comfortable_media_surfer 3.0.0

data/app/models/comfy/cms/layout.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+class Comfy::Cms::Layout < ActiveRecord::Base
+  self.table_name = 'comfy_cms_layouts'
+
+  require_relative '../../../../lib/comfortable_media_surfer/extensions/acts_as_tree'
+
+  cms_acts_as_tree
+  cms_has_revisions_for :content, :css, :js
+
+  # -- Relationships --------------------------------------------------------
+  belongs_to :site
+  has_many :pages, dependent: :nullify
+
+  # -- Callbacks ---------------------------------------------------------------
+  before_validation :assign_label
+  before_create :assign_position
+  after_save    :clear_page_content_cache
+  after_destroy :clear_page_content_cache
+
+  # -- Validations -------------------------------------------------------------
+  validates :site_id,
+            presence:   true
+  validates :label,
+            presence:   true
+  validates :identifier,
+            presence: true,
+            uniqueness: { scope: :site_id },
+            format: { with: %r{\A\w[a-z0-9_-]*\z}i }
+
+  # -- Class Methods -----------------------------------------------------------
+  # Tree-like structure for layouts
+  def self.options_for_select(site, current_layout = nil)
+    options = []
+
+    options_for_layout = ->(layout, depth = 0) do
+      return if layout == current_layout
+
+      options << ["#{'. . ' * depth}#{layout.label}", layout.id]
+
+      layout.children.order(:position).each do |child_layout|
+        options_for_layout.call(child_layout, depth + 1)
+      end
+    end
+
+    site.layouts.roots.order(:position).each do |layout|
+      options_for_layout.call(layout)
+    end
+
+    options
+  end
+
+  # List of available application layouts
+  def self.app_layouts_for_select(view_paths)
+    view_paths.map(&:to_s).select { |path| path.start_with?(Rails.root.to_s) }.flat_map do |full_path|
+      Dir.glob("#{full_path}/layouts/**/*.html.*").collect do |filename|
+        filename.gsub!("#{full_path}/layouts/", '')
+        filename.split('/').last[0...1] == '_' ? nil : filename.split('.').first
+      end.compact.sort
+    end.compact.uniq.sort
+  end
+
+  # -- Instance Methods --------------------------------------------------------
+  # Tokenized layout content that also pulls in parent layout (if there's one)
+  # and merges on the {{cms:tag_type content}} tag (if parent layout has that).
+  # Returns a list of tokens that can be fed into the renderer.
+  def content_tokens
+    renderer  = ComfortableMediaSurfer::Content::Renderer.new(nil)
+    tokens    = renderer.tokenize(content)
+
+    if parent
+      fragment_tags = ComfortableMediaSurfer::Content::Tags::Fragment.subclasses.map do |c|
+        ComfortableMediaSurfer::Content::Renderer.tags.key(c)
+      end
+
+      parent_tokens = parent.content_tokens
+      replacement_position = parent_tokens.index do |n|
+        n.is_a?(Hash) &&
+          fragment_tags.member?(n[:tag_class]) &&
+          n[:tag_params].split(%r{\s}).first == 'content'
+      end
+
+      if replacement_position
+        parent_tokens[replacement_position] = tokens
+        tokens = parent_tokens.flatten
+      end
+    end
+
+    tokens
+  end
+
+  def cache_buster
+    updated_at.to_i
+  end
+
+  # Forcing page content reload
+  def clear_page_content_cache
+    Comfy::Cms::Page.where(id: pages.pluck(:id)).update_all(content_cache: nil)
+    children.each(&:clear_page_content_cache)
+  end
+
+protected
+
+  def assign_label
+    self.label = label.blank? ? identifier.try(:titleize) : label
+  end
+
+  def assign_position
+    return if position.to_i.positive?
+
+    max = site.layouts.where(parent_id: parent_id).maximum(:position)
+    self.position = max ? max + 1 : 0
+  end
+end

data/app/models/comfy/cms/page.rb

