rails_admin 0.8.1 → 2.2.1

data/lib/rails_admin/config/fields/types/text.rb

@@ -1,31 +1,13 @@
-require 'rails_admin/config/fields/base'
+require 'rails_admin/config/fields/types/string_like'
 
 module RailsAdmin
   module Config
     module Fields
       module Types
-        class Text < RailsAdmin::Config::Fields::Base
+        class Text < StringLike
           # Register field type for the type loader
           RailsAdmin::Config::Fields::Types.register(self)
 
-          [:ckeditor, :ckeditor_base_location, :ckeditor_config_js, :ckeditor_location].each do |key|
-            register_deprecated_instance_option key do
-              fail("The 'field(:foo){ ckeditor true }' style DSL is deprecated. Please use 'field :foo, :ck_editor' instead.")
-            end
-          end
-
-          [:codemirror, :codemirror_assets, :codemirror_config, :codemirror_css_location, :codemirror_js_location].each do |key|
-            register_deprecated_instance_option key do
-              fail("The 'field(:foo){ codemirror true }' style DSL is deprecated. Please use 'field :foo, :code_mirror' instead.")
-            end
-          end
-
-          [:bootstrap_wysihtml5, :bootstrap_wysihtml5_config_options, :bootstrap_wysihtml5_css_location, :bootstrap_wysihtml5_js_location].each do |key|
-            register_deprecated_instance_option key do
-              fail("The 'field(:foo){ bootstrap_wysihtml5 true }' style DSL is deprecated. Please use 'field :foo, :wysihtml5' instead.")
-            end
-          end
-
           register_instance_option :html_attributes do
             {
               required: required?,

data/lib/rails_admin/config/fields/types/wysihtml5.rb

@@ -1,35 +1,39 @@
-require 'rails_admin/config/fields/base'
+require 'rails_admin/config/fields/types/text'
 
 module RailsAdmin
   module Config
     module Fields
       module Types
-        class Wysihtml5 < RailsAdmin::Config::Fields::Types::Text
+        class Wysihtml5 < Text
           # Register field type for the type loader
           RailsAdmin::Config::Fields::Types.register(self)
 
           # If you want to have a different toolbar configuration for wysihtml5
           # you can use a Ruby hash to configure these options:
-          # https://github.com/jhollingworth/bootstrap-wysihtml5/#advanced
+          # https://github.com/bootstrap-wysiwyg/bootstrap3-wysiwyg
           register_instance_option :config_options do
-            nil
+            {
+              toolbar: {
+                fa: true,
+              },
+            }
+          end
+
+          register_instance_option :version do
+            '0.3.3'
           end
 
           register_instance_option :css_location do
-            ActionController::Base.helpers.asset_path('bootstrap-wysihtml5.css')
+            "https://cdnjs.cloudflare.com/ajax/libs/bootstrap3-wysiwyg/#{version}/bootstrap3-wysihtml5.min.css"
           end
 
           register_instance_option :js_location do
-            ActionController::Base.helpers.asset_path('bootstrap-wysihtml5.js')
+            "https://cdnjs.cloudflare.com/ajax/libs/bootstrap3-wysiwyg/#{version}/bootstrap3-wysihtml5.all.min.js"
           end
 
           register_instance_option :partial do
             :form_wysihtml5
           end
-
-          [:config_options, :css_location, :js_location].each do |key|
-            register_deprecated_instance_option :"bootstrap_wysihtml5_#{key}", key
-          end
         end
       end
     end

data/lib/rails_admin/config/fields/types.rb

@@ -9,7 +9,7 @@ module RailsAdmin
         @@registry = {}
 
         def self.load(type)
-          @@registry[type.to_sym] || fail("Unsupported field datatype: #{type}")
+          @@registry[type.to_sym] || raise("Unsupported field datatype: #{type}")
         end
 
         def self.register(type, klass = nil)

data/lib/rails_admin/config/fields.rb

@@ -82,5 +82,7 @@ require 'rails_admin/config/fields/factories/devise'
 require 'rails_admin/config/fields/factories/paperclip'
 require 'rails_admin/config/fields/factories/dragonfly'
 require 'rails_admin/config/fields/factories/carrierwave'
-require 'rails_admin/config/fields/factories/refile'
+require 'rails_admin/config/fields/factories/active_storage'
+require 'rails_admin/config/fields/factories/shrine'
+require 'rails_admin/config/fields/factories/action_text'
 require 'rails_admin/config/fields/factories/association'

data/lib/rails_admin/config/has_fields.rb

@@ -130,7 +130,7 @@ module RailsAdmin
           @_ro_fields = @_fields = RailsAdmin::Config::Fields.factory(self)
         else
           # parent is RailsAdmin::Config::Model, recursion is on Section's classes
-          @_ro_fields ||= parent.send(self.class.superclass.to_s.underscore.split('/').last)._fields(true).freeze
+          @_ro_fields ||= parent.send(self.class.superclass.to_s.underscore.split('/').last)._fields(true).clone.freeze
         end
         readonly ? @_ro_fields : (@_fields ||= @_ro_fields.collect(&:clone))
       end

data/lib/rails_admin/config/has_groups.rb

@@ -16,7 +16,7 @@ module RailsAdmin
 
       # Reader for groups that are marked as visible
       def visible_groups
-        parent.groups.collect { |f| f.section = self; f.with(bindings) }.select(&:visible?).select do |g| # rubocop:disable Semicolon
+        parent.groups.collect { |f| f.section = self; f.with(bindings) }.select(&:visible?).select do |g| # rubocop:disable Style/Semicolon
           g.visible_fields.present?
         end
       end

data/lib/rails_admin/config/hideable.rb

@@ -16,7 +16,7 @@ module RailsAdmin
 
       # Writer to hide object.
       def hide(&block)
-        visible block ? proc { false == (instance_eval(&block)) } : false
+        visible block ? proc { false == instance_eval(&block) } : false
       end
 
       # Writer to show field.

data/lib/rails_admin/config/inspectable.rb

@@ -0,0 +1,39 @@
+module RailsAdmin
+  module Config
+    module Inspectable
+      def inspect
+        set_named_instance_variables
+
+        instance_name = try(:name) || try(:abstract_model).try(:model).try(:name)
+        instance_name = instance_name ? "[#{instance_name}]" : ''
+
+        instance_vars = instance_variables.collect do |v|
+          instance_variable_name(v)
+        end.join(', ')
+
+        "#<#{self.class.name}#{instance_name} #{instance_vars}>"
+      end
+
+    private
+
+      def instance_variable_name(variable)
+        value = instance_variable_get(variable)
+        if self.class::NAMED_INSTANCE_VARIABLES.include?(variable)
+          if value.respond_to?(:name)
+            "#{variable}=#{value.name.inspect}"
+          else
+            "#{variable}=#{value.class.name}"
+          end
+        else
+          "#{variable}=#{value.inspect}"
+        end
+      end
+
+      def set_named_instance_variables
+        unless defined?(self.class::NAMED_INSTANCE_VARIABLES)
+          self.class.const_set('NAMED_INSTANCE_VARIABLES', [])
+        end
+      end
+    end
+  end
+end

data/lib/rails_admin/config/lazy_model.rb

@@ -5,23 +5,63 @@ module RailsAdmin
     class LazyModel < BasicObject
       def initialize(entity, &block)
         @entity = entity
-        @deferred_block = block
+        @deferred_blocks = [*block]
+        @existing_blocks = []
+      end
+
+      def add_deferred_block(&block)
+        @deferred_blocks << block
       end
 
       def target
-        unless @model
-          @model = ::RailsAdmin::Config::Model.new(@entity)
-          @model.instance_eval(&@deferred_block) if @deferred_block
+        @model ||= ::RailsAdmin::Config::Model.new(@entity)
+        # When evaluating multiple configuration blocks, the order of
+        # execution is important. As one would expect (in my opinion),
+        # options defined within a resource should take precedence over
+        # more general options defined in an initializer. This way,
+        # general settings for a number of resources could be specified
+        # in the initializer, while models could override these settings
+        # later, if required.
+        #
+        # CAVEAT: It cannot be guaranteed that blocks defined in an initializer
+        # will be loaded (and adde to @deferred_blocks) first. For instance, if
+        # the initializer references a model class before defining
+        # a RailsAdmin configuration block, the configuration from the
+        # resource will get added to @deferred_blocks first:
+        #
+        #     # app/models/some_model.rb
+        #     class SomeModel
+        #       rails_admin do
+        #         :
+        #       end
+        #     end
+        #
+        #     # config/initializers/rails_admin.rb
+        #     model = 'SomeModel'.constantize # blocks from SomeModel get loaded
+        #     model.config model do           # blocks from initializer gets loaded
+        #       :
+        #     end
+        #
+        # Thus, sort all blocks to excute for a resource by Proc.source_path,
+        # to guarantee that blocks from 'config/initializers' evaluate before
+        # blocks defined within a model class.
+        unless @deferred_blocks.empty?
+          @existing_blocks += @deferred_blocks
+          @existing_blocks.
+            partition { |block| block.source_location.first =~ %r{config\/initializers} }.
+            flatten.
+            each { |block| @model.instance_eval(&block) }
+          @deferred_blocks = []
         end
         @model
       end
 
-      def method_missing(method, *args, &block)
-        target.send(method, *args, &block)
+      def method_missing(method_name, *args, &block)
+        target.send(method_name, *args, &block)
       end
 
-      def respond_to?(method, include_private = false)
-        super || target.respond_to?(method, include_private)
+      def respond_to?(method_name, include_private = false)
+        super || target.respond_to?(method_name, include_private)
       end
     end
   end

data/lib/rails_admin/config/model.rb

@@ -9,6 +9,7 @@ require 'rails_admin/config/has_fields'
 require 'rails_admin/config/has_description'
 require 'rails_admin/config/sections'
 require 'rails_admin/config/actions'
+require 'rails_admin/config/inspectable'
 
 module RailsAdmin
   module Config
@@ -18,11 +19,14 @@ module RailsAdmin
       include RailsAdmin::Config::Configurable
       include RailsAdmin::Config::Hideable
       include RailsAdmin::Config::Sections
+      include RailsAdmin::Config::Inspectable
 
       attr_reader :abstract_model
       attr_accessor :groups
       attr_reader :parent, :root
 
+      NAMED_INSTANCE_VARIABLES = [:@parent, :@root].freeze
+
       def initialize(entity)
         @parent = nil
         @root = self
@@ -40,7 +44,8 @@ module RailsAdmin
       end
 
       def excluded?
-        @excluded ||= !RailsAdmin::AbstractModel.all.collect(&:model_name).include?(abstract_model.try(:model_name))
+        return @excluded if defined?(@excluded)
+        @excluded = !RailsAdmin::AbstractModel.all.collect(&:model_name).include?(abstract_model.try(:model_name))
       end
 
       def object_label
@@ -61,7 +66,7 @@ module RailsAdmin
       end
 
       register_instance_option :label_plural do
-        (@label_plural ||= {})[::I18n.locale] ||= abstract_model.model.model_name.human(count: Float::INFINITY, default: label.pluralize)
+        (@label_plural ||= {})[::I18n.locale] ||= abstract_model.model.model_name.human(count: Float::INFINITY, default: label.pluralize(::I18n.locale))
       end
 
       def pluralize(count)
@@ -83,7 +88,7 @@ module RailsAdmin
 
       register_instance_option :navigation_label do
         @navigation_label ||= begin
-          if (parent_module = abstract_model.model.parent) != Object
+          if (parent_module = abstract_model.model.try(:module_parent) || abstract_model.model.try!(:parent)) != Object
             parent_module.to_s
           end
         end
@@ -95,25 +100,8 @@ module RailsAdmin
 
       # Act as a proxy for the base section configuration that actually
       # store the configurations.
-      def method_missing(m, *args, &block)
-        send(:base).send(m, *args, &block)
-      end
-
-      def inspect
-        "#<#{self.class.name}[#{abstract_model.model.name}] #{
-          instance_variables.collect do |v|
-            value = instance_variable_get(v)
-            if [:@parent, :@root].include? v
-              if value.respond_to? :name
-                "#{v}=#{value.name.inspect}"
-              else
-                "#{v}=#{value.class.name}"
-              end
-            else
-              "#{v}=#{value.inspect}"
-            end
-          end.join(', ')
-        }>"
+      def method_missing(method_name, *args, &block)
+        send(:base).send(method_name, *args, &block)
       end
     end
   end

