super 0.20.0 → 0.22.0

data/lib/super/form_builder.rb

@@ -19,7 +19,7 @@ module Super
   # https://api.rubyonrails.org/classes/ActionView/Helpers/FormBuilder.html
   class FormBuilder < ActionView::Helpers::FormBuilder
     FIELD_ERROR_PROC = proc { |html_tag, instance| html_tag }
-    FORM_BUILDER_DEFAULTS = { builder: self }.freeze
+    FORM_BUILDER_DEFAULTS = {builder: self}.freeze
 
     def super(**options)
       @super_wrappers ||= Wrappers.new(self, @template)
@@ -68,29 +68,27 @@ module Super
           elsif type == :block
             definition_last.push("&#{name}")
             call_last.push("&#{name}")
-          else
-            if type == :req
-              definition.push(name.to_s)
+          elsif type == :req
+            definition.push(name.to_s)
+            call.push(name.to_s)
+          elsif type == :opt || type == :key
+            if !optionals.key?(name)
+              raise Super::Error::ArgumentError, "Form bang method has optional argument, but doesn't know the default value: #{name}"
+            end
+
+            default_value = optionals[name]
+
+            if type == :opt
+              definition.push("#{name} = #{default_value}")
               call.push(name.to_s)
-            elsif type == :opt || type == :key
-              if !optionals.key?(name)
-                raise Super::Error::ArgumentError, "Form bang method has optional argument, but doesn't know the default value: #{name}"
-              end
-
-              default_value = optionals[name]
-
-              if type == :opt
-                definition.push("#{name} = #{default_value}")
-                call.push(name.to_s)
-              elsif type == :key
-                definition.push("#{name}: #{default_value}")
-                call.push("#{name}: #{name}")
-              else
-                raise Super::Error::ArgumentError, "Form bang method has a unprocessable argument with name #{name}"
-              end
+            elsif type == :key
+              definition.push("#{name}: #{default_value}")
+              call.push("#{name}: #{name}")
             else
-              raise Super::Error::ArgumentError, "Form bang method has keyword argument type #{type} and name #{name}"
+              raise Super::Error::ArgumentError, "Form bang method has a unprocessable argument with name #{name}"
             end
+          else
+            raise Super::Error::ArgumentError, "Form bang method has keyword argument type #{type} and name #{name}"
           end
         end
 

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

@@ -13,7 +13,7 @@ module Super
       ActionView::Base.field_error_proc = FormBuilder::FIELD_ERROR_PROC
 
       options[:builder] ||= FormBuilder
-      return form_for(record, options, &block)
+      form_for(record, options, &block)
     ensure
       ActionView::Base.field_error_proc = original
     end
@@ -24,7 +24,18 @@ module Super
       ActionView::Base.field_error_proc = FormBuilder::FIELD_ERROR_PROC
 
       options[:builder] ||= FormBuilder
-      return form_with(**options, &block)
+      form_with(**options, &block)
+    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
+      fields_for(*args, **options, &block)
     ensure
       ActionView::Base.field_error_proc = original
     end

data/lib/super/link.rb

@@ -26,24 +26,24 @@ module Super
       @registry ||= {}.tap do |reg|
         reg[:new] = LinkBuilder.new
           .text { |params:| Super::Useful::I19.i18n_with_fallback("super", params[:controller].split("/"), "actions.new") }
-          .href { |params:| { controller: params[:controller], action: :new, only_path: true } }
+          .href { |params:| {controller: params[:controller], action: :new, only_path: true} }
           .freeze
         reg[:index] = LinkBuilder.new
           .text { |params:| Super::Useful::I19.i18n_with_fallback("super", params[:controller].split("/"), "actions.index") }
-          .href { |params:| { controller: params[:controller], action: :index, only_path: true } }
+          .href { |params:| {controller: params[:controller], action: :index, only_path: true} }
           .freeze
         reg[:show] = LinkBuilder.new
           .text { |params:, **| Super::Useful::I19.i18n_with_fallback("super", params[:controller].split("/"), "actions.show") }
