madmin 1.0.2 → 1.2.2

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
@@ -18,6 +14,10 @@ module Madmin
         model_name.constantize
       end
 
+      def model_find(id)
+        friendly_model? ? model.friendly.find(id) : model.find(id)
+      end
+
       def model_name
         to_s.chomp("Resource").classify
       end
@@ -26,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
@@ -38,21 +59,27 @@ module Madmin
       end
 
       def index_path(options = {})
-        path = "/madmin/#{model.model_name.collection}"
-        path += "?#{options.to_param}" if options.any?
-        path
+        route_name = "madmin_#{model.model_name.plural}_path"
+
+        url_helpers.send(route_name, options)
       end
 
       def new_path
-        "/madmin/#{model.model_name.collection}/new"
+        route_name = "new_madmin_#{model.model_name.singular}_path"
+
+        url_helpers.send(route_name)
       end
 
       def show_path(record)
-        "/madmin/#{model.model_name.collection}/#{record.id}"
+        route_name = "madmin_#{model.model_name.singular}_path"
+
+        url_helpers.send(route_name, record.to_param)
       end
 
       def edit_path(record)
-        "/madmin/#{model.model_name.collection}/#{record.id}/edit"
+        route_name = "edit_madmin_#{model.model_name.singular}_path"
+
+        url_helpers.send(route_name, record.to_param)
       end
 
       def param_key
@@ -60,18 +87,28 @@ 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)
         "#{record.class} ##{record.id}"
       end
 
-      private
+      def friendly_model?
+        model.respond_to? :friendly
+      end
 
-      def field_for_type(name, type)
-        type ||= infer_type(name)
+      def sortable_columns
+        model.column_names
+      end
 
+      def searchable_attributes
+        attributes.values.select { |a| a.field.searchable? }
+      end
+
+      private
+
+      def field_for_type(type)
         {
           binary: Fields::String,
           blob: Fields::Text,
@@ -90,6 +127,7 @@ module Madmin
           text: Fields::Text,
           time: Fields::Time,
           timestamp: Fields::Time,
+          password: Fields::Password,
 
           # Postgres specific types
           bit: Fields::String,
@@ -126,17 +164,9 @@ module Madmin
           polymorphic: Fields::Polymorphic,
           has_many: Fields::HasMany,
           has_one: Fields::HasOne,
-          rich_text: Fields::RichText
+          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)
@@ -157,6 +187,14 @@ module Madmin
           :attachment
         elsif model.reflect_on_association(:"#{name_string}_attachments")
           :attachments
+
+        # 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
 
@@ -171,6 +209,16 @@ module Madmin
           :belongs_to
         end
       end
+
+      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

data/lib/madmin/resource_builder.rb

@@ -0,0 +1,80 @@
+module Madmin
+  class ResourceBuilder
+    attr_reader :model
+
+    def initialize(model)
+      @model = model
+    end
+
+    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
+    end
+
+    def attributes
+      model.attribute_names + virtual_attributes - redundant_attributes
+    end
+
+    def store_accessors
+      model.stored_attributes.values.flatten
+    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
+
+      # ActiveRecord Store columns
+      virtual += store_accessors.map(&:to_s)
+
+      # 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
+    end
+
+    def redundant_attributes
+      redundant = []
+
+      # has_secure_password columns
+      redundant += model.attribute_types.keys.select { |k| k.ends_with?("_digest") }
+
+      # ActiveRecord Store columns
+      store_columns = model.stored_attributes.keys
+      redundant += store_columns.map(&:to_s)
+
+      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
+  end
+end

data/lib/madmin/search.rb

