integral 1.4.0 → 1.5.0

data/app/views/layouts/integral/backend/_main_menu_items.haml

@@ -1,101 +1 @@
-%li
-  = link_to backend_dashboard_url do
-    = icon('home')
-    %span= t('integral.navigation.dashboard')
-
-- if policy(Integral::Page).index?
-  %li
-    = link_to backend_pages_url do
-      = icon('file')
-      %span= t('integral.navigation.pages')
-    %ul
-      %li= t('integral.navigation.pages')
-      %li
-        = link_to backend_pages_url do
-          %span= t('integral.navigation.dashboard')
-
-      - if policy(Integral::Page).create?
-        %li
-          = link_to new_backend_page_url do
-            %span= t('integral.actions.create')
-      %li
-        = link_to list_backend_pages_url do
-          %span= t('integral.navigation.listing')
-
-
-- if policy(Integral::Post).index? && Integral.blog_enabled?
-  %li
-    = link_to backend_posts_url do
-      = icon('rss')
-      %span= t('integral.navigation.posts')
-    %ul
-      %li= t('integral.navigation.posts')
-      %li
-        = link_to backend_posts_url do
-          %span= t('integral.navigation.dashboard')
-      - if policy(Integral::Post).create?
-        %li
-          = link_to new_backend_post_url do
-            %span= t('integral.actions.create')
-      %li
-        = link_to list_backend_posts_url do
-          %span= t('integral.navigation.listing')
-
-- if policy(Integral::List).index?
-  %li
-    = link_to backend_lists_url do
-      = icon('list')
-      %span= t('integral.navigation.lists')
-    %ul
-      %li= t('integral.navigation.lists')
-      %li
-        = link_to backend_lists_url do
-          %span= t('integral.navigation.dashboard')
-      - if policy(Integral::List).create?
-        %li
-          = link_to new_backend_list_url do
-            %span= t('integral.actions.create')
-
-- if policy(Integral::Image).manager?
-  %li
-    = link_to backend_img_index_url do
-      = icon('picture-o')
-      %span= t('integral.navigation.images')
-    %ul
-      %li= t('integral.navigation.images')
-      %li
-        = link_to backend_img_index_url do
-          %span= t('integral.navigation.dashboard')
-      - if policy(Integral::Image).create?
-        %li
-          = link_to new_backend_img_url do
-            %span= t('integral.actions.create')
-
-- if policy(current_user).manager?
-  %li
-    = link_to backend_users_url do
-      = icon('users')
-      %span=t('integral.navigation.users')
-    %ul
-      %li= t('integral.navigation.users')
-      %li
-        = link_to backend_users_url do
-          %span= t('integral.navigation.dashboard')
-      %li
-        = link_to new_backend_user_url do
-          %span= t('integral.actions.create')
-      %li
-        = link_to list_backend_users_url do
-          %span= t('integral.navigation.listing')
-
-- if policy(Integral::Version).manager?
-  %li
-    = link_to backend_activities_url do
-      = icon('crosshairs')
-      %span=t('integral.navigation.activities')
-
-- if current_user.admin?
-  %li
-    = link_to backend_settings_url do
-      = icon('cog')
-      %span=t('integral.navigation.settings')
+= render_main_menu

data/config/initializers/devise.rb

@@ -13,7 +13,7 @@ Devise.setup do |config|
   config.mailer_sender = Proc.new { "#{Integral::Settings.website_title} <#{Integral::Settings.contact_email}>" }
 
   # Configure the class responsible to send e-mails.
-  # config.mailer = 'Devise::Mailer'
+  config.mailer = 'Integral::DeviseMailer'
 
   # ==> ORM configuration
   # Load and configure the ORM. Supports :active_record (default) and

data/config/locales/en.yml

@@ -15,6 +15,44 @@ en:
       default: "%A, %d %B %Y"
       long: "%H:%M %d/%m/%Y"
 
+  datetime:
+    distance_in_words:
+      short:
+        half_a_minute: "30s"
+        less_than_x_seconds:
+          one:   "1s"
+          other: "%{count}s"
+        x_seconds:
+          one:   "1s"
+          other: "%{count}s"
+        less_than_x_minutes:
+          one:   "~1m"
+          other: "~%{count}m"
+        x_minutes:
+          one:   "1m"
+          other: "%{count}m"
+        about_x_hours:
+          one:   "~1h"
+          other: "~%{count}h "
+        x_days:
+          one:   "1d"
+          other: "%{count}d"
+        about_x_months:
+          one:   "~1mn"
+          other: "~%{count}mn"
+        x_months:
+          one:   "1mn"
+          other: "%{count}mn"
+        about_x_years:
+          one:   "~1y"
+          other: "~%{count}y"
+        over_x_years:
+          one:   "1y"
+          other: "%{count}y"
+        almost_x_years:
+          one:   "~1y"
+          other: "~%{count}y"
+
   errors:
     generic: Unfortunately there was a problem. Please try again later.
     unauthorized: You are not authorized to perform this action.
@@ -55,6 +93,8 @@ en:
       confirmation:
         deletion: If you delete this item it will be gone forever. Are you sure you want to proceed?
         clone: Are you sure you want to clone this item?
+        block: Are you sure you want to block this user?
+        unblock: Are you sure you want to unblock this user?
       new_page: Add new page
       new_post: Add new post
       edit_profile: Edit profile
@@ -63,6 +103,8 @@ en:
       view_main_site: View main site
       view_on_site: View on site
       publish: Publish
+      block: Block
+      unblock: Unblock
       create: Create
       clone: Clone
       save: Save
@@ -95,6 +137,9 @@ en:
       select_image: Select Image..
       select_type: Select Type..
       unsaved_changes: Changes that you made may not be saved.
+    tooltips:
+      unsubscribe: Unsubscribe from notifications.
+      subscribe: Subscribe to notifications.
     placeholders:
       description: Description
       title: Title
@@ -102,6 +147,9 @@ en:
       draft: Draft
       published: Published
       archived: Archived
+      blocked: Blocked
+      pending: Pending
+      active: Active
     records:
       attributes:
         category: Category
@@ -143,7 +191,7 @@ en:
       actions: Actions
       activity: Activity
       activity_log: Activity Log
-      profile: My Profile
+      profile: My profile
       quick_links: Quick Links
       activities: Activities
       home: Home
@@ -161,7 +209,7 @@ en:
       new: New
       edit: Edit
       log_out: Logout
-      my_account: Account & Profile
+      my_account: Account & profile
       settings: Settings
       listing: Listing
 
@@ -368,6 +416,8 @@ en:
           title: 'Image listing'
           no_images_available: 'No images available. Try uploading some!'
           new_image: 'New image'
+        edit:
+          title: Edit Image
       users:
         available_locales:
           en: English
@@ -424,6 +474,8 @@ en:
       list:
         title: This is only used for internal reference.
         description: This is only used for internal reference.
+      user:
+        notify_me: Subscribe to be notified whenever there is a change to any resource. Otherwise be notified about followed resources only.
     inputs:
       file:
         button_label: 'File'
@@ -473,6 +525,12 @@ en:
         create: 'Invite %{model}'
 
   devise:
+    invitations:
+      edit:
+        title: Set your password
+    failure:
+      user:
+        blocked: User account is no longer active.
     passwords:
       edit:
         title: Change your password

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/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,16 +35,18 @@ Integral::Page.create!(title: 'Integral CMS - Demo Page',
                        body: renderer.render('integral/pages/_demo', layout: false),
                        status: 1)
 
-# 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)
+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/integral.rb

@@ -15,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'

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

@@ -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