comfortable_mexican_sofa 2.0.12 → 2.0.13

data/lib/comfortable_mexican_sofa/content/tag.rb

@@ -1,9 +1,21 @@
+# frozen_string_literal: true
+
 class ComfortableMexicanSofa::Content::Tag
 
   class Error < StandardError; end
 
-  attr_reader :context, :params, :source
+  # @type [Comfy::Cms::WithFragments]
+  attr_reader :context
+
+  # @type [Array<String, {String => String}>] params
+  attr_reader :params
+
+  # @type [String, nil] source
+  attr_reader :source
 
+  # @param [Comfy::Cms::WithFragments] context
+  # @param [Array<String, {String => String}>] params
+  # @param [String, nil] source
   def initialize(context:, params: [], source: nil)
     @context  = context
     @params   = params
@@ -12,22 +24,25 @@ class ComfortableMexicanSofa::Content::Tag
 
   # Making sure we don't leak erb from tags by accident.
   # Tag classes can override this, like partials/helpers tags.
-  def allow_erb
-    false || ComfortableMexicanSofa.config.allow_erb
+  def allow_erb?
+    ComfortableMexicanSofa.config.allow_erb
   end
 
-  # Normally it's a string. However if tag content has tags, we need to expand
-  # them and that produces potentually more stuff
+  # Normally it's a {(String)}. However, if tag content has tags,
+  # we need to expand them and that produces potentially more stuff.
+  # @return [Array<String, ComfortableMexicanSofa::Content::Tag>]
   def nodes
     template  = ComfortableMexicanSofa::Content::Renderer.new(@context)
     tokens    = template.tokenize(content)
     template.nodes(tokens)
   end
 
+  # @return [String]
   def content
     raise Error, "This is a base class. It holds no content"
   end
 
+  # @return [String]
   def render
     content
   end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This tag allows for linking of js and css content defined on the layout.
 # Looks something like this:
 #   {{cms:asset layout_identifier, type: css, as: tag}}

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Tag for boolean content that is going to be rendered using checkbox
 #   {{ cms:checkbox identifier }}
 #
@@ -9,10 +11,15 @@ class ComfortableMexicanSofa::Content::Tag::Checkbox < ComfortableMexicanSofa::C
 
   def form_field(object_name, view, index)
     name = "#{object_name}[fragments_attributes][#{index}][boolean]"
-    checkbox_hidden = view.hidden_field_tag(name, "0", id: nil)
-    checkbox_input  = view.check_box_tag(name, "1", content.present?, id: nil)
 
-    yield [checkbox_hidden, checkbox_input].join.html_safe
+    input = view.content_tag(:div, class: "form-check mt-2") do
+      view.concat view.hidden_field_tag(name, "0", id: nil)
+
+      options = { id: form_field_id, class: "form-check-input position-static" }
+      view.concat view.check_box_tag(name, "1", content.present?, options)
+    end
+
+    yield input
   end
 
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Tag for text content that is going to be rendered using text input with date widget
 #   {{ cms:date identifier }}
 #
@@ -9,7 +11,7 @@ class ComfortableMexicanSofa::Content::Tag::Date < ComfortableMexicanSofa::Conte
 
   def form_field(object_name, view, index)
     name    = "#{object_name}[fragments_attributes][#{index}][datetime]"
-    options = { id: nil, class: "form-control", data: { "cms-date" => true } }
+    options = { id: form_field_id, class: "form-control", data: { "cms-date" => true } }
     value   = content.present? ? content.to_s(:db) : ""
     input   = view.send(:text_field_tag, name, value, options)
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Tag for text content that is going to be rendered using text input with datetime widget
 #   {{ cms:datetime identifier }}
 #
@@ -9,7 +11,7 @@ class ComfortableMexicanSofa::Content::Tag::Datetime < ComfortableMexicanSofa::C
 
   def form_field(object_name, view, index)
     name    = "#{object_name}[fragments_attributes][#{index}][datetime]"
-    options = { id: nil, class: "form-control", data: { "cms-datetime" => true } }
+    options = { id: form_field_id, class: "form-control", data: { "cms-datetime" => true } }
     value   = content.present? ? content.to_s(:db) : ""
     input   = view.send(:text_field_tag, name, value, options)
 

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

@@ -1,6 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "./mixins/file_content"
+
 # File tag allows attaching of file to the page. This controls how files are
 # uploaded and then displayed on the page. Example tag:
