super 0.20.0 → 0.22.0

data/lib/super/action_inquirer.rb

@@ -24,24 +24,44 @@ module Super
         "delete" => %w[destroy],
 
         "collection" => %w[index new create],
-        "member" => %w[show edit update destroy],
+        "member" => %w[show edit update destroy]
       }
     end
 
     # @return [ActionInquirer]
-    def self.index!; new(default_for_resources, "index"); end
+    def self.index!
+      new(default_for_resources, "index")
+    end
+
     # @return [ActionInquirer]
-    def self.show!; new(default_for_resources, "show"); end
+    def self.show!
+      new(default_for_resources, "show")
+    end
+
     # @return [ActionInquirer]
-    def self.new!; new(default_for_resources, "new"); end
+    def self.new!
+      new(default_for_resources, "new")
+    end
+
     # @return [ActionInquirer]
-    def self.edit!; new(default_for_resources, "edit"); end
+    def self.edit!
+      new(default_for_resources, "edit")
+    end
+
     # @return [ActionInquirer]
-    def self.create!; new(default_for_resources, "create"); end
+    def self.create!
+      new(default_for_resources, "create")
+    end
+
     # @return [ActionInquirer]
-    def self.update!; new(default_for_resources, "update"); end
+    def self.update!
+      new(default_for_resources, "update")
+    end
+
     # @return [ActionInquirer]
-    def self.destroy!; new(default_for_resources, "destroy"); end
+    def self.destroy!
+      new(default_for_resources, "destroy")
+    end
 
     def initialize(categories_and_their_actions, action)
       @categories = categories_and_their_actions.keys.map(&:to_s)

data/lib/super/assets.rb

@@ -16,7 +16,7 @@ module Super
     end
 
     def self.use_webpacker(assets, grep: nil)
-      assets = [assets] if !assets.kind_of?(Array)
+      assets = [assets] if !assets.is_a?(Array)
 
       assets.map do |asset|
         grep_matches = grep && asset === grep
@@ -29,7 +29,7 @@ module Super
     end
 
     def self.use_sprockets(assets, grep: nil)
-      assets = [assets] if !assets.kind_of?(Array)
+      assets = [assets] if !assets.is_a?(Array)
 
       assets.map do |asset|
         grep_matches = grep && asset === grep

data/lib/super/badge.rb

@@ -9,37 +9,22 @@ module Super
       yellow: "bg-yellow-400 text-black",
       green: "bg-green-700 text-white",
       blue: "bg-blue-700 text-white",
-      purple: "bg-purple-800 text-white",
+      purple: "bg-purple-800 text-white"
     }
 
-    def initialize(text, styles: nil)
+    def initialize(text, style:)
+      if !STYLES.key?(style)
+        raise Super::Error::Initialization, "`style:` must be one of #{STYLES.keys.inspect}"
+      end
+
       @text = text
-      @requested_styles = Array(styles.presence).flatten
+      @style = style
     end
 
     def styles
       return @styles if instance_variable_defined?(:@styles)
-      @styles =
-        if requested_styles.delete(:reset)
-          []
-        else
-          COMMON_STYLES
-        end
-
-      if requested_styles.empty?
-        @styles += [STYLES[:light]]
-      else
-        requested_styles.each do |style|
-          @styles +=
-            if STYLES.key?(style)
-              [STYLES[style]]
-            else
-              [style]
-            end
-        end
-      end
 
-      @styles
+      @styles = COMMON_STYLES + [STYLES.fetch(@style)]
     end
 
     def to_s

data/lib/super/cheat.rb

@@ -3,13 +3,19 @@
 module Super
   class Cheat
     def controller
-      paths = %w[../../app/controllers/super/substructure_controller.rb]
+      paths = %w[
+        ../../app/controllers/super/application_controller.rb
+        ../../app/controllers/super/view_controller.rb
+        ../../app/controllers/super/sitewide_controller.rb
+        ../../app/controllers/super/substructure_controller.rb
+        ../../app/controllers/super/foundation_controller.rb
+      ]
       methods =
         paths
-        .map { |f| File.read(File.expand_path(f, __dir__)) }
-        .flat_map { |content| content.scan(/^\s+(?:helper_method )?def .*$/) }
-        .reject { |method| method =~ /\bdef self\./ }
-        .map { |method| method.strip.sub(/^(?:helper_method )?def /, "#") }
+          .map { |f| File.read(File.expand_path(f, __dir__)) }
+          .flat_map { |content| content.scan(/^\s+(?:helper_method )?def .*$/) }
+          .reject { |method| method =~ /\bdef self\./ }
+          .map { |method| method.strip.sub(/^(?:helper_method )?def /, "#") }
 
       puts "== Super::ApplicationController"
       puts methods.join("\n")

