formalist 0.6.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 812b680bec83258e220c4ad7e003db7aacc7f333cee556cd93079c22aeebbca6
-  data.tar.gz: fc45315295d88673cb31220b0e2dddd299f5ec2804f6230b9ee99135fcaba1f7
+  metadata.gz: 8cb9ec48a2b65c7e8b44b9ea1db47b9a466e5b664f8c9a1ef799dc998f7ae339
+  data.tar.gz: aa3a86a47295192edb6278e9a19a5e675c01e041fba98f30be87c7ee04aa108a
 SHA512:
-  metadata.gz: dd154e92d8e422108e4c46005a68c3072b41dee80781499da1c3c521e82bc5aeda5471466c30ee1ed021bdab703215bd589c92b042b35936503e1dc740884575
-  data.tar.gz: b8d7a67e86633126f6d5a0620018ea4698742e52d511be24bd9eaaffa85c1bebcdf62d0d0b7cda4cb6b4fdf68d46052d9bd2d29dfd0bdda1531221126128d30e
+  metadata.gz: ea0667c4a32ca779b49b1d1fdce21a717b04e0a630680c267bea3f960b04a13d6223e3bbaabb16ae77291d14975f74fe6c2d51afc34c6d453eb293f1e0b9e791
+  data.tar.gz: 20c9ff5caa796d18312122cc5da852980cc51b9ebffd6eeabc182a161034997241633213478910debed24897bb93513fabf6010a4ea146abb3f4999f03511d11

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+# 0.9.0 / 2022-06-30
+
+### Added
+
+- Added a `#with` method to `EmbeddedFormRenderer` to support additional call time options
+
+# 0.8.0 / 2022-06-29
+
+### Changed
+
+- Update to ruby to version 3
+- Update dry-configurable to version 0.13
+
+# 0.7.0 / 2022-04-07
+
+### Added
+
+- Add support a field with an arbitrary list of forms. Supporting updates in formalist-standard-react@^4.2.0
+- Add namespace and paths options to embedded form renderer
+- Support dry-schema/dry-validation 1.0
+
 # 0.6.0 / 2020-05-06
 
 ### Changed

data/Gemfile

@@ -5,7 +5,7 @@ gemspec
 group :test do
   gem "codeclimate-test-reporter", require: nil
   gem "dry-auto_inject"
-  gem "dry-validation"
+  gem "dry-validation", "~> 1.0"
 end
 
 group :tools do

data/formalist.gemspec

@@ -17,9 +17,9 @@ Gem::Specification.new do |spec|
   spec.executables    = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths  = ['lib']
 
-  spec.required_ruby_version = ">= 2.2.0"
+  spec.required_ruby_version = ">= 3.0.0"
 
-  spec.add_runtime_dependency "dry-configurable", "~> 0.7"
+  spec.add_runtime_dependency "dry-configurable", "~> 0.13"
   spec.add_runtime_dependency "dry-core", "~> 0.4"
   spec.add_runtime_dependency "dry-container", "~> 0.6"
   spec.add_runtime_dependency "inflecto"

data/lib/formalist/child_forms/builder.rb

@@ -0,0 +1,46 @@
+require "json"
+require_relative "child_form"
+
+module Formalist
+  module ChildForms
+    class Builder
+      attr_reader :embedded_forms
+      MissingFormDefinitionError = Class.new(StandardError)
+
+      def initialize(embedded_form_collection)
+        @embedded_forms = embedded_form_collection
+      end
+
+      def call(input)
+        return input if input.nil?
+        input.map { |node| visit(node) }
+      end
+      alias_method :[], :call
+
+      private
+
+      def visit(node)
+        name, data = node.values_at(:name, :data)
+
+        embedded_form = embedded_forms[name]
+        if embedded_form.nil?
+          raise MissingFormDefinitionError, "Form +#{embedded_forms[name]}+ is missing from the embeddable forms collection"
+        end
+        child_form(name, embedded_form).fill(input: data)
+      end
+
+      def child_form(name, embedded_form)
+        ChildForm.build(
+          name: name,
+          attributes: {
+            label: embedded_form.label,
+            form: embedded_form.form,
+            schema: embedded_form.schema,
+            input_processor: embedded_form.input_processor,
+            preview_image_url: embedded_form.preview_image_url
+          }
+        )
+      end
+    end
+  end
+end

