comfortable_mexican_sofa 2.0.12 → 2.0.13

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

@@ -1,10 +1,6 @@
 - begin
   - nodes = record.fragment_nodes
-
-  // Grouping nodes by their namespace
-  - namespace = nodes.each_with_object({}) do |n, h|
-    - h[n.namespace] ||= []
-    - h[n.namespace] << n
+  - namespace = nodes.group_by(&:namespace)
 
   #form-fragments
     - if nodes.empty?
@@ -14,29 +10,29 @@
         = t(".no_tags").html_safe
 
     - else
-      = fields scope: :fragments, builder: ComfortableMexicanSofa::FormBuilder, bootstrap: { layout: :horizontal } do |fragments|
+      .tabbable
+        - if namespace.size > 1
+          .row
+            .col-sm-2
+            .col-sm-10
+              %ul.nav.nav-tabs
+                - namespace.each_with_index do |(name, tags), index|
+                  %li.nav-item
+                    - active = index == 0 ? "active" : nil
+                    - label = t("comfy.cms.content.namespace.#{name}", default: name.humanize)
+                    = link_to label, "#ns-#{name}", class: "nav-link #{active}", data: {toggle: "tab"}
 
-        .tabbable
-          - if namespace.size > 1
-            .row
-              .col-sm-2
-              .col-sm-10
-                %ul.nav.nav-tabs
-                  - namespace.each_with_index do |(name, tags), index|
-                    %li.nav-item
-                      - active = index == 0 ? "active" : nil
-                      - label = t("comfy.cms.content.namespace.#{name}", default: name.humanize)
-                      = link_to label, "#ns-#{name}", class: "nav-link #{active}", data: {toggle: "tab"}
+        .tab-content
+          - frag_index = 0
 
-          .tab-content
-            - frag_index = 0
+          - builder_opts = { builder: ComfortableMexicanSofa::FormBuilder, bootstrap: { layout: :horizontal }}
+          = fields scope, model: record, **builder_opts do |form|
             - namespace.each_with_index do |(name, tags), index|
               .tab-pane{id: "ns-#{name}", class: index == 0 ? "active" : nil}
                 - tags.each do |tag|
-                  = fragments.field(record, tag, frag_index)
+                  = form.fragment_field(tag, frag_index)
                   - frag_index += 1
 
-
 - rescue ComfortableMexicanSofa::Content::Renderer::SyntaxError, ComfortableMexicanSofa::Content::Tag::Error => e
   .alert.alert-danger
     = e

data/app/views/comfy/admin/cms/pages/_form.html.haml

@@ -13,7 +13,8 @@
 
 = comfy_admin_partial "comfy/admin/cms/partials/page_form_inner", form: form
 
-= render "comfy/admin/cms/fragments/form_fragments", form: form, record: @page
+#form-fragments-container
+  = render "comfy/admin/cms/fragments/form_fragments", record: @page, scope: :page
 
 = render "comfy/admin/cms/categories/form", form: form
 
@@ -25,6 +26,6 @@
 = comfy_admin_partial "comfy/admin/cms/partials/page_form_after", form: form
 
 = form.form_actions do
-  = submit_tag t(".preview"), name: "preview", id: nil, class: "btn btn-secondary", data: {disable_with: false}
+  = submit_tag t(".preview"), name: "preview", formtarget: "comfy-cms-preview", id: nil, class: "btn btn-secondary", data: {disable_with: false}
   = submit_tag t(@page.new_record?? ".create" : ".update"), class: "btn btn-primary ml-sm-1", data: {disable_with: false}
   = link_to t(".cancel"), comfy_admin_cms_site_pages_path, class: "btn btn-link"

data/app/views/comfy/admin/cms/pages/toggle_branch.js.erb