data/lib/super/client_error.rb

@@ -6,9 +6,13 @@ module Super
   # See also `Super::Error`
   class ClientError < StandardError
     class BadRequest < ClientError; end
+
     class Unauthorized < ClientError; end
+
     class Forbidden < ClientError; end
+
     class NotFound < ClientError; end
+
     class UnprocessableEntity < ClientError; end
 
     module Handling

data/lib/super/compatibility.rb

@@ -34,6 +34,10 @@ module Super
               def method_missing(method_name)
                 Rails.application.routes.url_helpers.public_send(method_name)
               end
+
+              def respond_to_missing?(*args, **kwargs)
+                Rails.application.routes.url_helpers.respond_to?(*args, **kwargs)
+              end
             end
 
             klass.new

data/lib/super/configuration.rb

@@ -24,6 +24,9 @@ module Super
     include ActiveSupport::Configurable
 
     config_accessor(:title) { "Super Admin" }
+
+    # @!attribute [rw] index_records_per_page
+    #   @return [Integer]
     config_accessor(:index_records_per_page) { 100 }
     config_accessor(:javascripts) do
       [Super::Assets.auto("super/application")]

data/lib/super/display/schema_types.rb

@@ -3,7 +3,7 @@
 module Super
   class Display
     class SchemaTypes
-      TYPES = Useful::Enum.new(:column, :record, :none)
+      TYPES = Useful::Enum.new(:attribute, :record, :none)
 
       class Builder
         extend Useful::Builder
@@ -12,40 +12,61 @@ module Super
           @transform_block = block
         end
 
-        builder def real; @real = true; end
-        builder def computed; @real = false; end
+        builder def real
+          @real = true
+        end
+        builder def computed
+          @real = false
+        end
 
-        builder def column; @type = :column; end
-        builder def record; @type = :record; end
-        builder def none; @type = :none; end
+        builder def attribute
+          @type = :attribute
+        end
+        builder def record
+          @type = :record
+        end
+        builder def none
+          @type = :none
+        end
 
-        builder def ignore_nil; @ignore_nil = true; end
+        builder def ignore_nil
+          @ignore_nil = true
+        end
+
+        builder def attribute_name(name) # standard:disable Style/TrivialAccessors
+          @attribute_name = name
+        end
 
         def build
           Built.new(
             real: @real,
             type: @type,
             ignore_nil: !!@ignore_nil,
+            attribute_name: @attribute_name,
             &@transform_block
           )
         end
       end
 
       class Built
-        def initialize(real:, type:, ignore_nil:, &transform_block)
+        def initialize(real:, type:, ignore_nil:, attribute_name:, &transform_block)
           @real = real
           @type = type
           @ignore_nil = ignore_nil
+          @attribute_name = attribute_name
           @transform_block = transform_block
         end
 
-        def real?; @real; end
+        def real?
+          @real
+        end
         attr_reader :type
+        attr_reader :attribute_name
 
         def present(attribute_name, value = nil)
           if @transform_block.nil?
             if attribute_name
-              raise Error::ArgumentError, "Transformation block is not set for column: #{attribute_name}"
+              raise Error::ArgumentError, "Transformation block is not set for attribute: #{attribute_name}"
             else
               raise Error::ArgumentError, "Transformation block is not set!"
             end
@@ -61,97 +82,55 @@ module Super
         end
       end
 
-      class Badge
-        extend Useful::Builder
-
-        def initialize(builder)
-          @builder = builder
-          @whens = {}
-          format_for_lookup(&:itself)
-          format_for_display(&:itself)
-        end
-
-        builder_with_block def when(*patterns, &block)
-          patterns.each do |pattern|
-            @whens[pattern] = block
-          end
-        end
-
-        builder_with_block def else(&block)
-          @else = block
-        end
-
-        builder_with_block def format_for_lookup(&block)
-          @format_for_lookup = block
-        end
-
-        builder_with_block def format_for_display(&block)
-          @format_for_display = block
-        end
-
-        def build
-          @builder.transform do |value|
-            lookup_value = @format_for_lookup.call(value)
-            block = @whens[lookup_value] || @else
-            Super::Badge.new(
-              @format_for_display.call(value),
-              styles: block&.call
-            )
-          end
-          @builder.build
-        end
-      end
-
       def initialize(fields:)
         @actions_called = false
         @fields = fields
       end
 
-      def real(type = :column, &transform_block)
+      def real(type = :attribute, &transform_block)
         TYPES
           .case(type)
