denny/ShinyCMS-ruby

# ShinyCMS Developer Documentation

## TODO

Note: a lot of the TODO list has been moved to the [ShinyCMS project board](https://github.com/denny/ShinyCMS-ruby/projects/1) (as has the entire 'in progress' list)


## New features that I'd like to add at some point...

### Small-ish

* Make a generic sidebar template that renders any partials in a specified directory

* Add links to the in-page alerts, where helpful? e.g. "You must <a href="/login">log in</a> first"
    * https://guides.rubyonrails.org/i18n.html#using-safe-html-translations
    * https://www.ruby-toolbox.com/projects/it

* Re-assess use of helpers (vs models/libs/whatever) for Akismet and reCaptcha (and others?)

* On email recipients admin page, link to a summary of their comments and newsletter subscriptions (if any exist)

* Allow an EmailRecipient to reset their token (in case they forward an email containing it to somebody else)

* When not-logged-in users post a comment or subscribe to a list, offer to create an account for them

* Check site config for internal consistency on startup
    * e.g. if reCAPTCHA is enabled for registrations, the reCAPTCHA keys must be set

* Configurable (per-site and per-user) menu order in admin area
    * ( Per-site is currently partially possible, by changing the order plugins appear in ENV['SHINYCMS_PLUGINS'] )

* In admin area, load the full dataset for user capabilities, feature flags,
  and possibly site settings, and stick them in some hashes, with some helper
  methods to check them. The menu already makes a crazy amount of hits on the
  db and there are still a load of 'feature hidden by flag/capability/etc'
  conditionals to implement.

* Add tests for form actions being what they're supposed to be on new/edit pages,
  and for delete links being correct on list pages (to catch path helper issues)

* Make textarea inputs grow as needed
    * http://www.cryer.co.uk/resources/javascript/script21_auto_grow_text_box.htm

* Switch pagination to use JS helpers, to give site builders more flexibility?

* Delete ahoy and session data when Akismet reports blatant spam? (make configurable)

### Medium-ish

* Refactor show/hide/visible/published/etc stuff
    * CanHide could become a polymorphic acts_as_showable sort of thing?
        * show_on( :site ), show_in( :menus ), show_on( :sitemap ), etc

* Add folding to page sections on /admin/pages
    * Add 'fold all' and 'open all' options (here, and anywhere else that has folding too)
    * Decide 'intelligently' whether to fold all/none/some
        * (e.g. if there are >20 pages in total, fold any section containing >10 pages; if there are >10 sections and >100 pages in total, fold all sections; etc)

* Blazer:
    * Investigate alternatives? https://github.com/ankane/blazer/pull/316 :(
        * daru-view ?? https://github.com/SciRuby/daru-view#readme
    * Fix admin ACL; currently if you can view, you can add/update/delete too
        * Wrap in a thin ShinyStats plugin, to give it standard auth and feature flagging

* Add a polymorphic metatags model+helpers so they can be added to anything that might want them for SEO
    * pages/sections, shop items/categories, etc

* Multi-channel notifications: https://github.com/excid3/noticed#readme

* Tests for rake tasks
    * https://thoughtbot.com/blog/test-rake-tasks-like-a-boss ? (old)

* Improve UX for slug auto-generation
    * Look at Fae CMS slugger: https://www.faecms.com/documentation/features-slugger

* A/B testing
    * Field Test: https://github.com/ankane/field_test

* Replace hand-rolled slug generation with FriendlyId ?
    * https://norman.github.io/friendly_id

* Fix geolocation (for web stats) via Cloudflare?
    * https://support.cloudflare.com/hc/en-us/articles/200168236-Configuring-Cloudflare-IP-Geolocation

### Large-ish

* Investigate RBS - https://github.com/ruby/rbs#readme
    * https://honeyryderchuck.gitlab.io/httpx/2020/10/16/rbs-duck-typing-at-httpx.html

* View Components sound very interesting... https://viewcomponent.org

* Re-think mailer preview features
    * Can I use https://guides.rubyonrails.org/action_mailer_basics.html#previewing-emails instead of REP?

* Image galleries / multimedia galleries / etc

* Can I merge EmailRecipient, CommentAuthor, and VotableIP, to make 'Visitor' ?
    * Think about privacy implications of linking prior actions to current visitor

* GDPR compliance
    * https://github.com/prey/gdpr_rails ?

* Switch main site templates from ERB to liquid / handlebars / similar ?

* Allow in-situ editing of Page (and other?) content
    * Mercury: https://jejacks0n.github.io/mercury

* Replace hand-rolled trees and recursion (page sections, etc) with ClosureTree ?
    * https://github.com/ClosureTree/closure_tree

* Integrate a wiki?
    * https://www.ruby-toolbox.com/categories/wiki_apps

* Integrate a static site generator?
    * https://www.ruby-toolbox.com/categories/static_website_generation

* Run multiple ShinySites from one ShinyCMS installation?
    * https://www.ruby-toolbox.com/categories/Multitenancy


## Done / In Progress

See the [done](done.md) list for features from the original ShinyCMS that I have already implemented in this version - as well as a few new ones that snuck in along the way - with notes on improvements from the Perl version where applicable.

See the 'In Progress' column of the [ShinyCMS project board](https://github.com/denny/ShinyCMS-ruby/projects/1) for features that I am currently working on (with notes on where I'm up to, links to useful docs, etc).