data/lib/rails_admin/config/proxyable/proxy.rb

@@ -2,8 +2,6 @@ module RailsAdmin
   module Config
     module Proxyable
       class Proxy < BasicObject
-        attr_reader :bindings
-
         def initialize(object, bindings = {})
           @object = object
           @bindings = bindings
@@ -19,18 +17,18 @@ module RailsAdmin
           self
         end
 
-        def method_missing(name, *args, &block)
-          if @object.respond_to?(name)
-            reset = @object.instance_variable_get('@bindings')
+        def method_missing(method_name, *args, &block)
+          if @object.respond_to?(method_name)
+            reset = @object.bindings
             begin
-              @object.instance_variable_set('@bindings', @bindings)
-              response = @object.__send__(name, *args, &block)
+              @object.bindings = @bindings
+              response = @object.__send__(method_name, *args, &block)
             ensure
-              @object.instance_variable_set('@bindings', reset)
+              @object.bindings = reset
             end
             response
           else
-            super(name, *args, &block)
+            super(method_name, *args, &block)
           end
         end
       end

data/lib/rails_admin/config/proxyable.rb

@@ -2,7 +2,19 @@ require 'rails_admin/config/proxyable/proxy'
 module RailsAdmin
   module Config
     module Proxyable
-      attr_accessor :bindings
+      def bindings
+        Thread.current[:rails_admin_bindings] ||= {}
+        Thread.current[:rails_admin_bindings][self]
+      end
+
+      def bindings=(new_bindings)
+        Thread.current[:rails_admin_bindings] ||= {}
+        if new_bindings.nil?
+          Thread.current[:rails_admin_bindings].delete(self)
+        else
+          Thread.current[:rails_admin_bindings][self] = new_bindings
+        end
+      end
 
       def with(bindings = {})
         RailsAdmin::Config::Proxyable::Proxy.new(self, bindings)

