madmin 1.2.1 → 1.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f3bd8e986e4859620b06401c531dc24ca84bb02e4e2284a34918b5a088c126c
-  data.tar.gz: 9bf59b4f93849feda832005caa748e02b4227ea2552cd6e94264d3b7d170f5a9
+  metadata.gz: ea857d0e707bca79172d1bcbecb72cfb939724279ab3f2c08546ff279fd38d03
+  data.tar.gz: c886c8ad0c5d0a11c81f1aecf45463e29205e9bf29dfe00fae4fc94466988ee0
 SHA512:
-  metadata.gz: 3181e8f05aad7af36b905a4a04ffb2ddd63419b347e699b0b9ea6d8d2fb9a880f12ebbd7b12d05770e02dc7508e4789a1cb8250b11b6eed26878b6ef71d7fc1b
-  data.tar.gz: '0019a725b02cde9e007190917381da718a139662d1d9094a0e49ccc69b799437865a4170658b99492947ce1d6d2ae04f71dde97886212a8dd728c3a9aa2275f3'
+  metadata.gz: 65e7522be423638030455299a70bfdd21cc706e75a5b6624f7a41f869250517474b00dd514551914e86bb3b7e7dac31aa812826461a634649caba8456b73f5c8
+  data.tar.gz: faea74829b0c7e307960dcbe006986f51c064e147c00b17f1234bfc6b72246511c1d206d4891fd773f3f97ea05b96a87dbcdd3e9b709aac1141407a580529b26

data/app/controllers/madmin/application_controller.rb

@@ -0,0 +1,22 @@
+module Madmin
+  class ApplicationController < Madmin::BaseController
+    before_action :authenticate_admin_user
+
+    def authenticate_admin_user
+      # TODO: Add your authentication logic here
+
+      # For example, we could redirect if the user isn't an admin
+      # redirect_to "/", alert: "Not authorized." unless user_signed_in? && current_user.admin?
+    end
+
+    # Authenticate with Clearance
+    # include Clearance::Controller
+    # before_action :require_login
+
+    # Authenticate with Devise
+    # before_action :authenticate_user!
+
+    # Authenticate with Basic Auth
+    # http_basic_authenticate_with(name: Rails.application.credentials.admin_username, password: Rails.application.credentials.admin_password)
+  end
+end

data/app/controllers/madmin/resource_controller.rb

@@ -1,5 +1,5 @@
 module Madmin
-  class ResourceController < ApplicationController
+  class ResourceController < Madmin::ApplicationController
     include SortHelper
 
     before_action :set_record, except: [:index, :new, :create]

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/app/views/madmin/application/_javascript.html.erb

@@ -3,7 +3,7 @@
 <%= stylesheet_link_tag "https://unpkg.com/tom-select/dist/css/tom-select.min.css", "data-turbo-track": "reload" %>
 
 <script type="module">
-  import { Application, Controller } from 'https://cdn.skypack.dev/stimulus'
+  import { Application, Controller } from 'https://cdn.skypack.dev/@hotwired/stimulus'
   const application = Application.start()
 
   import { Dropdown } from "https://cdn.skypack.dev/tailwindcss-stimulus-components"

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

@@ -27,33 +27,36 @@
     <%= link_to scope.to_s.humanize, resource.index_path(scope: scope), class: class_names("p-2 rounded", {"bg-gray-100" => params[:scope] == scope.to_s}) %>
   <% end %>
 </div>
-
-<table class="min-w-full divide-y divide-gray-200">
-  <thead>
-    <tr class="border-b border-gray-200">
-      <% resource.attributes.values.each do |attribute| %>
-        <% next if attribute.field.nil? %>
-        <% next unless attribute.field.visible?(action_name) %>
-
-        <th class="py-2 px-4 text-left text-xs text-gray-500 font-medium uppercase whitespace-nowrap"><%= sortable attribute.name, attribute.name.to_s.titleize %></th>
-      <% end %>
-      <th class="py-2 px-4 text-left text-xs text-gray-500 font-medium uppercase">Actions</th>
-    </tr>
-  </thead>
-
-  <tbody class="text-sm divide-y">
-    <% @records.each do |record| %>
-      <tr>
+<div class="min-w-full max-w-xl overflow-x-auto pb-4">
+  <table class="min-w-full divide-y divide-gray-200">
+    <thead>
+      <tr class="border-b border-gray-200">
         <% resource.attributes.values.each do |attribute| %>
           <% next if attribute.field.nil? %>
           <% next unless attribute.field.visible?(action_name) %>
