activeadmin-rb 1.4.0

data/lib/active_admin/namespace_settings.rb

@@ -0,0 +1,107 @@
+require 'active_admin/dynamic_settings_node'
+
+module ActiveAdmin
+  class NamespaceSettings < DynamicSettingsNode
+    # The default number of resources to display on index pages
+    register :default_per_page, 30
+
+    # The max number of resources to display on index pages and batch exports
+    register :max_per_page, 10_000
+
+    # The title which gets displayed in the main layout
+    register :site_title, "", :string_symbol_or_proc
+
+    # Set the site title link href (defaults to AA dashboard)
+    register :site_title_link, ""
+
+    # Set the site title image displayed in the main layout (has precendence over :site_title)
+    register :site_title_image, "", :string_symbol_or_proc
+
+    # Set the site footer text (defaults to Powered by ActiveAdmin text with version)
+    register :footer, "", :string_symbol_or_proc
+
+    # Set a favicon
+    register :favicon, false
+
+    # Additional meta tags to place in head of logged in pages.
+    register :meta_tags, {}
+
+    # Additional meta tags to place in head of logged out pages.
+    register :meta_tags_for_logged_out_pages, { robots: "noindex, nofollow" }
+
+    # The view factory to use to generate all the view classes. Take
+    # a look at ActiveAdmin::ViewFactory
+    register :view_factory, ActiveAdmin::ViewFactory.new
+
+    # The method to call in controllers to get the current user
+    register :current_user_method, false
+
+    # The method to call in the controllers to ensure that there
+    # is a currently authenticated admin user
+    register :authentication_method, false
+
+    # The path to log user's out with. If set to a symbol, we assume
+    # that it's a method to call which returns the path
+    register :logout_link_path, :destroy_admin_user_session_path
+
+    # The method to use when generating the link for user logout
+    register :logout_link_method, :get
+
+    # Whether the batch actions are enabled or not
+    register :batch_actions, false
+
+    # Whether filters are enabled
+    register :filters, true
+
+    # The namespace root.
+    register :root_to, 'dashboard#index'
+
+    # Options that a passed to root_to.
+    register :root_to_options, {}
+
+    # Options passed to the routes, i.e. { path: '/custom' }
+    register :route_options, {}
+
+    # Display breadcrumbs
+    register :breadcrumb, true
+
+    # Display create another checkbox on a new page
+    # @return [Boolean] (true)
+    register :create_another, false
+
+    # Default CSV options
+    register :csv_options, { col_sep: ',', byte_order_mark: "\xEF\xBB\xBF" }
+
+    # Default Download Links options
+    register :download_links, true
+
+    # The authorization adapter to use
+    register :authorization_adapter, ActiveAdmin::AuthorizationAdapter
+
+    # A proc to be used when a user is not authorized to view the current resource
+    register :on_unauthorized_access, :rescue_active_admin_access_denied
+
+    # A regex to detect unsupported browser, set to false to disable
+    register :unsupported_browser_matcher, /MSIE [1-8]\.0/
+
+    # Whether to display 'Current Filters' on search screen
+    register :current_filters, true
+
+    # class to handle ordering
+    register :order_clause, ActiveAdmin::OrderClause
+
+    # default show_count for scopes
+    register :scopes_show_count, true
+
+    # Request parameters that are permitted by default
+    register :permitted_params, [
+      :utf8, :_method, :authenticity_token, :commit, :id
+    ]
+
+    # Set flash message keys that shouldn't show in ActiveAdmin
+    register :flash_keys_to_except, ['timedout']
+
+    # Include association filters by default
+    register :include_default_association_filters, true
+  end
+end

data/lib/active_admin/order_clause.rb

