forest_cms 0.98.1

data/app/helpers/admin_info_helper.rb

@@ -0,0 +1,12 @@
+module AdminInfoHelper
+  def info_message(message)
+    [
+      '<div class="well">',
+        '<div class="text-muted">',
+          '<span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span> ',
+          message,
+        '</div>',
+    '</div>'
+    ].join.html_safe
+  end
+end

data/app/helpers/admin_settings_helper.rb

@@ -0,0 +1,16 @@
+module AdminSettingsHelper
+
+  def admin_setting_value(setting)
+    return setting.value if setting.value.blank?
+
+    case setting.value_type
+    when 'boolean'
+      setting.value == '1' ? 'True' : 'False'
+    when 'image'
+      URI(setting.value).path.split('/').last
+    else
+      setting.value
+    end
+  end
+
+end

data/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/app/helpers/block_helper.rb

@@ -0,0 +1,25 @@
+module BlockHelper
+
+  def render_blocks(record, options = {})
+    return if record.blank?
+
+    begin
+      block_layout = options[:block_layout].presence || BlockLayout.default_layout
+
+      if block_layout.is_a?(Symbol)
+        block_layout = BlockLayout.find_by_slug(block_layout)
+      end
+
+      collection = record.blocks(block_layout: block_layout).reject(&:hidden?)
+
+      if collection.present?
+        content_tag :div, class: "blocks block-layout--#{block_layout.slug}" do
+          render partial: 'blocks/show', collection: collection, as: 'block'
+        end
+      end
+    rescue Exception => e
+      forest_admin_error(e)
+    end
+  end
+
+end

data/app/helpers/cache_helper.rb

@@ -0,0 +1,23 @@
+module CacheHelper
+  def cache_key_for(collection)
+    count = collection.try(:count) || 1
+    if collection.is_a? Array
+      return if collection.blank?
+      max_updated_at = collection.reject(&:blank?).max_by(&:updated_at).updated_at.try(:utc).try(:to_s, :number)
+      "#{collection.first.model_name.plural}/all-#{count}-#{max_updated_at}"
+    elsif collection.try :updated_at
+      "#{collection.model_name.plural}/all-#{count}-#{collection.updated_at.try(:utc).try(:to_s, :number)}"
+    else
+      max_updated_at = collection.maximum(:updated_at).try(:utc).try(:to_s, :number)
+      "#{collection.model_name.plural}/all-#{count}-#{max_updated_at}"
+    end
+  end
+
+  def cache_digest_for(stringable)
+    Digest::MD5.hexdigest(stringable.to_s)
+  end
+
+  def application_cache_key
+    @_application_cache_key ||= Setting.application_cache_key
+  end
+end

data/app/helpers/forest_errors_helper.rb

@@ -0,0 +1,34 @@
+module ForestErrorsHelper
+  # Display errors that are only visible to admin users
+  def forest_admin_error(error, options = {})
+    if Rails.env.production?
+      if current_user&.admin?
+        logger.error("[Forest] forest_admin_error")
+        logger.error(error.message)
+        logger.error(error.backtrace.join("\n"))
+
+        error_messages = []
+        error_messages << "Error on #{Rails.application.class.parent.to_s.titleize}\n"
+        error_messages << "Path: #{request.fullpath.force_encoding('utf-8')}\n"
+        error_messages << "#{error.message}\n"
+        error_messages << error.backtrace.first(20).join("\n")
+
+        visible_errors_for_admin = []
+        visible_errors_for_admin << options.fetch(:message, "Warning: this code block has errors and is not visible to the public.\nYou are seeing this message because you are an admin.\n")
+        visible_errors_for_admin << mail_to('mailto:hi@dylanfisher.com',
+                                        "Click here to email this error to the developers.\n",
+                                        subject: "Error on #{Rails.application.class.parent.to_s.titleize} - #{request.path.force_encoding('utf-8')}",
+                                        body: error_messages.join("\n").html_safe,
+                                        target: '_blank')
+        visible_errors_for_admin << "#{error.message}\n"
+        visible_errors_for_admin << error.backtrace.join("\n")
+
+        content_tag :pre, class: 'admin-error-message' do
+          visible_errors_for_admin.join("\n").html_safe
+        end
+      end
+    else
+      raise error
+    end
+  end
+end

data/app/helpers/form_helper.rb

