madmin 1.1.0 → 1.2.3

data/app/views/madmin/fields/json/_form.html.erb

@@ -1,2 +1,4 @@
-<%= form.label field.attribute_name, class: "inline-block w-32 flex-shrink-0" %>
+<div class="block md:inline-block md:w-32 flex-shrink-0 text-gray-700">
+  <%= render "madmin/shared/label", form: form, field: field %>
+</div>
 <%= form.text_area field.attribute_name, class: "form-input" %>

data/app/views/madmin/fields/nested_has_many/_fields.html.erb

@@ -1,5 +1,5 @@
-<%= content_tag :div, class: "nested-fields bg-gray-100 rounded-t-xl p-5", data: { new_record: f.object.new_record? } do %>
-  <% field.nested_attributes.each do |nested_attribute| %>
+<%= content_tag :div, class: "nested-fields border border-gray-200 rounded-lg p-5", data: { new_record: f.object.new_record? } do %>
+  <% field.nested_attributes.each do |name, nested_attribute| %>
     <% next if nested_attribute[:field].nil? %>
     <% next unless nested_attribute[:field].visible?(action_name) %>
     <% next unless nested_attribute[:field].visible?(:form) %>
@@ -14,5 +14,4 @@
   <small><%= link_to "Remove", "#", data: { action: "click->nested-form#remove_association" } %></small>
 
   <%= f.hidden_field :_destroy %>
-
 <% end %>

data/app/views/madmin/fields/nested_has_many/_form.html.erb

@@ -1,4 +1,6 @@
-<%= form.label field.attribute_name, class: "inline-block w-32 flex-shrink-0" %>
+<div class="block md:inline-block w-32 flex-shrink-0">
+  <%= render "madmin/shared/label", form: form, field: field %>
+</div>
 
 <div class="container space-y-8" data-controller="nested-form">
   <template data-target="nested-form.template">

data/app/views/madmin/fields/nested_has_many/_show.html.erb

@@ -1,5 +1,5 @@
 <% field.value(record).each do |object| %>
   <div>
-    <%= link_to Madmin.resource_for(object).display_name(object), Madmin.resource_for(object).show_path(object) %>
+    <%= link_to Madmin.resource_for(object).display_name(object), Madmin.resource_for(object).show_path(object), class: "text-indigo-500 underline" %>
   </div>
 <% end %>

data/app/views/madmin/fields/password/_form.html.erb

@@ -1,2 +1,4 @@
-<%= form.label field.attribute_name, class: "inline-block w-32 flex-shrink-0" %>
+<div class="block md:inline-block md:w-32 flex-shrink-0 text-gray-700">
+  <%= render "madmin/shared/label", form: form, field: field %>
+</div>
 <%= form.password_field field.attribute_name, class: "form-input" %>

data/app/views/madmin/fields/polymorphic/_form.html.erb

@@ -1,5 +1,7 @@
 <%= form.fields_for field.attribute_name do |pf| %>
-  <%= pf.label field.attribute_name, class: "inline-block w-32 flex-shrink-0" %>
+  <div class="block md:inline-block md:w-32 flex-shrink-0 text-gray-700">
+    <%= render "madmin/shared/label", form: pf, field: field %>
+  </div>
   <%= pf.select :value, field.options_for_select(record).map(&:to_global_id), { selected: field.value(record)&.to_global_id, prompt: true }, { class: "form-select", data: { controller: "slimselect" } } %>
   <%= pf.hidden_field :type, value: "polymorphic" %>
 <% end %>

data/app/views/madmin/fields/polymorphic/_show.html.erb

@@ -1,3 +1,3 @@
 <% if (object = field.value(record)) %>
-  <%= link_to Madmin.resource_for(object).display_name(object), Madmin.resource_for(object).show_path(object) %>
+  <%= link_to Madmin.resource_for(object).display_name(object), Madmin.resource_for(object).show_path(object), class: "text-indigo-500 underline" %>
 <% end %>

data/app/views/madmin/fields/rich_text/_form.html.erb

@@ -1,4 +1,6 @@
-<%= form.label field.attribute_name, class: "inline-block w-32 flex-shrink-0" %>
+<div class="block md:inline-block md:w-32 flex-shrink-0 text-gray-700">
+  <%= render "madmin/shared/label", form: form, field: field %>
+</div>
 <div class="flex-1">
   <%= form.rich_text_area field.attribute_name, class: "form-input block" %>
 </div>

data/app/views/madmin/fields/string/_form.html.erb