data/lib/rails_admin/config/sections/base.rb

@@ -1,5 +1,6 @@
 require 'rails_admin/config/proxyable'
 require 'rails_admin/config/configurable'
+require 'rails_admin/config/inspectable'
 require 'rails_admin/config/has_fields'
 require 'rails_admin/config/has_groups'
 require 'rails_admin/config/has_description'
@@ -11,6 +12,7 @@ module RailsAdmin
       class Base
         include RailsAdmin::Config::Proxyable
         include RailsAdmin::Config::Configurable
+        include RailsAdmin::Config::Inspectable
 
         include RailsAdmin::Config::HasFields
         include RailsAdmin::Config::HasGroups
@@ -19,29 +21,14 @@ module RailsAdmin
         attr_reader :abstract_model
         attr_reader :parent, :root
 
+        NAMED_INSTANCE_VARIABLES = [:@parent, :@root, :@abstract_model].freeze
+
         def initialize(parent)
           @parent = parent
           @root = parent.root
 
           @abstract_model = root.abstract_model
         end
-
-        def inspect
-          "#<#{self.class.name} #{
-            instance_variables.collect do |v|
-              value = instance_variable_get(v)
-              if [:@parent, :@root, :@abstract_model].include? v
-                if value.respond_to? :name
-                  "#{v}=#{value.name.inspect}"
-                else
-                  "#{v}=#{value.class.name}"
-                end
-              else
-                "#{v}=#{value.inspect}"
-              end
-            end.join(', ')
-          }>"
-        end
       end
     end
   end