@@ -0,0 +1,60 @@
+# based on Administrate Search: https://github.com/thoughtbot/administrate/blob/main/lib/administrate/search.rb
+
+module Madmin
+  class Search
+    attr_reader :query
+
+    def initialize(scoped_resource, resource, term)
+      @resource = resource
+      @scoped_resource = scoped_resource
+      @query = term
+    end
+
+    def run
+      if query.blank?
+        @scoped_resource.all
+      else
+        search_results(@scoped_resource)
+      end
+    end
+
+    private
+
+    def search_results(resources)
+      resources.where(query_template, *query_values)
+    end
+
+    def query_template
+      search_attributes.map do |attr|
+        table_name = query_table_name(attr)
+        searchable_fields(attr).map do |field|
+          column_name = column_to_query(field)
+          "LOWER(CAST(#{table_name}.#{column_name} AS CHAR(256))) LIKE ?"
+        end.join(" OR ")
+      end.join(" OR ")
+    end
+
+    def searchable_fields(attr)
+      [attr[:name]]
+    end
+
+    def query_values
+      fields_count = search_attributes.sum do |attr|
+        searchable_fields(attr).count
+      end
+      ["%#{@query.mb_chars.downcase}%"] * fields_count
+    end
+
+    def search_attributes
+      @resource.searchable_attributes
+    end
+
+    def query_table_name(attr)
+      ActiveRecord::Base.connection.quote_column_name(@scoped_resource.table_name)
+    end
+
+    def column_to_query(attr)
+      ActiveRecord::Base.connection.quote_column_name(attr)
+    end
+  end
+end

data/lib/madmin/version.rb

@@ -1,3 +1,3 @@
 module Madmin
-  VERSION = "1.0.2"
+  VERSION = "1.2.2"
 end

data/lib/madmin.rb

@@ -6,36 +6,53 @@ module Madmin
   autoload :Field, "madmin/field"
   autoload :GeneratorHelpers, "madmin/generator_helpers"
   autoload :Resource, "madmin/resource"
+  autoload :ResourceBuilder, "madmin/resource_builder"
+  autoload :Search, "madmin/search"
 
   module Fields
+    autoload :Attachment, "madmin/fields/attachment"
+    autoload :Attachments, "madmin/fields/attachments"
+    autoload :BelongsTo, "madmin/fields/belongs_to"
     autoload :Boolean, "madmin/fields/boolean"
-    autoload :Integer, "madmin/fields/integer"
-    autoload :String, "madmin/fields/string"
-    autoload :Text, "madmin/fields/text"
     autoload :Date, "madmin/fields/date"
     autoload :DateTime, "madmin/fields/date_time"
     autoload :Decimal, "madmin/fields/decimal"
-    autoload :Json, "madmin/fields/json"
     autoload :Enum, "madmin/fields/enum"
     autoload :Float, "madmin/fields/float"
-    autoload :Time, "madmin/fields/time"
-    autoload :BelongsTo, "madmin/fields/belongs_to"
-    autoload :Polymorphic, "madmin/fields/polymorphic"
     autoload :HasMany, "madmin/fields/has_many"
     autoload :HasOne, "madmin/fields/has_one"
+    autoload :Integer, "madmin/fields/integer"
+    autoload :Json, "madmin/fields/json"
+    autoload :NestedHasMany, "madmin/fields/nested_has_many"
+    autoload :Password, "madmin/fields/password"
+    autoload :Polymorphic, "madmin/fields/polymorphic"
     autoload :RichText, "madmin/fields/rich_text"
-    autoload :Attachment, "madmin/fields/attachment"
-    autoload :Attachments, "madmin/fields/attachments"
+    autoload :String, "madmin/fields/string"
+    autoload :Text, "madmin/fields/text"
+    autoload :Time, "madmin/fields/time"
   end
 
-  mattr_accessor :resources, default: []
-
   class << self
     def resource_for(object)
-      Rails.application.eager_load!
+      "#{object.class.name}Resource".constantize
+    end
+
+    def resource_by_name(name)
+      "#{name}Resource".constantize
+    end
+
+    def resources
+      @resources ||= resource_names.map(&:constantize)
+    end
+
+    def reset_resources!
+      @resources = nil
+    end
 