data/lib/formalist/child_forms/child_form.rb

@@ -0,0 +1,48 @@
+require "formalist/element"
+
+module Formalist
+  module ChildForms
+    class ChildForm < Element
+      DEFAULT_INPUT_PROCESSOR = -> input { input }.freeze
+
+      attribute :label
+      attribute :form
+      attribute :schema
+      attribute :input_processor, default: DEFAULT_INPUT_PROCESSOR
+      attribute :preview_image_url
+
+      def fill(input: {}, errors: {})
+        super(input: form_input_ast(input), errors: errors.to_a)
+      end
+
+      def attributes
+        super.merge(form: form_attribute_ast)
+      end
+
+      def form_attribute_ast
+        @attributes[:form].to_ast
+      end
+
+      def form_input_ast(data)
+        # Run the raw data through the validation schema
+        validation = @attributes[:schema].(data)
+
+        # And then through the embedded form's input processor (which may add
+        # extra system-generated information necessary for the form to render
+        # fully)
+        input = @attributes[:input_processor].(validation.to_h)
+
+        @attributes[:form].fill(input: input, errors: validation.errors.to_h).to_ast
+      end
+
+      def to_ast
+        [:child_form, [
+          name,
+          type,
+          input,
+          Element::Attributes.new(attributes).to_ast,
+        ]]
+      end
+    end
+  end
+end

data/lib/formalist/child_forms/params_processor.rb

@@ -0,0 +1,30 @@
+require "json"
+require_relative "builder"
+
+module Formalist
+  module ChildForms
+    class ParamsProcessor
+      attr_reader :embedded_forms
+
+      def initialize(embedded_form_collection)
+        @embedded_forms = embedded_form_collection
+      end
+
+      def call(input)
+        return input if input.nil?
+        input.inject([]) { |output, node| output.push(process(node)) }
+      end
+      alias_method :[], :call
+
+      private
+
+      def process(node)
+        name, data = node.values_at(:name, :data)
+
+        validation = embedded_forms[name].schema.(data)
+        node.merge(data: validation.to_h)
+      end
+
+    end
+  end
+end

data/lib/formalist/child_forms/validity_check.rb

@@ -0,0 +1,30 @@
+require "json"
+require_relative "builder"
+
+module Formalist
+  module ChildForms
+    class ValidityCheck
+      attr_reader :embedded_forms
+
+      def initialize(embedded_form_collection)
+        @embedded_forms = embedded_form_collection
+      end
+
+      def call(input)
+        return input if input.nil?
+        input.map { |node| valid?(node) }.all?
+      end
+      alias_method :[], :call
+
+      private
+
+      def valid?(node)
+        name, data = node.values_at(:name, :data)
+
+        validation = embedded_forms[name].schema
+        validation.(data).success?
+      end
+
+    end
+  end
+end

data/lib/formalist/element.rb

@@ -10,12 +10,12 @@ module Formalist
 
     # @api private
     def self.build(**args)
-      new(args)
+      new(**args)
     end
 
     # @api private
     def self.fill(input: {}, errors: {}, **args)
-      new(args).fill(input: input, errors: errors)
+      new(**args).fill(input: input, errors: errors)
     end
 
     # @api private
@@ -43,7 +43,7 @@ module Formalist
         errors: errors,
       }.merge(args)
 
-      self.class.new(args)
+      self.class.new(**args)
     end
 
     def type

data/lib/formalist/elements/form_field.rb

