madmin 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb075b59c9ecf34a7f4b939bb87a3e564fd984bb0d6866b13926d9873a335d3b
-  data.tar.gz: d6ec7fa589c2784e9c4a07d43b8cb5344e8637c7f7a3f53871cd17ecf1241061
+  metadata.gz: 531eb134ff2fc5b4f8d16f24167561fcd7836f1f5e8886d39f103a156ccffc6b
+  data.tar.gz: 28cec8a6ae99f9a36e6ecdc65383fe10306f2880ec7ae499e08a50093b38b7e1
 SHA512:
-  metadata.gz: 4d98c36cdfa429788088b18bdfc2bb7d9b5263575941156612c40efe4bf96ba7e3abc0560550eec7b3707aab12ec6485d5ea80182b36e8e3f9b04d3698d1c1ca
-  data.tar.gz: 24a57436a187fce39ace57a461989fb996395a6967c0513bba022c96197f054414754bd6b2a770cf54040daabfbd71880fb768fb12672917ba2a08bf94d577d3
+  metadata.gz: 122ff7eda3d0bc65945b4e34b9b23d6ddc700d711b9fa7381e8c3fd9bdfcd73113a083f2dcaded130978b6716bf79e3233bcc0e132c80704436b42d5065d407b
+  data.tar.gz: 92e06ee0cfcba0279947e46972efc5f2463b35b020b97bc5d830f7554cf5b004cc242f4203d3cc124919df49d8ecf1a4b16ac1e94b5e70715961b8e2afa8a1aa

data/README.md

@@ -6,14 +6,15 @@
 
 Why another Ruby on Rails admin? We wanted an admin that was:
 
-* Familiar and customizable like Rails scaffolds (less DSL)
-* Supports all the Rails features out of the box (ActionText, ActionMailbox, has_secure_password, etc)
-* Stimulus / Turbolinks / Hotwire ready
+- Familiar and customizable like Rails scaffolds (less DSL)
+- Supports all the Rails features out of the box (ActionText, ActionMailbox, has_secure_password, etc)
+- Stimulus / Turbolinks / Hotwire ready
 
 ![Madmin Screenshot](docs/images/screenshot.png)
 _We're still working on the design!_
 
 ## Installation
+
 Add `madmin` to your application's Gemfile:
 
 ```bash
@@ -40,6 +41,23 @@ To generate a resource for a model, you can run:
 rails g madmin:resource ActionText::RichText
 ```
 
+### Avoid N+1 queries
+
+In case of N+1 queries, you can preload the association by overriding the `scoped_resource` method in the controller:
+
+```ruby
+module Madmin
+  class PostsController < Madmin::ResourceController
+    private
+
+    def scoped_resources
+      super.includes(:user)
+    end
+  end
+end
+
+```
+
 ## Configuring Views
 
 The views packaged within the gem are a great starting point, but inevitably people will need to be able to customize those views.
@@ -47,16 +65,19 @@ The views packaged within the gem are a great starting point, but inevitably peo
 You can use the included generator to create the appropriate view files, which can then be customized.
 
 For example, running the following will copy over all of the views into your application that will be used for every resource:
+
 ```bash
 rails generate madmin:views
 ```
 
-The view files that are copied over in this case includes all of the standard Rails action views (index, new, edit, show, and _form), as well as:
-* `application.html.erb` (layout file)
-* `_javascript.html.erb` (default JavaScript setup)
-* `_navigation.html.erb` (renders the navigation/sidebar menu)
+The view files that are copied over in this case includes all of the standard Rails action views (index, new, edit, show, and \_form), as well as:
+
+- `application.html.erb` (layout file)
+- `_javascript.html.erb` (default JavaScript setup)
+- `_navigation.html.erb` (renders the navigation/sidebar menu)
 
 As with the other views, you can specifically run the views generator for only the navigation or application layout views:
+
 ```bash
 rails g madmin:views:navigation
  # -> app/views/madmin/_navigation.html.erb
@@ -68,6 +89,7 @@ rails g madmin:views:layout  # Note the layout generator includes the layout, ja
 ```
 
 If you only need to customize specific views, you can restrict which views are copied by the generator:
+
 ```bash
 rails g madmin:views:index
  # -> app/views/madmin/application/index.html.erb
@@ -79,6 +101,7 @@ The `attribute` method in model_resource.rb gives you that flexibility.
 ```bash
  # -> app/madmin/resources/book_resource.rb
 ```
+
 ```ruby
 class UserResource < Madmin::Resource
   attribute :id, form: false
@@ -91,6 +114,7 @@ end
 ```
 
 You can also scope the copied view(s) to a specific Resource/Model:
+
 ```bash
 rails generate madmin:views:index Book
  # -> app/views/madmin/books/index.html.erb
@@ -126,9 +150,14 @@ end
 You can use a couple of strategies to authenticate users who are trying to
 access your madmin panel: [Authentication Docs](docs/authentication.md)
 
+## Assets
+You can customize the JavaScript and CSS assets used by Madmin for your application. To learn how
+see the [Assets Doc](docs/assets.md)
+
 ## 🙏 Contributing
 
 This project uses Standard for formatting Ruby code. Please make sure to run standardrb before submitting pull requests.
 
 ## 📝 License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/assets/stylesheets/madmin/application-sprockets.css

@@ -0,0 +1,11 @@
+/*
+ *= require trix
+ *= require madmin/actiontext
+ *= require madmin/reset
+ *= require madmin/base
+ *= require madmin/sidebar
+ *= require madmin/buttons
+ *= require madmin/forms
+ *= require madmin/tables
+ *= require madmin/pagination
+*/

data/app/assets/stylesheets/madmin/application.css

@@ -1,88 +1,10 @@
-@import url("../trix.css");
-@import url("./actiontext.css");
-@import url("./reset.css");
-@import url("./sidebar.css");
-@import url("./buttons.css");
-@import url("./forms.css");
-@import url("./tables.css");
-@import url("./pagination.css");
+@import url("/trix.css");
+@import url("/madmin/actiontext.css");
+@import url("/madmin/reset.css");
+@import url("/madmin/base.css");
+@import url("/madmin/sidebar.css");
+@import url("/madmin/buttons.css");
+@import url("/madmin/forms.css");
+@import url("/madmin/tables.css");
+@import url("/madmin/pagination.css");
 
-:root {
-  --primary-color: rgb(37 99 235);
-  --border-color: rgb(229 231 235);
-  --background-color: rgb(249 250 251);
-  --text-color: rgb(2 6 23);
-  --light-text-color: rgb(71 85 105);
-
-  --sidebar-width: 16rem;
-}
-
-body {
-  color: var(--text-color);
-  font-size: 14px;
-}
-
-a {
-  color: var(--primary-color);
-}
-
-.search {
-  display: flex;
-  align-items: center;
-}
-
-.header {
-  border-bottom: 1px solid rgb(229 231 235);
-  display: flex;
-  justify-content: space-between;
-  align-items: center;
-  padding-bottom: 1rem;
-  margin-bottom: 1rem;
-
-  h1 {
-    margin: 0;
-  }
-
-  a {
-    text-decoration: none;
-
-    &:hover {
-      text-decoration: underline;
-    }
-  }
-
-  .actions {
-    align-items: center;
-    display: flex;
-    gap: 0.5rem;
-  }
-}
-
-.metrics {
-  display: flex;
-
-  .metric {
-    border: 1px solid rgb(229 231 235);
-    border-radius: 0.25rem;
-    padding: 1rem;
-    margin: 1rem;
-    flex: 1 1 0%;
-
-    h4 {
-      color: rgb(75 85 99);
-      font-weight: 600;
-      margin-top: 0;
-      margin-bottom: 0.5rem;
-    }
-
-    p {
-      font-size: 2rem;
-      font-weight: 600;
-      margin: 0;
-    }
-  }
-}
-
-.scopes {
-  margin-bottom: 1rem;
-}

