madmin 1.2.10 → 2.0.0

data/lib/madmin/resource.rb

@@ -1,10 +1,11 @@
-require "ostruct"
-
 module Madmin
   class Resource
+    Attribute = Data.define(:name, :type, :field)
+
     class_attribute :attributes, default: ActiveSupport::OrderedHash.new
     class_attribute :member_actions, default: []
     class_attribute :scopes, default: []
+    class_attribute :menu_options, instance_reader: false
 
     class << self
       def inherited(base)
@@ -14,12 +15,17 @@ module Madmin
         super
       end
 
-      def model
-        @model ||= model_name.constantize
+      def model(value = nil)
+        if value
+          @model = value
+        else
+          @model ||= model_name.constantize
+        end
       end
 
       def model_find(id)
-        friendly_model? ? model.friendly.find(id) : model.find(id)
+        record = friendly_model? ? model.friendly.find(id) : model.find(id)
+        becomes(record)
       end
 
       def model_name
@@ -36,26 +42,36 @@ module Madmin
 
       def attribute(name, type = nil, **options)
         type ||= infer_type(name)
-        field = options[:field] || field_for_type(type)
+        field = options.delete(:field) || field_for_type(type)
 
-        attributes[name] = OpenStruct.new(
-          name: name,
-          type: type,
-          field: field.new(**options.merge(attribute_name: name, model: model, resource: self))
-        )
-      rescue => e
-        builder = ResourceBuilder.new(model)
-        raise ArgumentError, <<~MESSAGE
-          Madmin couldn't find attribute or association '#{name}' on #{model} model.
+        if field.nil?
+          Rails.logger.warn <<~MESSAGE
+            WARNING: Madmin could not infer a field type for `#{name}` attribute. Defaulting to a String type.
+            You can set the type by specifying the type on the attribute:
+
+                attribute :#{name}, :boolean
+          MESSAGE
+          field = Fields::String
+        end
+
+        config = ActiveSupport::OrderedOptions.new.merge(options)
+        yield config if block_given?
 
-          We searched these attributes and associations:
-          #{(builder.attributes + builder.associations).join(", ")}
+        # Form is an alias for new & edit
+        if config.has_key?(:form)
+          config.new = config[:form]
+          config.edit = config[:form]
+        end
 
-          This attribute is defined in a Madmin resource at:
-          #{e.backtrace.find { |l| l =~ /_resource.rb/ }}
+        # New/create and edit/update need to match
+        config.create = config[:create] if config.has_key?(:new)
+        config.update = config[:update] if config.has_key?(:edit)
 
-          Either add the missing attribute or assocation, or remove this line from your Madmin resource.
-        MESSAGE
+        attributes[name] = Attribute.new(
+          name: name,
+          type: type,
+          field: field.new(attribute_name: name, model: model, resource: self, options: config)
+        )
       end
 
       def friendly_name
@@ -81,11 +97,15 @@ module Madmin
       end
 
       def show_path(record)
-        url_helpers.polymorphic_path([:madmin, route_namespace, record])
+        url_helpers.polymorphic_path([:madmin, route_namespace, becomes(record)])
       end
 
       def edit_path(record)
-        url_helpers.polymorphic_path([:madmin, route_namespace, record], action: :edit)
+        url_helpers.polymorphic_path([:madmin, route_namespace, becomes(record)], action: :edit)
+      end
+
+      def becomes(record)
+        record.instance_of?(model) ? record : record.becomes(model)
       end
 
       def param_key
@@ -121,6 +141,7 @@ module Madmin
           binary: Fields::String,
           blob: Fields::Text,
           boolean: Fields::Boolean,
+          currency: Fields::Currency,
           date: Fields::Date,
           datetime: Fields::DateTime,
           decimal: Fields::Decimal,
@@ -131,6 +152,7 @@ module Madmin
           json: Fields::Json,
           jsonb: Fields::Json,
           primary_key: Fields::String,
+          select: Fields::Select,
           string: Fields::String,
           text: Fields::Text,
           time: Fields::Time,
@@ -176,7 +198,7 @@ module Madmin
           has_one: Fields::HasOne,
           rich_text: Fields::RichText,
           nested_has_many: Fields::NestedHasMany
-        }.fetch(type)
+        }[type]
       end
 
       def infer_type(name)
@@ -228,6 +250,16 @@ module Madmin
         store_accessors = model.stored_attributes.values
         store_accessors.flatten
       end
+
+      def menu(options)
+        @menu_options = options
+      end
+
+      def menu_options
+        return false if @menu_options == false
+        @menu_options ||= {}
+        @menu_options.with_defaults(label: friendly_name.pluralize, url: index_path)
+      end
     end
   end
 end

data/lib/madmin/search.rb

@@ -35,7 +35,7 @@ module Madmin
     end
 
     def searchable_fields(attr)
-      [attr[:name]]
+      [attr.name]
     end
 
     def query_values

data/lib/madmin/version.rb