-#   {{cms:file identifier, as: link, label: "My File"}}
+#   {{ cms:file identifier, as: link, label: "My File" }}
 #
 # `as`      - url (default) | link | image - render out link or image tag
 # `label`   - attach label attribute to link or image tag
@@ -10,10 +14,15 @@
 #
 class ComfortableMexicanSofa::Content::Tag::File < ComfortableMexicanSofa::Content::Tag::Fragment
 
-  attr_reader :as, :variant_attrs
+  include ComfortableMexicanSofa::Content::Tag::Mixins::FileContent
 
-  delegate :rails_blob_path, to: "Rails.application.routes.url_helpers"
+  # @type ["url", "link", "image"]
+  attr_reader :as
 
+  # @type [{String => String}]
+  attr_reader :variant_attrs
+
+  # @param (see ComfortableMexicanSofa::Content::Tag#initialize)
   def initialize(context:, params: [], source: nil)
     super
     @as             = options["as"] || "url"
@@ -21,28 +30,9 @@ class ComfortableMexicanSofa::Content::Tag::File < ComfortableMexicanSofa::Conte
     @variant_attrs  = options.slice("resize", "gravity", "crop")
   end
 
-  def content(file = attachment)
-    return "" unless file
-
-    if @variant_attrs.present? && attachment.image?
-      file = file.variant(@variant_attrs)
-    end
-
-    url = rails_blob_path(file, only_path: true)
-
-    case @as
-    when "link"
-      "<a href='#{url}' target='_blank'>#{label}</a>"
-    when "image"
-      "<img src='#{url}' alt='#{label}'/>"
-    else
-      url
-    end
-  end
-
   def form_field(object_name, view, index)
     name    = "#{object_name}[fragments_attributes][#{index}][files]"
-    input   = view.send(:file_field_tag, name, id: nil, class: "form-control")
+    input   = view.send(:file_field_tag, name, id: form_field_id, class: "form-control")
 
     attachments_partial =
       if fragment.attachments
@@ -51,22 +41,26 @@ class ComfortableMexicanSofa::Content::Tag::File < ComfortableMexicanSofa::Conte
           locals: {
             object_name:  object_name,
             index:        index,
-            attachments:  fragment.attachments
+            attachments:  fragment.attachments,
+            fragment_id:  identifier,
+            multiple:     false
           }
         )
       end
 
-    yield [input, attachments_partial].join.html_safe
+    yield view.safe_join([input, attachments_partial], "")
   end
 
 protected
 
-  def attachment
+  # @return [ActiveStorage::Blob]
+  def file
     fragment.attachments.first
   end
 
+  # @return [String]
   def label
-    @label || attachment && attachment.filename
+    @label || file&.filename
   end
 
 end

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

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require_relative "./mixins/file_content"
+
 # This is how you link previously uploaded file to anywhere. Good example may be
 # a header image you want to use on the layout level.
 #   {{cms:file_link id, as: image}}
@@ -10,9 +14,16 @@
 #
 class ComfortableMexicanSofa::Content::Tag::FileLink < ComfortableMexicanSofa::Content::Tag
 
-  attr_reader :identifier, :as, :variant_attrs
+  include ComfortableMexicanSofa::Content::Tag::Mixins::FileContent
+
+  # @return [String] A {Comfy::Cms::Site#files} ID.
+  attr_reader :identifier
+
+  # @type ["url", "link", "image"]
+  attr_reader :as
 
-  delegate :rails_blob_path, to: "Rails.application.routes.url_helpers"
+  # @type [{String => String}]
+  attr_reader :variant_attrs
 
   def initialize(context:, params: [], source: nil)
     super
@@ -27,32 +38,20 @@ class ComfortableMexicanSofa::Content::Tag::FileLink < ComfortableMexicanSofa::C
     end
   end
 
-  def file
-    @file ||= context.site.files.detect { |f| f.id == identifier.to_i }
+  # @return [Comfy::Cms::File]
+  def file_record
+    @file_record ||= context.site.files.detect { |f| f.id == identifier.to_i }
   end
 
-  def label
-    @file.label.present? ? @file.label : @file.attachment.filename
+  # @return [ActiveStorage::Blob]
+  def file
+    file_record&.attachment
   end
 
