madmin 1.0.0.beta2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e0427cd7d7dd77a86ef9b7cfd6b08af93cc2f6f542a7992b69d63328c483e26
-  data.tar.gz: f85af965580b168e7efa890049ca58a46d9710ab3484ed99b45acf7267a7859c
+  metadata.gz: 40199d348bebb973f7b9dc6b6a850bd5c68ff022643384a65acfc59960f86dbb
+  data.tar.gz: 7f672c9ad00abe803c5be58c57da8c163d944a5a7d152af6e4471830f3460ee9
 SHA512:
-  metadata.gz: b63ca0956bd1a730d686b7f35252e951f0bb88743df2a2d9fa025120a82647a141e1e20dae3052f889e4d1db7bbf69328ab26e1285d1c602a58b0e625f084eed
-  data.tar.gz: 11783c59ee3445c594dd2ce51ea5b24ee5942d59f59a2ae6f444ff8991f353e298473f6dfcf8e38c923248458dd38957cd3d8aead6e4c18d1821abcce023a10e
+  metadata.gz: c27c66fa995081db788c99036b9a5cd4ea1bec2aaf7d3450a4c633fed0b9e8a9b73658dbc8eda4df0e9f894010f88f4696126c3f1322a886706f8f91195ca3fe
+  data.tar.gz: 4311d571bca085e92b2dad5902a2ede438347efdb910897fe391efe5764bb9a37b2c1c1228d376e305d11d2fb6712f3d8f4077e4d024dc5d017fdf9e53a14dbe

data/README.md

@@ -37,6 +37,29 @@ To generate a resource for a model, you can run:
 rails g madmin:resource ActionText::RichText
 ```
 
+## 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.
+
+You can use the included generator to create the appropriate view files, which can then be customized.
+
+For example, running the following will copy over all of the views into your application that will be used for every resource:
+```bash
+rails generate madmin:views
+```
+
+If you only need to customize specific views, you can restrict which views are copied by the generator:
+```bash
+rails g madmin:views:index
+ # -> app/views/madmin/application/index.html.erb
+```
+
+You can also scope the copied view(s) to a specific Resource/Model:
+```bash
+rails generate madmin:views:index Book
+ # -> app/views/madmin/books/index.html.erb
+```
+
 ## 🙏 Contributing
 
 This project uses Standard for formatting Ruby code. Please make sure to run standardrb before submitting pull requests.

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

@@ -0,0 +1,15 @@
+require "madmin/view_generator"
+
+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)
+      end
+    end
+  end
+end

data/lib/madmin/namespace.rb

@@ -0,0 +1,35 @@
+module Madmin
+  class Namespace
+    def initialize(namespace)
+      @namespace = namespace
+    end
+
+    def resources
+      @resources ||= routes.map(&:first).uniq.map { |path|
+        Resource.new(namespace, path)
+      }
+    end
+
+    def routes
+      @routes ||= all_routes.select { |controller, _action|
+        controller.starts_with?("#{namespace}/")
+      }.map { |controller, action|
+        [controller.gsub(/^#{namespace}\//, ""), action]
+      }
+    end
+
+    def resources_with_index_route
+      routes.select { |_resource, route| route == "index" }.map(&:first).uniq
+    end
+
+    private
+
+    attr_reader :namespace
+
+    def all_routes
+      Rails.application.routes.routes.map do |route|
+        route.defaults.values_at(:controller, :action).map(&:to_s)
+      end
+    end
+  end
+end

data/lib/madmin/version.rb

@@ -1,3 +1,3 @@
 module Madmin
-  VERSION = "1.0.0.beta2"
+  VERSION = "1.0.0"
 end

data/lib/madmin/view_generator.rb

@@ -0,0 +1,42 @@
+require "rails/generators/base"
+require "madmin/generator_helpers"
+require "madmin/namespace"
+
+module Madmin
+  class ViewGenerator < Rails::Generators::Base
+    include Madmin::GeneratorHelpers
+    class_option :namespace, type: :string, default: "madmin"
+
+    def self.template_source_path
+      File.expand_path(
+        "../../../app/views/madmin/application",
+        __FILE__
+      )
+    end
+
+    private
+
+    def namespace
+      options[:namespace]
+    end
+
+    def copy_resource_template(template_name)
+      template_file = "#{template_name}.html.erb"
+
+      copy_file(
+        template_file,
+        "app/views/#{namespace}/#{resource_path}/#{template_file}"
+      )
+    end
+
+    def resource_path
+      args.first.try(:underscore).try(:pluralize) || BaseResourcePath.new
+    end
+
+    class BaseResourcePath
+      def to_s
+        "application"
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: madmin
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta2
+  version: 1.0.0
 platform: ruby
 authors:
 - Chris Oliver
@@ -131,6 +131,14 @@ files:
 - lib/generators/madmin/resource/resource_generator.rb
 - lib/generators/madmin/resource/templates/controller.rb.tt
 - lib/generators/madmin/resource/templates/resource.rb.tt
+- 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/layout_generator.rb
+- lib/generators/madmin/views/navigation_generator.rb
+- lib/generators/madmin/views/new_generator.rb
+- lib/generators/madmin/views/show_generator.rb
+- lib/generators/madmin/views/views_generator.rb
 - lib/madmin.rb
 - lib/madmin/engine.rb
 - lib/madmin/field.rb
@@ -153,8 +161,10 @@ files:
 - lib/madmin/fields/text.rb
 - lib/madmin/fields/time.rb
 - lib/madmin/generator_helpers.rb
+- lib/madmin/namespace.rb
 - lib/madmin/resource.rb
 - lib/madmin/version.rb
+- lib/madmin/view_generator.rb
 - lib/tasks/madmin_tasks.rake
 homepage: https://github.com/excid3/madmin
 licenses:
@@ -171,9 +181,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.2.3
 signing_key: