super 0.0.7 → 0.0.12

data/lib/super/assets.rb

@@ -1,8 +1,66 @@
+# frozen_string_literal: true
+
 module Super
   # Utilities for determining whether to use Sprockets or Webpacker
   class Assets
-    def self.sprockets_available?
-      Gem::Dependency.new("sprockets").matching_specs.any?
+    def self.webpacker(path, **arguments)
+      Asset.new(handler: Handler.webpacker, path: path, arguments: arguments)
+    end
+
+    def self.sprockets(path, **arguments)
+      Asset.new(handler: Handler.sprockets, path: path, arguments: arguments)
+    end
+
+    def self.auto(path, **arguments)
+      Asset.new(handler: Handler.auto, path: path, arguments: arguments)
+    end
+
+    def self.use_webpacker(assets, grep: nil)
+      assets = [assets] if !assets.kind_of?(Array)
+
+      assets.map do |asset|
+        grep_matches = grep && asset === grep
+        if grep_matches || !grep
+          asset.instance_variable_set(:@handler, Handler.webpacker)
+        end
+
+        asset
+      end
+    end
+
+    def self.use_sprockets(assets, grep: nil)
+      assets = [assets] if !assets.kind_of?(Array)
+
+      assets.map do |asset|
+        grep_matches = grep && asset === grep
+        if grep_matches || !grep
+          asset.instance_variable_set(:@asset_handler, Handler.sprockets)
+        end
+
+        asset
+      end
+    end
+
+    class Asset
+      def initialize(handler:, path:, arguments:)
+        @handler = handler
+        @path = path
+        @arguments = arguments
+      end
+
+      attr_reader :handler
+      attr_reader :path
+      attr_reader :arguments
+
+      def ===(other)
+        return true if path == other
+        return true if other.is_a?(Regexp) && path.match?(other)
+        return true if handler == other
+        return true if handler.to_sym == other
+        return true if handler.to_s == other
+
+        false
+      end
     end
 
     def self.dist(gem_name, package_name)
@@ -15,49 +73,67 @@ module Super
       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
+    class Handler
+      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", "~> 6.0").matching_specs.any?
+            webpacker
+          elsif Gem::Dependency.new("webpacker", "~> 5.0").matching_specs.any?
+            webpacker
+          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.sprockets_available?
+        Gem::Dependency.new("sprockets").matching_specs.any? && defined?(Sprockets)
+      end
 
-    def self.webpacker
-      new(:webpacker)
-    end
+      def self.sprockets
+        @sprockets ||= new(:sprockets)
+      end
 
-    def self.none
-      new(:none)
-    end
+      def self.webpacker
+        @webpacker ||= new(:webpacker)
+      end
 
-    def initialize(asset_handler)
-      @asset_handler = asset_handler
-    end
+      def self.none
+        @none ||= new(:none)
+      end
 
-    def sprockets?
-      @asset_handler == :sprockets
-    end
+      def initialize(asset_handler)
+        @asset_handler = asset_handler
+      end
 
-    def webpacker?
-      @asset_handler == :webpacker
-    end
+      def sprockets?
+        @asset_handler == :sprockets
+      end
+
+      def webpacker?
+        @asset_handler == :webpacker
+      end
+
+      def none?
+        @asset_handler == :none
+      end
+
+      def to_sym
+        @asset_handler
+      end
 
-    def none?
-      @asset_handler == :none
+      def to_s
+        @asset_handler.to_s
+      end
     end
   end
 end

data/lib/super/client_error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Super
   # A container class for all user-facing (4xx) errors thrown by this library.
   #

data/lib/super/compatibility.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Super
   module Compatability
     module_function

data/lib/super/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Super
   # @yield [Configuration]
   # @return [Configuration]
@@ -19,92 +21,27 @@ module Super
   # 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
-
-          public_send("#{key}=", value)
-        end
-
-        Plugin::Registry.controller.use(prepend: Super::Filter::ControllerMethods)
-        Plugin::Registry.controller.use(prepend: Super::Pagination::ControllerMethods)
-      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
+    include ActiveSupport::Configurable
 
