super 0.0.11 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05520525a7f38fff438eee43a134b9b2e52ac3551098c177323cdb87fd193670
-  data.tar.gz: 0db34e8d60114592b824ec79a2318a11743fe676291859ccec0d81615ce77bfb
+  metadata.gz: 645a472c963d0e09e2d4b8646fc54c82b780b4cd60b47daac01b7434d9f37111
+  data.tar.gz: 7fa33b28be8edffa88ca94c919ae79f96287e071e84ab2f84dbb51a66a72d0e4
 SHA512:
-  metadata.gz: 489419d94f150b08399cfab907773f7cbafc08d7bbf6d2db3af0b8966b81b5cfc1d547fe1a8bb066f72fdac41b04d4b6295715468356de9442d66ae546ff890a
-  data.tar.gz: 806ca79ae33691eca540cd1350210ef4cf75fc427be26731068f307687e50643fe02999c473a39d90fe58f267e2f3aa5bd5e35d580c273b625f787c7176941b3
+  metadata.gz: a91b5535467f835d8cd87c5a02f2e09f086455bedaa02d529dc896c025eefc67ef9162954ab9159c79915bbcfdfb70729443d524137efe6173a7a07cbb20b598
+  data.tar.gz: f6f3d9ff8e7ce16cd1470b9b8ad1f7f982cbf2e13428e0fb6e47380fa17c1438e4e63832a7a9db8db1e9d32a8639c5847c2621572a9f0845fa18725116336777

data/.yardopts

@@ -1,13 +1,5 @@
 --exclude lib/generators
 --markup markdown
---load ./docs/yard_customizations.rb
 -
 CONTRIBUTING.md
-STABILITY.md
 LICENSE
-docs/quick_start.md
-docs/installation.md
-docs/webpacker.md
-docs/action_text.md
-docs/cheat.md
-docs/faq.md

data/README.md