@@ -0,0 +1,93 @@
+module FormHelper
+
+  # TODO:
+  # - enable multiple selections at the same time, e.g. merge the current_scopes
+
+  def dropdown_select_form(options = {})
+    url                    = options.fetch :url
+    id                     = options.fetch :id
+    select_options         = options.fetch :select_options
+    title                  = options.fetch :title, nil
+    placeholder            = options.fetch :placeholder, nil
+    include_blank          = options.fetch :include_blank, nil
+    css_class              = options.fetch :css_class, nil
+    remote_parent          = options.fetch :remote_parent, nil
+    remote_target          = options.fetch :remote_target, nil
+    remote_response_target = options.fetch :remote_response_target, nil
+
+    if remote_parent && remote_target && remote_response_target
+      remote = true
+    end
+
+    if remote
+      form_tag_base_css_class = 'select-tag-remote-form'
+    else
+      form_tag_base_css_class = 'select-tag-form'
+    end
+
+    form_tag url, method: :get, enforce_utf8: false, class: "#{form_tag_base_css_class} #{css_class}" do
+      # concat params_as_hidden_fields id
+      concat select_tag_dropdown id: id,
+        select_options: select_options,
+        title: title,
+        placeholder: placeholder,
+        include_blank: include_blank,
+        selected: params[id],
+        remote_parent: remote_parent,
+        remote_target: remote_target,
+        remote_response_target: remote_response_target
+    end
+  end
+
+  private
+
+    def select_tag_dropdown(options = {})
+      id                     = options.fetch :id
+      select_options         = options.fetch :select_options
+      title                  = options.fetch :title, nil
+      placeholder            = options.fetch :placeholder, nil
+      include_blank          = options.fetch :include_blank, nil
+      selected               = options.fetch :selected, nil
+      remote_parent          = options.fetch :remote_parent, nil
+      remote_target          = options.fetch :remote_target, nil
+      remote_response_target = options.fetch :remote_response_target, nil
+      remote_attributes      = {}
+      options_for_select     = title ? select_options.unshift([title, '']) : select_options
+
+      if remote_parent && remote_target && remote_response_target
+        remote = true
+      end
+
+      if remote
+        css_class = 'select-tag--remote'
+        remote_attributes = {
+          remote_parent: remote_parent,
+          remote_target: remote_target,
+          remote_response_target: remote_response_target
+        }
+      else
+        css_class = 'select-tag--default'
+      end
+
+      select_tag id,
+        options_for_select(options_for_select, selected),
+        placeholder: placeholder.presence || 'false',
+        id: id,
+        class: css_class,
+        include_blank: include_blank,
+        style: 'width: 100%',
+        data: {
+          form_title: title,
+          **remote_attributes
+        }
+    end
+
+    def params_as_hidden_fields(additional_params_to_ignore)
+      params_to_ignore = :controller, :action, :locale, :utf8
+      params_to_process = params_to_ignore.reject { |param| param == additional_params_to_ignore.to_s }
+      params_to_process.collect do |param|
+        hidden_field_tag param
+      end.join.html_safe
+    end
+
+end

data/app/helpers/image_helper.rb

