super 0.0.1 → 0.0.6

data/lib/generators/super/install/USAGE

@@ -20,7 +20,8 @@ Example:
         config/initializers/super.rb
         app/controllers/admin_controller.rb
         app/controllers/admin/.keep
-        app/super/.keep
+
+    This will also update your Sprockets manifest as necessary.
 
 Example:
     rails generate super:install --controller-namespace badminton
@@ -29,4 +30,5 @@ Example:
         config/initializers/super.rb
         app/controllers/badminton_controller.rb
         app/controllers/badminton/.keep
-        app/super/.keep
+
+    This will also update your Sprockets manifest as necessary.

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

@@ -29,9 +29,24 @@ module Super
       create_file("app/controllers/#{controller_namespace}/.keep", "")
     end
 
-    def create_directory_for_dashboards_slash_setup
-      empty_directory("app/super")
-      create_file("app/super/.keep", "")
+    def copy_cheatsheet
+      super_path = Pathname.new(Gem.loaded_specs["super"].full_gem_path).expand_path
+      super_cheat_path = super_path.join("docs", "cheat.md")
+
+      path =
+        if options["controller_namespace"].present?
+          "app/controllers/#{controller_namespace}/README.md"
+        else
+          "app/controllers/README.md"
+        end
+
+      create_file(path) do
+        super_cheat_path.read.sub(%r{<!--.*?-->}m, "").strip + "\n"
+      end
+    end
+
+    def setup_sprockets4_manifest
+      append_to_file "app/assets/config/manifest.js", "//= link super_manifest.js\n"
     end
 
     private

data/lib/generators/super/resource/USAGE

@@ -1,9 +1,8 @@
 Description:
-    Creates a controller and its respective "control".
+    Creates a controller
 
 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

@@ -14,8 +14,6 @@ module Super
         "resources_controller.rb",
         "app/controllers/#{controller_subdir}#{file_path.pluralize}_controller.rb"
       )
-
-      template("resource_dashboard.rb", "app/super/#{file_path}_dashboard.rb")
     end
 
     private

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

@@ -2,8 +2,44 @@
 class <%= class_name.pluralize %>Controller < <%= parent_controller_name %>
   private
 
-  def dashboard
-    <%= class_name %>Dashboard.new
+  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/webpacker_generator.rb

@@ -9,6 +9,14 @@ module Super
       )
     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

data/lib/super.rb

@@ -1,18 +1,23 @@
-require "tsort"
 require "active_support/concern"
 
+require "super/action_inquirer"
 require "super/assets"
+require "super/client_error"
+require "super/compatibility"
 require "super/configuration"
 require "super/controls"
+require "super/display/schema_types"
 require "super/engine"
 require "super/error"
-require "super/display"
-require "super/display/schema_types"
+require "super/form"
 require "super/form/schema_types"
-require "super/inline_callback"
+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/version"
-require "super/view"
+require "super/view_helper"

data/lib/super/action_inquirer.rb

@@ -0,0 +1,101 @@
+module Super
+  # ```ruby
+  # action = Super::ActionInquirer.new(
+  #   Super::ActionInquirer.default_for_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_for_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

@@ -1,4 +1,5 @@
 module Super
+  # Utilities for determining whether to use Sprockets or Webpacker
   class Assets
     def self.sprockets_available?
       Gem::Dependency.new("sprockets").matching_specs.any?

data/lib/super/client_error.rb

@@ -0,0 +1,43 @@
+module Super
+  # A container class for all user-facing (4xx) errors thrown by this library.
+  #
+  # See also `Super::Error`
+  class ClientError < StandardError
+    class BadRequest < ClientError; end
+    class Unauthorized < ClientError; end
+    class Forbidden < ClientError; end
+    class NotFound < ClientError; end
+    class UnprocessableEntity < ClientError; end
+
+    module Handling
+      extend ActiveSupport::Concern
+
+      included do
+        rescue_from ::Super::ClientError do |exception|
+          code, default_message =
+            case exception
+            when ClientError::UnprocessableEntity
+              [422, "Unprocessable entity"]
+            when ClientError::NotFound
+              [404, "Not found"]
+            when ClientError::Forbidden
+              [403, "Forbidden"]
+            when ClientError::Unauthorized
+              [401, "Unauthorized"]
+            when ClientError::BadRequest, ClientError
+              [400, "Bad request"]
+            end
+
+          flash.now.alert =
+            if exception.message == exception.class.name.to_s
+              default_message
+            else
+              exception.message
+            end
+
+          render "nothing", status: code
+        end
+      end
+    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

data/lib/super/configuration.rb

@@ -1,4 +1,6 @@
 module Super
+  # @yield [Configuration]
+  # @return [Configuration]
   def self.configuration
     @configuration ||= Configuration.new
 
@@ -9,78 +11,91 @@ module Super
     @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)
+  # Allows setting global configuration
+  #
+  # ```ruby
+  # Super.configuration do |c|
+  #   c.title = "My Admin Site"
+  # end
+  # ```
+  class Configuration
+    module ConfigurationLogic # @api private
+      def self.included(base)
+        base.extend(ClassMethods)
       end
-    end
 
-    def configured?(attr)
-      instance_variable_defined?("@#{attr}")
-    end
+      def initialize
+        self.class.defaults.each do |key, value|
+          if value.respond_to?(:call)
+            value = value.call
+          end
 
-    module ClassMethods
-      def defaults
-        @defaults ||= {}
+          public_send("#{key}=", value)
+        end
       end
 
-      def wraps
-        @wraps ||= {}
+      def configured?(attr)
+        instance_variable_defined?("@#{attr}")
       end
 
-      def configure(attr, wrap: nil, enum: nil, **kwargs)
-        if kwargs.key?(:default)
-          defaults[attr] = kwargs[:default]
+      module ClassMethods
+        def defaults
+          @defaults ||= {}
         end
 
-        define_method(attr) do
-          if !configured?(attr)
-            raise Error::UnconfiguredConfiguration, "unconfigured: #{attr}"
+        def wraps
+          @wraps ||= {}
+        end
+
+        def configure(attr, wrap: nil, enum: nil, **kwargs)
+          if kwargs.key?(:default)
+            defaults[attr] = kwargs[:default]
           end
 
-          result = instance_variable_get("@#{attr}")
+          define_method(attr) do
+            if !configured?(attr)
+              raise Error::UnconfiguredConfiguration, "unconfigured: #{attr}"
+            end
 
-          if wrap.nil?
-            result
-          else
-            wrap.call(result)
-          end
-        end
+            result = instance_variable_get("@#{attr}")
 
-        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(", ")}"
+            if wrap.nil?
+              result
+            else
+              wrap.call(result)
             end
           end
 
-          instance_variable_set("@#{attr}", value)
-          value
+          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
-  end
 
-  class Configuration
     include ConfigurationLogic
 
+    # @!attribute [rw]
     configure :title
-    configure :index_resources_per_page, default: 20
+    # @!attribute [rw]
+    configure :index_records_per_page, default: 20
+    # @!attribute [rw]
     configure :controller_namespace, default: "admin"
+    # @!attribute [rw]
     configure :route_namespace, default: :admin, wrap: -> (val) { [val].flatten }
+    # @!attribute [rw]
     configure :asset_handler, default: -> { Super::Assets.auto }
 
+    # @api private
     def path_parts(*parts)
       route_namespace + parts
     end