madmin 2.5.1 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 651ff84ef6656287c3eb1bbadae16eb38d2820bcc5eb122c10d19f42739a8d92
-  data.tar.gz: 97176ea8203d5118b19e25a2e1ceffb4252c28ce8d3573f5f5b4937ef0876fef
+  metadata.gz: 35abef3e18e33da02efc68140fbbffe237a15b5054f99a6299265b1219181069
+  data.tar.gz: 6cd25c564e51d1d663b9b8525caa793d6395e8534f831a02fdf41b36411b6161
 SHA512:
-  metadata.gz: f67235e06f0e0822a97bdcb306fc8328aae9e203edd06f1a3f6823bdaa19d9c072a1688f246faaedd73c6b2b5ce547f7f2340761c958f2c75d0b87f08ad79a71
-  data.tar.gz: 8e36b4f0986ec2946b4a288b43c2c705b9b1eb07ab0a5d64e006b603b05b0e748292110614075b8ad11d6c55885fd554e2631b1320e534b357b96111b06be3bc
+  metadata.gz: 62b04e88f49fbbb3c680c482e6c73bfa71710471c858e872f11d8eb5ba6491fb8c12607adadea92f64c8ed3f1b6da10afa616fa3e13114dbe0a2a5365d41c897
+  data.tar.gz: 3e11e615a5720928b8997fa684549a2e67cc17e06d689a0856ba9d350d6037ccb63d6f6dd543e353712ce32616f8af09efbe66dfa545a91eae7cef98896cb6fe

data/README.md

