super 0.0.0 → 0.0.1

data/lib/generators/super/install/USAGE

@@ -0,0 +1,32 @@
+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
+        app/super/.keep
+
+Example:
+    rails generate super:install --controller-namespace badminton
+
+    This will create:
+        config/initializers/super.rb
+        app/controllers/badminton_controller.rb
+        app/controllers/badminton/.keep
+        app/super/.keep

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

@@ -0,0 +1,47 @@
+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 create_directory_for_dashboards_slash_setup
+      empty_directory("app/super")
+      create_file("app/super/.keep", "")
+    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,9 @@
+Description:
+    Creates a controller and its respective "control".
+
+Example:
+    rails generate super:resource Thing
+
+    This will create:
+        app/controllers/admin/things_controller.rb
+        app/controls/thing_controls.rb

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

@@ -0,0 +1,54 @@
+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"
+      )
+
+      template("resource_dashboard.rb", "app/super/#{file_path}_dashboard.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/resource_dashboard.rb.tt

@@ -0,0 +1,65 @@
+class <%= class_name %>Dashboard
+  def title
+    <%= class_name %>.name.pluralize
+  end
+
+  def model
+    <%= class_name %>
+  end
+
+  def index_scope
+    <%= class_name %>.all
+  end
+
+  def index_schema
+    Super::Schema.new(Super::Display::SchemaTypes.new) do |fields, type|
+    end
+  end
+
+  def create_scope
+    <%= class_name %>.all
+  end
+
+  def create_permitted_params(params)
+    params.require(:<%= file_name %>).permit()
+  end
+
+  def new_scope
+    <%= class_name %>.all
+  end
+
+  def new_schema
+    Super::Schema.new(Super::Form::SchemaTypes.new) do |fields, type|
+    end
+  end
+
+  def edit_scope
+    <%= class_name %>.all
+  end
+
+  def edit_schema
+    Super::Schema.new(Super::Form::SchemaTypes.new) do |fields, type|
+    end
+  end
+
+  def show_scope
+    <%= class_name %>.all
+  end
+
+  def show_schema
+    Super::Schema.new(Super::Display::SchemaTypes.new) do |fields, type|
+    end
+  end
+
+  def update_scope
+    <%= class_name %>.all
+  end
+
+  def update_permitted_params(params)
+    params.require(:<%= file_name %>).permit()
+  end
+
+  def destroy_scope
+    <%= class_name %>.all
+  end
+end

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

@@ -0,0 +1,9 @@
+<% wrap_with_configured_module do -%>
+class <%= class_name.pluralize %>Controller < <%= parent_controller_name %>
+  private
+
+  def dashboard
+    <%= class_name %>Dashboard.new
+  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,17 @@
+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 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,18 @@
-require "super/engine"
+require "tsort"
+require "active_support/concern"
 
-module Super
-  # Your code goes here...
-end
+require "super/assets"
+require "super/configuration"
+require "super/controls"
+require "super/engine"
+require "super/error"
+require "super/display"
+require "super/display/schema_types"
+require "super/form/schema_types"
+require "super/inline_callback"
+require "super/navigation/automatic"
+require "super/pagination"
+require "super/plugin"
+require "super/schema"
+require "super/version"
+require "super/view"

data/lib/super/assets.rb

@@ -0,0 +1,62 @@
+module Super
+  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/configuration.rb

@@ -0,0 +1,88 @@
+module Super
+  def self.configuration
+    @configuration ||= Configuration.new
+
+    if block_given?
+      yield(@configuration)
+    end
+
+    @configuration
+  end
+
+  module ConfigurationLogic
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    def initialize
+      self.class.defaults.each do |key, value|
+        if value.respond_to?(:call)
+          value = value.call
+        end
+
+        public_send("#{key}=", value)
+      end
+    end
+
+    def configured?(attr)
+      instance_variable_defined?("@#{attr}")
+    end
+
+    module ClassMethods
+      def defaults
+        @defaults ||= {}
+      end
+
+      def wraps
+        @wraps ||= {}
+      end
+
+      def configure(attr, wrap: nil, enum: nil, **kwargs)
+        if kwargs.key?(:default)
+          defaults[attr] = kwargs[:default]
+        end
+
+        define_method(attr) do
+          if !configured?(attr)
+            raise Error::UnconfiguredConfiguration, "unconfigured: #{attr}"
+          end
+
+          result = instance_variable_get("@#{attr}")
+
+          if wrap.nil?
+            result
+          else
+            wrap.call(result)
+          end
+        end
+
+        define_method("#{attr}=") do |value|
+          if enum.is_a?(Array)
+            if !enum.include?(value)
+              raise Error::InvalidConfiguration,
+                "tried to set `#{attr}` to `#{value.inspect}`, " \
+                "expected: #{enum.join(", ")}"
+            end
+          end
+
+          instance_variable_set("@#{attr}", value)
+          value
+        end
+      end
+    end
+  end
+
+  class Configuration
+    include ConfigurationLogic
+
+    configure :title
+    configure :index_resources_per_page, default: 20
+    configure :controller_namespace, default: "admin"
+    configure :route_namespace, default: :admin, wrap: -> (val) { [val].flatten }
+    configure :asset_handler, default: -> { Super::Assets.auto }
+
+    def path_parts(*parts)
+      route_namespace + parts
+    end
+  end
+end