rails_admin_next 1.0.0

data/lib/rails_admin_next/config/inspectable.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module RailsAdminNext
+  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
+        self.class.const_set(:NAMED_INSTANCE_VARIABLES, []) unless defined?(self.class::NAMED_INSTANCE_VARIABLES)
+      end
+    end
+  end
+end

data/lib/rails_admin_next/config/lazy_model.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require "rails_admin_next/config/model"
+
+module RailsAdminNext
+  module Config
+    class LazyModel < BasicObject
+      def initialize(entity, &block)
+        @entity = entity
+        @deferred_blocks = [*block]
+        @initialized = false
+      end
+
+      def add_deferred_block(&block)
+        if @initialized
+          @model.instance_eval(&block)
+        else
+          @deferred_blocks << block
+        end
+      end
+
+      def target
+        @model ||= ::RailsAdminNext::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 RailsAdminNext configuration block, the configuration from the
+        # resource will get added to @deferred_blocks first:
+        #
+        #     # app/models/some_model.rb
+        #     class SomeModel
+        #       rails_admin_next do
+        #         :
+        #       end
+        #     end
+        #
+        #     # config/initializers/rails_admin_next.rb
+        #     model = 'SomeModel'.constantize # blocks from SomeModel get loaded
+        #     model.config model do           # blocks from initializer gets loaded
+        #       :
+        #     end
+        #
+        # Thus, sort all blocks to execute 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?
+          @deferred_blocks
+            .partition { |block| block.source_location.first =~ %r{config/initializers} }
+            .flatten
+            .each { |block| @model.instance_eval(&block) }
+          @deferred_blocks = []
+        end
+        @initialized = true
+        @model
+      end
+
+      def method_missing(method_name, *, &)
+        target.send(method_name, *, &)
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        super || target.respond_to?(method_name, include_private)
+      end
+    end
+  end
+end

