super 0.20.0 → 0.21.0

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
@@ -15,37 +15,47 @@ module Super
         builder def real; @real = true; end
         builder def computed; @real = false; end
 
-        builder def column; @type = :column; end
+        # @deprecated Prefer {#attribute}
+        builder def column
+          Useful::Deprecation["0.22"].deprecation_warning(":column", "use :attribute instead")
+          @type = :attribute
+        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 attribute_name(name); @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
         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,6 +71,7 @@ module Super
         end
       end
 
+      # @deprecated
       class Badge
         extend Useful::Builder
 
@@ -107,26 +118,36 @@ module Super
         @fields = fields
       end
 
-      def real(type = :column, &transform_block)
+      def real(type = :attribute, &transform_block)
+        if type == :column
+          Useful::Deprecation["0.22"].deprecation_warning(":column", "use :attribute instead")
+          type = :attribute
+        end
+
         TYPES
           .case(type)
-          .when(:column) { Builder.new.real.ignore_nil.column.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(: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) }
           .result
       end
 
-      def computed(type = :column, &transform_block)
+      def computed(type = :attribute, &transform_block)
+        if type == :column
+          Useful::Deprecation["0.22"].deprecation_warning(":column", "use :attribute instead")
+          type = :attribute
+        end
+
         TYPES
           .case(type)
-          .when(:column) { Builder.new.computed.ignore_nil.column.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(: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) }
           .result
       end
 
       def manual(&transform_block)
-        real(:column, &transform_block)
+        real(:attribute, &transform_block)
       end
 
       def batch
@@ -146,8 +167,10 @@ module Super
         end
       end
 
+      # @deprecated Use {#real} or {#computed} instead, and return an instance of {Super::Badge}
       def badge(*builder_methods)
-        builder_methods = %i[real ignore_nil column] if builder_methods.empty?
+        Useful::Deprecation["0.22"].deprecation_warning("#badge", "use #real or #computed instead, and return an instance of Super::Badge")
+        builder_methods = %i[real ignore_nil attribute] if builder_methods.empty?
         builder = builder_methods.each_with_object(Builder.new) do |builder_method, builder|
           builder.public_send(builder_method)
         end

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) { if val.respond_to?(:build) then val.build else val end }
+      )
       @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,7 +59,6 @@ module Super
     # @private
     def render_attribute(template:, record:, column:)
       formatter = @fields[column]
-      formatter = formatter.build if formatter.respond_to?(:build)
 
       formatted =
         SchemaTypes::TYPES
@@ -65,7 +66,7 @@ module Super
         .when(:record) do
           formatter.present(column, record)
         end
-        .when(:column) do
+        .when(:attribute) do
           value = record.public_send(column)
           formatter.present(column, value)
         end

data/lib/super/error.rb

@@ -24,9 +24,9 @@ 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

data/{app/helpers → lib}/super/form_builder_helper.rb

@@ -28,5 +28,16 @@ module Super
     ensure
       ActionView::Base.field_error_proc = original
     end
+
+    # Super's version of `#fields_for`
+    def super_fields_for(*args, **options, &block)
+      original = ActionView::Base.field_error_proc
+      ActionView::Base.field_error_proc = FormBuilder::FIELD_ERROR_PROC
+
+      options[:builder] ||= FormBuilder
+      return fields_for(*args, **options, &block)
+    ensure
+      ActionView::Base.field_error_proc = original
+    end
   end
 end

data/lib/super/navigation.rb

@@ -4,14 +4,14 @@ module Super
   class Navigation
     def initialize
       @builder = Builder.new
-      @definition = yield @builder
-      if !@definition.is_a?(Array)
-        @definition = [@definition]
+      result = yield @builder
+      if result.is_a?(Array)
+        Useful::Deprecation["0.22"].deprecation_warning("returning an array", "calling a Super::Navigation builder method defines the navigation")
       end
     end
 
     def definition
