activeadmin 2.2.0

data/lib/active_admin/resource_controller/decorators.rb

@@ -0,0 +1,102 @@
+module ActiveAdmin
+  class ResourceController < BaseController
+    module Decorators
+
+      protected
+
+      def apply_decorator(resource)
+        decorate? ? decorator_class.new(resource) : resource
+      end
+
+      def apply_collection_decorator(collection)
+        if decorate?
+          collection_decorator.decorate collection, with: decorator_class
+        else
+          collection
+        end
+      end
+
+      def self.undecorate(resource)
+        if resource.respond_to?(:decorated?) && resource.decorated?
+          resource.model
+        else
+          resource
+        end
+      end
+
+      private
+
+      def decorate?
+        case action_name
+        when 'new', 'edit', 'create', 'update'
+          form = active_admin_config.get_page_presenter :form
+          form && form.options[:decorate] && decorator_class.present?
+        else
+          decorator_class.present?
+        end
+      end
+
+      def decorator_class
+        active_admin_config.decorator_class
+      end
+
+      # When using Draper, we wrap the collection draper in a new class that
+      # correctly delegates methods that Active Admin depends on.
+      def collection_decorator
+        if decorator_class
+          Wrapper.wrap decorator_class
+        end
+      end
+
+      class Wrapper
+        @cache = {}
+
+        def self.wrap(decorator)
+          collection_decorator = find_collection_decorator(decorator)
+
+          if draper_collection_decorator? collection_decorator
+            name = "#{collection_decorator.name} of #{decorator} + ActiveAdmin"
+            @cache[name] ||= wrap! collection_decorator, name
+          else
+            collection_decorator
+          end
+        end
+
+        private
+
+        def self.wrap!(parent, name)
+          ::Class.new parent do
+            delegate :reorder, :page, :current_page, :total_pages, :limit_value,
+                     :total_count, :total_pages, :to_key, :group_values, :except,
+                     :find_each, :ransack
+
+            define_singleton_method(:name) { name }
+          end
+        end
+
+        # Draper::CollectionDecorator was introduced in 1.0.0
+        # Draper::Decorator#collection_decorator_class was introduced in 1.3.0
+        def self.find_collection_decorator(decorator)
+          if Dependency.draper?    '>= 1.3.0'
+            decorator.collection_decorator_class
+          elsif Dependency.draper? '>= 1.0.0'
+            draper_collection_decorator
+          else
+            decorator
+          end
+        end
+
+        def self.draper_collection_decorator?(decorator)
+          decorator && decorator <= draper_collection_decorator
+        rescue NameError
+          false
+        end
+
+        def self.draper_collection_decorator
+          ::Draper::CollectionDecorator
+        end
+
+      end
+    end
+  end
+end

data/lib/active_admin/resource_controller/resource_class_methods.rb

@@ -0,0 +1,26 @@
+module ActiveAdmin
+  class ResourceController < BaseController
+    module ResourceClassMethods
+
+      # Override the default `resource_class` class and instance
+      # methods to only return the class defined in the instance
+      # of ActiveAdmin::Resource
+      def override_resource_class_methods!
+        class_exec do
+          def self.resource_class=(klass); end
+
+          def self.resource_class
+            @active_admin_config ? @active_admin_config.resource_class : nil
+          end
+
+          private
+
+          def resource_class
+            self.class.resource_class
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/active_admin/resource_controller/scoping.rb

@@ -0,0 +1,31 @@
+module ActiveAdmin
+  class ResourceController < BaseController
+
+    # This module deals with scoping entire controllers to a relation
+    module Scoping
+      extend ActiveSupport::Concern
+
+      protected
+
+      # Override the default InheritedResource #begin_of_association_chain to allow
+      # the scope to be defined in the active admin configuration.
+      #
+      # If scope_to is a proc, we eval it, otherwise we call the method on the controller.
+      #
+      # Collection can be scoped conditionally with an :if or :unless proc.
+      def begin_of_association_chain
+        return nil unless active_admin_config.scope_to?(self)
+        MethodOrProcHelper.render_in_context(self, active_admin_config.scope_to_method)
+      end
+
+      # Overriding from InheritedResources::BaseHelpers
+      #
+      # Returns the method for the association chain when using
+      # the scope_to option
+      def method_for_association_chain
+        active_admin_config.scope_to_association_method || super
+      end
+
+    end
+  end
+end

