cadmus 0.5.2 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 25c8b4e53cfd255b409c868f3b8d713ee9ba529f
-  data.tar.gz: 0d63afd6ffe03f07c80b2e9a6ff6acfd8285c429
+SHA256:
+  metadata.gz: 976db2b31a6439bbd4be7c6d8b0cd262bc9a6d69e065770643904703e5a7ff89
+  data.tar.gz: fd4e5c8a7dd861bbac67b18aeb72f3b1c6ca5e0956334aa645c0eca019dfec5a
 SHA512:
-  metadata.gz: fa374b8cf36fd744d00c382eb62b64f013b53b5ea9a2ce30df22f640b4bcd56e85e3f3d98da8c9b8393d26738c2c6dff32c610ed0f6cbd16b7fafcd741850b1f
-  data.tar.gz: 6343c1b8a254081c5e2613665534af3cfda9a44837067b02c374916a87dc143a7ed975c1b4ac4c9a1ee7be35d249f13c03928033b93620c0b7d0ccbf32ec80ed
+  metadata.gz: d93ed1826c12119f410af33808a44c3f2bbf8e4215b3e8d0fd8c61792550db2feb4163faf8a3d8a4554dc1fc1a99ff3b91433d3effab8e546b4765f9c70ec643
+  data.tar.gz: 30b44dc40bc5698f5da0d23967c4a888fce8838e04d434329f0f5f776a2cd84f166aa6abaec6f0a583a645917aa1152ca79ff5ace04d6f0200870a49c21dd7da

data/CHANGELOG.md

@@ -1,43 +1,64 @@
+## cadmus 0.7.1 (12-22-2021)
+
+- Rails 7 compatibility fixes
+
+## cadmus 0.7.0 (09-19-2018)
+
+- BREAKING CHANGE: Cadmus no longer mixes anything into `ActiveRecord::Base` when required; instead, models must explicitly include the mixins they need
+- Layouts
+- Partials
+- Major internal refactors
+
+## cadmus 0.6.0 (04-08-2017)
+
+- Expose a `{% page_url %}` tag, which outputs the URL to a page (for easier inter-page linking)
+- Expose a Liquid register called `parent` from controllers that mix in `Cadmus::ControllerExtensions`, which contains the page parent (if present)
+- Extract a mixin module called `Cadmus::Concerns::LiquidTemplateField`, which makes it easier to add Liquid templates to models
+
+## cadmus 0.5.3 (02-04-2017)
+
+- Make it possible to make `liquid_assigns`, `liquid_filters` and `liquid_registers` private or protected methods in controllers and other Renderables.
+
 ## cadmus 0.5.2 (11-10-2016)
 
-* Rails 5 compatibility fixes
+- Rails 5 compatibility fixes
 
 ## cadmus 0.5.1 (05-03-2015)
 
-* Support the sanitizer changes in Rails 4.2
+- Support the sanitizer changes in Rails 4.2
 
 ## cadmus 0.5.0 (12-06-2013)
 
-* First release that requires Rails 4.0
-* Strong parameters compatibility by default
+- First release that requires Rails 4.0
+- Strong parameters compatibility by default
 
 ## cadmus 0.4.8 (07-16-2013)
 
-* Add license info to gemspec
+- Add license info to gemspec
 
 ## cadmus 0.4.7 (07-15-2013)
 
-* Bugfix: don't try to use the parameters in the new action.  This prevents us from raising errors unnecessarily for required params in Rails 4.
+- Bugfix: don't try to use the parameters in the new action. This prevents us from raising errors unnecessarily for required params in Rails 4.
 
 ## cadmus 0.4.6 (07-15-2013)
 
-* Changes for Rails 4 compatibility:
-** Allow PUT or PATCH for the update action
-** Implement a page_params protected method in page controllers, which you can override to get strong_parameters support
+- Changes for Rails 4 compatibility:
+  ** Allow PUT or PATCH for the update action
+  ** Implement a page_params protected method in page controllers, which you can override to get strong_parameters support
 
 ## cadmus 0.4.5 (03-04-2013)
 
-* Change all the other uses of ^ and $ in regexes to \A and \z
-* Change scope to use a lambda for Rails 4 compatibility
+- Change all the other uses of ^ and $ in regexes to \A and \z
+- Change scope to use a lambda for Rails 4 compatibility
 
 ## cadmus 0.4.4 (03-04-2013)
 
-* Change some uses of ^ and $ in regexes to \A and \z
+- Change some uses of ^ and $ in regexes to \A and \z
 
 ## cadmus 0.4.3 (06-17-2012)
 