@@ -0,0 +1,25 @@
+require "formalist/child_forms/child_form"
+
+module Formalist
+  class Elements
+    class FormField < ChildForms::ChildForm
+      attribute :hint
+
+      def fill(input: {}, errors: {})
+        input = input[name]
+        errors = errors[name].to_a
+
+        super(input: input, errors: errors)
+      end
+
+      def to_ast
+        [:form_field, [
+          name,
+          type,
+          input,
+          Element::Attributes.new(attributes).to_ast,
+        ]]
+      end
+    end
+  end
+end

data/lib/formalist/elements/many.rb

@@ -5,10 +5,15 @@ module Formalist
     class Many < Element
       attribute :action_label
       attribute :sortable
+      attribute :moveable
       attribute :label
       attribute :max_height
       attribute :placeholder
       attribute :validation
+      attribute :allow_create, default: true
+      attribute :allow_update, default: true
+      attribute :allow_destroy, default: true
+      attribute :allow_reorder, default: true
 
       # @api private
       attr_reader :child_template
@@ -28,7 +33,7 @@ module Formalist
       # @api private
       def fill(input: {}, errors: {})
         input = input.fetch(name) { [] }
-        errors = errors.fetch(name) { {} }
+        errors = errors[name] || {}
 
         # Errors look like this when they are on the array itself: ["size cannot be greater than 2"]
         # Errors look like this when they are on children: {0=>{:summary=>["must be filled"]}
@@ -47,17 +52,6 @@ module Formalist
         )
       end
 
-      # Until we can put defaults on `Types::Bool`, supply them here
-      # @api private
-      def attributes
-        {
-          allow_create: true,
-          allow_update: true,
-          allow_destroy: true,
-          allow_reorder: true,
-        }.merge(super)
-      end
-
       # Converts a collection of "many" repeating elements into an abstract
       # syntax tree.
       #

data/lib/formalist/elements/many_forms.rb

@@ -0,0 +1,115 @@
+require "formalist/element"
+require "formalist/child_forms/builder"
+
+module Formalist
+  class Elements
+    class ManyForms < Element
+      attribute :action_label
+      attribute :sortable
+      attribute :moveable
+      attribute :label
+      attribute :max_height
+      attribute :placeholder
+      attribute :embeddable_forms
+      attribute :validation
+      attribute :allow_create, default: true
+      attribute :allow_update, default: true
+      attribute :allow_destroy, default: true
+      attribute :allow_reorder, default: true
+
+      # FIXME: it would be tidier to have a reader method for each attribute
+      def attributes
+        super.merge(embeddable_forms: embeddable_forms_ast)
+      end
+
+       # @api private
+       def fill(input: {}, errors: {})
+        input = input[name] || []
+        errors = errors[name].to_a
+
+        children = child_form_builder.(input)
+
+        super(
+          input: input,
+          errors: errors,
+          children: children,
+        )
+      end
+
+      # Replace the form objects with their AST
+      def embeddable_forms_ast
+        @attributes[:embeddable_forms].to_h.map { |key, attrs|
+          template_attrs = attrs.slice(:label, :preview_image_url)
+
+          [
+            key,
+            attrs.merge(
+              form: attrs[:form].to_ast,
+              attributes_template: Element::Attributes.new(template_attrs).to_ast
+            )
+          ]
+        }.to_h
+      end
+
+      def child_form_builder
+        ChildForms::Builder.new(@attributes[:embeddable_forms])
+      end
+
+      # Converts a collection of "many" repeating elements into an abstract
+      # syntax tree.
+      #
+      # It takes the following format:
+      #
+      # ```
+      # [:many_forms, [params]]
+      # ```
+      #
+      # With the following parameters:
+      #
+      # 1. Collection name
+      # 2. Custom form element type (or `:many_forms` otherwise)
+      # 3. Collection-level error messages
+      # 4. Form element attributes
+      # 6. Child elements, one for each of the entries in the input data (or
+      #    none, if there is no or empty input data)
+      #
+      # @see Formalist::Element::Attributes#to_ast "Form element attributes" structure
+      #
+      # @example "components" collection
+      #   many_forms.to_ast
+      #   # => [:many_forms, [
+      #     :components,
+      #     :many_forms,
+      #     ["components size cannot be less than 3"],
+      #     [:object, [
+      #       [:allow_create, [:value, [true]]],
+      #       [:allow_update, [:value, [true]]],
+      #       [:allow_destroy, [:value, [true]]],
+      #       [:allow_reorder, [:value, [true]]]
+      #     ]],
+      #     [
+      #       [
+      #        [:child_form,
+      #         [:image_with_captions,
+      #          :child_form,
+      #            [[:field, [:image_id, :text_field, "", ["must be filled"], [:object, []]]], [:field, [:caption, :text_field, "Large panda", [], [:object, []]]]],
+      #           [:object, []]
+      #     ]
+      #   ]]
+      #
+      # @return [Array] the collection as an abstract syntax tree.
+      def to_ast
+        local_errors = errors.is_a?(Array) ? errors : []
+
+        [:many_forms, [
+          name,
+          type,
+          local_errors,
+          Element::Attributes.new(attributes).to_ast,
+          children.map(&:to_ast)
+        ]]
+      end
+
+    end
+  end
+end

