integral 1.1.0 → 1.5.1

data/config/routes.rb

@@ -1,3 +1,5 @@
 Integral::Engine.routes.draw do
   Integral::Router.load
 end
+
+ActiveSupport::Notifications.instrument 'integral.routes_loaded'

data/db/migrate/20190414172018_create_webhook_endpoints.rb

@@ -0,0 +1,10 @@
+class CreateWebhookEndpoints < ActiveRecord::Migration[5.1]
+  def change
+    create_table :integral_webhook_endpoints do |t|
+      t.string :target_url, null: false
+      t.string :events, null: false, array: true
+      t.timestamps
+      t.index :events
+    end
+  end
+end

data/db/migrate/20190929191412_add_integral_post_categories.rb

@@ -0,0 +1,13 @@
+class AddIntegralPostCategories < ActiveRecord::Migration[5.1]
+  def change
+    create_table :integral_categories do |t|
+      t.string :title
+      t.string :description
+      t.string :slug, unique: true
+
+      t.timestamps null: false
+    end
+
+    add_reference :integral_posts, :category, index: true
+  end
+end

data/db/migrate/20191203090008_add_image_to_integral_categories.rb

@@ -0,0 +1,6 @@
+class AddImageToIntegralCategories < ActiveRecord::Migration[5.2]
+  def change
+    add_column :integral_categories, :image_id, :bigint
+    add_index :integral_categories, :image_id
+  end
+end

data/db/migrate/20200401210442_create_category_versions.rb

@@ -0,0 +1,20 @@
+class CreateCategoryVersions < ActiveRecord::Migration[5.2]
+  # The largest text column available in all supported RDBMS is
+  # 1024^3 - 1 bytes, roughly one gibibyte.  We specify a size
+  # so that MySQL will use `longtext` instead of `text`.  Otherwise,
+  # when serializing very large objects, `text` might not be big enough.
+  TEXT_BYTES = 1_073_741_823
+
+  def change
+    create_table :integral_category_versions do |t|
+      t.string   :item_type, {:null=>false}
+      t.integer  :item_id,   null: false
+      t.string   :event,     null: false
+      t.string   :whodunnit
+      t.text     :object, limit: TEXT_BYTES
+      t.text     :object_changes, limit: TEXT_BYTES
+      t.datetime :created_at
+    end
+    add_index :integral_category_versions, %i(item_type item_id)
+  end
+end

data/db/migrate/20200407022636_create_integral_notifications.rb

@@ -0,0 +1,25 @@
+class CreateIntegralNotifications < ActiveRecord::Migration[5.2]
+  def change
+    add_column :integral_users, :notify_me, :boolean, default: true
+
+    create_table :integral_notifications do |t|
+      t.integer :recipient_id
+      t.integer :actor_id
+      t.datetime :read_at
+      t.string :action
+      # (automated index name is too long)
+      t.references :subscribable, polymorphic: true, index: { name: 'index_integral_notifications_on_subscribable_type_id' }
+
+      t.timestamps null: false
+    end
+
+    create_table :integral_notification_subscriptions do |t|
+      t.integer :user_id
+      t.string :state
+      # (automated index name is too long)
+      t.references :subscribable, polymorphic: true, index: { name: 'index_integral_subscriptions_on_subscribable_type_id' }
+
+      t.timestamps null: false
+    end
+  end
+end

data/db/migrate/20200421223602_add_status_to_integral_users.rb

@@ -0,0 +1,5 @@
+class AddStatusToIntegralUsers < ActiveRecord::Migration[5.2]
+  def change
+    add_column :integral_users, :status, :integer, default: 0
+  end
+end

data/db/seeds.rb

@@ -18,7 +18,9 @@ Integral::Role.create!(name: 'PostManager')
 Integral::Role.create!(name: 'ListManager')
 
 # Demo User
-user = Integral::User.create!({ name: 'Integrico', email: 'user@integralrails.com', password: 'password', role_ids: Integral::Role.ids, admin: true })
+user = Integral::User.create!({ name: 'Integrico', email: 'user@integralrails.com', password: 'password', role_ids: Integral::Role.ids, admin: true, status: 1 })
+
+return if Rails.env.test? # Test DB should start with blank slate ... although roles and initial user are required
 
 # Demo Page
 host = URI.parse(Rails.application.routes.default_url_options[:host] || 'http://localhost:3000')