data/lib/rails_admin_next/config/model.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+require "rails_admin_next/config"
+require "rails_admin_next/config/proxyable"
+require "rails_admin_next/config/configurable"
+require "rails_admin_next/config/hideable"
+require "rails_admin_next/config/has_groups"
+require "rails_admin_next/config/fields/group"
+require "rails_admin_next/config/fields"
+require "rails_admin_next/config/has_fields"
+require "rails_admin_next/config/has_description"
+require "rails_admin_next/config/sections"
+require "rails_admin_next/config/actions"
+require "rails_admin_next/config/inspectable"
+
+module RailsAdminNext
+  module Config
+    # Model specific configuration object.
+    class Model
+      include RailsAdminNext::Config::Proxyable
+      include RailsAdminNext::Config::Configurable
+      include RailsAdminNext::Config::Hideable
+      include RailsAdminNext::Config::Sections
+      include RailsAdminNext::Config::Inspectable
+
+      attr_reader :abstract_model, :parent, :root
+      attr_accessor :groups
+
+      NAMED_INSTANCE_VARIABLES = %i[@parent @root].freeze
+
+      def initialize(entity)
+        @parent = nil
+        @root = self
+
+        @abstract_model =
+          case entity
+          when RailsAdminNext::AbstractModel
+            entity
+          when Class, String
+            RailsAdminNext::AbstractModel.new(entity)
+          when Symbol
+            RailsAdminNext::AbstractModel.new(entity.to_s)
+          else
+            RailsAdminNext::AbstractModel.new(entity.class)
+          end
+
+        @groups = [RailsAdminNext::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 = !RailsAdminNext::AbstractModel.all.collect(&:model_name).include?(abstract_model.try(:model_name))
+      end
+
+      def object_label
+        bindings[:object].send(object_label_method).presence ||
+          bindings[:object].send(:rails_admin_default_object_label_method)
+      end
+
+      # The display for a model instance (i.e. a single database record).
+      # Unless configured in a model config block, it'll try to use :name followed by :title methods, then
+      # any methods that may have been added to the label_methods array via Configuration.
+      # Failing all of these, it'll return the class name followed by the model's id.
+      register_instance_option :object_label_method do
+        @object_label_method ||= Config.label_methods.detect { |method| (@dummy_object ||= abstract_model.model.new).respond_to? method } || :rails_admin_default_object_label_method
+      end
+
+      register_instance_option :label do
+        (@label ||= {})[::I18n.locale] ||= abstract_model.model.model_name.human
+      end
+
+      register_instance_option :label_plural do
+        (@label_plural ||= {})[::I18n.locale] ||= abstract_model.model.model_name.human(count: Float::INFINITY, default: label.pluralize(::I18n.locale))
+      end
+
+      def pluralize(count)
+        (count == 1) ? label : label_plural
+      end
+
+      register_instance_option :weight do
+        0
+      end
+
+      # parent node in navigation/breadcrumb
+      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
+        end
+      end
+
+      register_instance_option :navigation_label do
+        @navigation_label ||=
+          if (parent_module = abstract_model.model.try(:module_parent) || abstract_model.model.try!(:parent)) != Object
+            parent_module.to_s
+          end
+      end
+
+      # Logical icon name (see RailsAdminNext::Icons::GLYPHS) rendered as inline SVG
+      # next to the model in the sidebar; nil for no icon.
+      register_instance_option :navigation_icon do
+        nil
+      end
+
+      register_instance_option :scope do
+        abstract_model.scoped
+      end
+
+      register_instance_option :last_created_at do
+        abstract_model.model.last.try(:created_at) if abstract_model.properties.detect { |c| c.name == :created_at }
+      end
+
+      # Act as a proxy for the base section configuration that actually
+      # store the configurations.
+      def method_missing(method_name, *, &)
+        send(:base).send(method_name, *, &)
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        send(:base).respond_to?(method_name, include_private) || super
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module RailsAdminNext
+  module Config
+    module Proxyable
+      class Proxy < BasicObject
+        def initialize(object, bindings = {})
+          @object = object
+          @bindings = bindings
+        end
+
+        # Bind variables to be used by the configuration options
+        def bind(key, value = nil)
+          if key.is_a?(::Hash)
+            @bindings = key
+          else
+            @bindings[key] = value
+          end
+          self
+        end
+
+        # Transparent proxy: `Proxy < BasicObject` has no `respond_to?`, so
+        # `respond_to_missing?` would be dead code (nothing ever calls it) — a
+        # bare `proxy.respond_to?(:x)` is itself delegated through method_missing.
+        def method_missing(method_name, *, &) # standard:disable Style/MissingRespondToMissing
+          if @object.respond_to?(method_name)
+            reset = @object.bindings
+            begin
+              @object.bindings = @bindings
+              response = @object.__send__(method_name, *, &)
+            ensure
+              @object.bindings = reset
+            end
+            response
+          else
+            super
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails_admin_next/config/proxyable.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "rails_admin_next/config/proxyable/proxy"
+module RailsAdminNext
+  module Config
+    module Proxyable
+      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 = {})
+        RailsAdminNext::Config::Proxyable::Proxy.new(self, bindings)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "rails_admin_next/config/proxyable"
+require "rails_admin_next/config/configurable"
+require "rails_admin_next/config/inspectable"
+require "rails_admin_next/config/has_fields"
+require "rails_admin_next/config/has_groups"
+require "rails_admin_next/config/has_description"
+
+module RailsAdminNext
+  module Config
+    module Sections
+      # Configuration of the show view for a new object
+      class Base
+        include RailsAdminNext::Config::Proxyable
+        include RailsAdminNext::Config::Configurable
+        include RailsAdminNext::Config::Inspectable
+
+        include RailsAdminNext::Config::HasFields
+        include RailsAdminNext::Config::HasGroups
+        include RailsAdminNext::Config::HasDescription
+
+        attr_reader :abstract_model, :parent, :root
+
+        NAMED_INSTANCE_VARIABLES = %i[@parent @root @abstract_model].freeze
+
+        def initialize(parent)
+          @parent = parent
+          @root = parent.root
+
+          @abstract_model = root.abstract_model
+        end
+      end
+    end
+  end
+end

data/lib/rails_admin_next/config/sections/create.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "rails_admin_next/config/sections/edit"
+
+module RailsAdminNext
+  module Config
+    module Sections
+      # Configuration of the edit view for a new object
+      class Create < RailsAdminNext::Config::Sections::Edit
+      end
+    end
+  end
+end