@@ -0,0 +1,65 @@
+module ImageHelper
+  # Embed an SVG file inline, allowing it to be styled with CSS.
+  def embedded_svg(filename, options={})
+    file = File.read(Rails.root.join('app', 'assets', 'images', 'svg', "#{filename}.svg"))
+    doc = Nokogiri::HTML::DocumentFragment.parse file
+    svg = doc.at_css 'svg'
+    if options[:class].present?
+      svg['class'] = "#{svg['class']} #{options[:class]}"
+    end
+    if options[:id].present?
+      svg['id'] = options[:id]
+    end
+    if options[:style].present?
+      svg['style'] = "#{svg['style']} #{options[:style]}"
+    end
+    doc.to_html.html_safe
+  end
+
+  def responsive_image(media_item, options = {})
+    # TODO: DF 08/04/17 - return a missing image if media item is blank?
+    # return if media_item.blank?
+    css_class = options.fetch :class, nil
+    image_set_tag media_item.attachment.url(:small), {
+        media_item.attachment.url(:medium) => '1200w',
+        media_item.attachment.url(:large) => '2000w'
+      },
+      options.merge(
+        sizes: options.fetch(:sizes, '100vw'),
+        class: "responsive-image #{css_class}"
+      )
+  end
+
+  # https://gist.github.com/mrreynolds/4fc71c8d09646567111f
+  # Acts as a thin wrapper for image_tag and generates an srcset attribute for regular image tags
+  # for usage with responsive images polyfills like picturefill.js, supports asset pipeline path helpers.
+  #
+  # image_set_tag 'pic_1980.jpg', { 'pic_640.jpg' => '640w', 'pic_1024.jpg' => '1024w', 'pic_1980.jpg' => '1980w' }, sizes: '100vw', class: 'my-image'
+  #
+  # => <img src="/assets/ants_1980.jpg" srcset="/assets/pic_640.jpg 640w, /assets/pic_1024.jpg 1024w, /assets/pic_1980.jpg 1980w" sizes="100vw" class="my-image">
+  def image_set_tag(source, srcset = {}, options = {})
+    srcset = srcset.map { |src, size| "#{asset_path(src)} #{size}" }.join(', ')
+    image_tag source, options.merge(srcset: srcset)
+  end
+
+  # Prevent images from thrashing your page's layout with the image_jump_fix helper.
+  #
+  # <%= image_jump_fix block.media_item do %>
+  #   <%= image_tag block.media_item.attachment.url(:medium) %>
+  # <% end %>
+  def image_jump_fix(media_item, options = {})
+    width = media_item.try(:dimensions).try(:[], :width) || media_item.try(:attachment_width)
+    height = media_item.try(:dimensions).try(:[], :height) || media_item.try(:attachment_height)
+    tag_type = options.delete(:tag) || :div
+    css_class = options[:class]
+
+    if [width, height].all?
+      ratio = height.to_f / width.to_f * 100
+      padding_bottom = "padding-bottom: #{ratio}%;"
+    end
+
+    content_tag tag_type, class: "forest-image-jump-fix #{('forest-image-jump-fix--' + media_item.attachment_content_type.parameterize) if media_item.try(:attachment_content_type).present?} #{css_class}", style: padding_bottom do
+      yield
+    end
+  end
+end

data/app/helpers/markdown_helper.rb

@@ -0,0 +1,25 @@
+require 'redcarpet/render_strip'
+
+module MarkdownHelper
+  def md(text)
+    parser.render(text.to_s).html_safe
+  end
+
+  def stripdown(text)
+    stripper.render(text.to_s).squish
+  end
+
+  private
+
+    def parser
+      @parser ||= Redcarpet::Markdown.new(renderer, Forest::MarkdownRenderer.options)
+    end
+
+    def stripper
+      @stripper ||= Redcarpet::Markdown.new(Redcarpet::Render::StripDown)
+    end
+
+    def renderer
+      @renderer ||= Forest::MarkdownRenderer.new(Forest::MarkdownRenderer.render_options)
+    end
+end

data/app/helpers/meta_helper.rb