@@ -1,3 +1,3 @@
 module Madmin
-  VERSION = "1.2.10"
+  VERSION = "2.0.0"
 end

data/lib/madmin.rb

@@ -5,6 +5,7 @@ require "pagy"
 module Madmin
   autoload :Field, "madmin/field"
   autoload :GeneratorHelpers, "madmin/generator_helpers"
+  autoload :Menu, "madmin/menu"
   autoload :Resource, "madmin/resource"
   autoload :ResourceBuilder, "madmin/resource_builder"
   autoload :Search, "madmin/search"
@@ -14,6 +15,7 @@ module Madmin
     autoload :Attachments, "madmin/fields/attachments"
     autoload :BelongsTo, "madmin/fields/belongs_to"
     autoload :Boolean, "madmin/fields/boolean"
+    autoload :Currency, "madmin/fields/currency"
     autoload :Date, "madmin/fields/date"
     autoload :DateTime, "madmin/fields/date_time"
     autoload :Decimal, "madmin/fields/decimal"
@@ -28,14 +30,32 @@ module Madmin
     autoload :Password, "madmin/fields/password"
     autoload :Polymorphic, "madmin/fields/polymorphic"
     autoload :RichText, "madmin/fields/rich_text"
+    autoload :Select, "madmin/fields/select"
     autoload :String, "madmin/fields/string"
     autoload :Text, "madmin/fields/text"
     autoload :Time, "madmin/fields/time"
   end
 
+  mattr_accessor :importmap, default: Importmap::Map.new
+  mattr_accessor :menu, default: Menu.new
+  mattr_accessor :site_name
+
   class << self
     def resource_for(object)
-      "#{object.class.name}Resource".constantize
+      if object.is_a? ::ActiveStorage::Attached
+        "ActiveStorage::AttachmentResource".constantize
+      else
+        begin
+          "#{object.class.name}Resource".constantize
+        rescue
+          # For STI models, see if there's a superclass resource available
+          if (column = object.class.inheritance_column) && object.class.column_names.include?(column)
+            "#{object.class.superclass.base_class.name}Resource".constantize
+          else
+            raise
+          end
+        end
+      end
     end
 
     def resource_by_name(name)
@@ -48,6 +68,7 @@ module Madmin
 
     def reset_resources!
       @resources = nil
+      menu.reset
     end
 
     def resource_names

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: madmin
 version: !ruby/object:Gem::Version
-  version: 1.2.10
+  version: 2.0.0
 platform: ruby
 authors:
 - Chris Oliver
 - Andrea Fomera
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-02 00:00:00.000000000 Z
+date: 2024-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.3
+        version: 7.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.3
+        version: 7.0.0
 - !ruby/object:Gem::Dependency
   name: pagy
   requirement: !ruby/object:Gem::Requirement
@@ -39,6 +39,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: importmap-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: propshaft
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: It's an admin, obviously.
 email:
 - excid3@gmail.com
@@ -50,9 +78,15 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- app/assets/config/manifest.js
-- app/assets/stylesheets/actiontext.scss
-- app/assets/stylesheets/application.css
+- app/assets/config/madmin_manifest.js
+- app/assets/stylesheets/madmin/actiontext.css
+- app/assets/stylesheets/madmin/application.css
+- app/assets/stylesheets/madmin/buttons.css
+- app/assets/stylesheets/madmin/forms.css
+- app/assets/stylesheets/madmin/pagination.css
+- app/assets/stylesheets/madmin/reset.css
+- app/assets/stylesheets/madmin/sidebar.css
+- app/assets/stylesheets/madmin/tables.css
 - app/controllers/madmin/application_controller.rb
 - app/controllers/madmin/base_controller.rb
 - app/controllers/madmin/dashboard_controller.rb
@@ -60,10 +94,14 @@ files:
 - app/helpers/madmin/application_helper.rb
 - app/helpers/madmin/nav_helper.rb
 - app/helpers/madmin/sort_helper.rb
+- app/javascript/madmin/application.js
+- app/javascript/madmin/controllers/application.js
+- app/javascript/madmin/controllers/index.js
+- app/javascript/madmin/controllers/nested_form_controller.js
+- app/javascript/madmin/controllers/select_controller.js
 - app/views/layouts/madmin/application.html.erb
 - app/views/madmin/application/_form.html.erb
 - app/views/madmin/application/_javascript.html.erb
-- app/views/madmin/application/_menu_resources.html.erb
 - app/views/madmin/application/_navigation.html.erb
 - app/views/madmin/application/edit.html.erb
 - app/views/madmin/application/index.html.erb
@@ -82,6 +120,9 @@ files:
 - app/views/madmin/fields/boolean/_form.html.erb
 - app/views/madmin/fields/boolean/_index.html.erb
 - app/views/madmin/fields/boolean/_show.html.erb
