occams 1.0.0

data/app/models/occams/cms/categorization.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class Occams::Cms::Categorization < ActiveRecord::Base
+
+  self.table_name = "occams_cms_categorizations"
+
+  # -- Relationships -----------------------------------------------------------
+  belongs_to :category
+  belongs_to :categorized,
+    polymorphic: true
+
+  # -- Validations -------------------------------------------------------------
+  validates :category_id,
+    uniqueness: { scope: %i[categorized_type categorized_id] }
+
+end

data/app/models/occams/cms/category.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+class Occams::Cms::Category < ActiveRecord::Base
+
+  self.table_name = "occams_cms_categories"
+
+  # -- Relationships --------------------------------------------------------
+  belongs_to :site
+  has_many :categorizations,
+    dependent: :destroy
+
+  # -- Validations ----------------------------------------------------------
+  validates :label,
+    presence:   true,
+    uniqueness: { scope: %i[categorized_type site_id] }
+  validates :categorized_type,
+    presence:   true
+
+  # -- Scopes ---------------------------------------------------------------
+  scope :of_type, ->(type) {
+    where(categorized_type: type)
+  }
+
+end

data/app/models/occams/cms/file.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+class Occams::Cms::File < ActiveRecord::Base
+
+  self.table_name = "occams_cms_files"
+
+  include Occams::Cms::WithCategories
+
+  VARIANT_SIZE = {
+    redactor: { resize: "100x75^",   gravity: "center", crop: "100x75+0+0" },
+    thumb:    { resize: "200x150^",  gravity: "center", crop: "200x150+0+0" },
+    icon:     { resize: "28x28^",    gravity: "center", crop: "28x28+0+0" }
+  }.freeze
+
+  # temporary place to store attachment
+  attr_accessor :file
+
+  has_one_attached :attachment
+
+  # -- Relationships -----------------------------------------------------------
+  belongs_to :site
+
+  # -- Callbacks ---------------------------------------------------------------
+  before_validation :assign_label, on: :create
+  before_create :assign_position
+  # active_storage attachment behavior changed in rails 6 - see PR#892 for details
+  if Rails::VERSION::MAJOR >= 6
+    before_save :process_attachment
+  else
+    after_save :process_attachment
+  end
+
+  after_save    :clear_page_content_cache
+
+  # -- Validations -------------------------------------------------------------
+  validates :label, presence: true
+  validates :file, presence: true, on: :create
+
+  # -- Scopes ------------------------------------------------------------------
+  # When we need to grab only files with image attachments.
+  # Don't forget to include `with_attached_attachment` before calling this
+  scope :with_images, -> {
+    where("active_storage_blobs.content_type LIKE 'image/%'").references(:blob)
+  }
+
+private
+
+def clear_page_content_cache
+  Occams::Cms::Page.where(id: site.pages.pluck(:id)).update_all(content_cache: nil)
+end
+
+protected
+
+  def assign_position
+    max = Occams::Cms::File.maximum(:position)
+    self.position = max ? max + 1 : 0
+  end
+
+  # TODO: Change db schema not to set blank string
+  def assign_label
+    return if label.present?
+    self.label = file&.original_filename
+  end
+
+  def process_attachment
+    return if @file.blank?
+    self.attachment = @file
+  end
+
+end

data/app/models/occams/cms/fragment.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+class Occams::Cms::Fragment < ActiveRecord::Base
+
+  self.table_name = "occams_cms_fragments"
+
+  has_many_attached :attachments
+
+  serialize :content
+
+  attr_reader :files
+
+  # -- Callbacks ---------------------------------------------------------------
+  # active_storage attachment behavior changed in rails 6 - see PR#892 for details
+  if Rails::VERSION::MAJOR >= 6
+    before_save :remove_attachments, :add_attachments
+  else
+    after_save :remove_attachments, :add_attachments
+  end
+
+  # -- Relationships -----------------------------------------------------------
+  belongs_to :record, polymorphic: true, touch: true
+
+  # -- Validations -------------------------------------------------------------
+  validates :identifier,
+    presence:   true,
+    uniqueness: { scope: :record }
+
+  # -- Instance Methods --------------------------------------------------------
+
+  # Temporary accessor for uploaded files. We can only attach to persisted
+  # records so we are deffering it to the after_save callback.
+  # Note: hijacking dirty tracking to force trigger callbacks later.
+  def files=(files)
+    @files = [files].flatten.compact
+    content_will_change! if @files.present?
+  end
+
+  def file_ids_destroy=(ids)
+    @file_ids_destroy = [ids].flatten.compact
+    content_will_change! if @file_ids_destroy.present?
+  end
+
+protected
+
+  def remove_attachments
+    return unless @file_ids_destroy.present?
+    attachments.where(id: @file_ids_destroy).destroy_all
+  end
+
+  def add_attachments
+    return if @files.blank?
+
+    # If we're dealing with a single file
+    if tag == "file"
+      @files = [@files.first]
+      attachments&.purge_later
+    end
+
+    attachments.attach(@files)
+  end
+
+end

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

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+class Occams::Cms::Layout < ActiveRecord::Base
+
+  self.table_name = "occams_cms_layouts"
+
+  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  = Occams::Content::Renderer.new(nil)
+    tokens    = renderer.tokenize(content)
+
+    if parent
+      fragment_tags = Occams::Content::Tag::Fragment.subclasses.map do |c|
+        Occams::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
+    Occams::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/occams/cms/page.rb

