activeadmin 1.3.1 → 1.4.0

data/lib/active_admin/abstract_view_factory.rb

@@ -1,15 +1,19 @@
 module ActiveAdmin
-  class AbstractViewFactory
-    @@default_views = {}
+  class AbstractViewFactory < SettingsNode
 
     def self.register(view_hash)
       view_hash.each do |view_key, view_class|
-        @@default_views[view_key] = view_class
+        super view_key, view_class
+        add_writer(view_key)
+        send "#{view_key}=", view_class
       end
     end
 
-    def initialize
-      @views = {}
+    def self.add_writer(name)
+      define_singleton_method("#{name}=") do |value|
+        value.builder_method name
+        instance_variable_set :"@#{name}", value
+      end
     end
 
     # Register a new view key with the view factory
@@ -25,61 +29,19 @@ module ActiveAdmin
     #                     another_view: OtherViewClass
     #
     def register(view_hash)
-      view_hash.each do |view_key, view_class|
-        @views[view_key] = view_class
-      end
+      self.class.register view_hash
     end
 
     def default_for(key)
-      @@default_views[key.to_sym]
-    end
-
-    def has_key?(key)
-      @views.has_key?(key.to_sym) || @@default_views.has_key?(key.to_sym)
+      self.class.send key
     end
 
     def [](key)
-      get_view_for_key(key)
+      send key
     end
 
     def []=(key, value)
-      set_view_for_key(key, value)
-    end
-
-    def respond_to_missing?(method, include_private)
-      key = key_from_method_name(method)
-      if has_key?(key)
-        true
-      else
-        super
-      end
-    end
-
-    private
-
-    def method_missing(method, *args)
-      key = key_from_method_name(method)
-      if has_key?(key)
-        if method.to_s.include?('=')
-          set_view_for_key key, args.first
-        else
-          get_view_for_key key
-        end
-      else
-        super
-      end
-    end
-
-    def key_from_method_name(method)
-      method.to_s.tr('=', '').to_sym
-    end
-
-    def get_view_for_key(key)
-      @views[key.to_sym] || @@default_views[key.to_sym]
-    end
-
-    def set_view_for_key(key, view)
-      @views[key.to_sym] = view
+      send "#{key}=", value
     end
   end
 end

data/lib/active_admin/application.rb

@@ -1,151 +1,47 @@
 require 'active_admin/router'
 require 'active_admin/reloader'
-require 'active_admin/helpers/settings'
+require 'active_admin/application_settings'
+require 'active_admin/namespace_settings'
 
 module ActiveAdmin
   class Application
-    include Settings
-    include Settings::Inheritance
 
-    settings_inherited_by Namespace
-
-    # The default namespace to put controllers and routes inside. Set this
-    # in config/initializers/active_admin.rb using:
-    #
-    #   config.default_namespace = :super_admin
-    #
-    setting :default_namespace, :admin
+    class << self
+      def setting(name, default)
+        ApplicationSettings.register name, default
+      end
 
-    attr_reader :namespaces
-    def initialize
-      @namespaces = Namespace::Store.new
+      def inheritable_setting(name, default)
+        NamespaceSettings.register name, default
+      end
     end
 