@@ -1,10 +1,12 @@
+// TODO: Extract this so the server only renders the HTML.
 var li = $('li#comfy_cms_page_<%=@page.id%>');
 li.find('.item .toggle').first().toggleClass('open');
 
 <% if session[:cms_page_tree].member?(@page.id.to_s) %>
   if(!li.find('ul.children')[0]) {
     li.append('<ul class="children sortable pl-md-3"><%= escape_javascript(render partial: "index_branch", collection: @page.children) %></ul>');
-    CMS.sortable_list();
+    CMS.sortableList.destroy();
+    CMS.sortableList.init();
   }
 <% else %>
   li.find('ul.children').remove();

data/app/views/comfy/admin/cms/translations/_form.html.haml

@@ -7,13 +7,14 @@
 - if (options = ::Comfy::Cms::Layout.options_for_select(@site)).present?
   = form.select :layout_id, options, {}, {data: {url: form_fragments_comfy_admin_cms_site_page_translation_path(@site, @page, @translation.id.to_i)}, id: "fragments-toggle"}
 
-= render "comfy/admin/cms/fragments/form_fragments", record: @translation
+#form-fragments-container
+  = render "comfy/admin/cms/fragments/form_fragments", record: @translation, scope: :translation
 
 = form.check_box :is_published
 
 = comfy_admin_partial "comfy/admin/cms/partials/translation_form_after", form: form
 
 = form.form_actions do
-  = submit_tag t(".preview"), name: "preview", id: nil, class: "btn btn-secondary", data: {disable_with: false}
+  = submit_tag t(".preview"), name: "preview", formtarget: "comfy-cms-preview", id: nil, class: "btn btn-secondary", data: {disable_with: false}
   = submit_tag t(@translation.new_record? ? ".create" : ".update"), class: "btn btn-primary", data: {disable_with: false}
   = link_to t(".cancel"), edit_comfy_admin_cms_site_page_path(@site, @page), class: "btn btn-link"

data/app/views/layouts/comfy/admin/cms.html.haml

@@ -2,4 +2,3 @@
 %html{lang: I18n.locale}
   = render 'layouts/comfy/admin/cms/head'
   = render 'layouts/comfy/admin/cms/body'
-  = render 'comfy/admin/cms/files/modal' if @site && !@site.new_record?

data/app/views/layouts/comfy/admin/cms/_body.html.haml

@@ -7,6 +7,7 @@
       #cms-main.col-lg-8.m-auto
         = render "layouts/comfy/admin/cms/flash"
         = yield
+        = render 'comfy/admin/cms/files/modal' if @site && !@site.new_record?
       #cms-right.col-lg-2
         = render 'layouts/comfy/admin/cms/right'
 

data/app/views/layouts/comfy/admin/cms/_left.html.haml

@@ -23,7 +23,7 @@
             = t('comfy.admin.cms.base.snippets')
         %li.nav-item
           - unless is_active_link?(comfy_admin_cms_site_files_path(@site))
-            %a.cms-files-open-modal{href: '#', title: "Open library"}
+            %a.cms-files-open-modal{href: comfy_admin_cms_site_files_path(@site), title: "Open library"}
               %i.fas.fa-bars
           = active_link_to comfy_admin_cms_site_files_path(@site), class: "nav-link" do
             = t('comfy.admin.cms.base.files')

data/comfortable_mexican_sofa.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
 require "comfortable_mexican_sofa/version"
 
@@ -15,10 +17,9 @@ Gem::Specification.new do |s|
     f.match(%r{^(test|doc)/})
   end
 
-  s.required_ruby_version = ">= 2.2.2"
+  s.required_ruby_version = ">= 2.3.0"
 
   s.add_dependency "active_link_to",        ">= 1.0.0"
-  s.add_dependency "coffee-rails",          ">= 4.2.0"
   s.add_dependency "comfy_bootstrap_form",  ">= 4.0.0"
   s.add_dependency "haml-rails",            ">= 1.0.0"
   s.add_dependency "jquery-rails",          ">= 4.3.1"

data/config.ru

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This file is used by Rack-based servers to start the application.
 
 require ::File.expand_path("../config/environment", __FILE__)

