comfortable_mexican_sofa 1.9.1 → 1.9.2

data/README.md

@@ -18,8 +18,10 @@ Installation
 ------------
 Add gem definition to your Gemfile:
     
-    gem 'comfortable_mexican_sofa', '~> 1.9.0'
-    
+```ruby
+gem 'comfortable_mexican_sofa', '~> 1.9.0'
+``` 
+
 Then from the Rails project's root run:
     
     bundle install
@@ -39,8 +41,10 @@ Installation for Rails 3
 ------------------------
 For Rails 3 apps feel free to use [1.8 release](https://github.com/comfy/comfortable-mexican-sofa/tree/1.8)
     
-    gem 'comfortable_mexican_sofa', '~> 1.8.0'
-    
+```ruby
+gem 'comfortable_mexican_sofa', '~> 1.8.0'
+```
+
 Quick Start Guide
 -----------------
 After finishing installation you should be able to navigate to http://yoursite/cms-admin

data/app/controllers/cms_admin/base_controller.rb

@@ -1,4 +1,4 @@
-class CmsAdmin::BaseController < ApplicationController
+class CmsAdmin::BaseController < ComfortableMexicanSofa.config.base_controller.to_s.constantize
 
   protect_from_forgery
 

data/app/controllers/cms_admin/snippets_controller.rb

@@ -13,7 +13,7 @@ class CmsAdmin::SnippetsController < CmsAdmin::BaseController
   end
 
   def edit
-    render
+    @snippet.attributes = snippet_params
   end
 
   def create

data/config/initializers/comfortable_mexican_sofa.rb

@@ -4,35 +4,38 @@ ComfortableMexicanSofa.configure do |config|
   # Title of the admin area
   #   config.cms_title = 'ComfortableMexicanSofa CMS Engine'
   
+  # Controller that is inherited from CmsAdmin::BaseController
+  #   config.base_controller = 'ApplicationController'
+
   # Module responsible for authentication. You can replace it with your own.
   # It simply needs to have #authenticate method. See http_auth.rb for reference.
   #   config.admin_auth = 'ComfortableMexicanSofa::HttpAuth'
-  
+
   # Module responsible for public authentication. Similar to the above. You also
   # will have access to @cms_site, @cms_layout, @cms_page so you can use them in
   # your logic. Default module doesn't do anything.
   #   config.public_auth = 'ComfortableMexicanSofa::DummyAuth'
-  
+
   # When arriving at /cms-admin you may chose to redirect to arbirtary path,
   # for example '/cms-admin/users'
   #   config.admin_route_redirect = ''
-  
+
   # File uploads use Paperclip and can support filesystem or s3 uploads.  Override
   # the upload method and appropriate settings based on Paperclip.  For S3 see:
-  # http://rdoc.info/gems/paperclip/2.3.8/Paperclip/Storage/S3, and for 
+  # http://rdoc.info/gems/paperclip/2.3.8/Paperclip/Storage/S3, and for
   # filesystem see: http://rdoc.info/gems/paperclip/2.3.8/Paperclip/Storage/Filesystem
   # If you are using S3 and HTTPS, pass :s3_protocol => '' to have URLs that use the protocol of the page
   #   config.upload_file_options = {:url => '/system/:class/:id/:attachment/:style/:filename'}
-  
+
   # Sofa allows you to setup entire site from files. Database is updated with each
   # request (if necessary). Please note that database entries are destroyed if there's
   # no corresponding file. Fixtures are disabled by default.
   #   config.enable_fixtures = false
-  
+
   # Path where fixtures can be located.
   #   config.fixtures_path = File.expand_path('db/cms_fixtures', Rails.root)
-  
-  # Importing fixtures into Database  
+
+  # Importing fixtures into Database
   # To load fixtures into the database just run this rake task:
   #   local: $ rake comfortable_mexican_sofa:fixtures:import FROM=example.local TO=localhost
   #   Heroku: $ heroku run rake comfortable_mexican_sofa:fixtures:import FROM=example.local TO=yourapp.herokuapp.com
@@ -43,16 +46,16 @@ ComfortableMexicanSofa.configure do |config|
   #   local: $ rake comfortable_mexican_sofa:fixtures:export FROM=localhost TO=example.local
   #   Heroku: $ heroku run rake comfortable_mexican_sofa:fixtures:export FROM=yourapp.herokuapp.com TO=example.local
   # This will create example.local folder and dump all content from example.com Site.
-  
+
   # Content for Layouts, Pages and Snippets has a revision history. You can revert
   # a previous version using this system. You can control how many revisions per
   # object you want to keep. Set it to 0 if you wish to turn this feature off.
   #   config.revisions_limit = 25
-  
+
   # Locale definitions. If you want to define your own locale merge
   # {:locale => 'Locale Title'} with this.
   #   config.locales = {:en => 'English', :es => 'Español'}
-  
+
   # Admin interface will respect the locale of the site being managed. However you can
   # force it to English by setting this to `:en`
   #   config.admin_locale = nil
@@ -61,30 +64,30 @@ ComfortableMexicanSofa.configure do |config|
   # add a database_config. For example, setting it to 'cms' will look for a cms_#{Rails.env}
   # definition in your database.yml file
   #   config.database_config = nil
-  
+
   # A class that is included as a sweeper to admin base controller if it's set
   #   config.admin_cache_sweeper = nil
-  
+
   # By default you cannot have irb code inside your layouts/pages/snippets.
   # Generally this is to prevent putting something like this:
   # <% User.delete_all %> but if you really want to allow it...
   #   config.allow_irb = false
-  
+
   # Whitelist of all helper methods that can be used via {{cms:helper}} tag. By default
   # all helpers are allowed except `eval`, `send`, `call` and few others. Empty array
   # will prevent rendering of all helpers.
   #   config.allowed_helpers = nil
-  
+
   # Whitelist of partials paths that can be used via {{cms:partial}} tag. All partials
   # are accessible by default. Empty array will prevent rendering of all partials.
   #   config.allowed_partials = nil
-  
-  # Site aliases, if you want to have aliases for your site. Good for harmonizing 
+
+  # Site aliases, if you want to have aliases for your site. Good for harmonizing
   # production env with dev/testing envs.
   # e.g. config.hostname_aliases = {'host.com' => 'host.inv', 'host_a.com' => ['host.lvh.me', 'host.dev']}
   # Default is nil (not used)
   #   config.hostname_aliases = nil
-  
+
 end
 
 # Default credentials for ComfortableMexicanSofa::HttpAuth

data/lib/comfortable_mexican_sofa/configuration.rb

@@ -4,6 +4,10 @@ class ComfortableMexicanSofa::Configuration
 
   # Don't like ComfortableMexicanSofa? Set it to whatever you like. :(
   attr_accessor :cms_title
+  
+  # Controller that is inherited from CmsAdmin::BaseController
+  # 'ApplicationController' is the default
+  attr_accessor :base_controller
 
   # Module that will handle authentication to access cms-admin area
   attr_accessor :admin_auth
@@ -57,6 +61,10 @@ class ComfortableMexicanSofa::Configuration
   # are accessible by default. Empty array will prevent rendering of all partials.
   attr_accessor :allowed_partials
 
+  # Whitelist of template paths that can be used via {{cms:template}} tag. All templates
+  # are accessible by default. Empty array will prevent rendering of all templates.
+  attr_accessor :allowed_templates
+
   # Site aliases, if you want to have aliases for your site. Good for harmonizing
   # production env with dev/testing envs.
   # e.g. config.site_aliases = {'host.com' => 'host.inv', 'host_a.com' => ['host.lvh.me', 'host.dev']}
@@ -66,6 +74,7 @@ class ComfortableMexicanSofa::Configuration
   # Configuration defaults
   def initialize
     @cms_title            = 'ComfortableMexicanSofa CMS Engine'
+    @base_controller      = 'ApplicationController'
     @admin_auth           = 'ComfortableMexicanSofa::HttpAuth'
     @public_auth          = 'ComfortableMexicanSofa::DummyAuth'
     @seed_data_path       = nil

data/lib/comfortable_mexican_sofa/fixture/page.rb

@@ -57,7 +57,7 @@ module ComfortableMexicanSofa::Fixture::Page
         page.blocks_attributes = blocks_attributes if blocks_attributes.present?
         
         # saving
-        if page.changed? || self.force_import
+        if page.changed? || page.blocks_attributes_changed || self.force_import
           if page.save
             save_categorizations!(page, categories)
             ComfortableMexicanSofa.logger.warn("[FIXTURES] Imported Page \t #{page.full_path}")
@@ -119,4 +119,4 @@ module ComfortableMexicanSofa::Fixture::Page
       end
     end
   end
-end
+end

data/lib/comfortable_mexican_sofa/tags/template.rb

@@ -0,0 +1,22 @@
+class ComfortableMexicanSofa::Tag::Template
+  include ComfortableMexicanSofa::Tag
+
+  def self.regex_tag_signature(identifier = nil)
+    identifier ||= /[\w\/\-]+/
+    /\{\{\s*cms:template:(#{identifier})\s*\}\}/
+  end
+
+  def content
+    "<%= render :template => '#{identifier}' %>"
+  end
+
+  def render
+    whitelist = ComfortableMexicanSofa.config.allowed_templates
+    if whitelist.is_a?(Array)
+      content if whitelist.member?(identifier)
+    else
+      content
+    end
+  end
+
+end

data/lib/comfortable_mexican_sofa/version.rb

@@ -1,3 +1,3 @@
 module ComfortableMexicanSofa
-  VERSION = "1.9.1"
+  VERSION = "1.9.2"
 end

data/lib/comfortable_mexican_sofa/view_methods.rb

@@ -1,34 +1,66 @@
 module ComfortableMexicanSofa::ViewMethods
-  
+
   # Wrapper around ComfortableMexicanSofa::FormBuilder
   def comfy_form_for(record, options = {}, &proc)
     options[:builder] = ComfortableMexicanSofa::FormBuilder
     options[:type] ||= :horizontal
     formatted_form_for(record, options, &proc)
   end
-  
+
   # Injects some content somewhere inside cms admin area
   def cms_hook(name, options = {})
     ComfortableMexicanSofa::ViewHooks.render(name, self, options)
   end
   
-  # Content of a snippet. Example:
+  # Content of a snippet. Examples:
   #   cms_snippet_content(:my_snippet)
-  def cms_snippet_content(identifier, cms_site = nil)
+  #   <%= cms_snippet_content(:my_snippet) do %>
+  #     Default content can go here.
+  #   <% end %>
+  def cms_snippet_content(identifier, cms_site = nil, &block)
     unless cms_site
       host, path = request.host.downcase, request.fullpath if respond_to?(:request) && request
       cms_site ||= (@cms_site || Cms::Site.find_site(host, path))
     end
-    return '' unless cms_site 
-    case identifier
-    when Cms::Snippet
-      snippet = identifier
-    else
-      return '' unless snippet = cms_site.snippets.find_by_identifier(identifier)
+    return '' unless cms_site && identifier.present?
+    snippet = cms_site.snippets.find_by_identifier(identifier)
+    
+    if !snippet && block_given?
+      snippet = cms_site.snippets.create(
+        :identifier => identifier,
+        :label      => identifier.to_s.titleize,
+        :content    => capture(&block)
+      )
     end
     render :inline => ComfortableMexicanSofa::Tag.process_content(cms_site.pages.build, snippet.content)
   end
-  
+
+  # Content of a text based page block. This is the typical method for retrieving content from
+  # page:field. Note: This method will be faster than the more generic cms_page_content.
+  #
+  # Example:
+  #   cms_page_block_content(:left_column, CmsPage.first)
+  #   cms_page_block_content(:left_column) if @cms_page is present
+  def cms_page_block_content(identifier, page = nil)
+    return '' unless page ||= @cms_page
+    return '' unless block = page.blocks.find_by_identifier(identifier)
+
+    ComfortableMexicanSofa::Tag.process_content(page, block.content)
+  end
+
+  # Fetch files from a page:field. Will return a list of files, regardless of how many files are present.
+  # Note: This method will be faster than the more generic cms_page_content.
+  #
+  # Example:
+  #   cms_page_block_content(:open_graph_image, CmsPage.first)
+  #   cms_page_block_content(:attachments, CmsPage.first)
+  def cms_page_files(identifier, page = nil)
+    return nil unless page ||= @cms_page
+    return nil unless block = page.blocks.find_by_identifier(identifier)
+
+    block.files
+  end
+
   # Content of a page block. This is how you get content from page:field
   # Example:
   #   cms_page_content(:left_column, CmsPage.first)

data/test/controllers/cms_admin/snippets_controller_test.rb

@@ -52,6 +52,14 @@ class CmsAdmin::SnippetsControllerTest < ActionController::TestCase
     assert_template :edit
     assert_select "form[action=/cms-admin/sites/#{snippet.site.id}/snippets/#{snippet.id}]"
   end
+  
+  def test_get_edit_with_params
+    snippet = cms_snippets(:default)
+    get :edit, :site_id => snippet.site, :id => snippet, :snippet => {:label => 'New Label'}
+    assert_response :success
+    assert assigns(:snippet)
+    assert_equal 'New Label', assigns(:snippet).label
+  end
 
   def test_get_edit_failure
     get :edit, :site_id => cms_sites(:default), :id => 'not_found'

data/test/models/configuration_test.rb

@@ -7,6 +7,7 @@ class ConfigurationTest < ActiveSupport::TestCase
   def test_configuration_presence
     assert config = ComfortableMexicanSofa.configuration
     assert_equal 'ComfortableMexicanSofa CMS Engine', config.cms_title
+    assert_equal 'ApplicationController', config.base_controller
     assert_equal 'ComfortableMexicanSofa::HttpAuth', config.admin_auth
     assert_equal 'ComfortableMexicanSofa::DummyAuth', config.public_auth
     assert_equal '', config.admin_route_redirect

data/test/models/tags/template_test.rb

@@ -0,0 +1,56 @@
+require_relative '../../test_helper'
+
+class TemplateTagTest < ActiveSupport::TestCase
+
+  def test_initialize_tag
+    assert tag = ComfortableMexicanSofa::Tag::Template.initialize_tag(
+      cms_pages(:default), '{{ cms:template:template_name }}'
+    )
+    assert_equal 'template_name', tag.identifier
+    assert tag = ComfortableMexicanSofa::Tag::Template.initialize_tag(
+      cms_pages(:default), '{{cms:template:path/to/template}}'
+    )
+    assert_equal 'path/to/template', tag.identifier
+    assert tag = ComfortableMexicanSofa::Tag::Template.initialize_tag(
+      cms_pages(:default), '{{cms:template:path/to/dashed-template}}'
+    )
+    assert_equal 'path/to/dashed-template', tag.identifier
+  end
+
+  def test_initialize_tag_failure
+    [
+      '{{cms:template}}',
+      '{{cms:not_template:label}}',
+      '{not_a_tag}'
+    ].each do |tag_signature|
+      assert_nil ComfortableMexicanSofa::Tag::Template.initialize_tag(
+        cms_pages(:default), tag_signature
+      )
+    end
+  end
+
+  def test_content_and_render
+    tag = ComfortableMexicanSofa::Tag::Template.initialize_tag(
+      cms_pages(:default), '{{cms:template:path/to/template}}'
+    )
+    assert_equal "<%= render :template => 'path/to/template' %>", tag.content
+    assert_equal "<%= render :template => 'path/to/template' %>", tag.render
+  end
+
+  def test_whitelisted_paths
+    ComfortableMexicanSofa.config.allowed_templates = ['safe/path']
+
+    tag = ComfortableMexicanSofa::Tag::Template.initialize_tag(
+      cms_pages(:default), '{{cms:template:safe/path}}'
+    )
+    assert_equal "<%= render :template => 'safe/path' %>", tag.content
+    assert_equal "<%= render :template => 'safe/path' %>", tag.render
+
+    tag = ComfortableMexicanSofa::Tag::Template.initialize_tag(
+      cms_pages(:default), '{{cms:template:unsafe/path}}'
+    )
+    assert_equal "<%= render :template => 'unsafe/path' %>", tag.content
+    assert_equal nil, tag.render
+  end
+
+end

data/test/models/view_methods_test.rb

@@ -1,9 +1,9 @@
 require_relative '../test_helper'
 
 class ViewMethodsTest < ActionView::TestCase
-  
+
   include ComfortableMexicanSofa::ViewMethods
-  
+
   class ::HelpersTestController < ActionController::Base
     helper { def hello; 'hello' end }
 
@@ -11,6 +11,17 @@ class ViewMethodsTest < ActionView::TestCase
       render :inline => '<%= cms_snippet_content(:default) %>'
     end
 
+    def test_cms_page_block_content
+      @cms_page = Cms::Page.root
+      render :inline => '<%= cms_page_block_content(:default_field_text) %>'
+    end
+    
+    def test_cms_snippet_with_default_content_block
+      render :inline => '<%= cms_snippet_content(:nonexistent_snippet) do %>
+                           Some content <b>here</b>.
+                         <% end %>'
+    end
+
     def test_cms_page_content
       @cms_page = Cms::Page.root
       render :inline => '<%= cms_page_content(:default_field_text) %>'
@@ -24,7 +35,7 @@ class ViewMethodsTest < ActionView::TestCase
       end
     end
   end
-  
+
   # Simulating a call and getting resulting output
   def action_result(action)
     HelpersTestController.action(action).call(ActionController::TestRequest.new.env).last.body
@@ -41,26 +52,64 @@ class ViewMethodsTest < ActionView::TestCase
   def test_cms_snippet_content
     assert_equal 'default_snippet_content', action_result('test_cms_snippet_content')
   end
-  
+
   def test_cms_snippet_content_with_tags
     cms_snippets(:default).update_columns(:content => '{{cms:helper:hello}}')
     assert_equal 'hello', action_result('test_cms_snippet_content')
   end
-  
+
   def test_cms_snippet_content_with_file_tag
     cms_snippets(:default).update_column(:content, '{{cms:file:sample.jpg}}')
     assert_equal cms_files(:default).file.url, action_result('test_cms_snippet_content')
   end
+
+  def test_cms_page_block_content
+    assert_equal 'default_field_text_content', action_result('test_cms_page_block_content')
+  end
+
+  def test_cms_page_files
+    page = cms_pages(:default)
+    page.layout.update_column(:content, '{{cms:page_files:files}}')
+    page.update_attributes!(
+      :blocks_attributes => [
+        {
+          :identifier => 'files',
+          :content    => [
+            fixture_file_upload('files/image.jpg', "image/jpeg"),
+            fixture_file_upload('files/image.gif', "image/gif")
+          ]
+        }
+      ]
+    )
+    assert_equal page.blocks.find_by_identifier('files').files, cms_page_files(:files, page)
+  end
+
+  def test_cms_snippet_with_default_content_block_displays_content
+    assert_equal 'Some content <b>here</b>.',
+      action_result('test_cms_snippet_with_default_content_block').strip
+  end
+
+  def test_cms_snippet_with_default_content_creates_snippet
+    assert_nil Cms::Snippet.find_by_identifier('nonexistent_snippet')
+    action_result('test_cms_snippet_with_default_content_block')
+    assert_not_nil Cms::Snippet.find_by_identifier('nonexistent_snippet')
+  end
+
+  def test_cms_snippet_with_default_content_shows_stored_snippet_if_present
+    cms_snippets(:default).update_attribute(:identifier, 'nonexistent_snippet')
+    assert_equal 'default_snippet_content',
+      action_result('test_cms_snippet_with_default_content_block')
+  end
   
   def test_cms_page_content
     assert_equal 'default_field_text_content', action_result('test_cms_page_content')
   end
-  
+
   def test_cms_page_content_with_tags
     cms_blocks(:default_field_text).update_column(:content, '{{cms:helper:hello}}')
     assert_equal 'hello', action_result('test_cms_page_content')
   end
-  
+
   def test_cms_page_content_with_files
     page = cms_pages(:default)
     page.layout.update_column(:content, '{{cms:page_file:file}} {{cms:page_files:files}}')
@@ -76,5 +125,5 @@ class ViewMethodsTest < ActionView::TestCase
     assert_equal page.blocks.find_by_identifier('file').files.first, cms_page_content(:file, page)
     assert_equal page.blocks.find_by_identifier('files').files, cms_page_content(:files, page)
   end
-  
-end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: comfortable_mexican_sofa
 version: !ruby/object:Gem::Version
-  version: 1.9.1
+  version: 1.9.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-13 00:00:00.000000000 Z
+date: 2013-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -375,6 +375,7 @@ files:
 - lib/comfortable_mexican_sofa/tags/page_text.rb
 - lib/comfortable_mexican_sofa/tags/partial.rb
 - lib/comfortable_mexican_sofa/tags/snippet.rb
+- lib/comfortable_mexican_sofa/tags/template.rb
 - lib/comfortable_mexican_sofa/version.rb
 - lib/comfortable_mexican_sofa/view_hooks.rb
 - lib/comfortable_mexican_sofa/view_methods.rb
@@ -453,6 +454,7 @@ files:
 - test/models/tags/page_text_test.rb
 - test/models/tags/partial_test.rb
 - test/models/tags/snippet_test.rb
+- test/models/tags/template_test.rb
 - test/models/view_methods_test.rb
 - test/test_helper.rb
 homepage: http://github.com/comfy/comfortable-mexican-sofa