@@ -1,2 +1,4 @@
-<%= form.label field.attribute_name, class: "inline-block w-32 flex-shrink-0" %>
+<div class="block md:inline-block md:w-32 flex-shrink-0 text-gray-700">
+  <%= render "madmin/shared/label", form: form, field: field %>
+</div>
 <%= form.text_field field.attribute_name, class: "form-input" %>

data/app/views/madmin/fields/text/_form.html.erb

@@ -1,2 +1,4 @@
-<%= form.label field.attribute_name, class: "inline-block w-32 flex-shrink-0" %>
+<div class="block md:inline-block md:w-32 flex-shrink-0 text-gray-700">
+  <%= render "madmin/shared/label", form: form, field: field %>
+</div>
 <%= form.text_area field.attribute_name, class: "form-input" %>

data/app/views/madmin/fields/time/_form.html.erb

@@ -1,2 +1,4 @@
-<%= form.label field.attribute_name, class: "inline-block w-32 flex-shrink-0" %>
+<div class="block md:inline-block md:w-32 flex-shrink-0 text-gray-700">
+  <%= render "madmin/shared/label", form: form, field: field %>
+</div>
 <%= form.time_select field.attribute_name, {}, { class: "form-select" } %>

data/app/views/madmin/shared/_label.html.erb

@@ -0,0 +1,4 @@
+<%= form.label field.attribute_name %>
+<% if field.required? %>
+  <span class="text-red-500">*</span>
+<% end %>

data/lib/generators/madmin/field/field_generator.rb

@@ -0,0 +1,31 @@
+module Madmin
+  module Generators
+    class FieldGenerator < Rails::Generators::NamedBase
+      include Madmin::GeneratorHelpers
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def eager_load
+        Rails.application.eager_load!
+      end
+
+      def generate_field
+        template "field.rb", "app/madmin/fields/#{file_path}_field.rb"
+        copy_resource_template "_form"
+        copy_resource_template "_index"
+        copy_resource_template "_show"
+      end
+
+      private
+
+      def copy_resource_template(template_name)
+        template_file = "#{template_name}.html.erb"
+
+        copy_file(
+          template_file,
+          "app/views/madmin/fields/#{file_path}_field/#{template_file}"
+        )
+      end
+    end
+  end
+end

data/lib/generators/madmin/field/templates/_form.html.erb

@@ -0,0 +1,2 @@
+<%= form.label field.attribute_name, class: "inline-block w-32 flex-shrink-0" %>
+<%= form.text_field field.attribute_name, class: "form-input" %>

data/lib/generators/madmin/field/templates/_index.html.erb

@@ -0,0 +1 @@
+<%= field.value(record) %>

data/lib/generators/madmin/field/templates/_show.html.erb

@@ -0,0 +1 @@
+<%= field.value(record) %>

data/lib/generators/madmin/field/templates/field.rb.tt

@@ -0,0 +1,26 @@
+class <%= class_name %>Field < Madmin::Field
+  # def value(record)
+  #   record.public_send(attribute_name)
+  # end
+
+  # def to_partial_path(name)
+  #   unless %w[index show form].include? name
+  #     raise ArgumentError, "`partial` must be 'index', 'show', or 'form'"
+  #  end
+  #
+  #   "/madmin/fields/#{self.class.field_type}/#{name}"
+  # end
+
+  # def to_param
+  #   attribute_name
+  # end
+
+  # # Used for checking visibility of attribute on an view
+  # def visible?(action, default: true)
+  #   options.fetch(action.to_sym, default)
+  # end
+
+  # def required?
+  #   model.validators_on(attribute_name).any? { |v| v.is_a? ActiveModel::Validations::PresenceValidator }
+  # end
+end

data/lib/generators/madmin/install/install_generator.rb

@@ -16,8 +16,13 @@ module Madmin
       end
 
       def generate_routes
+        if rails6_1_and_up?
+          route "draw :madmin", file: ROUTES_FILE[:default]
+          template("routes.rb.tt", "config/routes/madmin.rb")
+        end
+
         if route_namespace_exists?
-          route "root to: \"dashboard#show\"", indentation: 4, sentinel: /namespace :madmin do\s*\n/m
+          route "root to: \"dashboard#show\"", indentation: separated_routes_file? ? 2 : 4, sentinel: /namespace :madmin do\s*\n/m
         else
           route "root to: \"dashboard#show\"", namespace: [:madmin]
         end

data/lib/generators/madmin/install/templates/routes.rb.tt

@@ -0,0 +1,3 @@
+# Below are the routes for madmin
+namespace :madmin do
+end

data/lib/generators/madmin/resource/resource_generator.rb

@@ -20,7 +20,7 @@ module Madmin
 
       def generate_route
         if route_namespace_exists?