-          <td class="px-4 py-2"><%= render partial: attribute.field.to_partial_path("index"), locals: { field: attribute.field, record: record } %></td>
-        <% end %>
 
-        <td class="px-4 py-2 text-center"><%= link_to "View", resource.show_path(record), class: "text-indigo-500" %></td>
+          <th class="py-2 px-4 text-left text-xs text-gray-500 font-medium uppercase whitespace-nowrap"><%= sortable attribute.name, attribute.name.to_s.titleize %></th>
+        <% end %>
+        <th class="py-2 px-4 text-left text-xs text-gray-500 font-medium uppercase">Actions</th>
       </tr>
-    <% end %>
-  </tbody>
-</table>
-
+    </thead>
+
+    <tbody class="text-sm divide-y">
+      <% @records.each do |record| %>
+        <tr>
+          <% resource.attributes.values.each do |attribute| %>
+            <% next if attribute.field.nil? %>
+            <% next unless attribute.field.visible?(action_name) %>
+            <td class="px-4 py-2"><%= render partial: attribute.field.to_partial_path("index"), locals: { field: attribute.field, record: record, resource: resource } %></td>
+          <% end %>
+
+          <td class="px-4 py-2 text-center">
+            <%= link_to "View", resource.show_path(record), class: "text-indigo-500" %>
+            <%= link_to "Edit", resource.edit_path(record), class: "text-indigo-500" %>
+          </td>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+</div>
 <%== pagy_nav(@pagy) if @pagy.pages > 1 %>

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

@@ -24,7 +24,7 @@
       </div>
 
       <div class="md:col-span-3">
-        <%= render partial: attribute.field.to_partial_path("show"), locals: { field: attribute.field, record: @record } %>
+        <%= render partial: attribute.field.to_partial_path("show"), locals: { field: attribute.field, record: @record, resource: resource } %>
       </div>
     </div>
   <% end %>

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

@@ -0,0 +1,4 @@
+<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.file_field field.attribute_name, class: "form-input" %>

data/app/views/madmin/fields/file/_index.html.erb

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

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

@@ -0,0 +1,6 @@
+<% value = field.value(record) %>
+<% if value.respond_to?(:url) %>
+  <%= link_to value.url, value.url, target: :_blank, class: "text-indigo-500 underline" %>
+<% else %>
+  <%= value %>
+<% end %>

data/app/views/madmin/fields/integer/_index.html.erb

@@ -1 +1,5 @@
-<%= field.value(record) %>
+<% if field.attribute_name == :id %>
+  <%= link_to field.value(record), resource.show_path(record), class: "text-indigo-500 underline" %>
+<% else %>
+  <%= field.value(record) %>
+<% end %>

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/text/_index.html.erb

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

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

@@ -1,14 +1,15 @@
 module Madmin
   class Field
-    attr_reader :attribute_name, :model, :options
+    attr_reader :attribute_name, :model, :options, :resource
 
     def self.field_type
       to_s.split("::").last.underscore
     end
 
-    def initialize(attribute_name:, model:, **options)
+    def initialize(attribute_name:, model:, resource:, **options)
       @attribute_name = attribute_name
       @model = model
+      @resource = resource
       @options = options
     end
 

data/lib/madmin/fields/file.rb

@@ -0,0 +1,9 @@
+module Madmin
+  module Fields
+    class File < Field
+      def searchable?
+        false
+      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/resource.rb

@@ -11,7 +11,7 @@ module Madmin
       end
 
       def model