data/config/application.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "boot"
 
 require "rails/all"

data/config/boot.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Set up gems listed in the Gemfile.
 ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile", __FILE__)
 

data/config/cms_routes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # We can't have this in config/routes.rb as they will get pulled in into parent
 # application automatically. We want user to manually place them.
 ComfortableMexicanSofa::Application.routes.draw do

data/config/environment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Load the rails application
 require File.expand_path("../application", __FILE__)
 

data/config/environments/development.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 defined?(ComfortableMexicanSofa::Application) && ComfortableMexicanSofa::Application.configure do
   # Settings specified here will take precedence over those in config/application.rb.
 

data/config/environments/test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 defined?(ComfortableMexicanSofa::Application) && ComfortableMexicanSofa::Application.configure do
   # Settings specified here will take precedence over those in config/application.rb.
 

data/config/initializers/comfortable_mexican_sofa.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 ComfortableMexicanSofa.configure do |config|
   # Title of the admin area
   #   config.cms_title = 'ComfortableMexicanSofa CMS Engine'

data/lib/comfortable_mexican_sofa.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Loading engine only if this is not a standalone installation
 unless defined? ComfortableMexicanSofa::Application
   require_relative "comfortable_mexican_sofa/engine"

data/lib/comfortable_mexican_sofa/access_control/admin_authentication.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ComfortableMexicanSofa::AccessControl
   module AdminAuthentication
 

data/lib/comfortable_mexican_sofa/access_control/admin_authorization.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ComfortableMexicanSofa::AccessControl
   module AdminAuthorization
 

data/lib/comfortable_mexican_sofa/access_control/public_authentication.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ComfortableMexicanSofa::AccessControl
   module PublicAuthentication
 

data/lib/comfortable_mexican_sofa/access_control/public_authorization.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ComfortableMexicanSofa::AccessControl
   module PublicAuthorization
 

data/lib/comfortable_mexican_sofa/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class ComfortableMexicanSofa::Configuration
 
   # Don't like ComfortableMexicanSofa? Set it to whatever you like. :(
@@ -45,6 +47,7 @@ class ComfortableMexicanSofa::Configuration
   attr_accessor :admin_cache_sweeper
 
   # Not allowing erb code to be run inside page content. False by default.
+  # @return [Boolean]
   attr_accessor :allow_erb
 
   # Whitelist of all helper methods that can be used via {{cms:helper}} tag. By default

data/lib/comfortable_mexican_sofa/content.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ComfortableMexicanSofa::Content
   # ...
 end
@@ -23,6 +25,7 @@ require_relative "content/tags/files"
 require_relative "content/tags/snippet"
 require_relative "content/tags/asset"
 require_relative "content/tags/file_link"
+require_relative "content/tags/page_file_link"
 require_relative "content/tags/helper"
 require_relative "content/tags/partial"
 require_relative "content/tags/template"

data/lib/comfortable_mexican_sofa/content/block.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # wtf does this mean
 # it means that all nodes between this must be moved into here
 # {{cms:block}} some content {{cms:end_block}}

data/lib/comfortable_mexican_sofa/content/params_parser.rb

@@ -1,54 +1,73 @@
+# frozen_string_literal: true
+
+require "strscan"
+
 module ComfortableMexicanSofa::Content::ParamsParser
 
   class Error < StandardError; end
 
-  SINGLE_STRING_LITERAL = %r{'[^']*'}
-  DOUBLE_STRING_LITERAL = %r{"[^"]*"}
-  IDENTIFIER            = %r{[a-z0-9][\w\-/.]*}i
-  COLUMN                = %r{:}
-  COMMA                 = %r{,}
+  STRING_LITERAL = %r{'[^']*'|"[^"]*"}
+  IDENTIFIER     = %r{[a-z0-9][\w\-/.]*}i
+  COLON          = %r{:}
+  COMMA          = %r{,}
 
