comfortable_mexican_sofa 2.0.8 → 2.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fb7afcd2d6042c08dd39429cbf714394ab50b286
-  data.tar.gz: 1ad39a72dc37a220429932e9df775373b7ee83c2
+SHA256:
+  metadata.gz: 79703d049752d5effd488e8aec9c2bfe55088532c485fa98ff3135d9b672d131
+  data.tar.gz: 2989239f43a6a8830e52dc9090ce06608f472af7c73078587bc5a8a01b1b9ca6
 SHA512:
-  metadata.gz: 6421a3b93ae6e47689a3fff0066334c4fe8da857d363863d35cf292a757972faa0ff54ae079ab317753549c6d0e435c1a37842e8f592d9ce4547794ad3d1ba88
-  data.tar.gz: 3eb62f07989bf29b0b0d15409b989b806c44da21a1357c19a3694ae4c7b6099a5d410f25c9abec25cbb3dc056d4e54e1f5565fdc5f79f7b8fe1ac7d5c423c6ac
+  metadata.gz: '08b837b7639498ddccccf9cfb8bc292ffb904af74bbebe4d522544005ae690db9cb90b4ebdda5230f7ed6c215687d4c62732c4c7003194543fa35871ff31b6d7'
+  data.tar.gz: 58bb9995dcdb937ac75c5f93cd1721f37e5a795537917770fab4aac221bddbf1bd1c214379375604e507c9b4c34b1ce1f206d98b1194f9afadc9fd971b5ce638

data/README.md

