super 0.0.2 → 0.0.7

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

@@ -29,6 +29,22 @@ module Super
       create_file("app/controllers/#{controller_namespace}/.keep", "")
     end
 
+    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

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,19 +1,29 @@
 require "tsort"
-require "active_support/concern"
+
+require "rails/engine"
 
 require "super/action_inquirer"
 require "super/assets"
+require "super/client_error"
+require "super/compatibility"
 require "super/configuration"
 require "super/controls"
-require "super/engine"
-require "super/error"
-require "super/display"
 require "super/display/schema_types"
+require "super/error"
+require "super/filter"
+require "super/filter/operator"
+require "super/filter/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"
+
+require "super/engine"

data/lib/super/action_inquirer.rb

@@ -1,8 +1,21 @@
 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
 
-    def self.default_resources
+    # @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],

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,25 @@
+module Super
+  module Compatability
+    module_function
+
+    # Rails 5.1 and after lets you find field errors using either a string or a
+    # symbol.
+    def errable_fields(field)
+      if Rails::VERSION::MAJOR == 5 && Rails::VERSION::MINOR == 0
+        [field.to_s, field.to_sym]
+      else
+        field
+      end
+    end
+
+    def sanitize_sql_like(query)
+      if ActiveRecord::VERSION::MAJOR == 4
+        ActiveRecord::Base.send(:sanitize_sql_like, query)
+      elsif ActiveRecord::VERSION::MAJOR == 5 && ActiveRecord::VERSION::MINOR <= 1
+        ActiveRecord::Base.send(:sanitize_sql_like, query)
+      else
+        ActiveRecord::Base.sanitize_sql_like(query)
+      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,98 @@ module Super
     @configuration
   end
 
-  module ConfigurationLogic
-    def self.included(base)
-      base.extend(ClassMethods)
-    end
+  # 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
+
+      def initialize
+        self.class.defaults.each do |key, value|
+          if value.respond_to?(:call)
+            value = value.call
+          end
 
-    def initialize
-      self.class.defaults.each do |key, value|
-        if value.respond_to?(:call)
-          value = value.call
+          public_send("#{key}=", value)
         end
 
-        public_send("#{key}=", value)
+        Plugin::Registry.controller.use(prepend: Super::Filter::ControllerMethods)
+        Plugin::Registry.controller.use(prepend: Super::Pagination::ControllerMethods)
       end
-    end
-
-    def configured?(attr)
-      instance_variable_defined?("@#{attr}")
-    end
 
-    module ClassMethods
-      def defaults
-        @defaults ||= {}
+      def configured?(attr)
+        instance_variable_defined?("@#{attr}")
       end
 
-      def wraps
-        @wraps ||= {}
-      end
+      module ClassMethods
+        def defaults
+          @defaults ||= {}
+        end
 
-      def configure(attr, wrap: nil, enum: nil, **kwargs)
-        if kwargs.key?(:default)
-          defaults[attr] = kwargs[:default]
+        def wraps
+          @wraps ||= {}
         end
 
-        define_method(attr) do
-          if !configured?(attr)
-            raise Error::UnconfiguredConfiguration, "unconfigured: #{attr}"
+        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 }
 
+    def controller_plugins
+      Plugin::Registry.controller
+    end
+
+    # @api private
     def path_parts(*parts)
       route_namespace + parts
     end

data/lib/super/controls.rb

@@ -1,25 +1,36 @@
+require "super/controls/optional"
+require "super/controls/required"
+require "super/controls/steps"
+
 module Super
+  # A wrapper around the per-controller Controls classes. This class often
+  # directly delegates to the per-controller classes, but it can also provide
+  # some default implementation.
   class Controls
-    def initialize(dashboard)
-      @dashboard = dashboard
+    include Required
+    include Optional
+    include Steps
+
+    def initialize(actual)
+      @actual = actual
     end
 
-    attr_reader :dashboard
+    attr_reader :actual
 
-    def method_missing(method_name, *args)
-      if @dashboard.respond_to?(method_name)
-        @dashboard.public_send(method_name, *args)
-      else
-        super
-      end
-    end
+    private
 
-    def respond_to_missing?(method_name, _ = false)
-      if @dashboard.respond_to?(method_name)
-        true
-      else
-        super
+    def default_for(method_name, *args, **kwargs)
+      if @actual.respond_to?(method_name)
+        if args.empty? && kwargs.empty?
+          return @actual.public_send(method_name)
+        elsif args.empty?
+          return @actual.public_send(method_name, **kwargs)
+        else
+          return @actual.public_send(method_name, *args)
+        end
       end
+
+      yield
     end
   end
 end

data/lib/super/controls/optional.rb

@@ -0,0 +1,54 @@
+module Super
+  class Controls
+    # Methods for `Controls` that have a sane default implementation
+    module Optional
+      # This is an optional method
+      #
+      # @return [String]
+      def title
+        default_for(:title) do
+          model.name.pluralize
+        end
+      end
+
+      # Configures what database records are visible on load. This is an optional
+      # method, it defaults to "`all`" methods
+      #
+      # @param action [ActionInquirer]
+      # @return [ActiveRecord::Relation]
+      def scope(action:)
+        default_for(:scope, action: action) do
+          model.all
+        end
+      end
+
+      # Configures the actions linked to on the index page. This is an optional
+      # method
+      #
+      # @param action [ActionInquirer]
+      # @return [Array<Link>]
+      def collection_actions(action:)
+        default_for(:collection_actions, action: action) do
+          Super::Link.find_all(:new)
+        end
+      end
+
+      # Configures the actions linked to on the show page as well as each row of
+      # the table on the index page. This is an optional method
+      #
+      # @param action [ActionInquirer]
+      # @return [Array<Link>]
+      def member_actions(action:)
+        default_for(:member_actions, action: action) do
+          if action.show?
+            Super::Link.find_all(:edit, :destroy)
+          elsif action.edit?
+            Super::Link.find_all(:show, :destroy)
+          else
+            Super::Link.find_all(:show, :edit, :destroy)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/super/controls/required.rb

@@ -0,0 +1,41 @@
+module Super
+  class Controls
+    # Methods for `Controls` that must be defined for Super to work properly
+    module Required
+      # Specifies the model. This is a required method
+      #
+      # @return [ActiveRecord::Base]
+      def model
+        @actual.model
+      end
+
+      # Configures which parameters could be written to the database. This is a
+      # required method
+      #
+      # @param params [ActionController::Parameters]
+      # @param action [ActionInquirer]
+      # @return [ActionController::Parameters]
+      def permitted_params(params, action:)
+        @actual.permitted_params(params, action: action)
+      end
+
+      # Configures the fields that are displayed on the index and show actions.
+      # This is a required method
+      #
+      # @param action [ActionInquirer]
+      # @return [Schema]
+      def display_schema(action:)
+        @actual.display_schema(action: action)
+      end
+
+      # Configures the editable fields on the new and edit actions. This is a
+      # required method
+      #
+      # @param action [ActionInquirer]
+      # @return [Schema]
+      def form_schema(action:)
+        @actual.form_schema(action: action)
+      end
+    end
+  end
+end