madmin 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19d2f645bfcae060a5a925b945892a2a196790a2d6c3b296ec0fe5118aeaf186
-  data.tar.gz: 4310e5b0fb00744f6098032799d6df7368890b736382a9bad466d328662f4da4
+  metadata.gz: 223251f99312a051f3fd6a6d926c6583347e2c78b255343bc66b3fb063ea8a54
+  data.tar.gz: cfab141916431f52d137bd7704c33cc4cd3b1781735062e2a9d173f9d9d7bee4
 SHA512:
-  metadata.gz: c4d157858da05695020064ef9aa636079298cdc7bb1937bc3a4cb13faf71087d31ac0df3d1f3027414112aae61e97f9bfd099a1cf8bbf6bf8380532e654fe844
-  data.tar.gz: 2969bdf7c7e419290cff1db31f1d22befdb2eb7b0591cc60a00a328dd7e024991825547cae8404a98abdfd309c3308bc7c46332bf154fd6765f48372785baddd
+  metadata.gz: 7b1480b7df30ec0bba0f1937a7336bb8532f51cd8dc9c8de78fd73b686c132dd14083eec88a303938bfb4fdfa50827db570a3d899e40952799869dfe4795e756
+  data.tar.gz: e362a3d85149b1f1074ea21eaf6a6659e6c8f002a929f668a21583a286fc1824a2f3ede02997eafe75feaa20e0172345c54210180b7c537b44d0de4bca1eb0b0

data/README.md

@@ -7,9 +7,12 @@
 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, etc)
+* 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:
 

data/app/controllers/madmin/resource_controller.rb

@@ -41,7 +41,7 @@ module Madmin
     private
 
     def set_record
-      @record = resource.model.find(params[:id])
+      @record = resource.model_find(params[:id])
     end
 
     def resource

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

@@ -3,7 +3,7 @@
 <%= stylesheet_link_tag "https://unpkg.com/slim-select@1.27.0/dist/slimselect.min.css", "data-turbo-track": "reload" %>
 
 <script type="module">
-  import { Application } from 'https://cdn.skypack.dev/stimulus'
+  import { Application, Controller } from 'https://cdn.skypack.dev/stimulus'
   const application = Application.start()
 
   import stimulusFlatpickr from 'https://cdn.skypack.dev/stimulus-flatpickr'
@@ -21,4 +21,39 @@
   ActiveStorage.start()
 
   import * as Turbo from "https://cdn.skypack.dev/@hotwired/turbo"
+
+  (() => {
+    application.register('nested-form', class extends Controller {
+      static get targets() {
+        return [ "links", "template" ]
+      }
+
+      connect() {
+        this.wrapperClass = this.data.get("wrapperClass") || "nested-fields"
+      }
+
+      add_association(event) {
+        event.preventDefault()
+
+        var content = this.templateTarget.innerHTML.replace(/NEW_RECORD/g, new Date().getTime())
+        this.linksTarget.insertAdjacentHTML('beforebegin', content)
+      }
+
+      remove_association(event) {
+        event.preventDefault()
+
+        let wrapper = event.target.closest("." + this.wrapperClass)
+
+        // New records are simply removed from the page
+        if (wrapper.dataset.newRecord == "true") {
+          wrapper.remove()
+
+        // Existing records are hidden and flagged for deletion
+        } else {
+          wrapper.querySelector("input[name*='_destroy']").value = 1
+          wrapper.style.display = 'none'
+        }
+      }
+    })
+  })()
 </script>

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

@@ -0,0 +1,18 @@
+<%= 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| %>
+    <% next if nested_attribute[:field].nil? %>
+    <% next unless nested_attribute[:field].visible?(action_name) %>
+    <% next unless nested_attribute[:field].visible?(:form) %>
+
+    <% nested_field = nested_attribute[:field] %>
+
+    <div class="mb-4 flex">
+      <%= render partial: nested_field.to_partial_path("form"), locals: { field: nested_field, record: f.object, form: f, resource: field.resource } %>
+    </div>
+  <% end %>
+
+  <small><%= link_to "Remove", "#", data: { action: "click->nested-form#remove_association" } %></small>
+
+  <%= f.hidden_field :_destroy %>
+
+<% end %>

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