data/lib/active_admin/resource_controller/sidebars.rb

@@ -0,0 +1,18 @@
+module ActiveAdmin
+  class ResourceController < BaseController
+
+    module Sidebars
+
+      protected
+
+      def skip_sidebar!
+        @skip_sidebar = true
+      end
+
+      def skip_sidebar?
+        @skip_sidebar == true
+      end
+    end
+
+  end
+end

data/lib/active_admin/resource_controller/streaming.rb

@@ -0,0 +1,43 @@
+require 'csv'
+
+module ActiveAdmin
+  class ResourceController < BaseController
+
+    # This module overrides CSV responses to allow large data downloads.
+    # Could be expanded to JSON and XML in the future.
+    #
+    module Streaming
+
+      def index
+        super do |format|
+          format.csv { stream_csv }
+          yield(format) if block_given?
+        end
+      end
+
+      protected
+
+      def stream_resource(&block)
+        headers['X-Accel-Buffering'] = 'no'
+        headers['Cache-Control'] = 'no-cache'
+
+        if ActiveAdmin.application.disable_streaming_in.include? Rails.env
+          self.response_body = block['']
+        else
+          self.response_body = Enumerator.new &block
+        end
+      end
+
+      def csv_filename
+        "#{resource_collection_name.to_s.gsub('_', '-')}-#{Time.zone.now.to_date.to_s(:default)}.csv"
+      end
+
+      def stream_csv
+        headers['Content-Type'] = 'text/csv; charset=utf-8' # In Rails 5 it's set to HTML??
+        headers['Content-Disposition'] = %{attachment; filename="#{csv_filename}"}
+        stream_resource &active_admin_config.csv_builder.method(:build).to_proc.curry[self]
+      end
+
+    end
+  end
+end

data/lib/active_admin/resource_dsl.rb