data/lib/formalist/elements/standard/check_box.rb

@@ -6,7 +6,7 @@ module Formalist
     class CheckBox < Field
       attribute :question_text
 
-      def initialize(*)
+      def initialize(**)
         super
 
         # Ensure value is a boolean (also: default to false for nil values)

data/lib/formalist/elements.rb

@@ -4,6 +4,8 @@ require "formalist/elements/compound_field"
 require "formalist/elements/field"
 require "formalist/elements/group"
 require "formalist/elements/many"
+require "formalist/elements/many_forms"
+require "formalist/elements/form_field"
 require "formalist/elements/section"
 
 module Formalist
@@ -15,6 +17,8 @@ module Formalist
     register :field, Field
     register :group, Group
     register :many, Many
+    register :many_forms, ManyForms
+    register :form_field, FormField
     register :section, Section
   end
 end

data/lib/formalist/form/validity_check.rb

@@ -41,11 +41,20 @@ module Formalist
       def visit_many(node)
         _name, _type, errors, _attributes, _child_template, children = node
 
-        # The `children`` parameter for `many` elements is for some reason
-        # doubly nested right now, so we need to flatten it.
+        # The `children parameter for `many` elements is nested since there are
+        # many groups of elements, we need to flatten to traverse them all
         errors.empty? && children.flatten(1).map { |child| visit(child) }.all?
       end
 
+      # TODO work out what to do with this.
+      # I think it's only relevant to many_forms
+      # nested in rich text ast
+      def visit_many_forms(node)
+        _name, _type, errors, _attributes, children = node
+
+        errors.empty? && children.map { |child| visit(child[:form]) }.all?
+      end
+
       def visit_section(node)
         _name, _type, _attributes, children = node
 

data/lib/formalist/form.rb

@@ -8,7 +8,7 @@ module Formalist
     extend Dry::Configurable
     include Dry::Core::Constants
 
-    setting :elements_container, Elements
+    setting :elements_container, default: Elements
 
     class << self
       attr_reader :definition

data/lib/formalist/rich_text/embedded_form_compiler.rb

@@ -79,7 +79,7 @@ module Formalist
         # fully)
         input = embedded_form.input_processor.(validation.to_h)
 
-        embedded_form.form.fill(input: input, errors: validation.messages).to_ast
+        embedded_form.form.fill(input: input, errors: validation.errors.to_h).to_ast
       end
     end
   end

data/lib/formalist/rich_text/embedded_forms_container/mixin.rb

