super 0.0.10 → 0.0.11

data/lib/super/controls/required.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Super
   class Controls
     # Methods for `Controls` that must be defined for Super to work properly

data/lib/super/controls/steps.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Super
   class Controls
     # Methods that are called by controller actions. All of these methods have
@@ -66,48 +68,38 @@ module Super
         record.destroy
       end
 
-      def build_index_view
-        Super::Layout.new(
-          mains: [
-            Super::Panel.new(
-              Super::Partial.new("collection_header"),
-              :@display
-            ),
-          ]
+      def initialize_query_form(params:, current_path:)
+        Super::Query::FormObject.new(
+          model: model,
+          params: params,
+          namespace: :q,
+          current_path: current_path,
         )
       end
 
-      def build_show_view
-        Super::Layout.new(
-          mains: [
-            Super::Panel.new(
-              Super::Partial.new("member_header"),
-              :@display
-            ),
-          ]
-        )
+      def apply_queries(query_form:, records:)
+        query_form.apply_changes(records)
       end
 
-      def build_new_view
-        Super::Layout.new(
-          mains: [
-            Super::Panel.new(
-              Super::Partial.new("collection_header"),
-              :@form
-            ),
-          ]
-        )
+      def initialize_filter_form(query_form:)
+        if filters_enabled?
+          query_form.add(
+            Super::Filter::FormObject,
+            namespace: :f,
+            schema: filter_schema
+          )
+        end
       end
 
-      def build_edit_view
-        Super::Layout.new(
-          mains: [
-            Super::Panel.new(
-              Super::Partial.new("member_header"),
-              :@form
-            ),
-          ]
-        )
+      def initialize_sort_form(query_form:)
+        if sort_enabled?
+          query_form.add(
+            Super::Sort::FormObject,
+            namespace: :s,
+            default: default_sort,
+            sortable_columns: sortable_columns
+          )
+        end
       end
     end
   end

data/lib/super/controls/view.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Super
+  class Controls
+    # Methods for `Controls` that have a sane default implementation
+    module View
+      def index_view
+        Super::Layout.new(
+          mains: [
+            Super::Panel.new(
+              Super::Partial.new("collection_header"),
+              :@display
+            ),
+          ],
+          asides: [
+            :@query_form,
+          ]
+        )
+      end
+
+      def show_view
+        Super::Layout.new(
+          mains: [
+            Super::Panel.new(
+              Super::Partial.new("member_header"),
+              :@display
+            ),
+          ]
+        )
+      end
+
+      def new_view
+        Super::Layout.new(
+          mains: [
+            Super::Panel.new(
+              Super::Partial.new("collection_header"),
+              :@form
+            ),
+          ]
+        )
+      end
+
+      def 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,3 +1,5 @@
+# frozen_string_literal: true
+
 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.
@@ -23,20 +25,26 @@ module Super
   class Display
     include Schema::Common
 
-    def initialize(action:)
-      @action_inquirer = action
+    def initialize
       @fields = Super::Schema::Fields.new
       @schema_types = SchemaTypes.new(fields: @fields)
 
       yield(@fields, @schema_types)
+    end
 
-      return if !@action_inquirer.index?
-      return if @schema_types.actions_called?
+    def apply(action:)
+      @action_inquirer = action
+      return self if !@action_inquirer.index?
+      return self if @schema_types.actions_called?
       @fields[:actions] = @schema_types.actions
+      self
     end
 
     def to_partial_path
-      if @action_inquirer.index?
+      if @action_inquirer.nil?
+        raise Super::Error::Initalization,
+          "You must call the `#apply` method after instantiating Super::Display"
+      elsif @action_inquirer.index?
         "super_schema_display_index"
       elsif @action_inquirer.show?
         "super_schema_display_show"

data/lib/super/display/guesser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Super
   class Display
     class Guesser

data/lib/super/display/schema_types.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Super
   class Display
     class SchemaTypes

data/lib/super/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Super
   # Configures the host Rails app to work with Super
   class Engine < ::Rails::Engine

data/lib/super/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Super
   # A container class for all internal errors thrown by this library
   #
@@ -22,5 +24,8 @@ module Super
         )
       end
     end
+    # Error raised when something wasn't initalized correctly, and if there isn't
+    # a more specific error
+    class Initalization < Error; end
   end
 end

data/lib/super/filter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Super
   class Filter
     def initialize

data/lib/super/filter/form_object.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Super
   class Filter
     class FormObject
@@ -42,11 +44,10 @@ module Super
         end
       end
 
-      def initialize(model:, url:, schema:, params:)
+      def initialize(model:, params:, schema:)
         @model = model
-        @url = url
-        @schema = schema
         @params = params
+        @schema = schema
 
         @form_fields = {}
       end
@@ -57,15 +58,11 @@ module Super
         end
       end
 
-      def url
-        @url
-      end
-
       def to_partial_path
         "filter"
       end
 
-      def to_search_query(relation)
+      def apply_changes(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)

data/lib/super/filter/guesser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Super
   class Filter
     class Guesser

data/lib/super/filter/operator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Super
   class Filter
     module Operator

data/lib/super/filter/schema_types.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Super
   class Filter
     # This schema type is used to configure the filtering form on your +#index+

data/lib/super/form.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Super
   # This schema type is used on your +#edit+ and +#new+ forms
   #

data/lib/super/form/builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Super
   class Form
     # Example

data/lib/super/form/guesser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Super
   class Form
     class Guesser

data/lib/super/form/inline_errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Super
   class Form
     module InlineErrors

data/lib/super/form/schema_types.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Super
   class Form
     class SchemaTypes

data/lib/super/form/strong_params.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Super
   class Form
     class StrongParams

data/lib/super/layout.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "super/partial/resolving"
 
 module Super

data/lib/super/link.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Super
   # Links have three required attributes that are passed directly into Rails'
   # `link_to` helper

data/lib/super/navigation/automatic.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Super
   class Navigation
     # Traverses the defined Rails Routes and attempts to build a list of links.

data/lib/super/pagination.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Super
   class Pagination
     include Enumerable

data/lib/super/panel.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "super/partial/resolving"
 
 module Super

data/lib/super/partial.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Super
   class Partial
     def self.render(partialish, template:)

data/lib/super/partial/resolving.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Super
   class Partial
     module Resolving

data/lib/super/plugin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Super
   module Plugin
     class Registry

data/lib/super/query/form_object.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Super
+  class Query
+    class FormObject
+      def initialize(model:, params:, namespace:, current_path:)
+        @model = model
+        @all_params = params.dup
+        @namespace = namespace
+        @params = params[namespace] || ActionController::Parameters.new
+        @path = current_path
+        @addons = {}
+      end
+
+      attr_reader :namespace
+      attr_reader :path
+      attr_reader :addons
+
+      def add(klass, namespace:, **additional_initialization_arguments)
+        instance = klass.new(
+          model: @model,
+          params: params_dig(namespace),
+          **additional_initialization_arguments
+        )
+
+        addons[namespace] = instance
+      end
+
+      def apply_changes(records)
+        addons.each_value do |addon|
+          records = addon.apply_changes(records)
+        end
+
+        records
+      end
+
+      def to_partial_path
+        "query"
+      end
+
+      private
+
+      def params_dig(*keys)
+        @params.dig(*keys) || ActionController::Parameters.new
+      end
+    end
+  end
+end

data/lib/super/schema.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Super
   # The Schema is a general purpose container for describing the "schema"
   # for various purposes. It primarily exists to provide a cohesive user-facing

data/lib/super/schema/common.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Super
   class Schema
     module Common