+- app/views/madmin/fields/currency/_form.html.erb
+- app/views/madmin/fields/currency/_index.html.erb
+- app/views/madmin/fields/currency/_show.html.erb
 - app/views/madmin/fields/date/_form.html.erb
 - app/views/madmin/fields/date/_index.html.erb
 - app/views/madmin/fields/date/_show.html.erb
@@ -125,6 +166,9 @@ files:
 - app/views/madmin/fields/rich_text/_form.html.erb
 - app/views/madmin/fields/rich_text/_index.html.erb
 - app/views/madmin/fields/rich_text/_show.html.erb
+- app/views/madmin/fields/select/_form.html.erb
+- app/views/madmin/fields/select/_index.html.erb
+- app/views/madmin/fields/select/_show.html.erb
 - app/views/madmin/fields/string/_form.html.erb
 - app/views/madmin/fields/string/_index.html.erb
 - app/views/madmin/fields/string/_show.html.erb
@@ -135,6 +179,7 @@ files:
 - app/views/madmin/fields/time/_index.html.erb
 - app/views/madmin/fields/time/_show.html.erb
 - app/views/madmin/shared/_label.html.erb
+- config/importmap.rb
 - lib/generators/madmin/field/field_generator.rb
 - lib/generators/madmin/field/templates/_form.html.erb
 - lib/generators/madmin/field/templates/_index.html.erb
@@ -162,6 +207,7 @@ files:
 - lib/madmin/fields/attachments.rb
 - lib/madmin/fields/belongs_to.rb
 - lib/madmin/fields/boolean.rb
+- lib/madmin/fields/currency.rb
 - lib/madmin/fields/date.rb
 - lib/madmin/fields/date_time.rb
 - lib/madmin/fields/decimal.rb
@@ -176,10 +222,12 @@ files:
 - lib/madmin/fields/password.rb
 - lib/madmin/fields/polymorphic.rb
 - lib/madmin/fields/rich_text.rb
+- lib/madmin/fields/select.rb
 - lib/madmin/fields/string.rb
 - lib/madmin/fields/text.rb
 - lib/madmin/fields/time.rb
 - lib/madmin/generator_helpers.rb
+- lib/madmin/menu.rb
 - lib/madmin/namespace.rb
 - lib/madmin/resource.rb
 - lib/madmin/resource_builder.rb
@@ -191,7 +239,7 @@ homepage: https://github.com/excid3/madmin
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -199,15 +247,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key: 
+rubygems_version: 3.5.23
+signing_key:
 specification_version: 4
 summary: A modern admin for Ruby on Rails apps
 test_files: []

data/app/assets/config/manifest.js

@@ -1,2 +0,0 @@
-//= link_tree ../images
-//= link_directory ../stylesheets .css

data/app/assets/stylesheets/actiontext.scss

@@ -1,36 +0,0 @@
-//
-// Provides a drop-in pointer for the default Trix stylesheet that will format the toolbar and
-// the trix-editor content (whether displayed or under editing). Feel free to incorporate this
-// inclusion directly in any other asset bundle and remove this file.
-//
-//= require trix/dist/trix
-
-// We need to override trix.css’s image gallery styles to accommodate the
-// <action-text-attachment> element we wrap around attachments. Otherwise,
-// images in galleries will be squished by the max-width: 33%; rule.
-.trix-content {
-  .attachment-gallery {
-    > action-text-attachment,
-    > .attachment {
-      flex: 1 0 33%;
-      padding: 0 0.5em;
-      max-width: 33%;
-    }
-
-    &.attachment-gallery--2,
-    &.attachment-gallery--4 {
-      > action-text-attachment,
-      > .attachment {
-        flex-basis: 50%;
-        max-width: 50%;
-      }
-    }
-  }
-
-  action-text-attachment {
-    .attachment {
-      padding: 0 !important;
-      max-width: 100% !important;
-    }
-  }
-}

data/app/assets/stylesheets/application.css

@@ -1,15 +0,0 @@
-/*
- * This is a manifest file that'll be compiled into application.css, which will include all the files
- * listed below.
- *
- * Any CSS and SCSS file within this directory, lib/assets/stylesheets, or any plugin's
- * vendor/assets/stylesheets directory can be referenced here using a relative path.
- *
- * You're free to add application-wide styles to this file and they'll appear at the bottom of the
- * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
- * files in this directory. Styles in this file should be added after the last require_* statement.
- * It is generally better to create a new file per style scope.
- *
- *= require_tree .
- *= require_self
- */

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

@@ -1,7 +0,0 @@
-<% Madmin.resources.each do |resource| %>
-  <%= nav_link_to resource.friendly_name.pluralize, resource.index_path, class: "block p-2 rounded hover:bg-gray-100", starts_with: resource.index_path, active_class: "font-bold text-black" %>
-<% end %>
-
-<div class="mt-auto">
-  <%= link_to "View Madmin on GitHub", "https://github.com/excid3/madmin", target: :_blank, class: "block p-2 rounded text-gray-500 hover:bg-gray-100" %>
-</div>