super 0.19.0.rc1 → 0.21.0

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

@@ -10,9 +10,9 @@ module Super
     # Super's version of `#form_for`
     def super_form_for(record, options = {}, &block)
       original = ActionView::Base.field_error_proc
-      ActionView::Base.field_error_proc = Form::Builder::FIELD_ERROR_PROC
+      ActionView::Base.field_error_proc = FormBuilder::FIELD_ERROR_PROC
 
-      options[:builder] ||= Form::Builder
+      options[:builder] ||= FormBuilder
       return form_for(record, options, &block)
     ensure
       ActionView::Base.field_error_proc = original
@@ -21,12 +21,23 @@ module Super
     # Super's version of `#form_with`
     def super_form_with(**options, &block)
       original = ActionView::Base.field_error_proc
-      ActionView::Base.field_error_proc = Form::Builder::FIELD_ERROR_PROC
+      ActionView::Base.field_error_proc = FormBuilder::FIELD_ERROR_PROC
 
-      options[:builder] ||= Form::Builder
+      options[:builder] ||= FormBuilder
       return 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
+      return fields_for(*args, **options, &block)
+    ensure
+      ActionView::Base.field_error_proc = original
+    end
   end
 end

data/lib/super/link.rb

@@ -9,75 +9,43 @@ module Super
     end
 
     def self.find(link)
-      if link.kind_of?(self)
-        return link
-      end
-
       if registry.key?(link)
-        return registry[link]
+        found = registry[link]
+
+        if found.is_a?(LinkBuilder)
+          return found.dup
+        else
+          return found
+        end
       end
 
       raise Error::LinkNotRegistered, "Unknown link `#{link}`"
     end
 
     def self.registry
-      @registry ||= {
-        new: LinkBuilder.new(
-          "New",
-          -> (params:) {
-            {
-              controller: params[:controller],
-              action: :new,
-              only_path: true
-            }
-          }
-        ),
-        index: LinkBuilder.new(
-          "Index",
-          -> (params:) {
-            {
-              controller: params[:controller],
-              action: :index,
-              only_path: true
-            }
-          }
-        ),
-        show: LinkBuilder.new(
-          "View",
-          -> (record:, params:) {
-            {
-              controller: params[:controller],
-              action: :show,
-              id: record,
-              only_path: true
-            }
-          }
-        ),
-        edit: LinkBuilder.new(
-          "Edit",
-          -> (record:, params:) {
-            {
-              controller: params[:controller],
-              action: :edit,
-              id: record,
-              only_path: true
-            }
-          }
-        ),
-        destroy: LinkBuilder.new(
-          "Delete",
-          -> (record:, params:) {
-            {
-              controller: params[:controller],
-              action: :destroy,
-              id: record,
-              only_path: true
-            }
-          },
-          method: :delete,
-          data: { confirm: "Really delete?" }
-        ),
-      }
+      @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 } }
+          .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 } }
+          .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 } }
+          .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 } }
+          .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?" } } }
+          .freeze
+      end
     end
 
     def self.polymorphic_parts(*parts_tail)
@@ -85,15 +53,31 @@ module Super
       parts_head.map { |part| part.is_a?(String) ? part.to_sym : part } + parts_tail
     end
 
+    # The first argument should be the text of the link. If it's an array,
+    # it'll send it directly into `I18n.t`
     def initialize(text, href, **options)
       @text = text
       @href = href
       @options = options
     end
 
-    attr_reader :text
     attr_reader :options
 
+    def text
+      if @text.is_a?(Array)
+        *head, tail = @text
+        if !tail.is_a?(Hash)
+          head.push(tail)
+          tail = {}
+        end
+
+        @text = I18n.t(*head, **tail)
+        return @text
+      end
+
+      @text
+    end
+
     def href
       if @href.is_a?(String)
         return @href

data/lib/super/link_builder.rb

@@ -2,53 +2,34 @@
 
 module Super
   class LinkBuilder
-    def initialize(text, href, **options)
-      @text = text
-      @href = href
-      @options = options
-      @requirements = []
-      @requirements += gather_requirements(text)
-      @requirements += gather_requirements(href)
-      @requirements += gather_requirements(options)
-
-      unknown_arguments = @requirements - known_requirements
-      if unknown_arguments.any?
-        raise Error::ArgumentError, "Unknown arguments: #{unknown_arguments.join(", ")}"
-      end
+    %i[text href options].each do |method_name|
+      class_eval(<<~RUBY, __FILE__, __LINE__ + 1)
+        def #{method_name}(&block)
+          @#{method_name} = block
+          self
+        end
+
+        def process_#{method_name}(&block)
+          @process_#{method_name} = block
+          self
+        end
+      RUBY
     end
 
-    attr_reader :requirements
-
     def resolve(**kwargs)
-      Link.new(
-        into_value(@text, kwargs),
-        into_value(@href, kwargs),
-        **into_value(@options, kwargs),
+      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 }
+
+      Super::Link.new(
+        @process_text.call(@text.call(**kwargs)),
+        @process_href.call(@href.call(**kwargs)),
+        **@process_options.call(@options.call(**kwargs))
       )
     end
-
-    private
-
-    def known_requirements
-      %i[params record].freeze
-    end
-
-    def gather_requirements(value_or_proc)
-      return [] if !value_or_proc.is_a?(Proc)
-
-      requirements =
-        value_or_proc
-          .parameters
-          .select { |(kind, name)| kind = :keyreq }
-          .map(&:last)
-    end
-
-    def into_value(value_or_proc, kwargs)
-      if value_or_proc.kind_of?(Proc)
-        value_or_proc.call(**kwargs)
-      else
-        value_or_proc
-      end
-    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/useful/i19.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Super
+  module Useful
+    module I19
+      module_function
+
+      def build_chain(prefix, optional, suffix)
+        prefix = Array(prefix)
+        optional = Array(optional)
+        suffix = Array(suffix)
+
+        result = []
+
+        (optional.size + 1).times do
+          lookup = [prefix, optional, suffix].flatten.join(".").to_sym
+          result.push(lookup)
+          optional.pop
+        end
+
+        result
+      end
+
+      def chain_to_i18n(chain)
+        head, *tail = chain
+
+        [head, { default: tail }]
+      end
+
+      def i18n_with_fallback(prefix, optional, suffix)
+        chain_to_i18n(build_chain(prefix, optional, suffix))
+      end
+    end
+  end
+end

data/lib/super/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Super
-  VERSION = "0.19.0.rc1"
+  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,11 +2,17 @@
 
 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"
 
 require "super/action_inquirer"
 require "super/assets"
@@ -24,12 +30,17 @@ require "super/filter/guesser"
 require "super/filter/operator"
 require "super/filter/schema_types"
 require "super/form"
-require "super/form/builder"
 require "super/form/field_transcript"
 require "super/form/guesser"
 require "super/form/inline_errors"
 require "super/form/schema_types"
 require "super/form/strong_params"
+require "super/form_builder"
+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"
@@ -39,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"
@@ -49,4 +60,4 @@ require "super/version"
 require "super/view_chain"
 require "super/view_helper"
 
-require "super/engine"
+require "super/railtie"