madmin 0.1.0 → 1.0.1

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

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

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

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

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

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

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

@@ -1,4 +1,2 @@
-<div class="form-group">
-  <%= form.label field.key, field.label %>
-  <%= form.text_field field.key, class: "form-control" %>
-</div>
+<%= form.label field.attribute_name, class: "inline-block w-32 flex-shrink-0" %>
+<%= form.text_area field.attribute_name, class: "form-input" %>

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

@@ -1 +1 @@
-<%= field.value_for(resource) %>
+<%= field.value(record) %>

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

@@ -1,8 +1 @@
-<div class="row">
-  <div class="col-3">
-    <%= field.label %>
-  </div>
-  <div class="col-9">
-    <%= field.value_for(resource) %>
-  </div>
-</div>
+<%= field.value(record) %>

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

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

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

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

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

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

data/lib/generators/madmin/install/install_generator.rb

@@ -1,4 +1,3 @@
-require "rails/generators/base"
 require "madmin/generator_helpers"
 
 module Madmin
@@ -6,25 +5,45 @@ module Madmin
     class InstallGenerator < Rails::Generators::Base
       include Madmin::GeneratorHelpers
 
-      def generate_resources
-        resources.each do |model|
-          call_generator "madmin:resource", model.to_s
+      source_root File.expand_path("../templates", __FILE__)
+
+      def eager_load
+        Rails.application.eager_load!
+      end
+
+      def copy_controller
+        template("controller.rb.tt", "app/controllers/madmin/application_controller.rb")
+      end
+
+      def generate_routes
+        if route_namespace_exists?
+          route "root to: \"dashboard#show\"", indentation: 4, sentinel: /namespace :madmin do\s*\n/m
+        else
+          route "root to: \"dashboard#show\"", namespace: [:madmin]
         end
       end
 
-      def install_route
-        inject_into_file(
-          Rails.root.join("config/routes.rb"),
-          after: "Rails.application.routes.draw do\n"
-        ) { "  namespace :madmin do\n  end\n  mount Madmin::Engine => \"/madmin\"\n" }
+      def generate_resources
+        generateable_models.each do |model|
+          if model.table_exists?
+            call_generator "madmin:resource", model.to_s
+          else
+            puts "Skipping #{model} because database table does not exist"
+          end
+        end
       end
 
       private
 
-      def resources
-        Rails.application.eager_load! unless Rails.application.config.cache_classes
+      # Skip Abstract classes, ActiveRecord::Base, and auto-generated HABTM models
+      def generateable_models
+        active_record_models.reject do |model|
+          model.abstract_class? || model == ActiveRecord::Base || model.name.start_with?("HABTM_")
+        end
+      end
 
-        ActiveRecord::Base.descendants.reject(&:abstract_class?)
+      def active_record_models
+        ObjectSpace.each_object(ActiveRecord::Base.singleton_class)
       end
     end
   end

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

@@ -0,0 +1,22 @@
+module Madmin
+  class ApplicationController < Madmin::BaseController
+    before_action :authenticate_admin_user
+
+    def authenticate_admin_user
+      # TODO: Add your authentication logic here
+
+      # For example, we could redirect if the user isn't an admin
+      # redirect_to "/", alert: "Not authorized." unless user_signed_in? && current_user.admin?
+    end
+
+    # Authenticate with Clearance
+    # include Clearance::Controller
+    # before_action :require_login
+
+    # Authenticate with Devise
+    # before_action :authenticate_user!
+
+    # Authenticate with Basic Auth
+    # http_basic_authenticate_with(name: Rails.application.credentials.admin_username, password: Rails.application.credentials.admin_password)
+  end
+end

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

@@ -1,75 +1,111 @@
-require "rails/generators/named_base"
-require "madmin/generator_helpers"
-
 module Madmin
   module Generators
     class ResourceGenerator < Rails::Generators::NamedBase
-      ATTRIBUTE_TYPE_MAPPING = {
-        boolean: "Field::CheckBox",
-        date: "Field::DateTime",
-        datetime: "Field::DateTime",
-        enum: "Field::Text",
-        float: "Field::Number",
-        integer: "Field::Number",
-        time: "Field::DateTime",
-        text: "Field::TextArea",
-        string: "Field::Text",
-      }
+      include Madmin::GeneratorHelpers
 
       source_root File.expand_path("../templates", __FILE__)
 
-      def create_resource_file
-        template(
-          "resource.rb.erb",
-          Rails.root.join("app/madmin/resources/#{file_name}.rb"),
-        )
+      def eager_load
+        Rails.application.eager_load!
       end
 