@@ -25,7 +25,7 @@ module Formalist
           end
 
           def register(key, **attrs)
-            super(key.to_s, Registration.new(attrs))
+            super(key.to_s, Registration.new(**attrs))
           end
 
           def to_h

data/lib/formalist/rich_text/embedded_forms_container/registration.rb

@@ -8,12 +8,14 @@ module Formalist
         attr_reader :form
         attr_reader :schema
         attr_reader :input_processor
+        attr_reader :preview_image_url
 
-        def initialize(label:, form:, schema:, input_processor: DEFAULT_INPUT_PROCESSOR)
+        def initialize(label:, form:, schema:, preview_image_url: nil, input_processor: DEFAULT_INPUT_PROCESSOR)
           @label = label
           @form = form
           @schema = schema
           @input_processor = input_processor
+          @preview_image_url = preview_image_url
         end
 
         def to_h
@@ -22,6 +24,7 @@ module Formalist
             form: form,
             schema: schema,
             input_processor: input_processor,
+            preview_image_url: preview_image_url
           }
         end
       end

data/lib/formalist/rich_text/rendering/embedded_form_renderer.rb

@@ -3,22 +3,50 @@ module Formalist
     module Rendering
       class EmbeddedFormRenderer
         attr_reader :container
+        attr_reader :namespace
+        attr_reader :paths
         attr_reader :options
 
-        def initialize(container = {}, **options)
+        def initialize(container = {}, namespace: nil, paths: [], **options)
           @container = container
+          @namespace = namespace
+          @paths = paths
           @options = options
         end
 
         def call(form_data)
           type, data = form_data.values_at(:name, :data)
 
-          if container.key?(type)
-            container[type].(data, options)
+          key = resolve_key(type)
+
+          if key
+            container[key].(data, **options)
           else
             ""
           end
         end
+
+        def with(**context_options)
+          self.class.new(
+            container,
+            namespace: namespace,
+            paths: paths,
+            **options.merge(context_options)
+          )
+        end
+
+        private
+
+        def resolve_key(type)
+          paths.each do |path|
+            path_key = path.tr("/", ".")
+            key = [namespace, path_key, type].compact.join(".")
+            return key if container.key?(key)
+          end
+
+          key = [namespace, type].compact.join(".")
+          return key if container.key?(key)
+        end
       end
     end
   end

data/lib/formalist/version.rb

@@ -1,3 +1,3 @@
 module Formalist
-  VERSION = "0.6.0".freeze
+  VERSION = "0.9.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: formalist
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Tim Riley
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-05-06 00:00:00.000000000 Z
+date: 2022-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: dry-core
   requirement: !ruby/object:Gem::Requirement
@@ -136,7 +136,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - tim@icelab.com.au
 executables: []
@@ -155,6 +155,10 @@ files:
 - bin/console
 - formalist.gemspec
 - lib/formalist.rb
+- lib/formalist/child_forms/builder.rb
+- lib/formalist/child_forms/child_form.rb
+- lib/formalist/child_forms/params_processor.rb
+- lib/formalist/child_forms/validity_check.rb
 - lib/formalist/definition.rb
 - lib/formalist/element.rb
 - lib/formalist/element/attributes.rb
@@ -163,8 +167,10 @@ files:
 - lib/formalist/elements/attr.rb
 - lib/formalist/elements/compound_field.rb
 - lib/formalist/elements/field.rb
+- lib/formalist/elements/form_field.rb
 - lib/formalist/elements/group.rb
 - lib/formalist/elements/many.rb
+- lib/formalist/elements/many_forms.rb
 - lib/formalist/elements/section.rb
 - lib/formalist/elements/standard.rb
 - lib/formalist/elements/standard/check_box.rb
@@ -199,7 +205,7 @@ homepage: https://github.com/icelab/formalist
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -207,15 +213,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: Flexible form builder
 test_files: []