dry-types 0.10.3 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 39a0be1972bae04a7b9f3f45e5b4430948c825a1
-  data.tar.gz: b74e55614628bc6a556ebef86a8bfa6abfc12e85
+  metadata.gz: 12cffdbb9c18b6f1ab0bb726c5a13fbd13c1178e
+  data.tar.gz: 150931c98379624c229416370bd63cd8830bbab5
 SHA512:
-  metadata.gz: f2a0a595e1feb9a642269b6fdaaaf42be81f09a6cb31be3f30ed63a4ac85a1cf816fa1ba9e147b487cceff6436f52161fa032321c7828ed2c657d12a8fa13a72
-  data.tar.gz: 1e5d6ad66e3fef84f7d31a0d430b2bb7b20c0225d5ad527e5cdf90a6f4dbcb12b8837705173372732034416aa76f6f915df044ef64305ad0d557675d8b1beca9
+  metadata.gz: 7b6bd371faf9ae94c6559c01309216205c3df88614c86cb2862929b2836d8cc4c32b76d916f6deeb6e4390bb296c8e1733e85e8997b3f00092584960961e02ee
+  data.tar.gz: 584c9552a9185595008a63c2ca6f3a8cc88ec56b7c063f720d36ff10d9c1b26b403443456416a484429cae4b7e10bd6a06995acd3adf99eb89b1026825a9fd83

data/.travis.yml

@@ -9,17 +9,13 @@ script:
   - bundle exec rake
 rvm:
   - 2.2.7
-  - 2.3.3
+  - 2.3.4
   - 2.4.1
-  - jruby-9.1.8.0
-  - rbx-3
+  - jruby-9.1.10.0
 env:
   global:
     - COVERAGE=true
     - JRUBY_OPTS='--dev -J-Xmx1024M'