@@ -0,0 +1,173 @@
+# frozen_string_literal: true
+
+class Comfy::Cms::Page < ActiveRecord::Base
+  self.table_name = 'comfy_cms_pages'
+
+  include Comfy::Cms::WithFragments
+  include Comfy::Cms::WithCategories
+
+  cms_acts_as_tree counter_cache: :children_count, order: :position
+  cms_has_revisions_for :fragments_attributes
+
+  attr_accessor :content
+
+  # -- Relationships -----------------------------------------------------------
+  belongs_to :site
+  belongs_to :target_page,
+             class_name: 'Comfy::Cms::Page',
+             optional: true
+
+  has_many :translations,
+           dependent: :destroy
+
+  # -- Callbacks ---------------------------------------------------------------
+  before_validation :assigns_label,
+                    :assign_parent,
+                    :escape_slug,
+                    :assign_full_path
+  before_create     :assign_position
+  after_save        :sync_child_full_paths!
+  after_find        :unescape_slug_and_path
+
+  # -- Validations -------------------------------------------------------------
+  validates :label,
+            presence: true
+  validates :slug,
+            presence: true,
+            uniqueness: { scope: :parent_id },
+            unless: ->(p) {
+              p.site && (p.site.pages.count.zero? || p.site.pages.root == self)
+            }
+  validate :validate_target_page
+  validate :validate_format_of_unescaped_slug
+
+  # -- Scopes ------------------------------------------------------------------
+  scope :published, -> { where(is_published: true) }
+
+  # -- Class Methods -----------------------------------------------------------
+  # Tree-like structure for pages
+  def self.options_for_select(site:, current_page: nil, exclude_self: false)
+    options = []
+
+    options_for_page = ->(page, depth = 0) do
+      return if page.nil?
+      return if exclude_self && page == current_page
+
+      options << ["#{'. . ' * depth}#{page.label}", page.id]
+
+      page.children.order(:position).each do |child_page|
+        options_for_page.call(child_page, depth + 1)
+      end
+    end
+
+    options_for_page.call(site.pages.root)
+
+    options
+  end
+
+  # -- Instance Methods --------------------------------------------------------
+  # For previewing purposes sometimes we need to have full_path set. This
+  # full path take care of the pages and its childs but not of the site path
+  def full_path
+    read_attribute(:full_path) || assign_full_path
+  end
+
+  # Somewhat unique method of identifying a page that is not a full_path
+  def identifier
+    parent_id.blank? ? 'index' : full_path[1..].parameterize
+  end
+
+  # Full url for a page
+  def url(relative: false)
+    [site.url(relative: relative), full_path].compact.join
+  end
+
+  # This method will mutate page object by transfering attributes from translation
+  # for a given locale.
+  def translate!
+    # If site locale same as page's or there's no translastions, we do nothing
+    if site.locale == I18n.locale.to_s || translations.blank?
+      return
+    end
+
+    translation = translations.published.find_by!(locale: I18n.locale)
+    self.layout        = translation.layout
+    self.label         = translation.label
+    self.content_cache = translation.content_cache
+
+    # We can't just assign fragments as it's a relation and will write to DB
+    # This has odd side-effect of preserving page's fragments and just replacing
+    # them from the translation. Not an issue if all fragments match.
+    self.fragments_attributes = translation.fragments_attributes
+    readonly!
+
+    self
+  end
+
+protected
+
+  def assigns_label
+    self.label = label.blank? ? slug.try(:titleize) : label
+  end
+
+  def assign_parent
+    return unless site
+
+    self.parent ||= site.pages.root unless self == site.pages.root || site.pages.count.zero?
+  end
+
+  def assign_full_path
+    self.full_path =
+      if self.parent
+        [CGI.escape(self.parent.full_path).gsub('%2F', '/'), slug].join('/').squeeze('/')
+      else
+        '/'
+      end
+  end
+
+  def assign_position
+    return unless self.parent
+    return if position.to_i.positive?
+
+    max = self.parent.children.maximum(:position)
+    self.position = max ? max + 1 : 0
+  end
+
+  def validate_target_page
+    return unless target_page
+
+    p = self
+    while p.target_page
+      if (p = p.target_page) == self
+        return errors.add(:target_page_id, 'Invalid Redirect')
+      end
+    end
+  end
+
+  def validate_format_of_unescaped_slug
+    return unless slug.present?
+
+    unescaped_slug = CGI.unescape(slug)
+    errors.add(:slug, :invalid) unless unescaped_slug =~ %r{^\p{Alnum}[.\p{Alnum}\p{Mark}_-]*$}i
+  end
+
+  # Forcing re-saves for child pages so they can update full_paths
+  def sync_child_full_paths!
+    return unless full_path_previously_changed?
+
+    children.each do |p|
+      p.update_attribute(:full_path, p.send(:assign_full_path))
+    end
+  end
+
+  # Escape slug unless it's nonexistent (root)
+  def escape_slug
+    self.slug = CGI.escape(slug) unless slug.nil?
+  end
+
+  # Unescape the slug and full path back into their original forms unless they're nonexistent
+  def unescape_slug_and_path
+    self.slug       = CGI.unescape(slug)      unless slug.nil?
+    self.full_path  = CGI.unescape(full_path) unless full_path.nil?
+  end
+end