-      return @defs if instance_variable_defined?(:@defs)
+      return @definition if instance_variable_defined?(:@definition)
 
       searcher = RouteFormatterButReallySearcher.new
       inspector = ActionDispatch::Routing::RoutesInspector.new(Rails.application.routes.routes)
@@ -19,37 +19,12 @@ module Super
       all_matches = searcher.matches
       unused_matches = all_matches.each_with_object({}) { |match, hash| hash[match] = true }
 
-      defs = expand_proc_syntax_sugar(@definition)
-      defs = validate_and_determine_explicit_links(defs, unused_matches)
-      @defs = expand_directives(defs, all_matches, unused_matches.keys)
+      defs = validate_and_determine_explicit_links(@builder.build, unused_matches)
+      @definition = expand_directives(defs, all_matches, unused_matches.keys)
     end
 
     private
 
-    # This expands the syntax sugar that allows `nav.menu("Name")[nav.link(Item)]`
-    def expand_proc_syntax_sugar(definition)
-      definition.map do |link_or_menu_or_rest_or_menuproc|
-        link_or_menu_or_rest =
-          if link_or_menu_or_rest_or_menuproc.is_a?(Proc)
-            link_or_menu_or_rest_or_menuproc.call
-          else
-            link_or_menu_or_rest_or_menuproc
-          end
-
-        if link_or_menu_or_rest.is_a?(Menu)
-          link_or_menu_or_rest.links = link_or_menu_or_rest.links.map do |menu_item|
-            if menu_item.is_a?(Proc)
-              menu_item.call
-            else
-              menu_item
-            end
-          end
-        end
-
-        link_or_menu_or_rest
-      end
-    end
-
     def validate_and_determine_explicit_links(definition, unused_links)
       definition.each do |link_or_menu_or_rest|
         if link_or_menu_or_rest.is_a?(Super::Link)
@@ -103,31 +78,56 @@ module Super
     Menu = Struct.new(:title, :links)
 
     class Builder
+      def initialize
+        @links = []
+        @menu_level = 0
+      end
+
+      def build
+        @links
+      end
+
       def link(model, **kwargs)
         text = model.model_name.human.pluralize
         parts = Super::Link.polymorphic_parts(model)
 
-        Super::Link.new(text, parts, **kwargs)
+        @links.push(Super::Link.new(text, parts, **kwargs))
+        self
       end
 
       def link_to(*args, **kwargs)
-        Super::Link.new(*args, **kwargs)
+        @links.push(Super::Link.new(*args, **kwargs))
+        self
       end
 
-      def menu(title, *links)
-        menu = Menu.new(title, links)
-        proc do |*more_links|
-          menu.links += more_links
-          menu
+      def menu(title)
+        if @menu_level > 0
+          raise Super::Error::ArgumentError, "Navigation menus can't be nested"
+        end
+
+        begin
+          @menu_level += 1
+          original_links = @links
+          @links = []
+          yield
+          menu_links = @links
+        ensure
+          @links = original_links
+          @menu_level -= 1
         end
+
+        @links.push(Menu.new(title, menu_links))
+        self
       end
 
       def rest
-        REST
+        @links.push(REST)
+        self
       end
 
       def all
-        ALL
+        @links.push(ALL)
+        self
       end
     end
 

data/lib/super/query.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Super
+  class Query
+    def initialize(model:, params:, current_path:)
+      @model = model
+      @params = params
+      @path = current_path
+      @addons = {}
+      @backwards_addons = {}
+    end
+
+    attr_reader :addons
+    attr_reader :model
+    attr_reader :params
+    attr_reader :path
+    attr_reader :backwards_addons
+
+    private :model
+    private :params
+    private :backwards_addons
+
+    def build(klass, namespace:, **additional_initialization_arguments)
+      params_for_querier =
+        params.fetch(namespace) { ActiveSupport::HashWithIndifferentAccess.new }
+
+      instance = klass.new(
+        model: model,
+        params: params_for_querier,
+        **additional_initialization_arguments
+      )
+
+      addons[namespace] = instance
+      backwards_addons[instance] = namespace
+      instance
+    end
+
+    def namespace_for(query_form_object)
+      backwards_addons.fetch(query_form_object)
+    end
+
+    def form_options
+      {
+        url: path,
+        method: :get
+      }
+    end
+
+    def apply_changes(records)
+      addons.each_value do |addon|
+        records = addon.apply_changes(records)
+      end
+
+      records
+    end
+
+    def to_partial_path
+      "query"
+    end
+  end
+end