-  def content
-    return "" unless file && file.attachment
-
-    attachment = file.attachment
-    if @variant_attrs.present? && attachment.image?
-      attachment = attachment.variant(@variant_attrs)
-    end
-
-    url = rails_blob_path(attachment, only_path: true)
-
-    case @as
-    when "link"
-      "<a href='#{url}' target='_blank'>#{label}</a>"
-    when "image"
-      "<img src='#{url}' alt='#{label}'/>"
-    else
-      url
-    end
+  # @return [String]
+  def label
+    return "" if file_record.nil?
+    file_record.label.presence || file.filename.to_s
   end
 
 end

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

@@ -1,23 +1,23 @@
+# frozen_string_literal: true
+
 # Same tag as File, only it handles multiple attachments.
-# Generally not a bad idea to handle rendering of this in a partial/helper
+# Generally not a bad idea to handle rendering of this in a partial/helper.
+# Example tag:
+#   {{ cms:files identifier }}
 #
 class ComfortableMexicanSofa::Content::Tag::Files < ComfortableMexicanSofa::Content::Tag::File
 
-  def initialize(context:, params: [], source: nil)
-    super
-  end
-
   def content
     return "" if fragment.attachments.blank?
 
     fragment.attachments.collect do |attachment|
-      super(attachment)
+      super(file: attachment, label: attachment.filename)
     end.join(" ")
   end
 
   def form_field(object_name, view, index)
     name    = "#{object_name}[fragments_attributes][#{index}][files][]"
-    input   = view.send(:file_field_tag, name, id: nil, multiple: true, class: "form-control")
+    input   = view.send(:file_field_tag, name, id: form_field_id, multiple: true, class: "form-control")
 
     attachments_partial =
       if fragment.attachments
@@ -26,12 +26,14 @@ class ComfortableMexicanSofa::Content::Tag::Files < ComfortableMexicanSofa::Cont
           locals: {
             object_name:  object_name,
             index:        index,
-            attachments:  fragment.attachments
+            attachments:  fragment.attachments,
+            fragment_id:  identifier,
+            multiple:     true
           }
         )
       end
 
-    yield [input, attachments_partial].join.html_safe
+    yield view.safe_join([input, attachments_partial], "")
   end
 
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Base Tag class that other fragment tags depend on.
 # Tag handles following options:
 #   `render`: true (default) | false
@@ -8,7 +10,10 @@
 #
 class ComfortableMexicanSofa::Content::Tag::Fragment < ComfortableMexicanSofa::Content::Tag
 
-  attr_reader :identifier, :renderable, :namespace, :options
+  attr_reader :identifier, :renderable, :namespace
+
+  # @type [{String => String}]
+  attr_reader :options
 
   def initialize(context:, params: [], source: nil)
     super
@@ -25,6 +30,7 @@ class ComfortableMexicanSofa::Content::Tag::Fragment < ComfortableMexicanSofa::C
   end
 
   # Grabs existing fragment record or spins up a new instance if there's none
+  # @return [Comfy::Cms::Fragment]
   def fragment
     context.fragments.detect { |f| f.identifier == identifier } ||
       context.fragments.build(identifier: identifier)
@@ -52,4 +58,8 @@ class ComfortableMexicanSofa::Content::Tag::Fragment < ComfortableMexicanSofa::C
     raise "Form field rendering not implemented for this Tag"
   end
 
+  def form_field_id
+    "fragment-#{@identifier}"
+  end
+
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Tag for injecting view helpers. Example tag:
 #   {{cms:helper method_name, param_a, param_b, foo: bar}}
 # This expands into something like this:
@@ -21,7 +23,7 @@ class ComfortableMexicanSofa::Content::Tag::Helper < ComfortableMexicanSofa::Con
   end
 
   # we output erb into rest of the content
-  def allow_erb
+  def allow_erb?
     true
   end
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Tag for text content that is going to be rendered using textarea with markdown
 #   {{ cms:markdown identifier }}
 #
@@ -9,7 +11,7 @@ class ComfortableMexicanSofa::Content::Tag::Markdown < ComfortableMexicanSofa::C
 
   def form_field(object_name, view, index)
     name    = "#{object_name}[fragments_attributes][#{index}][content]"
-    options = { id: nil, data: { "cms-cm-mode" => "text/x-markdown" } }
+    options = { id: form_field_id, data: { "cms-cm-mode" => "text/x-markdown" } }
     input   = view.send(:text_area_tag, name, content, options)
 
     yield input

