occams 1.0.0

data/lib/occams/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 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) : ""
+    input   = view.send(:text_field_tag, name, value, options)
+
+    yield input
+  end
+
+end
+
+Occams::Content::Renderer.register_tag(
+  :date, Occams::Content::Tag::Date
+)

data/lib/occams/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 Occams::Content::Tag::Datetime < Occams::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
+
+Occams::Content::Renderer.register_tag(
+  :datetime, Occams::Content::Tag::Datetime
+)

data/lib/occams/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 Occams::Content::Tag::File < Occams::Content::Tag::Fragment
+
+  include Occams::Content::Tag::Mixins::FileContent
+
+  # @type ["url", "link", "image"]
+  attr_reader :as
+
+  # @type [{String => String}]
+  attr_reader :variant_attrs
+
+  # @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")
+  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: "occams/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
+
+Occams::Content::Renderer.register_tag(
+  :file, Occams::Content::Tag::File
+)

data/lib/occams/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 Occams::Content::Tag::FileLink < Occams::Content::Tag
+
+  include Occams::Content::Tag::Mixins::FileContent
+
+  # @return [String] A {Occams::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 [Occams::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
+
+Occams::Content::Renderer.register_tag(
+  :file_link, Occams::Content::Tag::FileLink
+)

data/lib/occams/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 Occams::Content::Tag::Files < Occams::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: "occams/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
+
+Occams::Content::Renderer.register_tag(
+  :files, Occams::Content::Tag::Files
+)

data/lib/occams/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 Occams::Content::Tag::Fragment < Occams::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 [Occams::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 < Occams::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

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

@@ -0,0 +1,55 @@
+# 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 Occams::Content::Tag::Helper < Occams::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
+
+    unless @method_name.present?
+      raise Error, "Missing method name for helper tag"
+    end
+  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 = Occams.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
+
+Occams::Content::Renderer.register_tag(
+  :helper, Occams::Content::Tag::Helper
+)

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Tag for text content that is going to be rendered using textarea with markdown
+#   {{ cms:markdown identifier }}
+#
+class Occams::Content::Tag::Markdown < Occams::Content::Tag::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
+
+Occams::Content::Renderer.register_tag(
+  :markdown, Occams::Content::Tag::Markdown
+)

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# 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
+
+      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}'/>"
+      else
+        attachment_url
+      end
+    end
+
+  private
+
+    def html_class_attribute
+      return if @class.blank?
+      " class='#{@class}'"
+    end
+
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# Tag for text content that is going to be rendered using number input
+#   {{ 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" }
+    input   = view.send(:number_field_tag, name, content, options)
+
+    yield input
+  end
+
+end
+
+Occams::Content::Renderer.register_tag(
+  :number, Occams::Content::Tag::Number
+)

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

@@ -0,0 +1,84 @@
+# 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`   - 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.
+  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 Occams::Content::Tag#initialize)
+  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")
+    @filename       = options["filename"]
+
+    unless @identifier.present?
+      raise Error, "Missing identifier for page file link tag"
+    end
+  end
+
+  # @return [Occams::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
+
+Occams::Content::Renderer.register_tag(
+  :page_file_link, Occams::Content::Tag::PageFileLink
+)

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# Tag for injecting partials. Example tag:
+#   {{cms:partial path/to/partial, foo: bar, zip: zoop}}
+# This expands into a familiar:
+#   <%= render partial: "path/to/partial", locals: {foo: bar, zip: zoop} %>
+# Whitelist is can be used to control what partials are renderable.
+#
+class Occams::Content::Tag::Partial < Occams::Content::Tag
+
+  attr_reader :path, :locals
+
+  def initialize(context:, params: [], source: nil)
+    super
+    @locals = params.extract_options!
+    @path   = params[0]
+
+    unless @path.present?
+      raise Error, "Missing path for partial tag"
+    end
+  end
+
+  # we output erb into rest of the content
+  def allow_erb?
+    true
+  end
+
+  def content
+    format(
+      "<%%= render partial: %<path>p, locals: %<locals>s %%>",
+      path: @path,
+      locals: @locals
+    )
+  end
+
+  def render
+    whitelist = Occams.config.allowed_partials
+    if whitelist.is_a?(Array)
+      whitelist.member?(@path) ? content : ""
+    else
+      content
+    end
+  end
+
+end
+
+Occams::Content::Renderer.register_tag(
+  :partial, Occams::Content::Tag::Partial
+)

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+# Tag for reusable snippets within context's site scope. Looks like this:
+#   {{cms:snippet identifier}}
+# Snippets may have more tags in them like fragments, so they may be expanded too.
+#
+class Occams::Content::Tag::Snippet < Occams::Content::Tag
+
+  attr_reader :identifier
+
+  def initialize(context:, params: [], source: nil)
+    super
+    @identifier = params[0]
+
+    unless @identifier.present?
+      raise Error, "Missing identifier for snippet tag"
+    end
+  end
+
+  def content
+    if snippet.markdown
+      Kramdown::Document.new(snippet.content.to_s).to_html
+    else
+      snippet.content
+    end
+  end
+
+  # Grabbing or initializing Occams::Cms::Snippet object
+  def snippet
+    context.site.snippets.detect { |s| s.identifier == identifier } ||
+      context.site.snippets.build(identifier: identifier)
+  end
+
+end
+
+Occams::Content::Renderer.register_tag(
+  :snippet, Occams::Content::Tag::Snippet
+)

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# Tag for injecting template rendering. Example tag:
+#   {{cms:template template/path}}
+# This expands into something like this:
+#   <%= render template: "template/path" %>
+# Whitelist is can be used to control what templates are available.
+#
+class Occams::Content::Tag::Template < Occams::Content::Tag
+
+  attr_reader :path
+
+  def initialize(context:, params: [], source: nil)
+    super
+    @path = params[0]
+
+    unless @path.present?
+      raise Error, "Missing template path for template tag"
+    end
+  end
+
+  # we output erb into rest of the content
+  def allow_erb?
+    true
+  end
+
+  def content
+    format("<%%= render template: %<path>p %%>", path: path)
+  end
+
+  def render
+    whitelist = Occams.config.allowed_templates
+    if whitelist.is_a?(Array)
+      whitelist.member?(@path) ? content : ""
+    else
+      content
+    end
+  end
+
+end
+
+Occams::Content::Renderer.register_tag(
+  :template, Occams::Content::Tag::Template
+)

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# Tag for text content that is going to be rendered using text input
+#   {{ cms:text identifier }}
+#
+class Occams::Content::Tag::Text < 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" }
+    input   = view.send(:text_field_tag, name, content, options)
+
+    yield input
+  end
+
+end
+
+Occams::Content::Renderer.register_tag(
+  :text, Occams::Content::Tag::Text
+)