@@ -0,0 +1,30 @@
+<%= form.label field.attribute_name, class: "inline-block w-32 flex-shrink-0" %>
+
+<div class="container space-y-8" data-controller="nested-form">
+  <template data-target="nested-form.template">
+
+    <%= form.fields_for field.attribute_name, field.to_model.new, child_index: 'NEW_RECORD' do |nested_form| %>
+      <%= render(
+        partial: field.to_partial_path('fields'),
+        locals: {
+          f: nested_form,
+          field: field
+        }
+      ) %>
+  <% end %>
+  </template>
+
+    <%= form.fields_for field.attribute_name do |nested_form| %>
+      <%= render(
+        partial: field.to_partial_path('fields'),
+        locals: {
+          f: nested_form,
+          field: field
+        }
+      ) %>
+  <% end %>
+
+  <%= content_tag :div, class: '', data: { target:"nested-form.links" } do %>
+    <%= link_to "+ Add new", "#",  data: { action: "click->nested-form#add_association" } %>
+  <% end %>
+</div>

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

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

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

@@ -0,0 +1,5 @@
+<% field.value(record).each do |object| %>
+  <div>
+    <%= link_to Madmin.resource_for(object).display_name(object), Madmin.resource_for(object).show_path(object) %>
+  </div>
+<% end %>

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

@@ -0,0 +1,2 @@
+<%= form.label field.attribute_name, class: "inline-block w-32 flex-shrink-0" %>
+<%= form.password_field field.attribute_name, class: "form-input" %>

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

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

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

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

data/lib/generators/madmin/resource/resource_generator.rb

@@ -46,6 +46,10 @@ module Madmin
       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")
@@ -63,6 +67,9 @@ module Madmin
       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
@@ -98,13 +105,17 @@ module Madmin
         if %w[id created_at updated_at].include?(name)
           {form: false}
 
-        # Attributes without a database column
-        elsif !model.column_names.include?(name)
-          {index: false}
+        # has_secure_passwords should only show on forms
+        elsif name.ends_with?("_confirmation") || virtual_attributes.include?("#{name}_confirmation")
+          {index: false, show: false}
 
         # Counter cache columns are typically not editable
         elsif name.ends_with?("_count")
           {form: false}
+
+        # Attributes without a database column
+        elsif !model.column_names.include?(name)
+          {index: false}
         end
       end
     end

data/lib/generators/madmin/resource/templates/resource.rb.tt

@@ -8,4 +8,9 @@ class <%= class_name %>Resource < Madmin::Resource
 <% associations.each do |association_name| -%>
   attribute :<%= association_name %>
 <% end -%>
+
+  # Uncomment this to customize the display name of records in the admin area.
+  # def self.display_name(record)
+  #   record.name
+  # end
 end

data/lib/generators/madmin/views/javascript_generator.rb

@@ -0,0 +1,15 @@
+require "madmin/view_generator"
+
+module Madmin
+  module Generators
+    module Views
+      class JavascriptGenerator < Madmin::ViewGenerator
+        source_root template_source_path
+
+        def copy_navigation
+          copy_resource_template("_javascript")
+        end
+      end
+    end
+  end
+end

data/lib/generators/madmin/views/views_generator.rb

@@ -4,11 +4,12 @@ module Madmin
   module Generators
     class ViewsGenerator < Madmin::ViewGenerator
       def copy_templates
-        view = "madmin:views:"
-        call_generator("#{view}index", resource_path, "--namespace", namespace)
-        call_generator("#{view}show", resource_path, "--namespace", namespace)
-        call_generator("#{view}new", resource_path, "--namespace", namespace)
-        call_generator("#{view}edit", resource_path, "--namespace", namespace)
+        # Some generators duplicate templates, so not everything is present here
+        call_generator("madmin:views:edit", resource_path, "--namespace", namespace)
+        call_generator("madmin:views:index", resource_path, "--namespace", namespace)
+        call_generator("madmin:views:layout", resource_path, "--namespace", namespace)
+        call_generator("madmin:views:new", resource_path, "--namespace", namespace)
+        call_generator("madmin:views:show", resource_path, "--namespace", namespace)
       end
     end
   end

data/lib/madmin.rb

@@ -8,24 +8,26 @@ module Madmin
   autoload :Resource, "madmin/resource"
 
   module Fields