@@ -0,0 +1,224 @@
+module ActiveAdmin
+  # This is the class where all the register blocks are evaluated.
+  class ResourceDSL < DSL
+
+    private
+
+    # Redefine sort behaviour for column
+    #
+    # For example:
+    #
+    #   # nulls last
+    #   order_by(:age) do |order_clause|
+    #     [order_clause.to_sql, 'NULLS LAST'].join(' ')  if order_clause.order == 'desc'
+    #   end
+    #
+    #   # by last_name but in the case that there is no last name, by first_name.
+    #   order_by(:full_name) do |order_clause|
+    #     ['COALESCE(NULLIF(last_name, ''), first_name), first_name', order_clause.order].join(' ')
+    #   end
+    #
+    #
+    def order_by(column, &block)
+      config.ordering[column] = block
+    end
+
+    def belongs_to(target, options = {})
+      config.belongs_to(target, options)
+    end
+
+    # Scope collection to a relation
+    def scope_to(*args, &block)
+      config.scope_to(*args, &block)
+    end
+
+    # Create a scope
+    def scope(*args, &block)
+      config.scope(*args, &block)
+    end
+
+    # Store relations that should be included
+    def includes(*args)
+      config.includes.push *args
+    end
+
+    #
+    # Keys included in the `permitted_params` setting are automatically whitelisted.
+    #
+    # Either
+    #
+    #   permit_params :title, :author, :body, tags: []
+    #
+    # Or
+    #
+    #   permit_params do
+    #     defaults = [:title, :body]
+    #     if current_user.admin?
+    #       defaults + [:author]
+    #     else
+    #       defaults
+    #     end
+    #   end
+    #
+    def permit_params(*args, &block)
+      param_key = config.param_key.to_sym
+      belongs_to_param = config.belongs_to_param
+      create_another_param = :create_another if config.create_another
+
+      controller do
+        define_method :permitted_params do
+          permitted_params =
+            active_admin_namespace.permitted_params +
+              Array.wrap(belongs_to_param) +
+              Array.wrap(create_another_param)
+
+          params.permit(*permitted_params, param_key => block ? instance_exec(&block) : args)
+        end
+
+        private :permitted_params
+      end
+    end
+
+    # Configure the index page for the resource
+    def index(options = {}, &block)
+      options[:as] ||= :table
+      config.set_page_presenter :index, ActiveAdmin::PagePresenter.new(options, &block)
+    end
+
+    # Configure the show page for the resource
+    def show(options = {}, &block)
+      config.set_page_presenter :show, ActiveAdmin::PagePresenter.new(options, &block)
+    end
+
+    def form(options = {}, &block)
+      config.set_page_presenter :form, ActiveAdmin::PagePresenter.new(options, &block)
+    end
+
+    # Configure the CSV format
+    #
+    # For example:
+    #
+    #   csv do
+    #     column :name
+    #     column("Author") { |post| post.author.full_name }
+    #   end
+    #
+    #   csv col_sep: ";", force_quotes: true do
+    #     column :name
+    #   end
+    #
+    def csv(options = {}, &block)
+      options[:resource] = config
+
+      config.csv_builder = CSVBuilder.new(options, &block)
+    end
+
+    # Member Actions give you the functionality of defining both the
+    # action and the route directly from your ActiveAdmin registration
+    # block.
+    #
+    # For example:
+    #
+    #   ActiveAdmin.register Post do
+    #     member_action :comments do
+    #       @post = Post.find(params[:id])
+    #       @comments = @post.comments
+    #     end
+    #   end
+    #
+    # Will create a new controller action comments and will hook it up to
+    # the named route (comments_admin_post_path) /admin/posts/:id/comments
+    #
+    # You can treat everything within the block as a standard Rails controller
+    # action.
+    #
+    def action(set, name, options = {}, &block)
+      warn "Warning: method `#{name}` already defined in #{controller.name}" if controller.method_defined?(name)
+
+      set << ControllerAction.new(name, options)
+      title = options.delete(:title)
+
+      controller do
+        before_action(only: [name]) { @page_title = title } if title
+        define_method(name, &block || Proc.new {})
+      end
+    end
+
+    def member_action(name, options = {}, &block)
+      action config.member_actions, name, options, &block
+    end
+
+    def collection_action(name, options = {}, &block)
+      action config.collection_actions, name, options, &block
+    end
+
+    def decorate_with(decorator_class)
+      # Force storage as a string. This will help us with reloading issues.
+      # Assuming decorator_class.to_s will return the name of the class allows
+      # us to handle a string or a class.
+      config.decorator_class_name = "::#{ decorator_class }"
+    end
+
+    # Defined Callbacks
+    #
+    # == After Build
+    # Called after the resource is built in the new and create actions.
+    #
+    # ActiveAdmin.register Post do
+    #   after_build do |post|
+    #     post.author = current_user
+    #   end
+    # end
+    #
+    # == Before / After Create
+    # Called before and after a resource is saved to the db on the create action.
+    #
+    # == Before / After Update
+    # Called before and after a resource is saved to the db on the update action.
+    #
+    # == Before / After Save
+    # Called before and after the object is saved in the create and update action.
+    # Note: Gets called after the create and update callbacks
+    #
+    # == Before / After Destroy
+    # Called before and after the object is destroyed from the database.
+    #
+    delegate :before_build,   :after_build,   to: :controller
+    delegate :before_create,  :after_create,  to: :controller
+    delegate :before_update,  :after_update,  to: :controller
+    delegate :before_save,    :after_save,    to: :controller
+    delegate :before_destroy, :after_destroy, to: :controller
+
+    # This code defines both *_filter and *_action for Rails 5.0 and  *_action for Rails >= 5.1
+    phases = [
+      :before, :skip_before,
+      :after,  :skip_after,
+      :around, :skip
+    ]
+    keywords = if Rails::VERSION::MAJOR == 5 && Rails::VERSION::MINOR >= 1
+                 [:action]
+               else
+                 [:action, :filter]
+               end
+
+    keywords.each do |name|
+      phases.each do |action|
+       define_method "#{action}_#{name}" do |*args, &block|
+         controller.public_send "#{action}_action", *args, &block
+       end
+     end
+    end
+
+    # Specify which actions to create in the controller
+    #
+    # Eg:
+    #
+    #   ActiveAdmin.register Post do
+    #     actions :index, :show
+    #   end
+    #
+    # Will only create the index and show actions (no create, update or delete)
+    delegate :actions, to: :controller
+
+  end
+end