@@ -58,6 +58,20 @@ end
 
 ```
 
+### Read-only Resources
+
+To expose a resource in the admin without allowing writes, override `readonly?` in the resource:
+
+```ruby
+class AuditLogResource < Madmin::Resource
+  def self.readonly?
+    true
+  end
+end
+```
+
+The new, edit, and delete links are hidden for read-only resources, and any write actions redirect back to the index.
+
 ## 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.

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

@@ -5,6 +5,10 @@
   position: relative;
   min-width: 0;
   width: 100%;
+
+  &:not(:has(tbody tr)) th {
+    border-bottom: none;
+  }
 }
 
 table {

data/app/controllers/madmin/resource_controller.rb

@@ -3,12 +3,13 @@ module Madmin
     include SortHelper
 
     before_action :set_record, except: [:index, :new, :create]
+    before_action :enforce_readonly, only: [:new, :create, :edit, :update, :destroy]
 
     # Assign current_user for paper_trail gem
     before_action :set_paper_trail_whodunnit, if: -> { respond_to?(:set_paper_trail_whodunnit, true) }
 
     def index
-      @pagy, @records = pagy(scoped_resources)
+      @pagy, @records = paginate_collection(scoped_resources)
 
       respond_to do |format|
         format.html
@@ -68,9 +69,16 @@ module Madmin
     def scoped_resources
       resources = resource.model.send(valid_scope)
       resources = Madmin::Search.new(resources, resource, search_term).run
+
+      return resources if sort_column.blank?
+
       resources.reorder(sort_column => sort_direction)
     end
 
+    def paginate_collection(collection)
+      pagy(collection)
+    end
+
     def valid_scope
       scope = params.fetch(:scope, "all")
       resource.scopes.include?(scope.to_sym) ? scope : :all
@@ -102,6 +110,10 @@ module Madmin
       @search_term ||= params[:q].to_s.strip
     end
 
+    def enforce_readonly
+      redirect_to resource.index_path, alert: t("madmin.flash.readonly", name: resource.friendly_name) if resource.readonly?
+    end
+
     ActiveSupport.run_load_hooks(:madmin_resource_controller, self)
   end
 end

data/app/helpers/madmin/sort_helper.rb

@@ -22,7 +22,7 @@ module Madmin
     end
 
     def default_sort_column
-      resource.try(:default_sort_column) || (["created_at", "id", "uuid"] & resource.model.column_names).first
+      resource.try(:default_sort_column) || (["created_at", "id", "uuid"] & resource.sortable_columns).first || resource.sortable_columns.first
     end
 
     def default_sort_direction

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

@@ -19,8 +19,10 @@
       <%= instance_exec(&action) %>
     <% end %>
 
-    <%= link_to resource.new_path, class: "btn btn-secondary" do %>
-      <%= t("madmin.actions.new") %> <%= tag.span resource.friendly_name, class: "hidden md:inline-block" %>
+    <% unless resource.readonly? %>
+      <%= link_to resource.new_path, class: "btn btn-secondary" do %>
+        <%= t("madmin.actions.new") %> <%= tag.span resource.friendly_name, class: "hidden md:inline-block" %>
+      <% end %>
     <% end %>
   </div>
 </header>
@@ -60,7 +62,7 @@
 
           <td class="actions">
             <%= link_to t("madmin.actions.view"), resource.show_path(record), class: "btn btn-secondary" %>
-            <%= link_to t("madmin.actions.edit"), resource.edit_path(record), class: "btn btn-secondary" %>
+            <%= link_to t("madmin.actions.edit"), resource.edit_path(record), class: "btn btn-secondary" unless resource.readonly? %>
 
             <% resource.collection_member_actions.each do |action| %>
               <%= instance_exec(record, &action) %>

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

@@ -11,8 +11,10 @@
     <% resource.member_actions.each do |action| %>
       <%= instance_exec(@record, &action) %>
     <% end %>
-    <%= link_to t("madmin.actions.edit"), resource.edit_path(@record), class: "btn btn-secondary" %>
-    <%= button_to t("madmin.actions.delete"), resource.show_path(@record), method: :delete, data: { turbo_confirm: t("madmin.confirmations.delete") }, class: "btn btn-danger" %>
+    <% unless resource.readonly? %>
+      <%= link_to t("madmin.actions.edit"), resource.edit_path(@record), class: "btn btn-secondary" %>
+      <%= button_to t("madmin.actions.delete"), resource.show_path(@record), method: :delete, data: { turbo_confirm: t("madmin.confirmations.delete") }, class: "btn btn-danger" %>
+    <% end %>
   </div>
 </header>
 

data/config/locales/el.yml

@@ -0,0 +1,42 @@
+el:
+  madmin:
+    layout:
+      open_menu: Άνοιγμα μενού
+      admin_suffix: Διαχείριση
+    navigation:
+      dashboard: Πίνακας ελέγχου
+      github: Το Madmin στο GitHub
+    dashboard:
+      title: Πίνακας ελέγχου Madmin
+      hint_html: Δημιουργήστε το <code>app/views/madmin/dashboard/show.html.erb</code> για να προσαρμόσετε τον πίνακα ελέγχου σας.
+    actions:
+      all: Όλα
+      view: Προβολή
+      edit: Επεξεργασία
+      delete: Διαγραφή
+      new: Νέο
+      remove: Αφαίρεση
+      cancel: Ακύρωση
+    search:
+      placeholder: Αναζήτηση
+    titles:
+      new: Νέο %{name}
+      edit: Επεξεργασία %{name}
+    form:
+      errors:
+        one: Υπήρξε 1 σφάλμα με την υποβολή σας
+        other: Υπήρξαν %{count} σφάλματα με την υποβολή σας
+    flash:
+      readonly: "%{name}: μόνο για ανάγνωση"
+    confirmations:
+      delete: Είστε σίγουροι;
+      remove_with_changes: Είστε σίγουροι; Θα χάσετε όλες τις άλλες αλλαγές.
+    nested_form:
+      add_new: "+ Προσθήκη νέου"
+    fields:
+      attachment:
+        one: "%{count} συνημμένο"
+        other: "%{count} συνημμένα"
+    missing_resource:
+      message: "Λείπει: %{resource}"
+      create_hint: "Δημιουργήστε το εκτελώντας:"

data/config/locales/en.yml

@@ -26,6 +26,8 @@ en:
       errors:
         one: There was 1 error with your submission
         other: There were %{count} errors with your submission
+    flash:
+      readonly: "%{name} is read-only"
     confirmations:
       delete: Are you sure?
       remove_with_changes: Are you sure? You will lose any other changes.

data/config/locales/fr.yml

@@ -26,6 +26,8 @@ fr:
       errors:
         one: Il y a eu 1 erreur dans votre soumission
         other: Il y a eu %{count} erreurs dans votre soumission
+    flash:
+      readonly: "%{name} est en lecture seule"
     confirmations:
       delete: Êtes-vous sûr ?
       remove_with_changes: Êtes-vous sûr ? Vous perdrez toutes les autres modifications.

data/config/locales/ko.yml

@@ -0,0 +1,40 @@
+ko:
+  madmin:
+    layout:
+      open_menu: 메뉴 열기
+      admin_suffix: 관리자
+    navigation:
+      dashboard: 대시보드
+      github: GitHub에서 Madmin 보기
+    dashboard:
+      title: Madmin 대시보드
+      hint_html: 대시보드를 원하는 대로 꾸미려면 <code>app/views/madmin/dashboard/show.html.erb</code> 파일을 생성하세요.
+    actions:
+      all: 전체
+      view: 보기
+      edit: 수정
+      delete: 삭제
+      new: 새로 만들기
+      remove: 제거
+      cancel: 취소
+    search:
+      placeholder: 검색
+    titles:
+      new: 새 %{name}
+      edit: "%{name} 수정"
+    form:
+      errors:
+        one: 제출한 내용에 오류가 1개 있습니다
+        other: 제출한 내용에 오류가 %{count}개 있습니다
+    confirmations:
+      delete: 정말 삭제하시겠습니까?
+      remove_with_changes: 정말 제거하시겠습니까? 다른 변경 사항도 함께 사라집니다.
+    nested_form:
+      add_new: "+ 새로 추가"
+    fields:
+      attachment:
+        one: "첨부파일 %{count}개"
+        other: "첨부파일 %{count}개"
+    missing_resource:
+      message: "%{resource}이(가) 존재하지 않습니다."
+      create_hint: "다음 명령어를 실행하여 생성하세요:"

data/lib/madmin/fields/string.rb

@@ -2,7 +2,7 @@ module Madmin
   module Fields
     class String < Field
       def searchable?
-        options.fetch(:searchable, model.column_names.include?(attribute_name.to_s))
+        options.fetch(:searchable, resource.model_column_names.include?(attribute_name.to_s))
       end
     end
   end

data/lib/madmin/fields/text.rb

@@ -2,7 +2,7 @@ module Madmin
   module Fields
     class Text < Field
       def searchable?
-        options.fetch(:searchable, model.column_names.include?(attribute_name.to_s))
+        options.fetch(:searchable, resource.model_column_names.include?(attribute_name.to_s))
       end
     end
   end

data/lib/madmin/resource.rb

@@ -126,7 +126,15 @@ module Madmin
         model.respond_to? :friendly
       end
 
+      def readonly?
+        false
+      end
+
       def sortable_columns
+        model_column_names
+      end
+
+      def model_column_names
         model.column_names
       end
 
@@ -258,6 +266,8 @@ module Madmin
       end
 
       def model_store_accessors
+        return [] unless model.respond_to?(:stored_attributes)
+
         store_accessors = model.stored_attributes.values
         store_accessors.flatten
       end

data/lib/madmin/resource_builder.rb

@@ -7,6 +7,8 @@ module Madmin
     end
 
     def associations
+      return [] unless model.respond_to?(:reflections)
+
       model.reflections.reject { |name, association|
         # Hide these special associations
         name.starts_with?("rich_text") ||
@@ -22,10 +24,14 @@ module Madmin
     end
 
     def store_accessors
+      return [] unless model.respond_to?(:stored_attributes)
+
       model.stored_attributes.values.flatten
     end
 
     def virtual_attributes
+      return [] unless model.respond_to?(:attribute_types)
+
       virtual = []
 
       # has_secure_password columns
@@ -50,6 +56,8 @@ module Madmin
     end
 
     def redundant_attributes
+      return [] unless model.respond_to?(:attribute_types)
+
       redundant = []
 
       # has_secure_password columns

data/lib/madmin/version.rb

@@ -1,3 +1,3 @@
 module Madmin
-  VERSION = "2.5.1"
+  VERSION = "2.6.0"
 end

data/lib/madmin.rb

@@ -78,6 +78,8 @@ module Madmin
     end
 
     def sti_resource_name_for(object)
+      return unless object.class.respond_to?(:inheritance_column) && object.class.respond_to?(:column_names)
+
       if (column = object.class.inheritance_column) && object.class.column_names.include?(column)
         "#{object.class.superclass.base_class.name}Resource"
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: madmin
 version: !ruby/object:Gem::Version
-  version: 2.5.1
+  version: 2.6.0
 platform: ruby
 authors:
 - Chris Oliver
@@ -198,8 +198,10 @@ files:
 - app/views/madmin/fields/time/_show.html.erb
 - app/views/madmin/shared/_label.html.erb
 - config/importmap.rb
+- config/locales/el.yml
 - config/locales/en.yml
 - config/locales/fr.yml
+- config/locales/ko.yml
 - lib/generators/madmin/field/field_generator.rb
 - lib/generators/madmin/field/templates/_form.html.erb
 - lib/generators/madmin/field/templates/_index.html.erb
@@ -274,7 +276,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.18
+rubygems_version: 4.0.16
 specification_version: 4
 summary: A modern admin for Ruby on Rails apps
 test_files: []