formalist 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 372c76aa3a3991513336c9b742aa6c5fd3d45b9b
-  data.tar.gz: 44cf4056ec9617c63d2ae9829bbed28013977e2d
+  metadata.gz: 80737e639f603683df1a3527b2a1978591169aa0
+  data.tar.gz: db8cc08289a1b651ee40f763245b5a917a08b6f2
 SHA512:
-  metadata.gz: b72e88f632bb792ac8b6356020215968013cfd1b4370f03f5fd78e527c996b71d143ec6470a67be3a2eb1077d5be49ff67bbd4e822ece0a483c20f203c9c49d6
-  data.tar.gz: 5420b73a92b48894ddd9ff798b11c334bd4d728e9281ca16f17b031e22833e122da5d6cac520d59ee9c542a90d35c96cdd55eba2e58a803cba2c7bd50c419a36
+  metadata.gz: ca4062cdf2586ed0d562ae40e8163542453180fcf35d9310ae72c5eb050ee70a62110d972e25474be9644547dc475b0718d740a477fee965daca92b7e6866726
+  data.tar.gz: 45c7fe326a700e1afe77207438bb9e6b400687516a8229d25a6d981e290e211b493f93ca62ef1a72b8bc20951dd43abcd885c298973f1348f38d8952f11cf39d

data/Gemfile

@@ -3,6 +3,9 @@ source "https://rubygems.org"
 # Gem dependencies are specified in formalist.gemspec
 gemspec
 
+# Lock to a version of dry-v that'll offer the AST/error message structures we expect
+gem "dry-validation", git: "https://github.com/dryrb/dry-validation", ref: "6447302f3b53766b29f29230831890a5cc3822e0"
+
 group :tools do
   gem "pry"
 end

data/Gemfile.lock

@@ -1,11 +1,23 @@
+GIT
+  remote: https://github.com/dryrb/dry-validation
+  revision: 6447302f3b53766b29f29230831890a5cc3822e0
+  ref: 6447302f3b53766b29f29230831890a5cc3822e0
+  specs:
+    dry-validation (0.6.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+      dry-container (~> 0.2, >= 0.2.8)
+      dry-data (~> 0.5, >= 0.5.0)
+      dry-equalizer (~> 0.2)
+      dry-logic (~> 0.1, >= 0.1.4)
+
 PATH
   remote: .
   specs:
-    formalist (0.1.0)
+    formalist (0.2.0)
       dry-configurable
       dry-container
       dry-data (>= 0.4.2)
-      dry-validation
+      dry-validation (~> 0.6.0)
       inflecto
 
 GEM
@@ -18,23 +30,22 @@ GEM
     coderay (1.1.0)
     diff-lcs (1.2.5)
     docile (1.1.5)
-    dry-configurable (0.1.2)
+    dry-configurable (0.1.3)
       thread_safe
-    dry-container (0.2.7)
-      dry-configurable (= 0.1.2)
+    dry-container (0.2.8)
+      dry-configurable (~> 0.1, >= 0.1.3)
       thread_safe
-    dry-data (0.4.2)
+    dry-data (0.5.1)
       dry-configurable (~> 0.1)
       dry-container (~> 0.2)
       dry-equalizer (~> 0.2)
+      dry-logic (~> 0.1)
       inflecto (~> 0.0.0, >= 0.0.2)
       kleisli (~> 0.2)
       thread_safe (~> 0.3)
     dry-equalizer (0.2.0)
-    dry-validation (0.4.1)
-      dry-configurable (~> 0.1)
+    dry-logic (0.1.4)
       dry-container (~> 0.2, >= 0.2.6)
-      dry-data (~> 0.4, >= 0.4.2)
       dry-equalizer (~> 0.2)
     inflecto (0.0.2)
     json (1.8.3)
@@ -84,6 +95,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.10)
   byebug
+  dry-validation!
   formalist!
   pry
   rake (~> 10.4.2)

data/README.md

@@ -6,13 +6,16 @@
 
 ## Installation
 
-Add this line to your application’s `Gemfile`:
+Add these lines to your application’s `Gemfile`:
 
 ```ruby
+gem "dry-validation", git: "https://github.com/dryrb/dry-validation", ref: "6447302f3b53766b29f29230831890a5cc3822e0"
 gem "formalist"
 ```
 
-Run `bundle` to install the gem.
+The dry-validation dependency is a temporary lock to a version that offers the AST/error message structures we expect. You should be able to remove this after future releases of formalist and dry-validation.
+
+Run `bundle` to install the gems.
 
 ## Contributing
 

