integral 1.0.0

data/app/models/integral/page_version.rb

@@ -0,0 +1,8 @@
+# Integral namespace
+module Integral
+  # Record PaperTrail of Integral::Page
+  class PageVersion < Version
+    self.table_name = :integral_page_versions
+    self.sequence_name = :integral_page_versions_id_seq
+  end
+end

data/app/models/integral/post.rb

@@ -0,0 +1,149 @@
+module Integral
+  # Represents a user post
+  class Post < ApplicationRecord
+    include ActionView::Helpers::DateHelper
+    acts_as_paranoid # Soft-deletion
+    acts_as_listable if Integral.blog_enabled? # Listable Item
+    acts_as_taggable # Tagging
+
+    has_paper_trail class_name: 'Integral::PostVersion'
+
+    # Slugging
+    extend FriendlyId
+    friendly_id :title, use: :history
+
+    enum status: %i[draft published]
+
+    # Conditional hack to check if method exists otherwise causes undefined method error in test env
+    self.per_page = 8 if respond_to? :per_page
+
+    # Associations
+    belongs_to :user
+    belongs_to :image, class_name: 'Integral::Image', optional: true
+    belongs_to :preview_image, class_name: 'Integral::Image', optional: true
+
+    # Validations
+    validates :title, presence: true, length: { minimum: 4, maximum: 60 }
+    validates :description, presence: true, length: { minimum: 50, maximum: 300 }
+    validates :body, :user, :slug, presence: true
+
+    # Callbacks
+    before_save :set_published_at
+    before_save :set_tags_context
+
+    # Aliases
+    alias author user
+    alias featured_image image
+
+    # Scopes
+    scope :search, ->(query) { where('lower(title) LIKE ?', "%#{query.downcase}%") }
+
+    # @return [Array] containing available human readable statuses against there numeric value
+    def self.available_statuses(opts = { reverse: false })
+      statuses = [
+        [I18n.t('integral.records.status.draft'), 0],
+        [I18n.t('integral.records.status.published'), 1]
+      ]
+
+      opts[:reverse] ? statuses.each(&:reverse!) : statuses
+    end
+
+    # Increments the view count of the post if a PostViewing is successfully added
+    #
+    # @param ip_address [String] Viewers IP address
+    def increment_count!(ip_address)
+      increment!(:view_count) if PostViewing.add(self, ip_address)
+    end
+
+    # @return [Hash] the instance as a list item
+    def to_list_item
+      subtitle = published_at.present? ? I18n.t('integral.blog.posted_ago', time: time_ago_in_words(published_at)) : I18n.t('integral.users.status.draft')
+      {
+        id: id,
+        title: title,
+        subtitle: subtitle,
+        description: description,
+        image: featured_image,
+        url: Integral::Engine.routes.url_helpers.post_url(self)
+      }
+    end
+
+    # @return [Hash] the instance as a card
+    def to_card
+      image_url = featured_image.file.url if featured_image
+      {
+        image: image_url,
+        description: title,
+        url: url,
+        attributes: [
+          { key: I18n.t('integral.records.attributes.author'), value: author.name },
+          { key: I18n.t('integral.records.attributes.views'), value: view_count },
+          { key: I18n.t('integral.records.attributes.status'), value: I18n.t("integral.records.status.#{status}") },
+          { key: I18n.t('integral.records.attributes.updated_at'), value: I18n.l(updated_at) }
+        ]
+      }
+    end
+
+    # @return [String] URL to frontend route
+    def url
+      Integral::Engine.routes.url_helpers.post_url(self)
+    end
+
+    # @return [Hash] listable options to be used within a RecordSelector widget
+    def self.listable_options
+      {
+        icon: 'rss',
+        record_title: I18n.t('integral.backend.record_selector.posts.record'),
+        selector_path: Engine.routes.url_helpers.backend_posts_path,
+        selector_title: I18n.t('integral.backend.record_selector.posts.title')
+      }
+    end
+
+    # @return [String] Current tag context
+    def tag_context
+      status
+    end
+
+    # @return [Array] ActsAsTaggableOn::Tag tags associated with this post
+    def tags
+      tags_on(tag_context)
+    end
+
+    private
+
+    def set_slug
+      if slug_changed? && Post.exists_by_friendly_id?(slug)
+        self.slug = resolve_friendly_id_conflict([slug])
+      end
+    end
+
+    def set_published_at
+      self.published_at = Time.now if published? && published_at.nil?
+    end
+
+    # Set the context of tags so that draft and archived tags are not displayed publicly
+    def set_tags_context
+      return unless tag_list_changed? || status_changed? || !persisted?
+
+      # Give all tags current context
+      set_tag_list_on(tag_context, tag_list)
+
+      # Clear previous contexts
+      self.tag_list = []
+      inactive_tag_contexts.each do |context|
+        set_tag_list_on(context, [])
+      end
+    end
+
+    # @return [Array] containing all inactive tag contexts
+    def inactive_tag_contexts
+      contexts = []
+
+      self.class.statuses.each_key do |status|
+        contexts << status
+      end
+      contexts.delete(tag_context)
+      contexts
+    end
+  end
+end