-* Add a cadmus:views generator to make view customization easier
+- Add a cadmus:views generator to make view customization easier
 
 ## cadmus 0.4.2 (06-16-2012)
 
-* Make `cadmus_pages` route function work with no arguments
+- Make `cadmus_pages` route function work with no arguments

data/Gemfile

@@ -6,3 +6,6 @@ gemspec
 gem 'yard'
 gem 'redcarpet', '~> 1.0'
 gem 'github-markup'
+gem 'rails', '>= 5.1'
+gem 'sprockets-rails'
+gem 'sqlite3'

data/README.md

@@ -1,6 +1,6 @@
 # Cadmus: an embeddable CMS for Rails
 
-Cadmus is an embeddable content management system for Rails 3 applications.  It's based on [Liquid](http://liquidmarkup.org)
+Cadmus is an embeddable content management system for Rails applications.  It's based on [Liquid](http://liquidmarkup.org)
 and is designed to be small and unobtrusive.
 
 Cadmus doesn't define controllers or models itself, but rather, provides mixins to add CMS-like functionality to controllers
@@ -14,7 +14,7 @@ ORM you want instead of ActiveRecord.
 
 One additional feature is the ability for pages to have parents.  A parent can be any model object.  Page parent objects allow
 you to create separate "sections" of your site - for example, if you have a project-hosting application that includes multiple
-projects, each of which has its own separate space of CMS pages.  (Page parents aren't intended for creating sub-pages - 
+projects, each of which has its own separate space of CMS pages.  (Page parents aren't intended for creating sub-pages -
 instead, just use forward-slash characters in the page slug to simulate folders, and Cadmus will handle it.)
 
 ## Basic Installation
@@ -30,18 +30,19 @@ The next step is to create a Page model.  Your app can have multiple Page models
 create one.
 
     rails generate model Page name:text slug:string content:text parent_id:integer parent_type:string
-	
-You'll need to tweak the generated migration and model slightly.  In the migration, after the `create_pages` block, add a 
+
+You'll need to tweak the generated migration and model slightly.  In the migration, after the `create_pages` block, add a
 unique index on the parent and slug columns:
 
 ```ruby
 add_index :pages, [:parent_type, :parent_id, :slug], :unique => true
 ```
-	
-And in the model, add a `cadmus_page` declaration:
+
+And in the model, include `Cadmus::Page` and add a `cadmus_page` declaration:
 
 ```ruby
 class Page < ActiveRecord::Base
+  include Cadmus::Page
   cadmus_page
 end
 ```
@@ -51,43 +52,23 @@ You'll need a controller to deal with your pages.  Here's a minimal example of o
 ```ruby
 class PagesController < ApplicationController
   include Cadmus::PagesController
-
-  protected
-  def page_class
-    Page
-  end
 end
 ```
 
-If you're on Rails 4 (or using the `strong_parameters` gem) you'll probably want to use forbidden attributes protection.
-Here's how you do that:
+`Cadmus::PagesController` automatically adds the seven RESTful resource methods to your controller.  It requires that you
+define a `page_class` method that returns the class for pages it's dealing with.  (This could potentially return different
+classes depending on request parameters, if you need it to - or, you could also set up different controllers for different
+types of page.)
 
-```ruby
-class Page < ActiveRecord::Base
-  include ActiveModel::ForbiddenAttributesProtection
-  cadmus_page
-end
-```
+You'll also want to set up an initializer (probably in `config/initializers/cadmus.rb`) that will tell Cadmus how to generate URLs for pages.  This might look like this:
 
 ```ruby
-class PagesController < ApplicationController
-  include Cadmus::PagesController
-
-  protected
-  def page_params
-    params.require(:page).permit(:name, :slug, :content)
-  end
-  
-  def page_class
-    Page
-  end
+Cadmus::Tags::PageUrl.define_page_path_method do |page_name, parent|
+  page_path(page_name, parent_id: parent)
 end
 ```
 
-`Cadmus::PagesController` automatically adds the seven RESTful resource methods to your controller.  It requires that you
-define a `page_class` method that returns the class for pages it's dealing with.  (This could potentially return different
-classes depending on request parameters, if you need it to - or, you could also set up different controllers for different
-types of page.)
+Doing this will enable markup like this in page templates: `<a href="{% page_url my-other-page %}">My other page</a>`.  The `{% page_url my-other-page %}` will be replaced with the actual URL for the page called `my-other-page`.
 
 Finally, you'll need to create routes for this controller.  Cadmus provides a built-in helper for that:
 
