jav_madmin 2.6.2

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

@@ -0,0 +1,73 @@
+module Madmin
+  module Generators
+    class ResourceGenerator < Rails::Generators::NamedBase
+      include Madmin::GeneratorHelpers
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def eager_load
+        Rails.application.eager_load!
+      end
+
+      def generate_resource
+        template "resource.rb", "app/madmin/resources/#{file_path}_resource.rb"
+      end
+
+      def generate_controller
+        destination = Rails.root.join("app/controllers/madmin/#{file_path.pluralize}_controller.rb")
+        template("controller.rb", destination)
+      end
+
+      def generate_route
+        if route_namespace_exists?
+          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
+      end
+
+      private
+
+      def model
+        @model ||= class_name.constantize
+      end
+
+      def resource_builder
+        @resource_builder ||= ResourceBuilder.new(model)
+      end
+
+      def model_attributes
+        resource_builder.attributes
+      end
+
+      delegate :associations, :virtual_attributes, :store_accessors, to: :resource_builder
+
+      def formatted_options_for_attribute(name)
+        options = options_for_attribute(name)
+        return if options.blank?
+
+        ", " + options.map { |key, value|
+          "#{key}: #{value}"
+        }.join(", ")
+      end
+
+      def options_for_attribute(name)
+        if %w[id created_at updated_at].include?(name)
+          {form: 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) && !store_accessors.map(&:to_s).include?(name)
+          {index: false}
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+module Madmin
+  class <%= class_name.pluralize %>Controller < Madmin::ResourceController
+<% if class_name == "ActiveStorage::Blob" -%>
+    def new
+      super
+      @record.assign_attributes(filename: "")
+    end
+<% end -%>
+  end
+end

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

@@ -0,0 +1,33 @@
+class <%= class_name %>Resource < Madmin::Resource
+  # Attributes
+<% model_attributes.each do |attribute_name| -%>
+  attribute :<%= attribute_name %><%= formatted_options_for_attribute(attribute_name) %>
+<% end -%>
+
+  # Associations
+<% associations.each do |association_name| -%>
+  attribute :<%= association_name %>
+<% end -%>
+
+  # Add scopes to easily filter records
+  # scope :published
+
+  # Add actions to the resource's show page
+  # Pass collection: true to also render it in each row on the index page
+  # member_action do |record|
+  #   link_to "Do Something", some_path
+  # end
+
+  # Add actions to the resource's index page
+  # collection_action do
+  #   link_to "Bulk Import", bulk_import_path, class: "btn btn-secondary"
+  # end
+
+  # Customize the display name of records in the admin area.
+  # def self.display_name(record) = record.name
+
+  # Customize the default sort column and direction.
+  # def self.default_sort_column = "created_at"
+  #
+  # def self.default_sort_direction = "desc"
+end

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

@@ -0,0 +1,16 @@
+require "madmin/view_generator"
+
+module Madmin
+  module Generators
+    module Views
+      class EditGenerator < Madmin::ViewGenerator
+        source_root template_source_path
+
+        def copy_edit
+          copy_resource_template("edit")
+          copy_resource_template("_form")
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,15 @@
+require "madmin/view_generator"
+
+module Madmin
+  module Generators
+    module Views
+      class IndexGenerator < Madmin::ViewGenerator
+        source_root template_source_path
+
+        def copy_template
+          copy_resource_template("index")
+        end
+      end
+    end
+  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/layout_generator.rb

@@ -0,0 +1,21 @@
+require "madmin/view_generator"
+
+module Madmin
+  module Generators
+    module Views
+      class LayoutGenerator < Madmin::ViewGenerator
+        source_root template_source_path
+
+        def copy_template
+          copy_file(
+            "../../layouts/madmin/application.html.erb",
+            "app/views/layouts/madmin/application.html.erb"
+          )
+
+          call_generator("madmin:views:navigation")
+          copy_resource_template("_javascript")
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,16 @@
+require "madmin/view_generator"
+
+module Madmin
+  module Generators
+    module Views
+      class NewGenerator < Madmin::ViewGenerator
+        source_root template_source_path
+
+        def copy_new
+          copy_resource_template("new")
+          copy_resource_template("_form")
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,16 @@
+require "madmin/view_generator"
+
+module Madmin
+  module Generators
+    class ViewsGenerator < Madmin::ViewGenerator
+      def copy_templates
+        # 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
+end

