rails_admin 2.3.0 → 3.0.0.beta

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

@@ -8,10 +8,7 @@ module RailsAdmin
           RailsAdmin::Config::Fields::Types.register(self)
 
           def parse_value(value)
-            parent_value = super(value)
-            return unless parent_value
-            value_with_tz = parent_value.in_time_zone
-            ::DateTime.parse(value_with_tz.strftime('%Y-%m-%d %H:%M:%S'))
+            abstract_model.model.type_for_attribute(name.to_s).serialize(super)&.change(year: 2000, month: 1, day: 1)
           end
 
           register_instance_option :strftime_format do

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

@@ -7,10 +7,6 @@ module RailsAdmin
         class Timestamp < RailsAdmin::Config::Fields::Types::Datetime
           # Register field type for the type loader
           RailsAdmin::Config::Fields::Types.register(self)
-
-          @format = :long
-          @i18n_scope = [:time, :formats]
-          @js_plugin_options = {}
         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] || raise("Unsupported field datatype: #{type}")
+          @@registry.fetch(type.to_sym) { raise "Unsupported field datatype: #{type}" }
         end
 
         def self.register(type, klass = nil)

data/lib/rails_admin/config/fields.rb

@@ -50,13 +50,15 @@ module RailsAdmin
         parent.abstract_model.properties.each do |properties|
           # Unless a previous factory has already loaded current field as well
           next if fields.detect { |f| f.name == properties.name }
+
           # Loop through factories until one returns true
           @@registry.detect { |factory| factory.call(parent, properties, fields) }
         end
         # Load fields for all associations (relations)
-        parent.abstract_model.associations.select { |a| a.type != :belongs_to }.each do |association| # :belongs_to are created by factory for belongs_to fields
+        parent.abstract_model.associations.reject { |a| a.type == :belongs_to }.each do |association| # :belongs_to are created by factory for belongs_to fields
           # Unless a previous factory has already loaded current field as well
           next if fields.detect { |f| f.name == association.name }
+
           # Loop through factories until one returns true
           @@registry.detect { |factory| factory.call(parent, association, fields) }
         end

data/lib/rails_admin/config/has_fields.rb

@@ -8,9 +8,7 @@ module RailsAdmin
 
         # some fields are hidden by default (belongs_to keys, has_many associations in list views.)
         # unhide them if config specifically defines them
-        if field
-          field.show unless field.instance_variable_get("@#{field.name}_registered").is_a?(Proc)
-        end
+        field.show if field && !field.instance_variable_get("@#{field.name}_registered").is_a?(Proc)
         # Specify field as virtual if type is not specifically set and field was not
         # found in default stack
         if field.nil? && type.nil?
@@ -39,9 +37,9 @@ module RailsAdmin
         field
       end
 
-      # configure a field without adding it.
+      # configure field(s) from the default group in a section without changing the original order.
       def configure(name, type = nil, &block)
-        field(name, type, false, &block)
+        [*name].each { |field_name| field(field_name, type, false, &block) }
       end
 
       # include fields by name and apply an optionnal block to each (through a call to fields),
@@ -50,6 +48,7 @@ module RailsAdmin
         if field_names.empty?
           _fields.select { |f| f.instance_eval(&block) }.each do |f|
             next if f.defined
+
             f.defined = true
             f.order = _fields.count(&:defined)
           end
@@ -126,7 +125,7 @@ module RailsAdmin
         return @_fields if @_fields
         return @_ro_fields if readonly && @_ro_fields
 
-        if self.class == RailsAdmin::Config::Sections::Base
+        if instance_of?(RailsAdmin::Config::Sections::Base)
           @_ro_fields = @_fields = RailsAdmin::Config::Fields.factory(self)
         else
           # parent is RailsAdmin::Config::Model, recursion is on Section's classes

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 { instance_eval(&block) == false } : false
       end
 
       # Writer to show field.

data/lib/rails_admin/config/inspectable.rb

@@ -30,9 +30,7 @@ module RailsAdmin
       end
 
       def set_named_instance_variables
-        unless defined?(self.class::NAMED_INSTANCE_VARIABLES)
-          self.class.const_set('NAMED_INSTANCE_VARIABLES', [])
-        end
+        self.class.const_set('NAMED_INSTANCE_VARIABLES', []) unless defined?(self.class::NAMED_INSTANCE_VARIABLES)
       end
     end
   end