+  # @param [String] text
+  # @return [Array<String, {String => String}>]
+  # @raise [Error] if the given `text` is malformed.
+  #
+  # @example
+  #   parse("happy greeting name:Joe show:true")
+  #   #=> ['happy', 'greeting', {'name' => 'Joe', 'show' => 'true'}]
   def self.parse(text)
-    parameterize(slice(tokenize(text.to_s)))
+    parse_token_groups(split_on_commas(tokenize(text.to_s)))
   end
 
-  def self.parameterize(token_groups)
-    params = []
-    token_groups.each do |tokens|
-      if tokens.count == 1
-        collect_param_for_string!(params, tokens[0])
-      elsif tokens.count == 3
-        collect_param_for_hash!(params, tokens)
+  # @param [Enumerable<Array<(Symbol, String)>>] token_groups
+  # @return [Array<String, {String => String}>]
+  def self.parse_token_groups(token_groups)
+    token_groups.each_with_object([]) do |tokens, params|
+      case tokens.count
+      when 1
+        params << parse_string_param(tokens[0])
+      when 3
+        param = parse_key_value_param(tokens)
+        if params.last.is_a?(Hash)
+          params.last.update(param)
+        else
+          params << param
+        end
       else
         raise Error, "Unexpected tokens found: #{tokens}"
       end
     end
-    params
   end
 
-  def self.collect_param_for_string!(params, token)
+  # @param [(:string, String)] token
+  # @return [String]
+  # @raise [Error] if `token[0] != :string`.
+  def self.parse_string_param(token)
     type, value = token
     raise Error, "Unexpected token: #{token}" unless type == :string
-    params << value
+    value
   end
 
-  def self.collect_param_for_hash!(params, tokens)
-    key, col, val = tokens
-    key_type, key_value = key
-    col_type,           = col
-    val_type, val_value = val
-
-    unless key_type == :string && col_type == :column && val_type == :string
+  # @param [((:string, String), (:colon, String), (:string, String))] tokens
+  # @return [{String => String}]
+  # @raise [Error] if `tokens[0][0] != :string`, or `tokens[1][0] != :colon`,
+  #   or `tokens[2][0] != :string`.
+  def self.parse_key_value_param(tokens)
+    (key_type, key_value), (col_type, _col_value), (val_type, val_value) = tokens
+    unless key_type == :string && col_type == :colon && val_type == :string
       raise Error, "Unexpected tokens: #{tokens}"
     end
-
-    hash = params.last.is_a?(Hash) ? params.pop : {}
-    hash[key_value] = val_value
-    params << hash
+    { key_value => val_value }
   end
 
-  # grouping tokens based on the comma and also removing comma tokens
-  def self.slice(tokens)
+  # Splits tokens on commas. The result contains no `:comma` tokens.
+  #
+  # @param [Enumerable<(Symbol, String)>] tokens
+  # @return [Enumerable<Array<(Symbol, String)>>] Token groups.
+  def self.split_on_commas(tokens)
     slices = tokens.slice_after do |token|
       token[0] == :comma
     end
@@ -59,25 +78,24 @@ module ComfortableMexicanSofa::Content::ParamsParser
 
   # Tokenizing input string into a list of touples
   # Also args_string is stripped of "smart" quotes coming from wysiwyg
+  #
+  # @param [String] args_string
+  # @return [Array<String>] tokens
   def self.tokenize(args_string)
-    args_string.gsub!(%r{[“”]}, '"')
-    args_string.gsub!(%r{[‘’]}, "'")
-
-    tokens = []
+    args_string = args_string.tr("“”‘’", %q(""''))
     ss = StringScanner.new(args_string)
-    until ss.eos?
+    tokens = []
+    loop do
       ss.skip(%r{\s*})
       break if ss.eos?