data/lib/super/{engine.rb → railtie.rb}

@@ -2,7 +2,7 @@
 
 module Super
   # Configures the host Rails app to work with Super
-  class Engine < ::Rails::Engine
+  class Railtie < ::Rails::Engine
     isolate_namespace Super
 
     initializer "super.assets.precompile" do |app|
@@ -11,6 +11,12 @@ module Super
       end
     end
 
+    initializer "super.inclusion" do
+      ActiveSupport.on_load(:action_view) do
+        include Super::FormBuilderHelper
+      end
+    end
+
     config.to_prepare do
       Super::Plugin::Registry.controller.ordered do |klass, method_name|
         Super::ApplicationController.public_send(method_name, klass)

data/lib/super/reset.rb

@@ -16,6 +16,8 @@ module Super
       # Defined in Super::ApplicationController
       current_action: true,
       with_current_action: true,
+
+      # Keep all of the ones in Super::SitewideController
     }
 
     included do
@@ -27,6 +29,11 @@ module Super
       undef_method :update
       undef_method :destroy
 
+      Super::ViewController.private_instance_methods(false).each do |imethod|
+        next if KEEP.key?(imethod)
+        undef_method imethod
+      end
+
       Super::SubstructureController.private_instance_methods(false).each do |imethod|
         next if KEEP.key?(imethod)
         undef_method imethod

data/lib/super/schema.rb

@@ -14,8 +14,9 @@ module Super
     class Fields
       include Enumerable
 
-      def initialize
+      def initialize(transform_value_on_set: nil)
         @backing = {}
+        @transform_value_on_set = transform_value_on_set
       end
 
       def [](key)
@@ -23,7 +24,12 @@ module Super
       end
 
       def []=(key, value)
-        @backing[key] = value
+        @backing[key] =
+          if @transform_value_on_set
+            @transform_value_on_set.call(value)
+          else
+            value
+          end
       end
 
       def keys

data/lib/super/sort.rb

@@ -7,11 +7,9 @@ module Super
 
       def initialize(model:, params:, default:, sortable_columns:)
         @model = model
-        @params = params.dup
+        @params = params
         @default = default
         @sortable_columns = sortable_columns.map(&:to_s)
-
-        @params.permit!
       end
 
       attr_reader :sortable_columns

data/lib/super/useful/deprecations.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "active_support/deprecation"
+
+module Super
+  module Useful
+    class Deprecation
+      VERSIONS = {
+        "0.22" => ActiveSupport::Deprecation.new("0.22", "Super")
+      }
+      private_constant :VERSIONS
+
+      def self.[](version)
+        VERSIONS.fetch(version)
+      end
+    end
+  end
+end

data/lib/super/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Super
-  VERSION = "0.20.0"
+  VERSION = "0.21.0"
 end

data/lib/super/view_chain.rb

@@ -6,10 +6,6 @@ module Super
       @data = ReorderableHash.new(chain)
     end
 
-    def chain
-      @chain ||= @data.values
-    end
-
     def insert(*args, **kwargs)
       if instance_variable_defined?(:@chain)
         raise Error::ViewChain::ChainAlreadyStarted
@@ -21,5 +17,19 @@ module Super
     def to_partial_path
       "view_chain"
     end
