integral 1.0.0

data/lib/integral/engine.rb

@@ -0,0 +1,124 @@
+module Integral
+  # Integral Engine
+  class Engine < ::Rails::Engine
+    require 'haml'
+    require 'htmlcompressor'
+    require 'jquery-rails'
+    require 'groupdate'
+    require 'turbolinks'
+    require 'toastr-rails'
+    require 'nprogress-rails'
+    require 'simple_form'
+    require 'gibbon'
+    require 'cocoon'
+    require 'draper'
+    require 'coffee-rails'
+    require 'client_side_validations'
+    require 'client_side_validations/simple_form'
+    require 'parsley-rails'
+    require 'datagrid'
+    require 'font-awesome-sass'
+    require 'breadcrumbs_on_rails'
+    require 'foundation-rails'
+    require 'pundit'
+    require 'carrierwave'
+    require 'carrierwave-aws'
+    require 'carrierwave_backgrounder'
+    require 'carrierwave-imageoptimizer'
+    require 'ckeditor'
+    require 'paper_trail'
+    require 'diffy'
+    require 'active_record_union'
+    require 'i18n-js'
+    require 'meta-tags'
+    require 'sitemap_generator'
+    # require 'before_render'
+    require 'friendly_id'
+    require 'acts-as-taggable-on'
+    require 'slack-notifier'
+    require 'paranoia'
+    require 'inky'
+    require 'premailer/rails'
+    require 'will_paginate'
+    require 'will_paginate-foundation'
+    require 'rails-settings-cached'
+    require 'gaffe'
+
+    isolate_namespace Integral
+
+    config.generators do |g|
+      g.test_framework :rspec
+      g.fixture_replacement :factory_bot, dir: 'spec/factories'
+    end
+
+    # Dynamic page routing
+    config.middleware.use Integral::Middleware::PageRouter
+
+    # Engine customization
+    config.to_prepare do
+      # Allow Integral to be extended
+      Dir.glob(Rails.root + 'app/extensions/**/*_decorator*.rb').each do |c|
+        require_dependency(c)
+      end
+
+      Integral::Engine.routes.default_url_options[:host] = Rails.application.routes.default_url_options[:host]
+    end
+
+    # Clientside I18n
+    config.assets.initialize_on_precompile = true
+
+    # Do not automatically include all helpers
+    config.action_controller.include_all_helpers = false
+
+    # Allows engine factories to be reused by application
+    initializer 'model_core.factories', after: 'factory_bot.set_factory_paths' do
+      if defined?(FactoryBot)
+        FactoryBot.definition_file_paths << File.expand_path('../../../spec/factories', __FILE__)
+      end
+    end
+
+    initializer 'integral.assets.precompile' do |app|
+      assets_for_precompile = [
+        # Dashboard tiles
+        'integral/tiles/*',
+        # Defaults
+        'integral/defaults/*',
+        # CKEditor Overrides
+        'ckeditor/my_contents.css',
+        'ckeditor/my_styles.js',
+        'ckeditor/my_config.js',
+        'ckeditor/filebrowser/*',
+        'ckeditor/skins/*',
+        'ckeditor/lang/*',
+        'ckeditor/plugins/*',
+
+        # Frontend
+        'integral/frontend.js',
+        'integral/frontend.css',
+        'integral/posts-hero-banner.jpg',
+        'integral/demo/*',
+
+        # Backend
+        'integral/backend.js',
+        'integral/backend.css',
+        'integral/backend/logo.png',
+        'integral/backend/data-unavailable.png',
+        'integral/image-not-set.png',
+
+        # Emails
+        'integral/emails.css',
+        'integral/emails/colors.css',
+
+        # Errors
+        'errors.css'
+      ]
+
+      app.config.assets.precompile.concat assets_for_precompile
+    end
+
+    # Initializer to combine this engines static assets with the static assets of the hosting site.
+    initializer 'static assets' do |app|
+      app.middleware.insert_before(::ActionDispatch::Static, ::ActionDispatch::Static, "#{root}/public")
+    end
+  end
+end