data/lib/comfortable_mexican_sofa/content/tags/mixins/file_content.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# A mixin for tags that returns the file as their content.
+module ComfortableMexicanSofa::Content::Tag::Mixins
+  module FileContent
+
+    # @param [ActiveStorage::Blob] file
+    # @param ["link", "image", "url"] as
+    # @param [{String => String}] variant_attrs ImageMagick variant attributes
+    # @param [String] label alt text for `as: "image"`, link text for `as: "link"`
+    # @return [String]
+    def content(file: self.file, as: self.as, variant_attrs: self.variant_attrs, label: self.label)
+      return "" unless file
+
+      if variant_attrs.present? && attachment.image?
+        file = file.variant(variant_attrs)
+      end
+
+      url = rails_blob_path(file)
+
+      case as
+      when "link"
+        "<a href='#{url}' target='_blank'>#{label}</a>"
+      when "image"
+        "<img src='#{url}' alt='#{label}'/>"
+      else
+        url
+      end
+    end
+
+    # @param [ActiveStorage::Blob]
+    # @return [String]
+    def rails_blob_path(blob)
+      Rails.application.routes.url_helpers.rails_blob_path(blob, only_path: true)
+    end
+
+  end
+end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Tag for text content that is going to be rendered using number input
 #   {{ cms:number identifier }}
 #
@@ -5,7 +7,7 @@ class ComfortableMexicanSofa::Content::Tag::Number < ComfortableMexicanSofa::Con
 
   def form_field(object_name, view, index)
     name    = "#{object_name}[fragments_attributes][#{index}][content]"
-    options = { id: nil, class: "form-control" }
+    options = { id: form_field_id, class: "form-control" }
     input   = view.send(:number_field_tag, name, content, options)
 
     yield input

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

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require_relative "./mixins/file_content"
+
+# This tag allows you to link page-level files from within the page content.
+#
+# E.g. if your layout has:
+#
+#   {{ cms:file graphic, render: false }}
+#   {{ cms:files attachments, redner: false }}
+#
+# You can link to the files from an individual page (or snippet rendered in
+# the context of the page) like so:
+#
+#   {{ cms:page_file_link graphic }}
+#   {{ cms:page_file_link attachments, filename: "cat.jpg" }}
+#
+# `as`      - url (default) | link | image - how file gets rendered out
+# `label`   - attach label attribute to link or image tag
+# `resize`  - imagemagick option. For example: "100x50>"
+# `gravity` - imagemagick option. For example: "center"
+# `crop`    - imagemagick option. For example: "100x50+0+0"
+#
+class ComfortableMexicanSofa::Content::Tag::PageFileLink < ComfortableMexicanSofa::Content::Tag
+
+  include ComfortableMexicanSofa::Content::Tag::Mixins::FileContent
+
+  # @return [String] A `cms:file(s)` identifier.
+  attr_reader :identifier
+
+  # @type ["url", "link", "image"]
+  attr_reader :as
+
+  # @type [{String => String}]
+  attr_reader :variant_attrs
+
+  # @return [String] Used to refer to a file in a {{ cms:files }} tag.
+  attr_reader :filename
+
+  # @param (see ComfortableMexicanSofa::Content::Tag#initialize)
+  def initialize(context:, params: [], source: nil)
+    super
+
+    options = params.extract_options!
+    @identifier     = params[0]
+    @as             = options["as"] || "url"
+    @variant_attrs  = options.slice("resize", "gravity", "crop")
+    @filename       = options["filename"]
+
+    unless @identifier.present?
+      raise Error, "Missing identifier for page file link tag"
+    end
+  end
+
+  # @return [Comfy::Cms::Fragment]
+  def fragment
+    @fragment ||= context.fragments.detect { |f| f.identifier == identifier }
+  end
+
+  # @return [ActiveStorage::Blob]
+  def file
+    @file ||=
+      if fragment.nil?
+        nil
+      elsif filename.nil?
+        fragment.attachments.first
+      else
+        fragment.attachments.detect { |a| a.filename.to_s == filename }
+      end
+  end
+
+  # @return [String]
+  def label
+    return if file.nil?
+    file.filename.to_s
+  end
+
+end
+
+ComfortableMexicanSofa::Content::Renderer.register_tag(
+  :page_file_link, ComfortableMexicanSofa::Content::Tag::PageFileLink
+)