madmin 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f3bd8e986e4859620b06401c531dc24ca84bb02e4e2284a34918b5a088c126c
-  data.tar.gz: 9bf59b4f93849feda832005caa748e02b4227ea2552cd6e94264d3b7d170f5a9
+  metadata.gz: '05151328dcf6fdd8c23755a1b1f3f14b9dcceadc8215e6f102e133d915e95be6'
+  data.tar.gz: 305bf51253018fa0c871d0314e9ecd69339c510160cdacf1439c2fd361a95a97
 SHA512:
-  metadata.gz: 3181e8f05aad7af36b905a4a04ffb2ddd63419b347e699b0b9ea6d8d2fb9a880f12ebbd7b12d05770e02dc7508e4789a1cb8250b11b6eed26878b6ef71d7fc1b
-  data.tar.gz: '0019a725b02cde9e007190917381da718a139662d1d9094a0e49ccc69b799437865a4170658b99492947ce1d6d2ae04f71dde97886212a8dd728c3a9aa2275f3'
+  metadata.gz: 625d77d1c5ee5bd30462c2609a8b53b7c5d321fb97e0951a95b852eca019189d468c596fcda77e170ed996bd25707feea787a3668faf318a542a65f03d75e488
+  data.tar.gz: b594b3c324289e44dbdeb3f0acc70a532b391f8c46faa4854ea5654e9dfe648c88062e24c29433bb476165134a0d79fdbbca526000bbf6c148e9c2c28777f0ed

data/app/views/layouts/madmin/application.html.erb

@@ -19,7 +19,7 @@
       <div id="sidebar" class="md:w-64 p-4 flex-shrink-0 border-r">
         <%= render "navigation" -%>
       </div>
-      <main class="flex-grow p-4" role="main">
+      <main class="flex-grow p-4 overflow-x-scroll" role="main">
         <%#= render "flashes" -%>
         <%= yield %>
       </main>

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

@@ -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/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 -%>
 

data/lib/madmin/engine.rb

@@ -1,8 +1,8 @@
 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

data/lib/madmin/resource.rb

@@ -39,6 +39,19 @@ module Madmin
           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
@@ -154,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)
@@ -187,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
 
@@ -205,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

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/version.rb

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

data/lib/madmin.rb

@@ -6,6 +6,7 @@ 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: madmin
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Chris Oliver
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-09 00:00:00.000000000 Z
+date: 2021-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -182,6 +182,7 @@ 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