data/lib/integral/foundation_builder.rb

@@ -0,0 +1,33 @@
+# Foundation 6 builder for breadcrumbs
+# :nocov:
+class FoundationBuilder < BreadcrumbsOnRails::Breadcrumbs::Builder
+  # @return [String] representing the breadcrumb
+  def render
+    output = ''
+    output += "<nav aria-label='You are here:' role='navigation'>"
+    output += "<ul class='breadcrumbs'>"
+
+    output += @elements.collect do |element|
+      render_element(element)
+    end.join
+
+    output += '</ul>'
+    output += '</nav>'
+    output
+  end
+
+  private
+
+  def render_element(element)
+    if element.path.nil? || @context.current_page?(compute_path(element))
+      @context.content_tag :li do
+        @context.content_tag(:span, 'Current: ', class: 'show-for-sr') +
+          compute_name(element)
+      end
+    else
+      @context.content_tag :li do
+        @context.link_to(compute_name(element), compute_path(element), element.options)
+      end
+    end
+  end
+end

data/lib/integral/google_tag_manager.rb

@@ -0,0 +1,33 @@
+module Integral
+  # Handles rendering Google Tag Manager snipper
+  class GoogleTagManager
+    # Render Google Tag Manager Snippet
+    #
+    # @return [String] GTM Container if ID has been supplied
+    def self.render(container_id, type = :script)
+      # TODO: - May want to add some other check for staging environments
+      return '' if !container_id.present? || !Rails.env.production?
+
+      if type == :script
+        snippet = <<-HTML
+          <!-- Google Tag Manager -->
+          <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
+          new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
+          j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
+          '//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
+          })(window,document,'script','dataLayer','#{container_id}');</script>
+          <!-- End Google Tag Manager -->
+        HTML
+      else
+        snippet = <<-HTML
+          <!-- Google Tag Manager -->
+          <noscript><iframe src="//www.googletagmanager.com/ns.html?id=#{container_id}"
+          height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
+          <!-- End Google Tag Manager -->
+        HTML
+      end
+
+      snippet.html_safe
+    end
+  end
+end

data/lib/integral/grids/activities_grid.rb

@@ -0,0 +1,37 @@
+module Integral
+  # Grids to manage displaying of data when filtering & sorting is required
+  module Grids
+    # Manages Activity filtering & sorting
+    class ActivitiesGrid
+      include Datagrid
+
+      scope do
+        Integral::UserVersion.all.union(Integral::PageVersion.all).union(Integral::PostVersion.all).union(Integral::ListVersion.all).union(Integral::ImageVersion.all).order('created_at DESC')
+      end
+
+      filter(:user, multiple: true) do |value|
+        where(whodunnit: value)
+      end
+
+      filter(:action, multiple: true) do |value|
+        where(event: value)
+      end
+
+      filter(:object, multiple: true) do |value|
+        where(item_type: value)
+      end
+
+      filter(:item_id, multiple: true) do |value|
+        where(item_id: value)
+      end
+
+      column(:date, order: :created_at)
+      column(:user, order: :whodunnit)
+      column(:action, order: :event)
+      column(:object, order: :item_type)
+      column(:instance)
+      column(:attributes_changed)
+      column(:actions)
+    end
+  end
+end

data/lib/integral/grids/images_grid.rb

@@ -0,0 +1,21 @@
+module Integral
+  # Grids to manage displaying of data when filtering & sorting is required
+  module Grids
+    # Manages Image filtering & sorting
+    class ImagesGrid
+      include Datagrid
+
+      scope do
+        Integral::Image.all.order('title DESC')
+      end
+
+      filter(:title) do |value|
+        search(value)
+      end
+
+      column(:title, order: :title)
+      column(:updated_at, order: :updated_at)
+      column(:actions)
+    end
+  end
+end

data/lib/integral/grids/lists_grid.rb