-      private
+      def generate_resource
+        template "resource.rb", "app/madmin/resources/#{file_path}_resource.rb"
+      end
 
-      def attributes
-        klass.attribute_types.map { |name, attr|
-          # Skip attributes related to associations
-          next if ignored_attributes.include?(name)
+      def generate_controller
+        destination = Rails.root.join("app/controllers/madmin/#{file_path.pluralize}_controller.rb")
+        template("controller.rb", destination)
+      end
 
-          [name, madmin_type_for_column(attr.type)]
-        }.compact
+      def generate_route
+        if route_namespace_exists?
+          route "resources :#{plural_name}", namespace: class_path, indentation: 4, sentinel: /namespace :madmin do\s*\n/m
+        else
+          route "resources :#{plural_name}", namespace: [:madmin] + class_path
+        end
       end
 
+      private
+
       def associations
-        klass.reflections.map do |name, association|
-          if association.polymorphic?
-            [name, "Field::Polymorphic"]
-          elsif association.belongs_to?
-            [name, "Field::BelongsTo"]
-          elsif association.has_one?
-            [name, "Field::HasOne"]
-          else
-            [name, "Field::HasMany"]
+        model.reflections.reject { |name, association|
+          # Hide these special associations
+          name.starts_with?("rich_text") ||
+            name.ends_with?("_attachment") ||
+            name.ends_with?("_attachments") ||
+            name.ends_with?("_blob") ||
+            name.ends_with?("_blobs")
+        }.keys
+      end
+
+      def attributes
+        model.attribute_names + virtual_attributes - redundant_attributes
+      end
+
+      def virtual_attributes
+        virtual = []
+
+        # Add virtual attributes for ActionText and ActiveStorage
+        model.reflections.each do |name, association|
+          if name.starts_with?("rich_text")
+            virtual << name.split("rich_text_").last
+          elsif name.ends_with?("_attachment")
+            virtual << name.split("_attachment").first
+          elsif name.ends_with?("_attachments")
+            virtual << name.split("_attachments").first
           end
         end
+
+        virtual
       end
 
-      def ignored_attributes
-        attrs = []
+      def redundant_attributes
+        redundant = []
 
-        klass.reflections.map do |name, association|
-          if association.polymorphic?
-            attrs += [association.foreign_key, association.foreign_type]
-          elsif association.belongs_to?
-            attrs += [association.foreign_key]
+        model.reflections.each do |name, association|
+          if association.has_one?
+            next
+          elsif association.collection?
+            next
+          elsif association.polymorphic?
+            redundant << "#{name}_id"
+            redundant << "#{name}_type"
+          elsif name.starts_with?("rich_text")
+            redundant << name
+          else # belongs to
+            redundant << "#{name}_id"
           end
         end
 
-        attrs
+        redundant
+      end
+
+      def model
+        @model ||= class_name.constantize
       end
 
-      def klass
-        @klass ||= Object.const_get(class_name)
+      def formatted_options_for_attribute(name)
+        options = options_for_attribute(name)
+        return if options.blank?
+
+        ", " + options.map { |key, value|
+          "#{key}: #{value}"
+        }.join(", ")
       end
 
-      def madmin_type_for_column(column_type)
-        ATTRIBUTE_TYPE_MAPPING[column_type]
+      def options_for_attribute(name)
+        if %w[id created_at updated_at].include?(name)
+          {form: false}
+
+        # Attributes without a database column
+        elsif !model.column_names.include?(name)
+          {index: false}
+
+        # Counter cache columns are typically not editable
+        elsif name.ends_with?("_count")
+          {form: false}
+        end
       end
     end
   end

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

@@ -0,0 +1,4 @@
+module Madmin
+  class <%= class_name.pluralize %>Controller < Madmin::ResourceController
+  end
+end

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

@@ -0,0 +1,11 @@
+class <%= class_name %>Resource < Madmin::Resource
+  # Attributes
+<% 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 -%>
+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/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

@@ -1,14 +1,14 @@
-require "rails/generators/base"
+require "madmin/view_generator"
 
 module Madmin
   module Generators
-    class ViewsGenerator < Rails::Generators::Base
-      desc("Copies views for customizing Madmin's views")
-
-      source_root File.expand_path("../../../../..", __FILE__)
-
-      def copy_views
-        directory "app/views/madmin", "app/views/madmin"
+    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)
       end
     end
   end