cadmus 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 215a6a345f843d05ef56b703311301119d8bd685
-  data.tar.gz: 171b52fb98dcd2779c8fa28f8128a8705aea3411
+SHA256:
+  metadata.gz: 6c607dee469a52a3503f7ed85361b5324c4b10cb44941ce653e122a6642881c6
+  data.tar.gz: ac58d718a15527304ebb19291d8fa641076334dfcebd6cc97711e493ee3afc77
 SHA512:
-  metadata.gz: 138d7e20134104dd9b7f1252def6317678df7038b0ff920569673878437f72f4aeffeed5abd7c980e017ecae568f72b217ea0cb13b4b4d26bb3e4f2d79f56bbe
-  data.tar.gz: 17f27f48c748c06284811f8b3e7cdcbe549986a97b2a4214146b2e5b24e6ba0e54f4edafa5970ee8c229c3e89f8cf06c942f56a755833f5e22f2b382187f3b3b
+  metadata.gz: 5629fb1f4409a98cbd053110aad417e2d3dc697f5b0cb14f00dcfd24003e5ba2571d3de2651d659c794da91bd8d83b7afe45a8f34eb9e293ece85195f6cf3603
+  data.tar.gz: 1996d05f4e055806e4c76428414af0c1e437e7399d5d3792ccb03a7183301a7e8411f86d5f48355cb2dbfe9c4bec11f7992113d50e6cadf890068519d7a2dc74

data/CHANGELOG.md

@@ -1,8 +1,15 @@
+## 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::LiquidTemplateField`, which makes it easier to add Liquid templates to models
+* 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)
 

data/Gemfile

@@ -6,3 +6,5 @@ gemspec
 gem 'yard'
 gem 'redcarpet', '~> 1.0'
 gem 'github-markup'
+gem 'rails', '>= 5.1'
+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
@@ -38,10 +38,11 @@ unique index on the parent and slug columns:
 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,36 +52,6 @@ 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:
-
-```ruby
-class Page < ActiveRecord::Base
-  include ActiveModel::ForbiddenAttributesProtection
-  cadmus_page
-end
-```
-
-```ruby
-class PagesController < ApplicationController
-  include Cadmus::PagesController
-
-  protected
-  def page_params
-    params.require(:page).permit(:name, :slug, :content)
-  end
-
-  def page_class
-    Page
-  end
 end
 ```
 
@@ -307,7 +278,7 @@ Cadmus provides a convenience mixin to let you make that field a Liquid template
 
 ```ruby
 class WelcomeEmail < ActiveRecord::Base
-  include Cadmus::LiquidTemplateField
+  include Cadmus::Concerns::LiquidTemplateField
 
   liquid_template_field :content_liquid_template, :content
 
@@ -319,7 +290,7 @@ Now if you call `my_welcome_email.content_liquid_template`, you'll get a parsed
 
 ```ruby
 class WelcomeEmail < ActiveRecord::Base
-  include Cadmus::LiquidTemplateField
+  include Cadmus::Concerns::LiquidTemplateField
   include Cadmus::Renderable
 
   liquid_template_field :content_liquid_template, :content
@@ -336,7 +307,7 @@ Presto!  Now you can call `my_welcome_email.rendered_content`.  Since `WelcomeEm
 
 ```ruby
 class WelcomeEmail < ActiveRecord::Base
-  include Cadmus::LiquidTemplateField
+  include Cadmus::Concerns::LiquidTemplateField
   include Cadmus::Renderable
 
   liquid_template_field :content_liquid_template, :content

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

data/lib/cadmus.rb

@@ -1,14 +1,31 @@
+require 'liquid'
+
 require "cadmus/version"
+
+require "cadmus/concerns/controller_with_parent"
+require "cadmus/concerns/model_with_parent"
+require "cadmus/concerns/liquid_template_field"
+require "cadmus/concerns/other_class_accessor"
+
 require "cadmus/routing"
 require "cadmus/renderers"
-require "cadmus/controller_extensions"
 require "cadmus/slugs"
-require "cadmus/liquid_template_field"
-require "cadmus/page"
 require "cadmus/tags"
+require "cadmus/page"
+require "cadmus/layout"
+require "cadmus/partial"
+require "cadmus/partial_file_system"
+require "cadmus/pages_controller"
+require "cadmus/partials_controller"
+require "cadmus/layouts_controller"
+
 require "rails"
+require "cadmus/engine"
 
 module Cadmus
-  class Engine < Rails::Engine
-  end
-end
+  extend Cadmus::Concerns::OtherClassAccessor
+
+  other_class_accessor :layout_model
+  other_class_accessor :page_model
+  other_class_accessor :partial_model
+end

data/lib/cadmus/concerns/controller_with_parent.rb

@@ -0,0 +1,70 @@
+module Cadmus
+  module Concerns
+    module ControllerWithParent
+      extend ActiveSupport::Concern
+
+      included do
+        class << self
+          attr_accessor :parent_model_name, :parent_model_class, :find_parent_by
+        end
+      end
+
+      # This gets kind of meta.
+      #
+      # If cms_layout_parent_name and cms_layout_parent_class are both defined for this class, this method uses it to find
+      # the parent object in which layouts live.  For example, if cms_layout_parent_class is Blog and
+      # cms_layout_parent_name is "blog", then this is equivalent to calling:
+      #
+      #     @cms_layout_parent = Blog.where(:id => params["blog_id"]).first
+      #
+      # If you don't want to use :id to find the parent object, then redefine the find_parent_by method to return
+      # what you want to use.
+      def parent_model
+        return @parent_model if @parent_model
+
+        if parent_model_name && parent_model_class
+          parent_id_param = "#{parent_model_name}_id"
+          if params[parent_id_param]
+            @parent_model = parent_model_class.find_by(find_parent_by => params[parent_id_param])
+          end
+        end
+
+        @parent_model
+      end
+
+      # Returns the name of the layout parent object.  This will be used for determining the parameter name for
+      # finding the parent object.  For example, if the parent name is "wiki", the finder will look in
+      # params["wiki_id"] to determine the object ID.
+      #
+      # By default, this will return the value of cms_layout_parent_name set at the controller class level, but can
+      # be overridden for cases where the layout parent name must be determined on a per-request basis.
+      def parent_model_name
+        self.class.parent_model_name
+      end
+
+      # Returns the class of the layout parent object.  For example, if the pages used by this controller are
+      # children of a Section object, this method should return the Section class.
+      #
+      # By default, this will return the value of cms_layout_parent_class set at the controller class level, but can
+      # be overridden for cases where the layout parent class must be determined on a per-request basis.
+      def parent_model_class
+        self.class.parent_model_class
+      end
+
+      # Returns the field used to find the layout parent object.  By default this is :id, but if you need to
+      # find the layout parent object using a different parameter (for example, if you use a "slug" field for
+      # part of the URL), this can be changed.
+      #
+      # By default this method takes its value from the "find_parent_by" accessor set at the controller class
+      # level, but it can be overridden for cases where the finder field name should be determined on a
+      # per-request basis.
+      def find_parent_by
+        self.class.find_parent_by || :id
+      end
+
+      def liquid_file_system
+        Cadmus::PartialFileSystem.new(parent_model)
+      end
+    end
+  end
+end