occams 1.0.0 → 1.0.2

data/lib/occams/content/renderer.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "strscan"
+require 'strscan'
 
 # Processing content follows these stages:
 #
@@ -15,17 +15,15 @@ require "strscan"
 #                   Resulting list is flattened and joined into a final rendered string.
 #
 class Occams::Content::Renderer
-
   class SyntaxError < StandardError; end
   class Error < StandardError; end
 
   MAX_DEPTH = 100
 
   # tags are in this format: {{ cms:tag_class params }}
-  TAG_REGEX = %r{\{\{\s*?cms:(?<class>\w+)(?<params>.*?)\}\}}
+  TAG_REGEX = %r{\{\{\s*?cms:(?<class>\w+)(?<params>.*?)\}\}}.freeze
 
   class << self
-
     # @return [Hash<String, Class<Occams::Content::Tag>>]
     def tags
       @tags ||= {}
@@ -36,7 +34,6 @@ class Occams::Content::Renderer
     def register_tag(name, klass)
       tags[name.to_s] = klass
     end
-
   end
 
   # @param [Occams::Cms::WithFragments, nil] context
@@ -51,7 +48,7 @@ class Occams::Content::Renderer
   # @param [Boolean] allow_erb
   def render(nodes, allow_erb = Occams.config.allow_erb)
     if (@depth += 1) > MAX_DEPTH
-      raise Error, "Deep tag nesting or recursive nesting detected"
+      raise Error, 'Deep tag nesting or recursive nesting detected'
     end
 
     nodes.map do |node|
@@ -70,7 +67,7 @@ class Occams::Content::Renderer
     if allow_erb
       string.to_s
     else
-      string.to_s.gsub("<%", "&lt;%").gsub("%>", "%&gt;")
+      string.to_s.gsub('<%', '&lt;%').gsub('%>', '%&gt;')
     end
   end
 
@@ -80,12 +77,12 @@ class Occams::Content::Renderer
     tokens = []
     ss = StringScanner.new(string.to_s)
     while (string = ss.scan_until(TAG_REGEX))
-      text = string.sub(ss[0], "")
+      text = string.sub(ss[0], '')
       tokens << text unless text.empty?
       tokens << {
-        tag_class:  ss[:class],
+        tag_class: ss[:class],
         tag_params: ss[:params].strip,
-        source:     ss[0]
+        source: ss[0]
       }
     end
     text = ss.rest
@@ -108,22 +105,23 @@ class Occams::Content::Renderer
         case tag_class = token[:tag_class]
 
         # This handles {{cms:end}} tag. Stopping collecting block nodes.
-        when "end"
+        when 'end'
           if nodes.count == 1
-            raise SyntaxError, "closing unopened block"
+            raise SyntaxError, 'closing unopened block'
           end
+
           nodes.pop
 
         else
           # @type [Class<Occams::Content::Tag>]
           klass = self.class.tags[tag_class] ||
-            raise(SyntaxError, "Unrecognized tag: #{token[:source]}")
+                  raise(SyntaxError, "Unrecognized tag: #{token[:source]}")
 
           # @type [Occams::Content::Tag]
           tag = klass.new(
-            context:  @context,
-            params:   Occams::Content::ParamsParser.new(token[:tag_params]).params,
-            source:   token[:source]
+            context: @context,
+            params: Occams::Content::ParamsParser.new(token[:tag_params]).params,
+            source: token[:source]
           )
           nodes.last << tag
 
@@ -140,10 +138,9 @@ class Occams::Content::Renderer
     end
 
     if nodes.count > 1
-      raise SyntaxError, "unclosed block detected"
+      raise SyntaxError, 'unclosed block detected'
     end
 
     nodes.flatten
   end
-
 end

data/lib/occams/content/tag.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 class Occams::Content::Tag
-
   class Error < StandardError; end
 
   # @type [Occams::Cms::WithFragments]
@@ -39,12 +38,11 @@ class Occams::Content::Tag
 
   # @return [String]
   def content
