super 0.0.0 → 0.0.5

data/lib/generators/super/install/USAGE

@@ -0,0 +1,34 @@
+Description:
+    Set up all required files for the Super admin framework.
+
+Options:
+    --controller-namespace
+        This specifies the directory into which generated controllers should be
+        placed. This also specifies the parent controller that all Super admin
+        pages would inherit from (see examples). Generated controllers will
+        automatically inherit from the controller that is specified through this
+        option.
+
+    --route-namespace
+        Since this generator only creates one inheritable parent controller,
+        this option only affects the generated initializer.
+
+Example:
+    rails generate super:install
+
+    This will create:
+        config/initializers/super.rb
+        app/controllers/admin_controller.rb
+        app/controllers/admin/.keep
+
+    This will also update your Sprockets manifest as necessary.
+
+Example:
+    rails generate super:install --controller-namespace badminton
+
+    This will create:
+        config/initializers/super.rb
+        app/controllers/badminton_controller.rb
+        app/controllers/badminton/.keep
+
+    This will also update your Sprockets manifest as necessary.

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

@@ -0,0 +1,46 @@
+module Super
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("templates", __dir__)
+
+    class_option :controller_namespace, type: :string, default: "admin",
+      banner: "Specifies where to place generated admin controllers"
+    class_option :route_namespace, type: :string, default: "admin",
+      banner: "Specifies the route namespace for admin controllers"
+
+    def create_initializer
+      template("initializer.rb", "config/initializers/super.rb")
+    end
+
+    def create_base_admin_controller
+      template(
+        "base_controller.rb",
+        "app/controllers/#{controller_namespace}_controller.rb",
+        controller_namespace: controller_namespace
+      )
+    end
+
+    def create_directory_for_admin_controllers
+      if options["controller_namespace"].blank?
+        empty_directory("app/controllers")
+        return
+      end
+
+      empty_directory("app/controllers/#{controller_namespace}")
+      create_file("app/controllers/#{controller_namespace}/.keep", "")
+    end
+
+    def setup_sprockets4_manifest
+      append_to_file "app/assets/config/manifest.js", "//= link super_manifest.js\n"
+    end
+
+    private
+
+    def controller_namespace
+      if options["controller_namespace"].blank?
+        "admin"
+      else
+        options["controller_namespace"]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,2 @@
+class <%= config[:controller_namespace].classify %>Controller < Super::ApplicationController
+end

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

@@ -0,0 +1,5 @@
+Super.configuration do |c|
+  c.title = "My Admin Site"
+  c.controller_namespace = "<%= options["controller_namespace"] %>"
+  c.route_namespace = "<%= options["route_namespace"] %>"
+end

data/lib/generators/super/resource/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Creates a controller
+
+Example:
+    rails generate super:resource Thing
+
+    This will create:
+        app/controllers/admin/things_controller.rb

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

@@ -0,0 +1,52 @@
+module Super
+  class ResourceGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path("templates", __dir__)
+
+    def create_controller
+      controller_subdir =
+        if Super.configuration.controller_namespace.present?
+          "#{Super.configuration.controller_namespace}/"
+        else
+          ""
+        end
+
+      template(
+        "resources_controller.rb",
+        "app/controllers/#{controller_subdir}#{file_path.pluralize}_controller.rb"
+      )
+    end
+
+    private
+
+    def wrap_with_configured_module(&block)
+      indentation_amount =
+        if Super.configuration.controller_namespace.present?
+          2
+        else
+          0
+        end
+
+      inner = capture(&block)
+      inner = indent(inner, indentation_amount).chomp
+
+      if Super.configuration.controller_namespace.present?
+        concat("module #{Super.configuration.controller_namespace.camelize}\n")
+      end
+
+      concat(inner)
+      concat("\n")
+
+      if Super.configuration.controller_namespace.present?
+        concat("end\n")
+      end
+    end
+
+    def parent_controller_name
+      if Super.configuration.controller_namespace.present?
+        "#{Super.configuration.controller_namespace.camelize}Controller"
+      else
+        "AdminController"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+<% wrap_with_configured_module do -%>
+class <%= class_name.pluralize %>Controller < <%= parent_controller_name %>
+  private
+
+  def new_controls
+    Controls.new
+  end
+
+  class Controls
+    def title
+      <%= class_name %>.name.pluralize
+    end
+
+    def model
+      <%= class_name %>
+    end
+
+    def scope(action:)
+      if action.read?
+        <%= class_name %>.all
+      else
+        <%= class_name %>.all
+      end
+    end
+
+    def permitted_params(params, action:)
+      if action.create?
+        params.require(:<%= file_name %>).permit()
+      else
+        params.require(:<%= file_name %>).permit()
+      end
+    end
+
+    def display_schema(action:)
+      Super::Schema.new(Super::Display::SchemaTypes.new) do |fields, type|
+      end
+    end
+
+    def form_schema(action:)
+      Super::Schema.new(Super::Form::SchemaTypes.new) do |fields, type|
+      end
+    end
+  end
+end
+<% end -%>