-      token =
-        if    (t = ss.scan(SINGLE_STRING_LITERAL)) then [:string, t[1...t.size - 1]]
-        elsif (t = ss.scan(DOUBLE_STRING_LITERAL)) then [:string, t[1...t.size - 1]]
-        elsif (t = ss.scan(IDENTIFIER))            then [:string, t]
-        elsif (t = ss.scan(COLUMN))                then [:column, t]
-        elsif (t = ss.scan(COMMA))                 then [:comma, t]
+      tokens <<
+        if    (t = ss.scan(STRING_LITERAL)) then [:string, t[1...-1]]
+        elsif (t = ss.scan(IDENTIFIER))     then [:string, t]
+        elsif (t = ss.scan(COLON))          then [:colon, t]
+        elsif (t = ss.scan(COMMA))          then [:comma, t]
         else
           raise Error, "Unexpected char: #{ss.getch}"
         end
-      tokens << token
     end
     tokens
   end

data/lib/comfortable_mexican_sofa/content/renderer.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require "strscan"
+
 # Processing content follows these stages:
 #
 #   string        - Text with tags. like this: "some {{cms:fragment content}} text"
@@ -22,16 +26,20 @@ class ComfortableMexicanSofa::Content::Renderer
 
   class << self
 
+    # @return [Hash<String, Class<ComfortableMexicanSofa::Content::Tag>>]
     def tags
       @tags ||= {}
     end
 
+    # @param [String] name
+    # @param [Class<ComfortableMexicanSofa::Content::Tag>] klass
     def register_tag(name, klass)
       tags[name.to_s] = klass
     end
 
   end
 
+  # @param [Comfy::Cms::WithFragments, nil] context
   def initialize(context)
     @context = context
     @depth   = 0
@@ -39,6 +47,8 @@ class ComfortableMexicanSofa::Content::Renderer
 
   # This is how we render content out. Takes context (cms page) and content
   # nodes
+  # @param [Array<String, ComfortableMexicanSofa::Content::Tag>]
+  # @param [Boolean] allow_erb
   def render(nodes, allow_erb = ComfortableMexicanSofa.config.allow_erb)
     if (@depth += 1) > MAX_DEPTH
       raise Error, "Deep tag nesting or recursive nesting detected"
@@ -51,7 +61,7 @@ class ComfortableMexicanSofa::Content::Renderer
       else
         tokens  = tokenize(node.render)
         nodes   = nodes(tokens)
-        render(nodes, allow_erb || node.allow_erb)
+        render(nodes, allow_erb || node.allow_erb?)
       end
     end.flatten.join
   end
@@ -65,6 +75,7 @@ class ComfortableMexicanSofa::Content::Renderer
   end
 
   # Splitting text with tags into tokens we can process down the line
+  # @return [Array<String, {Symbol => String}>]
   def tokenize(string)
     tokens = []
     ss = StringScanner.new(string.to_s)
@@ -85,6 +96,8 @@ class ComfortableMexicanSofa::Content::Renderer
   # Constructing node tree for content. It's a list of strings and tags with
   # their own `nodes` method that has array of strings and tags with their own
   # `nodes` method that... you get the idea.
+  # @param [Array<String, {Symbol => String}>] tokens
+  # @return [Array<String, ComfortableMexicanSofa::Content::Tag>]
   def nodes(tokens)
     nodes = [[]]
     tokens.each do |token|
@@ -102,10 +115,11 @@ class ComfortableMexicanSofa::Content::Renderer
           nodes.pop
 
         else
-          unless (klass = self.class.tags[tag_class])
-            raise SyntaxError, "Unrecognized tag: #{token[:source]}"
-          end
+          # @type [Class<ComfortableMexicanSofa::Content::Tag>]
+          klass = self.class.tags[tag_class] ||
+            raise(SyntaxError, "Unrecognized tag: #{token[:source]}")
 
+          # @type [ComfortableMexicanSofa::Content::Tag]
           tag = klass.new(
             context:  @context,
             params:   ComfortableMexicanSofa::Content::ParamsParser.parse(token[:tag_params]),