-    # Load paths for admin configurations. Add folders to this load path
-    # to load up other resources for administration. External gems can
-    # include their paths in this load path to provide active_admin UIs
-    setting :load_paths, [File.expand_path('app/admin', Rails.root)]
-
-    # The default number of resources to display on index pages
-    inheritable_setting :default_per_page, 30
-
-    # The max number of resources to display on index pages and batch exports
-    inheritable_setting :max_per_page, 10_000
-
-    # The title which gets displayed in the main layout
-    inheritable_setting :site_title, ""
-
-    # Set the site title link href (defaults to AA dashboard)
-    inheritable_setting :site_title_link, ""
-
-    # Set the site title image displayed in the main layout (has precendence over :site_title)
-    inheritable_setting :site_title_image, ""
-
-    # Set the site footer text (defaults to Powered by ActiveAdmin text with version)
-    inheritable_setting :footer, ""
-
-    # Set a favicon
-    inheritable_setting :favicon, false
-
-    # Additional meta tags to place in head of logged in pages.
-    inheritable_setting :meta_tags, {}
-
-    # Additional meta tags to place in head of logged out pages.
-    inheritable_setting :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
-    inheritable_setting :view_factory, ActiveAdmin::ViewFactory.new
-
-    # The method to call in controllers to get the current user
-    inheritable_setting :current_user_method, false
-
-    # The method to call in the controllers to ensure that there
-    # is a currently authenticated admin user
-    inheritable_setting :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
-    inheritable_setting :logout_link_path, :destroy_admin_user_session_path
-
-    # The method to use when generating the link for user logout
-    inheritable_setting :logout_link_method, :get
-
-    # Whether the batch actions are enabled or not
-    inheritable_setting :batch_actions, false
-
-    # Whether filters are enabled
-    inheritable_setting :filters, true
-
-    # The namespace root.
-    inheritable_setting :root_to, 'dashboard#index'
-
-    # Options that a passed to root_to.
-    inheritable_setting :root_to_options, {}
-
-    # Options passed to the routes, i.e. { path: '/custom' }
-    inheritable_setting :route_options, {}
-
-    # Display breadcrumbs
-    inheritable_setting :breadcrumb, true
-
-    # Display create another checkbox on a new page
-    # @return [Boolean] (true)
-    inheritable_setting :create_another, false
-
-    # Default CSV options
-    inheritable_setting :csv_options, { col_sep: ',', byte_order_mark: "\xEF\xBB\xBF" }
-
-    # Default Download Links options
-    inheritable_setting :download_links, true
-
-    # The authorization adapter to use
-    inheritable_setting :authorization_adapter, ActiveAdmin::AuthorizationAdapter
-
-    # A proc to be used when a user is not authorized to view the current resource
-    inheritable_setting :on_unauthorized_access, :rescue_active_admin_access_denied
-
-    # A regex to detect unsupported browser, set to false to disable
-    inheritable_setting :unsupported_browser_matcher, /MSIE [1-8]\.0/
-
-    # Whether to display 'Current Filters' on search screen
-    inheritable_setting :current_filters, true
-
-    # class to handle ordering
-    inheritable_setting :order_clause, ActiveAdmin::OrderClause
-
-    # default show_count for scopes
-    inheritable_setting :scopes_show_count, true
-
-    # Request parameters that are permitted by default
-    inheritable_setting :permitted_params, [
-      :utf8, :_method, :authenticity_token, :commit, :id
-    ]
-
-    # Set flash message keys that shouldn't show in ActiveAdmin
-    inheritable_setting :flash_keys_to_except, ['timedout']
+    def settings
+      @settings ||= SettingsNode.build(ApplicationSettings)
+    end
 
-    # Set default localize format for Date/Time values
-    setting :localize_format, :long
+    def namespace_settings
+      @namespace_settings ||= SettingsNode.build(NamespaceSettings)
+    end
 
-    # Include association filters by default
-    inheritable_setting :include_default_association_filters, true
+    def respond_to_missing?(method, include_private = false)
+      [settings, namespace_settings].any? { |sets| sets.respond_to?(method) } || super
+    end
 
-    # Active Admin makes educated guesses when displaying objects, this is
-    # the list of methods it tries calling in order
-    # Note that Formtastic also has 'collection_label_methods' similar to this
-    # used by auto generated dropdowns in filter or belongs_to field of Active Admin
-    setting :display_name_methods, [ :display_name,
-                                      :full_name,
-                                      :name,
-                                      :username,
-                                      :login,
-                                      :title,
-                                      :email,
-                                      :to_s ]
+    def method_missing(method, *args)
+      if settings.respond_to?(method)
+        settings.send(method, *args)
+      elsif namespace_settings.respond_to?(method)
+        namespace_settings.send(method, *args)
+      else
+        super
+      end
+    end
 
-    # To make debugging easier, by default don't stream in development
-    setting :disable_streaming_in, ['development']
+    attr_reader :namespaces
+    def initialize
+      @namespaces = Namespace::Store.new
+    end
 
     # == Deprecated Settings
 
@@ -239,14 +135,18 @@ module ActiveAdmin
       load_paths.flatten.compact.uniq.flat_map{ |path| Dir["#{path}/**/*.rb"] }
     end
 
-    def router
-      @router ||= Router.new(self)
-    end
-
-    # One-liner called by user's config/routes.rb file
+    # Creates all the necessary routes for the ActiveAdmin configurations
+    #
+    # Use this within the routes.rb file:
+    #
+    #   Application.routes.draw do |map|
+    #     ActiveAdmin.routes(self)
+    #   end
+    #
+    # @param rails_router [ActionDispatch::Routing::Mapper]
     def routes(rails_router)
       load!
-      router.apply(rails_router)
+      Router.new(router: rails_router, namespaces: namespaces).apply
     end
 
     # Adds before, around and after filters to all controllers.
@@ -268,7 +168,7 @@ module ActiveAdmin
       controllers
     end
 
-  private
+    private
 
     def register_default_assets
       stylesheets['active_admin.css'] = { media: 'screen' }

data/lib/active_admin/application_settings.rb