@@ -67,11 +67,20 @@ After creating a Site, you need to make a Layout. Layout is the template of your
 </html>
 ```
 
-[See Wiki entry on available Tags you can use](https://github.com/comfy/comfortable-mexican-sofa/wiki/Docs:-Content-Tags)
-
 Once you have a layout, you may start creating pages and populating content. It's that easy.
 
-For more information please refer to [Wiki](https://github.com/comfy/comfortable-mexican-sofa/wiki).
+## Documentation
+
+For more information on how to use this CMS please refer to the [Wiki](https://github.com/comfy/comfortable-mexican-sofa/wiki). Section that might be of interest is the entry
+on [Content Tags](https://github.com/comfy/comfortable-mexican-sofa/wiki/Docs:-Content-Tags).
+
+[Comfy Demo App](https://github.com/comfy/comfy-demo) also can be used as an
+example of a default Rails app with CMS installed.
+
+## Add-ons
+
+If you want to add a Blog functionality to your app take a look at
+[ComfyBlog](https://github.com/comfy/comfy-blog).
 
 ![Admin Area Preview](doc/preview.jpg)
 
@@ -89,8 +98,6 @@ ComfortableMexicanSofa repository can be ran like a regular Rails application in
 development environment. It's as easy to work on as any other Rails app out there.
 For more detail take a look at [CONTRIBUTING](CONTRIBUTING.md)
 
-[![Help Contribute to Open Source](https://www.codetriage.com/comfy/comfortable-mexican-sofa/badges/users.svg)](https://www.codetriage.com/comfy/comfortable-mexican-sofa)
-
 #### Help and Contact
 
 Gitter: https://gitter.im/comfy/comfortable-mexican-sofa

data/app/models/comfy/cms/translation.rb

@@ -6,6 +6,8 @@ class Comfy::Cms::Translation < ActiveRecord::Base
 
   cms_has_revisions_for :fragments_attributes
 
+  delegate :site, to: :page
+
   # -- Relationships -----------------------------------------------------------
   belongs_to :page
 

data/app/views/comfy/admin/cms/fragments/_form_fragments.html.haml

@@ -36,5 +36,7 @@
                   = fragments.field(record, tag, frag_index)
                   - frag_index += 1
 
-- rescue
-  - Rails.env.production?? nil : raise
+
+- rescue ComfortableMexicanSofa::Content::Renderer::SyntaxError, ComfortableMexicanSofa::Content::Tag::Error => e
+  .alert.alert-danger
+    = e

data/lib/comfortable_mexican_sofa/content/renderer.rb

@@ -71,7 +71,11 @@ class ComfortableMexicanSofa::Content::Renderer
     while (string = ss.scan_until(TAG_REGEX))
       text = string.sub(ss[0], "")
       tokens << text unless text.empty?
-      tokens << { tag_class: ss[:class], tag_params: ss[:params].strip }
+      tokens << {
+        tag_class:  ss[:class],
+        tag_params: ss[:params].strip,
+        source:     ss[0]
+      }
     end
     text = ss.rest
     tokens << text if text.present?
@@ -99,10 +103,14 @@ class ComfortableMexicanSofa::Content::Renderer
 
         else
           unless (klass = self.class.tags[tag_class])
-            raise SyntaxError, "Unrecognized tag #{tag_class}: #{token}"
+            raise SyntaxError, "Unrecognized tag: #{token[:source]}"
           end
 
-          tag = klass.new(@context, token[:tag_params])
+          tag = klass.new(
+            context:  @context,
+            params:   ComfortableMexicanSofa::Content::ParamsParser.parse(token[:tag_params]),
+            source:   token[:source]
+          )
           nodes.last << tag
 
           # If it's a block tag we start collecting nodes into it

data/lib/comfortable_mexican_sofa/content/tag.rb

@@ -2,11 +2,12 @@ class ComfortableMexicanSofa::Content::Tag
 
   class Error < StandardError; end
 
-  attr_reader :context, :params
+  attr_reader :context, :params, :source
 
-  def initialize(context, params_string)
+  def initialize(context:, params: [], source: nil)
     @context  = context
-    @params   = parse_params_string(params_string)
+    @params   = params
+    @source   = source
   end
 
   # Making sure we don't leak erb from tags by accident.
@@ -18,8 +19,8 @@ class ComfortableMexicanSofa::Content::Tag
   # Normally it's a string. However if tag content has tags, we need to expand
   # them and that produces potentually more stuff
   def nodes
-    template = ComfortableMexicanSofa::Content::Renderer.new(@context)
-    tokens = template.tokenize(content)
+    template  = ComfortableMexicanSofa::Content::Renderer.new(@context)
+    tokens    = template.tokenize(content)
     template.nodes(tokens)
   end
 
@@ -31,8 +32,4 @@ class ComfortableMexicanSofa::Content::Tag
     content
   end
 
-  def parse_params_string(string)
-    ComfortableMexicanSofa::Content::ParamsParser.parse(string)
-  end
-
 end

data/lib/comfortable_mexican_sofa/content/tags/asset.rb

@@ -9,7 +9,7 @@ class ComfortableMexicanSofa::Content::Tag::Asset < ComfortableMexicanSofa::Cont
 
   attr_reader :identifier, :type, :as
 
-  def initialize(context, params_string)
+  def initialize(context:, params: [], source: nil)
     super
 
     options = params.extract_options!

data/lib/comfortable_mexican_sofa/content/tags/file.rb

@@ -14,7 +14,7 @@ class ComfortableMexicanSofa::Content::Tag::File < ComfortableMexicanSofa::Conte
 
   delegate :rails_blob_path, to: "Rails.application.routes.url_helpers"
 
-  def initialize(context, params_string)
+  def initialize(context:, params: [], source: nil)
     super
     @as             = options["as"] || "url"
     @label          = options["label"]

data/lib/comfortable_mexican_sofa/content/tags/file_link.rb

@@ -14,7 +14,7 @@ class ComfortableMexicanSofa::Content::Tag::FileLink < ComfortableMexicanSofa::C
 
   delegate :rails_blob_path, to: "Rails.application.routes.url_helpers"
 
-  def initialize(context, params_string)
+  def initialize(context:, params: [], source: nil)
     super
 
     options = params.extract_options!

data/lib/comfortable_mexican_sofa/content/tags/files.rb

@@ -3,7 +3,7 @@
 #
 class ComfortableMexicanSofa::Content::Tag::Files < ComfortableMexicanSofa::Content::Tag::File
 
-  def initialize(context, params_string)
+  def initialize(context:, params: [], source: nil)
     super
   end
 

data/lib/comfortable_mexican_sofa/content/tags/fragment.rb

@@ -10,14 +10,14 @@ class ComfortableMexicanSofa::Content::Tag::Fragment < ComfortableMexicanSofa::C
 
   attr_reader :identifier, :renderable, :namespace, :options
 
-  def initialize(context, params_string)
+  def initialize(context:, params: [], source: nil)
     super
 
     @options    = params.extract_options!
     @identifier = params[0]
 
     unless @identifier.present?
-      raise Error, "Missing identifier for fragment tag"
+      raise Error, "Missing identifier for fragment tag: #{source}"
     end
 
     @namespace  = @options["namespace"] || "default"

data/lib/comfortable_mexican_sofa/content/tags/helper.rb

@@ -11,7 +11,7 @@ class ComfortableMexicanSofa::Content::Tag::Helper < ComfortableMexicanSofa::Con
 
   attr_reader :method_name
 
-  def initialize(context, params_string)
+  def initialize(context:, params: [], source: nil)
     super
     @method_name = params.shift
 

data/lib/comfortable_mexican_sofa/content/tags/partial.rb

@@ -8,7 +8,7 @@ class ComfortableMexicanSofa::Content::Tag::Partial < ComfortableMexicanSofa::Co
 
   attr_reader :path, :locals
 
-  def initialize(context, params_string)
+  def initialize(context:, params: [], source: nil)
     super
     @locals = params.extract_options!
     @path   = params[0]

data/lib/comfortable_mexican_sofa/content/tags/snippet.rb

@@ -6,7 +6,7 @@ class ComfortableMexicanSofa::Content::Tag::Snippet < ComfortableMexicanSofa::Co
 
   attr_reader :identifier
 
-  def initialize(context, params_string)
+  def initialize(context:, params: [], source: nil)
     super
     @identifier = params[0]
 

data/lib/comfortable_mexican_sofa/content/tags/template.rb

@@ -8,7 +8,7 @@ class ComfortableMexicanSofa::Content::Tag::Template < ComfortableMexicanSofa::C
 
   attr_reader :path
 
-  def initialize(context, params_string)
+  def initialize(context:, params: [], source: nil)
     super
     @path = params[0]
 

data/lib/comfortable_mexican_sofa/version.rb

@@ -1,5 +1,5 @@
 module ComfortableMexicanSofa
 
-  VERSION = "2.0.8".freeze
+  VERSION = "2.0.9".freeze
 
 end

data/test/controllers/comfy/admin/cms/pages_controller_test.rb

@@ -186,15 +186,18 @@ class Comfy::Admin::Cms::PagesControllerTest < ActionDispatch::IntegrationTest
     assert_select "label.renderable-false", "B"
   end
 
-  def test_get_new_with_crashy_tag
+  def test_get_new_with_invalid_tag
     @layout.update_column(:content, "{{cms:invalid}}")
-    assert_exception_raised do
-      r :get, new_comfy_admin_cms_site_page_path(site_id: @site)
-    end
+    r :get, new_comfy_admin_cms_site_page_path(site_id: @site)
+    assert_response :success
+    assert_select "div.alert-danger", "Unrecognized tag: {{cms:invalid}}"
+  end
 
-    Rails.stubs(env: ActiveSupport::StringInquirer.new("production"))
+  def test_get_new_with_invalid_fragment_tag
+    @layout.update_column(:content, "a {{cms:markdown}} b")
     r :get, new_comfy_admin_cms_site_page_path(site_id: @site)
     assert_response :success
+    assert_select "div.alert-danger", "Missing identifier for fragment tag: {{cms:markdown}}"
   end
 
   def test_get_new_with_repeated_tag

data/test/controllers/comfy/cms/content_controller_test.rb

@@ -230,4 +230,20 @@ class Comfy::Cms::ContentControllerTest < ActionDispatch::IntegrationTest
     end
   end
 
+  def test_with_translation_with_snippet
+    translation = @page.translations.create!(
+      locale: "ja",
+      label:  "Test Translation",
+      fragments_attributes: [
+        { identifier: "content",
+          tag:        "text",
+          content:    "test {{cms:snippet default}} test" }
+      ]
+    )
+    I18n.locale = translation.locale
+
+    get comfy_cms_render_page_path(cms_path: "")
+    assert_equal "test snippet content test", response.body
+  end
+
 end

data/test/lib/content/block_test.rb

@@ -17,7 +17,7 @@ class ContentBlockTest < ActiveSupport::TestCase
   # -- Tests -------------------------------------------------------------------
 
   def test_block_tag_nodes
-    block = TestBlockTag.new(nil, "")
+    block = TestBlockTag.new(context: nil)
     assert_equal [], block.nodes
     block.nodes << "text"
     assert_equal ["text"], block.nodes

data/test/lib/content/renderer_test.rb

@@ -42,7 +42,8 @@ class ContentRendererTest < ActiveSupport::TestCase
   }.freeze
 
   setup do
-    @template = ComfortableMexicanSofa::Content::Renderer.new(comfy_cms_pages(:default))
+    @page     = comfy_cms_pages(:default)
+    @template = ComfortableMexicanSofa::Content::Renderer.new(@page)
 
     ComfortableMexicanSofa::Content::Renderer.register_tag(:test, TestTag)
     ComfortableMexicanSofa::Content::Renderer.register_tag(:test_nested, TestNestedTag)
@@ -89,13 +90,17 @@ class ContentRendererTest < ActiveSupport::TestCase
   end
 
   def test_tokenize_with_tag
-    assert_equal ["test ", { tag_class: "tag", tag_params: "" }, " text"],
+    assert_equal ["test ", { tag_class: "tag", tag_params: "", source: "{{cms:tag}}" }, " text"],
       @template.tokenize("test {{cms:tag}} text")
   end
 
   def test_tokenize_with_tag_and_params
-    assert_equal ["test ", { tag_class: "tag", tag_params: "name, key:val" }, " text"],
-      @template.tokenize("test {{cms:tag name, key:val}} text")
+    expected = [
+      "test ",
+      { tag_class: "tag", tag_params: "name, key:val", source: "{{cms:tag name, key:val}}" },
+      " text"
+    ]
+    assert_equal expected, @template.tokenize("test {{cms:tag name, key:val}} text")
   end
 
   def test_tokenize_with_invalid_tag
@@ -104,8 +109,12 @@ class ContentRendererTest < ActiveSupport::TestCase
   end
 
   def test_tokenize_with_newlines
-    assert_equal [{ tag_class: "test", tag_params: "" }, "\n", { tag_class: "test", tag_params: "" }],
-      @template.tokenize("{{cms:test}}\n{{cms:test}}")
+    expected = [
+      { tag_class: "test", tag_params: "", source: "{{cms:test}}" },
+      "\n",
+      { tag_class: "test", tag_params: "", source: "{{cms:test}}" }
+    ]
+    assert_equal expected, @template.tokenize("{{cms:test}}\n{{cms:test}}")
   end
 
   def test_nodes
@@ -124,6 +133,17 @@ class ContentRendererTest < ActiveSupport::TestCase
     assert nodes[3].is_a?(ContentRendererTest::TestTag)
   end
 
+  def test_nodes_with_tag_with_params
+    tokens = @template.tokenize("{{cms:test param, key: value}}")
+    nodes = @template.nodes(tokens)
+    assert_equal 1, nodes.count
+    assert nodes[0].is_a?(ContentRendererTest::TestTag)
+    tag = nodes[0]
+    assert_equal @page, tag.context
+    assert_equal ["param", { "key" => "value" }], tag.params
+    assert_equal "{{cms:test param, key: value}}", tag.source
+  end
+
   def test_nodes_with_block_tag
     string = "a {{cms:test_block}} b {{cms:end}} c"
     tokens = @template.tokenize(string)
@@ -178,7 +198,8 @@ class ContentRendererTest < ActiveSupport::TestCase
   def test_nodes_with_unclosed_block_tag
     string = "a {{cms:test_block}} b"
     tokens = @template.tokenize(string)
-    assert_exception_raised ComfortableMexicanSofa::Content::Renderer::SyntaxError, "unclosed block detected" do
+    message = "unclosed block detected"
+    assert_exception_raised ComfortableMexicanSofa::Content::Renderer::SyntaxError, message do
       @template.nodes(tokens)
     end
   end
@@ -186,7 +207,17 @@ class ContentRendererTest < ActiveSupport::TestCase
   def test_nodes_with_closed_tag
     string = "a {{cms:end}} b"
     tokens = @template.tokenize(string)
-    assert_exception_raised ComfortableMexicanSofa::Content::Renderer::SyntaxError, "closing unopened block" do
+    message = "closing unopened block"
+    assert_exception_raised ComfortableMexicanSofa::Content::Renderer::SyntaxError, message do
+      @template.nodes(tokens)
+    end
+  end
+
+  def test_nodes_with_invalid_tag
+    string = "a {{cms:invalid}} b"
+    tokens = @template.tokenize(string)
+    message = "Unrecognized tag: {{cms:invalid}}"
+    assert_exception_raised ComfortableMexicanSofa::Content::Renderer::SyntaxError, message do
       @template.nodes(tokens)
     end
   end

data/test/lib/content/tag_test.rb

@@ -30,18 +30,24 @@ class ContentTagTest < ActiveSupport::TestCase
 
   # -- Tests -------------------------------------------------------------------
 
-  def test_init_with_params
-    tag = TestTag.new(nil, "param_a, key: value")
+  def test_init
+    tag = TestTag.new(
+      context:  comfy_cms_pages(:default),
+      params:   ["param_a", { "key" => "value" }],
+      source:   "source"
+    )
+    assert_equal comfy_cms_pages(:default), tag.context
     assert_equal ["param_a", { "key" => "value" }], tag.params
+    assert_equal "source", tag.source
   end
 
   def test_nodes
-    tag = TestTag.new(nil, "")
+    tag = TestTag.new(context: nil, params: [], source: "")
     assert_equal ["test tag content"], tag.nodes
   end
 
   def test_tag_nodes_with_nested_tag
-    tag = TestNestedTag.new(nil, "")
+    tag = TestNestedTag.new(context: nil, params: [], source: "")
     nodes = tag.nodes
     assert_equal 3, nodes.count
     assert_equal "test ", nodes[0]

data/test/lib/content/tags/asset_test.rb

@@ -7,14 +7,20 @@ class ContentTagsAssetTest < ActiveSupport::TestCase
   end
 
   def test_init
-    tag = ComfortableMexicanSofa::Content::Tag::Asset.new(@page, "default")
+    tag = ComfortableMexicanSofa::Content::Tag::Asset.new(
+      context: @page,
+      params: ["default"]
+    )
     assert_equal "default", tag.identifier
     assert_nil tag.type
     assert_equal "url", tag.as
   end
 
   def test_init_with_params
-    tag = ComfortableMexicanSofa::Content::Tag::Asset.new(@page, "default, type: css, as: tag")
+    tag = ComfortableMexicanSofa::Content::Tag::Asset.new(
+      context: @page,
+      params: ["default", { "type" => "css", "as" => "tag" }]
+    )
     assert_equal "default", tag.identifier
     assert_equal "css", tag.type
     assert_equal "tag", tag.as
@@ -23,28 +29,34 @@ class ContentTagsAssetTest < ActiveSupport::TestCase
   def test_init_without_identifier
     message = "Missing layout identifier for asset tag"
     assert_exception_raised ComfortableMexicanSofa::Content::Tag::Error, message do
-      ComfortableMexicanSofa::Content::Tag::Asset.new(@page, "")
+      ComfortableMexicanSofa::Content::Tag::Asset.new(context: @page)
     end
   end
 
   def test_layout
-    tag = ComfortableMexicanSofa::Content::Tag::Asset.new(@page, "default")
+    tag = ComfortableMexicanSofa::Content::Tag::Asset.new(context: @page, params: ["default"])
     assert tag.layout.is_a?(Comfy::Cms::Layout)
   end
 
   def test_content_for_invalid
-    tag = ComfortableMexicanSofa::Content::Tag::Asset.new(@page, "default")
+    tag = ComfortableMexicanSofa::Content::Tag::Asset.new(context: @page, params: ["default"])
     assert_nil tag.content
   end
 
   def test_content_for_css
-    tag = ComfortableMexicanSofa::Content::Tag::Asset.new(@page, "default, type: css")
+    tag = ComfortableMexicanSofa::Content::Tag::Asset.new(
+      context: @page,
+      params: ["default", { "type" => "css" }]
+    )
     out = "/cms-css/#{@page.site_id}/#{@page.layout.identifier}/#{@page.layout.cache_buster}.css"
     assert_equal out, tag.content
   end
 
   def test_content_for_css_as_tag
-    tag = ComfortableMexicanSofa::Content::Tag::Asset.new(@page, "default, type: css, as: tag")
+    tag = ComfortableMexicanSofa::Content::Tag::Asset.new(
+      context: @page,
+      params: ["default", { "type" => "css", "as" => "tag" }]
+    )
     out = "/cms-css/#{@page.site_id}/#{@page.layout.identifier}/#{@page.layout.cache_buster}.css"
     out = "<link href='#{out}' media='screen' rel='stylesheet' type='text/css' />"
     assert_equal out, tag.content
@@ -52,19 +64,28 @@ class ContentTagsAssetTest < ActiveSupport::TestCase
 
   def test_content_for_css_with_public_cms_path
     ComfortableMexicanSofa.config.public_cms_path = "/custom"
-    tag = ComfortableMexicanSofa::Content::Tag::Asset.new(@page, "default, type: css")
+    tag = ComfortableMexicanSofa::Content::Tag::Asset.new(
+      context: @page,
+      params: ["default", { "type" => "css" }]
+    )
     out = "/custom/cms-css/#{@page.site_id}/#{@page.layout.identifier}/#{@page.layout.cache_buster}.css"
     assert_equal out, tag.content
   end
 
   def test_content_for_js
-    tag = ComfortableMexicanSofa::Content::Tag::Asset.new(@page, "default, type: js")
+    tag = ComfortableMexicanSofa::Content::Tag::Asset.new(
+      context: @page,
+      params: ["default", { "type" => "js" }]
+    )
     out = "/cms-js/#{@page.site_id}/#{@page.layout.identifier}/#{@page.layout.cache_buster}.js"
     assert_equal out, tag.content
   end
 
   def test_content_for_js_as_tag
-    tag = ComfortableMexicanSofa::Content::Tag::Asset.new(@page, "default, type: js, as: tag")
+    tag = ComfortableMexicanSofa::Content::Tag::Asset.new(
+      context: @page,
+      params: ["default", { "type" => "js", "as" => "tag" }]
+    )
     out = "/cms-js/#{@page.site_id}/#{@page.layout.identifier}/#{@page.layout.cache_buster}.js"
     out = "<script src='#{out}' type='text/javascript'></script>"
     assert_equal out, tag.content
@@ -72,7 +93,10 @@ class ContentTagsAssetTest < ActiveSupport::TestCase
 
   def test_content_for_js_with_public_cms_path
     ComfortableMexicanSofa.config.public_cms_path = "/custom"
-    tag = ComfortableMexicanSofa::Content::Tag::Asset.new(@page, "default, type: js")
+    tag = ComfortableMexicanSofa::Content::Tag::Asset.new(
+      context: @page,
+      params: ["default", { "type" => "js" }]
+    )
     out = "/custom/cms-js/#{@page.site_id}/#{@page.layout.identifier}/#{@page.layout.cache_buster}.js"
     assert_equal out, tag.content
   end