-          route "resources :#{plural_name}", namespace: class_path, indentation: 4, sentinel: /namespace :madmin do\s*\n/m
+          route "resources :#{plural_name}", namespace: class_path, indentation: separated_routes_file? ? 2 : 4, sentinel: /namespace :madmin do\s*\n/m
         else
           route "resources :#{plural_name}", namespace: [:madmin] + class_path
         end
@@ -28,69 +28,19 @@ module Madmin
 
       private
 
-      def associations
-        model.reflections.reject { |name, association|
-          # Hide these special associations
-          name.starts_with?("rich_text") ||
-            name.ends_with?("_attachment") ||
-            name.ends_with?("_attachments") ||
-            name.ends_with?("_blob") ||
-            name.ends_with?("_blobs")
-        }.keys
+      def model
+        @model ||= class_name.constantize
       end
 
-      def attributes
-        model.attribute_names + virtual_attributes - redundant_attributes
+      def resource_builder
+        @resource_builder ||= ResourceBuilder.new(model)
       end
 
-      def virtual_attributes
-        virtual = []
-
-        # has_secure_password columns
-        password_attributes = model.attribute_types.keys.select { |k| k.ends_with?("_digest") }.map { |k| k.delete_suffix("_digest") }
-        virtual += password_attributes.map { |attr| [attr, "#{attr}_confirmation"] }.flatten
-
-        # Add virtual attributes for ActionText and ActiveStorage
-        model.reflections.each do |name, association|
-          if name.starts_with?("rich_text")
-            virtual << name.split("rich_text_").last
-          elsif name.ends_with?("_attachment")
-            virtual << name.split("_attachment").first
-          elsif name.ends_with?("_attachments")
-            virtual << name.split("_attachments").first
-          end
-        end
-
-        virtual
+      def model_attributes
+        resource_builder.attributes
       end
 
-      def redundant_attributes
-        redundant = []
-
-        # has_secure_password columns
-        redundant += model.attribute_types.keys.select { |k| k.ends_with?("_digest") }
-
-        model.reflections.each do |name, association|
-          if association.has_one?
-            next
-          elsif association.collection?
-            next
-          elsif association.polymorphic?
-            redundant << "#{name}_id"
-            redundant << "#{name}_type"
-          elsif name.starts_with?("rich_text")
-            redundant << name
-          else # belongs to
-            redundant << "#{name}_id"
-          end
-        end
-
-        redundant
-      end
-
-      def model
-        @model ||= class_name.constantize
-      end
+      delegate :associations, :virtual_attributes, :store_accessors, to: :resource_builder
 
       def formatted_options_for_attribute(name)
         options = options_for_attribute(name)
@@ -114,7 +64,7 @@ module Madmin
           {form: false}
 
         # Attributes without a database column
-        elsif !model.column_names.include?(name)
+        elsif !model.column_names.include?(name) && !store_accessors.map(&:to_s).include?(name)
           {index: false}
         end
       end

data/lib/generators/madmin/resource/templates/controller.rb.tt

@@ -1,4 +1,10 @@
 module Madmin
   class <%= class_name.pluralize %>Controller < Madmin::ResourceController
+<% if class_name == "ActiveStorage::Blob" -%>
+    def new
+      super
+      @record.assign_attributes(filename: "")
+    end
+<% end -%>
   end
 end

data/lib/generators/madmin/resource/templates/resource.rb.tt

@@ -1,6 +1,6 @@
 class <%= class_name %>Resource < Madmin::Resource
   # Attributes
-<% attributes.each do |attribute_name| -%>
+<% model_attributes.each do |attribute_name| -%>
   attribute :<%= attribute_name %><%= formatted_options_for_attribute(attribute_name) %>
 <% end -%>
 
@@ -13,4 +13,13 @@ class <%= class_name %>Resource < Madmin::Resource
   # def self.display_name(record)
   #   record.name
   # end
+
+  # Uncomment this to customize the default sort column and direction.
+  # def self.default_sort_column
+  #   "created_at"
+  # end
+  #
+  # def self.default_sort_direction
+  #   "desc"
+  # end
 end

data/lib/madmin/engine.rb

@@ -1,12 +1,12 @@
 module Madmin
   class Engine < ::Rails::Engine
-    initializer "madmin.autoload", before: :set_autoload_paths do |app|
-      app.config.paths.add "app/madmin/resources", eager_load: true
-      app.config.paths.add "app/madmin/fields", eager_load: true
+    config.before_configuration do |app|
+      app.config.autoload_paths << File.expand_path("app/madmin/resources", Rails.root)
+      app.config.autoload_paths << File.expand_path("app/madmin/fields", Rails.root)
     end
 
     config.to_prepare do
