super 0.0.3 → 0.0.8

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,17 +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
-
-    class ClientError < Error; end
-    class BadRequest < ClientError; end
-    class Unauthorized < ClientError; end
-    class Forbidden < ClientError; end
-    class NotFound < ClientError; end
-    class UnprocessableEntity < ClientError; end
+    # Error raised when a `Super::Link` couldn't be found
+    class LinkNotRegistered < Error; 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

data/lib/super/filter/guesser.rb

@@ -0,0 +1,30 @@
+module Super
+  class Filter
+    class Guesser
+      def initialize(model:, fields:, type:)
+        @model = model
+        @fields = fields
+        @type = type
+      end
+
+      def call
+        Schema::Guesser
+          .new(model: @model, fields: @fields, type: @type)
+          .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/filter/operator.rb

@@ -0,0 +1,103 @@
+module Super
+  class Filter
+    module Operator
+      class Definition
+        def initialize(identifier, name, filter)
+          @identifier = identifier
+          @name = name
+          @filter = filter
+        end
+
+        attr_reader :identifier
+        attr_reader :name
+
+        def filter(*args)
+          @filter.call(args)
+        end
+      end
+
+      class << self
+        def registry
+          @registry ||= {}
+        end
+
+        def range_defaults
+          [
+            registry["between"],
+          ]
+        end
+
+        def select_defaults
+          [
+            registry["eq"],
+            registry["neq"],
+          ]
+        end
+
+        def text_defaults
+          [
+            registry["eq"],
+            registry["neq"],
+            registry["contain"],
+            registry["ncontain"],
+            registry["start"],
+            registry["end"],
+          ]
+        end
+
+        def define(identifier, name, &filter)
+          identifier = identifier.to_s
+          name = name.to_s
+
+          definition = Definition.new(identifier, name, filter)
+
+          registry[identifier] = definition
+
+          define_singleton_method(identifier) do
+            registry[identifier]
+          end
+        end
+      end
+
+      define("eq", "equals") do |relation, field, query|
+        relation.where(field => query)
+      end
+
+      define("neq", "doesn't equal") do |relation, field, query|
+        relation.where.not(field => query)
+      end
+
+      define("contain", "contains") do |relation, field, query|
+        query = "%#{Compatability.sanitize_sql_like(query)}%"
+        relation.where("#{field} LIKE ?", "%#{query}%")
+      end
+
+      define("ncontain", "doesn't contain") do |relation, field, query|
+        query = "%#{Compatability.sanitize_sql_like(query)}%"
+        relation.where("#{field} NOT LIKE ?", query)
+      end
+
+      define("start", "starts with") do |relation, field, query|
+        query = "#{Compatability.sanitize_sql_like(query)}%"
+        relation.where("#{field} LIKE ?", query)
+      end
+
+      define("end", "ends with") do |relation, field, query|
+        query = "%#{Compatability.sanitize_sql_like(query)}"
+        relation.where("#{field} LIKE ?", query)
+      end
+
+      define("between", "between") do |relation, field, query0, query1|
+        if query0.present?
+          relation = relation.where("#{field} >= ?", query0)
+        end
+
+        if query1.present?
+          relation = relation.where("#{field} <= ?", query1)
+        end
+
+        relation
+      end
+    end
+  end
+end

data/lib/super/filter/plugin.rb

@@ -0,0 +1,47 @@
+module Super
+  class Filter
+    module ControllerMethods
+      def index
+        super
+        @filter_form = controls.initialize_filtering(params: params, query_params: request.GET)
+        @records = controls.filter_records(filter_form: @filter_form, records: @records)
+        @view.asides.push(:@filter_form)
+      end
+    end
+  end
+
+  class Controls
+    module Optional
+      def filters_enabled?
+        true
+      end
+
+      def filter_schema
+        Filter.new do |fields, type|
+          Filter::Guesser.new(model: model, fields: fields, type: type).call
+        end
+      end
+    end
+
+    module Steps
+      def initialize_filtering(params:, query_params:)
+        if filters_enabled?
+          Super::Filter::FormObject.new(
+            model: model,
+            schema: filter_schema,
+            params: params[:q],
+            url: query_params
+          )
+        end
+      end
+
+      def filter_records(filter_form:, records:)
+        if filters_enabled? && records
+          filter_form.to_search_query(records)
+        else
+          records
+        end
+      end
+    end
+  end
+end

data/lib/super/filter/schema_types.rb

@@ -0,0 +1,112 @@
+module Super
+  class Filter
+    # This schema type is used to configure the filtering form on your +#index+
+    # action.
+    #
+    # The +operators:+ keyword argument can be left out in each case. There is
+    # a default set of operators that are provided.
+    #
+    # Note: The constants under "Defined Under Namespace" are considered
+    # private.
+    #
+    #   class MemberDashboard
+    #     # ...
+    #
+    #     def filter_schema
+    #       Super::Filter.new do |fields, type|
+    #         fields[:name] = type.text(operators: [
+    #           Super::Filter::Operator.eq,
+    #           Super::Filter::Operator.contain,
+    #           Super::Filter::Operator.ncontain,
+    #           Super::Filter::Operator.start,
+    #           Super::Filter::Operator.end,
+    #         ])
+    #         fields[:rank] = type.select(collection: Member.ranks.values)
+    #         fields[:position] = type.text(operators: [
+    #           Super::Filter::Operator.eq,
+    #           Super::Filter::Operator.neq,
+    #           Super::Filter::Operator.contain,
+    #           Super::Filter::Operator.ncontain,
+    #         ])
+    #         fields[:ship_id] = type.select(
+    #           collection: Ship.all.map { |s| ["#{s.name} (Ship ##{s.id})", s.id] },
+    #         )
+    #         fields[:created_at] = type.timestamp
+    #         fields[:updated_at] = type.timestamp
+    #       end
+    #     end
+    #
+    #     # ...
+    #   end
+    class SchemaTypes
+      class Text
+        def initialize(partial_path:, operators:)
+          @partial_path = partial_path
+          @operators = operators
+        end
+
+        attr_reader :operators
+
+        def to_partial_path
+          @partial_path
+        end
+
+        def q
+          [:q]
+        end
+      end
+
+      class Select
+        def initialize(collection:, operators:)
+          @collection = collection
+          @operators = operators
+        end
+
+        attr_reader :collection
+        attr_reader :operators
+
+        def to_partial_path
+          "filter_type_select"
+        end
+
+        def q
+          [:q]
+        end
+      end
+
+      class Timestamp
+        def initialize(operators:)
+          @operators = operators
+        end
+
+        attr_reader :operators
+
+        def to_partial_path
+          "filter_type_timestamp"
+        end
+
+        def q
+          [:q0, :q1]
+        end
+      end
+
+      def select(collection:, operators: Filter::Operator.select_defaults)
+        Select.new(
+          collection: collection,
+          operators: operators
+        )
+      end
+
+      def text(operators: Filter::Operator.text_defaults)
+        Text.new(
+          partial_path: "filter_type_text",
+          operators: operators
+        )
+      end
+
+      def timestamp(operators: Filter::Operator.range_defaults)
+        Timestamp.new(operators: operators)
+      end
+    end
+  end
+end