-          .when(:column) { Builder.new.real.ignore_nil.column.transform(&transform_block) }
+          .when(:attribute) { Builder.new.real.ignore_nil.attribute.transform(&transform_block) }
           .when(:record) { Builder.new.real.ignore_nil.record.transform(&transform_block) }
-          .when(:none)   { Builder.new.real.ignore_nil.none.transform(&transform_block) }
+          .when(:none) { Builder.new.real.ignore_nil.none.transform(&transform_block) }
           .result
       end
 
-      def computed(type = :column, &transform_block)
+      def computed(type = :attribute, &transform_block)
         TYPES
           .case(type)
-          .when(:column) { Builder.new.computed.ignore_nil.column.transform(&transform_block) }
+          .when(:attribute) { Builder.new.computed.ignore_nil.attribute.transform(&transform_block) }
           .when(:record) { Builder.new.computed.ignore_nil.record.transform(&transform_block) }
-          .when(:none)   { Builder.new.computed.ignore_nil.none.transform(&transform_block) }
+          .when(:none) { Builder.new.computed.ignore_nil.none.transform(&transform_block) }
           .result
       end
 
       def manual(&transform_block)
-        real(:column, &transform_block)
+        real(:attribute, &transform_block)
       end
 
       def batch
         real do |value|
-          Partial.new("batch_checkbox", locals: { value: value })
+          Partial.new("batch_checkbox", locals: {value: value})
         end
       end
 
-      def string; real(&:to_s); end
+      def string
+        real(&:to_s)
+      end
 
-      def timestamp; real(&:to_s); end
-      def time; real { |value| value.strftime("%H:%M:%S") }; end
+      def timestamp
+        real(&:to_s)
+      end
 
-      def rich_text
-        computed do |value|
-          Partial.new("display_rich_text", locals: { rich_text: value })
-        end
+      def time
+        real { |value| value.strftime("%H:%M:%S") }
       end
 
-      def badge(*builder_methods)
-        builder_methods = %i[real ignore_nil column] if builder_methods.empty?
-        builder = builder_methods.each_with_object(Builder.new) do |builder_method, builder|
-          builder.public_send(builder_method)
+      def rich_text
+        computed do |value|
+          Partial.new("display_rich_text", locals: {rich_text: value})
         end
-        Badge.new(builder)
       end
 
       def actions

data/lib/super/display.rb

@@ -26,7 +26,9 @@ module Super
     include Schema::Common
 
     def initialize
-      @fields = Super::Schema::Fields.new
+      @fields = Super::Schema::Fields.new(
+        transform_value_on_set: ->(val) { val.respond_to?(:build) ? val.build : val }
+      )
       @schema_types = SchemaTypes.new(fields: @fields)
 
       yield(@fields, @schema_types)
@@ -43,7 +45,7 @@ module Super
 
     def to_partial_path
       if @action_inquirer.nil?
-        raise Super::Error::Initalization,
+        raise Super::Error::Initialization,
           "You must call the `#apply` method after instantiating Super::Display"
       elsif @action_inquirer.index?
         "display_index"
@@ -57,22 +59,21 @@ module Super
     # @private
     def render_attribute(template:, record:, column:)
       formatter = @fields[column]
-      formatter = formatter.build if formatter.respond_to?(:build)
 
       formatted =
         SchemaTypes::TYPES
-        .case(formatter.type)
-        .when(:record) do
-          formatter.present(column, record)
-        end
-        .when(:column) do
-          value = record.public_send(column)
-          formatter.present(column, value)
-        end
-        .when(:none) do
-          formatter.present(column)
-        end
-        .result
+          .case(formatter.type)
+          .when(:record) do
+            formatter.present(column, record)
+          end
+          .when(:attribute) do
+            value = record.public_send(column)
+            formatter.present(column, value)
+          end
+          .when(:none) do
+            formatter.present(column)
+          end
+          .result
 
       if formatted.respond_to?(:to_partial_path)
         if formatted.respond_to?(:locals)

data/lib/super/error.rb

@@ -7,14 +7,19 @@ module Super
   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
+
     # 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
+
     # Error raised when rendering if `@view` wasn't set by the controller
     class NothingToRender < Error
       def initialize(basename)
@@ -24,23 +29,32 @@ module Super
         )
       end
     end
-    # Error raised when something wasn't initalized correctly, and if there isn't
+
+    # Error raised when something wasn't initialized correctly, and if there isn't
     # a more specific error
-    class Initalization < Error; end
+    class Initialization < Error; end
+
     class ArgumentError < Error; end
+
     class AlreadyRegistered < Error; end
+
     class AlreadyTranscribed < Error; end
+
     class NotImplementedError < Error; end
+
     class IncompleteBuilder < Error; end
 
     class Enum < Error
       class ImpossibleValue < Enum; end
