super 0.0.1 → 0.0.6

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,65 @@
+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
+
+      # Specifies how many records to show per page
+      #
+      # @param action [ActionInquirer]
+      # @param query_params [Hash]
+      # @return [ActiveRecord::Relation]
+      def records_per_page(action:, query_params:)
+        default_for(:records_per_page, action: action, query_params: query_params) do
+          Super.configuration.index_records_per_page
+        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

data/lib/super/controls/steps.rb

@@ -0,0 +1,115 @@
+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:)
+        default_for(:load_records, action: action, params: params) do
+          scope(action: action)
+        end
+      end
+
+      # Sets up pagination
+      #
+      # @param action [ActionInquirer]
+      # @param records [ActiveRecord::Relation]
+      # @param query_params [Hash]
+      # @return [Pagination]
+      def initialize_pagination(action:, records:, query_params:)
+        default_for(:initialize_pagination, action: action, records: records, query_params: query_params) do
+          Pagination.new(
+            total_count: records.size,
+            limit: records_per_page(action: action, query_params: query_params),
+            query_params: query_params,
+            page_query_param: :page
+          )
+        end
+      end
+
+      # Paginates
+      #
+      # @param action [ActionInquirer]
+      # @param records [ActiveRecord::Relation]
+      # @param pagination [Pagination]
+      # @return [ActiveRecord::Relation]
+      def paginate_records(action:, records:, pagination:)
+        default_for(:paginate_records, action: action, records: records, pagination: pagination) do
+          records
+            .limit(pagination.limit)
+            .offset(pagination.offset)
+        end
+      end
+
+      # Loads a record using `#scope`
+      #
+      # @param action [ActionInquirer]
+      # @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
+      end
+
+      # Builds a record using `#scope`
+      #
+      # @param action [ActionInquirer]
+      # @return [ActiveRecord::Base]
+      def build_record(action:)
+        default_for(:build_record) do
+          scope(action: action).build
+        end
+      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:)
+        default_for(:build_record_with_params, action: action, params: params) do
+          scope(action: action).build(permitted_params(params, action: action))
+        end
+      end
+
+      # Saves a record
+      #
+      # @param action [ActionInquirer]
+      # @param params [ActionController::Parameters]
+      # @return [ActiveRecord::Base]
+      def save_record(action:, record:, params:)
+        default_for(:save_record, action: action, record: record, params: params) do
+          record.save
+        end
+      end
+
+      # Saves a record
+      #
+      # @param action [ActionInquirer]
+      # @param params [ActionController::Parameters]
+      # @return [ActiveRecord::Base]
+      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
+      end
+
+      # Destroys a record
+      #
+      # @param action [ActionInquirer]
+      # @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
+      end
+    end
+  end
+end

data/lib/super/display/schema_types.rb

@@ -3,39 +3,81 @@ 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.
     #
-    # Note: The constants under "Defined Under Namespace" are considered
-    # private.
+    # ```
+    # class MembersController::Controls
+    #   # ...
     #
-    #   class MemberDashboard
-    #     # ...
-    #
-    #     def show_schema
-    #       Super::Schema.new(Super::Display::SchemaTypes.new) do |fields, type|
-    #         fields[:name] = type.dynamic { |name| name }
-    #         fields[:rank] = type.dynamic { |rank| rank }
-    #         fields[:position] = type.dynamic { |position| position }
-    #         fields[:ship] = type.dynamic { |ship| "#{ship.name} (Ship ##{ship.id})" }
-    #         fields[:created_at] = type.dynamic { |created_at| created_at.iso8601 }
-    #         fields[:updated_at] = type.dynamic { |updated_at| updated_at.iso8601 }
-    #       end
+    #   def show_schema
+    #     Super::Schema.new(Super::Display::SchemaTypes.new) do |fields, type|
+    #       fields[:name] = type.dynamic { |name| name }
+    #       fields[:rank] = type.dynamic { |rank| rank }
+    #       fields[:position] = type.dynamic { |position| position }
+    #       fields[:ship] = type.dynamic { |ship| "#{ship.name} (Ship ##{ship.id})" }
+    #       fields[:created_at] = type.dynamic { |created_at| created_at.iso8601 }
+    #       fields[:updated_at] = type.dynamic { |updated_at| updated_at.iso8601 }
     #     end