@@ -96,7 +77,7 @@ MyApp::Application.routes.draw do
   cadmus_pages
 end
 ```
-	
+
 This will create the following routes:
 
 * GET /pages => PagesController#index
@@ -109,15 +90,15 @@ This will create the following routes:
 
 ## Authorization Control
 
-The pages controller is where you'll need to hook into any authorization or authentication system your app might use.  
+The pages controller is where you'll need to hook into any authorization or authentication system your app might use.
 We use CanCan, so here's an example of how we do that:
 
 ```ruby
 class PagesController < ApplicationController
   include Cadmus::PagesController
-  
+
   authorize_resource :page
-  
+
   protected
   def page_class
     Page
@@ -130,7 +111,7 @@ class Ability
   def initialize(user)
     can :read, Page
       return unless user
-	
+
       # in this example, we've added an owner_id column to our Page model
       can :manage, Page, :owner_id => user.id
   end
@@ -154,7 +135,7 @@ DugoutCoach::Application.routes.draw do
     resources :players
       resources :schedule
   end
-  
+
   cadmus_pages # for global pages on your site
 end
 ```
@@ -177,20 +158,20 @@ end
 ```
 
 Now you have a way of separating team-specific pages from global pages on the site.  The URLs for these pages might be,
-for example, http://dugoutcoach.net/teams/cosmonauts/directions, or 
+for example, http://dugoutcoach.net/teams/cosmonauts/directions, or
 http://dugoutcoach.net/teams/cosmonauts/promotions/free-hat-day (remember, Cadmus slugs can contain slashes).  We'll
 now need a TeamPages controller to handle these:
 
 ```ruby
 class TeamPagesController < ApplicationController
   include Cadmus::PagesController
-  
+
   self.page_parent_class = Team   # page's parent is a Team
   self.page_parent_name = "team"  # parent ID is in params[:team_id]
   self.find_parent_by = "slug"    # parent ID is the Team's "slug" field rather than "id"
-  
+
   authorize_resource :page
-  
+
   protected
   def page_class
     Page
@@ -215,7 +196,7 @@ DugoutCoach::Application.routes.draw do
       resources :schedule
       cadmus_pages :controller => :team_pages, :shallow => true
   end
-  
+
   cadmus_pages
 end
 ```
@@ -245,7 +226,7 @@ help them by providing them with a Liquid template variable they can use like so
 
 ```html
 <h1>We're the Cosmonauts!</h1>
-   
+
 <p>Our uniform color this week is {{ team.uniform_color }}!</p>
 ```
 
@@ -254,19 +235,19 @@ To do this, you'll need to expose `team` as a Liquid assign variable:
 ```ruby
 class TeamPagesController < ApplicationController
   include Cadmus::PagesController
-  
+
   self.page_parent_class = Team   # page's parent is a Team
   self.page_parent_name = "team"  # parent ID is in params[:team_id]
   self.find_parent_by = "slug"    # parent ID is the Team's "slug" field rather than "id"
-  
+
   authorize_resource :page
-  
+
   protected
 
   def page_class
     Page
   end
-    
+
   def liquid_assigns
     { :team => @page.parent }
   end
@@ -285,10 +266,66 @@ class Team < ActiveRecord::Base
   # everything else in your model...
 end
 ```
-    
+
 You could also define a `to_liquid` method that returns a `Liquid::Drop` subclass for Teams, if you need to do things
 more complicated than just return data values.
 
+## Liquid Templates on Non-Page Models
+
+Let's say you have another model in your app that you'd like to put a Liquid template on.  For example, perhaps the baseball teams would like to send out a welcome email to their fans.  You might create a `WelcomeEmail` model with a `content` field.
+
+Cadmus provides a convenience mixin to let you make that field a Liquid template.  You can use it like so:
+
+```ruby
+class WelcomeEmail < ActiveRecord::Base
+  include Cadmus::Concerns::LiquidTemplateField
+
+  liquid_template_field :content_liquid_template, :content
+
+  belongs_to :team
+end
+```
+
+Now if you call `my_welcome_email.content_liquid_template`, you'll get a parsed `Liquid::Template` generated from the value of `my_welcome_email.content`.  You could further make the WelcomeEmail into a `Cadmus::Renderable` to make it render the template:
+
+```ruby
+class WelcomeEmail < ActiveRecord::Base
+  include Cadmus::Concerns::LiquidTemplateField
+  include Cadmus::Renderable
+
+  liquid_template_field :content_liquid_template, :content
+
+  belongs_to :team
+
+  def rendered_content
+    cadmus_renderer.render(content_liquid_template, :html)
+  end
+end
+```
+
+Presto!  Now you can call `my_welcome_email.rendered_content`.  Since `WelcomeEmail` includes `Cadmus::Renderable`, you can also define `liquid_assigns` to expose variables to the template, for example:
+
+```ruby
+class WelcomeEmail < ActiveRecord::Base
+  include Cadmus::Concerns::LiquidTemplateField
+  include Cadmus::Renderable
+
+  liquid_template_field :content_liquid_template, :content
+
+  belongs_to :team
+
+  def rendered_content
+    cadmus_renderer.render(content_liquid_template, :html)
+  end
+
+  def liquid_assigns
+    { 'team' => team }
+  end
+end
+```
+
+And now the welcome email templates can include `{{ team.name }}` and any other things derived from the Team model they want.
+
 ## Copyright and Licensing
 