data/app/assets/stylesheets/madmin/base.css

@@ -0,0 +1,117 @@
+:root {
+  --primary-color: rgb(37 99 235);
+  --border-color: rgb(229 231 235);
+  --background-color: rgb(249 250 251);
+  --text-color: rgb(2 6 23);
+  --light-text-color: rgb(71 85 105);
+  --sidebar-width: 16rem;
+}
+
+body {
+  color: var(--text-color);
+  font-size: 14px;
+}
+
+a {
+  color: var(--primary-color);
+}
+
+.alert {
+  border-radius: 0.5rem;
+  font-weight: 500;
+  padding: 1rem;
+  margin-bottom: 1rem;
+
+  ul {
+    margin-top: 0.5rem;
+    margin-bottom: 0;
+    padding-left: 2rem;
+  }
+
+  svg {
+    display: inline-block;
+    height: 1rem;
+    margin-right: 0.25rem;
+    width: 1rem;
+    vertical-align: text-bottom;
+  }
+
+  &.alert-danger {
+    background-color: oklch(.936 .032 17.717);
+    color: oklch(.444 .177 26.899);
+
+    svg {
+      color: oklch(.637 .237 25.331);
+    }
+  }
+
+  &.alert-notice {
+    background-color: oklch(.962 .044 156.743);
+    color: oklch(.448 .119 151.328);
+
+    svg {
+      color: oklch(.723 .219 149.579);
+    }
+  }
+}
+
+.search {
+  display: flex;
+  align-items: center;
+}
+
+.header {
+  border-bottom: 1px solid rgb(229 231 235);
+  display: flex;
+  justify-content: space-between;
+  align-items: center;
+  padding-bottom: 1rem;
+  margin-bottom: 1rem;
+
+  h1 {
+    margin: 0;
+  }
+
+  a {
+    text-decoration: none;
+
+    &:hover {
+      text-decoration: underline;
+    }
+  }
+
+  .actions {
+    align-items: center;
+    display: flex;
+    gap: 0.5rem;
+  }
+}
+
+.metrics {
+  display: flex;
+
+  .metric {
+    border: 1px solid rgb(229 231 235);
+    border-radius: 0.25rem;
+    padding: 1rem;
+    margin: 1rem;
+    flex: 1 1 0%;
+
+    h4 {
+      color: rgb(75 85 99);
+      font-weight: 600;
+      margin-top: 0;
+      margin-bottom: 0.5rem;
+    }
+
+    p {
+      font-size: 2rem;
+      font-weight: 600;
+      margin: 0;
+    }
+  }
+}
+
+.scopes {
+  margin-bottom: 1rem;
+}

data/app/assets/stylesheets/madmin/forms.css