data/lib/rails_admin/config/model.rb

@@ -21,30 +21,31 @@ module RailsAdmin
       include RailsAdmin::Config::Sections
       include RailsAdmin::Config::Inspectable
 
-      attr_reader :abstract_model
+      attr_reader :abstract_model, :parent, :root
       attr_accessor :groups
-      attr_reader :parent, :root
 
-      NAMED_INSTANCE_VARIABLES = [:@parent, :@root].freeze
+      NAMED_INSTANCE_VARIABLES = %i[@parent @root].freeze
 
       def initialize(entity)
         @parent = nil
         @root = self
 
-        @abstract_model = begin
-          if entity.is_a?(RailsAdmin::AbstractModel)
+        @abstract_model =
+          case entity
+          when RailsAdmin::AbstractModel
             entity
-          elsif entity.is_a?(Class) || entity.is_a?(String) || entity.is_a?(Symbol)
+          when Class, String, Symbol
             RailsAdmin::AbstractModel.new(entity)
           else
             RailsAdmin::AbstractModel.new(entity.class)
           end
-        end
+
         @groups = [RailsAdmin::Config::Fields::Group.new(self, :default).tap { |g| g.label { I18n.translate('admin.form.basic_info') } }]
       end
 
       def excluded?
         return @excluded if defined?(@excluded)
+
         @excluded = !RailsAdmin::AbstractModel.all.collect(&:model_name).include?(abstract_model.try(:model_name))
       end
 
@@ -81,17 +82,16 @@ module RailsAdmin
       register_instance_option :parent do
         @parent_model ||= begin
           klass = abstract_model.model.superclass
-          klass = nil if klass.to_s.in?(%w(Object BasicObject ActiveRecord::Base))
+          klass = nil if klass.to_s.in?(%w[Object BasicObject ActiveRecord::Base])
           klass
         end
       end
 
       register_instance_option :navigation_label do
-        @navigation_label ||= begin
+        @navigation_label ||=
           if (parent_module = abstract_model.model.try(:module_parent) || abstract_model.model.try!(:parent)) != Object
             parent_module.to_s
           end
-        end
       end
 
       register_instance_option :navigation_icon do

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

@@ -18,10 +18,9 @@ module RailsAdmin
         include RailsAdmin::Config::HasGroups
         include RailsAdmin::Config::HasDescription
 
-        attr_reader :abstract_model
-        attr_reader :parent, :root
+        attr_reader :abstract_model, :parent, :root
 
-        NAMED_INSTANCE_VARIABLES = [:@parent, :@root, :@abstract_model].freeze
+        NAMED_INSTANCE_VARIABLES = %i[@parent @root @abstract_model].freeze
 
         def initialize(parent)
           @parent = parent

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

@@ -44,23 +44,12 @@ module RailsAdmin
           ''
         end
 
-        register_instance_option :sidescroll do
-          nil
+        register_deprecated_instance_option :sidescroll do
+          ActiveSupport::Deprecation.warn('The sidescroll configuration option was removed, it is always enabled now.')
         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
+        def fields_for_table
+          visible_fields.partition(&:sticky?).flatten
         end
       end
     end

data/lib/rails_admin/config/sections.rb

@@ -25,7 +25,7 @@ module RailsAdmin
           section = RailsAdmin::Config::Sections.const_get(name)
           name = name.to_s.underscore.to_sym
           klass.send(:define_method, name) do |&block|
-            @sections = {} unless @sections
+            @sections ||= {}
             @sections[name] = section.new(self) unless @sections[name]
             @sections[name].instance_eval(&block) if block
             @sections[name]

data/lib/rails_admin/config.rb

@@ -1,4 +1,4 @@
-require 'rails_admin/config/lazy_model'
+require 'rails_admin/config/model'
 require 'rails_admin/config/sections/list'
 require 'active_support/core_ext/module/attribute_accessors'
 
@@ -20,6 +20,10 @@ module RailsAdmin
 
     DEFAULT_CURRENT_USER = proc {}
 
+    # Variables to track initialization process
+    @initialized = false
+    @deferred_blocks = []
+
     class << self
       # Application title, can be an array of two elements
       attr_accessor :main_app_name
@@ -27,8 +31,8 @@ module RailsAdmin
       # Configuration option to specify which models you want to exclude.
       attr_accessor :excluded_models
 