-      Madmin.resources = []
+      Madmin.reset_resources!
     end
   end
 end

data/lib/madmin/field.rb

@@ -36,5 +36,9 @@ module Madmin
     def required?
       model.validators_on(attribute_name).any? { |v| v.is_a? ActiveModel::Validations::PresenceValidator }
     end
+
+    def searchable?
+      false
+    end
   end
 end

data/lib/madmin/fields/belongs_to.rb

@@ -2,18 +2,21 @@ module Madmin
   module Fields
     class BelongsTo < Field
       def options_for_select(record)
-        association = record.class.reflect_on_association(attribute_name)
-        klass = association.klass
-        resource = nil
-        klass.all.map do |r|
-          resource ||= Madmin.resource_for(r)
-          [resource.display_name(r), r.id]
+        if (record = record.send(attribute_name))
+          resource = Madmin.resource_for(record)
+          [[resource.display_name(record), record.id]]
+        else
+          []
         end
       end
 
       def to_param
         "#{attribute_name}_id"
       end
+
+      def index_path
+        Madmin.resource_by_name(model.reflect_on_association(attribute_name).klass).index_path(format: :json)
+      end
     end
   end
 end

data/lib/madmin/fields/has_many.rb

@@ -2,18 +2,22 @@ module Madmin
   module Fields
     class HasMany < Field
       def options_for_select(record)
-        association = record.class.reflect_on_association(attribute_name)
-        klass = association.klass
-        resource = nil
-        klass.all.map do |r|
-          resource ||= Madmin.resource_for(r)
-          [resource.display_name(r), r.id]
+        if (records = record.send(attribute_name))
+          return [] unless records.first
+          resource = Madmin.resource_for(records.first)
+          records.map { |record| [resource.display_name(record), record.id] }
+        else
+          []
         end
       end
 
       def to_param
         {"#{attribute_name.to_s.singularize}_ids".to_sym => []}
       end
+
+      def index_path
+        Madmin.resource_by_name(model.reflect_on_association(attribute_name).klass).index_path(format: :json)
+      end
     end
   end
 end

data/lib/madmin/fields/nested_has_many.rb

@@ -3,7 +3,7 @@ module Madmin
     class NestedHasMany < Field
       DEFAULT_ATTRIBUTES = %w[_destroy id].freeze
       def nested_attributes
-        resource.attributes.reject { |i| skipped_fields.include?(i[:name]) }
+        resource.attributes.reject { |name, attribute| skipped_fields.include?(name) }
       end
 
       def resource

data/lib/madmin/fields/string.rb

@@ -1,6 +1,9 @@
 module Madmin
   module Fields
     class String < Field
+      def searchable?
+        options.fetch(:searchable, model.column_names.include?(attribute_name.to_s))
+      end
     end
   end
 end

data/lib/madmin/fields/text.rb

@@ -1,6 +1,9 @@
 module Madmin
   module Fields
     class Text < Field
+      def searchable?
+        options.fetch(:searchable, model.column_names.include?(attribute_name.to_s))
+      end
     end
   end
 end

data/lib/madmin/generator_helpers.rb

@@ -1,24 +1,30 @@
 module Madmin
   module GeneratorHelpers
+    ROUTES_FILE = {default: "config/routes.rb", separated: "config/routes/madmin.rb"}.freeze
+
     def call_generator(generator, *args)
       Rails::Generators.invoke(generator, args, generator_options)
     end
 
     def route_namespace_exists?
-      File.readlines(Rails.root.join("config/routes.rb")).grep(/namespace :madmin/).size > 0
+      File.readlines(Rails.root.join(default_routes_file)).grep(/namespace :madmin/).size > 0
+    end
+
+    def rails6_1_and_up?
+      Gem.loaded_specs["rails"].version >= Gem::Version.new(6.1)
     end
 
     # Method copied from Rails 6.1 master
-    def route(routing_code, namespace: nil, sentinel: nil, indentation: 2)
+    def route(routing_code, namespace: nil, sentinel: nil, indentation: 2, file: default_routes_file)
       routing_code = Array(namespace).reverse.reduce(routing_code) { |code, ns|
         "namespace :#{ns} do\n#{indent(code, 2)}\nend"
       }
 
       log :route, routing_code
-      sentinel ||= /\.routes\.draw do\s*\n/m
+      sentinel ||= default_sentinel(file)
 
       in_root do