+
+    def shift
+      chain.shift
+    end
+
+    def empty?
+      chain.empty?
+    end
+
+    private
+
+    def chain
+      @chain ||= @data.to_h
+    end
   end
 end

data/lib/super.rb

@@ -2,10 +2,15 @@
 
 require "tsort"
 
+if !ENV["SUPER_SKIP_REQUIRE_CSV"]
+  require "csv"
+end
+
 require "rails/engine"
 
 require "super/schema/common"
 require "super/useful/builder"
+require "super/useful/deprecations"
 require "super/useful/enum"
 require "super/useful/i19"
 
@@ -35,6 +40,7 @@ require "super/form_builder/action_text_methods"
 require "super/form_builder/base_methods"
 require "super/form_builder/flatpickr_methods"
 require "super/form_builder/option_methods"
+require "super/form_builder_helper"
 require "super/layout"
 require "super/link"
 require "super/link_builder"
@@ -44,7 +50,7 @@ require "super/pagination"
 require "super/panel"
 require "super/partial"
 require "super/plugin"
-require "super/query/form_object"
+require "super/query"
 require "super/reorderable_hash"
 require "super/reset"
 require "super/schema"
@@ -54,4 +60,4 @@ require "super/version"
 require "super/view_chain"
 require "super/view_helper"
 
-require "super/engine"
+require "super/railtie"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: super
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.21.0
 platform: ruby
 authors:
 - Zach Ahn
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-09 00:00:00.000000000 Z
+date: 2022-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -128,48 +128,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest-ci
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: appraisal
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -254,8 +212,9 @@ files:
 - app/assets/javascripts/super/application.js
 - app/assets/stylesheets/super/application.css
 - app/controllers/super/application_controller.rb
+- app/controllers/super/sitewide_controller.rb
 - app/controllers/super/substructure_controller.rb
-- app/helpers/super/form_builder_helper.rb
+- app/controllers/super/view_controller.rb
 - app/views/layouts/super/application.html.erb
 - app/views/super/application/_batch_button.html.erb
 - app/views/super/application/_batch_checkbox.csv.erb
@@ -295,7 +254,6 @@ files:
 - app/views/super/feather/README.md
 - app/views/super/feather/_x.html
 - config/locales/en.yml
-- config/routes.rb
 - frontend/super-frontend/dist/application.css
 - frontend/super-frontend/dist/application.js
 - frontend/super-frontend/dist/package.json
@@ -324,7 +282,6 @@ files:
 - lib/super/display.rb
 - lib/super/display/guesser.rb
 - lib/super/display/schema_types.rb
-- lib/super/engine.rb
 - lib/super/error.rb
 - lib/super/filter.rb
 - lib/super/filter/form_object.rb
@@ -342,6 +299,7 @@ files:
 - lib/super/form_builder/base_methods.rb
 - lib/super/form_builder/flatpickr_methods.rb
 - lib/super/form_builder/option_methods.rb
+- lib/super/form_builder_helper.rb
 - lib/super/layout.rb
 - lib/super/link.rb
 - lib/super/link_builder.rb
@@ -352,7 +310,8 @@ files:
 - lib/super/partial.rb
 - lib/super/partial/resolving.rb
 - lib/super/plugin.rb
-- lib/super/query/form_object.rb
+- lib/super/query.rb
+- lib/super/railtie.rb
 - lib/super/reorderable_hash.rb
 - lib/super/reset.rb
 - lib/super/schema.rb
@@ -360,6 +319,7 @@ files:
 - lib/super/schema/guesser.rb
 - lib/super/sort.rb
 - lib/super/useful/builder.rb
+- lib/super/useful/deprecations.rb
 - lib/super/useful/enum.rb
 - lib/super/useful/i19.rb
 - lib/super/version.rb
@@ -390,7 +350,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.4
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: A simple, powerful, zero dependency Rails admin framework

data/config/routes.rb

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-
-Rails.application.routes.draw do
-end