administrate 0.20.1 → 1.0.0.beta2

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

@@ -41,11 +41,15 @@ module Administrate
         else
           self.class.associated_class_name(
             resource.class,
-            attribute,
+            attribute
           )
         end
       end
 
+      def html_controller
+        "select"
+      end
+
       private
 
       def associated_dashboard

data/lib/administrate/field/base.rb

@@ -34,20 +34,38 @@ module Administrate
 
       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 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 to_partial_path
         "/fields/#{self.class.field_type}/#{page}"
       end
@@ -56,13 +74,13 @@ module Administrate
         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

@@ -25,7 +25,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 +41,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

@@ -6,7 +6,7 @@ module Administrate
       def date
         I18n.localize(
           data.to_date,
-          format: format,
+          format: format
         )
       end
 

data/lib/administrate/field/date_time.rb

@@ -6,7 +6,7 @@ module Administrate
       def date
         I18n.localize(
           data.in_time_zone(timezone).to_date,
-          format: format,
+          format: format
         )
       end
 
@@ -14,7 +14,7 @@ module Administrate
         I18n.localize(
           data.in_time_zone(timezone),
           format: format,
-          default: data,
+          default: data
         )
       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,12 +34,16 @@ 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",
+          "searchable_field is deprecated, use searchable_fields instead"
         )
         options.fetch(:searchable_field)
       end

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
 
@@ -82,7 +82,7 @@ module Administrate
       def order_from_params(params)
         Administrate::Order.new(
           params.fetch(:order, sort_by),
-          params.fetch(:direction, direction),
+          params.fetch(:direction, direction)
         )
       end
 

data/lib/administrate/field/has_one.rb

@@ -20,10 +20,10 @@ module Administrate
             end
           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 +33,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 +48,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/polymorphic.rb

@@ -4,7 +4,7 @@ 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
@@ -16,11 +16,11 @@ module Administrate
       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/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/order.rb

@@ -48,7 +48,7 @@ module Administrate
     end
 
     def opposite_direction
-      direction == :asc ? :desc : :asc
+      (direction == :asc) ? :desc : :asc
     end
 
     def order_by_association(relation)
@@ -67,15 +67,15 @@ module Administrate
     def order_by_count(relation)
       klass = reflect_association(relation).klass
       query = klass.arel_table[klass.primary_key].count.public_send(direction)
-      relation.
-        left_joins(attribute.to_sym).
-        group(:id).
-        reorder(query)
+      relation
+        .left_joins(attribute.to_sym)
+        .group(:id)
+        .reorder(query)
     end
 
     def order_by_belongs_to(relation)
       if ordering_by_association_column?(relation)
-        order_by_attribute(relation)
+        order_by_association_attribute(relation)
       else
         order_by_id(relation)
       end
@@ -83,26 +83,16 @@ module Administrate
 
     def order_by_has_one(relation)
       if ordering_by_association_column?(relation)
-        order_by_attribute(relation)
+        order_by_association_attribute(relation)
       else
         order_by_association_id(relation)
       end
     end
 
-    def order_by_attribute(relation)
-      relation.joins(
-        attribute.to_sym,
-      ).reorder(order_by_attribute_query)
-    end
-
     def order_by_id(relation)
       relation.reorder(order_by_id_query(relation))
     end
 
-    def order_by_association_id(relation)
-      relation.reorder(order_by_association_id_query)
-    end
-
     def ordering_by_association_column?(relation)
       association_attribute &&
         column_exist?(
@@ -115,16 +105,26 @@ module Administrate
     end
 
     def order_by_id_query(relation)
-      relation.arel_table[foreign_key(relation)].public_send(direction)
+      relation.arel_table[association_foreign_key(relation)].public_send(direction)
     end
 
-    def order_by_association_id_query
-      Arel::Table.new(association_table_name)[:id].public_send(direction)
+    def order_by_association_id(relation)
+      order_by_association_column(relation, association_primary_key(relation))
     end
 
-    def order_by_attribute_query
-      table = Arel::Table.new(association_table_name)
-      table[association_attribute].public_send(direction)
+    def order_by_association_attribute(relation)
+      order_by_association_column(relation, association_attribute)
+    end
+
+    def order_by_association_column(relation, column_name)
+      relation.joins(
+        attribute.to_sym
+      ).reorder(order_by_association_column_query(relation, column_name))
+    end
+
+    def order_by_association_column_query(relation, column)
+      table = Arel::Table.new(association_table_name(relation))
+      table[column].public_send(direction)
     end
 
     def relation_type(relation)
@@ -135,12 +135,16 @@ module Administrate
       relation.klass.reflect_on_association(attribute.to_s)
     end
 
-    def foreign_key(relation)
+    def association_foreign_key(relation)
       reflect_association(relation).foreign_key
     end
 
-    def association_table_name
-      attribute.tableize
+    def association_primary_key(relation)
+      reflect_association(relation).association_primary_key
+    end
+
+    def association_table_name(relation)
+      reflect_association(relation).table_name
     end
   end
 end

data/lib/administrate/page/base.rb

@@ -12,7 +12,7 @@ module Administrate
       end
 
       def resource_path
-        @resource_path ||= resource_name.gsub("/", "_")
+        @resource_path ||= resource_name.tr("/", "_")
       end
 
       def collection_includes
@@ -30,13 +30,8 @@ module Administrate
       private
 
       def attribute_field(dashboard, resource, attribute_name, page)
-        value = get_attribute_value(resource, attribute_name)
         field = dashboard.attribute_type_for(attribute_name)
-        field.new(attribute_name, value, page, resource: resource)
-      end
-
-      def get_attribute_value(resource, attribute_name)
-        resource.public_send(attribute_name)
+        field.new(attribute_name, nil, page, resource: resource)
       end
 
       attr_reader :dashboard, :options

data/lib/administrate/page/collection.rb

@@ -5,7 +5,7 @@ module Administrate
     class Collection < Page::Base
       def attribute_names
         options.fetch(:collection_attributes, nil) ||
-        dashboard.collection_attributes
+          dashboard.collection_attributes
       end
 
       def attributes_for(resource)
@@ -25,7 +25,7 @@ module Administrate
       delegate :ordered_by?, to: :order
 
       def order_params_for(attr, key: resource_name)
-        { key => order.order_params_for(attr) }
+        {key => order.order_params_for(attr)}
       end
 
       private

data/lib/administrate/page/form.rb

@@ -14,7 +14,7 @@ module Administrate
         attributes = dashboard.form_attributes(action)
 
         if attributes.is_a? Array
-          attributes = { "" => attributes }
+          attributes = {"" => attributes}
         end
 
         attributes.transform_values do |attrs|

data/lib/administrate/page/show.rb

@@ -18,7 +18,7 @@ module Administrate
         attributes = dashboard.show_page_attributes
 
         if attributes.is_a? Array
-          attributes = { "" => attributes }
+          attributes = {"" => attributes}
         end
 
         attributes.transform_values do |attrs|

data/lib/administrate/resource_resolver.rb

@@ -35,7 +35,7 @@ module Administrate
     end
 
     def controller_path_parts
-      path_parts = controller_path.split("/")[1..-1]
+      path_parts = controller_path.split("/")[1..]
       path_parts << path_parts.pop.singularize
     end
 

data/lib/administrate/search.rb

@@ -59,8 +59,7 @@ module Administrate
         @scoped_resource.all
       else
         results = search_results(@scoped_resource)
-        results = filter_results(results)
-        results
+        filter_results(results)
       end
     end
 
@@ -112,9 +111,9 @@ module Administrate
     end
 
     def search_results(resources)
-      resources.
-        left_joins(tables_to_join).
-        where(query_template, *query_values)
+      resources
+        .left_joins(tables_to_join)
+        .where(query_template, *query_values)
     end
 
     def valid_filters
@@ -141,8 +140,8 @@ module Administrate
           end
         ActiveRecord::Base.connection.quote_table_name(unquoted_table_name)
       else
-        ActiveRecord::Base.connection.
-          quote_table_name(@scoped_resource.table_name)
+        ActiveRecord::Base.connection
+          .quote_table_name(@scoped_resource.table_name)
       end
     end
 

data/lib/administrate/version.rb

@@ -1,3 +1,3 @@
 module Administrate
-  VERSION = "0.20.1".freeze
+  VERSION = "1.0.0.beta2".freeze
 end

data/lib/administrate/view_generator.rb

@@ -9,13 +9,13 @@ module Administrate
       :namespace,
       type: :string,
       desc: "Namespace where the admin dashboards live",
-      default: "admin",
+      default: "admin"
     )
 
     def self.template_source_path
       File.expand_path(
         "../../../app/views/administrate/application",
-        __FILE__,
+        __FILE__
       )
     end
 
@@ -30,7 +30,7 @@ module Administrate
 
       copy_file(
         template_file,
-        "app/views/#{namespace}/#{resource_path}/#{template_file}",
+        "app/views/#{namespace}/#{resource_path}/#{template_file}"
       )
     end
 

data/lib/administrate.rb

@@ -4,39 +4,39 @@ require "administrate/version"
 module Administrate
   def self.warn_of_missing_resource_class
     deprecator.warn(
-      "Calling Field::Base.permitted_attribute without the option " +
-      ":resource_class is deprecated. If you are seeing this " +
-      "message, you are probably using a custom field type that" +
-      "does this. Please make sure to update it to a version that " +
-      "does not use a deprecated API",
+      "Calling Field::Base.permitted_attribute without the option " \
+      ":resource_class is deprecated. If you are seeing this " \
+      "message, you are probably using a custom field type that" \
+      "does this. Please make sure to update it to a version that " \
+      "does not use a deprecated API"
     )
   end
 
   def self.warn_of_deprecated_option(name)
     deprecator.warn(
-      "The option :#{name} is deprecated. " +
-      "Administrate should detect it automatically. " +
-      "Please file an issue at " +
-      "https://github.com/thoughtbot/administrate/issues " +
-      "if you think otherwise.",
+      "The option :#{name} is deprecated. " \
+      "Administrate should detect it automatically. " \
+      "Please file an issue at " \
+      "https://github.com/thoughtbot/administrate/issues " \
+      "if you think otherwise."
     )
   end
 
   def self.warn_of_deprecated_method(klass, method)
     deprecator.warn(
-      "The method #{klass}##{method} is deprecated. " +
-      "If you are seeing this message you are probably " +
-      "using a dashboard that depends explicitly on it. " +
-      "Please make sure you update it to a version that " +
-      "does not use a deprecated API",
+      "The method #{klass}##{method} is deprecated. " \
+      "If you are seeing this message you are probably " \
+      "using a dashboard that depends explicitly on it. " \
+      "Please make sure you update it to a version that " \
+      "does not use a deprecated API"
     )
   end
 
   def self.warn_of_deprecated_authorization_method(method)
     deprecator.warn(
-      "The method `#{method}` is deprecated. " +
-      "Please use `accessible_action?` instead, " +
-      "or see the documentation for other options.",
+      "The method `#{method}` is deprecated. " \
+      "Please use `accessible_action?` instead, " \
+      "or see the documentation for other options."
     )
   end