@@ -0,0 +1,238 @@
+module MetaHelper
+  def meta_page_title
+    @_meta_page_title ||= begin
+      title = []
+
+      if record_to_build_from.try(:seo_title).present?
+        title << record_to_build_from.seo_title
+      else
+        title << page_title unless controller_name == 'home_pages'
+        title << site_title
+      end
+
+      title = title.reject(&:blank?).join(divider)
+      stripdown(title).squish
+    end
+  end
+
+  def page_title
+    @_page_title ||= begin
+      return if @disable_page_title.present?
+      title = [
+        content_for(:page_title),
+        @page_title,
+        build_page_title_from_record,
+        build_page_title_from_controller
+      ].reject(&:blank?).first
+      stripdown(title).squish
+    end
+  end
+
+  def site_title
+    @_site_title ||= begin
+      title = Setting.for('site_title') || default_site_title
+      stripdown(title).squish
+    end
+  end
+
+  def page_description
+    @_page_description ||= begin
+      description = [
+        content_for(:page_description),
+        @page_description,
+        build_page_description_from_record,
+        site_description
+      ].reject(&:blank?).first.try(:squish)
+      stripdown(description).squish
+    end
+  end
+
+  def page_keywords
+    @_page_keywords ||= begin
+      [
+        content_for(:page_keywords),
+        Setting.for('page_keywords')
+      ].reject(&:blank?).first.try(:squish)
+    end
+  end
+
+  def page_featured_image
+    @_page_featured_image ||= begin
+      image = [
+        content_for(:page_featured_image),
+        @page_featured_image,
+        build_page_featured_image_from_record,
+        site_featured_image
+      ].reject(&:blank?).first
+
+      if image.respond_to?(:attachment)
+        image = image.attachment
+      end
+
+      image
+    end
+  end
+
+  def page_featured_image_url
+    begin
+      @_page_featured_image_url ||= begin
+        if page_featured_image.is_a?(String)
+          url = page_featured_image
+        end
+
+        if page_featured_image.is_a?(Paperclip::Attachment)
+          if page_featured_image.options[:styles].keys.include?(:large)
+            style = :large
+          else
+            style = page_featured_image.options[:styles].keys.last
+          end
+          url = page_featured_image.url(style)
+        end
+
+        url
+      end
+    rescue Exception => e
+    end
+  end
+
+  def page_featured_image_width
+    @_page_featured_image_width ||= begin
+      return unless page_featured_image.is_a?(Paperclip::Attachment)
+      @page_featured_image_width ||
+        page_featured_image.instance.try(:dimensions).try(:[], :width) ||
+        page_featured_image.instance.try(:attachment_width)
+    end
+  end
+
+  def page_featured_image_height
+    @_page_featured_image_height ||= begin
+      return unless page_featured_image.is_a?(Paperclip::Attachment)
+      @page_featured_image_height ||
+        page_featured_image.instance.try(:dimensions).try(:[], :height) ||
+        page_featured_image.instance.try(:attachment_height)
+    end
+  end
+
+  def page_featured_image_type
+    @_page_featured_image_type ||= begin
+      return unless page_featured_image.is_a?(Paperclip::Attachment)
+      page_featured_image.try(:attachment_content_type)
+    end
+  end
+
+  def page_featured_image_alt
+    @_page_featured_image_alt ||= begin
+      return unless page_featured_image.is_a?(Paperclip::Attachment)
+      page_featured_image.try(:instance).try(:alternative_text)
+    end
+  end
+
+  def site_description
+    @_site_description ||= begin
+      (Setting.for('description') || default_site_description).try(:squish)
+    end
+  end
+
+  def site_featured_image
+    @_site_featured_image ||= begin
+      Setting.for('featured_image')
+    end
+  end
+
+  def meta_see_also
+    @_meta_see_also ||= begin
+      [
+        content_for(:meta_see_also),
+        root_path
+      ].reject(&:blank?).first
+    end
+  end
+
+  def meta_type
+    @_meta_type ||= begin
+      [
+        content_for(:meta_type),
+        default_meta_type
+      ].reject(&:blank?).first
+    end
+  end
+
+  def meta_url
+    @_meta_url ||= begin
+      [
+        content_for(:meta_url),
+        (request.base_url.force_encoding('utf-8') + request.path.force_encoding('utf-8'))
+      ].reject(&:blank?).first
+    end
+  end
+
+  def meta_viewport
+    @_meta_viewport ||= begin
+      [
+        content_for(:meta_viewport),
+        'width=device-width, initial-scale=1.0'
+      ].reject(&:blank?).first
+    end
+  end
+
+  def additional_meta_tags
+    content_for(:additional_meta_tags)
+  end
+
+  private
+
+    def default_site_title
+      'Forest CMS'
+    end
+
+    def default_site_description
+      'This site was built with Forest, a Ruby on Rails CMS.'
+    end
+
+    def default_meta_type
+      'website'
+    end
+
+    def divider(spacer = ' - ')
+      spacer
+    end
+
+    def build_page_title_from_record
+      record_to_build_from.try(:to_page_title) ||
+      record_to_build_from.try(:title) ||
+      record_to_build_from.try(:name)
+    end
+
+    def build_page_title_from_controller
+      if controller_name == 'home_pages'
+        'Home'
+      else
+        controller_name.titleize
+      end
+    end
+
+    def build_page_description_from_record
+      @_build_page_description_from_record ||= begin
+        description = record_to_build_from.try(:to_page_description) ||
+          record_to_build_from.try(:description)
+        truncate(description, length: 240)
+      end
+    end
+
+    def build_page_featured_image_from_record
+      @_build_page_featured_image_from_record ||= begin
+        record_to_build_from.try(:featured_image).presence ||
+          record_to_build_from.try(:media_item).presence ||
+          record_to_build_from.try(:blockable_metadata).try(:[], 'featured_image_url').presence
+      end
+    end
+
+    def record_to_build_from(record = nil)
+      @_record_to_build_from ||= begin
+        record.presence ||
+          @page.presence ||
+          @record.presence ||
+          instance_variable_get("@#{controller_name.singularize}").presence
+      end
+    end
+end