@@ -0,0 +1,48 @@
+module ActiveAdmin
+  class OrderClause
+    attr_reader :field, :order, :active_admin_config
+
+    def initialize(active_admin_config, clause)
+      clause =~ /^([\w\_\.]+)(->'\w+')?_(desc|asc)$/
+      @column = $1
+      @op = $2
+      @order = $3
+      @active_admin_config = active_admin_config
+      @field = [@column, @op].compact.join
+    end
+
+    def valid?
+      @field.present? && @order.present?
+    end
+
+    def apply(chain)
+      chain.reorder(Arel.sql sql)
+    end
+
+    def to_sql
+      [table_column, @op, ' ', @order].compact.join
+    end
+
+    def table
+      active_admin_config.resource_column_names.include?(@column) ? active_admin_config.resource_table_name : nil
+    end
+
+    def table_column
+      (@column =~ /\./) ? @column :
+        [table, active_admin_config.resource_quoted_column_name(@column)].compact.join(".")
+    end
+
+    def sql
+      custom_sql || to_sql
+    end
+
+    protected
+
+    def custom_sql
+      if active_admin_config.ordering[@column].present?
+        active_admin_config.ordering[@column].call(self)
+      end
+    end
+
+  end
+end

data/lib/active_admin/orm/active_record.rb

@@ -0,0 +1,5 @@
+# ActiveRecord-specific plugins should be required here
+
+ActiveAdmin::DatabaseHitDuringLoad.database_error_classes << ActiveRecord::StatementInvalid
+
+require 'active_admin/orm/active_record/comments'

data/lib/active_admin/orm/active_record/comments.rb

@@ -0,0 +1,101 @@
+require 'active_admin/orm/active_record/comments/views'
+require 'active_admin/orm/active_record/comments/show_page_helper'
+require 'active_admin/orm/active_record/comments/namespace_helper'
+require 'active_admin/orm/active_record/comments/resource_helper'
+
+# Add the comments configuration
+ActiveAdmin::Application.inheritable_setting :comments,                   true
+ActiveAdmin::Application.inheritable_setting :comments_registration_name, 'Comment'
+ActiveAdmin::Application.inheritable_setting :comments_order,             "created_at ASC"
+ActiveAdmin::Application.inheritable_setting :comments_menu,              {}
+
+# Insert helper modules
+ActiveAdmin::Namespace.send :include, ActiveAdmin::Comments::NamespaceHelper
+ActiveAdmin::Resource.send  :include, ActiveAdmin::Comments::ResourceHelper
+ActiveAdmin.application.view_factory.show_page.send :include, ActiveAdmin::Comments::ShowPageHelper
+
+# Load the model as soon as it's referenced. By that point, Rails & Kaminari will be ready
+ActiveAdmin.autoload :Comment, 'active_admin/orm/active_record/comments/comment'
+
+# Hint i18n-tasks about model and attribute translations used by default install
+# i18n-tasks-use t('activerecord.models.comment')
+# i18n-tasks-use t('activerecord.models.active_admin/comment')
+# i18n-tasks-use t('activerecord.attributes.active_admin/comment.author_type')
+# i18n-tasks-use t('activerecord.attributes.active_admin/comment.body')
+# i18n-tasks-use t('activerecord.attributes.active_admin/comment.created_at')
+# i18n-tasks-use t('activerecord.attributes.active_admin/comment.namespace')
+# i18n-tasks-use t('activerecord.attributes.active_admin/comment.resource_type')
+# i18n-tasks-use t('activerecord.attributes.active_admin/comment.updated_at')
+# i18n-tasks-use t('active_admin.scopes.all')
+
+# Walk through all the loaded namespaces after they're loaded
+ActiveAdmin.after_load do |app|
+  app.namespaces.each do |namespace|
+    namespace.register ActiveAdmin::Comment, as: namespace.comments_registration_name do
+      actions :index, :show, :create, :destroy
+
+      menu namespace.comments ? namespace.comments_menu : false
+
+      config.comments      = false # Don't allow comments on comments
+      config.batch_actions = false # The default destroy batch action isn't showing up anyway...
+
+      scope :all, show_count: false
+      # Register a scope for every namespace that exists.
+      # The current namespace will be the default scope.
+      app.namespaces.map(&:name).each do |name|
+        scope name, default: namespace.name == name do |scope|
+          scope.where namespace: name.to_s
+        end
+      end
+
+      # Store the author and namespace
+      before_save do |comment|
+        comment.namespace = active_admin_config.namespace.name
+        comment.author    = current_active_admin_user
+      end
+
+      controller do
+        # Prevent N+1 queries
+        def scoped_collection
+          super.includes(:author, :resource)
+        end
+
+        # Redirect to the resource show page after comment creation
+        def create
+          create! do |success, failure|
+            success.html do
+              ActiveAdmin::Dependency.rails.redirect_back self, active_admin_root
+            end
+            failure.html do
+              flash[:error] = I18n.t 'active_admin.comments.errors.empty_text'
+              ActiveAdmin::Dependency.rails.redirect_back self, active_admin_root
+            end
+          end
+
+          def destroy
+            destroy! do |success, failure|
+              success.html do
+                ActiveAdmin::Dependency.rails.redirect_back self, active_admin_root
+              end
+              failure.html do
+                ActiveAdmin::Dependency.rails.redirect_back self, active_admin_root
+              end
+            end
+          end
+        end
+      end
+
+      permit_params :body, :namespace, :resource_id, :resource_type
+
+      index do
+        column I18n.t('active_admin.comments.resource_type'), :resource_type
+        column I18n.t('active_admin.comments.author_type'),   :author_type
+        column I18n.t('active_admin.comments.resource'),      :resource
+        column I18n.t('active_admin.comments.author'),        :author
+        column I18n.t('active_admin.comments.body'),          :body
+        column I18n.t('active_admin.comments.created_at'),    :created_at
+        actions
+      end
+    end
+  end
+end