data/lib/generators/super/webpacker/USAGE

@@ -0,0 +1,14 @@
+Description:
+    Creates the necessary files for assets to be served under Webpacker
+
+    Webpacker support requires ERB support. There are no other dependencies.
+
+    Installing ERB on webpacker is usually done by running the command:
+    `rails webpacker:install:erb`
+
+Example:
+    rails webpacker:install:erb             # if you hadn't set up ERB already
+    rails generate super:install:webpacker
+
+    This will create:
+        app/javascript/packs/super/application.js.erb

data/lib/generators/super/webpacker/templates/pack_super_application.js.erb.tt

@@ -0,0 +1,2 @@
+import Super from "<%%= Super::Assets.dist("super", "super-frontend").join("application") %>";
+import "<%%= Super::Assets.dist("super", "super-frontend").join("application.css") %>";

data/lib/generators/super/webpacker/webpacker_generator.rb

@@ -0,0 +1,25 @@
+module Super
+  class WebpackerGenerator < Rails::Generators::Base
+    source_root File.expand_path("templates", __dir__)
+
+    def copy_the_pack_file
+      template(
+        "pack_super_application.js.erb",
+        "app/javascript/packs/super/application.js.erb"
+      )
+    end
+
+    def set_asset_handler_to_webpacker
+      insert_into_file(
+        "config/initializers/super.rb",
+        "  c.asset_handler = Super::Assets.webpacker\n",
+        before: /\bend\b/
+      )
+    end
+
+    def remind_about_erb
+      say "Make sure ERB is set up for Webpacker!", :bold
+      say "Run if needed: rails webpacker:install:erb", :bold
+    end
+  end
+end

data/lib/super.rb

@@ -1,5 +1,23 @@
-require "super/engine"
+require "active_support/concern"
 
-module Super
-  # Your code goes here...
-end
+require "super/action_inquirer"
+require "super/assets"
+require "super/compatibility"
+require "super/configuration"
+require "super/controls"
+require "super/display"
+require "super/display/schema_types"
+require "super/engine"
+require "super/error"
+require "super/form/schema_types"
+require "super/layout"
+require "super/link"
+require "super/navigation/automatic"
+require "super/pagination"
+require "super/panel"
+require "super/partial"
+require "super/plugin"
+require "super/schema"
+require "super/step"
+require "super/version"
+require "super/view_helper"

data/lib/super/action_inquirer.rb