data/lib/madmin/engine.rb

@@ -0,0 +1,47 @@
+module Madmin
+  class Engine < ::Rails::Engine
+    isolate_namespace Madmin
+
+    config.before_configuration do |app|
+      app.config.eager_load_paths << app.root.join("app/madmin/resources")
+      app.config.eager_load_paths << app.root.join("app/madmin/fields")
+      Madmin.resource_locations << Rails.root.join("app/madmin/resources/")
+
+      Rails::Engine.subclasses.each do |engine|
+        app.config.eager_load_paths << engine.root.join("app/madmin/resources")
+        app.config.eager_load_paths << engine.root.join("app/madmin/fields")
+        Madmin.resource_locations << engine.root.join("app/madmin/resources/")
+      end
+    end
+
+    config.to_prepare do
+      Madmin.reset_resources!
+      Madmin.site_name ||= Rails.application.class.module_parent_name.titleize
+    end
+
+    initializer "madmin.assets" do |app|
+      if app.config.respond_to?(:assets)
+        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
+
+        Madmin.stylesheets << "lexxy" if defined?(::Lexxy)
+      end
+    end
+
+    initializer "madmin.importmap", before: "importmap" do |app|
+      Madmin.importmap.draw root.join("config/importmap.rb")
+      Madmin.importmap.cache_sweeper watches: root.join("app/javascript")
+
+      ActiveSupport.on_load(:action_controller_base) do
+        before_action { Madmin.importmap.cache_sweeper.execute_if_updated }
+      end
+    end
+  end
+end

data/lib/madmin/field.rb

@@ -0,0 +1,67 @@
+module Madmin
+  class Field
+    attr_reader :attribute_name, :model, :options, :resource
+
+    def self.field_type
+      to_s.split("::").last.underscore
+    end
+
+    def initialize(attribute_name:, model:, resource:, options:)
+      @attribute_name = attribute_name.to_sym
+      @model = model
+      @resource = resource
+      @options = options
+    end
+
+    def value(record)
+      record.try(attribute_name)
+    end
+
+    def to_partial_path(name)
+      unless %w[index show form].include? name.to_s
+        raise ArgumentError, "`partial` must be 'index', 'show', or 'form'"
+      end
+
+      "/madmin/fields/#{self.class.field_type}/#{name}"
+    end
+
+    def to_param
+      attribute_name
+    end
+
+    def label
+      options[:label].presence || model.human_attribute_name(attribute_name)
+    end
+
+    # Used for checking visibility of attribute on an view
+    def visible?(action)
+      action = action.to_sym
+      options.fetch(action) do
+        case action
+        when :index
+          default_index_attributes.include?(attribute_name)
+        else
+          true
+        end
+      end
+    end
+
+    def default_index_attributes
+      [model.primary_key.to_sym, :avatar, :title, :name, :user, :created_at]
+    end
+
+    def required?
+      model.validators_on(attribute_name).any? { |v| v.is_a? ActiveModel::Validations::PresenceValidator }
+    end
+
+    def searchable?
+      false
+    end
+
+    def paginateable?
+      false
+    end
+
+    ActiveSupport.run_load_hooks(:madmin_field, self)
+  end
+end

data/lib/madmin/fields/attachment.rb

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

data/lib/madmin/fields/attachments.rb

@@ -0,0 +1,9 @@
+module Madmin
+  module Fields
+    class Attachments < Field
+      def to_param
+        {attribute_name => []}
+      end
+    end
+  end
+end

data/lib/madmin/fields/belongs_to.rb

@@ -0,0 +1,29 @@
+module Madmin
+  module Fields
+    class BelongsTo < Field
+      def options_for_select(record)
+        current_value = record.send(attribute_name)
+        records = [current_value].compact + associated_resource.model.excluding(current_value).limit(25)
+        records.map { [Madmin.resource_for(_1).display_name(_1), _1.id] }
+      end
+
+      def to_param
+        "#{attribute_name}_id"
+      end
+
+      def index_path(format: :json)
+        associated_resource&.index_path(format: format)
+      end
+
+      def associated_resource
+        Madmin.resource_by_name(model.reflect_on_association(attribute_name).klass)
+      rescue MissingResource
+      end
+
+      def associated_resource_for(object)
+        Madmin.resource_for(object)
+      rescue MissingResource
+      end
+    end
+  end
+end