-matrix:
-  allow_failures:
-    - rvm: rbx-3
 notifications:
   email: false
   webhooks:

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# v0.11.0 2017-06-30
+
+## Added
+
+* `#to_ast` available for all type objects (GustavoCaso)
+* `Types::Array#of` as an alias for `#member` (maliqq)
+* Detailed failure objects are passed to results which improves constraint violation messages (GustavoCaso)
+
+[Compare v0.10.3...v0.11.0](https://github.com/dry-rb/dry-types/compare/v0.10.3...v0.11.0)
+
 # v0.10.3 2017-05-06
 
 ## Added

data/CONTRIBUTING.md

@@ -0,0 +1,29 @@
+# Issue Guidelines
+
+## Reporting bugs
+
+If you found a bug, report an issue and describe what's the expected behavior versus what actually happens. If the bug causes a crash, attach a full backtrace. If possible, a reproduction script showing the problem is highly appreciated.
+
+## Reporting feature requests
+
+Report a feature request **only after discussing it first on [discuss.dry-rb.org](https://discuss.dry-rb.org)** where it was accepted. Please provide a concise description of the feature, don't link to a discussion thread, and instead summarize what was discussed.
+
+## Reporting questions, support requests, ideas, concerns etc.
+
+**PLEASE DON'T** - use [discuss.dry-rb.org](http://discuss.dry-rb.org) instead.
+
+# Pull Request Guidelines
+
+A Pull Request will only be accepted if it addresses a specific issue that was reported previously, or fixes typos, mistakes in documentation etc.
+
+Other requirements:
+
+1) Do not open a pull request if you can't provide tests along with it. If you have problems writing tests, ask for help in the related issue.
+2) Follow the style conventions of the surrounding code. In most cases, this is standard ruby style.
+3) Add API documentation if it's a new feature
+4) Update API documentation if it changes an existing feature
+5) Bonus points for sending a PR to [github.com/dry-rb/dry-rb.org](github.com/dry-rb/dry-rb.org) which updates user documentation and guides
+
+# Asking for help
+
+If these guidelines aren't helpful, and you're stuck, please post a message on [discuss.dry-rb.org](https://discuss.dry-rb.org).

data/README.md

@@ -20,7 +20,7 @@
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake run_specs` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 

data/dry-types.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-  spec.required_ruby_version = ">= 2.1.0"
+  spec.required_ruby_version = ">= 2.2.0"
 
   spec.add_runtime_dependency 'concurrent-ruby', '~> 1.0'
   spec.add_runtime_dependency 'dry-core', '~> 0.2', '>= 0.2.1'

data/lib/dry/types.rb

@@ -15,6 +15,7 @@ require 'dry/types/container'
 require 'dry/types/type'
 require 'dry/types/definition'
 require 'dry/types/constructor'
+require 'dry/types/fn_container'
 
 require 'dry/types/errors'
 
@@ -51,6 +52,11 @@ module Dry
       @container ||= Container.new
     end
 
+    # @api private
+    def self.registered?(class_or_identifier)
+      container.key?(identifier(class_or_identifier))
+    end
+
     # @param [String] name
     # @param [Type] type
     # @param [#call,nil] block

data/lib/dry/types/array.rb

@@ -14,6 +14,8 @@ module Dry
 
         Array::Member.new(primitive, options.merge(member: member))
       end
+
+      alias_method :of, :member
     end
   end
 end

data/lib/dry/types/array/member.rb

@@ -48,6 +48,13 @@ module Dry
             block ? yield(failure) : failure
           end
         end
+
+        # @api public
+        #
+        # @see Definition#to_ast
+        def to_ast(meta: true)
+          [:array, [member.to_ast(meta: meta), meta ? self.meta : EMPTY_HASH]]
+        end
       end
     end
   end

data/lib/dry/types/compiler.rb

@@ -11,73 +11,76 @@ module Dry
         visit(ast)
       end
 
-      def visit(node, *args)
-        send(:"visit_#{node[0]}", node[1], *args)
+      def visit(node)
+        type, body = node
+        send(:"visit_#{ type }", body)
       end
 
       def visit_constructor(node)
-        primitive, fn = node
+        definition, fn_register_name, meta = node
+        fn = Dry::Types::FnContainer[fn_register_name]
+        primitive = visit(definition)
         Types::Constructor.new(primitive, &fn)
       end
 
-      def visit_type(node)
-        type, args = node
-        meth = :"visit_#{type.tr('.', '_')}"
+      def visit_safe(node)
+        ast, meta = node
+        Types::Safe.new(visit(ast), meta: meta)
+      end
+
+      def visit_definition(node)
+        type, meta = node
 
-        if respond_to?(meth) && args
-          send(meth, args)
+        if registry.registered?(type)
+          registry[type].meta(meta)
         else
-          registry[type]
+          Definition.new(type, meta: meta)
         end
       end
 
       def visit_sum(node)
-        node.map { |type| visit(type) }.reduce(:|)
+        *types, meta = node
+        types.map { |type| visit(type) }.reduce(:|).meta(meta)
       end
 
       def visit_array(node)
-        registry['array'].member(call(node))
+        member, meta = node
+        registry['array'].member(visit(member)).meta(meta)
       end
 
-      def visit_form_array(node)
-        registry['form.array'].member(call(node))
+      def visit_hash(node)
+        constructor, schema, meta = node
+        merge_with('hash', constructor, schema).meta(meta)
       end
 
-      def visit_json_array(node)
-        registry['json.array'].member(call(node))
+      def visit_json_hash(node)
+        schema, meta = node
+        merge_with('json.hash', :symbolized, schema).meta(meta)
       end
 
-      def visit_hash(node)
-        constructor, schema = node
-        merge_with('hash', constructor, schema)
+      def visit_json_array(node)
+        member, meta = node
+        registry['json.array'].member(visit(member)).meta(meta)
       end
 
       def visit_form_hash(node)
-        if node
-          constructor, schema = node
-          merge_with('form.hash', constructor, schema)
-        else
-          registry['form.hash']
-        end
+        schema, meta = node
+        merge_with('form.hash', :symbolized, schema).meta(meta)
       end
 
-      def visit_json_hash(node)
-        if node
-          constructor, schema = node
-          merge_with('json.hash', constructor, schema)
-        else
-          registry['json.hash']
-        end
+      def visit_form_array(node)
+        member, meta = node
+        registry['form.array'].member(visit(member)).meta(meta)
       end
 
-      def visit_key(node)
-        name, types = node
-        { name => visit(types) }
+      def visit_member(node)
+        name, type = node
+        { name => visit(type) }
       end
 
       def merge_with(hash_id, constructor, schema)
         registry[hash_id].__send__(
-          constructor, schema.map { |key| visit(key) }.reduce({}, :merge)
+          constructor, schema.map { |key| visit(key) }.reduce({}, :update)
         )
       end
     end

data/lib/dry/types/constrained.rb

@@ -73,6 +73,15 @@ module Dry
         valid?(value)
       end
 
+      # @api public
+      #
+      # @see Definition#to_ast
+      def to_ast(meta: true)
+        [:constrained, [type.to_ast(meta: meta),
+                        rule.to_ast,
+                        meta ? self.meta : EMPTY_HASH]]
+      end
+
       private
 
       # @param [Object] response

data/lib/dry/types/constructor.rb

@@ -72,8 +72,21 @@ module Dry
         Constrained::Coercible
       end
 
+      # @api public
+      #
+      # @see Definition#to_ast
+      def to_ast(meta: true)
+        [:constructor, [type.to_ast(meta: meta),
+                        register_fn(fn),
+                        meta ? self.meta : EMPTY_HASH]]
+      end
+
       private
 
+      def register_fn(fn)
+        Dry::Types::FnContainer.register(fn)
+      end
+
       # @param [Symbol] meth
       # @param [Boolean] include_private
       # @return [Boolean]

data/lib/dry/types/definition.rb

@@ -106,6 +106,15 @@ module Dry
       end
       alias_method :valid?, :primitive?
       alias_method :===, :primitive?
+
+      # Return AST representation of a type definition
+      #
+      # @api public
+      #
+      # @return [Array]
+      def to_ast(meta: true)
+        [:definition, [primitive, meta ? self.meta : EMPTY_HASH]]
+      end
     end
   end
 end

data/lib/dry/types/enum.rb

@@ -41,6 +41,13 @@ module Dry
         raise '.enum(*values).default(value) is not supported. Call '\
               '.default(value).enum(*values) instead'
       end
+
+      # @api public
+      #
+      # @see Definition#to_ast
+      def to_ast(meta: true)
+        [:enum, [type.to_ast(meta: meta), meta ? self.meta : EMPTY_HASH]]
+      end
     end
   end
 end

data/lib/dry/types/errors.rb

@@ -9,8 +9,9 @@ module Dry
     class SchemaError < TypeError
       # @param [String,Symbol] key
       # @param [Object] value
-      def initialize(key, value)
-        super("#{value.inspect} (#{value.class}) has invalid type for :#{key}")
+      # @param [String, #to_s] result
+      def initialize(key, value, result)
+        super("#{value.inspect} (#{value.class}) has invalid type for :#{key} violates constraints (#{result} failed)")
       end
     end
 

data/lib/dry/types/fn_container.rb

@@ -0,0 +1,33 @@
+require 'dry/types/container'
+
+module Dry
+  module Types
+    class FnContainer
+      # @api private
+      def self.container
+        @container ||= Container.new
+      end
+
+      # @api private
+      def self.register(function)
+        register_function_name = register_name(function)
+        container.register(register_function_name, function) unless container.key?(register_function_name)
+        register_function_name
+      end
+
+      # @api private
+      def self.[](function_name)
+        if container.key?(function_name)
+          container[function_name]
+        else
+          function_name
+        end
+      end
+
+      # @api private
+      def self.register_name(function)
+        "fn_#{function.object_id}"
+      end
+    end
+  end
+end

data/lib/dry/types/hash/schema.rb

@@ -58,8 +58,23 @@ module Dry
           end
         end
 
+        def to_ast(meta: true)
+          [
+            :hash,
+            [
+              hash_type,
+              member_types.map { |name, member| [:member, [name, member.to_ast(meta: meta)]] },
+              meta ? self.meta : EMPTY_HASH
+            ]
+          ]
+        end
+
         private
 
+        def hash_type
+          :schema
+        end
+
         # @param [Hash] hash
         # @return [Hash{Symbol => Object}]
         def try_coerce(hash)
@@ -74,8 +89,8 @@ module Dry
           resolve(hash) do |type, key, value|
             begin
               type.call(value)
-            rescue ConstraintError
-              raise SchemaError.new(key, value)
+            rescue ConstraintError => e
+              raise SchemaError.new(key, value, e.result)
             end
           end
         end
@@ -114,6 +129,10 @@ module Dry
       class Permissive < Schema
         private
 
+        def hash_type
+          :permissive
+        end
+
         # @param [Symbol] key
         # @raise [MissingKeyError] when key is missing in given input
         def resolve_missing_value(_, key, _)
@@ -132,6 +151,10 @@ module Dry
       class Strict < Permissive
         private
 
+        def hash_type
+          :strict
+        end
+
         # @param [Hash] hash
         # @return [Hash{Symbol => Object}]
         # @raise [UnknownKeysError]
@@ -160,6 +183,10 @@ module Dry
       class StrictWithDefaults < Strict
         private
 
+        def hash_type
+          :strict_with_defaults
+        end
+
         # @param [Hash] result
         # @param [Symbol] key
         # @param [Type] type
@@ -203,12 +230,22 @@ module Dry
             block ? yield(result) : result
           end
         end
+
+        private
+
+        def hash_type
+          :weak
+        end
       end
 
       # {Symbolized} hash will turn string key names into symbols.
       class Symbolized < Weak
         private
 
+        def hash_type
+          :symbolized
+        end
+
         def resolve(hash)
           result = {}
           member_types.each do |key, type|

data/lib/dry/types/options.rb

@@ -24,7 +24,13 @@ module Dry
       #   @param [Hash] new metadata to merge into existing metadata
       #   @return [Type] new type with added metadata
       def meta(data = nil)
-        data ? with(meta: @meta.merge(data)) : @meta
+        if !data
+          @meta
+        elsif data.empty?
+          self
+        else
+          with(meta: @meta.merge(data))
+        end
       end
 
       # Resets meta

data/lib/dry/types/safe.rb

@@ -33,6 +33,19 @@ module Dry
         block ? yield(result) : result
       end
 
+      # @api public
+      #
+      # @see Definition#to_ast
+      def to_ast(meta: true)
+        [:safe, [type.to_ast, meta ? self.meta : EMPTY_HASH]]
+      end
+
+      # @api public
+      # @return [Safe]
+      def safe
+        self
+      end
+
       private
 
       # @param [Object, Dry::Types::Constructor] response

data/lib/dry/types/sum.rb

@@ -102,6 +102,13 @@ module Dry
       def valid?(value)
         left.valid?(value) || right.valid?(value)
       end
+
+      # @api public
+      #
+      # @see Definition#to_ast
+      def to_ast(meta: true)
+        [:sum, [left.to_ast(meta: meta), right.to_ast(meta: meta), meta ? self.meta : EMPTY_HASH]]
+      end
     end
   end
 end

data/lib/dry/types/version.rb

@@ -1,5 +1,5 @@
 module Dry
   module Types
-    VERSION = '0.10.3'.freeze
+    VERSION = '0.11.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-types
 version: !ruby/object:Gem::Version
-  version: 0.10.3
+  version: 0.11.0
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-06 00:00:00.000000000 Z
+date: 2017-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -209,6 +209,7 @@ files:
 - ".travis.yml"
 - ".yardopts"
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - README.md
@@ -238,6 +239,7 @@ files:
 - lib/dry/types/errors.rb
 - lib/dry/types/extensions.rb
 - lib/dry/types/extensions/maybe.rb
+- lib/dry/types/fn_container.rb
 - lib/dry/types/form.rb
 - lib/dry/types/hash.rb
 - lib/dry/types/hash/schema.rb
@@ -262,7 +264,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -270,7 +272,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.9
 signing_key: 
 specification_version: 4
 summary: Type system for Ruby supporting coercions, constraints and complex types