-        inject_into_file "config/routes.rb", optimize_indentation(routing_code, indentation), after: sentinel, verbose: false, force: false
+        inject_into_file file, optimize_indentation(routing_code, indentation), after: sentinel, verbose: false, force: false
       end
     end
 
@@ -30,6 +36,18 @@ module Madmin
 
     private
 
+    def separated_routes_file?
+      default_routes_file.eql?(ROUTES_FILE[:separated])
+    end
+
+    def default_sentinel(file)
+      file.eql?(ROUTES_FILE[:default]) ? /\.routes\.draw do\s*\n/m : /namespace :madmin do\s*\n/m
+    end
+
+    def default_routes_file
+      rails6_1_and_up? ? ROUTES_FILE[:separated] : ROUTES_FILE[:default]
+    end
+
     def generator_options
       {behavior: behavior}
     end

data/lib/madmin/resource.rb

@@ -1,14 +1,10 @@
 module Madmin
   class Resource
-    class_attribute :attributes, default: []
+    class_attribute :attributes, default: ActiveSupport::OrderedHash.new
     class_attribute :scopes, default: []
 
     class << self
       def inherited(base)
-        # Remove any old references
-        Madmin.resources.delete(base)
-        Madmin.resources << base
-
         base.attributes = attributes.dup
         base.scopes = scopes.dup
         super
@@ -30,11 +26,32 @@ module Madmin
         scopes << name
       end
 
+      def get_attribute(name)
+        attributes[name]
+      end
+
       def attribute(name, type = nil, **options)
-        attributes << {
+        type ||= infer_type(name)
+        field = options[:field] || field_for_type(type)
+
+        attributes[name] = OpenStruct.new(
           name: name,
-          field: field_for_type(name, type).new(**options.merge(attribute_name: name, model: model))
-        }
+          type: type,
+          field: field.new(**options.merge(attribute_name: name, model: model))
+        )
+      rescue => e
+        builder = ResourceBuilder.new(model)
+        raise ArgumentError, <<~MESSAGE
+          Madmin couldn't find attribute or association '#{name}' on #{model} model.
+
+          We searched these attributes and associations:
+          #{(builder.attributes + builder.associations).join(", ")}
+
+          This attribute is defined in a Madmin resource at:
+          #{e.backtrace.find { |l| l =~ /_resource.rb/ }}
+
+          Either add the missing attribute or assocation, or remove this line from your Madmin resource.
+        MESSAGE
       end
 
       def friendly_name
@@ -42,7 +59,7 @@ module Madmin
       end
 
       def index_path(options = {})
-        route_name = "madmin_#{model.table_name}_path"
+        route_name = "madmin_#{model.model_name.plural}_path"
 
         url_helpers.send(route_name, options)
       end
@@ -70,7 +87,7 @@ module Madmin
       end
 
       def permitted_params
-        attributes.map { |a| a[:field].to_param }
+        attributes.values.filter_map { |a| a.field.to_param if a.field.visible?(:form) }
       end
 
       def display_name(record)
@@ -81,11 +98,17 @@ module Madmin
         model.respond_to? :friendly
       end
 
-      private
+      def sortable_columns
+        model.column_names
+      end
 
-      def field_for_type(name, type)
-        type ||= infer_type(name)
+      def searchable_attributes
+        attributes.values.select { |a| a.field.searchable? }
+      end
+
+      private
 
+      def field_for_type(type)
         {
           binary: Fields::String,
           blob: Fields::Text,
@@ -144,15 +167,6 @@ module Madmin
           rich_text: Fields::RichText,
           nested_has_many: Fields::NestedHasMany
         }.fetch(type)
-      rescue
-        raise ArgumentError, <<~MESSAGE
-          Couldn't find attribute or association '#{name}' with type '#{type}' on #{model} model
-
-            To fix this, either:
-
-            1. Remove 'attribute #{name}' from app/madmin/resources/#{model.to_s.underscore}_resource.rb
-            2. Or add the missing attribute or association to the #{model} model
-        MESSAGE
       end
 
       def infer_type(name)
@@ -177,6 +191,10 @@ module Madmin
         # has_secure_password
         elsif model.attribute_types.include?("#{name_string}_digest") || name_string.ends_with?("_confirmation")
           :password
+
+          # ActiveRecord Store
+        elsif model_store_accessors.include?(name)
+          :string
         end
       end
 
@@ -195,6 +213,12 @@ module Madmin
       def url_helpers
         @url_helpers ||= Rails.application.routes.url_helpers
       end
+
+      def model_store_accessors
+        store_accessors = model.stored_attributes.values
+
+        store_accessors.flatten
+      end
     end
   end
 end