data/lib/rails_admin/config/sections/list.rb

@@ -5,6 +5,10 @@ module RailsAdmin
     module Sections
       # Configuration of the list view
       class List < RailsAdmin::Config::Sections::Base
+        register_instance_option :checkboxes? do
+          true
+        end
+
         register_instance_option :filters do
           []
         end
@@ -14,6 +18,16 @@ module RailsAdmin
           RailsAdmin::Config.default_items_per_page
         end
 
+        # Positive value shows only prev, next links in pagination.
+        # This is for avoiding count(*) query.
+        register_instance_option :limited_pagination do
+          false
+        end
+
+        register_instance_option :search_by do
+          nil
+        end
+
         register_instance_option :sort_by do
           parent.abstract_model.primary_key
         end
@@ -25,6 +39,29 @@ module RailsAdmin
         register_instance_option :scopes do
           []
         end
+
+        register_instance_option :row_css_class do
+          ''
+        end
+
+        register_instance_option :sidescroll do
+          nil
+        end
+
+        def sidescroll_frozen_columns
+          global_config = RailsAdmin::Config.sidescroll
+          model_config = sidescroll
+          enabled = model_config.nil? ? global_config : model_config
+          if enabled
+            num_frozen = model_config[:num_frozen_columns] if model_config.is_a?(Hash)
+            unless num_frozen
+              num_frozen = global_config[:num_frozen_columns] if global_config.is_a?(Hash)
+              num_frozen ||= 3 # by default, freeze checkboxes, links & first property (usually primary key / id?)
+              num_frozen -= 1 unless checkboxes? # model config should be explicit about this, only adjust if using global config
+            end
+            num_frozen
+          end
+        end
       end
     end
   end