-Copyright &copy; 2011-2012 Gively, Inc.  Cadmus is released under the MIT license.  For more information, see the LICENSE file.
+Copyright &copy; Gively, Inc.  Cadmus is released under the MIT license.  For more information, see the LICENSE file.

data/Rakefile

@@ -1,2 +1,33 @@
-#!/usr/bin/env rake
-require "bundler/gem_tasks"
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Cadmus'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/helpers/cadmus/rendering_helper.rb

@@ -0,0 +1,24 @@
+module Cadmus::RenderingHelper
+  def render_cadmus_page_in_effective_layout(page)
+    page_content = cadmus_renderer.render(@page.liquid_template, :html)
+    cms_layout = @page.effective_cms_layout
+    render_in_cadmus_layout(page_content, cms_layout, 'page' => page)
+  end
+
+  def render_in_cadmus_layout(content, cms_layout, assigns = {})
+    if cms_layout
+      assigns = assigns.merge({ 'content_for_layout' => content })
+      if defined?(:liquid_assigns_for_layout)
+        assigns.reverse_merge!(liquid_assigns_for_layout(cms_layout))
+      end
+
+      cadmus_renderer.render(cms_layout.liquid_template, :html, assigns: assigns, registers: { 'parent' => cms_layout.parent })
+    else
+      content_for :content do
+        content
+      end
+
+      render template: 'layouts/application'
+    end
+  end
+end

data/app/views/cadmus/layouts/_form.html.erb

@@ -0,0 +1,11 @@
+<div class="form-group">
+  <%= f.label :name %>
+  <%= f.text_field :name, class: 'form-control' %>
+</div>
+
+<div class="form-group">
+  <%= f.label :content %>
+  <%= f.text_area(:content, :style => "font-family: monospace; min-height: 40vh;", class: 'form-control') %>
+</div>
+
+<%= f.submit class: 'btn btn-primary' %>

data/app/views/cadmus/layouts/edit.html.erb

@@ -0,0 +1,5 @@
+<h1>Editing layout <%= @cms_layout.name %></h1>
+
+<%= form_for @cms_layout, url: url_for(action: 'update', id: @cms_layout) do |f| %>
+  <%= render partial: 'cadmus/layouts/form', locals: { f: f } %>
+<% end %>

data/app/views/cadmus/layouts/index.html.erb

@@ -0,0 +1,25 @@
+<h1>
+	<% if @cms_layout_parent && @cms_layout_parent.respond_to?(:name) -%>
+		Layouts in <%= @cms_layout_parent.name %>
+	<% else -%>
+		Layouts
+	<% end -%>
+</h1>
+
+<ul class="list-group mb-4">
+  <% @cms_layouts.each do |cms_layout| %>
+    <li class="list-group-item">
+      <div class="row w-100">
+        <div class="col">
+          <%= cms_layout.name %>
+        </div>
+        <div class="col text-right">
+          <%= link_to "Edit", url_for(action: 'edit', id: cms_layout), class: 'btn btn-secondary btn-sm' %>
+          <%= link_to "Delete", url_for(action: 'destroy', id: cms_layout), method: 'DELETE', "data-confirm" => "Are you sure you want to delete this layout?", class: 'btn btn-danger btn-sm' %>
+        </div>
+      </div>
+    </li>
+  <% end -%>
+</ul>
+
+<%= link_to "New layout", url_for(action: 'new'), class: 'btn btn-primary' %>

data/app/views/cadmus/layouts/new.html.erb

@@ -0,0 +1,5 @@
+<h1>New layout</h1>
+
+<%= form_for @cms_layout, url: url_for(action: 'create') do |f| %>
+  <%= render partial: 'cadmus/layouts/form', locals: { f: f } %>
+<% end %>

data/app/views/cadmus/pages/index.html.erb

@@ -1,6 +1,6 @@
 <h1>