@@ -0,0 +1,21 @@
+module Integral
+  # Grids to manage displaying of data when filtering & sorting is required
+  module Grids
+    # Manages List filtering & sorting
+    class ListsGrid
+      include Datagrid
+
+      scope do
+        Integral::List.where(hidden: false).order('title DESC')
+      end
+
+      filter(:title) do |value|
+        search(value)
+      end
+
+      column(:title, order: :title)
+      column(:updated_at, order: :updated_at)
+      column(:actions)
+    end
+  end
+end

data/lib/integral/grids/pages_grid.rb

@@ -0,0 +1,27 @@
+module Integral
+  # Grids to manage displaying of data when filtering & sorting is required
+  module Grids
+    # Manages Page filtering & sorting
+    class PagesGrid
+      include Datagrid
+
+      scope do
+        Integral::Page.all.order('updated_at DESC')
+      end
+
+      filter(:title) do |value|
+        search(value)
+      end
+
+      filter(:status, multiple: true) do |value|
+        where(status: value)
+      end
+
+      column(:title, order: :title)
+      column(:path, order: :path)
+      column(:status, order: :status)
+      column(:updated_at, order: :updated_at)
+      column(:actions)
+    end
+  end
+end

data/lib/integral/grids/posts_grid.rb

@@ -0,0 +1,32 @@
+module Integral
+  # Grids to manage displaying of data when filtering & sorting is required
+  module Grids
+    # Manages List filtering & sorting
+    class PostsGrid
+      include Datagrid
+
+      scope do
+        Integral::Post.all.order('title DESC')
+      end
+
+      filter(:title) do |value|
+        search(value)
+      end
+
+      filter(:status, multiple: true) do |value|
+        where(status: value)
+      end
+
+      filter(:user, multiple: true) do |value|
+        where(user: value)
+      end
+
+      column(:title, order: :title)
+      column(:user, order: :user)
+      column(:status, order: :status)
+      column(:view_count, order: :view_count)
+      column(:updated_at, order: :updated_at)
+      column(:actions)
+    end
+  end
+end

data/lib/integral/grids/users_grid.rb

@@ -0,0 +1,22 @@
+module Integral
+  # Grids to manage displaying of data when filtering & sorting is required
+  module Grids
+    # Manages User filtering & sorting
+    class UsersGrid
+      include Datagrid
+
+      scope do
+        Integral::User.all.order('name DESC')
+      end
+
+      filter(:name) do |value|
+        search(value)
+      end
+
+      column(:name, order: :name)
+      column(:email, order: :email)
+      column(:updated_at, order: :updated_at)
+      column(:actions)
+    end
+  end
+end

data/lib/integral/list_item_renderer.rb

