administrate 0.20.1 → 1.0.0

data/lib/administrate/engine.rb

@@ -1,8 +1,4 @@
-require "jquery-rails"
 require "kaminari"
-require "sassc-rails"
-require "selectize-rails"
-require "sprockets/railtie"
 
 require "administrate/namespace/resource"
 require "administrate/not_authorized_error"
@@ -13,7 +9,6 @@ require "administrate/order"
 require "administrate/resource_resolver"
 require "administrate/search"
 require "administrate/namespace"
-require "administrate/namespace/resource"
 
 module Administrate
   class Engine < ::Rails::Engine
@@ -25,10 +20,16 @@ module Administrate
     initializer "administrate.assets.precompile" do |app|
       app.config.assets.precompile += [
         "administrate/application.js",
-        "administrate/application.css",
+        "administrate/application.css"
       ]
     end
 
+    initializer "administrate.action_text" do
+      ActiveSupport.on_load :action_text_rich_text do
+        require "administrate/field/rich_text"
+      end
+    end
+
     def self.add_javascript(script)
       @@javascripts << script
     end

data/lib/administrate/field/associative.rb

@@ -37,51 +37,36 @@ module Administrate
 
       def associated_class_name
         if option_given?(:class_name)
-          deprecated_option(:class_name)
+          options.fetch(:class_name)
         else
           self.class.associated_class_name(
             resource.class,
-            attribute,
+            attribute
           )
         end
       end
 
+      def html_controller
+        "select"
+      end
+
       private
 
       def associated_dashboard
         "#{associated_class_name}Dashboard".constantize.new
       end
 
-      def primary_key
-        # Deprecated, renamed `association_primary_key`
-        Administrate.warn_of_deprecated_method(self.class, :primary_key)
-        association_primary_key
-      end
-
       def association_primary_key
-        if option_given?(:primary_key)
-          deprecated_option(:primary_key)
-        else
-          self.class.association_primary_key_for(resource.class, attribute)
-        end
+        self.class.association_primary_key_for(resource.class, attribute)
       end
 
       def foreign_key
-        if option_given?(:foreign_key)
-          deprecated_option(:foreign_key)
-        else
-          self.class.foreign_key_for(resource.class, attribute)
-        end
+        self.class.foreign_key_for(resource.class, attribute)
       end
 
       def option_given?(name)
         options.key?(name)
       end
-
-      def deprecated_option(name)
-        Administrate.warn_of_deprecated_option(name)
-        options.fetch(name)
-      end
     end
   end
 end

data/lib/administrate/field/base.rb

@@ -24,6 +24,10 @@ module Administrate
         false
       end
 
+      def self.sortable?
+        true
+      end
+
       def self.field_type
         to_s.split("::").last.underscore
       end
@@ -32,37 +36,68 @@ module Administrate
         attr
       end
 
+      def self.partial_prefixes
+        @partial_prefixes ||=
+          if superclass.respond_to?(:partial_prefixes)
+            local_partial_prefixes + superclass.partial_prefixes
+          else
+            local_partial_prefixes
+          end
+      end
+
+      def self.local_partial_prefixes
+        ["fields/#{field_type}"]
+      end
+
       def initialize(attribute, data, page, options = {})
         @attribute = attribute
-        @data = data
         @page = page
         @resource = options.delete(:resource)
         @options = options
+        @data = read_value(data)
       end
 
       def html_class
         self.class.html_class
       end
 
+      def html_controller
+        nil
+      end
+
       def name
         attribute.to_s
       end
 
-      def to_partial_path
-        "/fields/#{self.class.field_type}/#{page}"
+      def read_value(data)
+        if options.key?(:getter)
+          if options[:getter].respond_to?(:call)
+            options[:getter].call(self)
+          else
+            resource.try(options[:getter])
+          end
+        elsif data.nil?
+          resource.try(attribute)
+        else
+          data
+        end
+      end
+
+      def partial_prefixes
+        self.class.partial_prefixes
       end
 
       def required?
         return false unless resource.class.respond_to?(:validators_on)
 
         resource.class.validators_on(attribute).any? do |v|
-          next false unless v.class == ActiveRecord::Validations::PresenceValidator
+          next false unless v.instance_of?(ActiveRecord::Validations::PresenceValidator)
 
           options = v.options
           next false if options.include?(:if)
           next false if options.include?(:unless)
 
-          if on_option = options[:on]
+          if (on_option = options[:on])
             if on_option == :create && !resource.persisted?
               next true
             end

data/lib/administrate/field/belongs_to.rb

@@ -5,12 +5,7 @@ module Administrate
     class BelongsTo < Associative
       def self.permitted_attribute(attr, options = {})
         resource_class = options[:resource_class]
-        if resource_class
-          foreign_key_for(resource_class, attr)
-        else
-          Administrate.warn_of_missing_resource_class
-          :"#{attr}_id"
-        end
+        foreign_key_for(resource_class, attr)
       end
 
       def self.eager_load?
@@ -25,7 +20,7 @@ module Administrate
         candidate_resources.map do |resource|
           [
             display_candidate_resource(resource),
-            resource.send(association_primary_key),
+            resource.send(association_primary_key)
           ]
         end
       end
@@ -41,7 +36,12 @@ module Administrate
       private
 
       def candidate_resources
-        scope = options[:scope] ? options[:scope].call : associated_class.all
+        scope =
+          if options[:scope]
+            options[:scope].arity.positive? ? options[:scope].call(self) : options[:scope].call
+          else
+            associated_class.all
+          end
 
         order = options.delete(:order)
         order ? scope.reorder(order) : scope

data/lib/administrate/field/date.rb

@@ -5,8 +5,8 @@ module Administrate
     class Date < Base
       def date
         I18n.localize(
-          data.to_date,
-          format: format,
+          data.in_time_zone(timezone).to_date,
+          format: format
         )
       end
 
@@ -15,6 +15,10 @@ module Administrate
       def format
         options.fetch(:format, :default)
       end
+
+      def timezone
+        options.fetch(:timezone, ::Time.zone)
+      end
     end
   end
 end

data/lib/administrate/field/date_time.rb

@@ -6,15 +6,14 @@ module Administrate
       def date
         I18n.localize(
           data.in_time_zone(timezone).to_date,
-          format: format,
+          format: format
         )
       end
 
       def datetime
         I18n.localize(
           data.in_time_zone(timezone),
-          format: format,
-          default: data,
+          format: format
         )
       end
 
@@ -25,7 +24,7 @@ module Administrate
       end
 
       def timezone
-        options.fetch(:timezone, ::Time.zone.name || "UTC")
+        options.fetch(:timezone, ::Time.zone)
       end
     end
   end

data/lib/administrate/field/deferred.rb

@@ -21,6 +21,10 @@ module Administrate
           options == other.options
       end
 
+      def getter
+        options.fetch(:getter, nil)
+      end
+
       def associative?
         deferred_class.associative?
       end
@@ -30,31 +34,23 @@ module Administrate
       end
 
       def searchable?
-        options.fetch(:searchable, deferred_class.searchable?)
+        if options.key?(:getter)
+          false
+        else
+          options.fetch(:searchable, deferred_class.searchable?)
+        end
       end
 
-      def searchable_field
-        Administrate.deprecator.warn(
-          "searchable_field is deprecated, use searchable_fields instead",
-        )
-        options.fetch(:searchable_field)
+      def searchable_fields
+        options.fetch(:searchable_fields)
       end
 
-      def searchable_fields
-        if options.key?(:searchable_field)
-          [searchable_field]
-        else
-          options.fetch(:searchable_fields)
-        end
+      def sortable?
+        options.fetch(:sortable, deferred_class.sortable?)
       end
 
       def permitted_attribute(attr, opts = {})
-        if options.key?(:foreign_key)
-          Administrate.warn_of_deprecated_option(:foreign_key)
-          options.fetch(:foreign_key)
-        else
-          deferred_class.permitted_attribute(attr, options.merge(opts))
-        end
+        deferred_class.permitted_attribute(attr, options.merge(opts))
       end
 
       delegate :html_class, to: :deferred_class

data/lib/administrate/field/has_many.rb