+    autoload :Attachment, "madmin/fields/attachment"
+    autoload :Attachments, "madmin/fields/attachments"
+    autoload :BelongsTo, "madmin/fields/belongs_to"
     autoload :Boolean, "madmin/fields/boolean"
-    autoload :Integer, "madmin/fields/integer"
-    autoload :String, "madmin/fields/string"
-    autoload :Text, "madmin/fields/text"
     autoload :Date, "madmin/fields/date"
     autoload :DateTime, "madmin/fields/date_time"
     autoload :Decimal, "madmin/fields/decimal"
-    autoload :Json, "madmin/fields/json"
     autoload :Enum, "madmin/fields/enum"
     autoload :Float, "madmin/fields/float"
-    autoload :Time, "madmin/fields/time"
-    autoload :BelongsTo, "madmin/fields/belongs_to"
-    autoload :Polymorphic, "madmin/fields/polymorphic"
     autoload :HasMany, "madmin/fields/has_many"
     autoload :HasOne, "madmin/fields/has_one"
+    autoload :Integer, "madmin/fields/integer"
+    autoload :Json, "madmin/fields/json"
+    autoload :NestedHasMany, "madmin/fields/nested_has_many"
+    autoload :Password, "madmin/fields/password"
+    autoload :Polymorphic, "madmin/fields/polymorphic"
     autoload :RichText, "madmin/fields/rich_text"
-    autoload :Attachment, "madmin/fields/attachment"
-    autoload :Attachments, "madmin/fields/attachments"
+    autoload :String, "madmin/fields/string"
+    autoload :Text, "madmin/fields/text"
+    autoload :Time, "madmin/fields/time"
   end
 
   mattr_accessor :resources, default: []

data/lib/madmin/fields/belongs_to.rb

@@ -3,10 +3,11 @@ module Madmin
     class BelongsTo < Field
       def options_for_select(record)
         association = record.class.reflect_on_association(attribute_name)
-
         klass = association.klass
+        resource = nil
         klass.all.map do |r|
-          ["#{klass.name} ##{r.id}", r.id]
+          resource ||= Madmin.resource_for(r)
+          [resource.display_name(r), r.id]
         end
       end
 

data/lib/madmin/fields/has_many.rb

@@ -3,10 +3,11 @@ module Madmin
     class HasMany < Field
       def options_for_select(record)
         association = record.class.reflect_on_association(attribute_name)
-
         klass = association.klass
+        resource = nil
         klass.all.map do |r|
-          ["#{klass.name} ##{r.id}", r.id]
+          resource ||= Madmin.resource_for(r)
+          [resource.display_name(r), r.id]
         end
       end
 

data/lib/madmin/fields/nested_has_many.rb

@@ -0,0 +1,40 @@
+module Madmin
+  module Fields
+    class NestedHasMany < Field
+      DEFAULT_ATTRIBUTES = %w[_destroy id].freeze
+      def nested_attributes
+        resource.attributes.reject { |i| skipped_fields.include?(i[:name]) }
+      end
+
+      def resource
+        "#{to_model.name}Resource".constantize
+      end
+
+      def to_param
+        {"#{attribute_name}_attributes": permitted_fields}
+      end
+
+      def to_partial_path(name)
+        unless %w[index show form fields].include? name
+          raise ArgumentError, "`partial` must be 'index', 'show', 'form' or 'fields'"
+        end
+
+        "/madmin/fields/#{self.class.field_type}/#{name}"
+      end
+
+      def to_model
+        attribute_name.to_s.singularize.classify.constantize
+      end
+
+      private
+
+      def permitted_fields
+        (resource.permitted_params - skipped_fields + DEFAULT_ATTRIBUTES).uniq
+      end
+
+      def skipped_fields
+        options[:skip] || []
+      end
+    end
+  end
+end

data/lib/madmin/fields/password.rb

@@ -0,0 +1,6 @@
+module Madmin
+  module Fields
+    class Password < Field
+    end
+  end
+end

data/lib/madmin/resource.rb

@@ -18,6 +18,10 @@ module Madmin
         model_name.constantize
       end
 
+      def model_find(id)
+        friendly_model? ? model.friendly.find(id) : model.find(id)
+      end
+
       def model_name
         to_s.chomp("Resource").classify
       end
@@ -38,21 +42,27 @@ module Madmin
       end
 
       def index_path(options = {})
