super 0.0.7 → 0.0.8

data/lib/super/form.rb

@@ -1,48 +1,35 @@
 module Super
+  # This schema type is used on your +#edit+ and +#new+ forms
+  #
+  # ```ruby
+  # class MembersController::Controls
+  #   # ...
+  #
+  #   def new_schema
+  #     Super::Form.new do |fields, type|
+  #       fields[:name] = type.string
+  #       fields[:rank] = type.select
+  #       fields[:position] = type.string
+  #       fields[:ship_id] = type.select(
+  #         collection: Ship.all.map { |s| ["#{s.name} (Ship ##{s.id})", s.id] },
+  #       )
+  #     end
+  #   end
+  #
+  #   # ...
+  # end
+  # ```
   class Form
-    module FieldErrorProc
-      def error_wrapping(html_tag)
-        if Thread.current[:super_form_builder]
-          return html_tag
-        end
+    include Schema::Common
 
-        super
-      end
+    def initialize
+      @fields = Schema::Fields.new
+      @schema_types = SchemaTypes.new(fields: @fields)
+      yield(@fields, @schema_types)
     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
+    def to_partial_path
+      "super_schema_form"
     end
   end
 end
-
-ActionView::Helpers::Tags::Base.class_eval do
-  prepend Super::Form::FieldErrorProc
-end

data/lib/super/form/builder.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

data/lib/super/form/guesser.rb

@@ -0,0 +1,27 @@
+module Super
+  class Form
+    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) }
+          .reject { |attribute_name| attribute_name == "id" }
+          .reject { |attribute_name| attribute_name == "created_at" }
+          .reject { |attribute_name| attribute_name == "updated_at" }
+          .call
+      end
+
+      private
+
+      def attribute_type_for(attribute_name)
+        @type.string
+      end
+    end
+  end
+end

data/lib/super/form/schema_types.rb

@@ -1,26 +1,5 @@
 module Super
   class Form
-    # This schema type is used on your +#edit+ and +#new+ forms
-    #
-    # ```ruby
-    # class MembersController::Controls
-    #   # ...
-    #
-    #   def new_schema
-    #     Super::Schema.new(Super::Form::SchemaTypes.new) do |fields, type|
-    #       fields[:name] = type.generic("form_field_text")
-    #       fields[:rank] = type.generic("form_field_select", collection: Member.ranks.keys)
-    #       fields[:position] = type.generic("form_field_text")
-    #       fields[:ship_id] = type.generic(
-    #         "form_field_select",
-    #         collection: Ship.all.map { |s| ["#{s.name} (Ship ##{s.id})", s.id] },
-    #       )
-    #     end
-    #   end
-    #
-    #   # ...
-    # end
-    # ```
     class SchemaTypes
       class Generic
         def initialize(partial_path:, extras:, nested:)
@@ -31,6 +10,16 @@ module Super
 
         attr_reader :nested_fields
 
+        def each_attribute
+          if block_given?
+            @nested_fields.each do |key, value|
+              yield(key, value)
+            end
+          end
+
+          enum_for(:each_attribute)
+        end
+
         # This takes advantage of a feature of Rails. If the value of
         # `#to_partial_path` is `my_form_field`, Rails renders
         # `app/views/super/application/_my_form_field.html.erb`, and this
@@ -69,17 +58,22 @@ module Super
         end
       end
 
-      def before_yield(fields:)
+      def initialize(fields:)
         @fields = fields
       end
 
-      def after_yield
-      end
-
       def generic(partial_path, **extras)
         Generic.new(partial_path: partial_path, extras: extras, nested: {})
       end
 
+      def select(**extras)
+        Generic.new(partial_path: "form_field_select", extras: extras, nested: {})
+      end
+
+      def string(**extras)
+        Generic.new(partial_path: "form_field_text", extras: extras, nested: {})
+      end
+
       def has_many(reader, **extras)
         nested = @fields.nested do
           yield
@@ -113,10 +107,6 @@ module Super
           nested: {}
         )
       end
-
-      def to_partial_path
-        "super_schema_form"
-      end
     end
   end
 end

data/lib/super/form/strong_params.rb