-        model_name.constantize
+        @model ||= model_name.constantize
       end
 
       def model_find(id)
@@ -37,36 +37,51 @@ module Madmin
         attributes[name] = OpenStruct.new(
           name: name,
           type: type,
-          field: field.new(**options.merge(attribute_name: name, model: model))
+          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.
+
+          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
         model_name.gsub("::", " / ")
       end
 
-      def index_path(options = {})
-        route_name = "madmin_#{model.model_name.plural}_path"
+      # Support for isolated namespaces
+      # Finds parent module class to include in polymorphic urls
+      def route_namespace
+        return @route_namespace if instance_variable_defined?(:@route_namespace)
+        namespace = model.module_parents.detect do |n|
+          n.respond_to?(:use_relative_model_naming?) && n.use_relative_model_naming?
+        end
+        @route_namespace = (namespace ? namespace.name.singularize.underscore.to_sym : nil)
+      end
 
-        url_helpers.send(route_name, options)
+      def index_path(options = {})
+        url_helpers.polymorphic_path([:madmin, route_namespace, model], options)
       end
 
       def new_path
-        route_name = "new_madmin_#{model.model_name.singular}_path"
-
-        url_helpers.send(route_name)
+        url_helpers.polymorphic_path([:madmin, route_namespace, model], action: :new)
       end
 
       def show_path(record)
-        route_name = "madmin_#{model.model_name.singular}_path"
-
-        url_helpers.send(route_name, record.to_param)
+        url_helpers.polymorphic_path([:madmin, route_namespace, record])
       end
 
       def edit_path(record)
-        route_name = "edit_madmin_#{model.model_name.singular}_path"
-
-        url_helpers.send(route_name, record.to_param)
+        url_helpers.polymorphic_path([:madmin, route_namespace, record], action: :edit)
       end
 
       def param_key
@@ -115,6 +130,7 @@ module Madmin
           time: Fields::Time,
           timestamp: Fields::Time,
           password: Fields::Password,
+          file: Fields::File,
 
           # Postgres specific types
           bit: Fields::String,
@@ -154,15 +170,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 +194,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 +216,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.5"
 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
@@ -17,6 +18,7 @@ module Madmin
     autoload :DateTime, "madmin/fields/date_time"
     autoload :Decimal, "madmin/fields/decimal"
     autoload :Enum, "madmin/fields/enum"
+    autoload :File, "madmin/fields/file"
     autoload :Float, "madmin/fields/float"
     autoload :HasMany, "madmin/fields/has_many"
     autoload :HasOne, "madmin/fields/has_one"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: madmin
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.5
 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-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -59,6 +59,7 @@ files:
 - app/assets/config/manifest.js
 - app/assets/stylesheets/actiontext.scss
 - app/assets/stylesheets/application.css
+- app/controllers/madmin/application_controller.rb
 - app/controllers/madmin/base_controller.rb
 - app/controllers/madmin/dashboard_controller.rb
 - app/controllers/madmin/resource_controller.rb
@@ -98,6 +99,9 @@ files:
 - app/views/madmin/fields/enum/_form.html.erb
 - app/views/madmin/fields/enum/_index.html.erb
 - app/views/madmin/fields/enum/_show.html.erb
+- app/views/madmin/fields/file/_form.html.erb
+- app/views/madmin/fields/file/_index.html.erb
+- app/views/madmin/fields/file/_show.html.erb
 - app/views/madmin/fields/float/_form.html.erb
 - app/views/madmin/fields/float/_index.html.erb
 - app/views/madmin/fields/float/_show.html.erb
@@ -167,6 +171,7 @@ files:
 - lib/madmin/fields/date_time.rb
 - lib/madmin/fields/decimal.rb
 - lib/madmin/fields/enum.rb
+- lib/madmin/fields/file.rb
 - lib/madmin/fields/float.rb
 - lib/madmin/fields/has_many.rb
 - lib/madmin/fields/has_one.rb
@@ -182,6 +187,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