dry-struct 0.7.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ea6fc5c14bec80d877a1a04549fa897c48fb6d028e9a35c86f05d59fff4cf65
-  data.tar.gz: 38062528ba03fb91e4d0c4ca95dc526e1db4703a71b0095a5d99d43b1112a015
+  metadata.gz: b8e3499eadacef74b5203366275c7f68c77ad138e950ac4e5f0a02635bc118f9
+  data.tar.gz: a227f8eb3d8beb3b1388bbe1d447055076938611929ed0a41610253feae64741
 SHA512:
-  metadata.gz: d29117cb09adefbdca14a7ed0ce5ed3e0b3cf22d5167ae30ab143bad0771c0d02782f0386f3995a4aa1625303a759894473ddc668e67d4a04bd93a818458bdc2
-  data.tar.gz: 5e1f4cdba2ceb5325c90fa454701daac5d82b410a4b6742eda3bfb467038aee16fd5796a8d0819cc8c510471590ffc42fb9fe3f4b04e9f3bf11d359b8b850a4d
+  metadata.gz: 1c721723926e9edaf876e0e96e209fbdd33b882a9f92b2b670aeb3af26901c9c42d262a7446e811706c4fe02a3eb4bf76895747c2cac084ad20023952f480879
+  data.tar.gz: a0dba3a720335d985feea9004a0b1ec1f8bb8625a4b6947a22acb6ab68bb0f4fb23aea38c8122570475ed332dc408330391d1572707216007f302e853e8a6e66

data/.travis.yml

@@ -8,9 +8,9 @@ after_success:
   - '[ -d coverage ] && bundle exec codeclimate-test-reporter'
 rvm:
   - 2.4.5
