madmin-static_models 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50348135ce76b0e9c74e3fc26c2d0cf99af7a371ccfa1cfc0d5aa1e8b25d6f84
-  data.tar.gz: 7a45e2cf576dbf07bbf285c749cd0af4c57ce186090f80f6b17e8ed22f8dd3e8
+  metadata.gz: b1b682bf3c2f02394141d80a1b9cfda1fcbfa8949c8182f67eabfd820e451436
+  data.tar.gz: 687dee958276c38330eec3b88042a66798e7510822138be7e27e12befff695a8
 SHA512:
-  metadata.gz: c7ac57164d43bb5d708d788b8838ccbce6dea8a3b0e0379df90869b620700a1fb2a0b7072e099849f570427abe1d50fdb16aa931eb1c7ccb508bb87a32922ddb
-  data.tar.gz: '072779c79e1ce89a000ddfbf7b5e86bb07f957f3da64bb5af81f1f8a1c7cd6063548d9047583e5f1c44ea26b6fdaac273b231c26dc16c70c44c1b0ce7153454c'
+  metadata.gz: 6b390486013dda926947dbe93e7cafe441940f009c7f6c1ac242dd94904df06949ef42a31a466f4ee281df23b26a7a863638588b0e9b5ee9780dd6aadebca95e
+  data.tar.gz: dcb8b6196b75170d9baf3f1179465b5f88c1560dcea17c331a0eb2452e0220dbccb21924dbca1d27bc2362e3020c1d39a2a4796b4b0ef308eef3e5ad25694ac8

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.2.0
+
+- Requires Madmin 3 (>= 3.2, < 4); paginates with Madmin::Page instead of Pagy (page size comes from the `per_page` param); static resources don't offer index filters.
+
+## 0.1.1
+
+- Restrict madmin to >= 2.6, < 3. Madmin 3 replaced Pagy with its own pagination, which breaks static resource index pages on 0.1.x; use 0.2 for Madmin 3.
+
 ## 0.1.0
 
 - Initial release: ActiveHash adapter (covers ActiveHash, ActiveYaml, ActiveJson and ActiveFile models), read-only resources, in-memory search/sort/pagination, generator support, and an adapter API for other static backends.

data/README.md

@@ -18,7 +18,14 @@ Add to your Gemfile:
 gem "madmin-static_models"
 ```
 
-Requires madmin >= 2.6.
+Pick the version that matches your Madmin:
+
+| Madmin      | madmin-static_models | Gemfile                                    |
+| ----------- | -------------------- | ------------------------------------------ |
+| 2.6 – 2.x   | 0.1.x                | `gem "madmin-static_models", "~> 0.1.1"`   |
+| 3.2 – 3.x   | 0.2.x                | `gem "madmin-static_models", "~> 0.2"`     |
+
+Madmin 3.0 and 3.1 aren't supported. Upgrade to Madmin 3.2 or later.
 
 ## Usage
 
@@ -53,11 +60,12 @@ That's it — the resource shows up in Madmin like any other, minus the write ac
 
 ## How it works
 
-The gem attaches to Madmin through its `ActiveSupport` load hooks (`:madmin_resource`, `:madmin_resource_controller`) and prepends small modules that answer differently for static models and call `super` for everything else:
+The gem attaches to Madmin through its `ActiveSupport` load hooks (`:madmin_resource`, `:madmin_resource_controller`, `:madmin_field`) and prepends small modules that answer differently for static models and call `super` for everything else:
 
 - `Resource.readonly?` returns true, which makes Madmin hide write links and block write actions
 - `Resource.model_column_names` comes from the adapter instead of the database
-- Pagination, sorting and search run over plain arrays in memory
+- Pagination, sorting and search run over plain arrays in memory, paginated with `Madmin::Page`
+- Fields return no `filter_type`, so static resources don't offer Madmin's index filters (they build SQL)
 - `show_path`/`edit_path` are built manually since static records don't support polymorphic routing
 
 ## Adding a backend

data/lib/madmin/static_models/controller_extension.rb

@@ -23,22 +23,8 @@ module Madmin
 
       def paginate_static(collection)
         records = collection.to_a
-
-        # Pagy >= 43 paginates plain arrays natively, with the request context
-        # that its nav helpers need.
-        return pagy(records) if defined?(Pagy::Method) && is_a?(Pagy::Method)
-
-        # Older pagy: build the pager by hand.
-        page = [params[:page].to_i, 1].max
-        defaults = Pagy::DEFAULT || {}
-        limit = (params[:limit] || defaults[:limit] || defaults[:items] || 20).to_i
-        pager = begin
-          Pagy.new(count: records.size, page: page, limit: limit)
-        rescue ArgumentError
-          Pagy.new(count: records.size, page: page, items: limit)
-        end
-        per_page = pager.respond_to?(:limit) ? pager.limit : pager.items
-        [pager, records.slice(pager.offset, per_page) || []]
+        page = Madmin::Page.new(count: records.size, page: params[:page], per_page: Madmin::Page.per_page_for(params[:per_page]))
+        [page, records.slice(page.offset, page.per_page) || []]
       end
 
       def sort_static(collection, column, direction)

data/lib/madmin/static_models/field_extension.rb

@@ -0,0 +1,13 @@
+module Madmin
+  module StaticModels
+    # Prepended to Madmin::Field. Madmin's index filters build SQL, which
+    # static models can't run, so their fields offer no filters.
+    module FieldExtension
+      def filter_type
+        return nil if StaticModels.static_model?(model)
+
+        super
+      end
+    end
+  end
+end

data/lib/madmin/static_models/railtie.rb

@@ -12,6 +12,10 @@ module Madmin
           singleton_class.prepend Madmin::StaticModels::ResourceExtension
         end
 
+        ActiveSupport.on_load(:madmin_field) do
+          prepend Madmin::StaticModels::FieldExtension
+        end
+
         # Plain lib classes; referencing them triggers madmin's autoload.
         Madmin::Search.prepend Madmin::StaticModels::SearchExtension
         Madmin::ResourceBuilder.prepend Madmin::StaticModels::ResourceBuilderExtension
@@ -21,7 +25,7 @@ module Madmin
             # The :madmin_resource load hook never fired, so this madmin
             # predates the extension seams (readonly?, model_column_names,
             # paginate_collection) that this gem builds on.
-            warn "madmin-static_models requires madmin >= 2.6 (extension load hooks and seams)."
+            warn "madmin-static_models requires madmin >= 3.2 (extension load hooks and Madmin::Page)."
           end
         end
       end

data/lib/madmin/static_models/version.rb

@@ -1,5 +1,5 @@
 module Madmin
   module StaticModels
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/madmin/static_models.rb

@@ -8,6 +8,7 @@ require "madmin/static_models/resource_extension"
 require "madmin/static_models/resource_builder_extension"
 require "madmin/static_models/controller_extension"
 require "madmin/static_models/search_extension"
+require "madmin/static_models/field_extension"
 require "madmin/static_models/railtie"
 
 module Madmin

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: madmin-static_models
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Anthony Veaudry
@@ -15,14 +15,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: active_hash
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +58,7 @@ files:
 - lib/madmin/static_models/adapter.rb
 - lib/madmin/static_models/adapters/active_hash.rb
 - lib/madmin/static_models/controller_extension.rb
+- lib/madmin/static_models/field_extension.rb
 - lib/madmin/static_models/generator_extensions.rb
 - lib/madmin/static_models/railtie.rb
 - lib/madmin/static_models/resource_builder_extension.rb