@@ -1,21 +1,3 @@
-.alert {
-  border-radius: 0.25rem;
-  font-weight: 500;
-  padding: 1rem;
-  margin-bottom: 1rem;
-
-  ul {
-    margin-top: 0.5rem;
-    margin-bottom: 0;
-    padding-left: 2rem;
-  }
-
-  &.alert-danger {
-    background-color: rgb(254 226 226);
-    color: rgb(153 27 27);
-  }
-}
-
 .form-hint {
   font-size: 0.875rem;
   margin-top: 0.5rem;

data/app/controllers/madmin/resource_controller.rb

@@ -25,7 +25,7 @@ module Madmin
     end
 
     def new
-      @record = resource.model.new
+      @record = resource.model.new(new_resource_params)
     end
 
     def create
@@ -85,6 +85,12 @@ module Madmin
         .transform_values { |v| change_polymorphic(v) }
     end
 
+    def new_resource_params
+      params.fetch(resource.param_key, {}).permit!
+        .permit(*resource.permitted_params)
+        .transform_values { |v| change_polymorphic(v) }
+    end
+
     def change_polymorphic(data)
       return data unless data.is_a?(ActionController::Parameters) && data[:type]
 

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

@@ -18,6 +18,7 @@
       <%= render "navigation" %>
     </aside>
     <main>
+      <%= render "flash" %>
       <%= yield %>
     </main>
   </body>

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

@@ -0,0 +1,13 @@
+<% if alert %>
+  <div class="alert alert-danger">
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16" fill="currentColor"><path fill-rule="evenodd" d="M8 15A7 7 0 1 0 8 1a7 7 0 0 0 0 14ZM8 4a.75.75 0 0 1 .75.75v3a.75.75 0 0 1-1.5 0v-3A.75.75 0 0 1 8 4Zm0 8a1 1 0 1 0 0-2 1 1 0 0 0 0 2Z" clip-rule="evenodd"></path></svg>
+    <%= alert %>
+  </div>
+<% end %>
+
+<% if notice %>
+  <div class="alert alert-notice">
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16" fill="currentColor"><path fill-rule="evenodd" d="M8 15A7 7 0 1 0 8 1a7 7 0 0 0 0 14Zm3.844-8.791a.75.75 0 0 0-1.188-.918l-3.7 4.79-1.649-1.833a.75.75 0 1 0-1.114 1.004l2.25 2.5a.75.75 0 0 0 1.15-.043l4.25-5.5Z" clip-rule="evenodd"></path></svg>
+    <%= notice %>
+  </div>
+<% end %>

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

@@ -1,5 +1,5 @@
 <%= javascript_importmap_tags "application", importmap: Madmin.importmap %>
 
-<%= stylesheet_link_tag "madmin/application", "data-turbo-track": "reload" %>
+<%= stylesheet_link_tag *Madmin.stylesheets, "data-turbo-track": "reload" %>
 <%= stylesheet_link_tag "https://unpkg.com/flatpickr/dist/flatpickr.min.css", "data-turbo-track": "reload" %>
 <%= stylesheet_link_tag "https://unpkg.com/tom-select/dist/css/tom-select.min.css", "data-turbo-track": "reload" %>

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

@@ -1,5 +1,11 @@
-<% field.value(record).each do |object| %>
+<% pagy, records = field.paginated_value(record, params) %>
+<% records.each do |object| %>
   <div>
     <%= link_to Madmin.resource_for(object).display_name(object), Madmin.resource_for(object).show_path(object), class: "text-blue-500 underline" %>
   </div>
 <% end %>
+
+<div class="pagination">
+  <%== pagy_nav pagy if pagy.pages > 1 %>
+  <span>Showing <%= tag.strong pagy.in %> of <%= tag.strong pagy.count %></span>
+</div>

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

@@ -1,5 +1,11 @@
-<% field.value(record).each do |object| %>
+<% pagy, records = field.paginated_value(record, params) %>
+<% records.each do |object| %>
   <div>
     <%= link_to Madmin.resource_for(object).display_name(object), Madmin.resource_for(object).show_path(object), class: "text-blue-500 underline" %>
   </div>
 <% end %>
+
+<div class="pagination">
+  <%== pagy_nav pagy if pagy.pages > 1 %>
+  <span>Showing <%= tag.strong pagy.in %> of <%= tag.strong pagy.count %></span>
+</div>

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: separated_routes_file? ? 2 : 4, sentinel: /namespace :madmin do\s*\n/m
+          route "resources :#{plural_name}", namespace: class_path, indentation: separated_routes_file? ? 2 : 4, sentinel: /namespace :madmin[^\n]*do\s*\n/m
         else
           route "resources :#{plural_name}", namespace: [:madmin] + class_path
         end

data/lib/madmin/engine.rb

@@ -19,6 +19,12 @@ module Madmin
         app.config.assets.paths << root.join("app/assets/stylesheets")
         app.config.assets.paths << root.join("app/javascript")
         app.config.assets.precompile += %w[madmin_manifest]
+
+        Madmin.stylesheets << if defined?(::Sprockets)
+          "madmin/application-sprockets"
+        else
+          "madmin/application"
+        end
       end
     end
 

data/lib/madmin/field.rb

@@ -53,5 +53,9 @@ module Madmin
     def searchable?
       false
     end
+
+    def paginateable?
+      false
+    end
   end
 end

data/lib/madmin/fields/has_many.rb

@@ -1,6 +1,8 @@
 module Madmin
   module Fields
     class HasMany < Field
+      include Pagy::Backend
+
       def options_for_select(record)
         if (records = record.send(attribute_name))
           return [] unless records.first
@@ -18,6 +20,21 @@ module Madmin
       def index_path
         Madmin.resource_by_name(model.reflect_on_association(attribute_name).klass).index_path(format: :json)
       end
+
+      def paginateable?
+        true
+      end
+
+      def paginated_value(record, params)
+        pagy value(record), params: params, page_param: "#{attribute_name}_page"
+      end
+
+      # Override to access params from vars since we're not in a controller/view
+      def pagy_get_page(vars, force_integer: true)
+        params = vars[:params]
+        page = params[vars[:page_param] || DEFAULT[:page_param]]
+        force_integer ? (page || 1).to_i : page
+      end
     end
   end
 end

data/lib/madmin/fields/nested_has_many.rb

@@ -1,6 +1,6 @@
 module Madmin
   module Fields
-    class NestedHasMany < Field
+    class NestedHasMany < HasMany
       DEFAULT_ATTRIBUTES = %w[_destroy id].freeze
       def nested_attributes
         resource.attributes.except(*skipped_fields)
@@ -26,6 +26,10 @@ module Madmin
         attribute_name.to_s.singularize.classify.constantize
       end
 
+      def paginateable?
+        true
+      end
+
       private
 
       def permitted_fields

data/lib/madmin/generator_helpers.rb

@@ -41,11 +41,15 @@ module Madmin
     end
 
     def default_sentinel(file)
-      file.eql?(ROUTES_FILE[:default]) ? /\.routes\.draw do\s*\n/m : /namespace :madmin do\s*\n/m
+      file.eql?(ROUTES_FILE[:default]) ? /\.routes\.draw do\s*\n/m : /namespace :madmin[^\n]*do\s*\n/m
     end
 
     def default_routes_file
-      rails6_1_and_up? ? ROUTES_FILE[:separated] : ROUTES_FILE[:default]
+      if rails6_1_and_up? && File.exist?(ROUTES_FILE[:separated])
+        ROUTES_FILE[:separated]
+      else
+        ROUTES_FILE[:default]
+      end
     end
 
     def generator_options

data/lib/madmin/version.rb

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

data/lib/madmin.rb

@@ -39,6 +39,7 @@ module Madmin
   mattr_accessor :importmap, default: Importmap::Map.new
   mattr_accessor :menu, default: Menu.new
   mattr_accessor :site_name
+  mattr_accessor :stylesheets, default: []
 
   class << self
     def resource_for(object)

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: madmin
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Chris Oliver
 - Andrea Fomera
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-21 00:00:00.000000000 Z
+date: 2025-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -80,7 +79,9 @@ files:
 - Rakefile
 - app/assets/config/madmin_manifest.js
 - app/assets/stylesheets/madmin/actiontext.css
+- app/assets/stylesheets/madmin/application-sprockets.css
 - app/assets/stylesheets/madmin/application.css
+- app/assets/stylesheets/madmin/base.css
 - app/assets/stylesheets/madmin/buttons.css
 - app/assets/stylesheets/madmin/forms.css
 - app/assets/stylesheets/madmin/pagination.css
@@ -100,6 +101,7 @@ files:
 - 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/_flash.html.erb
 - app/views/madmin/application/_form.html.erb
 - app/views/madmin/application/_javascript.html.erb
 - app/views/madmin/application/_navigation.html.erb
@@ -239,7 +241,6 @@ homepage: https://github.com/excid3/madmin
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -254,8 +255,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
-signing_key:
+rubygems_version: 3.6.5
 specification_version: 4
 summary: A modern admin for Ruby on Rails apps
 test_files: []