@@ -0,0 +1,29 @@
+module Super
+  class Form
+    class StrongParams
+      def initialize(form_schema)
+        @form_schema = form_schema
+      end
+
+      def require(model)
+        model.model_name.singular
+      end
+
+      def permit
+        unfurl(@form_schema)
+      end
+
+      private
+
+      def unfurl(responds_to_each_attribute)
+        responds_to_each_attribute.each_attribute.map do |name, type|
+          if type.nested_fields&.any?
+            { name => [:id, *unfurl(type)] }
+          else
+            name
+          end
+        end
+      end
+    end
+  end
+end

data/lib/super/pagination.rb

@@ -89,9 +89,7 @@ module Super
       # @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
+        Super.configuration.index_records_per_page
       end
     end
 
@@ -103,14 +101,12 @@ module Super
       # @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
+        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
 
       # Paginates
@@ -120,11 +116,9 @@ module Super
       # @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
+        records
+          .limit(pagination.limit)
+          .offset(pagination.offset)
       end
     end
   end

data/lib/super/schema.rb

@@ -5,31 +5,6 @@ module Super
   #
   # The various "schema types" are likely of more interest
   class Schema
-    # @param schema_type [Display::SchemaTypes, Form::SchemaTypes]
-    def initialize(schema_type)
-      @schema_type = schema_type
-      @fields = Fields.new
-
-      @schema_type.before_yield(fields: @fields)
-
-      if block_given?
-        yield(@fields, @schema_type)
-      end
-
-      @schema_type.after_yield
-    end
-
-    attr_reader :fields
-    attr_reader :schema_type
-
-    def field_keys
-      fields.keys
-    end
-
-    def to_partial_path
-      @schema_type.to_partial_path
-    end
-
     # This class can be thought of as a Hash, where the keys usually refer to
     # the model's column name and the value refers to the column type. Note
     # though that this isn't always the case—different `SchemaTypes` can do

data/lib/super/schema/common.rb

@@ -0,0 +1,25 @@
+module Super
+  class Schema
+    module Common
+      def each_attribute_name
+        if block_given?
+          @fields.keys.each do |key|
+            yield(key)
+          end
+        end
+
+        enum_for(:each_attribute_name)
+      end
+
+      def each_attribute
+        if block_given?
+          @fields.each do |key, value|
+            yield(key, value)
+          end
+        end
+
+        enum_for(:each_attribute)
+      end
+    end
+  end
+end

data/lib/super/schema/guesser.rb

@@ -0,0 +1,77 @@
+module Super
+  class Schema
+    class Guesser
+      def initialize(model:, fields:, type:)
+        @model = model
+        @fields = fields
+        @type = type
+        @rejects = []
+      end
+
+      def limit
+        @limit = yield
+        self
+      end
+
+      def reject(&block)
+        @rejects.push(block)
+        self
+      end
+
+      def ignore_foreign_keys
+        @rejects.push(-> (attribute_name) { is_foreign_key[attribute_name] })
+        self
+      end
+
+      def assign_type(&block)
+        @assign_type = block
+        self
+      end
+
+      def call
+        result = sorted_attribute_names
+        result = @rejects.reduce(result) do |intermediary_result, rejection_proc|
+          intermediary_result.reject(&rejection_proc)
+        end
+
+        result = result.first(@limit) if @limit && @limit != Float::INFINITY
+
+        result.each do |name|
+          @fields[name] = @assign_type.call(name)
+        end
+      end
+
+      private
+
+      def sorted_attribute_names
+        @model
+          .attribute_names
+          .sort_by { |name| sort_weight[name] }
+      end
+
+      def sort_weight
+        @sort_weight ||= Hash.new do |hash, name|
+          hash[name] =
+            case name
+            when "id" then 0
+            when "title" then 1000
+            when "name" then 1300
+            when "created_at" then 9500
+            when "updated_at" then 9750
+            else
+              2000 + hash.size
+            end
+        end
+      end
+
+      def is_foreign_key
+        @is_foreign_key ||=
+          @model
+          .reflect_on_all_associations
+          .select { |a| a.macro == :belongs_to }
+          .map { |a| [a.foreign_key, true] }
+          .to_h
+      end
+    end
+  end
+end