formalist 0.2.2 → 0.2.3

data/lib/formalist/form.rb

@@ -1,52 +1,32 @@
-require "json"
 require "dry-configurable"
-require "dry-validation"
-require "dry/validation/schema/form"
-require "formalist/definition_compiler"
-require "formalist/output_compiler"
-require "formalist/display_adapters"
-require "formalist/form/definition"
+require "formalist/elements"
+require "formalist/form/definition_context"
+require "formalist/element/permitted_children"
 require "formalist/form/result"
 
 module Formalist
   class Form
     extend Dry::Configurable
-    extend Definition
 
-    setting :display_adapters, DisplayAdapters
-
-    def self.display_adapters
-      config.display_adapters
-    end
+    setting :elements_container, Elements
 
     # @api private
     def self.elements
-      @__elements__ ||= []
-    end
-
-    # @api private
-    attr_reader :schema
-
-    # @api private
-    attr_reader :elements
-
-    def initialize(schema)
-      definition_compiler = DefinitionCompiler.new(self.class.display_adapters)
-
-      @elements = definition_compiler.call(self.class.elements)
-      @schema = schema
+      @elements ||= []
     end
 
-    def build(input = {})
-      Result.new(schema, elements, input)
+    # @api public
+    def self.define(&block)
+      @elements = DefinitionContext.new(
+        container: config.elements_container,
+        permissions: Element::PermittedChildren.all
+      ).call(&block).elements
     end
 
-    def receive(form_post)
-      form_data = Formalist::OutputCompiler.new.call(JSON.parse(form_post))
-      form_schema = Dry::Validation::Schema::Form.new(schema.class.rules)
-
-      input = form_schema.(form_data).output
-      build(input)
+    # @api public
+    def build(input = {}, messages = {})
+      elements = self.class.elements.map { |el| el.resolve(self) }
+      Result.new(input, messages, elements)
     end
   end
 end

data/lib/formalist/types.rb

@@ -0,0 +1,30 @@
+require "dry-types"
+require "dry-logic"
+
+Dry::Types::Predicates.predicate :respond_to? do |method_name, value|
+  value.respond_to?(method_name)
+end
+
+module Formalist
+  module Types
+    include Dry::Types.module
+
+    ElementName = Types::Strict::Symbol.constrained(min_size: 1)
+    OptionsList = Types::Array.member(Formalist::Types::Array.member(Formalist::Types::Strict::String).constrained(size: 2)).constrained(min_size: 1)
+
+    # The SelectionField and MultiSelectionField require a _somewhat_ specific
+    # data structure:
+    #
+    #     {id: 123, label: 'foo'}
+    #
+    # It’s expected that `id` is the relational representation of the object.
+    # And label could/should be optional if the form defines a custom
+    # `render_as` attribute
+    SelectionsList = Formalist::Types::Strict::Array.member(Formalist::Types::Strict::Hash)
+
+    Validation = Types::Strict::Hash
+
+    Dependency = Dry::Types::Definition[Object].new(Object)
+    Function = Dependency.constrained(respond_to: :call)
+  end
+end

data/lib/formalist/version.rb

@@ -1,3 +1,3 @@
 module Formalist
-  VERSION = "0.2.2".freeze
+  VERSION = "0.2.3".freeze
 end

data/lib/formalist.rb

@@ -1,21 +1 @@
-module Formalist
-  DEFAULT_DISPLAY_ADAPTER = "default".freeze
-end
-
-# Temporarily monkey-patch over a dry-validation bug (intput type compiler for
-# form schemas not being passed the right set of rules).
-require "dry-validation"
-require "dry/validation/schema/form"
-module Dry
-  module Validation
-    class Schema::Form < Schema
-      def initialize(rules = [])
-        super
-        # @input_type = InputTypeCompiler.new.(self.class.rules.map(&:to_ast))
-        @input_type = InputTypeCompiler.new.(self.class.rule_ast + rules.map(&:to_ast))
-      end
-    end
-  end
-end
-
 require "formalist/form"

data/spec/examples.txt

@@ -1,7 +1,8 @@
-example_id                                       | status | run_time        |
------------------------------------------------- | ------ | --------------- |
-./spec/integration/display_adapters_spec.rb[1:1] | passed | 0.00188 seconds |
-./spec/integration/display_adapters_spec.rb[1:2] | passed | 0.00209 seconds |
-./spec/integration/form_spec.rb[1:1]             | passed | 0.00379 seconds |
-./spec/integration/validation_spec.rb[1:1]       | passed | 0.00545 seconds |
-./spec/unit/output_compiler_spec.rb[1:1]         | passed | 0.00317 seconds |
+example_id                                               | status | run_time        |
+-------------------------------------------------------- | ------ | --------------- |
+./spec/integration/dependency_injection_spec.rb[1:1]     | passed | 0.00111 seconds |
+./spec/integration/form_spec.rb[1:1]                     | passed | 0.01078 seconds |
+./spec/unit/elements/standard/check_box_spec.rb[1:1:1:1] | passed | 0.00026 seconds |
+./spec/unit/elements/standard/check_box_spec.rb[1:1:2:1] | passed | 0.00023 seconds |
+./spec/unit/elements/standard/check_box_spec.rb[1:1:3:1] | passed | 0.00019 seconds |
+./spec/unit/elements/standard/check_box_spec.rb[1:1:4:1] | passed | 0.00107 seconds |