@@ -18,14 +18,14 @@ module Administrate
         # be `country_ids` instead.
         #
         # See https://github.com/rails/rails/blob/b30a23f53b52e59d31358f7b80385ee5c2ba3afe/activerecord/lib/active_record/associations/builder/collection_association.rb#L48
-        { "#{attr.to_s.singularize}_ids".to_sym => [] }
+        {"#{attr.to_s.singularize}_ids": []}
       end
 
       def associated_collection(order = self.order)
         Administrate::Page::Collection.new(
           associated_dashboard,
           order: order,
-          collection_attributes: options[:collection_attributes],
+          collection_attributes: options[:collection_attributes]
         )
       end
 
@@ -37,7 +37,7 @@ module Administrate
         candidate_resources.map do |associated_resource|
           [
             display_candidate_resource(associated_resource),
-            associated_resource.send(association_primary_key),
+            associated_resource.send(association_primary_key)
           ]
         end
       end
@@ -59,7 +59,7 @@ module Administrate
       def permitted_attribute
         self.class.permitted_attribute(
           attribute,
-          resource_class: resource.class,
+          resource_class: resource.class
         )
       end
 
@@ -72,7 +72,7 @@ module Administrate
       end
 
       def more_than_limit?
-        paginate? && data.count(:all) > limit
+        paginate? && data.size > limit
       end
 
       def data
@@ -83,11 +83,20 @@ module Administrate
         Administrate::Order.new(
           params.fetch(:order, sort_by),
           params.fetch(:direction, direction),
+          sorting_column: sorting_column(
+            associated_dashboard_attribute(params.fetch(:order, sort_by))
+          )
         )
       end
 
       def order
-        @order ||= Administrate::Order.new(sort_by, direction)
+        @order ||= Administrate::Order.new(
+          sort_by,
+          direction,
+          sorting_column: sorting_column(
+            associated_dashboard_attribute(sort_by)
+          )
+        )
       end
 
       private
@@ -109,6 +118,16 @@ module Administrate
         associated_dashboard.display_resource(resource)
       end
 
+      def sorting_column(dashboard_attribute)
+        return unless dashboard_attribute.try(:options)
+
+        dashboard_attribute.options.fetch(:sorting_column, nil)
+      end
+
+      def associated_dashboard_attribute(attribute)
+        associated_dashboard.attribute_types[attribute.to_sym] if attribute
+      end
+
       def sort_by
         options[:sort_by]
       end

data/lib/administrate/field/has_one.rb

@@ -7,23 +7,15 @@ module Administrate
         resource_class = options[:resource_class]
         final_associated_class_name =
           if options.key?(:class_name)
-            Administrate.warn_of_deprecated_option(:class_name)
             options.fetch(:class_name)
-          elsif resource_class
-            associated_class_name(resource_class, attr)
           else
-            Administrate.warn_of_missing_resource_class
-            if options
-              attr.to_s.singularize.camelcase
-            else
-              attr
-            end
+            associated_class_name(resource_class, attr)
           end
         related_dashboard_attributes =
-          Administrate::ResourceResolver.
-            new("admin/#{final_associated_class_name}").
-            dashboard_class.new.permitted_attributes + [:id]
-        { "#{attr}_attributes": related_dashboard_attributes }
+          Administrate::ResourceResolver
+            .new("admin/#{final_associated_class_name}")
+            .dashboard_class.new.permitted_attributes + [:id]
+        {"#{attr}_attributes": related_dashboard_attributes}
       end
 
       def self.eager_load?
@@ -33,14 +25,14 @@ module Administrate
       def nested_form
         @nested_form ||= Administrate::Page::Form.new(
           resolver.dashboard_class.new,
-          data || resolver.resource_class.new,
+          data || resolver.resource_class.new
         )
       end
 
       def nested_show
         @nested_show ||= Administrate::Page::Show.new(
           resolver.dashboard_class.new,
-          data || resolver.resource_class.new,
+          data || resolver.resource_class.new
         )
       end
 
@@ -48,6 +40,10 @@ module Administrate
         data.try(:persisted?)
       end
 