data/lib/rails_admin_next/config/sections/edit.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "rails_admin_next/config/sections/base"
+
+module RailsAdminNext
+  module Config
+    module Sections
+      # Configuration of the edit view for an existing object
+      class Edit < RailsAdminNext::Config::Sections::Base
+      end
+    end
+  end
+end

data/lib/rails_admin_next/config/sections/export.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "rails_admin_next/config/sections/base"
+
+module RailsAdminNext
+  module Config
+    module Sections
+      # Configuration of the navigation view
+      class Export < RailsAdminNext::Config::Sections::Base
+      end
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require "rails_admin_next/config/sections/base"
+
+module RailsAdminNext
+  module Config
+    module Sections
+      # Configuration of the list view
+      class List < RailsAdminNext::Config::Sections::Base
+        register_instance_option :checkboxes? do
+          true
+        end
+
+        register_instance_option :filters do
+          []
+        end
+
+        # Number of items listed per page
+        register_instance_option :items_per_page do
+          RailsAdminNext::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 :search_help do
+          nil
+        end
+
+        register_instance_option :sort_by do
+          parent.abstract_model.primary_key
+        end
+
+        register_instance_option :scopes do
+          []
+        end
+
+        register_instance_option :row_css_class do
+          ""
+        end
+
+        register_deprecated_instance_option :sidescroll do
+          RailsAdminNext.deprecator.warn("The sidescroll configuration option was removed, it is always enabled now.")
+        end
+
+        def fields_for_table
+          visible_fields.partition(&:sticky?).flatten
+        end
+
+        register_deprecated_instance_option :sort_reverse do
+          RailsAdminNext.deprecator.warn("The sort_reverse configuration option is deprecated and has no effect.")
+        end
+      end
+    end
+  end
+end

data/lib/rails_admin_next/config/sections/modal.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "rails_admin_next/config/sections/edit"
+
+module RailsAdminNext
+  module Config
+    module Sections
+      class Modal < RailsAdminNext::Config::Sections::Edit
+      end
+    end
+  end
+end

data/lib/rails_admin_next/config/sections/nested.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "rails_admin_next/config/sections/edit"
+
+module RailsAdminNext
+  module Config
+    module Sections
+      class Nested < RailsAdminNext::Config::Sections::Edit
+      end
+    end
+  end
+end

data/lib/rails_admin_next/config/sections/show.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "rails_admin_next/config/sections/base"
+
+module RailsAdminNext
+  module Config
+    module Sections
+      class Show < RailsAdminNext::Config::Sections::Base
+      end
+    end
+  end
+end

data/lib/rails_admin_next/config/sections/update.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "rails_admin_next/config/sections/edit"
+
+module RailsAdminNext
+  module Config
+    module Sections
+      class Update < RailsAdminNext::Config::Sections::Edit
+      end
+    end
+  end
+end

data/lib/rails_admin_next/config/sections.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/string/inflections"
+require "rails_admin_next/config/sections/base"
+require "rails_admin_next/config/sections/edit"
+require "rails_admin_next/config/sections/update"
+require "rails_admin_next/config/sections/create"
+require "rails_admin_next/config/sections/nested"
+require "rails_admin_next/config/sections/modal"
+require "rails_admin_next/config/sections/list"
+require "rails_admin_next/config/sections/export"
+require "rails_admin_next/config/sections/show"
+
+module RailsAdminNext
+  module Config
+    # Sections describe different views in the RailsAdminNext engine. Configurable sections are
+    # list and navigation.
+    #
+    # Each section's class object can store generic configuration about that section (such as the
+    # number of visible tabs in the main navigation), while the instances (accessed via model
+    # configuration objects) store model specific configuration (such as the visibility of the
+    # model).
+    module Sections
+      def self.included(klass)
+        # Register accessors for all the sections in this namespace
+        constants.each do |name|
+          section = RailsAdminNext::Config::Sections.const_get(name)
+          name = name.to_s.underscore.to_sym
+          klass.send(:define_method, name) do |&block|
+            @sections ||= {}
+            @sections[name] = section.new(self) unless @sections[name]
+            @sections[name].instance_eval(&block) if block
+            @sections[name]
+          end
+        end
+      end
+    end
+  end
+end