data/spec/integration/dependency_injection_spec.rb

@@ -0,0 +1,54 @@
+require "dry-auto_inject"
+require "formalist/elements/standard"
+
+RSpec.describe "Dependency injection" do
+  let(:schema) {
+    Dry::Validation.Schema do
+      key(:status).required
+    end
+  }
+
+  subject(:form) {
+    Class.new(Formalist::Form) do
+      include Test::HashImport["fetch_options"]
+
+      define do
+        select_box :status, options: dep(:status_options)
+      end
+
+      def status_options
+        fetch_options.map { |option| [option, option.capitalize] }
+      end
+    end.new
+  }
+
+  before do
+    Test::Container = Class.new do
+      extend Dry::Container::Mixin
+    end
+
+    Test::Container.register :fetch_options, -> { %w[draft published] }
+
+    auto_inject = Dry::AutoInject(Test::Container)
+    Test::HashImport = -> *keys do
+      auto_inject.hash[*keys]
+    end
+  end
+
+  it "supports dependency injection via the initializer's options hash" do
+    expect(form.build.to_ast).to eql [
+      [:field, [
+        :status,
+        :select_box,
+        nil,
+        [],
+        [:object, [
+          [:options, [:array, [
+            [:array, [[:value, ["draft"]], [:value, ["Draft"]]]],
+            [:array, [[:value, ["published"]], [:value, ["Published"]]]]
+          ]]]
+        ]]
+      ]]
+    ]
+  end
+end

data/spec/integration/form_spec.rb

@@ -1,31 +1,104 @@
 RSpec.describe Formalist::Form do
   let(:schema) {
-    Class.new(Dry::Validation::Schema) do
-      key(:title, &:str?)
-      key(:rating, &:int?)
-    end.new
+    Dry::Validation.Schema do
+      key(:title).required
+      key(:rating).required(:int?)
+
+      key(:reviews).each do
+        key(:summary).required
+        key(:rating).required(:int?, gteq?: 1, lteq?: 10)
+      end
+
+      key(:meta).schema do
+        key(:pages).required(:int?, gteq?: 1)
+      end
+    end
   }
 
   subject(:form) {
     Class.new(Formalist::Form) do
-      component do |c|
-        c.field :title, type: "string"
-        c.field :rating, type: "int"
+      define do
+        compound_field do
+          field :title, validate: {filled: true}
+          field :rating, validate: {filled: true}
+        end
+
+        many :reviews do
+          field :summary, validate: {filled: true}
+          field :rating, validate: {filled: true}
+        end
+
+        attr :meta do
+          field :pages, validate: {filled: true}
+        end
       end
-    end.new(schema)
+    end.new
   }
 
   it "outputs an AST" do
-    ast = form.build(title: "Aurora", rating:  10).to_ast
+    input = {
+      title: "Aurora",
+      rating: "10",
+      reviews: [
+        {
+          summary: "",
+          rating: 10
+        },
+        {
+          summary: "Great!",
+          rating: 0
+        }
+      ],
+      meta: {
+        pages: 0
+      }
+    }
+
+    result = schema.(input)
 
