ComfortableMexicanSofa 2.0.18

data/lib/comfortable_mexican_sofa/content/tag.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+class ComfortableMexicanSofa::Content::Tag
+
+  class Error < StandardError; end
+
+  # @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
+    @source   = source
+  end
+
+  # Making sure we don't leak erb from tags by accident.
+  # Tag classes can override this, like partials/helpers tags.
+  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 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
+
+end

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

@@ -0,0 +1,59 @@
+# 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}}
+#
+# `type` - css | js - what we're outputting here
+# `as`   - url (default) | tag - output url or wrap it in the appropriate tag
+#
+class ComfortableMexicanSofa::Content::Tag::Asset < ComfortableMexicanSofa::Content::Tag
+
+  attr_reader :identifier, :type, :as
+
+  def initialize(context:, params: [], source: nil)
+    super
+
+    options = params.extract_options!
+    @identifier = params[0]
+    @type       = options["type"]
+    @as         = options["as"] || "url"
+
+    unless @identifier.present?
+      raise Error, "Missing layout identifier for asset tag"
+    end
+  end
+
+  def layout
+    @layout ||= context.site.layouts.find_by(identifier: @identifier)
+  end
+
+  def content
+    return "" unless layout
+
+    base = ComfortableMexicanSofa.config.public_cms_path || ""
+    unless base.ends_with?("/")
+      base += "/"
+    end
+
+    case @type
+    when "css"
+      out = "#{base}cms-css/#{context.site.id}/#{@identifier}/#{layout.cache_buster}.css"
+      if @as == "tag"
+        out = "<link href='#{out}' media='screen' rel='stylesheet' type='text/css' />"
+      end
+      out
+    when "js"
+      out = "#{base}cms-js/#{context.site.id}/#{@identifier}/#{layout.cache_buster}.js"
+      if @as == "tag"
+        out = "<script src='#{out}' type='text/javascript'></script>"
+      end
+      out
+    end
+  end
+
+end
+
+ComfortableMexicanSofa::Content::Renderer.register_tag(
+  :asset, ComfortableMexicanSofa::Content::Tag::Asset
+)

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# Tag for boolean content that is going to be rendered using checkbox
+#   {{ cms:checkbox identifier }}
+#
+class ComfortableMexicanSofa::Content::Tag::Checkbox < ComfortableMexicanSofa::Content::Tag::Fragment
+
+  def content
+    fragment.boolean
+  end
+
+  def form_field(object_name, view, index)
+    name = "#{object_name}[fragments_attributes][#{index}][boolean]"
+
+    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
+
+ComfortableMexicanSofa::Content::Renderer.register_tag(
+  :checkbox, ComfortableMexicanSofa::Content::Tag::Checkbox
+)

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# Tag for text content that is going to be rendered using text input with date widget
+#   {{ cms:date identifier }}
+#
+class ComfortableMexicanSofa::Content::Tag::Date < ComfortableMexicanSofa::Content::Tag::Datetime
+
+  def form_field(object_name, view, index)
+    name    = "#{object_name}[fragments_attributes][#{index}][datetime]"
+    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)
+
+    yield input
+  end
+
+end
+
+ComfortableMexicanSofa::Content::Renderer.register_tag(
+  :date, ComfortableMexicanSofa::Content::Tag::Date
+)

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# Tag for text content that is going to be rendered using text input with datetime widget
+#   {{ cms:datetime identifier, strftime: "at %I:%M%p" }}
+#
+# `strftime` - Format datetime string during rendering
+#
+class ComfortableMexicanSofa::Content::Tag::Datetime < ComfortableMexicanSofa::Content::Tag::Fragment
+
+  attr_reader :strftime
+
+  def initialize(context:, params: [], source: nil)
+    super
+    @strftime = options["strftime"]
+  end
+
+  def content
+    fragment.datetime
+  end
+
+  def render
+    return "" unless renderable
+
+    if strftime.present?
+      content.strftime(strftime)
+    else
+      content.to_s
+    end
+  end
+
+  def form_field(object_name, view, index)
+    name    = "#{object_name}[fragments_attributes][#{index}][datetime]"
+    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)
+
+    yield input
+  end
+
+end
+
+ComfortableMexicanSofa::Content::Renderer.register_tag(
+  :datetime, ComfortableMexicanSofa::Content::Tag::Datetime
+)

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

@@ -0,0 +1,72 @@
+# 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" }}
+#
+# `as`      - url (default) | link | image - render out link or image tag
+# `label`   - attach label attribute to link or image tag
+# `resize`  - imagemagic option. For example: "100x50>"
+# `gravity` - imagemagic option. For example: "center"
+# `crop`    - imagemagic option. For example: "100x50+0+0"
+# `class`   - any html classes that you want on the result link or image tag. For example "class1 class2"
+#
+class ComfortableMexicanSofa::Content::Tag::File < ComfortableMexicanSofa::Content::Tag::Fragment
+
+  include ComfortableMexicanSofa::Content::Tag::Mixins::FileContent
+
+  # @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"
+    @label          = options["label"]
+    @class          = options["class"]
+    @variant_attrs  = options.slice("resize", "gravity", "crop")
+  end
+
+  def form_field(object_name, view, index)
+    name    = "#{object_name}[fragments_attributes][#{index}][files]"
+    input   = view.send(:file_field_tag, name, id: form_field_id, class: "form-control")
+
+    attachments_partial =
+      if fragment.attachments
+        view.render(
+          partial: "comfy/admin/cms/fragments/form_fragment_attachments",
+          locals: {
+            object_name:  object_name,
+            index:        index,
+            attachments:  fragment.attachments,
+            fragment_id:  identifier,
+            multiple:     false
+          }
+        )
+      end
+
+    yield view.safe_join([input, attachments_partial], "")
+  end
+
+protected
+
+  # @return [ActiveStorage::Blob]
+  def file
+    fragment.attachments.first
+  end
+
+  # @return [String]
+  def label
+    @label || file&.filename
+  end
+
+end
+
+ComfortableMexicanSofa::Content::Renderer.register_tag(
+  :file, ComfortableMexicanSofa::Content::Tag::File
+)

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