-      # Configuration option to specify a whitelist of models you want to RailsAdmin to work with.
-      # The excluded_models list applies against the whitelist as well and further reduces the models
+      # Configuration option to specify a allowlist of models you want to RailsAdmin to work with.
+      # The excluded_models list applies against the allowlist as well and further reduces the models
       # RailsAdmin will use.
       # If included_models is left empty ([]), then RailsAdmin will automatically use all the models
       # in your application (less any excluded_models you may have specified).
@@ -56,14 +60,8 @@ module RailsAdmin
       # Tell browsers whether to use the native HTML5 validations (novalidate form option).
       attr_accessor :browser_validations
 
-      # 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
+      attr_reader :parent_controller
 
       # set settings for `protect_from_forgery` method
       # By default, it raises exception upon invalid CSRF tokens
@@ -82,6 +80,25 @@ module RailsAdmin
       attr_accessor :navigation_static_links
       attr_accessor :navigation_static_label
 
+      # Set where RailsAdmin fetches JS/CSS from, defaults to :sprockets
+      attr_accessor :asset_source
+
+      # Finish initialization by executing deferred configuration blocks
+      def initialize!
+        @deferred_blocks.each { |block| block.call(self) }
+        @deferred_blocks.clear
+        @initialized = true
+      end
+
+      # Evaluate the given block either immediately or lazily, based on initialization status.
+      def apply(&block)
+        if @initialized
+          yield(self)
+        else
+          @deferred_blocks << block
+        end
+      end
+
       # 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
       #
@@ -110,7 +127,7 @@ module RailsAdmin
         @authenticate || DEFAULT_AUTHENTICATION
       end
 
-      # Setup auditing/history/versioning provider that observe objects lifecycle
+      # Setup auditing/versioning provider that observe objects lifecycle
       def audit_with(*args, &block)
         extension = args.shift
         if extension
@@ -145,7 +162,7 @@ module RailsAdmin
       #     config.authorize_with :cancancan
       #   end
       #
-      # See the wiki[https://github.com/sferik/rails_admin/wiki] for more on authorization.
+      # See the wiki[https://github.com/railsadminteam/rails_admin/wiki] for more on authorization.
       #
       # @see RailsAdmin::Config::DEFAULT_AUTHORIZE
       def authorize_with(*args, &block)
@@ -198,10 +215,10 @@ module RailsAdmin
       end
 
       def default_search_operator=(operator)
-        if %w(default like not_like starts_with ends_with is =).include? operator
+        if %w[default like not_like starts_with ends_with is =].include? operator
           @default_search_operator = operator
         else
-          raise(ArgumentError.new("Search operator '#{operator}' not supported"))
+          raise ArgumentError.new("Search operator '#{operator}' not supported")
         end
       end
 
@@ -223,20 +240,20 @@ module RailsAdmin
       #
       # @see RailsAdmin::Config.registry
       def model(entity, &block)
-        key = begin
-          if entity.is_a?(RailsAdmin::AbstractModel)
+        key =
+          case entity
+          when RailsAdmin::AbstractModel
             entity.model.try(:name).try :to_sym
-          elsif entity.is_a?(Class)
+          when Class
             entity.name.to_sym
-          elsif entity.is_a?(String) || entity.is_a?(Symbol)
+          when String, Symbol
             entity.to_sym
           else
             entity.class.name.to_sym
           end
-        end
 
-        @registry[key] ||= RailsAdmin::Config::LazyModel.new(entity)
-        @registry[key].add_deferred_block(&block) if block
+        @registry[key] ||= RailsAdmin::Config::Model.new(entity)
+        @registry[key].instance_eval(&block) if block && @registry[key].abstract_model
         @registry[key]
       end
 
@@ -250,9 +267,28 @@ module RailsAdmin
         end
       end
 
-      # Returns action configuration object
+      def parent_controller=(name)
+        @parent_controller = name
+        if defined?(RailsAdmin::ApplicationController)
+          RailsAdmin.send(:remove_const, :ApplicationController)
+          load RailsAdmin::Engine.root.join('app/controllers/rails_admin/application_controller.rb')
+        end
+      end
+
+      def total_columns_width=(_)
+        ActiveSupport::Deprecation.warn('The total_columns_width configuration option is deprecated and has no effect.')
+      end
+
+      def sidescroll=(_)
+        ActiveSupport::Deprecation.warn('The sidescroll configuration option was removed, it is always enabled now.')
+      end
+
+      # Setup actions to be used.
       def actions(&block)