-          .href { |params:, record:| { controller: params[:controller], action: :show, id: record, only_path: true } }
+          .href { |params:, record:| {controller: params[:controller], action: :show, id: record, only_path: true} }
           .freeze
         reg[:edit] = LinkBuilder.new
           .text { |params:, **| Super::Useful::I19.i18n_with_fallback("super", params[:controller].split("/"), "actions.edit") }
-          .href { |params:, record:| { controller: params[:controller], action: :edit, id: record, only_path: true } }
+          .href { |params:, record:| {controller: params[:controller], action: :edit, id: record, only_path: true} }
           .freeze
         reg[:destroy] = LinkBuilder.new
           .text { |params:, **| Super::Useful::I19.i18n_with_fallback("super", params[:controller].split("/"), "actions.destroy") }
-          .href { |params:, record:| { controller: params[:controller], action: :destroy, id: record, only_path: true } }
-          .options { |**| { method: :delete, data: { confirm: "Really delete?" } } }
+          .href { |params:, record:| {controller: params[:controller], action: :destroy, id: record, only_path: true} }
+          .options { |**| {method: :delete, data: {confirm: "Really delete?"}} }
           .freeze
       end
     end
@@ -91,6 +91,15 @@ module Super
       @href = Super::Compatability.polymorphic_path_container.polymorphic_path(@href)
     end
 
+    def to_link(template, local_assigns)
+      default_options = local_assigns.fetch(:default_options, {})
+      template.link_to(
+        text,
+        href,
+        default_options.deep_merge(options)
+      )
+    end
+
     def to_partial_path
       "link"
     end

data/lib/super/link_builder.rb

@@ -20,10 +20,10 @@ module Super
       raise Super::Error::IncompleteBuilder, "LinkBuilder requires that #text is set" if @text.nil?
       raise Super::Error::IncompleteBuilder, "LinkBuilder requires that #href is set" if @href.nil?
 
-      @options ||= -> (**) { {} }
-      @process_text ||= -> (t) { t }
-      @process_href ||= -> (h) { h }
-      @process_options ||= -> (o) { o }
+      @options ||= ->(**) { {} }
+      @process_text ||= ->(t) { t }
+      @process_href ||= ->(h) { h }
+      @process_options ||= ->(o) { o }
 
       Super::Link.new(
         @process_text.call(@text.call(**kwargs)),

data/lib/super/navigation.rb

@@ -4,14 +4,11 @@ module Super
   class Navigation
     def initialize
       @builder = Builder.new
-      @definition = yield @builder
-      if !@definition.is_a?(Array)
-        @definition = [@definition]
-      end
+      yield @builder
     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 +16,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 +75,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
 
@@ -155,10 +152,17 @@ module Super
         end
       end
 
-      def header(routes); end
-      def no_routes(routes, filter); end
-      def result; end
-      def section_title(title); end
+      def header(routes)
+      end
+
+      def no_routes(routes, filter)
+      end
+
+      def result
+      end
+
+      def section_title(title)
+      end
     end
   end
 end

data/lib/super/partial.rb

@@ -2,18 +2,6 @@
 
 module Super
   class Partial
-    def self.render(partialish, template:)
-      if partialish.respond_to?(:to_partial_path)
-        if partialish.respond_to?(:locals)
-          template.render(partialish, partialish.locals)
-        else
-          template.render(partialish)
-        end
-      else
-        partialish
-      end
-    end
-
     def initialize(path, locals: {})
       @to_partial_path = path
       @locals = locals

data/lib/super/plugin.rb

@@ -27,8 +27,8 @@ module Super
       end
 
       def classes_ordered
-        each_node = -> (&b) { @ordering.each_key(&b) }
-        each_child = -> (cb, &b) { @ordering[cb].each(&b) }
+        each_node = ->(&b) { @ordering.each_key(&b) }
+        each_child = ->(cb, &b) { @ordering[cb].each(&b) }
 
         TSort.tsort(each_node, each_child)
       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,13 @@ module Super
       end
     end
 
+    initializer "super.inclusion" do
+      ActiveSupport.on_load(:action_view) do
+        include Super::FormBuilderHelper
+        include Super::RenderHelper
+      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/render_helper.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+# typed: false
+
+module Super::RenderHelper
+  def super_render(*args, **kwargs, &block)
+    if args.size >= 1
+      renderable = args.first
+
+      case renderable
+      when ActiveSupport::SafeBuffer
+        return renderable
+      when Super::Partial
+        return render(*args, **kwargs, &block)
+      when Super::Link
+        return renderable.to_link(self, kwargs)
+      when Super::ViewChain
+        return renderable.handle_super_render(self, kwargs)
+      end
+    end
+
+    render(*args, **kwargs, &block)
+  end
+
+  def super_resolve_renderable(renderable)
+    if renderable.is_a?(Symbol)
+      instance_variable_get(renderable)
+    else
+      renderable
+    end
+  end
+end

data/lib/super/reset.rb

@@ -10,12 +10,9 @@ module Super
       _generate_paths_by_default: true,
 
       # Defined in Super::SubstructureController
-      navigation: true,
-      page_title: true,
+      page_title: true
 
-      # Defined in Super::ApplicationController
-      current_action: true,
-      with_current_action: true,
+      # Keep all of the ones in Super::SitewideController
     }
 
     included do