@@ -33,14 +35,18 @@ Integral::Page.create!(title: 'Integral CMS - Demo Page',
                        body: renderer.render('integral/pages/_demo', layout: false),
                        status: 1)
 
-# Demo Post
-Integral::Post.create!(title: 'Integral CMS - Demo Post',
-                       description:'Integral CMS demo post. Integral is a rails content management system (CMS) which gives developers the ability to create a modern website with all the bells and whistles without the hassle.',
-                       body: File.read(File.join(Integral::Engine.root.join('public', 'integral', 'ckeditor_demo_content.html'))),
-                       slug: 'integral-demo',
-                       user: user,
-                       tag_list: 'integral-cms,example-tag',
-                       status: 1)
+if Integral.blog_enabled?
+  # Demo Post
+  category = Integral::Category.create!(title: 'Uncategorised', description: "Posts which we haven't yet categorized but are sure to grab your attention", slug: 'uncategorized')
+  Integral::Post.create!(title: 'Integral CMS - Demo Post',
+                         description:'Integral CMS demo post. Integral is a rails content management system (CMS) which gives developers the ability to create a modern website with all the bells and whistles without the hassle.',
+                         body: File.read(File.join(Integral::Engine.root.join('public', 'integral', 'ckeditor_demo_content.html'))),
+                         slug: 'integral-demo',
+                         user: user,
+                         tag_list: 'integral-cms,example-tag',
+                         status: 1,
+                         category: category)
+end
 
 # Main Menu
 Integral::List.create!({ title: 'Main Menu', list_items: [

data/lib/generators/integral/assets_generator.rb

@@ -6,7 +6,7 @@ module Integral
     # @example Generate all Integral assets
     #   rails g integral:assets --assets 'backend frontend email'
     class AssetsGenerator < Rails::Generators::Base
-      source_root File.expand_path('../../../../app/assets', __FILE__)
+      source_root File.expand_path('../../../app/assets', __dir__)
       class_option :asset_list, aliases: '-a', type: :array, default: 'frontend'
       desc 'Copies Integral assets to your application'
 
@@ -24,7 +24,7 @@ module Integral
         return unless options['asset_list'].include?('frontend')
 
         file 'javascripts/integral/frontend.js'
-        file 'stylesheets/integral/frontend.sass'
+        file 'stylesheets/integral/frontend.scss'
         directory 'stylesheets/integral/frontend'
       end
 

data/lib/generators/integral/install_generator.rb

@@ -3,7 +3,7 @@ module Integral
   module Generators
     # Runs setup for an Integral Application
     class InstallGenerator < Rails::Generators::Base
-      source_root File.expand_path('../../templates', __FILE__)
+      source_root File.expand_path('../templates', __dir__)
       desc 'Creates Integral, Carrierwave, CarrierwaveBackgrounder & Sitemap initializers'
 
       # Copies over necessary initialiser files

data/lib/generators/integral/views_generator.rb

@@ -6,7 +6,7 @@ module Integral
     # @example Generate all Integral views
     #   rails g integral:views --views 'backend frontend devise mailer'
     class ViewsGenerator < Rails::Generators::Base
-      source_root File.expand_path('../../../../app/views', __FILE__)
+      source_root File.expand_path('../../../app/views', __dir__)
       class_option :views, aliases: '-v', type: :array, default: 'frontend'
       desc 'Copies Integral views to your application'
 

data/lib/generators/templates/app.yml

@@ -8,7 +8,6 @@ defaults: &defaults
   # github_url: https://github.com/yamasolutions/integral
   # twitter_url: https://twitter.com/yama_solutions
   # facebook_url: https://www.facebook.com/yamasolutions
-  # google_plus_url: https://plus.google.com/communities/101878695540653445908
   # linkedin_url: https://www.linkedin.com/in/barackobama/
   # youtube_url: https://www.youtube.com/channel/UCUkM9uMpWatT7gVWShgtKFw
   # instagram_url: https://www.instagram.com/jerryoftheday

data/lib/generators/templates/integral.rb

@@ -61,6 +61,11 @@ Integral.configure do |config|
   #
   # config.additional_page_templates = [:full_width]
 
+  # Add additional tracked classes to include within activity tracking
+  # Default is []
+  #
+  # config.additional_tracked_classes = [MyCustomClass]
+
   # Configure what page paths are protected from user entry to prevent accidentally overriding
   # config.black_listed_paths = [
   #   '/admin/',

data/lib/integral.rb

@@ -5,7 +5,6 @@ require 'integral/version'
 require 'integral/router'
 require 'integral/middleware/page_router'
 require 'integral/engine'
-require 'integral/slack_bot'
 require 'integral/button_link_renderer'
 require 'integral/google_tag_manager'
 require 'integral/foundation_builder'
@@ -16,6 +15,7 @@ require 'integral/grids/lists_grid'
 require 'integral/grids/posts_grid'
 require 'integral/grids/images_grid'
 require 'integral/acts_as_listable'
+require 'integral/acts_as_integral'
 require 'integral/widgets/recent_posts'
 require 'integral/widgets/swiper_list'
 require 'integral/content_renderer'
@@ -34,107 +34,81 @@ module Integral
     yield(self)
   end
 
-  #
   mattr_accessor :backend_namespace
   @@backend_namespace = 'admin'
 
-  #
   mattr_accessor :backend_locales
   @@backend_locales = [:en]
 
-  #
   mattr_accessor :additional_settings_params
   @@additional_settings_params = []
 
-  #
   mattr_accessor :additional_widgets
   @@additional_widgets = []
 
-  #
   mattr_accessor :additional_post_params
   @@additional_post_params = []
 
-  #
   mattr_accessor :additional_page_params
   @@additional_page_params = []
 
-  #
   mattr_accessor :gtm_container_id
   @@gtm_container_id = ''
 
-  #
   mattr_accessor :blog_enabled
   @@blog_enabled = true
 
-  #
   mattr_accessor :blog_namespace
   @@blog_namespace = 'blog'
 
-  #
   mattr_accessor :black_listed_paths
   @@black_listed_paths = ['/admin']
 
-  #
   mattr_accessor :root_path
   @@root_path = nil
 
-  #
   mattr_accessor :frontend_parent_controller
   @@frontend_parent_controller = 'Integral::ApplicationController'
 
-  #
   mattr_accessor :editor_image_size_limit
   @@editor_image_size_limit = [1600, 1600]
 
-  #
   mattr_accessor :image_thumbnail_size
   @@image_thumbnail_size = [50, 50]
 
-  #
   mattr_accessor :image_small_size
   @@image_small_size = [500, 500]
 
-  #
   mattr_accessor :image_medium_size
   @@image_medium_size = [800, 800]
 
-  #
   mattr_accessor :image_large_size
   @@image_large_size = [1600, 1600]
 
-  #
   mattr_accessor :additional_page_templates
   @@additional_page_templates = []
 
-  #
+  mattr_accessor :additional_tracked_classes
+  @@additional_tracked_classes = []
+
   mattr_accessor :compression_enabled
   @@compression_enabled = true
 
-  #
   mattr_accessor :image_compression_quality
   @@image_compression_quality = 85
 
-  #
   mattr_accessor :editable_persisted_images
   @@editable_persisted_images = false
 
-  #
-  mattr_accessor :slack_web_hook_url
-  @@slack_web_hook_url = nil
-
-  #
   mattr_accessor :description_length_maximum
   @@description_length_maximum = 300
 
-  #
   mattr_accessor :description_length_minimum
   @@description_length_minimum = 50
 
-  #
   mattr_accessor :title_length_maximum
   @@title_length_maximum = 60
 
-  #
   mattr_accessor :title_length_minimum
   @@title_length_minimum = 4
 

data/lib/integral/acts_as_integral.rb

@@ -0,0 +1,115 @@
+module Integral
+  # Handles adding Integral behaviour to a class
+  module ActsAsIntegral
+    DEFAULT_OPTIONS ={ notifications: { enabled: true },
+                       cards: { at_a_glance: true, },
+                       backend_main_menu: { enabled: true, order: 11 },
+                       backend_create_menu: { enabled: true, order: 1 }}.freeze
+    class << self
+      attr_writer :backend_main_menu_items
+      attr_writer :backend_create_menu_items
+      attr_writer :backend_at_a_glance_card_items
+    end
+
+    # Accessor for backend main menu items
+    def self.backend_main_menu_items
+      @backend_main_menu_items ||= []
+    end
+
+    # Accessor for backend create menu items
+    def self.backend_create_menu_items
+      @backend_create_menu_items ||= []
+    end
+
+    # Accessor for at a glance card items
+    def self.backend_at_a_glance_card_items
+      @backend_at_a_glance_card_items ||= []
+    end
+
+    # Adds item to main backend dashboard at a glance chart
+    # @param [Class] item
+    def self.add_backend_at_a_glance_card_item(item)
+      backend_at_a_glance_card_items << item unless duplicate_menu_item?(item, backend_at_a_glance_card_items)
+    end
+
+    # Adds item to create menu, expects Hash or Class
+    def self.add_backend_create_menu_item(item)
+      backend_create_menu_items << item unless duplicate_menu_item?(item, backend_create_menu_items)
+    end
+
+    # Adds item to main menu, expects Hash or Class
+    def self.add_backend_main_menu_item(item)
+      backend_main_menu_items << item unless duplicate_menu_item?(item, backend_main_menu_items)
+    end
+
+    # Checks for existing duplicates in menu. Useful in development when app reloads
+    def self.duplicate_menu_item?(item, menu)
+      duplicate_found = if item.class == Class
+                          menu.map(&:to_s).include?(item.to_s)
+                        else
+                          menu.select { |item| item.is_a?(Hash) }.map {|item| item[:id] }.include?(item[:id])
+                        end
+
+      if duplicate_found
+        Rails.logger.error("ActsAsIntegral: Item '#{item.to_s}' not added to menu as it already exists.")
+        true
+      else
+        false
+      end
+    end
+
+    ActiveSupport.on_load(:active_record) do
+      # ActiveRecord::Base extension
+      class ActiveRecord::Base
+        # Adds integral behaviour to models
+        def self.acts_as_integral(options = {})
+          class << self
+            attr_accessor :integral_options
+
+            # @return [Hash] hash representing the class, used to render within the main menu
+            def integral_backend_main_menu_item
+              {
+                icon: integral_icon,
+                order: integral_options.dig(:backend_main_menu, :order),
+                label: model_name.human.pluralize,
+                url: url_helpers.send("backend_#{model_name.route_key}_url"),
+                # authorize: proc { policy(self).index? }, can't use this as self is in wrong context
+                authorize_class: self,
+                authorize_action: :index,
+                list_items: [
+                  { label: I18n.t('integral.navigation.dashboard'), url: url_helpers.send("backend_#{model_name.route_key}_url"), authorize_class: self, authorize_action: :index },
+                  { label: I18n.t('integral.actions.create'), url: url_helpers.send("new_backend_#{model_name.singular_route_key}_url"), authorize_class: self, authorize_action: :new },
+                  { label: I18n.t('integral.navigation.listing'), url: url_helpers.send("list_backend_#{model_name.route_key}_url"), authorize_class: self, authorize_action: :list },
+                ]
+              }
+            end
+
+            # @return [Hash] hash representing the class, used to render within the create menu
+            def integral_backend_create_menu_item
+              {
+                icon: integral_icon,
+                order: integral_options.dig(:backend_create_menu, :order),
+                label: model_name.human,
+                url: url_helpers.send("new_backend_#{model_name.singular_route_key}_url"),
+                # authorize: proc { policy(self).index? }, can't use this as self is in wrong context
+                authorize_class: self,
+                authorize_action: :new,
+              }
+            end
+
+            def url_helpers
+              Integral::Engine.routes.url_helpers
+            end
+          end
+
+          self.integral_options = Integral::ActsAsIntegral::DEFAULT_OPTIONS.deep_merge(options)
+          Integral::ActsAsIntegral.add_backend_create_menu_item(self) if integral_options.dig(:backend_create_menu, :enabled)
+          Integral::ActsAsIntegral.add_backend_main_menu_item(self) if integral_options.dig(:backend_main_menu, :enabled)
+          Integral::ActsAsIntegral.add_backend_at_a_glance_card_item(self) if integral_options.dig(:cards, :at_a_glance)
+
+          include Integral::Notification::Subscribable if integral_options.dig(:notifications, :enabled)
+        end
+      end
+    end
+  end
+end

data/lib/integral/acts_as_listable.rb

@@ -2,8 +2,8 @@ module Integral
   # Handles listable behaviour
   module ActsAsListable
     class << self
-       # Keeps a track of listable objects
-       attr_writer :objects
+      # Keeps a track of listable objects
+      attr_writer :objects
      end
 
     # Accessor for listable objects
@@ -16,7 +16,7 @@ module Integral
       class ActiveRecord::Base
         # Adds listable behaviour to objects
         def self.acts_as_listable(_options = {})
-          Integral::ActsAsListable.objects << self
+          Integral::ActsAsListable.objects << self unless Integral::ActsAsListable.objects.map(&:name).include?(self.name)
 
           # @return [Hash] instance as a list item
           # Keys include: id, title, subtitle, image, description, url