+
       class ArgumentError < Enum; end
+
       class UndefinedCase < Enum; end
     end
 
     class ReorderableHash < Error
       class DuplicateKey < ReorderableHash; end
+
       class KeyError < ReorderableHash; end
     end
 

data/lib/super/filter/form_object.rb

@@ -44,8 +44,8 @@ module Super
           query_parameter_keys = [NULLARY] if query_parameter_keys.empty?
           @specified_values =
             query_parameter_keys
-            .map { |key| [key, @params[key].presence&.strip] }
-            .to_h
+              .map { |key| [key, @params[key].presence&.strip] }
+              .to_h
 
           @specified_values.each do |key, value|
             define_singleton_method(key) { value }

data/lib/super/filter/operator.rb

@@ -57,7 +57,7 @@ module Super
       attr_reader :humanized_operator_name
 
       def behavior(&block)
-        self.behavior = block if block_given?
+        self.behavior = block if block
         @behavior
       end
 

data/lib/super/filter/schema_types.rb

@@ -28,7 +28,7 @@ module Super
           nil
         end
 
-        alias add push
+        alias_method :add, :push
 
         def each
           return enum_for(:each) if !block_given?

data/lib/super/form/field_transcript.rb

@@ -38,6 +38,10 @@ module Super
         @kwargs = kwargs
         @method_name
       end
+
+      def respond_to_missing?(*, **)
+        true
+      end
     end
   end
 end

data/lib/super/form/schema_types.rb

@@ -79,7 +79,7 @@ module Super
           end
 
           if @extras.key?(:reader)
-            return @extras[:reader].to_s.singularize.humanize
+            @extras[:reader].to_s.singularize.humanize
           end
         end
 
@@ -142,7 +142,7 @@ module Super
       end
 
       def self.define_schema_type_for(method_name)
-        class_eval(<<~RUBY)
+        class_eval(<<~RUBY, __FILE__, __LINE__ + 1)
           def #{method_name}(*args, **kwargs)
             Direct.new(super_builder: true, method_name: :#{method_name}!, args: args, kwargs: kwargs)
           end

data/lib/super/form/strong_params.rb

@@ -20,7 +20,7 @@ module Super
       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)] }
+            {name => [:id, *unfurl(type)]}
           else
             name
           end

data/lib/super/form_builder/base_methods.rb

@@ -3,7 +3,7 @@
 module Super
   class FormBuilder
     class Wrappers
-      skipped_field_helpers = [:label, :check_box, :radio_button, :fields_for, :fields, :hidden_field, :file_field]
+      skipped_field_helpers = [:label, :check_box, :radio_button, :fields_for, :fields, :hidden_field]
       (ActionView::Helpers::FormBuilder.field_helpers - skipped_field_helpers).each do |builder_method_name|
         class_eval(<<~RUBY, __FILE__, __LINE__ + 1)
           def #{builder_method_name}(attribute, options = {})
@@ -30,26 +30,20 @@ module Super
 
       def check_box!(attribute, checked_value: "1", unchecked_value: "0", label_text: nil, label: {}, field: {}, show_errors: true)
         label[:super] ||= {}
-        label[:super] = { class: "select-none ml-1" }.merge(label[:super])
+        label[:super] = {class: "select-none ml-1"}.merge(label[:super])
         container do
           compact_join([
             "<div>".html_safe,
             public_send(:check_box, attribute, field, checked_value, unchecked_value),
             public_send(:label, attribute, label_text, label),
             "</div>".html_safe,
-            show_errors && inline_errors(attribute),
+            show_errors && inline_errors(attribute)
           ])
         end
       end
 
       ::Super::Form::SchemaTypes.define_schema_type_for(:check_box)
 
-      # def file_field(attribute, options = {})
-      # end
-
-      # def file_field!(attribute, label_text: nil, label: {}, field: {}, show_errors: true)
-      # end
-
       def hidden_field(attribute, options = {})
         @builder.hidden_field(attribute, options)
       end

data/lib/super/form_builder/flatpickr_methods.rb

@@ -10,7 +10,7 @@ module Super
           data: {
             controller: "flatpickr",
             flatpickr_options_value: {
-              dateFormat: "Y-m-d",
+              dateFormat: "Y-m-d"
             }
           }
         )
@@ -33,7 +33,7 @@ module Super
             flatpickr_options_value: {
               enableSeconds: true,
               enableTime: true,
-              dateFormat: "Z",
+              dateFormat: "Z"
             }
           }
         )
@@ -57,7 +57,7 @@ module Super
               enableSeconds: true,
               enableTime: true,
               noCalendar: true,
-              dateFormat: "H:i:S",
+              dateFormat: "H:i:S"
             }
           }
         )