data/lib/formalist/display_adapters.rb

@@ -1,12 +1,16 @@
 require "dry-container"
 require "formalist/display_adapters/default"
+require "formalist/display_adapters/radio"
 require "formalist/display_adapters/select"
+require "formalist/display_adapters/textarea"
 
 module Formalist
   class DisplayAdapters
     extend Dry::Container::Mixin
 
     register DEFAULT_DISPLAY_ADAPTER, Default.new
+    register "radio", Radio.new
     register "select", Select.new
+    register "textarea", Textarea.new
   end
 end

data/lib/formalist/display_adapters/textarea.rb

@@ -0,0 +1,14 @@
+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

data/lib/formalist/form.rb

@@ -21,24 +21,25 @@ module Formalist
     end
 
     # @api private
-    attr_reader :elements
+    attr_reader :schema
 
     # @api private
-    attr_reader :schema
+    attr_reader :elements
 
-    def initialize(schema: nil)
+    def initialize(schema)
       definition_compiler = DefinitionCompiler.new(self.class.display_adapters)
+
       @elements = definition_compiler.call(self.class.elements)
       @schema = schema
     end
 
-    def call(input = {}, options = {})
-      validate = options.fetch(:validate, true)
-
-      rules = schema ? schema.rules.map(&:to_ary) : []
-      errors = validate && schema ? schema.(input).messages : {}
+    def build(input)
+      Result.new(schema, elements, input)
+    end
 
-      Result.new(elements.map { |el| el.(input, rules, errors) })
+    def receive(form_post)
+      input = schema.(form_post).output
+      build(input)
     end
   end
 end

data/lib/formalist/form/result.rb

@@ -1,14 +1,45 @@
+require "formalist/form/validated_result"
+
 module Formalist
   class Form
     class Result
+      # @api private
+      attr_reader :input
+
+      # @api private
+      attr_reader :schema
+
+      # @api private
       attr_reader :elements
 
-      def initialize(elements)
+      # @api public
+      attr_reader :validation
+
+      def initialize(schema, elements, input)
+        @input = input
+        @schema = schema
         @elements = elements
+        @validation = schema.(input)
+      end
+
+      def output
+        validation.output
+      end
+
+      def success?
+        true
+      end
+
+      def messages
+        {}
+      end
+
+      def to_ast
+        elements.map { |el| el.(output, schema.rules.map(&:to_ary), messages).to_ast }
       end
 
-      def to_ary
-        elements.map(&:to_ary)
+      def validate
+        ValidatedResult.new(self)
       end
     end
   end

data/lib/formalist/form/result/attr.rb

@@ -40,7 +40,7 @@ module Formalist
         # 1. Child form elements
         #
         # @example "metadata" attr
-        #   attr.to_ary # =>
+        #   attr.to_ast # =>
         #   # [:attr, [
         #   #   :metadata,
         #   #   [
@@ -53,7 +53,7 @@ module Formalist
         #   # ]]
         #
         # @return [Array] the attribute as an array.
-        def to_ary
+        def to_ast
           # Errors, if the attr hash is present and its members have errors:
           # {:meta=>[[{:pages=>[["pages is missing"], nil]}], {}]}
 
@@ -66,7 +66,7 @@ module Formalist
             definition.name,
             value_predicates,
             local_errors,
-            children.map(&:to_ary),
+            children.map(&:to_ast),
           ]]
         end
 

data/lib/formalist/form/result/component.rb

@@ -28,7 +28,7 @@ module Formalist
         # 1. Child form elements
         #
         # @example
-        #   component.to_ary # =>
+        #   component.to_ast # =>
         #   # [:component, [
         #   #   [
         #   #     [:some_config_name, :some_config_value]
@@ -39,10 +39,10 @@ module Formalist
         #   # ]]
         #
         # @return [Array] the component as an array.
-        def to_ary
+        def to_ast
           [:component, [
             definition.config.to_a,
-            children.map(&:to_ary),
+            children.map(&:to_ast),
           ]]
         end
       end

data/lib/formalist/form/result/field.rb

@@ -38,7 +38,7 @@ module Formalist
         # 1. Field configuration
         #
         # @example "email" field
-        #   field.to_ary # =>
+        #   field.to_ast # =>
         #   # [:field, [
         #   #   :email,
         #   #   "string",