-  - 2.5.3
-  - 2.6.1
-  - jruby-9.2.6.0
+  - 2.5.5
+  - 2.6.3
+  - jruby-9.2.7.0
   - truffleruby
 env:
   global:

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+# 1.0.0 2019-04-23
+
+## Changed
+
+* `valid?` and `===` behave differently, `===` works the same way `Class#===` does and `valid?` checks if the value _can be_ coerced to the struct (flash-gordon)
+
+## Added
+
+* `Struct.call` now accepts an optional block that will be called on failed coercion. This behavior is consistent with dry-types 1.0. Note that `.new` doesn't take a block (flash-gordon)
+  ```ruby
+  User = Dry::Struct(name: 'string')
+  User.(1) { :oh_no }
+  # => :oh_no
+  ```
+
+[Compare v0.7.0...v1.0.0](https://github.com/dry-rb/dry-struct/compare/v0.7.0...v1.0.0)
+
 # 0.7.0 2019-03-22
 
 ## Changed

data/Gemfile

@@ -7,7 +7,7 @@ gemspec
 group :test do
   gem 'codeclimate-test-reporter', platform: :mri, require: false
   gem 'simplecov', require: false
-  gem 'warning' if RUBY_VERSION >= '2.4.0'
+  gem 'warning'
 end
 
 group :tools do
@@ -22,4 +22,5 @@ group :benchmarks do
   gem 'virtus'
   gem 'fast_attributes'
   gem 'attrio'
+  gem 'hotch'
 end

data/README.md

@@ -1,10 +1,10 @@
 [gem]: https://rubygems.org/gems/dry-struct
 [travis]: https://travis-ci.org/dry-rb/dry-struct
 [codeclimate]: https://codeclimate.com/github/dry-rb/dry-struct
-[coveralls]: https://coveralls.io/r/dry-rb/dry-struct
 [inchpages]: http://inch-ci.org/github/dry-rb/dry-struct
+[chat]: https://dry-rb.zulipchat.com
 
-# dry-struct [![Join the chat at https://gitter.im/dry-rb/chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/dry-rb/chat)
+# dry-struct [![Join the chat at https://dry-rb.zulipchat.com](https://img.shields.io/badge/dry--rb-join%20chat-%23346b7a.svg)][chat]
 
 [![Gem Version](https://badge.fury.io/rb/dry-struct.svg)][gem]
 [![Build Status](https://travis-ci.org/dry-rb/dry-struct.svg?branch=master)][travis]

data/benchmarks/basic.rb

@@ -42,7 +42,7 @@ class AttrioUser
 end
 
 class DryStructUser < Dry::Struct
-  attributes(name: 'string', age: 'form.int')
+  attributes(name: 'strict.string', age: 'params.integer')
 end
 
 puts DryStructUser.new(name: 'Jane', age: '21').inspect

data/benchmarks/constrained.rb

@@ -21,9 +21,9 @@ module Types
 end
 
 class DryStructUser < Dry::Struct
-  attribute :id, Types::Form::Int
+  attribute :id, Types::Params::Integer
   attribute :name, Types::Strict::String.constrained(size: 3..64)
-  attribute :age, Types::Form::Int.constrained(gt: 18)
+  attribute :age, Types::Params::Integer.constrained(gt: 18)
 end
 
 puts ARUser.new(id: 1, name: 'Jane', age: '21').inspect

data/benchmarks/profile_instantiation.rb

@@ -0,0 +1,19 @@
+require_relative 'setup'
+
+ATTR_NAMES = [:attr0, :attr1, :attr2, :attr3, :attr4, :attr5, :attr6, :attr7, :attr8, :attr9]
+
+class Integers < Dry::Struct
+  ATTR_NAMES.each do |name|
+    attribute? name, 'coercible.integer'
+  end
+end
+
+integers = {attr0: 0, attr1: 1, attr2: 2, attr3: 3, attr4: 4, attr5: 5, attr6: 6, attr7: 7, attr8: 8, attr9: 9}
+
+require 'pry-byebug'
+
+profile do
+  1_000_000.times do
+    Integers.new(integers)
+  end
+end

data/benchmarks/setup.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'benchmark/ips'
+require 'hotch'
+ENV['HOTCH_VIEWER'] ||= 'open'
+
+require 'dry-struct'
+
+def profile(&block)
+  Hotch(filter: 'Dry', &block)
+end

data/dry-struct.gemspec

@@ -27,10 +27,10 @@ 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.3.0"
+  spec.required_ruby_version = ">= 2.4.0"
 
   spec.add_runtime_dependency 'dry-equalizer', '~> 0.2'
-  spec.add_runtime_dependency 'dry-types', '~> 0.15'
+  spec.add_runtime_dependency 'dry-types', '~> 1.0'
   spec.add_runtime_dependency 'dry-core', '~> 0.4', '>= 0.4.3'
   spec.add_runtime_dependency 'ice_nine', '~> 0.11'
 

data/lib/dry/struct.rb

@@ -188,3 +188,4 @@ end
 
 require 'dry/struct/value'
 require 'dry/struct/extensions'
+require 'dry/struct/printer'

data/lib/dry/struct/class_interface.rb

@@ -63,8 +63,8 @@ module Dry
       # @example with a nested array of structs
       #   class Language < Dry::Struct
       #     attribute :name, Types::String
-      #     array :versions, Types::String
-      #     array :celebrities, Types::Array.of(Dry::Struct) do
+      #     attribute :versions, Types::Array.of(Types::String)
+      #     attribute :celebrities, Types::Array.of(Dry::Struct) do
       #       attribute :name, Types::String
       #       attribute :pseudonym, Types::String
       #     end
@@ -157,8 +157,8 @@ module Dry
         keys.each do |key|
           next if instance_methods.include?(key)
           class_eval(<<-RUBY)
-            def #{ key }
-              @attributes[#{ key.inspect }]
+            def #{key}
+              @attributes[#{key.inspect}]
             end
           RUBY
         end
@@ -222,16 +222,36 @@ module Dry
 
       # @param [Hash{Symbol => Object},Dry::Struct] attributes
       # @raise [Struct::Error] if the given attributes don't conform {#schema}
-      def new(attributes = default_attributes)
-        if attributes.instance_of?(self)
+      def new(attributes = default_attributes, safe = false)
+        if equal?(attributes.class)
           attributes
+        elsif safe
+          load(schema.call_safe(attributes) { |output = attributes| return yield output })
         else
-          super(schema[attributes])
+          load(schema.call_unsafe(attributes))
         end
-      rescue Types::SchemaError, Types::MissingKeyError, Types::UnknownKeysError => error
+      rescue Types::CoercionError => error
         raise Struct::Error, "[#{self}.new] #{error}"
       end
 
+      # @api private
+      def call_safe(input, &block)
+        if input.is_a?(self)
+          input
+        else
+          new(input, true, &block)
+        end
+      end
+
+      # @api private
+      def call_unsafe(input)
+        if input.is_a?(self)
+          input
+        else
+          new(input)
+        end
+      end
+
       # @api private
       def load(attributes)
         struct = allocate
@@ -239,17 +259,6 @@ module Dry
         struct
       end
 
-      # Calls type constructor. The behavior is identical to `.new` but returns
-      # the input back if it's a subclass of the struct.
-      #
-      # @param [Hash{Symbol => Object},Dry::Struct] attributes
-      # @return [Dry::Struct]
-      def call(attributes = default_attributes)
-        return attributes if attributes.is_a?(self)
-        new(attributes)
-      end
-      alias_method :[], :call
-
       # @param [#call,nil] constructor
       # @param [Hash] _options
       # @param [#call,nil] block
@@ -274,7 +283,7 @@ module Dry
       # @private
       def try_struct(input)
         if input.is_a?(self)
-          Types::Result::Success.new(input)
+          input
         else
           yield
         end
@@ -305,9 +314,10 @@ module Dry
 
       # @param [Object, Dry::Struct] value
       # @return [Boolean]
-      def valid?(value)
-        self === value
+      def ===(other)
+        other.is_a?(self)
       end
+      alias_method :primitive?, :===
 
       # @return [true]
       def constrained?
@@ -324,6 +334,11 @@ module Dry
         false
       end
 
+      # @return [Proc]
+      def to_proc
+        proc { |input| call(input) }
+      end
+
       # Checks if this {Struct} has the given attribute
       #
       # @param [Symbol] key Attribute name

data/lib/dry/struct/printer.rb

@@ -0,0 +1,18 @@
+require 'dry/types/printer'
+
+module Dry
+  module Types
+    # @api private
+    class Printer
+      MAPPING[Struct::Sum] = :visit_struct_sum
+
+      def visit_struct_sum(sum)
+        visit_sum_constructors(sum) do |constructors|
+          visit_options(EMPTY_HASH, sum.meta) do |opts|
+            yield "Struct::Sum<#{constructors}#{opts}>"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dry/struct/sum.rb

@@ -1,4 +1,5 @@
 require 'dry/types/sum'
+require 'dry/types/printer'
 
 module Dry
   class Struct
@@ -6,6 +7,11 @@ module Dry
     # As opposed to Dry::Types::Sum::Constrained
     # this type tries no to coerce data first.
     class Sum < Dry::Types::Sum::Constrained
+      def call(input)
+        left.try_struct(input) do
+          right.try_struct(input) { super }
+        end
+      end
       # @param [Hash{Symbol => Object},Dry::Struct] input
       # @yieldparam [Dry::Types::Result::Failure] failure
       # @yieldreturn [Dry::Types::ResultResult]
@@ -23,12 +29,17 @@ module Dry
       # @return [Dry::Types::Sum]
       def |(type)
         if type.is_a?(Class) && type <= Struct || type.is_a?(Sum)
-          self.class.new(self, type)
+          Sum.new(self, type)
         else
           super
         end
       end
 
+      # @return [boolean]
+      def ===(value)
+        left === value || right === value
+      end
+
       protected
 
       # @private

data/lib/dry/struct/version.rb

@@ -1,6 +1,6 @@
 module Dry
   class Struct
     # @private
-    VERSION = '0.7.0'.freeze
+    VERSION = '1.0.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-struct
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-22 00:00:00.000000000 Z
+date: 2019-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-equalizer
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: dry-core
   requirement: !ruby/object:Gem::Requirement
@@ -147,6 +147,8 @@ files:
 - Rakefile
 - benchmarks/basic.rb
 - benchmarks/constrained.rb
+- benchmarks/profile_instantiation.rb
+- benchmarks/setup.rb
 - bin/console
 - bin/setup
 - dry-struct.gemspec
@@ -158,6 +160,7 @@ files:
 - lib/dry/struct/extensions.rb
 - lib/dry/struct/extensions/pretty_print.rb
 - lib/dry/struct/hashify.rb
+- lib/dry/struct/printer.rb
 - lib/dry/struct/struct_builder.rb
 - lib/dry/struct/sum.rb
 - lib/dry/struct/value.rb
@@ -178,14 +181,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Typed structs and value objects.