-        RailsAdmin::Config::Actions.instance_eval(&block) if block
+        return unless block
+
+        RailsAdmin::Config::Actions.reset
+        RailsAdmin::Config::Actions.instance_eval(&block)
       end
 
       # Returns all model configurations
@@ -274,24 +310,24 @@ module RailsAdmin
         @current_user = nil
         @default_hidden_fields = {}
         @default_hidden_fields[:base] = [:_type]
-        @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_hidden_fields[:edit] = %i[id _id created_at created_on deleted_at updated_at updated_on deleted_on]
+        @default_hidden_fields[:show] = %i[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]
+        @label_methods = %i[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
+        @asset_source = (defined?(Webpacker) ? :webpacker : :sprockets)
         @parent_controller = '::ActionController::Base'
         @forgery_protection_settings = {with: :exception}
         RailsAdmin::Config::Actions.reset
+        RailsAdmin::AbstractModel.reset
       end
 
       # Reset a provided model's configuration.
@@ -302,22 +338,21 @@ 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 = {}
+      # Perform reset, then load RailsAdmin initializer again
+      def reload!
+        @initialized = false
+        reset
+        load RailsAdmin::Engine.config.initializer_path
+        initialize!
       end
 
       # Get all models that are configured as visible sorted by their weight and label.
       #
       # @see RailsAdmin::Config::Hideable
-
       def visible_models(bindings)
         visible_models_with_bindings(bindings).sort do |a, b|
           if (weight_order = a.weight <=> b.weight) == 0
-            a.label.downcase <=> b.label.downcase
+            a.label.casecmp(b.label)
           else
             weight_order
           end
@@ -334,9 +369,9 @@ 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.paths.eager_load).collect do |load_path|
+              (app.paths['app/models'].to_a + app.config.eager_load_paths).collect do |load_path|
                 Dir.glob(app.root.join(load_path)).collect do |load_dir|
-                  Dir.glob(load_dir + '/**/*.rb').collect do |filename|
+                  Dir.glob("#{load_dir}/**/*.rb").collect do |filename|
                     # app/models/module/class.rb => module/class.rb => module/class => Module::Class
                     lchomp(filename, "#{app.root.join(load_dir)}/").chomp('.rb').camelize
                   end

data/lib/rails_admin/engine.rb

@@ -1,11 +1,8 @@
-require 'jquery-rails'
-require 'jquery-ui-rails'
 require 'kaminari'
 require 'nested_form'
 require 'rack-pjax'
 require 'rails'
 require 'rails_admin'
-require 'remotipart'
 
 module RailsAdmin
   class Engine < Rails::Engine
@@ -14,27 +11,38 @@ module RailsAdmin
     config.action_dispatch.rescue_responses['RailsAdmin::ActionNotAllowed'] = :forbidden
 
     initializer 'RailsAdmin precompile hook', group: :all do |app|
-      app.config.assets.precompile += %w(
-        rails_admin/rails_admin.js
-        rails_admin/rails_admin.css
-        rails_admin/jquery.colorpicker.js
-        rails_admin/jquery.colorpicker.css
-      )
+      if app.config.respond_to?(:assets)
+        app.config.assets.precompile += %w[
+          rails_admin.js
+          rails_admin.css
+        ]
+        app.config.assets.paths << RailsAdmin::Engine.root.join('src')
+        require 'rails_admin/support/esmodule_preprocessor'
+        Sprockets.register_preprocessor 'application/javascript', RailsAdmin::ESModulePreprocessor
+      end
     end
 
     initializer 'RailsAdmin setup middlewares' do |app|
       app.config.middleware.use Rack::Pjax
     end
 
-    initializer 'RailsAdmin reload config in development' do
-      if Rails.application.config.cache_classes
-        if defined?(ActiveSupport::Reloader)
-          ActiveSupport::Reloader.before_class_unload do
-            RailsAdmin::Config.reset_all_models
-          end
-          # else
-          # For Rails 4 not implemented
+    initializer 'RailsAdmin reload config in development' do |app|
+      config.initializer_path = app.root.join('config/initializers/rails_admin.rb')
+
+      unless Rails.application.config.cache_classes
+        ActiveSupport::Reloader.before_class_unload do
+          RailsAdmin::Config.reload!
+        end
+
+        reloader = app.config.file_watcher.new([config.initializer_path], []) do
+          # Do nothing, ActiveSupport::Reloader will trigger class_unload! anyway
         end