data/lib/rails_admin/config.rb

@@ -41,6 +41,9 @@ module RailsAdmin
       # been configured
       attr_accessor :default_items_per_page
 
+      # Default association limit
+      attr_accessor :default_associated_collection_limit
+
       attr_reader :default_search_operator
 
       # Configuration option to specify which method names will be searched for
@@ -56,22 +59,29 @@ module RailsAdmin
       # Set the max width of columns in list view before a new set is created
       attr_accessor :total_columns_width
 
+      # Enable horizontal-scrolling table in list view, ignore total_columns_width
+      attr_accessor :sidescroll
+
       # set parent controller
       attr_accessor :parent_controller
 
+      # set settings for `protect_from_forgery` method
+      # By default, it raises exception upon invalid CSRF tokens
+      attr_accessor :forgery_protection_settings
+
       # Stores model configuration objects in a hash identified by model's class
       # name.
       #
       # @see RailsAdmin.config
       attr_reader :registry
 
+      # show Gravatar in Navigation bar
+      attr_accessor :show_gravatar
+
       # accepts a hash of static links to be shown below the main navigation
       attr_accessor :navigation_static_links
       attr_accessor :navigation_static_label
 
-      # yell about fields that are not marked as accessible
-      attr_accessor :yell_for_non_accessible_fields
-
       # Setup authentication to be run as a before filter
       # This is run inside the controller instance so you can setup any authentication you need to
       #
@@ -104,11 +114,13 @@ module RailsAdmin
       def audit_with(*args, &block)
         extension = args.shift
         if extension
+          klass = RailsAdmin::AUDITING_ADAPTERS[extension]
+          klass.setup if klass.respond_to? :setup
           @audit = proc do
-            @auditing_adapter = RailsAdmin::AUDITING_ADAPTERS[extension].new(*([self] + args).compact)
+            @auditing_adapter = klass.new(*([self] + args).compact)
           end
-        else
-          @audit = block if block
+        elsif block
+          @audit = block
         end
         @audit || DEFAULT_AUDIT
       end
@@ -126,11 +138,11 @@ module RailsAdmin
       #   end
       #
       # To use an authorization adapter, pass the name of the adapter. For example,
-      # to use with CanCan[https://github.com/ryanb/cancan], pass it like this.
+      # to use with CanCanCan[https://github.com/CanCanCommunity/cancancan/], pass it like this.
       #
-      # @example CanCan
+      # @example CanCanCan
       #   RailsAdmin.config do |config|
-      #     config.authorize_with :cancan
+      #     config.authorize_with :cancancan
       #   end
       #
       # See the wiki[https://github.com/sferik/rails_admin/wiki] for more on authorization.
@@ -139,11 +151,13 @@ module RailsAdmin
       def authorize_with(*args, &block)
         extension = args.shift
         if extension
+          klass = RailsAdmin::AUTHORIZATION_ADAPTERS[extension]
+          klass.setup if klass.respond_to? :setup
           @authorize = proc do
-            @authorization_adapter = RailsAdmin::AUTHORIZATION_ADAPTERS[extension].new(*([self] + args).compact)
+            @authorization_adapter = klass.new(*([self] + args).compact)
           end