@@ -57,7 +57,7 @@ module Formalist
         #   # ]]
         #
         # @return [Array] the field as an array.
-        def to_ary
+        def to_ast
           # errors looks like this
           # {:field_name => [["pages is missing", "another error message"], nil]}
 

data/lib/formalist/form/result/group.rb

@@ -28,7 +28,7 @@ module Formalist
         # 1. Child form elements
         #
         # @example
-        #   group.to_ary # =>
+        #   group.to_ast # =>
         #   # [:group, [
         #   #   [
         #   #     [:some_config_name, :some_config_value]
@@ -39,10 +39,10 @@ module Formalist
         #   # ]]
         #
         # @return [Array] the group as an array.
-        def to_ary
+        def to_ast
           [:group, [
             definition.config.to_a,
-            children.map(&:to_ary),
+            children.map(&:to_ast),
           ]]
         end
       end

data/lib/formalist/form/result/many.rb

@@ -46,7 +46,7 @@ module Formalist
         #    none, if there is no or empty input data)
         #
         # @example "locations" collection
-        #   many.to_ary # =>
+        #   many.to_ast # =>
         #   # [:many, [
         #   #   :locations,
         #   #   [[:predicate, [:min_size?, [3]]]],
@@ -73,7 +73,7 @@ module Formalist
         #   # ]]
         #
         # @return [Array] the collection as an array.
-        def to_ary
+        def to_ast
           local_errors = errors.select { |e| e.is_a?(String) }
 
           [:many, [
@@ -81,8 +81,8 @@ module Formalist
             value_predicates,
             local_errors,
             definition.config.to_a,
-            child_template.map(&:to_ary),
-            children.map { |el_list| el_list.map(&:to_ary) },
+            child_template.map(&:to_ast),
+            children.map { |el_list| el_list.map(&:to_ast) },
           ]]
         end
 
@@ -97,24 +97,20 @@ module Formalist
 
         def build_children
           # child errors looks like this:
-          # {:links=>
-          #   [[{:links=>
-          #       [[{:url=>[["url must be filled"], ""]}],
-          #        {:name=>"personal", :url=>""}]}],
-          #    [{:name=>"company", :url=>"http://icelab.com.au"},
-          #     {:name=>"personal", :url=>""}]]}
+          # [
+          #   {:rating=>[["rating must be greater than or equal to 1"], 0]},
+          #   {:summary=>"Great", :rating=>0},
+          #   {:summary=>[["summary must be filled"], ""]},
+          #   {:summary=>"", :rating=>1}
+          # ]
           #
           # or local errors:
           # {:links=>[["links is missing"], nil]}
 