-    #
-    #     # ...
     #   end
+    #
+    #   # ...
+    # end
+    # ```
     class SchemaTypes
       class Dynamic
         def initialize(transform_block)
           @transform_block = transform_block
         end
 
-        def present(field)
-          @transform_block.call(field)
+        def present(value)
+          @transform_block.call(value)
+        end
+
+        def real?
+          true
+        end
+      end
+
+      class Bypass
+        def initialize(partial:, real:)
+          @partial = partial
+          @real = real
+        end
+
+        def present
+          Partial.new(@partial)
+        end
+
+        def real?
+          @real
         end
       end
 
+      def initialize(action_inquirer)
+        @action_inquirer = action_inquirer
+        @actions_called = false
+      end
+
+      def before_yield(fields:)
+        @fields = fields
+      end
+
+      def after_yield
+        return if !@action_inquirer.index?
+        return if @actions_called
+        @fields[:actions] = actions
+      end
+
       def dynamic(&transform_block)
         Dynamic.new(transform_block)
       end
+
+      def actions
+        @actions_called = true
+        Bypass.new(partial: "super_schema_display_actions", real: false)
+      end
+
+      def to_partial_path
+        "super_schema_display_#{@action_inquirer.action}"
+      end
     end
   end
 end

data/lib/super/engine.rb

@@ -1,4 +1,5 @@
 module Super
+  # Configures the host Rails app to work with Super
   class Engine < ::Rails::Engine
     initializer "super.assets.precompile" do |app|
       if Super::Assets.sprockets_available?

data/lib/super/error.rb

@@ -1,8 +1,17 @@
 module Super
+  # A container class for all internal errors thrown by this library
+  #
+  # See also `Super::ClientError`
   class Error < StandardError
+    # Error raised when some configuration is not set
     class UnconfiguredConfiguration < Error; end
+    # Error raised when a configuration is set to a invalid value
     class InvalidConfiguration < Error; end
-    class InvalidStyle < Error; end
+    # Error raised on problematic plugins, see `Super::Plugin`
     class InvalidPluginArgument < Error; end
+    # Error raised on problematic ActionInquirer settings, see `Super::ActionInquirer`
+    class ActionInquirerError < Error; end
+    # Error raised when a `Super::Link` couldn't be found
+    class LinkNotRegistered < Error; end
   end
 end

data/lib/super/form.rb

@@ -0,0 +1,48 @@
+module Super
+  class Form
+    module FieldErrorProc
+      def error_wrapping(html_tag)
+        if Thread.current[:super_form_builder]
+          return html_tag
+        end
+
+        super
+      end
+    end
+
+    class Builder < ActionView::Helpers::FormBuilder
+      # These methods were originally defined in the following files
+      #
+      # * actionview/lib/action_view/helpers/form_helper.rb
+      # * actionview/lib/action_view/helpers/form_options_helper.rb
+      # * actionview/lib/action_view/helpers/date_helper.rb
+      %w[
+        label text_field password_field hidden_field file_field text_area
+        check_box radio_button color_field search_field telephone_field
+        date_field time_field datetime_field month_field week_field url_field
+        email_field number_field range_field
+
+        select collection_select grouped_collection_select time_zone_select
+        collection_radio_buttons collection_check_boxes
+
+        time_select datetime_select date_select
+      ].each do |field_type_method|
+        class_eval(<<~RUBY, __FILE__, __LINE__ + 1)
+          def #{field_type_method}(*)
+            Thread.current[:super_form_builder] = true
+            super
+          ensure
+            Thread.current[:super_form_builder] = nil
+          end
+        RUBY
+      end
+
+      alias datetime_local_field datetime_field
+      alias phone_field telephone_field
+    end
+  end
+end
+
+ActionView::Helpers::Tags::Base.class_eval do
+  prepend Super::Form::FieldErrorProc
+end