super 0.0.4 → 0.0.9

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

data/lib/super/display.rb

@@ -1,9 +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
-    def self.format(schema, resource, column)
-      value = resource.public_send(column)
+    include Schema::Common
 
-      schema.fields[column].present(value)
+    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

data/lib/super/display/schema_types.rb

@@ -1,39 +1,75 @@
 module Super
   class Display
-    # 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::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)
+        def initialize(ignore_nil: true, &transform_block)
           @transform_block = transform_block
+          @ignore_nil = ignore_nil
         end
 
-        def present(field)
-          @transform_block.call(field)
+        def present(value)
+          return nil if value.nil? && @ignore_nil
+
+          @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(fields:)
+        @actions_called = false
+        @fields = fields
+      end
+
+      def string
+        Dynamic.new(&:to_s)
+      end
+
+      alias text string
+
+      def timestamp
+        Dynamic.new(&:iso8601)
+      end
+
+      def rich_text
+        Dynamic.new do |value|
+          Partial.new("display_rich_text", locals: { rich_text: value })
         end
       end
 
+      def manual(&transform_block)
+        Dynamic.new(&transform_block)
+      end
+
       def dynamic(&transform_block)
-        Dynamic.new(transform_block)
+        Dynamic.new(&transform_block)
+      end
+
+      def actions
+        @actions_called = true
+        Bypass.new(partial: "super_schema_display_actions", real: false)
+      end
+
+      # @private
+      def actions_called?
+        @actions_called
       end
     end
   end

data/lib/super/engine.rb

@@ -2,9 +2,15 @@ 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?
+      if Super::Assets::Handler.sprockets_available?
         app.config.assets.precompile << "config/super_manifest.js"
       end
     end
+
+    config.to_prepare do
+      Super::Plugin::Registry.controller.ordered do |klass, method_name|
+        Super::ApplicationController.public_send(method_name, klass)
+      end
+    end
   end
 end

data/lib/super/error.rb

@@ -1,18 +1,17 @@
 module Super
-  # A container class for all custom errors thrown by this library
+  # 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
-
-    class ClientError < Error; end
-    class BadRequest < ClientError; end
-    class Unauthorized < ClientError; end
-    class Forbidden < ClientError; end
-    class NotFound < ClientError; end
-    class UnprocessableEntity < ClientError; end
   end
 end

data/lib/super/filter.rb

@@ -0,0 +1,12 @@
+module Super
+  class Filter
+    def initialize
+      @schema_type = Filter::SchemaTypes.new
+      @fields = Schema::Fields.new
+
+      yield(@fields, @schema_type)
+    end
+
+    attr_reader :fields
+  end
+end

data/lib/super/filter/form_object.rb

@@ -0,0 +1,97 @@
+module Super
+  class Filter
+    class FormObject
+      class FilterFormField
+        def initialize(humanized_field_name:, field_name:, type:, params:)
+          @humanized_field_name = humanized_field_name
+          @field_name = field_name
+          @field_type = type
+          @params = params
+          @specified_values =
+            type.q
+              .map do |query_field_name|
+                [
+                  query_field_name,
+                  (params || {})[query_field_name],
+                ]
+              end
+              .to_h
+
+          @specified_values.each do |key, value|
+            define_singleton_method(key) { value }
+          end
+        end
+
+        attr_reader :humanized_field_name
+        attr_reader :field_name
+        attr_reader :field_type
+        attr_reader :specified_values
+
+        def op
+          (@params || {})[:op]
+        end
+
+        def operators
+          @field_type.operators
+            .map { |o| [o.name, o.identifier] }
+            .to_h
+        end
+
+        def to_partial_path
+          @field_type.to_partial_path
+        end
+      end
+
+      def initialize(model:, url:, schema:, params:)
+        @model = model
+        @url = url
+        @schema = schema
+        @params = params
+
+        @form_fields = {}
+      end
+
+      def each_field
+        @schema.fields.each do |field_name, _field_type|
+          yield(form_field_for(field_name))
+        end
+      end
+
+      def url
+        @url
+      end
+
+      def to_partial_path
+        "filter"
+      end
+
+      def to_search_query(relation)
+        each_field do |form_field|
+          next if form_field.specified_values.values.map(&:to_s).map(&:strip).all? { |specified_value| specified_value == "" }
+          next if !Super::Filter::Operator.registry.key?(form_field.op)
+
+          operator = Super::Filter::Operator.registry[form_field.op]
+          updated_relation = operator.filter(relation, form_field.field_name, *form_field.specified_values.values)
+
+          if updated_relation.is_a?(ActiveRecord::Relation)
+            relation = updated_relation
+          end
+        end
+
+        relation
+      end
+
+      private
+
+      def form_field_for(field_name)
+        @form_fields[field_name] ||=
+          FilterFormField.new(
+            humanized_field_name: @model.human_attribute_name(field_name),
+            field_name: field_name,
+            type: @schema.fields[field_name],
+            params: (@params || {})[field_name]
+          )
+      end
+    end
+  end
+end