+      def html_controller
+        "select"
+      end
+
       private
 
       def resolver

data/lib/administrate/field/number.rb

@@ -38,8 +38,8 @@ module Administrate
         formatter = options[:format][:formatter]
         formatter_options = options[:format][:formatter_options].to_h
 
-        ActiveSupport::NumberHelper.
-          try(formatter, result, **formatter_options) || result
+        ActiveSupport::NumberHelper
+          .try(formatter, result, **formatter_options) || result
       end
     end
   end

data/lib/administrate/field/password.rb

@@ -7,6 +7,10 @@ module Administrate
         false
       end
 
+      def self.sortable?
+        false
+      end
+
       def truncate
         data.to_s.gsub(/./, character)[0...truncation_length]
       end

data/lib/administrate/field/polymorphic.rb

@@ -4,23 +4,23 @@ module Administrate
   module Field
     class Polymorphic < BelongsTo
       def self.permitted_attribute(attr, _options = {})
-        { attr => %i{type value} }
+        {attr => %i[type value]}
       end
 
       def associated_resource_grouped_options
         classes.map do |klass|
-          [klass.to_s, candidate_resources_for(klass).map do |resource|
+          [klass.model_name.human, candidate_resources_for(klass).map do |resource|
             [display_candidate_resource(resource), resource.to_global_id]
           end]
         end
       end
 
       def permitted_attribute
-        { attribute => %i{type value} }
+        {attribute => %i[type value]}
       end
 
       def selected_global_id
-        data ? data.to_global_id : nil
+        data&.to_global_id
       end
 
       private

data/lib/administrate/field/rich_text.rb

@@ -0,0 +1,21 @@
+require "administrate/field/base"
+
+module Administrate
+  module Field
+    class RichText < Administrate::Field::Base
+      def to_s
+        data&.to_plain_text
+      end
+
+      def truncate
+        to_s.truncate(truncation_length)
+      end
+
+      private
+
+      def truncation_length
+        options.fetch(:truncate, 50)
+      end
+    end
+  end
+end

data/lib/administrate/field/select.rb

@@ -35,6 +35,10 @@ module Administrate
       def active_record_enum_values
         resource.class.defined_enums[attribute.to_s].map(&:first)
       end
+
+      def html_controller
+        "select"
+      end
     end
   end
 end

data/lib/administrate/field/time.rb

@@ -4,15 +4,16 @@ module Administrate
   module Field
     class Time < Base
       def time
-        return I18n.localize(data, format: format) if options[:format]
-
-        data.strftime("%I:%M%p")
+        I18n.localize(
+          data,
+          format: format
+        )
       end
 
       private
 
       def format
-        options[:format]
+        options.fetch(:format, "%I:%M%p")
       end
     end
   end

data/lib/administrate/generator_helpers.rb

@@ -7,7 +7,7 @@ module Administrate
     private
 
     def generator_options
-      { behavior: behavior }
+      {behavior: behavior}
     end
   end
 end

data/lib/administrate/namespace/resource.rb

@@ -21,7 +21,7 @@ module Administrate
       end
 
       def path
-        name.to_s.gsub("/", "_")
+        name.to_s.tr("/", "_")
       end
     end
   end

data/lib/administrate/namespace.rb

@@ -11,10 +11,16 @@ module Administrate
     end
 
     def routes
-      @routes ||= all_routes.select do |controller, _action|
-        controller.starts_with?("#{namespace}/")
-      end.map do |controller, action|
-        [controller.gsub(/^#{namespace}\//, ""), action]
+      @routes ||= begin
+        prefix = "#{namespace}/".freeze
+        Rails.application.routes.routes.filter_map do |route|
+          next unless route.defaults[:controller]&.start_with?(prefix)
+
+          [
+            route.defaults[:controller].delete_prefix(prefix),
+            route.defaults[:action]
+          ]
+        end
       end
     end
 
@@ -25,11 +31,5 @@ module Administrate
     private
 
     attr_reader :namespace
-
-    def all_routes
-      Rails.application.routes.routes.map do |route|
-        route.defaults.values_at(:controller, :action).map(&:to_s)
-      end
-    end
   end
 end