-    raise Error, "This is a base class. It holds no content"
+    raise Error, 'This is a base class. It holds no content'
   end
 
   # @return [String]
   def render
     content
   end
-
 end

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

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

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

@@ -4,7 +4,6 @@
 #   {{ cms:checkbox identifier }}
 #
 class Occams::Content::Tag::Checkbox < Occams::Content::Tag::Fragment
-
   def content
     fragment.boolean
   end
@@ -12,16 +11,15 @@ class Occams::Content::Tag::Checkbox < Occams::Content::Tag::Fragment
   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)
+    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)
+      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
 
 Occams::Content::Renderer.register_tag(

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

@@ -4,16 +4,14 @@
 #   {{ cms:date identifier }}
 #
 class Occams::Content::Tag::Date < Occams::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) : ""
+    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
 
 Occams::Content::Renderer.register_tag(

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

@@ -6,12 +6,11 @@
 # `strftime` - Format datetime string during rendering
 #
 class Occams::Content::Tag::Datetime < Occams::Content::Tag::Fragment
-
   attr_reader :strftime
 
   def initialize(context:, params: [], source: nil)
     super
-    @strftime = options["strftime"]
+    @strftime = options['strftime']
   end
 
   def content
@@ -19,7 +18,7 @@ class Occams::Content::Tag::Datetime < Occams::Content::Tag::Fragment
   end
 
   def render
-    return "" unless renderable
+    return '' unless renderable
 
     if strftime.present?
       content.strftime(strftime)
@@ -30,13 +29,12 @@ class Occams::Content::Tag::Datetime < Occams::Content::Tag::Fragment
 
   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) : ""