@@ -27,6 +24,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/guesser.rb

@@ -21,7 +21,7 @@ module Super
       end
 
       def ignore_foreign_keys
-        @rejects.push(-> (attribute_name) { is_foreign_key[attribute_name] })
+        @rejects.push(->(attribute_name) { is_foreign_key[attribute_name] })
         self
       end
 
@@ -69,10 +69,10 @@ module Super
       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
+            .reflect_on_all_associations
+            .select { |a| a.macro == :belongs_to }
+            .map { |a| [a.foreign_key, true] }
+            .to_h
       end
     end
   end

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
@@ -35,7 +41,7 @@ module Super
       end
 
       def each(&block)
-        if block_given?
+        if block
           return @backing.each(&block)
         end
 
@@ -59,7 +65,7 @@ module Super
         inside = {}
         @backing = inside
         yield
-        return inside
+        inside
       ensure
         @backing = outside
         inside

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
@@ -101,7 +99,7 @@ module Super
         @default.map do |attribute_name, direction|
           {
             a: attribute_name,
-            d: direction,
+            d: direction
           }
         end
       end

data/lib/super/useful/deprecations.rb

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

data/lib/super/useful/enum.rb

@@ -24,7 +24,7 @@ module Super
         end
 
         def when(*keys, &block)
-          if !block_given?
+          if !block
             raise Error::ArgumentError, "must receive block"
           end
 

data/lib/super/useful/i19.rb

@@ -24,7 +24,7 @@ module Super
       def chain_to_i18n(chain)
         head, *tail = chain
 
-        [head, { default: tail }]
+        [head, {default: tail}]
       end
 
       def i18n_with_fallback(prefix, optional, suffix)

data/lib/super/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Super
-  VERSION = "0.20.0"
+  VERSION = "0.22.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,38 @@ module Super
     def to_partial_path
       "view_chain"
     end
+
+    def shift
+      chain.shift
+    end
+
+    def empty?
+      chain.empty?
+    end
+
+    def handle_super_render(template, local_assigns, &block)
+      name, current = shift
+      current = template.super_resolve_renderable(current)
+
+      if !current
+        Rails.logger.warn do
+          "Super::ViewChain encountered a nil view: #{name.inspect}."
+        end
+      end
+
+      if empty?
+        template.super_render(current)
+      else
+        template.super_render(current) do
+          template.concat(template.super_render(self))
+        end
+      end
+    end
+
+    private
+
+    def chain
+      @chain ||= @data.to_h
+    end
   end
 end