-        else
-          @authorize = block if block
+        elsif block
+          @authorize = block
         end
         @authorize || DEFAULT_AUTHORIZE
       end
@@ -187,15 +201,13 @@ module RailsAdmin
         if %w(default like starts_with ends_with is =).include? operator
           @default_search_operator = operator
         else
-          fail(ArgumentError.new("Search operator '#{operator}' not supported"))
+          raise(ArgumentError.new("Search operator '#{operator}' not supported"))
         end
       end
 
       # pool of all found model names from the whole application
       def models_pool
-        excluded = (excluded_models.collect(&:to_s) + ['RailsAdmin::History'])
-
-        (viable_models - excluded).uniq.sort
+        (viable_models - excluded_models.collect(&:to_s)).uniq.sort
       end
 
       # Loads a model configuration instance from the registry or registers
@@ -223,11 +235,9 @@ module RailsAdmin
           end
         end
 
-        if block
-          @registry[key] = RailsAdmin::Config::LazyModel.new(entity, &block)
-        else
-          @registry[key] ||= RailsAdmin::Config::LazyModel.new(entity)
-        end
+        @registry[key] ||= RailsAdmin::Config::LazyModel.new(entity)
+        @registry[key].add_deferred_block(&block) if block
+        @registry[key]
       end
 
       def default_hidden_fields=(fields)
@@ -258,7 +268,6 @@ module RailsAdmin
       def reset
         @compact_show_view = true
         @browser_validations = true
-        @yell_for_non_accessible_fields = true
         @authenticate = nil
         @authorize = nil
         @audit = nil
@@ -268,16 +277,20 @@ module RailsAdmin
         @default_hidden_fields[:edit] = [:id, :_id, :created_at, :created_on, :deleted_at, :updated_at, :updated_on, :deleted_on]
         @default_hidden_fields[:show] = [:id, :_id, :created_at, :created_on, :deleted_at, :updated_at, :updated_on, :deleted_on]
         @default_items_per_page = 20
+        @default_associated_collection_limit = 100
         @default_search_operator = 'default'
         @excluded_models = []
         @included_models = []
         @total_columns_width = 697
+        @sidescroll = nil
         @label_methods = [:name, :title]
         @main_app_name = proc { [Rails.application.engine_name.titleize.chomp(' Application'), 'Admin'] }
         @registry = {}
+        @show_gravatar = true
         @navigation_static_links = {}
         @navigation_static_label = nil
-        @parent_controller = '::ApplicationController'
+        @parent_controller = '::ActionController::Base'
+        @forgery_protection_settings = {with: :exception}
         RailsAdmin::Config::Actions.reset
       end
 
@@ -289,6 +302,14 @@ module RailsAdmin
         @registry.delete(key)
       end
 
+      # Reset all models configuration
+      # Used to clear all configurations when reloading code in development.
+      # @see RailsAdmin::Engine
+      # @see RailsAdmin::Config.registry
+      def reset_all_models
+        @registry = {}
+      end
+
       # Get all models that are configured as visible sorted by their weight and label.
       #
       # @see RailsAdmin::Config::Hideable
@@ -313,7 +334,7 @@ module RailsAdmin
         included_models.collect(&:to_s).presence || begin
           @@system_models ||= # memoization for tests
             ([Rails.application] + Rails::Engine.subclasses.collect(&:instance)).flat_map do |app|
-              (app.paths['app/models'].to_a + app.config.autoload_paths).collect do |load_path|
+              (app.paths['app/models'].to_a + app.paths.eager_load).collect do |load_path|
                 Dir.glob(app.root.join(load_path)).collect do |load_dir|
                   Dir.glob(load_dir + '/**/*.rb').collect do |filename|
                     # app/models/module/class.rb => module/class.rb => module/class => Module::Class
@@ -321,7 +342,7 @@ module RailsAdmin
                   end
                 end
               end
-            end.flatten.reject { |m| m.starts_with?('Concerns::') } # rubocop:disable MultilineBlockChain
+            end.flatten.reject { |m| m.starts_with?('Concerns::') } # rubocop:disable Style/MultilineBlockChain
         end
       end