-          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
+    config_accessor(:title) { "Super Admin" }
+    config_accessor(:index_records_per_page) { 100 }
+    config_accessor(:javascripts) do
+      [Super::Assets.auto("super/application")]
+    end
+    config_accessor(:stylesheets) do
+      [Super::Assets.auto("super/application")]
     end
 
-    include ConfigurationLogic
+    config_accessor(:path) { "/admin" }
+    config_accessor(:generator_module) { "admin" }
+    config_accessor(:generator_as) { "admin" }
 
-    # @!attribute [rw]
-    configure :title
-    # @!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 initialize
+      controller_plugins.use(prepend: Super::Pagination::ControllerMethods)
+    end
 
     def controller_plugins
       Plugin::Registry.controller
     end
-
-    # @api private
-    def path_parts(*parts)
-      route_namespace + parts
-    end
   end
 end

data/lib/super/controls.rb

@@ -1,36 +1,22 @@
+# frozen_string_literal: true
+
 require "super/controls/optional"
-require "super/controls/required"
 require "super/controls/steps"
+require "super/controls/view"
 
 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.
+  # The base Controls class. Most parts of Super can be configured by
+  # customizing its methods.
   class Controls
-    include Required
     include Optional
     include Steps
+    include View
 
-    def initialize(actual)
-      @actual = actual
-    end
-
-    attr_reader :actual
-
-    private
-
-    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
+    # Specifies the model. This is a required method
+    #
+    # @return [ActiveRecord::Base]
+    def model
+      raise NotImplementedError
     end
   end
 end

data/lib/super/controls/optional.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Super
   class Controls
     # Methods for `Controls` that have a sane default implementation
@@ -6,9 +8,7 @@ module Super
       #
       # @return [String]
       def title
-        default_for(:title) do
-          model.name.pluralize
-        end
+        model.name.pluralize
       end
 
       # Configures what database records are visible on load. This is an optional
@@ -17,20 +17,49 @@ module Super
       # @param action [ActionInquirer]
       # @return [ActiveRecord::Relation]
       def scope(action:)
-        default_for(:scope, action: action) do
-          model.all
+        model.all
+      end
+
+      # Configures the fields that are displayed on the index and show actions.
+      # This is a required method
+      #
+      # @param action [ActionInquirer]
+      # @return [Display]
+      def display_schema(action:)
+        Display.new do |fields, type|
+          Display::Guesser.new(model: model, action: action, fields: fields, type: type).call
         end
       end
 
+      # Configures the editable fields on the new and edit actions. This is a
+      # required method
+      #
+      # @param action [ActionInquirer]
+      # @return [Form]
+      def form_schema(action:)
+        Form.new do |fields, type|
+          Form::Guesser.new(model: model, fields: fields, type: type).call
+        end
+      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:)
+        strong_params = Super::Form::StrongParams.new(form_schema(action: action))
+        params.require(strong_params.require(model)).permit(strong_params.permit)
+      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
+        Super::Link.find_all(:new)
       end
 
       # Configures the actions linked to on the show page as well as each row of
@@ -39,16 +68,46 @@ module Super
       # @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
+        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
+
+      def filters_enabled?
+        true
+      end
+
+      def filter_schema
+        Super::Filter.new do |fields, type|
+          Super::Filter::Guesser.new(model: model, fields: fields, type: type).call
         end
       end
+
+      def sort_enabled?
+        true
+      end
+
+      def sortable_columns
+        action = ActionInquirer.new(
+          ActionInquirer.default_for_resources,
+          "index"
+        )
+        attribute_names =
+          display_schema(action: action).each_attribute.map do |key, val|
+            val = val.build if val.respond_to?(:build)
+            key if val.real?
+          end
+
+        attribute_names.compact
+      end
+
+      def default_sort
+        { id: :desc }
+      end
     end
   end
 end