+    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
 
 Occams::Content::Renderer.register_tag(

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "./mixins/file_content"
+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:
@@ -14,7 +14,6 @@ require_relative "./mixins/file_content"
 # `class`   - any html classes that you want on the result link or image tag. For example "class1 class2"
 #
 class Occams::Content::Tag::File < Occams::Content::Tag::Fragment
-
   include Occams::Content::Tag::Mixins::FileContent
 
   # @type ["url", "link", "image"]
@@ -26,31 +25,31 @@ class Occams::Content::Tag::File < Occams::Content::Tag::Fragment
   # @param (see Occams::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")
+    @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")
+    input   = view.send(:file_field_tag, name, id: form_field_id, class: 'form-control')
 
     attachments_partial =
       if fragment.attachments
         view.render(
-          partial: "occams/admin/cms/fragments/form_fragment_attachments",
+          partial: 'occams/admin/cms/fragments/form_fragment_attachments',
           locals: {
-            object_name:  object_name,
-            index:        index,
-            attachments:  fragment.attachments,
-            fragment_id:  identifier,
-            multiple:     false
+            object_name: object_name,
+            index: index,
+            attachments: fragment.attachments,
+            fragment_id: identifier,
+            multiple: false
           }
         )
       end
 
-    yield view.safe_join([input, attachments_partial], "")
+    yield view.safe_join([input, attachments_partial], '')
   end
 
 protected
@@ -64,7 +63,6 @@ protected
   def label
     @label || file&.filename
   end
-
 end
 
 Occams::Content::Renderer.register_tag(

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "./mixins/file_content"
+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.
@@ -14,7 +14,6 @@ require_relative "./mixins/file_content"
 # `class`   - any html classes that you want on the result link or image tag. For example "class1 class2"
 #
 class Occams::Content::Tag::FileLink < Occams::Content::Tag
-
   include Occams::Content::Tag::Mixins::FileContent
 
   # @return [String] A {Occams::Cms::Site#files} ID.
@@ -31,13 +30,13 @@ class Occams::Content::Tag::FileLink < Occams::Content::Tag
 
     options = params.extract_options!
     @identifier     = params[0]
-    @as             = options["as"] || "url"
-    @class          = options["class"]
-    @variant_attrs  = options.slice("resize", "gravity", "crop")
+    @as             = options['as'] || 'url'
+    @class          = options['class']
+    @variant_attrs  = options.slice('resize', 'gravity', 'crop')
+
+    return if @identifier.present?
 
-    unless @identifier.present?
-      raise Error, "Missing identifier for file link tag"
-    end
+    raise Error, 'Missing identifier for file link tag'
   end
 
   # @return [Occams::Cms::File]
@@ -52,10 +51,10 @@ class Occams::Content::Tag::FileLink < Occams::Content::Tag
 
   # @return [String]
   def label
-    return "" if file_record.nil?
+    return '' if file_record.nil?
+
     file_record.label.presence || file.filename.to_s
   end
-
 end
 
 Occams::Content::Renderer.register_tag(

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

@@ -6,36 +6,34 @@
 #   {{ cms:files identifier }}
 #
 class Occams::Content::Tag::Files < Occams::Content::Tag::File
-
   def content
-    return "" if fragment.attachments.blank?
+    return '' if fragment.attachments.blank?
 
     fragment.attachments.collect do |attachment|
       super(file: attachment, label: attachment.filename)
-    end.join(" ")
+    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")
+    input   = view.send(:file_field_tag, name, id: form_field_id, multiple: true, class: 'form-control')
 
     attachments_partial =
       if fragment.attachments
         view.render(
-          partial: "occams/admin/cms/fragments/form_fragment_attachments",
+          partial: 'occams/admin/cms/fragments/form_fragment_attachments',
           locals: {
-            object_name:  object_name,
-            index:        index,
-            attachments:  fragment.attachments,
-            fragment_id:  identifier,
-            multiple:     true
+            object_name: object_name,
+            index: index,
+            attachments: fragment.attachments,
+            fragment_id: identifier,
+            multiple: true
           }
         )
       end
 
-    yield view.safe_join([input, attachments_partial], "")
+    yield view.safe_join([input, attachments_partial], '')
   end
-
 end
 
 Occams::Content::Renderer.register_tag(

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

@@ -9,7 +9,6 @@
 #     Just a string that allows grouping of form elements in the admin area
 #
 class Occams::Content::Tag::Fragment < Occams::Content::Tag
-
   attr_accessor :renderable
   attr_reader :identifier, :namespace
 
@@ -26,8 +25,8 @@ class Occams::Content::Tag::Fragment < Occams::Content::Tag
       raise Error, "Missing identifier for fragment tag: #{source}"
     end
 
-    @namespace  = @options["namespace"] || "default"
-    @renderable = @options["render"].to_s.downcase != "false"
+    @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
@@ -44,7 +43,7 @@ class Occams::Content::Tag::Fragment < Occams::Content::Tag
   # If `render: false` was passed in we won't render anything. Assuming that
   # that fragment content will be rendered manually
   def render
-    renderable ? content : ""
+    renderable ? content : ''
   end
 
   # Tag renders its own form inputs via `form_field(template, index)`
@@ -56,11 +55,10 @@ class Occams::Content::Tag::Fragment < Occams::Content::Tag
   #     end
   #   end
   def form_field
-    raise "Form field rendering not implemented for this Tag"
+    raise 'Form field rendering not implemented for this Tag'
   end
 
   def form_field_id
     "fragment-#{@identifier}"
   end
-
 end

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

@@ -8,7 +8,6 @@
 # By default there's a blacklist of methods that should not be called.
 #
 class Occams::Content::Tag::Helper < Occams::Content::Tag
-
   BLACKLIST = %w[eval class_eval instance_eval render].freeze
 
   attr_reader :method_name
@@ -17,9 +16,9 @@ class Occams::Content::Tag::Helper < Occams::Content::Tag
     super
     @method_name = params.shift
 
-    unless @method_name.present?
-      raise Error, "Missing method name for helper tag"
-    end
+    return if @method_name.present?
+
+    raise Error, 'Missing method name for helper tag'
   end
 
   # we output erb into rest of the content
@@ -31,11 +30,11 @@ class Occams::Content::Tag::Helper < Occams::Content::Tag
     helper_params = params.map do |p|
       case p
       when Hash
-        format("%<arg>s", arg: p)
+        format('%<arg>s', arg: p)
       else
-        format("%<arg>p", arg: p)
+        format('%<arg>p', arg: p)
       end
-    end.join(",")
+    end.join(',')
     "<%= #{method_name}(#{helper_params}) %>"
   end
 
@@ -47,7 +46,6 @@ class Occams::Content::Tag::Helper < Occams::Content::Tag
       content unless BLACKLIST.member?(method_name)
     end
   end
-
 end
 
 Occams::Content::Renderer.register_tag(

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

@@ -4,19 +4,17 @@
 #   {{ cms:markdown identifier }}
 #
 class Occams::Content::Tag::Markdown < Occams::Content::Tag::Fragment
-
   def render
-    renderable ? Kramdown::Document.new(content.to_s).to_html : ""
+    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" } }
+    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
 
 Occams::Content::Renderer.register_tag(

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

@@ -3,14 +3,13 @@
 # A mixin for tags that returns the file as their content.
 module Occams::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
+      return '' unless file
 
       url_helpers = Rails.application.routes.url_helpers
 
@@ -23,9 +22,9 @@ module Occams::Content::Tag::Mixins
         end
 
       case as
-      when "link"
+      when 'link'
         "<a href='#{attachment_url}'#{html_class_attribute} target='_blank'>#{label}</a>"
-      when "image"
+      when 'image'
         "<img src='#{attachment_url}'#{html_class_attribute} alt='#{label}'/>"
       else
         attachment_url
@@ -36,8 +35,8 @@ module Occams::Content::Tag::Mixins
 
     def html_class_attribute
       return if @class.blank?
+
       " class='#{@class}'"
     end
-
   end
 end

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

@@ -4,15 +4,13 @@
 #   {{ cms:number identifier }}
 #
 class Occams::Content::Tag::Number < Occams::Content::Tag::Fragment
-
   def form_field(object_name, view, index)
     name    = "#{object_name}[fragments_attributes][#{index}][content]"
-    options = { id: form_field_id, class: "form-control" }
+    options = { id: form_field_id, class: 'form-control' }
     input   = view.send(:number_field_tag, name, content, options)
 
     yield input
   end
-
 end
 
 Occams::Content::Renderer.register_tag(

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "./mixins/file_content"
+require_relative 'mixins/file_content'
 
 # This tag allows you to link page-level files from within the page content.
 #
@@ -23,7 +23,6 @@ require_relative "./mixins/file_content"
 # `class`   - any html classes that you want on the result link or image tag. For example "class1 class2"
 #
 class Occams::Content::Tag::PageFileLink < Occams::Content::Tag
-
   include Occams::Content::Tag::Mixins::FileContent
 
   # @return [String] A `cms:file(s)` identifier.
@@ -44,14 +43,14 @@ class Occams::Content::Tag::PageFileLink < Occams::Content::Tag
 
     options = params.extract_options!
     @identifier     = params[0]
-    @as             = options["as"] || "url"
-    @class          = options["class"]
-    @variant_attrs  = options.slice("resize", "gravity", "crop")
-    @filename       = options["filename"]
+    @as             = options['as'] || 'url'
+    @class          = options['class']
+    @variant_attrs  = options.slice('resize', 'gravity', 'crop')
+    @filename       = options['filename']
+
+    return if @identifier.present?
 
-    unless @identifier.present?
-      raise Error, "Missing identifier for page file link tag"
-    end
+    raise Error, 'Missing identifier for page file link tag'
   end
 
   # @return [Occams::Cms::Fragment]
@@ -74,9 +73,9 @@ class Occams::Content::Tag::PageFileLink < Occams::Content::Tag
   # @return [String]
   def label
     return if file.nil?
+
     file.filename.to_s
   end
-
 end
 
 Occams::Content::Renderer.register_tag(