@@ -0,0 +1,63 @@
+# 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}}
+#
+# `as`      - url (default) | link | image - how file gets rendered out
+# `label`   - attach label attribute to link or image tag
+# `resize`  - imagemagic option. For example: "100x50>"
+# `gravity` - imagemagic option. For example: "center"
+# `crop`    - imagemagic option. For example: "100x50+0+0"
+# `class`   - any html classes that you want on the result link or image tag. For example "class1 class2"
+#
+class ComfortableMexicanSofa::Content::Tag::FileLink < ComfortableMexicanSofa::Content::Tag
+
+  include ComfortableMexicanSofa::Content::Tag::Mixins::FileContent
+
+  # @return [String] A {Comfy::Cms::Site#files} ID.
+  attr_reader :identifier
+
+  # @type ["url", "link", "image"]
+  attr_reader :as
+
+  # @type [{String => String}]
+  attr_reader :variant_attrs
+
+  def initialize(context:, params: [], source: nil)
+    super
+
+    options = params.extract_options!
+    @identifier     = params[0]
+    @as             = options["as"] || "url"
+    @class          = options["class"]
+    @variant_attrs  = options.slice("resize", "gravity", "crop")
+
+    unless @identifier.present?
+      raise Error, "Missing identifier for file link tag"
+    end
+  end
+
+  # @return [Comfy::Cms::File]
+  def file_record
+    @file_record ||= context.site.files.detect { |f| f.id == identifier.to_i }
+  end
+
+  # @return [ActiveStorage::Blob]
+  def file
+    file_record&.attachment
+  end
+
+  # @return [String]
+  def label
+    return "" if file_record.nil?
+    file_record.label.presence || file.filename.to_s
+  end
+
+end
+
+ComfortableMexicanSofa::Content::Renderer.register_tag(
+  :file_link, ComfortableMexicanSofa::Content::Tag::FileLink
+)

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

@@ -0,0 +1,43 @@
+# 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.
+# Example tag:
+#   {{ cms:files identifier }}
+#
+class ComfortableMexicanSofa::Content::Tag::Files < ComfortableMexicanSofa::Content::Tag::File
+
+  def content
+    return "" if fragment.attachments.blank?
+
+    fragment.attachments.collect do |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: form_field_id, multiple: true, class: "form-control")
+
+    attachments_partial =
+      if fragment.attachments
+        view.render(
+          partial: "comfy/admin/cms/fragments/form_fragment_attachments",
+          locals: {
+            object_name:  object_name,
+            index:        index,
+            attachments:  fragment.attachments,
+            fragment_id:  identifier,
+            multiple:     true
+          }
+        )
+      end
+
+    yield view.safe_join([input, attachments_partial], "")
+  end
+
+end
+
+ComfortableMexicanSofa::Content::Renderer.register_tag(
+  :files, ComfortableMexicanSofa::Content::Tag::Files
+)

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

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+# Base Tag class that other fragment tags depend on.
+# Tag handles following options:
+#   `render`: true (default) | false
+#     do we want to render this content on the page, or manually access it via
+#     helpers. Good example would be content for meta tags.
+#   `namespace`:
+#     Just a string that allows grouping of form elements in the admin area
+#
+class ComfortableMexicanSofa::Content::Tag::Fragment < ComfortableMexicanSofa::Content::Tag
+
+  attr_accessor :renderable
+  attr_reader :identifier, :namespace
+
+  # @type [{String => String}]
+  attr_reader :options
+
+  def initialize(context:, params: [], source: nil)
+    super
+
+    @options    = params.extract_options!
+    @identifier = params[0]
+
+    unless @identifier.present?
+      raise Error, "Missing identifier for fragment tag: #{source}"
+    end
+
+    @namespace  = @options["namespace"] || "default"
+    @renderable = @options["render"].to_s.downcase != "false"
+  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)
+  end
+
+  def content
+    fragment.content
+  end
+
+  # If `render: false` was passed in we won't render anything. Assuming that
+  # that fragment content will be rendered manually
+  def render
+    renderable ? content : ""
+  end
+
+  # Tag renders its own form inputs via `form_field(template, index)`
+  # For example:
+  #   class MyTag < ComfortableMexicanSofa::Content::Tag::Fragment
+  #     def form_field(view, index, &block)
+  #       # omit yield if you don't want default wrapper
+  #       yield view.text_area "input_name", "value"
+  #     end
+  #   end
+  def form_field
+    raise "Form field rendering not implemented for this Tag"
+  end
+
+  def form_field_id
+    "fragment-#{@identifier}"
+  end
+
+end