-	<% if @page_parent && @page_parent.respond_to?(:name) -%>
-		<%= @page_parent.name %>
+	<% if @parent_model && @parent_model.respond_to?(:name) -%>
+		<%= @parent_model.name %>
 	<% else -%>
 		Pages
 	<% end -%>

data/app/views/cadmus/pages/show.html.erb

@@ -1 +1 @@
-<%= cadmus_renderer.render(@page.liquid_template, :html) %>
+<%= render_in_page_layout @page %>

data/app/views/cadmus/partials/_form.html.erb

@@ -0,0 +1,35 @@
+<% if f.object.errors.any? -%>
+  <div id="error_explanation">
+    <h2><%= pluralize(f.object.errors.count, "error") %> prohibited this partial from being saved:</h2>
+
+    <ul>
+      <% f.object.errors.full_messages.each do |message| -%>
+        <li><%= message %></li>
+      <% end -%>
+    </ul>
+  </div>
+<% end -%>
+
+<div class="form-group">
+  <%= f.label f.object.class.name_field %>
+  <%= f.text_field f.object.class.name_field, class: 'form-control' %>
+</div>
+
+<div class="form-group">
+  <%= f.label :content %>
+  <%= f.text_area(:content, :style => "font-family: monospace; min-height: 40vh;", class: 'form-control') %>
+</div>
+
+<%= f.submit class: 'btn btn-primary' %>
+
+<p><b>Rendered html preview</b></p>
+<div id="html-preview" style="border:1px solid; min-height: 10em;">
+</div>
+<br/><br/>
+
+<%= javascript_include_tag "cadmus.previewablehtml.js" %>
+<script type="text/javascript">
+$(document).ready(function(){
+  $('.cadmus-previewable-html').cadmusPreviewableHtml();
+});
+</script>

data/app/views/cadmus/partials/edit.html.erb

@@ -0,0 +1,5 @@
+<h1>Editing partial <%= @cms_partial.public_send(@cms_partial.class.name_field) %></h1>
+
+<%= form_for @cms_partial, url: url_for(action: 'update', id: @cms_partial) do |f| %>
+  <%= render partial: 'cadmus/partials/form', locals: { f: f } %>
+<% end %>

data/app/views/cadmus/partials/index.html.erb

@@ -0,0 +1,25 @@
+<h1>
+	<% if @parent_model && @parent_model.respond_to?(:name) -%>
+		Partials in <%= @parent_model.name %>
+	<% else -%>
+		Partials
+	<% end -%>
+</h1>
+
+<ul class="list-group mb-4">
+  <% @cms_partials.each do |cms_partial| %>
+    <li class="list-group-item">
+      <div class="row w-100">
+        <div class="col">
+          <%= cms_partial.public_send(cms_partial.class.name_field) %>
+        </div>
+        <div class="col text-right">
+          <%= link_to "Edit", url_for(action: 'edit', id: cms_partial), class: 'btn btn-secondary btn-sm' %>
+          <%= link_to "Delete", url_for(action: 'destroy', id: cms_partial), method: 'DELETE', "data-confirm" => "Are you sure you want to delete this partial?", class: 'btn btn-danger btn-sm' %>
+        </div>
+      </div>
+    </li>
+  <% end -%>
+</ul>
+
+<%= link_to "New partial", url_for(action: 'new'), class: 'btn btn-primary' %>

data/app/views/cadmus/partials/new.html.erb

@@ -0,0 +1,5 @@
+<h1>New partial</h1>
+
+<%= form_for @cms_partial, url: url_for(action: 'create') do |f| %>
+  <%= render partial: 'cadmus/partials/form', locals: { f: f } %>
+<% end %>

data/app/views/cadmus/partials/show.html.erb

@@ -0,0 +1,4 @@
+<p id="notice"><%= notice %></p>
+
+<%= link_to 'Edit', edit_cms_partial_path(@cms_partial) %> |
+<%= link_to 'Back', cms_partials_path %>

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/cadmus.gemspec

@@ -9,13 +9,13 @@ Gem::Specification.new do |gem|
   gem.homepage      = "http://github.com/gively/cadmus"
   gem.license       = "MIT"
 
-  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.executables   = `git ls-files -- exe/*`.split("\n").map{ |f| File.basename(f) }
   gem.files         = `git ls-files`.split("\n")
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   gem.name          = "cadmus"
   gem.require_paths = ["lib"]
   gem.version       = Cadmus::VERSION
 
-  gem.add_dependency("rails", ">= 4.0.0")
+  gem.add_dependency("rails", ">= 5.0.0")
   gem.add_dependency("liquid")
 end