-    expect(form.build(title: "Aurora", rating:  10).to_ast).to eq [
-      [:component, [
+    expect(form.build(result.output, result.messages).to_ast).to eq [
+      [:compound_field, [
+        :compound_field,
+        [:object, []],
+        [
+          [:field, [:title, :field, "Aurora", [], [:object, []]]],
+          [:field, [:rating, :field, "10", ["must be an integer"], [:object, []]]]
+        ]
+      ]],
+      [:many, [
+        :reviews,
+        :many,
         [],
+        [:object, [
+          [:allow_create, [:value, [true]]],
+          [:allow_update, [:value, [true]]],
+          [:allow_destroy, [:value, [true]]],
+          [:allow_reorder, [:value, [true]]]
+        ]],
         [
-          [:field, [:title, "string", "default", "Aurora", [[:predicate, [:str?, []]]], [], []]],
-          [:field, [:rating, "int", "default", 10, [[:predicate, [:int?, []]]], [], []]]
+          [:field, [:summary, :field, nil, [], [:object, []]]],
+          [:field, [:rating, :field, nil, [], [:object, []]]]
         ],
+        [
+          [
+            [:field, [:summary, :field, "", ["must be filled"], [:object, []]]],
+            [:field, [:rating, :field, 10, [], [:object, []]]]
+          ],
+          [
+            [:field, [:summary, :field, "Great!", [], [:object, []]]],
+            [:field, [:rating, :field, 0, ["must be greater than or equal to 1"], [:object, []]]]
+          ]
+        ]
       ]],
+      [:attr, [
+        :meta,
+        :attr,
+        [],
+        [:object, []],
+        [
+          [:field, [:pages, :field, 0, ["must be greater than or equal to 1"], [:object, []]]]
+        ]
+      ]]
     ]
   end
 end

data/spec/spec_helper.rb

@@ -1,12 +1,19 @@
-require "simplecov"
-# SimpleCov.minimum_coverage 100
-SimpleCov.start do
-  add_filter "/spec/"
+if RUBY_ENGINE == "ruby"
+  require "codeclimate-test-reporter"
+  CodeClimate::TestReporter.start
+
+  require "simplecov"
+  SimpleCov.start do
+    add_filter "/spec/"
+  end
 end
 
-require "byebug"
+begin
+  require "byebug"
+rescue LoadError; end
 
 require "formalist"
+require "dry-validation"
 
 # Requires supporting ruby files with custom matchers and macros, etc, in
 # spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are

data/spec/support/constants.rb

@@ -0,0 +1,11 @@
+module Test
+  def self.remove_constants
+    constants.each(&method(:remove_const))
+  end
+end
+
+RSpec.configure do |config|
+  config.after do
+    Test.remove_constants
+  end
+end

data/spec/unit/elements/standard/check_box_spec.rb

@@ -0,0 +1,33 @@
+require "spec_helper"
+require "formalist/elements/standard/check_box"
+
+RSpec.describe Formalist::Elements::CheckBox do
+  subject(:check_box) {
+    Formalist::Elements::CheckBox.new(:published, attributes, [], {published: input}, errors)
+  }
+
+  let(:attributes) { {} }
+  let(:input) { nil }
+  let(:errors) { {} }
+
+  describe "input" do
+    context "is nil" do
+      specify { expect(check_box.input).to eql false }
+    end
+
+    context "is false" do
+      let(:input) { false }
+      specify { expect(check_box.input).to eql false }
+    end
+
+    context "is true" do
+      let(:input) { true }
+      specify { expect(check_box.input).to eql true }
+    end
+
+    context "is any other value" do
+      let(:input) { "something" }
+      specify { expect(check_box.input).to eql true }
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: formalist
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Tim Riley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-23 00:00:00.000000000 Z
+date: 2016-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable
@@ -39,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: dry-validation
+  name: dry-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: inflecto
   requirement: !ruby/object:Gem::Requirement
@@ -80,20 +80,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -122,20 +108,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.3.0
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.34.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.34.2
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -177,40 +149,41 @@ files:
 - README.md
 - Rakefile
 - lib/formalist.rb
-- lib/formalist/definition_compiler.rb
-- lib/formalist/display_adapters.rb
-- lib/formalist/display_adapters/default.rb
-- lib/formalist/display_adapters/radio.rb
-- lib/formalist/display_adapters/select.rb
-- lib/formalist/display_adapters/textarea.rb
+- lib/formalist/element.rb
+- lib/formalist/element/attributes.rb
+- lib/formalist/element/class_interface.rb
+- lib/formalist/element/definition.rb
+- lib/formalist/element/permitted_children.rb
+- lib/formalist/elements.rb
+- lib/formalist/elements/attr.rb
+- lib/formalist/elements/compound_field.rb
+- lib/formalist/elements/field.rb
+- lib/formalist/elements/group.rb
+- lib/formalist/elements/many.rb
+- lib/formalist/elements/section.rb
+- lib/formalist/elements/standard.rb
+- lib/formalist/elements/standard/check_box.rb
+- lib/formalist/elements/standard/date_field.rb
+- lib/formalist/elements/standard/date_time_field.rb
+- lib/formalist/elements/standard/hidden_field.rb
+- lib/formalist/elements/standard/multi_selection_field.rb
+- lib/formalist/elements/standard/number_field.rb
+- lib/formalist/elements/standard/radio_buttons.rb
+- lib/formalist/elements/standard/select_box.rb
+- lib/formalist/elements/standard/selection_field.rb
+- lib/formalist/elements/standard/text_area.rb
+- lib/formalist/elements/standard/text_field.rb
 - lib/formalist/form.rb
-- lib/formalist/form/definition.rb
-- lib/formalist/form/definition/attr.rb
-- lib/formalist/form/definition/component.rb
-- lib/formalist/form/definition/field.rb
-- lib/formalist/form/definition/group.rb
-- lib/formalist/form/definition/many.rb
-- lib/formalist/form/definition/section.rb
 - lib/formalist/form/definition_context.rb
 - lib/formalist/form/result.rb
-- lib/formalist/form/result/attr.rb
-- lib/formalist/form/result/component.rb
-- lib/formalist/form/result/field.rb
-- lib/formalist/form/result/group.rb
-- lib/formalist/form/result/many.rb
-- lib/formalist/form/result/section.rb
-- lib/formalist/form/validated_result.rb
-- lib/formalist/output_compiler.rb
-- lib/formalist/validation/collection_rules_compiler.rb
-- lib/formalist/validation/predicate_list_compiler.rb
-- lib/formalist/validation/value_rules_compiler.rb
+- lib/formalist/types.rb
 - lib/formalist/version.rb
 - spec/examples.txt
-- spec/integration/display_adapters_spec.rb
+- spec/integration/dependency_injection_spec.rb
 - spec/integration/form_spec.rb
-- spec/integration/validation_spec.rb
 - spec/spec_helper.rb
-- spec/unit/output_compiler_spec.rb
+- spec/support/constants.rb
+- spec/unit/elements/standard/check_box_spec.rb
 homepage: https://github.com/icelab/formalist
 licenses:
 - MIT
@@ -223,7 +196,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/formalist/definition_compiler.rb

@@ -1,61 +0,0 @@
-require "formalist/form/definition/attr"
-require "formalist/form/definition/component"
-require "formalist/form/definition/field"
-require "formalist/form/definition/group"
-require "formalist/form/definition/many"
-require "formalist/form/definition/section"
-
-module Formalist
-  class DefinitionCompiler
-    attr_reader :display_adapters
-
-    def initialize(display_adapters)
-      @display_adapters = display_adapters
-    end
-
-    def call(ast)
-      ast.map { |node| visit(node) }
-    end
-
-    private
-
-    def visit(node)
-      name, attrs = node
-      send(:"visit_#{name}", attrs)
-    end
-
-    def visit_attr(attrs)
-      name, children = attrs
-      Form::Definition::Attr.new(name, call(children))
-    end
-
-    def visit_component(attrs)
-      display, config, children = attrs
-
-      component = Form::Definition::Component.new(config, call(children))
-      display_adapters[display].call(component)
-    end
-
-    def visit_field(attrs)
-      name, type, display, config = attrs
-
-      field = Form::Definition::Field.new(name, type, display, config)
-      display_adapters[display].call(field)
-    end
-
-    def visit_group(attrs)
-      config, children = attrs
-      Form::Definition::Group.new(config, call(children))
-    end
-
-    def visit_many(attrs)
-      name, config, children = attrs
-      Form::Definition::Many.new(name, config, call(children))
-    end
-
-    def visit_section(attrs)
-      name, config, children = attrs
-      Form::Definition::Section.new(name, config, call(children))
-    end
-  end
-end

data/lib/formalist/display_adapters/default.rb

@@ -1,9 +0,0 @@
-module Formalist
-  class DisplayAdapters
-    class Default
-      def call(field)
-        field
-      end
-    end
-  end
-end

data/lib/formalist/display_adapters/radio.rb

@@ -1,19 +0,0 @@
-module Formalist
-  class DisplayAdapters
-    class Radio
-      PERMITTED_TYPES = %w[
-        decimal
-        float
-        int
-        string
-      ].freeze
-
-      def call(field)
-        raise ArgumentError, "field type must be one of #{PERMITTED_TYPES.join(', ')}" unless PERMITTED_TYPES.include?(field.type)
-        raise ArgumentError, "field must have +option_values+ config" unless field.config.keys.include?(:option_values)
-
-        field.to_display_variant("radio")
-      end
-    end
-  end
-end

data/lib/formalist/display_adapters/select.rb

@@ -1,19 +0,0 @@
-module Formalist
-  class DisplayAdapters
-    class Select
-      PERMITTED_TYPES = %w[
-        decimal
-        float
-        int
-        string
-      ].freeze
-
-      def call(field)
-        raise ArgumentError, "field type must be one of #{PERMITTED_TYPES.join(', ')}" unless PERMITTED_TYPES.include?(field.type)
-        raise ArgumentError, "field must have +option_values+ config" unless field.config.keys.include?(:option_values)
-
-        field.to_display_variant("select")
-      end
-    end
-  end
-end

data/lib/formalist/display_adapters/textarea.rb

@@ -1,14 +0,0 @@
-module Formalist
-  class DisplayAdapters
-    class Textarea
-      PERMITTED_TYPES = %w[
-        string
-      ].freeze
-
-      def call(field)
-        raise ArgumentError, "field type must be one of #{PERMITTED_TYPES.join(', ')}" unless PERMITTED_TYPES.include?(field.type)
-        field.to_display_variant("textarea")
-      end
-    end
-  end
-end