super 0.0.7 → 0.0.8

data/lib/super/configuration.rb

@@ -19,84 +19,29 @@ 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
-
-        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
-
-          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
+      self.javascripts = [Super::Assets.auto("super/application")]
+      self.stylesheets = [Super::Assets.auto("super/application")]
     end
 
-    include ConfigurationLogic
+    attr_accessor :title
+    attr_accessor :index_records_per_page
+    attr_accessor :controller_namespace
+    attr_writer :route_namespace
+    def route_namespace
+      [@route_namespace].flatten
+    end
 
-    # @!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 }
+    attr_accessor :javascripts
+    attr_accessor :stylesheets
 
     def controller_plugins
       Plugin::Registry.controller

data/lib/super/controls.rb

@@ -3,34 +3,11 @@ 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
     include Required
     include Optional
     include Steps
-
-    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
-    end
   end
 end

data/lib/super/controls/optional.rb

@@ -6,9 +6,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 +15,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(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:)
-        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,14 +66,12 @@ 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
     end

data/lib/super/controls/required.rb

@@ -6,35 +6,7 @@ module Super
       #
       # @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)
+        raise NotImplementedError
       end
     end
   end

data/lib/super/controls/steps.rb

@@ -10,9 +10,7 @@ module Super
       # @param params [ActionController::Parameters]
       # @return [ActiveRecord::Relation]
       def load_records(action:, params:)
-        default_for(:load_records, action: action, params: params) do
-          scope(action: action)
-        end
+        scope(action: action)
       end
 
       # Loads a record using `#scope`
@@ -21,9 +19,7 @@ module Super
       # @param params [ActionController::Parameters]
       # @return [ActiveRecord::Base]
       def load_record(action:, params:)
-        default_for(:load_record, action: action, params: params) do
-          scope(action: action).find(params[:id])
-        end
+        scope(action: action).find(params[:id])
       end
 
       # Builds a record using `#scope`
@@ -31,9 +27,7 @@ module Super
       # @param action [ActionInquirer]
       # @return [ActiveRecord::Base]
       def build_record(action:)
-        default_for(:build_record) do
-          scope(action: action).build
-        end
+        scope(action: action).build
       end
 
       # Builds and populates a record using `#scope`
@@ -42,31 +36,25 @@ module Super
       # @param params [ActionController::Parameters]
       # @return [ActiveRecord::Base]
       def build_record_with_params(action:, params:)
-        default_for(:build_record_with_params, action: action, params: params) do
-          scope(action: action).build(permitted_params(params, action: action))
-        end
+        scope(action: action).build(permitted_params(params, action: action))
       end
 
       # Saves a record
       #
       # @param action [ActionInquirer]
       # @param params [ActionController::Parameters]
-      # @return [ActiveRecord::Base]
+      # @return [true, false]
       def save_record(action:, record:, params:)
-        default_for(:save_record, action: action, record: record, params: params) do
-          record.save
-        end
+        record.save
       end
 
       # Saves a record
       #
       # @param action [ActionInquirer]
       # @param params [ActionController::Parameters]
-      # @return [ActiveRecord::Base]
+      # @return [true, false]
       def update_record(action:, record:, params:)
-        default_for(:update_record, action: action, record: record, params: params) do
-          record.update(permitted_params(params, action: action))
-        end
+        record.update(permitted_params(params, action: action))
       end
 
       # Destroys a record
@@ -75,9 +63,7 @@ module Super
       # @param params [ActionController::Parameters]
       # @return [ActiveRecord::Base, false]
       def destroy_record(action:, record:, params:)
-        default_for(:update_record, action: action, record: record, params: params) do
-          record.destroy
-        end
+        record.destroy
       end
 
       def build_index_view

data/lib/super/display.rb

@@ -0,0 +1,72 @@
+module Super
+  # This schema type is meant to be used for +#index+ or +#show+ actions to
+  # transform database fields into something that is human friendly.
+  #
+  # ```
+  # class MembersController::Controls
+  #   # ...
+  #
+  #   def show_schema
+  #     Super::Display.new do |fields, type|
+  #       fields[:name] = type.manual { |name| name }
+  #       fields[:rank] = type.manual { |rank| rank }
+  #       fields[:position] = type.manual { |position| position }
+  #       fields[:ship] = type.manual { |ship| "#{ship.name} (Ship ##{ship.id})" }
+  #       fields[:created_at] = type.manual { |created_at| created_at.iso8601 }
+  #       fields[:updated_at] = type.manual { |updated_at| updated_at.iso8601 }
+  #     end
+  #   end
+  #
+  #   # ...
+  # end
+  # ```
+  class Display
+    include Schema::Common
+
+    def initialize(action:)
+      @action_inquirer = action
+      @fields = Super::Schema::Fields.new
+      @schema_types = SchemaTypes.new(fields: @fields)
+
+      yield(@fields, @schema_types)
+
+      return if !@action_inquirer.index?
+      return if @schema_types.actions_called?
+      @fields[:actions] = @schema_types.actions
+    end
+
+    def to_partial_path
+      if @action_inquirer.index?
+        "super_schema_display_index"
+      elsif @action_inquirer.show?
+        "super_schema_display_show"
+      else
+        "super_schema_display_#{@action_inquirer.action}"
+      end
+    end
+
+    # @private
+    def render_field(template:, record:, column:)
+      formatter = @fields[column]
+
+      formatted =
+        if formatter.real?
+          value = record.public_send(column)
+          formatter.present(value)
+        else
+          formatter.present
+        end
+
+      if formatted.respond_to?(:to_partial_path)
+        if formatted.respond_to?(:locals)
+          formatted.locals[:record] ||= record
+          template.render(formatted, formatted.locals)
+        else
+          template.render(formatted)
+        end
+      else
+        formatted
+      end
+    end
+  end
+end

data/lib/super/display/guesser.rb

@@ -0,0 +1,34 @@
+module Super
+  class Display
+    class Guesser
+      def initialize(model:, action:, fields:, type:)
+        @model = model
+        @action_inquirer = action
+        @fields = fields
+        @type = type
+      end
+
+      def call
+        Schema::Guesser
+          .new(model: @model, fields: @fields, type: @type)
+          .ignore_foreign_keys
+          .limit { 5 if @action_inquirer.index? }
+          .assign_type { |attribute_name| attribute_type_for(attribute_name) }
+          .call
+      end
+
+      private
+
+      def attribute_type_for(attribute_name)
+        type = @model.type_for_attribute(attribute_name).type
+
+        case type
+        when :datetime
+          @type.timestamp
+        else
+          @type.text
+        end
+      end
+    end
+  end
+end