data/lib/active_admin/orm/active_record/comments/comment.rb

@@ -0,0 +1,31 @@
+module ActiveAdmin
+  class Comment < ActiveRecord::Base
+
+    self.table_name = "#{table_name_prefix}active_admin_comments#{table_name_suffix}"
+
+    belongs_to :resource, { polymorphic: true }.merge(ActiveAdmin::Dependency.rails.optional_belongs_to_flag)
+    belongs_to :author,   polymorphic: true
+
+    validates_presence_of :body, :namespace, :resource
+
+    before_create :set_resource_type
+
+    # @return [String] The name of the record to use for the polymorphic relationship
+    def self.resource_type(resource)
+      ResourceController::Decorators.undecorate(resource).class.base_class.name.to_s
+    end
+
+    def self.find_for_resource_in_namespace(resource, namespace)
+      where(
+        resource_type: resource_type(resource),
+        resource_id:   resource,
+        namespace:     namespace.to_s
+      ).order(ActiveAdmin.application.namespaces[namespace.to_sym].comments_order)
+    end
+
+    def set_resource_type
+      self.resource_type = self.class.resource_type(resource)
+    end
+
+  end
+end

data/lib/active_admin/orm/active_record/comments/namespace_helper.rb

@@ -0,0 +1,14 @@
+module ActiveAdmin
+  module Comments
+
+    module NamespaceHelper
+
+      # Returns true if the namespace allows comments
+      def comments?
+        comments == true
+      end
+
+    end
+
+  end
+end

data/lib/active_admin/orm/active_record/comments/resource_helper.rb

@@ -0,0 +1,17 @@
+module ActiveAdmin
+  module Comments
+
+    module ResourceHelper
+      extend ActiveSupport::Concern
+
+      included do
+        attr_accessor :comments
+      end
+
+      def comments?
+        (namespace.comments? && comments != false) || comments == true
+      end
+    end
+
+  end
+end

data/lib/active_admin/orm/active_record/comments/show_page_helper.rb