data/lib/madmin/fields/boolean.rb

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

data/lib/madmin/fields/currency.rb

@@ -0,0 +1,15 @@
+module Madmin
+  module Fields
+    class Currency < Field
+      def value(record)
+        value = record.public_send(attribute_name)
+        value /= 100.0 if value && options.minor_units
+        value
+      end
+
+      def searchable?
+        options.fetch(:searchable, model.column_names.include?(attribute_name.to_s))
+      end
+    end
+  end
+end

data/lib/madmin/fields/date.rb

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

data/lib/madmin/fields/date_time.rb

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

data/lib/madmin/fields/decimal.rb

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

data/lib/madmin/fields/enum.rb

@@ -0,0 +1,9 @@
+module Madmin
+  module Fields
+    class Enum < Field
+      def options_for_select(record)
+        model.defined_enums[attribute_name.to_s].keys
+      end
+    end
+  end
+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/float.rb

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

data/lib/madmin/fields/has_many.rb

@@ -0,0 +1,62 @@
+module Madmin
+  module Fields
+    class HasMany < Field
+      def options_for_select(record)
+        if (records = record.send(attribute_name))
+          return [] unless records.first
+          resource = Madmin.resource_for(records.first)
+          records.map { |record| [resource.display_name(record), record.id] }
+        else
+          []
+        end
+      end
+
+      def to_param
+        {"#{attribute_name.to_s.singularize}_ids": []}
+      end
+
+      def index_path(format: :json)
+        associated_resource&.index_path(format: format)
+      end
+
+      def associated_resource
+        Madmin.resource_by_name(model.reflect_on_association(attribute_name).klass)
+      rescue MissingResource
+      end
+
+      def associated_resource_for(object)
+        Madmin.resource_for(object)
+      rescue MissingResource
+      end
+
+      def paginateable?
+        true
+      end
+
+      if Gem::Version.new(Pagy::VERSION) >= Gem::Version.new("43.0.0.rc")
+        include Pagy::Method
+
+        def paginated_value(record, params)
+          page_key = "#{attribute_name}_page"
+          request = {
+            params: {
+              "#{attribute_name}_page" => [params[page_key].to_i, 1].max
+            }
+          }
+          pagy value(record), page_key: page_key, request: request
+        rescue Pagy::OptionError
+        end
+      else
+        include Pagy::Backend
+
+        def paginated_value(record, params)
+          page_key = "#{attribute_name}_page"
+          page = [params[page_key].to_i, 1].max
+          pagy value(record), page: page, page_param: page_key
+        rescue Pagy::OverflowError, Pagy::VariableError
+          pagy value, page: 1, page_param: page_key
+        end
+      end
+    end
+  end
+end

data/lib/madmin/fields/has_one.rb

@@ -0,0 +1,10 @@
+module Madmin
+  module Fields
+    class HasOne < Field
+      def associated_resource_for(object)
+        Madmin.resource_for(object)
+      rescue MissingResource
+      end
+    end
+  end
+end

data/lib/madmin/fields/integer.rb

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

data/lib/madmin/fields/json.rb

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

data/lib/madmin/fields/nested_has_many.rb

@@ -0,0 +1,44 @@
+module Madmin
+  module Fields
+    class NestedHasMany < HasMany
+      DEFAULT_ATTRIBUTES = %w[_destroy id].freeze
+      def nested_attributes
+        resource.attributes.except(*skipped_fields)
+      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
+
+      def paginateable?
+        true
+      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/fields/polymorphic.rb

@@ -0,0 +1,22 @@
+module Madmin
+  module Fields
+    class Polymorphic < Field
+      def options_for_select(record)
+        if (collection = options[:collection])
+          collection.call
+        else
+          [value(record)].compact
+        end
+      end
+
+      def to_param
+        {attribute_name => %i[type value]}
+      end
+
+      def associated_resource_for(object)
+        Madmin.resource_for(object)
+      rescue MissingResource
+      end
+    end
+  end
+end