data/app/models/comfy/cms/revision.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class Comfy::Cms::Revision < ActiveRecord::Base
+  self.table_name = 'comfy_cms_revisions'
+
+  serialize :data, coder: Psych
+
+  # -- Relationships --------------------------------------------------------
+  belongs_to :record, polymorphic: true
+end

data/app/models/comfy/cms/site.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+class Comfy::Cms::Site < ActiveRecord::Base
+  self.table_name = 'comfy_cms_sites'
+
+  # -- Relationships -----------------------------------------------------------
+  with_options dependent: :destroy do |site|
+    site.has_many :layouts
+    site.has_many :pages
+    site.has_many :snippets
+    site.has_many :files
+    site.has_many :categories
+  end
+
+  # -- Callbacks ---------------------------------------------------------------
+  before_validation :assign_identifier,
+                    :assign_hostname,
+                    :assign_label,
+                    :clean_path
+
+  # -- Validations -------------------------------------------------------------
+  validates :identifier,
+            presence: true,
+            uniqueness: true,
+            format: { with: %r{\A\w[a-z0-9_-]*\z}i }
+  validates :label,
+            presence: true
+  validates :hostname,
+            presence: true,
+            uniqueness: { scope: :path },
+            format: { with: %r{\A[\w.-]+(?::\d+)?\z} }
+
+  # -- Class Methods -----------------------------------------------------------
+  # returning the Comfy::Cms::Site instance based on host and path
+  def self.find_site(host, path = nil)
+    return Comfy::Cms::Site.first if Comfy::Cms::Site.count == 1
+
+    cms_site = nil
+
+    public_cms_path = ComfortableMediaSurfer.configuration.public_cms_path
+    if path && public_cms_path != '/'
+      path = path.sub(%r{\A#{public_cms_path}}, '')
+    end
+
+    Comfy::Cms::Site.where(hostname: real_host_from_aliases(host)).each do |site|
+      if site.path.blank?
+        cms_site = site
+      elsif "#{path.to_s.split('?')[0]}/" =~ %r{^/#{Regexp.escape(site.path.to_s)}/}
+        cms_site = site
+        break
+      end
+    end
+    cms_site
+  end
+
+  def self.real_host_from_aliases(host)
+    if (aliases = ComfortableMediaSurfer.config.hostname_aliases)
+      aliases.each do |alias_host, hosts|
+        return alias_host if hosts.include?(host)
+      end
+    end
+    host
+  end
+
+  # -- Instance Methods --------------------------------------------------------
+  def url(relative: false)
+    public_cms_path = ComfortableMediaSurfer.config.public_cms_path || '/'
+    host = "//#{hostname}"
+    path = ['/', public_cms_path, self.path].compact.join('/').squeeze('/').chomp('/')
+    relative ? path.presence : [host, path].join
+  end
+
+protected
+
+  def assign_identifier
+    self.identifier = identifier.blank? ? hostname.try(:parameterize) : identifier
+  end
+
+  def assign_hostname
+    self.hostname ||= identifier
+  end
+
+  def assign_label
+    self.label = label.blank? ? identifier.try(:titleize) : label
+  end
+
+  def clean_path
+    self.path ||= ''
+    self.path.squeeze!('/')
+    self.path.gsub!(%r{/$}, '')
+    self.path = nil if self.path.blank?
+  end
+end

data/app/models/comfy/cms/snippet.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+class Comfy::Cms::Snippet < ActiveRecord::Base
+  self.table_name = 'comfy_cms_snippets'
+
+  include Comfy::Cms::WithCategories
+
+  cms_has_revisions_for :content
+
+  # -- Relationships -----------------------------------------------------------
+  belongs_to :site
+
+  # -- Callbacks ---------------------------------------------------------------
+  before_validation :assign_label
+  before_create :assign_position
+  after_save    :clear_page_content_cache
+  after_destroy :clear_page_content_cache
+
+  # -- Validations -------------------------------------------------------------
+  validates :label,
+            presence: true
+  validates :identifier,
+            presence: true,
+            uniqueness: { scope: :site_id },
+            format: { with: %r{\A\w[a-z0-9_-]*\z}i }
+
+protected
+
+  def assign_label
+    self.label = label.blank? ? identifier.try(:titleize) : label
+  end
+
+  # When snippet is changed or removed we need to blow away all page caches as
+  # we don't know where it was used.
+  def clear_page_content_cache
+    Comfy::Cms::Page.where(id: site.pages.pluck(:id)).update_all(content_cache: nil)
+  end
+
+  def assign_position
+    max = site.snippets.maximum(:position)
+    self.position = max ? max + 1 : 0
+  end
+end

data/app/models/comfy/cms/translation.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+class Comfy::Cms::Translation < ActiveRecord::Base
+  self.table_name = 'comfy_cms_translations'
+
+  include Comfy::Cms::WithFragments
+
+  cms_has_revisions_for :fragments_attributes
+
+  delegate :site, to: :page
+
+  # -- Relationships -----------------------------------------------------------
+  belongs_to :page
+
+  # -- Callbacks ---------------------------------------------------------------
+  before_validation :assign_layout
+
+  # -- Scopes ------------------------------------------------------------------
+  scope :published, -> { where(is_published: true) }
+
+  # -- Validations -------------------------------------------------------------
+  validates :label,
+            presence: true
+
+  validates :locale,
+            presence: true,
+            uniqueness: { scope: :page_id }
+
+  validate :validate_locale
+
+private
+
+  def validate_locale
+    return unless page
+
+    errors.add(:locale) if locale == page.site.locale
+  end
+
+  def assign_layout
+    self.layout ||= page.layout if page.present?
+  end
+end

data/app/models/concerns/comfy/cms/with_categories.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Comfy::Cms::WithCategories
+  extend ActiveSupport::Concern
+
+  included do
+    has_many :categorizations,
+             as: :categorized,
+             class_name: 'Comfy::Cms::Categorization',
+             dependent: :destroy
+    has_many :categories,
+             through: :categorizations,
+             class_name: 'Comfy::Cms::Category'
+
+    attr_writer :category_ids
+
+    after_save :sync_categories
+
+    scope :for_category, ->(*categories) {
+      if (categories = [categories].flatten.compact).present?
+        distinct
+          .joins(categorizations: :category)
+          .where('comfy_cms_categories.label' => categories)
+      end
+    }
+  end
+
+  def category_ids
+    @category_ids ||= categories.pluck(:id)
+  end
+
+  def sync_categories
+    return unless category_ids.is_a?(Array)
+
+    scope = Comfy::Cms::Category.of_type(self.class.to_s)
+    existing_ids = scope.pluck(:id)
+
+    ids_to_add = category_ids.map(&:to_i)
+
+    # adding categorizations
+    ids_to_add.each do |id|
+      if (category = scope.find_by_id(id))
+        category.categorizations.create(categorized: self)
+      end
+    end
+
+    # removing categorizations
+    ids_to_remove = existing_ids - ids_to_add
+    categorizations.where(category_id: ids_to_remove).destroy_all
+  end
+end

data/app/models/concerns/comfy/cms/with_fragments.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module Comfy::Cms::WithFragments
+  extend ActiveSupport::Concern
+
+  included do
+    attr_accessor :fragments_attributes_changed
+
+    belongs_to :layout,
+               class_name: 'Comfy::Cms::Layout'
+
+    has_many :fragments,
+             class_name: 'Comfy::Cms::Fragment',
+             as: :record,
+             autosave: true,
+             dependent: :destroy
+
+    before_save :clear_content_cache
+
+    validates :layout,
+              presence: true
+  end
+
+  # Array of fragment hashes in the following format:
+  #   [
+  #     {identifier: "frag_a", format: "text", content: "fragment a content"},
+  #     {identifier: "frag_b", format: "file", files: [{file_a}, {file_b}]}
+  #   ]
+  # It also handles when frag hashes come in as a hash:
+  #   {
+  #     "0" => {identifer: "foo", content: "bar"},
+  #     "1" => {identifier: "bar", content: "foo"}
+  #   }
+  def fragments_attributes=(frag_hashes = [])
+    frag_hashes = frag_hashes.values if frag_hashes.is_a?(Hash)
+
+    frag_hashes.each do |frag_attrs|
+      unless frag_attrs.is_a?(HashWithIndifferentAccess)
+        frag_attrs.symbolize_keys!
+      end
+
+      identifier = frag_attrs.delete(:identifier)
+
+      fragment =
+        fragments.detect { |f| f.identifier == identifier } ||
+        fragments.build(identifier: identifier)
+
+      fragment.attributes = frag_attrs
+
+      # tracking dirty
+      self.fragments_attributes_changed ||= fragment.changed?
+    end
+  end
+
+  # Snapshop of page fragments data used primarily for saving revisions
+  def fragments_attributes(was = false)
+    fragments.collect do |frag|
+      attrs = {}
+      %i[identifier tag content datetime boolean].each do |column|
+        attrs[column] = frag.send(was ? "#{column}_was" : column)
+      end
+      # TODO: save files against revision (not on db though)
+      # attrs[:files] = frag.attachments.collect do |a|
+      #   {io: a.download, filename: a.filename.to_s, content_type: a.content_type}
+      # end
+      attrs
+    end
+  end
+
+  # Method to collect prevous state of blocks for revisions
+  def fragments_attributes_was
+    fragments_attributes(:previous_values)
+  end
+
+  # Grabbing nodes that we need to render form elements in the admin area
+  # Rejecting duplicates as we'd need to render only one form field. Don't declare
+  # duplicate tags on the layout. That's wierd (but still works).
+  def fragment_nodes
+    nodes
+      .select { |n| n.is_a?(ComfortableMediaSurfer::Content::Tags::Fragment) }
+      .uniq(&:identifier)
+  end
+
+  # Rendered content of the page. We grab whatever layout is associated with the
+  # page and feed its content tokens to the renderer while passing this page as
+  # context.
+  def render(n = nodes)
+    renderer.render(n)
+  end
+
+  # If content_cache column is populated we don't need to call render for this
+  # page.
+  def content_cache
+    if (cache = read_attribute(:content_cache)).nil?
+      cache = render
+      update_column(:content_cache, cache) unless new_record?
+    end
+    cache
+  end
+
+  # Nuking content cache so it can be regenerated.
+  def clear_content_cache!
+    update_column(:content_cache, nil)
+  end
+
+  # Blanking cache on page saves so it can be regenerated on access
+  def clear_content_cache
+    write_attribute(:content_cache, nil)
+  end
+
+protected
+
+  def renderer
+    ComfortableMediaSurfer::Content::Renderer.new(self)
+  end
+
+  def nodes
+    return [] unless layout.present?
+
+    tokens = layout.content_tokens
+    renderer.nodes(tokens)
+  end
+end

data/app/views/comfy/admin/cms/categories/_categories.html.haml

@@ -0,0 +1,4 @@
+- object ||= categories
+- object.categories.each do |category|
+  %span.badge.badge-primary.mr-1.mb-1
+    = category.label

data/app/views/comfy/admin/cms/categories/_edit.html.haml

@@ -0,0 +1,7 @@
+- url = comfy_admin_cms_site_category_path(@site, category)
+= form_with model: @category, scope: :category, url: url, html: {class: "edit-category", id: dom_id(category)}, local: false do |form|
+  .input-group
+    = form.text_field :label, class: "form-control form-control-sm", id: nil
+    .input-group-btn
+      %button.btn.btn-primary.btn-sm{aria: {label: "Update Category"}}
+        %i.fas.fa-fw.fa-check

data/app/views/comfy/admin/cms/categories/_form.html.haml

@@ -0,0 +1,5 @@
+- object = form.object
+- if (categories = @site.categories.of_type(object.class.to_s)).present?
+  - options = {bootstrap: {check_inline: true, label: {text: t(".label"), class: "pt-0"}}}
+  = form.collection_check_boxes :category_ids, categories, :id, :label, options
+