@@ -0,0 +1,39 @@
+require 'active_admin/settings_node'
+
+module ActiveAdmin
+  class ApplicationSettings < SettingsNode
+
+    # The default namespace to put controllers and routes inside. Set this
+    # in config/initializers/active_admin.rb using:
+    #
+    #   config.default_namespace = :super_admin
+    #
+    register :default_namespace, :admin
+
+    register :app_path, Rails.root
+
+    # Load paths for admin configurations. Add folders to this load path
+    # to load up other resources for administration. External gems can
+    # include their paths in this load path to provide active_admin UIs
+    register :load_paths, [File.expand_path('app/admin', Rails.root)]
+
+    # Set default localize format for Date/Time values
+    register :localize_format, :long
+
+    # Active Admin makes educated guesses when displaying objects, this is
+    # the list of methods it tries calling in order
+    # Note that Formtastic also has 'collection_label_methods' similar to this
+    # used by auto generated dropdowns in filter or belongs_to field of Active Admin
+    register :display_name_methods, [ :display_name,
+                                      :full_name,
+                                      :name,
+                                      :username,
+                                      :login,
+                                      :title,
+                                      :email,
+                                      :to_s ]
+
+    # To make debugging easier, by default don't stream in development
+    register :disable_streaming_in, ['development']
+  end
+end

data/lib/active_admin/base_controller/authorization.rb

@@ -1,7 +1,6 @@
 module ActiveAdmin
   class BaseController < ::InheritedResources::Base
     module Authorization
-      include MethodOrProcHelper
       extend ActiveSupport::Concern
 
       ACTIONS_DICTIONARY = {
@@ -100,7 +99,7 @@ module ActiveAdmin
       end
 
       def dispatch_active_admin_access_denied(exception)
-        call_method_or_exec_proc active_admin_namespace.on_unauthorized_access, exception
+        instance_exec(self, exception, &active_admin_namespace.on_unauthorized_access.to_proc)
       end
 
       def rescue_active_admin_access_denied(exception)

data/lib/active_admin/batch_actions/controller.rb

@@ -7,7 +7,7 @@ module ActiveAdmin
         if action_present?
           selection  =            params[:collection_selection] || []
           inputs     = JSON.parse params[:batch_action_inputs]  || '{}'
-          valid_keys = render_in_context(self, current_batch_action.inputs).try(:keys)
+          valid_keys = StringSymbolOrProcSetting.new(current_batch_action.inputs).value(self).try(:keys)
           inputs     = inputs.with_indifferent_access.slice *valid_keys
           instance_exec selection, inputs, &current_batch_action.block
         else

data/lib/active_admin/dependency.rb

@@ -134,6 +134,14 @@ module ActiveAdmin
       end
 
       class Rails < Base
+        def optional_belongs_to_flag
+          if Dependency.rails5?
+            { optional: true }
+          else
+            { required: false }
+          end
+        end
+
         def parameterize(string)
           if Dependency.rails5?
             string.parameterize separator: '_'

data/lib/active_admin/deprecation.rb

@@ -6,30 +6,5 @@ module ActiveAdmin
       ActiveSupport::Deprecation.warn "Active Admin: #{message}", callstack
     end
 
-    # Deprecate a method.
-    #
-    # @param [Module] klass the Class or Module to deprecate the method on
-    # @param [Symbol] method the method to deprecate
-    # @param [String] message the message to display to the end user
-    #
-    # Example:
-    #
-    #     class MyClass
-    #       def my_method
-    #         # ...
-    #       end
-    #       ActiveAdmin::Deprecation.deprecate self, :my_method,
-    #         "MyClass#my_method is being removed in the next release"
-    #     end
-    #
-    def deprecate(klass, method, message)
-      klass.send :define_method, "deprecated_#{method}", klass.instance_method(method)
-
-      klass.send :define_method, method do |*args|
-        ActiveAdmin::Deprecation.warn "#{message}", caller
-        send "deprecated_#{method}", *args
-      end
-    end
-
   end
 end

data/lib/active_admin/dynamic_setting.rb

@@ -0,0 +1,38 @@
+module ActiveAdmin
+
+  class DynamicSetting
+    def self.build(setting, type)
+      (type ? klass(type) : self).new(setting)
+    end
+
+    def self.klass(type)
+      klass = "#{type.to_s.camelcase}Setting"
+      raise ArgumentError, "Unknown type: #{type}" unless ActiveAdmin.const_defined?(klass)
+      ActiveAdmin.const_get(klass)
+    end
+
+    def initialize(setting)
+      @setting = setting
+    end
+
+    def value(*_args)
+      @setting
+    end
+  end
+
+  # Many configuration options (Ex: site_title, title_image) could either be
+  # static (String), methods (Symbol) or procs (Proc). This wrapper takes care of
+  # returning the content when String or using instance_eval when Symbol or Proc.
+  #
+  class StringSymbolOrProcSetting < DynamicSetting
+    def value(context = self)
+      case @setting
+      when Symbol, Proc
+        context.instance_eval(&@setting)
+      else
+        @setting
+      end
+    end
+  end
+
+end