comfortable_media_surfer 3.0.0

data/lib/comfortable_media_surfer/content/tags/audio.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Tag for injecting HTML5 audio player. Example tag:
+#   {{ cms:audio "path/to/audio", style: "height: 22px; width: 80%" }}
+# This expands into:
+#   <audio controls src="path/to/audio"></audio>
+# To customize your player style, add a 'audioplayer' class to your CSS, e.g
+# .audioplayer {
+#   border-radius: 6px;
+#   height: 22px;
+#   width: 60%;
+#   margin: 2px 0 2px 8px;
+#   padding: 0;
+# }
+# and/or pass in style overrides with the 'style' parameter, as above
+
+class ComfortableMediaSurfer::Content::Tags::Audio < ComfortableMediaSurfer::Content::Tag
+  attr_reader :path, :style, :locals
+
+  def initialize(context:, params: [], source: nil)
+    super
+    @locals = params.extract_options!
+    @path   = params[0]
+    @style = ''
+    @style = "<style>.audioplayer {#{@locals['style']}}</style>" if @locals['style']
+
+    return if @path.present?
+
+    raise Error, 'Missing path for audio tag'
+  end
+
+  def content
+    format("#{@style}<audio controls class=\"audioplayer\" src=#{@path}></audio>")
+  end
+end
+
+ComfortableMediaSurfer::Content::Renderer.register_tag(
+  :audio, ComfortableMediaSurfer::Content::Tags::Audio
+)

data/lib/comfortable_media_surfer/content/tags/breadcrumbs.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# Nav Tag for rendering breadcrumb links to current page
+#   {{ cms:breadcrumbs }}
+#   {{ cms:breadcrumbs style: "font-weight: bold" }}
+# To customize your breadcrumbs style, add a 'breadcrumbs' id to your CSS, e.g
+# #breadcrumbs {
+#   color: #006633;
+#   font-family: Verdana, Arial, Helvetica, sans-serif;
+#   font-size: 105%;
+#   font-weight: bold;
+#   margin-top: 12px;
+#   margin-bottom: 4px;
+#   font-style: italic;
+# }
+# and/or pass in style overrides with the 'style' parameter, as above
+
+class ComfortableMediaSurfer::Content::Tags::Breadcrumbs < ComfortableMediaSurfer::Content::Tag
+  attr_reader :links, :style, :locals
+
+  def initialize(context:, params: [], source: nil)
+    super
+    @locals = params.extract_options!
+    @style = ''
+    @style = "<style>#breadcrumbs {#{@locals['style']}}</style>" if @locals['style']
+
+    @links = '<div id="breadcrumbs">'
+    context.ancestors.reverse.each do |a|
+      next if Rails.env == 'production' && !a.is_published
+
+      @links += "<a href=#{a.url(relative: true)}>#{a.label}</a> &raquo; "
+    end
+    @links += "#{context.label}</div>"
+  end
+
+  def content
+    format("#{@style}#{@links}")
+  end
+end
+
+ComfortableMediaSurfer::Content::Renderer.register_tag(
+  :breadcrumbs, ComfortableMediaSurfer::Content::Tags::Breadcrumbs
+)

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# Tag for boolean content that is going to be rendered using checkbox
+#   {{ cms:checkbox identifier }}
+#
+class ComfortableMediaSurfer::Content::Tags::Checkbox < ComfortableMediaSurfer::Content::Tags::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
+
+ComfortableMediaSurfer::Content::Renderer.register_tag(
+  :checkbox, ComfortableMediaSurfer::Content::Tags::Checkbox
+)