-      klass_name = object.class.name
-      Madmin.resources.find { |r| r.model_name == klass_name }
+    def resource_names
+      root = Rails.root.join("app/madmin/resources/")
+      files = Dir.glob(root.join("**/*.rb"))
+      files.sort!.map! { |f| f.split(root.to_s).last.delete_suffix(".rb").classify }
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: madmin
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.2.2
 platform: ruby
 authors:
 - Chris Oliver
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-04 00:00:00.000000000 Z
+date: 2021-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -34,7 +34,7 @@ dependencies:
         version: '3.5'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -44,7 +44,7 @@ dependencies:
         version: '3.5'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
 description: It's an admin, obviously.
 email:
 - excid3@gmail.com
@@ -63,6 +63,8 @@ files:
 - app/controllers/madmin/dashboard_controller.rb
 - app/controllers/madmin/resource_controller.rb
 - app/helpers/madmin/application_helper.rb
+- app/helpers/madmin/nav_helper.rb
+- app/helpers/madmin/sort_helper.rb
 - app/views/layouts/madmin/application.html.erb
 - app/views/madmin/application/_form.html.erb
 - app/views/madmin/application/_javascript.html.erb
@@ -111,6 +113,13 @@ files:
 - app/views/madmin/fields/json/_form.html.erb
 - app/views/madmin/fields/json/_index.html.erb
 - app/views/madmin/fields/json/_show.html.erb
+- app/views/madmin/fields/nested_has_many/_fields.html.erb
+- app/views/madmin/fields/nested_has_many/_form.html.erb
+- app/views/madmin/fields/nested_has_many/_index.html.erb
+- app/views/madmin/fields/nested_has_many/_show.html.erb
+- app/views/madmin/fields/password/_form.html.erb
+- app/views/madmin/fields/password/_index.html.erb
+- app/views/madmin/fields/password/_show.html.erb
 - app/views/madmin/fields/polymorphic/_form.html.erb
 - app/views/madmin/fields/polymorphic/_index.html.erb
 - app/views/madmin/fields/polymorphic/_show.html.erb
@@ -126,14 +135,22 @@ files:
 - app/views/madmin/fields/time/_form.html.erb
 - app/views/madmin/fields/time/_index.html.erb
 - app/views/madmin/fields/time/_show.html.erb
+- app/views/madmin/shared/_label.html.erb
+- lib/generators/madmin/field/field_generator.rb
+- lib/generators/madmin/field/templates/_form.html.erb
+- lib/generators/madmin/field/templates/_index.html.erb
+- lib/generators/madmin/field/templates/_show.html.erb
+- lib/generators/madmin/field/templates/field.rb.tt
 - lib/generators/madmin/install/install_generator.rb
 - lib/generators/madmin/install/templates/controller.rb.tt
+- lib/generators/madmin/install/templates/routes.rb.tt
 - lib/generators/madmin/resource/resource_generator.rb
 - lib/generators/madmin/resource/templates/controller.rb.tt
 - lib/generators/madmin/resource/templates/resource.rb.tt
 - lib/generators/madmin/views/edit_generator.rb
 - lib/generators/madmin/views/form_generator.rb
 - lib/generators/madmin/views/index_generator.rb
+- lib/generators/madmin/views/javascript_generator.rb
 - lib/generators/madmin/views/layout_generator.rb
 - lib/generators/madmin/views/navigation_generator.rb
 - lib/generators/madmin/views/new_generator.rb
@@ -155,6 +172,8 @@ files:
 - lib/madmin/fields/has_one.rb
 - lib/madmin/fields/integer.rb
 - lib/madmin/fields/json.rb
+- lib/madmin/fields/nested_has_many.rb
+- lib/madmin/fields/password.rb
 - lib/madmin/fields/polymorphic.rb
 - lib/madmin/fields/rich_text.rb
 - lib/madmin/fields/string.rb
@@ -163,6 +182,8 @@ files:
 - lib/madmin/generator_helpers.rb
 - lib/madmin/namespace.rb
 - lib/madmin/resource.rb
+- lib/madmin/resource_builder.rb
+- lib/madmin/search.rb
 - lib/madmin/version.rb
 - lib/madmin/view_generator.rb
 - lib/tasks/madmin_tasks.rake
@@ -185,7 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: A modern admin for Ruby on Rails apps