@@ -2,7 +2,8 @@
 
 ![Unit tests status](https://github.com/zachahn/super/workflows/Unit%20tests/badge.svg?branch=master)
 [![Gem](https://img.shields.io/gem/v/super)][gem]
-[![Try the demo](https://img.shields.io/badge/try-demo-blue)][demo]
+[![Try the demo](https://img.shields.io/badge/demo-try-blue)][demo]
+[![Read the docs](https://img.shields.io/badge/docs-available-brightgreen)][docs]
 
 
 Super is an admin framework for Ruby on Rails applications. Super helps you make
@@ -48,13 +49,7 @@ See the [stability doc](./STABILITY.md) for an idea of what might be changed.
 
 
 See the [demo][demo] and its [source][demo_source] for an example of some of its
-features.
-
-
-## Installation and Usage
-
-See [Installation](./docs/quick_start.md) and
-[Quick start](./docs/quick_start.md)
+features. See the [docs][docs] for a walkthrough.
 
 
 ## Editions
@@ -101,6 +96,7 @@ The gem is available under the terms of the [GNU LGPLv3](./LICENSE).
 
 [gem]: https://rubygems.org/gems/super
 [discussions]: https://github.com/zachahn/super/discussions
+[docs]: https://superadministration.github.io/
 [newsletter]: https://tinyletter.com/zachahn
 [demo]: https://demo-super.herokuapp.com/admin/members
 [demo_source]: https://github.com/zachahn/super_demo

data/app/controllers/super/application_controller.rb

@@ -38,7 +38,7 @@ module Super
       @record = controls.build_record_with_params(action: action_inquirer, params: params)
 
       if controls.save_record(action: action_inquirer, record: @record, params: params)
-        redirect_to polymorphic_path(Super.configuration.path_parts(@record))
+        redirect_to polymorphic_path(Super::Link.polymorphic_parts(@record))
       else
         @form = controls.form_schema(action: action_inquirer_for("new"))
         @view = controls.new_view
@@ -58,7 +58,7 @@ module Super
       @record = controls.load_record(action: action_inquirer, params: params)
 
       if controls.update_record(action: action_inquirer, record: @record, params: params)
-        redirect_to polymorphic_path(Super.configuration.path_parts(@record))
+        redirect_to polymorphic_path(Super::Link.polymorphic_parts(@record))
       else
         @form = controls.form_schema(action: action_inquirer_for("edit"))
         @view = controls.edit_view
@@ -71,14 +71,14 @@ module Super
       @record = controls.load_record(action: action_inquirer, params: params)
 
       if controls.destroy_record(action: action_inquirer, record: @record, params: params)
-        redirect_to polymorphic_path(Super.configuration.path_parts(controls.model))
+        redirect_to polymorphic_path(Super::Link.polymorphic_parts(@record))
       else
         flash.alert = "Couldn't delete record"
-        redirect_to polymorphic_path(Super.configuration.path_parts(@record))
+        redirect_to polymorphic_path(Super::Link.polymorphic_parts(@record))
       end
     rescue ActiveRecord::InvalidForeignKey => e
       flash.alert = "Couldn't delete record: #{e.class}"
-      redirect_to polymorphic_path(Super.configuration.path_parts(@record))
+      redirect_to polymorphic_path(Super::Link.polymorphic_parts(@record))
     end
 
     private

data/app/views/layouts/super/application.html.erb

@@ -38,9 +38,7 @@
     <div class="px-4">
       <header class="pt-4">
         <h1 class="text-lg font-bold mr-6 mb-1"><%= Super.configuration.title %></h1>
-        <%
-        route_namespace = Super.configuration.route_namespace.map(&:to_s).join("/")
-        Super::Navigation::Automatic.new(route_namespace: route_namespace).each do |text, href| %>
+        <% Super::Navigation::Automatic.new.each do |text, href| %>
           <%= link_to(text, href, class: "inline-block mr-6") %>
         <% end %>
       </header>

data/app/views/super/application/{_super_schema_display_index.html.erb → _display_index.html.erb}

@@ -2,7 +2,7 @@
   <table class="w-full border-separate relative" cellspacing="0" cellpadding="0">
     <thead class="">
       <tr class="">
-        <% super_schema_display_index.each_attribute_name do |attribute_name| %>
+        <% display_index.each_attribute_name do |attribute_name| %>
           <th class="p-2 first:pl-6 border-b border-b-2 border-gray-400 text-gray-600 text-left text-sm font-normal bg-white top-0 z-10">
             <%= controls.model.human_attribute_name(attribute_name) %>
           </th>
@@ -12,9 +12,9 @@
     <tbody class="">
       <% @records.each.with_index do |record, row_index| %>
         <tr id="record-pk-<%= record.id %>" class="group">
-          <% super_schema_display_index.each_attribute_name do |attribute_name| %>
+          <% display_index.each_attribute_name do |attribute_name| %>
             <td class="py-1 px-2 first:pl-5 border-transparent border-t border-b group-hover:bg-blue-200 first:border-l first:rounded-l-lg last:border-r last:rounded-r-lg bg-white <%= Super::ViewHelper.classes(["bg-gray-100", row_index.odd?]) %>">
-              <%= super_schema_display_index.render_field(template: self, record: record, column: attribute_name) %>
+              <%= display_index.render_attribute(template: self, record: record, column: attribute_name) %>
             </td>
           <% end %>
         </tr>

data/app/views/super/application/_display_show.html.erb

@@ -0,0 +1,8 @@
+<table class="max-w-full mt-4">
+  <% display_show.each_attribute_name do |attribute_name| %>
+    <tr>
+      <th class="py-1 align-baseline text-right px-4"><%= controls.model.human_attribute_name(attribute_name) %></th>
+      <td class="py-1 align-baseline"><%= display_show.render_attribute(template: self, record: @record, column: attribute_name) %></td>
+    </tr>
+  <% end %>
+</table>

data/app/views/super/application/{_super_schema_form.html.erb → _form.html.erb}

@@ -1,6 +1,6 @@
-<%= super_form_for(Super.configuration.path_parts(@record), builder: Super::Form::Builder) do |f| %>
+<%= super_form_for(Super::Link.polymorphic_parts(@record), builder: Super::Form::Builder) do |f| %>
   <div class="max-w-3xl">
-    <% super_schema_form.each_attribute do |field, type| %>
+    <% form.each_attribute do |field, type| %>
       <%= render(
         type,
         form: f,

data/app/views/super/application/{_super_layout.html.erb → _layout.html.erb}

@@ -1,29 +1,29 @@
-<% super_layout.resolve(self) %>
+<% layout.resolve(self) %>
 
-<% super_layout.resolved_headers.each do |partial| %>
+<% layout.resolved_headers.each do |partial| %>
   <%= Super::Partial.render(partial, template: self) %>
 <% end %>
 
-<% if super_layout.resolved_asides.empty? %>
-  <% super_layout.resolved_mains.each do |partial| %>
+<% if layout.resolved_asides.empty? %>
+  <% layout.resolved_mains.each do |partial| %>
     <%= Super::Partial.render(partial, template: self) %>
   <% end %>
 <% else %>
   <div class="clearfix -mx-2">
     <div class="md:float-left md:w-9/12 px-2">
-      <% super_layout.resolved_mains.each do |partial| %>
+      <% layout.resolved_mains.each do |partial| %>
         <%= Super::Partial.render(partial, template: self) %>
       <% end %>
     </div>
 
     <div class="md:float-right md:w-3/12 px-2">
-      <% super_layout.resolved_asides.each do |partial| %>
+      <% layout.resolved_asides.each do |partial| %>
         <%= Super::Partial.render(partial, template: self) %>
       <% end %>
     </div>
   </div>
 <% end %>
 
-<% super_layout.resolved_footers.each do |partial| %>
+<% layout.resolved_footers.each do |partial| %>
   <%= Super::Partial.render(partial, template: self) %>
 <% end %>

data/app/views/super/application/{_super_pagination.html.erb → _pagination.html.erb}

@@ -5,7 +5,7 @@
         <%= link_to(
           display,
           polymorphic_path(
-            Super.configuration.path_parts(controls.model),
+            Super::Link.polymorphic_parts(controls.model),
             page_query_params
           ),
           class: "inline-block ml-2 text-lg #{is_current_page ? " text-gray-900" : ""}"

data/app/views/super/application/{_super_panel.html.erb → _panel.html.erb}

@@ -1,6 +1,6 @@
-<% if super_panel.resolve(self, block_given? ? Proc.new { yield } : nil).resolved_parts.any? %>
+<% if panel.resolve(self, block_given? ? Proc.new { yield } : nil).resolved_parts.any? %>
   <div class="border rounded shadow border-gray-400 bg-white px-5 pt-4 pb-8 mt-6">
-    <% super_panel.resolved_parts.each do |partial| %>
+    <% panel.resolved_parts.each do |partial| %>
       <%= Super::Partial.render(partial, template: self) %>
     <% end %>
   </div>

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

@@ -9,6 +9,12 @@ module Super
     class_option :route_namespace, type: :string, default: "admin",
       banner: "Specifies the route namespace for admin controllers"
 
+    def assert_not_controller_namespace_not_super
+      if controller_namespace == "super"
+        raise Super::Error::ArgumentError, "controller_namespace can not be `super`"
+      end
+    end
+
     def create_initializer
       template("initializer.rb", "config/initializers/super.rb")
     end
@@ -16,8 +22,7 @@ module Super
     def create_base_admin_controller
       template(
         "base_controller.rb",
-        "app/controllers/#{controller_namespace}_controller.rb",
-        controller_namespace: controller_namespace
+        "app/controllers/#{parent_controller_name}_controller.rb"
       )
     end
 
@@ -53,12 +58,16 @@ module Super
 
     private
 
+    def route_namespace
+      options[:route_namespace].strip.gsub(%r{\A/+}, "").gsub(%r{/+\z}, "").strip.underscore
+    end
+
     def controller_namespace
-      if options["controller_namespace"].blank?
-        "admin"
-      else
-        options["controller_namespace"]
-      end
+      options["controller_namespace"].strip.gsub(%r{\A/+}, "").gsub(%r{/+\z}, "").strip.underscore
+    end
+
+    def parent_controller_name
+      controller_namespace.presence || "admin"
     end
   end
 end

data/lib/generators/super/install/templates/base_controller.rb.tt

@@ -1,2 +1,10 @@
-class <%= config[:controller_namespace].classify %>Controller < Super::ApplicationController
+class <%= parent_controller_name.classify %>Controller < Super::ApplicationController
+  class <%= parent_controller_name.classify.demodulize %>Controls < Super::Controls
+  end
+
+  private
+
+  def new_controls
+    self.class::Controls.new
+  end
 end

data/lib/generators/super/install/templates/initializer.rb.tt

@@ -1,5 +1,12 @@
 Super.configuration do |c|
   c.title = "My Admin Site"
-  c.controller_namespace = "<%= options["controller_namespace"] %>"
-  c.route_namespace = "<%= options["route_namespace"] %>"
+<% if route_namespace != "admin" -%>
+  c.path = "/<%= route_namespace %>"
+<% end -%>
+<% if route_namespace != "admin" -%>
+  c.generator_as = "<%= route_namespace.gsub(%r{/}, "_") %>"
+<% end -%>
+<% if controller_namespace != "admin" -%>
+  c.generator_module = "<%= controller_namespace %>"
+<% end -%>
 end

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

@@ -1,54 +1,129 @@
 # frozen_string_literal: true
 
+require "rails/generators/resource_helpers"
+
 module Super
   class ResourceGenerator < Rails::Generators::NamedBase
+    include Rails::Generators::ResourceHelpers
     source_root File.expand_path("templates", __dir__)
 
-    def create_controller
-      controller_subdir =
-        if Super.configuration.controller_namespace.present?
-          "#{Super.configuration.controller_namespace}/"
-        else
-          ""
-        end
+    check_class_collision suffix: "Controller"
+
+    class_option :skip_routes, type: :boolean, desc: "Don't add routes to config/routes.rb."
+
+    def initialize(*)
+      super
+
+      controller_namespace = Super.configuration.generator_module
+      if controller_namespace.present?
+        controller_name =
+          if controller_namespace.include?("/")
+            "#{controller_namespace}/#{name}"
+          else
+            "#{controller_namespace}::#{name}"
+          end
+        self.options = options.dup
+        options[:model_name] = name
+        options.freeze
+        assign_names!(name)
+        assign_controller_names!(controller_name.pluralize)
+      else
+        assign_names!(name)
+        assign_controller_names!(name.pluralize)
+      end
+    end
 
+    def create_controller
       template(
         "resources_controller.rb",
-        "app/controllers/#{controller_subdir}#{file_path.pluralize}_controller.rb"
+        File.join("app/controllers", controller_class_path, "#{controller_file_name}_controller.rb")
       )
     end
 
-    private
+    def create_route_namespace
+      data = route_scope
+      return if data.nil?
+      return if File.read(File.join(destination_root, "config", "routes.rb")).include?(data)
 
-    def wrap_with_configured_module(&block)
-      indentation_amount =
-        if Super.configuration.controller_namespace.present?
-          2
-        else
-          0
-        end
+      inject_into_file(
+        "config/routes.rb",
+        "#{data}\nend\n".indent(2),
+        after: /^Rails\.application\.routes\.draw\b.*$\r?\n\r?/,
+        verbose: true,
+        force: false
+      )
+    end
 
-      inner = capture(&block)
-      inner = indent(inner, indentation_amount).chomp
+    def add_admin_route
+      data = route_scope
 
-      if Super.configuration.controller_namespace.present?
-        concat("module #{Super.configuration.controller_namespace.camelize}\n")
+      if data.nil?
+        route("resources :#{file_name.pluralize}")
+      else
+        inject_into_file(
+          "config/routes.rb",
+          "resources :#{file_name.pluralize}\n".indent(4),
+          after: /#{data}.*$\r?\n\r?/,
+          verbose: true,
+          force: false
+        )
       end
+    end
 
-      concat(inner)
-      concat("\n")
+    private
 
-      if Super.configuration.controller_namespace.present?
-        concat("end\n")
-      end
+    def parent_controller_name
+      controller_namespace.presence || "admin"
     end
 
-    def parent_controller_name
-      if Super.configuration.controller_namespace.present?
-        "#{Super.configuration.controller_namespace.camelize}Controller"
-      else
-        "AdminController"
+    def controller_namespace
+      Super.configuration.generator_module.strip.gsub(%r{\A/+}, "").gsub(%r{/+\z}, "").strip.underscore
+    end
+
+    def route_scope
+      return nil if no_scope?
+
+      if use_scope?
+        kwargs = []
+        kwargs.push(%(path: "/#{g_path}")) if g_path.present?
+        kwargs.push(%(module: "#{g_module}")) if g_module.present?
+        kwargs.push(%(as: "#{g_as}")) if g_as.present?
+        return %(scope #{kwargs.join(", ")} do)
       end
+
+      %(namespace :#{g_module} do)
+    end
+
+    def use_scope?
+      return true if !same?
+      return true if g_module.include?("/")
+      return true if g_path.include?("/")
+
+      false
+    end
+
+    def no_scope?
+      g_module.blank? && g_path.blank? && g_as.blank?
+    end
+
+    def same?
+      g_module == g_path && g_path == g_as
+    end
+
+    def g_module
+      normalized_scope_part(Super.configuration.generator_module || "")
+    end
+
+    def g_path
+      normalized_scope_part(Super.configuration.path || "")
+    end
+
+    def g_as
+      normalized_scope_part(Super.configuration.generator_as || "")
+    end
+
+    def normalized_scope_part(part)
+      part.strip.gsub(%r{\A/+}, "").gsub(%r{/+\z}, "").strip
     end
   end
 end

data/lib/generators/super/resource/templates/resources_controller.rb.tt

@@ -1,12 +1,6 @@
-<% wrap_with_configured_module do -%>
-class <%= class_name.pluralize %>Controller < <%= parent_controller_name %>
-  private
-
-  def new_controls
-    Controls.new
-  end
-
-  class Controls < Super::Controls
+<% module_namespacing do -%>
+class <%= controller_class_name %>Controller < <%= parent_controller_name.classify %>Controller
+  class Controls < <%= parent_controller_name.classify.demodulize %>Controls
     def model
       <%= class_name %>
     end