data/lib/comfortable_media_surfer/content/tags/children.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# Nav Tag for unordered list of links to the children of the current page
+#   {{ cms:children }}
+#   {{ cms:children style: "font-weight: bold", exclude: "404-page, search-page" }}
+# To customize your children style, add a 'children' id to your CSS, e.g
+# #children {
+#   color: #006633;
+#   font-size: 90%;
+#   margin-bottom: 4px;
+#   font-style: italic;
+# }
+# and/or pass in style overrides with the 'style' parameter, as above
+#
+# To exclude children, list their slugs with the 'exclude' parameter
+# as comma-delimited string, e.g. as above - exclude: "404-page, search-page"
+
+class ComfortableMediaSurfer::Content::Tags::Children < ComfortableMediaSurfer::Content::Tag
+  attr_reader :style, :page_children, :locals
+  attr_accessor :list
+
+  def initialize(context:, params: [], source: nil)
+    super
+    @locals = params.extract_options!
+    @style  = ''
+    @style  = "<style>#children {#{@locals['style']}}</style>\n" if @locals['style']
+    @exclude = []
+    @exclude = @locals['exclude'].split(',') if @locals['exclude']
+    @list = ''
+    # ActiveRecord_Associations_CollectionProxy
+    @page_children = context.children.order(:position).to_ary
+    unless Rails.env == 'development'
+      @page_children.delete_if { |child| !child.is_published }
+    end
+    @page_children.delete_if { |child| @exclude.include? child.slug }
+  end
+
+  def content
+    if @page_children.any?
+      @list = "<ul id=\"children\">\n"
+      @page_children.each do |c|
+        @list += "  <li><a href=#{c.url(relative: true)}>#{c.label}</a></li>\n"
+      end
+      @list += '</ul>'
+    end
+    format("#{@style}#{@list}")
+  end
+end
+
+ComfortableMediaSurfer::Content::Renderer.register_tag(
+  :children, ComfortableMediaSurfer::Content::Tags::Children
+)

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+# Tag for text content that is going to be rendered using text input with date widget
+#   {{ cms:date identifier }}
+#
+class ComfortableMediaSurfer::Content::Tags::Date < ComfortableMediaSurfer::Content::Tags::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
+
+ComfortableMediaSurfer::Content::Renderer.register_tag(
+  :date, ComfortableMediaSurfer::Content::Tags::Date
+)

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

@@ -0,0 +1,42 @@
+# 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 ComfortableMediaSurfer::Content::Tags::Datetime < ComfortableMediaSurfer::Content::Tags::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
+
+ComfortableMediaSurfer::Content::Renderer.register_tag(
+  :datetime, ComfortableMediaSurfer::Content::Tags::Datetime
+)

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

@@ -0,0 +1,70 @@
+# 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 ComfortableMediaSurfer::Content::Tags::File < ComfortableMediaSurfer::Content::Tags::Fragment
+  include ComfortableMediaSurfer::Content::Tags::Mixins::FileContent
+
+  # @type ["url", "link", "image"]
+  attr_reader :as
+
+  # @type [{String => String}]
+  attr_reader :variant_attrs
+
+  # @param (see ComfortableMediaSurfer::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
+
+ComfortableMediaSurfer::Content::Renderer.register_tag(
+  :file, ComfortableMediaSurfer::Content::Tags::File
+)

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

@@ -0,0 +1,58 @@
+# 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
+# `class`   - any html classes that you want on the result link or image tag. For example "class1 class2"
+#
+# - variant_attrs are not functional, perhaps due to some change in ImageMagick
+# - Simply use a class in your CSS / SASS to style your image display
+# `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 ComfortableMediaSurfer::Content::Tags::FileLink < ComfortableMediaSurfer::Content::Tag
+  include ComfortableMediaSurfer::Content::Tags::Mixins::FileContent
+
+  attr_reader :identifier, :as, :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') # broken for ImageMagick
+
+    return if @identifier.present?
+
+    raise Error, 'Missing identifier for file link tag'
+  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
+
+ComfortableMediaSurfer::Content::Renderer.register_tag(
+  :file_link, ComfortableMediaSurfer::Content::Tags::FileLink
+)

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

@@ -0,0 +1,41 @@
+# 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 ComfortableMediaSurfer::Content::Tags::Files < ComfortableMediaSurfer::Content::Tags::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
+
+ComfortableMediaSurfer::Content::Renderer.register_tag(
+  :files, ComfortableMediaSurfer::Content::Tags::Files
+)

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

@@ -0,0 +1,64 @@
+# 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 ComfortableMediaSurfer::Content::Tags::Fragment < ComfortableMediaSurfer::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 < ComfortableMediaSurfer::Content::Tags::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

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

@@ -0,0 +1,53 @@
+# 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:
+#   <%= method_name("param_a", "param_b", "foo" => "bar") %>
+# Whitelist is can be used to control what helpers are available.
+# By default there's a blacklist of methods that should not be called.
+#
+class ComfortableMediaSurfer::Content::Tags::Helper < ComfortableMediaSurfer::Content::Tag
+  BLACKLIST = %w[eval class_eval instance_eval render].freeze
+
+  attr_reader :method_name
+
+  def initialize(context:, params: [], source: nil)
+    super
+    @method_name = params.shift
+
+    return if @method_name.present?
+
+    raise Error, 'Missing method name for helper tag'
+  end
+
+  # we output erb into rest of the content
+  def allow_erb?
+    true
+  end
+
+  def content
+    helper_params = params.map do |p|
+      case p
+      when Hash
+        format('%<arg>s', arg: p)
+      else
+        format('%<arg>p', arg: p)
+      end
+    end.join(',')
+    "<%= #{method_name}(#{helper_params}) %>"
+  end
+
+  def render
+    whitelist = ComfortableMediaSurfer.config.allowed_helpers
+    if whitelist.is_a?(Array)
+      content if whitelist.map!(&:to_s).member?(method_name)
+    else
+      content unless BLACKLIST.member?(method_name)
+    end
+  end
+end
+
+ComfortableMediaSurfer::Content::Renderer.register_tag(
+  :helper, ComfortableMediaSurfer::Content::Tags::Helper
+)

data/lib/comfortable_media_surfer/content/tags/image.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative 'mixins/file_content'
+
+# This is like the the file_link tag, but specifically for images
+# Identify the image by its label {{ cms:image label }}
+#
+# `class`   - any html classes that you want on the image tag. For example "class1 class2"
+#
+# - variant_attrs are not functional, perhaps due to some change in ImageMagick
+# - Simply use a class in your CSS / SASS to style your image display
+# `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 ComfortableMediaSurfer::Content::Tags::Image < ComfortableMediaSurfer::Content::Tag
+  include ComfortableMediaSurfer::Content::Tags::Mixins::FileContent
+
+  attr_reader :identifier, :as, :variant_attrs
+
+  def initialize(context:, params: [], source: nil)
+    super
+
+    options = params.extract_options!
+    @identifier     = params[0]
+    @as             = 'image'
+    @class          = options['class']
+    @variant_attrs  = options.slice('resize', 'gravity', 'crop') # broken for ImageMagick
+
+    return if @identifier.present?
+
+    raise Error, 'Missing identifier label for image tag'
+  end
+
+  # @return [Comfy::Cms::File]
+  def file_record
+    @file_record ||= context.site.files.detect { |f| f.label == identifier }
+  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
+
+ComfortableMediaSurfer::Content::Renderer.register_tag(
+  :image, ComfortableMediaSurfer::Content::Tags::Image
+)

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Tag for text content that is going to be rendered using textarea with markdown
+#   {{ cms:markdown identifier }}
+#
+class ComfortableMediaSurfer::Content::Tags::Markdown < ComfortableMediaSurfer::Content::Tags::Fragment
+  def render
+    renderable ? Kramdown::Document.new(content.to_s).to_html : ''
+  end
+
+  def form_field(object_name, view, index)
+    name    = "#{object_name}[fragments_attributes][#{index}][content]"
+    options = { id: form_field_id, data: { 'cms-cm-mode' => 'text/x-markdown' } }
+    input   = view.send(:text_area_tag, name, content, options)
+
+    yield input
+  end
+end
+
+ComfortableMediaSurfer::Content::Renderer.register_tag(
+  :markdown, ComfortableMediaSurfer::Content::Tags::Markdown
+)

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# A mixin for tags that returns the file as their content.
+module ComfortableMediaSurfer::Content::Tags::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
+
+      url_helpers = Rails.application.routes.url_helpers
+
+      attachment_url =
+        if variant_attrs.present? && file.image?
+          variant = file.variant(combine_options: variant_attrs)
+          url_helpers.rails_representation_path(variant, only_path: true)
+        else
+          url_helpers.rails_blob_path(file, only_path: true)
+        end
+
+      case as
+      when 'link'
+        "<a href='#{attachment_url}'#{html_class_attribute} target='_blank'>#{label}</a>"
+      when 'image'
+        "<img src='#{attachment_url}'#{html_class_attribute} alt='#{label}' title='#{label}'/>"
+      else
+        attachment_url
+      end
+    end
+
+  private
+
+    def html_class_attribute
+      return if @class.blank?
+
+      " class='#{@class}'"
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# Tag for text content that is going to be rendered using number input
+#   {{ cms:number identifier }}
+#
+class ComfortableMediaSurfer::Content::Tags::Number < ComfortableMediaSurfer::Content::Tags::Fragment
+  def form_field(object_name, view, index)
+    name    = "#{object_name}[fragments_attributes][#{index}][content]"
+    options = { id: form_field_id, class: 'form-control' }
+    input   = view.send(:number_field_tag, name, content, options)
+
+    yield input
+  end
+end
+
+ComfortableMediaSurfer::Content::Renderer.register_tag(
+  :number, ComfortableMediaSurfer::Content::Tags::Number
+)