-        path = "/madmin/#{model.model_name.collection}"
-        path += "?#{options.to_param}" if options.any?
-        path
+        route_name = "madmin_#{model.table_name}_path"
+
+        url_helpers.send(route_name, options)
       end
 
       def new_path
-        "/madmin/#{model.model_name.collection}/new"
+        route_name = "new_madmin_#{model.model_name.singular}_path"
+
+        url_helpers.send(route_name)
       end
 
       def show_path(record)
-        "/madmin/#{model.model_name.collection}/#{record.id}"
+        route_name = "madmin_#{model.model_name.singular}_path"
+
+        url_helpers.send(route_name, record.to_param)
       end
 
       def edit_path(record)
-        "/madmin/#{model.model_name.collection}/#{record.id}/edit"
+        route_name = "edit_madmin_#{model.model_name.singular}_path"
+
+        url_helpers.send(route_name, record.to_param)
       end
 
       def param_key
@@ -67,6 +77,10 @@ module Madmin
         "#{record.class} ##{record.id}"
       end
 
+      def friendly_model?
+        model.respond_to? :friendly
+      end
+
       private
 
       def field_for_type(name, type)
@@ -90,6 +104,7 @@ module Madmin
           text: Fields::Text,
           time: Fields::Time,
           timestamp: Fields::Time,
+          password: Fields::Password,
 
           # Postgres specific types
           bit: Fields::String,
@@ -126,7 +141,8 @@ module Madmin
           polymorphic: Fields::Polymorphic,
           has_many: Fields::HasMany,
           has_one: Fields::HasOne,
-          rich_text: Fields::RichText
+          rich_text: Fields::RichText,
+          nested_has_many: Fields::NestedHasMany
         }.fetch(type)
       rescue
         raise ArgumentError, <<~MESSAGE
@@ -157,6 +173,10 @@ module Madmin
           :attachment
         elsif model.reflect_on_association(:"#{name_string}_attachments")
           :attachments
+
+        # has_secure_password
+        elsif model.attribute_types.include?("#{name_string}_digest") || name_string.ends_with?("_confirmation")
+          :password
         end
       end
 
@@ -171,6 +191,10 @@ module Madmin
           :belongs_to
         end
       end
+
+      def url_helpers
+        @url_helpers ||= Rails.application.routes.url_helpers
+      end
     end
   end
 end

data/lib/madmin/version.rb

@@ -1,3 +1,3 @@
 module Madmin
-  VERSION = "1.0.2"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: madmin
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Chris Oliver
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-04 00:00:00.000000000 Z
+date: 2021-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -111,6 +111,13 @@ files:
 - app/views/madmin/fields/json/_form.html.erb
 - app/views/madmin/fields/json/_index.html.erb
 - app/views/madmin/fields/json/_show.html.erb
+- app/views/madmin/fields/nested_has_many/_fields.html.erb
+- app/views/madmin/fields/nested_has_many/_form.html.erb
+- app/views/madmin/fields/nested_has_many/_index.html.erb
+- app/views/madmin/fields/nested_has_many/_show.html.erb
+- app/views/madmin/fields/password/_form.html.erb
+- app/views/madmin/fields/password/_index.html.erb
+- app/views/madmin/fields/password/_show.html.erb
 - app/views/madmin/fields/polymorphic/_form.html.erb
 - app/views/madmin/fields/polymorphic/_index.html.erb
 - app/views/madmin/fields/polymorphic/_show.html.erb
@@ -134,6 +141,7 @@ files:
 - lib/generators/madmin/views/edit_generator.rb
 - lib/generators/madmin/views/form_generator.rb
 - lib/generators/madmin/views/index_generator.rb
+- lib/generators/madmin/views/javascript_generator.rb
 - lib/generators/madmin/views/layout_generator.rb
 - lib/generators/madmin/views/navigation_generator.rb
 - lib/generators/madmin/views/new_generator.rb
@@ -155,6 +163,8 @@ files:
 - lib/madmin/fields/has_one.rb
 - lib/madmin/fields/integer.rb
 - lib/madmin/fields/json.rb
+- lib/madmin/fields/nested_has_many.rb
+- lib/madmin/fields/password.rb
 - lib/madmin/fields/polymorphic.rb
 - lib/madmin/fields/rich_text.rb
 - lib/madmin/fields/string.rb