super 0.0.5 → 0.0.10

data/lib/super/compatibility.rb

@@ -2,12 +2,24 @@ module Super
   module Compatability
     module_function
 
-    def rails_50_errable_fields(field)
+    # 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

@@ -19,81 +19,33 @@ module Super
   # end
   # ```
   class Configuration
-    module ConfigurationLogic # @api private
-      def self.included(base)
-        base.extend(ClassMethods)
-      end
+    def initialize
+      self.title = "Super Admin"
+      self.index_records_per_page = 20
+      self.controller_namespace = "admin"
+      self.route_namespace = :admin
 
-      def initialize
-        self.class.defaults.each do |key, value|
-          if value.respond_to?(:call)
-            value = value.call
-          end
+      controller_plugins.use(prepend: Super::Filter::ControllerMethods)
+      controller_plugins.use(prepend: Super::Pagination::ControllerMethods)
 
-          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
+      self.javascripts = [Super::Assets.auto("super/application")]
+      self.stylesheets = [Super::Assets.auto("super/application")]
+    end
 
-            instance_variable_set("@#{attr}", value)
-            value
-          end
-        end
-      end
+    attr_accessor :title
+    attr_accessor :index_records_per_page
+    attr_accessor :controller_namespace
+    attr_writer :route_namespace
+    def route_namespace
+      [@route_namespace].flatten
     end
 
-    include ConfigurationLogic
+    attr_accessor :javascripts
+    attr_accessor :stylesheets
 
-    # @!attribute [rw]
-    configure :title
-    # @!attribute [rw]
-    configure :index_resources_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)

data/lib/super/controls.rb

@@ -1,120 +1,13 @@
+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.
+  # The base Controls class. Most parts of Super can be configured by
+  # customizing its methods.
   class Controls
-    def initialize(actual)
-      @actual = actual
-    end
-
-    attr_reader :actual
-
-    # This is an optional method
-    #
-    # @return [String]
-    def title
-      if @actual.respond_to?(:title)
-        return @actual.title
-      end
-
-      model.name.pluralize
-    end
-
-    # Specifies the model. This is a required method
-    #
-    # @return [ActiveRecord::Base]
-    def model
-      @actual.model
-    end
-
-    # Configures the actions linked to on the index page. This is an optional
-    # method
-    #
-    # @param params [ActionController::Parameters]
-    # @param action [ActionInquirer]
-    # @return [Array<Link>]
-    def resources_actions(params:, action:)
-      actions =
-        if @actual.respond_to?(:resources_actions)
-          @actual.resources_actions(params: params, action: action)
-        else
-          [:new]
-        end
-
-      actions.map do |link|
-        link = Link.resolve(link)
-
-        link.call(params: params)
-      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 resource [ActiveRecord::Base]
-    # @param params [ActionController::Parameters]
-    # @param action [ActionInquirer]
-    # @return [Array<Link>]
-    def resource_actions(resource, params:, action:)
-      actions =
-        if @actual.respond_to?(:resource_actions)
-          @actual.resource_actions(resource, params: params, action: action)
-        else
-          if action.show?
-            [:edit, :destroy]
-          elsif action.edit?
-            [:show, :destroy]
-          else
-            [:show, :edit, :destroy]
-          end
-        end
-
-      actions.map do |link|
-        link = Link.resolve(link)
-
-        link.call(resource, params: params)
-      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:)
-      if @actual.respond_to?(:scope)
-        return @actual.scope(action: action)
-      end
-
-      model.all
-    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
+    include Required
+    include Optional
+    include Steps
   end
 end

data/lib/super/controls/optional.rb

@@ -0,0 +1,79 @@
+module Super
+  class Controls
+    # Methods for `Controls` that have a sane default implementation
+    module Optional
+      # This is an optional method
+      #
+      # @return [String]
+      def title
+        model.name.pluralize
+      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:)
+        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(action: action) 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:)
+        Super::Link.find_all(:new)
+      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:)
+        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

data/lib/super/controls/required.rb

@@ -0,0 +1,13 @@
+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
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/super/controls/steps.rb

@@ -0,0 +1,114 @@
+module Super
+  class Controls
+    # Methods that are called by controller actions. All of these methods have
+    # a default implementation, but feel free to override as needed.
+    module Steps
+      # Tells the controller how to load records in the index action using
+      # `#scope`
+      #
+      # @param action [ActionInquirer]
+      # @param params [ActionController::Parameters]
+      # @return [ActiveRecord::Relation]
+      def load_records(action:, params:)
+        scope(action: action)
+      end
+
+      # Loads a record using `#scope`
+      #
+      # @param action [ActionInquirer]
+      # @param params [ActionController::Parameters]
+      # @return [ActiveRecord::Base]
+      def load_record(action:, params:)
+        scope(action: action).find(params[:id])
+      end
+
+      # Builds a record using `#scope`
+      #
+      # @param action [ActionInquirer]
+      # @return [ActiveRecord::Base]
+      def build_record(action:)
+        scope(action: action).build
+      end
+
+      # Builds and populates a record using `#scope`
+      #
+      # @param action [ActionInquirer]
+      # @param params [ActionController::Parameters]
+      # @return [ActiveRecord::Base]
+      def build_record_with_params(action:, params:)
+        scope(action: action).build(permitted_params(params, action: action))
+      end
+
+      # Saves a record
+      #
+      # @param action [ActionInquirer]
+      # @param params [ActionController::Parameters]
+      # @return [true, false]
+      def save_record(action:, record:, params:)
+        record.save
+      end
+
+      # Saves a record
+      #
+      # @param action [ActionInquirer]
+      # @param params [ActionController::Parameters]
+      # @return [true, false]
+      def update_record(action:, record:, params:)
+        record.update(permitted_params(params, action: action))
+      end
+
+      # Destroys a record
+      #
+      # @param action [ActionInquirer]
+      # @param params [ActionController::Parameters]
+      # @return [ActiveRecord::Base, false]
+      def destroy_record(action:, record:, params:)
+        record.destroy
+      end
+
+      def build_index_view
+        Super::Layout.new(
+          mains: [
+            Super::Panel.new(
+              Super::Partial.new("collection_header"),
+              :@display
+            ),
+          ]
+        )
+      end
+
+      def build_show_view
+        Super::Layout.new(
+          mains: [
+            Super::Panel.new(
+              Super::Partial.new("member_header"),
+              :@display
+            ),
+          ]
+        )
+      end
+
+      def build_new_view
+        Super::Layout.new(
+          mains: [
+            Super::Panel.new(
+              Super::Partial.new("collection_header"),
+              :@form
+            ),
+          ]
+        )
+      end
+
+      def build_edit_view
+        Super::Layout.new(
+          mains: [
+            Super::Panel.new(
+              Super::Partial.new("member_header"),
+              :@form
+            ),
+          ]
+        )
+      end
+    end
+  end
+end