@@ -0,0 +1,204 @@
+module Integral
+  # Handles safely rendering list items
+  class ListItemRenderer
+    include ActionView::Helpers::TagHelper
+    include ActionView::Helpers::TextHelper
+    include ActionView::Helpers::AssetTagHelper
+    include ActionView::Context
+
+    attr_accessor :list_item, :opts
+
+    # Renders the provided list item with options given
+    #
+    # @return [String] the rendered list item
+    def self.render(list_item, opts = {})
+      renderer = new(list_item, opts)
+      renderer.render
+    end
+
+    # @param list_item [ListItem] object to render
+    # @param opts [Hash] options hash
+    def initialize(list_item, opts = {})
+      @opts = opts.reverse_merge(
+        wrapper_element: 'li',
+        child_wrapper_element: 'ul',
+        child_wrapper_class: ''
+      )
+
+      @list_item = list_item
+    end
+
+    # Renders the provided list_item
+    #
+    # @return [String] the rendered list item (including possible children)
+    def render
+      return render_no_object_warning if list_item.object? && !object_available?
+
+      content_tag opts[:wrapper_element], class: html_classes do
+        if list_item.has_children?
+          concat render_item
+          concat content_tag opts[:child_wrapper_element], render_children, { class: opts[:child_wrapper_class] }, false
+        else
+          render_item
+        end
+      end
+    end
+
+    # @return [String] list item HTML
+    def render_item
+      content_tag :a, title, item_options
+    end
+
+    # @return [Hash] list item options
+    def item_options
+      opts = {}
+      opts[:class] = 'dropdown-button' if list_item.has_children?
+      opts[:href] = url if url.present?
+      opts[:target] = target if target.present? && target != '_self'
+
+      opts
+    end
+
+    # Loop over all list item children calling render on each
+    #
+    # @return [String] compiled string of all the rendered list item children
+    def render_children
+      children = ''
+
+      list_item.children.each do |child|
+        children += self.class.render(child, opts)
+      end
+
+      children
+    end
+
+    # Used within backend for preselecting type in dropdown
+    # TODO: Move this onto the model level
+    def type_for_dropdown
+      return list_item.type unless list_item.object?
+      list_item.object_type.to_s
+    end
+
+    # @return [String] title of list item
+    def title
+      provide_attr(:title)
+    end
+
+    # @return [String] description of list item
+    def description
+      provide_attr(:description)
+    end
+
+    # @return [String] target of list item
+    def target
+      list_item.target unless list_item.basic?
+    end
+
+    # @return [String] URL of list item
+    def url
+      return if list_item.basic?
+      url = provide_attr(:url)
+
+      return url if url.nil? || url.empty?
+      return url if url.match?(URI::DEFAULT_PARSER.make_regexp)
+
+      "#{Rails.application.routes.default_url_options[:host]}#{url}"
+    end
+
+    # @return [String] subtitle of list item
+    def subtitle
+      provide_attr(:subtitle)
+    end
+
+    # Returns the non object image path
+    def object_image
+      image = object_data[:image] if object_available?
+
+      return image.file.url if image.respond_to?(:file)
+      return image if image.present?
+
+      fallback_image
+    end
+
+    # @return [Boolean] whether item has an image linked to it (which isn't through an object)
+    def non_object_image?
+      list_item.image.present?
+    end
+
+    # Returns the non object image path
+    def non_object_image
+      image = list_item.image
+
+      return image.file.url if image.respond_to?(:file)
+      return image if image.present?
+
+      fallback_image
+    end
+
+    # @parameter version [Symbol] the version of the image so use if associated image is a file
+    #
+    # @return [String] the image URL
+    def image(version = nil)
+      image = provide_attr(:image)
+
+      return image.file.url(version) if image.respond_to?(:file)
+      return image if image.present?
+
+      fallback_image
+    end
+
+    # @return [Boolean] whether or not title is a required attribute
+    # TODO: This and other methods which are only used in backend could be moved to decorators
+    def title_required?
+      !list_item.object?
+    end
+
+    # @return [String] path to fallback image for list items
+    def fallback_image
+      ActionController::Base.helpers.image_path('integral/defaults/no_image_available.jpg')
+    end
+
+    private
+
+    def render_no_object_warning
+      message = "Tried to render a list item (##{list_item.id}) with no object."
+      Rails.logger.debug("IntegralMessage: #{message}")
+      "<!-- Warning: #{message} -->"
+    end
+
+    # Works out what the provided attr evaluates to.
+    #
+    # @param attr [Symbol] attribute to evaluate
+    #
+    # @return [String] value of attribute
+    def provide_attr(attr)
+      list_item_attr_value = list_item.public_send(attr)
+
+      # Provide user supplied attr
+      return list_item_attr_value if list_item_attr_value.present?
+
+      # Provide object supplied attr
+      return object_data[attr] if object_available?
+
+      # Provide error - Object is linked but has been deleted
+      return 'Object Unavailable' if list_item.object? && !object_available?
+
+      # Provide empty string - no attr supplied and no object linked
+      ''
+    end
+
+    def object_data
+      @object_data ||= list_item.object.to_list_item
+    end
+
+    def object_available?
+      @object_available ||= list_item.object? && list_item.object.present?
+    end
+
+    def html_classes
+      return list_item.html_classes unless opts[:html_classes].present?
+
+      "#{list_item.html_classes} #{opts[:html_classes]}"
+    end
+  end
+end