data/app/models/integral/post_version.rb

@@ -0,0 +1,8 @@
+# Integral namespace
+module Integral
+  # Record PaperTrail of Integral::Post
+  class PostVersion < Version
+    self.table_name = :integral_post_versions
+    self.sequence_name = :integral_post_versions_id_seq
+  end
+end

data/app/models/integral/post_viewing.rb

@@ -0,0 +1,19 @@
+module Integral
+  # Represents when a visitor views a post. Keeps track of unique view count based on IP address
+  class PostViewing < ApplicationRecord
+    belongs_to :post
+
+    # Adds a post viewing if it does not already exist
+    #
+    # @param post [Post] object which has been viewed
+    # @param ip_address [String] ip_address of the viewer
+    #
+    # @return [Boolean] whether or not the viewing was successfully added
+    def self.add(post, ip_address)
+      return false if where(post: post, ip_address: ip_address).exists?
+
+      create!(post: post, ip_address: ip_address)
+      true
+    end
+  end
+end

data/app/models/integral/role.rb

@@ -0,0 +1,14 @@
+module Integral
+  # Represents levels of authorization
+  class Role < ApplicationRecord
+    has_many :role_assignments
+    has_many :users, through: :role_assignments
+
+    validates :name, presence: true
+
+    # @return [String] label representing the Role
+    def label
+      I18n.t("integral.backend.roles.labels.#{name.underscore.downcase}")
+    end
+  end
+end

data/app/models/integral/role_assignment.rb

@@ -0,0 +1,7 @@
+module Integral
+  # Handles the has many relationship between User and Role
+  class RoleAssignment < ApplicationRecord
+    belongs_to :user
+    belongs_to :role
+  end
+end

data/app/models/integral/settings.rb

@@ -0,0 +1,5 @@
+module Integral
+  # Stores configurable application settings
+  class Settings < RailsSettings::Base
+  end
+end

data/app/models/integral/user.rb

@@ -0,0 +1,59 @@
+module Integral
+  # User model used to represent a authenticated user
+  class User < ApplicationRecord
+    # Soft-deletion
+    acts_as_paranoid
+
+    mount_uploader :avatar, AvatarUploader
+    process_in_background :avatar
+
+    # Included devise modules. Others available are:
+    # :confirmable, :timeoutable, :omniauthable, registerable and lockable
+    devise :invitable, :database_authenticatable, :recoverable, :rememberable, :trackable, :validatable
+
+    # Relations
+    has_many :role_assignments
+    has_many :roles, through: :role_assignments
+
+    # Validations
+    validates :name, :email, presence: true
+    validates :name, length: { minimum: 3, maximum: 25 }
+
+    has_paper_trail class_name: 'Integral::UserVersion'
+
+    scope :search, ->(search) { where('lower(name) LIKE ?', "%#{search.downcase}%") }
+
+    # Checks if the User has a given role
+    #
+    # @param role_sym [Symbol] role(s) to check - Can be array of symbols or one symbol
+    #
+    # @return [Boolean] whether or not user has role(s)
+    def role?(role_sym)
+      role_sym = [role_sym] unless role_sym.is_a?(Array)
+
+      roles.map { |r| r.name.underscore.to_sym }.any? { |user_role| role_sym.include?(user_role) }
+    end
+
+    # @return [Array] containing available locales
+    def self.available_locales
+      available_locales = []
+
+      Integral.backend_locales.each do |locale|
+        available_locales << [I18n.t("integral.backend.users.available_locales.#{locale}"), locale]
+      end
+
+      available_locales
+    end
+
+    # @return [String] return the avatar filename
+    def avatar_filename
+      name
+    end
+
+    private
+
+    def send_devise_notification(notification, *args)
+      devise_mailer.send(notification, self, *args).deliver_later
+    end
+  end
+end

data/app/models/integral/user_version.rb

@@ -0,0 +1,8 @@
+# Integral namespace
+module Integral
+  # Record PaperTrail of Integral::User
+  class UserVersion < Version
+    self.table_name = :integral_user_versions
+    self.sequence_name = :integral_user_versions_id_seq
+  end
+end

data/app/models/integral/version.rb

@@ -0,0 +1,31 @@
+# Integral namespace
+module Integral
+  # Base Version
+  # class Version < PaperTrail::Version
+  class Version < ApplicationRecord
+    include PaperTrail::VersionConcern
+    self.abstract_class = true
+
+    # @return [Array] available version actions
+    def self.available_actions
+      available = []
+
+      %w[update create destroy].each do |item|
+        available << [I18n.t("integral.actions.#{item}"), item]
+      end
+
+      available
+    end
+
+    # @return [Array] available version objects
+    def self.available_objects
+      available = []
+
+      [Integral::Post, Integral::Page, Integral::List, Integral::Image, Integral::User].each do |item|
+        available << [item.model_name.human, item]
+      end
+
+      available
+    end
+  end
+end

data/app/models/paper_trail/version.rb

@@ -0,0 +1,9 @@
+# :nocov:
+# Paper Trail - https://github.com/airblade/paper_trail
+module PaperTrail
+  # Base Version class for tracking model activity
+  class Version < ActiveRecord::Base
+    include PaperTrail::VersionConcern
+    self.abstract_class = true
+  end
+end

data/app/policies/integral/base_policy.rb

@@ -0,0 +1,50 @@
+module Integral
+  # Sets base policy for all objects to inherit
+  class BasePolicy
+    attr_reader :user, :instance
+
+    # Initializes a policy instance which is used to handle authorization
+    #
+    # @param user [User] user policy is authorizing against
+    # @param instance [Object] instance policy is authorizing against
+    def initialize(user, instance)
+      @user = user
+      @instance = instance
+    end
+
+    # @return [Boolean] whether or not user has manager role
+    def manager?
+      user.role?(role_name) || user.admin?
+    end
+
+    def permitted_attribute?(attribute)
+      permitted_attributes.include?(attribute)
+    end
+
+    def unpermitted_attribute?(attribute)
+      !permitted_attribute?(attribute)
+    end
+
+    # @return [Array] attributes the user is authorization to edit
+    def permitted_attributes
+      raise NotImplementedError
+    end
+
+    private
+
+    # @return [Symbol] role name
+    def role_name
+      raise NotImplementedError
+    end
+
+    alias destroy? manager?
+    alias index? manager?
+    alias show? manager?
+    alias new? manager?
+    alias create? manager?
+    alias edit? manager?
+    alias update? manager?
+    alias clone? manager?
+    alias grid? manager?
+  end
+end

data/app/policies/integral/image_policy.rb

@@ -0,0 +1,14 @@
+module Integral
+  # Handles Image authorization
+  class ImagePolicy < BasePolicy
+    # Allow all logged in users to access the images index
+    def index?
+      true
+    end
+
+    # @return [Symbol] role name
+    def role_name
+      :image_manager
+    end
+  end
+end

data/app/policies/integral/list_policy.rb

@@ -0,0 +1,9 @@
+module Integral
+  # Handles List authorization
+  class ListPolicy < BasePolicy
+    # @return [Symbol] role name
+    def role_name
+      :list_manager
+    end
+  end
+end

data/app/policies/integral/page_policy.rb

@@ -0,0 +1,45 @@
+module Integral
+  # Handles Page authorization
+  class PagePolicy < BasePolicy
+    # @return [Symbol] role name
+    def role_name
+      :page_manager
+    end
+
+    def editor?
+      user.role?(:page_editor) || user.admin?
+    end
+
+    def index?
+      user.admin? || user.role?(%i[page_manager page_editor page_contributer page_reader])
+    end
+
+    def create?
+      user.admin? || user.role?(%i[page_manager page_editor])
+    end
+
+    alias new? create?
+
+    def update?
+      user.admin? || user.role?(%i[page_manager page_editor])
+    end
+
+    alias edit? update?
+
+    def destroy?
+      user.admin? || user.role?([:page_manager])
+    end
+
+    # @return [Array] attributes the user is authorization to edit
+    def permitted_attributes
+      return [] unless manager? || editor?
+
+      permitted_params = %i[title description path body status template parent_id image_id lock_version]
+      permitted_params.concat Integral.additional_page_params
+
+      permitted_params -= [:status] unless manager?
+      permitted_params -= [:path] if !manager? && (editor? && !instance.draft?)
+      permitted_params
+    end
+  end
+end