@@ -0,0 +1,170 @@
+# frozen_string_literal: true
+
+class Occams::Cms::Page < ActiveRecord::Base
+
+  self.table_name = "occams_cms_pages"
+
+  include Occams::Cms::WithFragments
+  include Occams::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: "Occams::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..-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/occams/cms/revision.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class Occams::Cms::Revision < ActiveRecord::Base
+
+  self.table_name = "occams_cms_revisions"
+
+  serialize :data
+
+  # -- Relationships --------------------------------------------------------
+  belongs_to :record, polymorphic: true
+
+end

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

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+class Occams::Cms::Site < ActiveRecord::Base
+
+  self.table_name = "occams_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 Occams::Cms::Site instance based on host and path
+  def self.find_site(host, path = nil)
+    return Occams::Cms::Site.first if Occams::Cms::Site.count == 1
+    cms_site = nil
+
+    public_cms_path = Occams.configuration.public_cms_path
+    if path && public_cms_path != "/"
+      path = path.sub(%r{\A#{public_cms_path}}, "")
+    end
+
+    Occams::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 = Occams.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 = Occams.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/occams/cms/snippet.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+class Occams::Cms::Snippet < ActiveRecord::Base
+
+  self.table_name = "occams_cms_snippets"
+
+  include Occams::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
+    Occams::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/occams/cms/translation.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+class Occams::Cms::Translation < ActiveRecord::Base
+
+  self.table_name = "occams_cms_translations"
+
+  include Occams::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/views/kaminari/occams/_first_page.html.haml

@@ -0,0 +1,3 @@
+- unless current_page.first?
+  %li.page-item
+    = link_to_unless current_page.first?, raw(t 'views.pagination.first'), url, class: 'page-link', remote: remote

data/app/views/kaminari/occams/_gap.html.haml

@@ -0,0 +1,2 @@
+%li.page.item.disabled
+  = link_to raw(t 'views.pagination.truncate'), '#', class: 'page-link'

data/app/views/kaminari/occams/_last_page.html.haml

@@ -0,0 +1,3 @@
+- unless current_page.last?
+  %li.page-item
+    = link_to_unless current_page.last?, raw(t 'views.pagination.last'), url, class: 'page-link', remote: remote

data/app/views/kaminari/occams/_next_page.html.haml

@@ -0,0 +1,2 @@
+%li.page-item
+  = link_to_unless current_page.last?, raw(t 'views.pagination.next'), url, rel: 'next', remote: remote, class: 'page-link'

data/app/views/kaminari/occams/_page.html.haml

@@ -0,0 +1,2 @@
+%li{class: "page-item#{' active' if page.current?}"}
+  = link_to page, url, opts = {remote: remote, class: 'page-link', rel: page.next? ? 'next' : page.prev? ? 'prev' : nil}

data/app/views/kaminari/occams/_paginator.html.haml

@@ -0,0 +1,11 @@
+= paginator.render do
+  %ul.pagination.pagination-sm
+    = first_page_tag unless current_page.first?
+    = prev_page_tag unless current_page.first?
+    - each_page do |page|
+      - if page.left_outer? || page.right_outer? || page.inside_window?
+        = page_tag page
+      - elsif !page.was_truncated?
+        = gap_tag
+    = next_page_tag unless current_page.last?
+    = last_page_tag unless current_page.last?

data/app/views/kaminari/occams/_prev_page.html.haml

@@ -0,0 +1,2 @@
+%li
+  = link_to_unless current_page.first?, raw(t 'views.pagination.previous'), url, :rel => 'prev', :remote => remote, class: 'page-link'