-          child_errors = errors[0].is_a?(Hash) ? errors : {}
+          child_errors = errors.each_slice(2).to_a
 
           input.map { |child_input|
             local_child_errors = child_errors.select { |e|
-              e.is_a?(Hash)
-            }.map { |e|
-              e[definition.name]
-            }.detect { |e|
               e[1] == child_input
             }.to_a.dig(0, 0) || {}
 

data/lib/formalist/form/result/section.rb

@@ -29,7 +29,7 @@ module Formalist
         # 1. Child form elements
         #
         # @example "content" section
-        #   section.to_ary # =>
+        #   section.to_ast # =>
         #   # [:section, [
         #   #   :content,
         #   #   [
@@ -41,11 +41,11 @@ module Formalist
         #   # ]]
         #
         # @return [Array] the section as an array.
-        def to_ary
+        def to_ast
           [:section, [
             definition.name,
             definition.config.to_a,
-            children.map(&:to_ary),
+            children.map(&:to_ast),
           ]]
         end
       end

data/lib/formalist/form/validated_result.rb

@@ -0,0 +1,35 @@
+require "forwardable"
+
+module Formalist
+  class Form
+    class ValidatedResult
+      extend Forwardable
+
+      def_delegators :@result,
+        :input,
+        :schema,
+        :elements,
+        :validation,
+        :output
+
+      # @api private
+      attr_reader :result
+
+      def initialize(result)
+        @result = result
+      end
+
+      def success?
+        validation.success?
+      end
+
+      def messages
+        validation.messages
+      end
+
+      def to_ast
+        elements.map { |el| el.(output, schema.rules.map(&:to_ary), messages).to_ast }
+      end
+    end
+  end
+end

data/lib/formalist/validation/value_rules_compiler.rb

@@ -26,6 +26,10 @@ module Formalist
 
       def visit_val(node)
         name, predicate = node
+
+        # Support names that show as keypaths, e.g. [:reviews, :rating]
+        name = name.last if name.is_a?(Array)
+
         return [] unless name == target_name
 
         # Skip the "val" prefix

data/lib/formalist/version.rb

@@ -1,3 +1,3 @@
 module Formalist
-  VERSION = "0.1.0".freeze
+  VERSION = "0.2.0".freeze
 end

data/spec/examples.txt

@@ -1,8 +1,7 @@
 example_id                                       | status | run_time        |
 ------------------------------------------------ | ------ | --------------- |
-./spec/integration/display_adapters_spec.rb[1:1] | passed | 0.00016 seconds |
-./spec/integration/display_adapters_spec.rb[1:2] | passed | 0.00024 seconds |
-./spec/integration/form_spec.rb[1:1]             | passed | 0.00021 seconds |
-./spec/integration/new_spec.rb[1:1]              | passed | 0.00063 seconds |
-./spec/integration/validation_spec.rb[1:1]       | passed | 0.00435 seconds |
-./spec/unit/output_compiler_spec.rb[1:1]         | passed | 0.00049 seconds |
+./spec/integration/display_adapters_spec.rb[1:1] | passed | 0.00184 seconds |
+./spec/integration/display_adapters_spec.rb[1:2] | passed | 0.00228 seconds |
+./spec/integration/form_spec.rb[1:1]             | passed | 0.00232 seconds |
+./spec/integration/validation_spec.rb[1:1]       | passed | 0.00607 seconds |
+./spec/unit/output_compiler_spec.rb[1:1]         | passed | 0.00276 seconds |

data/spec/integration/display_adapters_spec.rb

@@ -1,12 +1,18 @@
 RSpec.describe "Display adapters" do
+  let(:schema) {
+    Class.new(Dry::Validation::Schema) do
+      key(:temperature_unit)
+    end.new
+  }
+
   subject(:form) {
     Class.new(Formalist::Form) do
       field :temperature_unit, type: "string", display: "select", option_values: [%w[c c], %w[f f]]
-    end.new
+    end.new(schema)
   }
 
   it "outputs an AST" do
-    expect(form.({}).to_ary).to eq [
+    expect(form.build({}).to_ast).to eq [
       [:field, [
         :temperature_unit,
         "string",
@@ -39,9 +45,9 @@ RSpec.describe "Display adapters" do
 
       field :name, type: "string", display: "custom"
       field :email, type: "string"
-    end.new
+    end.new(schema)
 
-    expect(form.({}).to_ary).to eq [
+    expect(form.build({}).to_ast).to eq [
       [:field, [:name, "string", "custom", nil, [], [], []]],
       [:field, [:email, "string", "default", nil, [], [], []]],
     ]

data/spec/integration/form_spec.rb

@@ -1,20 +1,29 @@
 RSpec.describe Formalist::Form do
+  let(:schema) {
+    Class.new(Dry::Validation::Schema) do
+      key(:title, &:str?)
+      key(:rating, &:int?)
+    end.new
+  }
+
   subject(:form) {
     Class.new(Formalist::Form) do
       component do |c|
         c.field :title, type: "string"
         c.field :rating, type: "int"
       end
-    end.new
+    end.new(schema)
   }
 
   it "outputs an AST" do
-    expect(form.(title: "Aurora", rating:  10).to_ary).to eq [
+    ast = form.build(title: "Aurora", rating:  10).to_ast
+
+    expect(form.build(title: "Aurora", rating:  10).to_ast).to eq [
       [:component, [
         [],
         [
-          [:field, [:title, "string", "default", "Aurora", [], [], []]],
-          [:field, [:rating, "int", "default", 10, [], [], []]]
+          [:field, [:title, "string", "default", "Aurora", [[:predicate, [:str?, []]]], [], []]],
+          [:field, [:rating, "int", "default", 10, [[:predicate, [:int?, []]]], [], []]]
         ],
       ]],
     ]

data/spec/integration/validation_spec.rb

@@ -16,9 +16,12 @@ RSpec.describe "Form validation" do
 
       end
 
-      key(:meta) do |meta|
-        meta.key(:pages) { |pages| pages.filled? }
-      end
+      # TODO: uncomment/fix the "meta" related sections (here and below) once
+      # we have a clarification on dryrb/dry-validation#58.
+      #
+      # key(:meta) do |meta|
+      #   meta.key(:pages) { |pages| pages.filled? }
+      # end
     end.new
   }
 
@@ -32,10 +35,10 @@ RSpec.describe "Form validation" do
         review.field :rating, type: "int"
       end
 
-      attr :meta do |meta|
-        meta.field :pages, type: "int"
-      end
-    end.new(schema: schema)
+      # attr :meta do |meta|
+      #   meta.field :pages, type: "int"
+      # end
+    end.new(schema)
   }
 
   it "includes validation rules and errors in the AST" do
@@ -44,7 +47,7 @@ RSpec.describe "Form validation" do
       meta: {pages: nil}
     }
 
-    expect(form.call(input).to_ary).to eq [
+    expect(form.build(input).validate.to_ast).to eq [
       [:field, [:title, "string", "default", nil, [[:predicate, [:filled?, []]]], ["title is missing"], []]],
       [:field, [:rating, "int", "default", nil, [[:and, [[:predicate, [:gteq?, [1]]], [:predicate, [:lteq?, [10]]]]]], ["rating is missing", "rating must be greater than or equal to 1", "rating must be less than or equal to 10"], []]],
       [:many, [:reviews,
@@ -71,13 +74,13 @@ RSpec.describe "Form validation" do
           ]
         ],
       ]],
-      [:attr, [:meta,
-        [],
-        [],
-        [
-          [:field, [:pages, "int", "default", nil, [[:predicate, [:filled?, []]]], ["pages must be filled"], []]]
-        ],
-      ]]
+      # [:attr, [:meta,
+      #   [],
+      #   [],
+      #   [
+      #     [:field, [:pages, "int", "default", nil, [[:predicate, [:filled?, []]]], ["pages must be filled"], []]]
+      #   ],
+      # ]]
     ]
   end
 end

data/spec/unit/output_compiler_spec.rb

@@ -1,6 +1,25 @@
 RSpec.describe Formalist::OutputCompiler do
   subject(:compiler) { Formalist::OutputCompiler.new }
 
+  let(:schema) {
+    Class.new(Dry::Validation::Schema) do
+      key(:title, &:str?)
+      key(:rating, &:int?)
+
+      key(:reviews) do |reviews|
+        reviews.each do |review|
+          review.key(:description, &:str?)
+          review.key(:rating, &:int?)
+        end
+      end
+
+      key(:meta) do |meta|
+        meta.key(:pages, &:int?)
+        meta.key(:publisher, &:str?)
+      end
+    end.new
+  }
+
   let(:form) {
     Class.new(Formalist::Form) do
       field :title, type: "string"
@@ -19,7 +38,7 @@ RSpec.describe Formalist::OutputCompiler do
           end
         end
       end
-    end.new
+    end.new(schema)
   }
 
   let(:input) {
@@ -43,7 +62,7 @@ RSpec.describe Formalist::OutputCompiler do
     }
   }
 
-  let(:ast) { form.call(input).to_ary }
+  let(:ast) { form.build(input).to_ast }
 
   it "works" do
     expect(compiler.call(ast)).to eq input

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: formalist
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tim Riley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-18 00:00:00.000000000 Z
+date: 2016-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable
@@ -56,16 +56,16 @@ dependencies:
   name: dry-validation
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: inflecto
   requirement: !ruby/object:Gem::Requirement
@@ -196,6 +196,7 @@ files:
 - 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/form.rb
 - lib/formalist/form/definition.rb
 - lib/formalist/form/definition/attr.rb
@@ -212,6 +213,7 @@ files:
 - 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
@@ -220,7 +222,6 @@ files:
 - spec/examples.txt
 - spec/integration/display_adapters_spec.rb
 - spec/integration/form_spec.rb
-- spec/integration/new_spec.rb
 - spec/integration/validation_spec.rb
 - spec/spec_helper.rb
 - spec/unit/output_compiler_spec.rb

data/spec/integration/new_spec.rb

@@ -1,27 +0,0 @@
-# require "pp"
-
-# RSpec.describe Formalist::Form do
-#   subject(:form) {
-#     Class.new(Formalist::Form) do
-#       field :title, type: "string"
-#       field :rating, type: "int"
-
-#       section :clever do |clever|
-#         clever.field :more, type: "string"
-#       end
-#     end.new
-#   }
-
-#   it "works" do
-#     # puts
-#     # p form
-#     # p form.class.elements
-#     # p form.class.elements.first
-
-#     # byebug
-
-#     # puts
-
-#     # pp form.elements
-#   end
-# end