@@ -0,0 +1,101 @@
+module Super
+  # ```ruby
+  # action = Super::ActionInquirer.new(
+  #   Super::ActionInquirer.default_resources,
+  #   :index
+  # )
+  #
+  # action.read? # => true
+  # action.index? # => true
+  # action.show? # => false
+  # action.write? # => false
+  # ```
+  class ActionInquirer
+    attr_reader :action
+
+    # @return [Hash<Symbol, Array<Symbol>>] default settings for initialization
+    #
+    def self.default_resources
+      {
+        read: %i[index show new edit],
+        write: %i[create update destroy],
+        delete: %i[destroy]
+      }
+    end
+
+    def initialize(categories_and_their_actions, action)
+      @categories = categories_and_their_actions.keys.map(&:to_s)
+      @actions = categories_and_their_actions.values.flatten.uniq.map(&:to_s)
+      @actions_categories = {}
+
+      categories_and_their_actions.each do |c, actions|
+        c = c.to_s
+
+        actions.each do |a|
+          a = a.to_s
+          @actions_categories[a] ||= []
+          @actions_categories[a].push(c)
+        end
+      end
+
+      intersection = @categories & @actions
+      if intersection.any?
+        raise Error::ActionInquirerError,
+          "Found shared elements between categories and actions: #{intersection.join(", ")}"
+      end
+
+      self.action = action
+    end
+
+    def action=(new_action)
+      new_action = new_action.to_s
+      if !@actions.include?(new_action)
+        raise Error::ActionInquirerError, "Unknown action: #{new_action}"
+      end
+
+      @action = new_action
+    end
+
+    def respond_to_missing?(method_name, *)
+      inquiry = parse_inquiry(method_name)
+
+      return super if !inquiry
+
+      @actions.include?(inquiry) || @categories.include?(inquiry) || super
+    end
+
+    def method_missing(method_name, *)
+      inquiry = parse_inquiry(method_name)
+
+      return super if !inquiry
+
+      if @actions.include?(inquiry)
+        matches_action?(inquiry)
+      elsif @categories.include?(inquiry)
+        matches_category?(inquiry)
+      else
+        super
+      end
+    end
+
+    private
+
+    def parse_inquiry(method_name)
+      inquiry = method_name.to_s
+
+      if inquiry[-1] != "?"
+        return nil
+      end
+
+      inquiry.chomp("?")
+    end
+
+    def matches_action?(inquiry)
+      @action == inquiry
+    end
+
+    def matches_category?(inquiry)
+      @actions_categories[@action].include?(inquiry)
+    end
+  end
+end

data/lib/super/assets.rb

@@ -0,0 +1,63 @@
+module Super
+  # Utilities for determining whether to use Sprockets or Webpacker
+  class Assets
+    def self.sprockets_available?
+      Gem::Dependency.new("sprockets").matching_specs.any?
+    end
+
+    def self.dist(gem_name, package_name)
+      gem_name = gem_name.to_s
+
+      @gem_paths ||= {}
+      @gem_paths[gem_name] ||= Pathname.new(Gem.loaded_specs[gem_name].full_gem_path).expand_path
+      gem_path = @gem_paths[gem_name]
+
+      gem_path.join("frontend", package_name, "dist")
+    end
+
+    def self.auto
+      @auto ||=
+        if Gem::Dependency.new("sprockets", "~> 4.0").matching_specs.any?
+          sprockets
+        elsif Gem::Dependency.new("sprockets", "~> 3.0").matching_specs.any?
+          sprockets
+        elsif Gem::Dependency.new("sprockets", "~> 2.0").matching_specs.any?
+          sprockets
+        elsif Gem::Dependency.new("webpacker", "~> 4.0").matching_specs.any?
+          webpacker
+        elsif Gem::Dependency.new("webpacker", "~> 3.0").matching_specs.any?
+          webpacker
+        else
+          none
+        end
+    end
+
+    def self.sprockets
+      new(:sprockets)
+    end
+
+    def self.webpacker
+      new(:webpacker)
+    end
+
+    def self.none
+      new(:none)
+    end
+
+    def initialize(asset_handler)
+      @asset_handler = asset_handler
+    end
+
+    def sprockets?
+      @asset_handler == :sprockets
+    end
+
+    def webpacker?
+      @asset_handler == :webpacker
+    end
+
+    def none?
+      @asset_handler == :none
+    end
+  end
+end

data/lib/super/compatibility.rb

@@ -0,0 +1,13 @@
+module Super
+  module Compatability
+    module_function
+
+    def rails_50_errable_fields(field)
+      if Rails::VERSION::MAJOR == 5 && Rails::VERSION::MINOR == 0
+        [field.to_s, field.to_sym]
+      else
+        field
+      end
+    end
+  end
+end