@@ -0,0 +1,23 @@
+module ActiveAdmin
+  module Comments
+
+    # Adds #active_admin_comments to the show page for use
+    # and sets it up on the default main content
+    module ShowPageHelper
+
+      # Add admin comments to the main content if they are
+      # turned on for the current resource
+      def default_main_content
+        super
+        active_admin_comments if active_admin_config.comments?
+      end
+
+      # Display the comments for the resource. Same as calling
+      # #active_admin_comments_for with the current resource
+      def active_admin_comments(*args, &block)
+        active_admin_comments_for(resource, *args, &block)
+      end
+    end
+
+  end
+end

data/lib/active_admin/orm/active_record/comments/views.rb

@@ -0,0 +1,2 @@
+require 'active_admin/views'
+require 'active_admin/orm/active_record/comments/views/active_admin_comments'

data/lib/active_admin/orm/active_record/comments/views/active_admin_comments.rb

@@ -0,0 +1,95 @@
+require 'active_admin/views'
+require 'active_admin/views/components/panel'
+
+module ActiveAdmin
+  module Comments
+    module Views
+
+      class Comments < ActiveAdmin::Views::Panel
+        builder_method :active_admin_comments_for
+
+        attr_accessor :resource
+
+        def build(resource)
+          @resource = resource
+          @comments = ActiveAdmin::Comment.find_for_resource_in_namespace(resource, active_admin_namespace.name).includes(:author).page(params[:page])
+          super(title, for: resource)
+          build_comments
+        end
+
+        protected
+
+        def title
+          I18n.t 'active_admin.comments.title_content', count: @comments.total_count
+        end
+
+        def build_comments
+          if @comments.any?
+            @comments.each(&method(:build_comment))
+            div page_entries_info(@comments).html_safe, class: 'pagination_information'
+          else
+            build_empty_message
+          end
+
+          text_node paginate @comments
+          build_comment_form
+        end
+
+        def build_comment(comment)
+          div for: comment do
+            div class: 'active_admin_comment_meta' do
+              h4 class: 'active_admin_comment_author' do
+                comment.author ? auto_link(comment.author) : I18n.t('active_admin.comments.author_missing')
+              end
+              span pretty_format comment.created_at
+              if authorized?(ActiveAdmin::Auth::DESTROY, comment)
+                text_node link_to I18n.t('active_admin.comments.delete'), comments_url(comment.id), method: :delete, data: { confirm: I18n.t('active_admin.comments.delete_confirmation') }
+              end
+            end
+            div class: 'active_admin_comment_body' do
+              simple_format comment.body
+            end
+          end
+        end
+
+        def build_empty_message
+          span I18n.t('active_admin.comments.no_comments_yet'), class: 'empty'
+        end
+
+        def comments_url(*args)
+          parts = []
+          parts << active_admin_namespace.name unless active_admin_namespace.root?
+          parts << active_admin_namespace.comments_registration_name.underscore
+          parts << 'path'
+          send parts.join('_'), *args
+        end
+
+        def comment_form_url
+          parts = []
+          parts << active_admin_namespace.name unless active_admin_namespace.root?
+          parts << active_admin_namespace.comments_registration_name.underscore.pluralize
+          parts << 'path'
+          send parts.join '_'
+        end
+
+        def build_comment_form
+          active_admin_form_for(ActiveAdmin::Comment.new, url: comment_form_url) do |f|
+            f.inputs do
+              f.input :resource_type, as: :hidden,  input_html: { value: ActiveAdmin::Comment.resource_type(parent.resource) }
+              f.input :resource_id,   as: :hidden,  input_html: { value: parent.resource.id }
+              f.input :body,          label: false, input_html: { size: '80x8' }
+            end
+            f.actions do
+              f.action :submit, label: I18n.t('active_admin.comments.add')
+            end
+          end
+        end
+
+        def default_id_for_prefix
+          'active_admin_comments_for'
+        end
+      end
+
+    end
+  end
+end