+
+        app.reloaders << reloader
+        app.reloader.to_run do
+          reloader.execute_if_updated { require_unload_lock! }
+        end
+        reloader.execute
       end
     end
 
@@ -49,20 +57,25 @@ module RailsAdmin
           m.klass.name =~ /^ActionDispatch::Session::/
       end
       loaded = app.config.middleware.to_a.map(&:name)
-      required = %w(ActionDispatch::Cookies ActionDispatch::Flash Rack::MethodOverride)
+      required = %w[ActionDispatch::Cookies ActionDispatch::Flash Rack::MethodOverride]
       missing = required - loaded
       unless missing.empty? && has_session_store
         configs = missing.map { |m| "config.middleware.use #{m}" }
         configs << "config.middleware.use #{app.config.session_store.try(:name) || 'ActionDispatch::Session::CookieStore'}, #{app.config.session_options}" unless has_session_store
-        raise <<-EOM
-Required middlewares for RailsAdmin are not added
-To fix this, add
+        raise <<~EOM
+          Required middlewares for RailsAdmin are not added
+          To fix this, add
 
-  #{configs.join("\n  ")}
+            #{configs.join("\n  ")}
 
-to config/application.rb.
+          to config/application.rb.
         EOM
       end
+
+      RailsAdmin::Config.initialize!
+
+      # Force route reload, since it doesn't reflect RailsAdmin action configuration yet
+      app.reload_routes!
     end
   end
 end

data/lib/rails_admin/extension.rb

@@ -15,27 +15,19 @@ module RailsAdmin
 
     EXTENSIONS << extension_key
 
-    if options[:authorization]
-      AUTHORIZATION_ADAPTERS[extension_key] = extension_definition::AuthorizationAdapter
-    end
+    AUTHORIZATION_ADAPTERS[extension_key] = extension_definition::AuthorizationAdapter if options[:authorization]
 
-    if options[:configuration]
-      CONFIGURATION_ADAPTERS[extension_key] = extension_definition::ConfigurationAdapter
-    end
+    CONFIGURATION_ADAPTERS[extension_key] = extension_definition::ConfigurationAdapter if options[:configuration]
 
-    if options[:auditing]
-      AUDITING_ADAPTERS[extension_key] = extension_definition::AuditingAdapter
-    end
+    AUDITING_ADAPTERS[extension_key] = extension_definition::AuditingAdapter if options[:auditing]
   end
 
   # Setup all extensions for testing
   def self.setup_all_extensions
     (AUTHORIZATION_ADAPTERS.values + AUDITING_ADAPTERS.values).each do |klass|
-      begin
-        klass.setup if klass.respond_to? :setup
-      rescue # rubocop:disable Lint/HandleExceptions, Style/RescueStandardError
-        # ignore errors
-      end
+      klass.setup if klass.respond_to? :setup
+    rescue # rubocop:disable Style/RescueStandardError
+      # ignore errors
     end
   end
 end

data/lib/rails_admin/extensions/cancancan/authorization_adapter.rb

@@ -26,6 +26,7 @@ module RailsAdmin
         # instance if it is available.
         def authorize(action, abstract_model = nil, model_object = nil)
           return unless action
+
           action, subject = resolve_action_and_subject(action, abstract_model, model_object)
           @controller.current_ability.authorize!(action, subject)
         end
@@ -36,6 +37,7 @@ module RailsAdmin
         # return a boolean whereas +authorize+ will raise an exception when not authorized.
         def authorized?(action, abstract_model = nil, model_object = nil)
           return unless action
+
           action, subject = resolve_action_and_subject(action, abstract_model, model_object)
           @controller.current_ability.can?(action, subject)
         end
@@ -51,13 +53,13 @@ module RailsAdmin
         # records. It should return a hash of attributes which match what the user
         # is authorized to create.
         def attributes_for(action, abstract_model)
-          @controller.current_ability.attributes_for(action, abstract_model && abstract_model.model)
+          @controller.current_ability.attributes_for(action, abstract_model&.model)
         end
 
       private
 
         def resolve_action_and_subject(action, abstract_model, model_object)
-          subject = model_object || abstract_model && abstract_model.model
+          subject = model_object || abstract_model&.model
           if subject
             [action, subject]
           else