dry-struct 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33cd05dd51a3310d7ede685ae1ce8631a0955d7563afca7633a7625b9b34dd17
-  data.tar.gz: 182c58865ccb3e74595aa22d6c9730ce8ca0e078d1b6ecb5e8b69e026ce6409d
+  metadata.gz: 2ea6fc5c14bec80d877a1a04549fa897c48fb6d028e9a35c86f05d59fff4cf65
+  data.tar.gz: 38062528ba03fb91e4d0c4ca95dc526e1db4703a71b0095a5d99d43b1112a015
 SHA512:
-  metadata.gz: 3f5e4f6609b93e80ae775ab556812cc872883eaf423a74ae2e5191d2bef6907152653fa7fe441bb9aab945b7cf9f4ec62dd4d359ffcb88f4e976b8b53fb42ac8
-  data.tar.gz: 4b76e94533ff98f1c1d9d427967a5c19af3d58484a5e785c7eac15d50211d70e4718d35572bb6e89fbafeb9b9f092a73f68e517244676f28d4c7e4854f1a055a
+  metadata.gz: d29117cb09adefbdca14a7ed0ce5ed3e0b3cf22d5167ae30ab143bad0771c0d02782f0386f3995a4aa1625303a759894473ddc668e67d4a04bd93a818458bdc2
+  data.tar.gz: 5e1f4cdba2ceb5325c90fa454701daac5d82b410a4b6742eda3bfb467038aee16fd5796a8d0819cc8c510471590ffc42fb9fe3f4b04e9f3bf11d359b8b850a4d

data/.travis.yml

@@ -4,20 +4,21 @@ sudo: required
 bundler_args: --without benchmarks tools
 script:
   - bundle exec rake spec
-before_install:
-  - gem update --system
 after_success:
   - '[ -d coverage ] && bundle exec codeclimate-test-reporter'
 rvm:
-  - 2.2.10
-  - 2.3.7
-  - 2.4.4
-  - 2.5.1
-  - jruby-9.2.0.0
+  - 2.4.5
+  - 2.5.3
+  - 2.6.1
+  - jruby-9.2.6.0
+  - truffleruby
 env:
   global:
     - COVERAGE=true
     - JRUBY_OPTS='--dev -J-Xmx1024M'
+matrix:
+  allow_failures:
+    - rvm: truffleruby
 notifications:
   email: false
   webhooks:

data/CHANGELOG.md

@@ -1,8 +1,37 @@
+# 0.7.0 2019-03-22
+
+## Changed
+
+* [BREAKING] `Struct.input` was renamed `Struct.schema`, hence `Struct.schema` returns an instance of `Dry::Types::Hash::Schema` rather than a `Hash`. Schemas are also implementing `Enumerable` but they iterate over key types.
+  New API:
+  ```ruby
+  User.schema.each do |key|
+    puts "Key name: #{ key.name }"
+    puts "Key type: #{ key.type }"
+  end
+  ```
+  To get a type by its name use `.key`:
+  ```ruby
+  User.schema.key(:id) # => #<Dry::Types::Hash::Key ...>
+  ```
+* [BREAKING] `transform_types` now passes one argument to the block, an instance of the `Key` type. Combined with the new API from dry-types it simplifies declaring omittable keys:
+  ```ruby
+  class StructWithOptionalKeys < Dry::Struct
+    transform_types { |key| key.required(false) }
+    # or simply
+    transform_types(&:omittable)
+  end
+  ```
+* `Dry::Stuct#new` is now more efficient for partial updates (flash-gordon)
+* Ruby 2.3 is EOL and not officially supported. It may work but we don't test it.
+
+[Compare v0.6.0...v0.7.0](https://github.com/dry-rb/dry-struct/compare/v0.6.0...v0.7.0)
+
 # v0.6.0 2018-10-24
 
-## BREAKING CHANGES
+## Changed
 
-* `Struct.attribute?` in the old sense is deprecated, use `has_attribute?` as a replacement
+* [BREAKING] `Struct.attribute?` in the old sense is deprecated, use `has_attribute?` as a replacement
 
 ## Added
 

data/Gemfile

@@ -1,9 +1,8 @@
 source 'https://rubygems.org'
 
-gemspec
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
-gem 'dry-types', git: 'https://github.com/dry-rb/dry-types'
-gem 'dry-inflector', git: 'https://github.com/dry-rb/dry-inflector'
+gemspec
 
 group :test do
   gem 'codeclimate-test-reporter', platform: :mri, require: false
@@ -12,10 +11,8 @@ group :test do
 end
 
 group :tools do
+  gem 'pry'
   gem 'pry-byebug', platform: :mri
-  gem 'pry', platform: :jruby
-  gem 'mutant'
-  gem 'mutant-rspec'
 end
 
 group :benchmarks do

data/benchmarks/constrained.rb

@@ -17,7 +17,7 @@ class ARUser < ActiveRecord::Base
 end
 
 module Types
-  include Dry::Types.module
+  include Dry.Types
 end
 
 class DryStructUser < Dry::Struct

data/bin/console

@@ -6,7 +6,7 @@ require 'dry/struct'
 require 'irb'
 
 module Types
-  include Dry::Types.module
+  include Dry.Types
 end
 
 binding.irb

data/dry-struct.gemspec

@@ -27,13 +27,14 @@ 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.add_runtime_dependency 'dry-equalizer', '~> 0.2'
-  spec.add_runtime_dependency 'dry-types', '~> 0.13'
+  spec.add_runtime_dependency 'dry-types', '~> 0.15'
   spec.add_runtime_dependency 'dry-core', '~> 0.4', '>= 0.4.3'
   spec.add_runtime_dependency 'ice_nine', '~> 0.11'
 
-  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake', '~> 11.0'
   spec.add_development_dependency 'rspec', '~> 3.3'
   spec.add_development_dependency 'yard', '~> 0.9.5'

data/lib/dry/struct.rb

@@ -16,7 +16,7 @@ module Dry
   #   require 'dry-struct'
   #
   #   module Types
-  #     include Dry::Types.module
+  #     include Dry.Types
   #   end
   #
   #   Person = Dry.Struct(name: Types::Strict::String, age: Types::Strict::Int)
@@ -60,12 +60,12 @@ module Dry
   #   require 'dry-struct'
   #
   #   module Types
-  #     include Dry::Types.module
+  #     include Dry.Types
   #   end
   #
   #   class Book < Dry::Struct
-  #     attribute :title, Types::Strict::String
-  #     attribute :subtitle, Types::Strict::String.optional
+  #     attribute :title, Types::String
+  #     attribute :subtitle, Types::String.optional
   #   end
   #
   #   rom_n_roda = Book.new(
@@ -90,8 +90,8 @@ module Dry
 
     # {Dry::Types::Hash::Schema} subclass with specific behaviour defined for
     # @return [Dry::Types::Hash::Schema]
-    defines :input
-    input Types['coercible.hash'].schema(EMPTY_HASH)
+    defines :schema
+    schema Types['coercible.hash'].schema(EMPTY_HASH)
 
     @meta = EMPTY_HASH
 
@@ -143,8 +143,8 @@ module Dry
     #   rom_n_roda.to_hash
     #     #=> {title: 'Web Development with ROM and Roda', subtitle: nil}
     def to_hash
-      self.class.schema.keys.each_with_object({}) do |key, result|
-        result[key] = Hashify[self[key]] if attributes.key?(key)
+      self.class.schema.each_with_object({}) do |key, result|
+        result[key.name] = Hashify[self[key.name]] if attributes.key?(key.name)
       end
     end
     alias_method :to_h, :to_hash
@@ -170,7 +170,10 @@ module Dry
     #   rom_n_roda.new(subtitle: '3rd edition')
     #     #=> #<Book title="Web Development with ROM and Roda" subtitle="3rd edition">
     def new(changeset)
-      self.class[__attributes__.merge(changeset)]
+      new_attributes = self.class.schema.apply(changeset, skip_missing: true, resolve_defaults: false)
+      self.class.load(__attributes__.merge(new_attributes))
+    rescue Types::SchemaError, Types::MissingKeyError, Types::UnknownKeysError => error
+      raise Struct::Error, "[#{self}.new] #{error}"
     end
     alias_method :__new__, :new
 

data/lib/dry/struct/class_interface.rb

@@ -34,7 +34,7 @@ module Dry
       # and modifies {.schema} accordingly.
       #
       # @param [Symbol] name name of the defined attribute
-      # @param [Dry::Types::Definition, nil] type or superclass of nested type
+      # @param [Dry::Types::Type, nil] type or superclass of nested type
       # @return [Dry::Struct]
       # @yield
       #   If a block is given, it will be evaluated in the context of
@@ -53,10 +53,7 @@ module Dry
       #   end
       #
       #   Language.schema
-      #     #=> {
-      #           :name=>#<Dry::Types::Definition primitive=String options={} meta={}>,
-      #           :details=>Language::Details
-      #         }
+      #   # => #<Dry::Types[Constructor<Schema<keys={name: Nominal<String> details: Language::Details}> fn=Kernel.Hash>]>
       #
       #   ruby = Language.new(name: 'Ruby', details: { type: 'OO' })
       #   ruby.name #=> 'Ruby'
@@ -74,11 +71,11 @@ module Dry
       #   end
       #
       #   Language.schema
-      #     #=> {
-      #           :name=>#<Dry::Types::Definition primitive=String options={} meta={}>,
-      #           :versions=>#<Dry::Types::Array::Member primitive=Array options={:member=>#<Dry::Types::Definition primitive=String options={} meta={}>} meta={}>,
-      #           :celebrities=>#<Dry::Types::Array::Member primitive=Array options={:member=>Language::Celebrity} meta={}>
-      #         }
+      #   => #<Dry::Types[Constructor<Schema<keys={
+      #         name: Nominal<String>
+      #         versions: Array<Nominal<String>>
+      #         celebrities: Array<Language::Celebrity>
+      #      }> fn=Kernel.Hash>]>
       #
       #   ruby = Language.new(
       #     name: 'Ruby',
@@ -114,7 +111,7 @@ module Dry
       #   User.new(name: 'John') # => #<User name="John">
       #
       # @param [Symbol] name name of the defined attribute
-      # @param [Dry::Types::Definition, nil] type or superclass of nested type
+      # @param [Dry::Types::Type, nil] type or superclass of nested type
       # @return [Dry::Struct]
       #
       def attribute?(*args, &block)
@@ -129,11 +126,11 @@ module Dry
         else
           name, type = args
 
-          attribute(name, build_type(name, type, &block).meta(omittable: true))
+          attribute(:"#{ name }?", build_type(name, type, &block))
         end
       end
 
-      # @param [Hash{Symbol => Dry::Types::Definition}] new_schema
+      # @param [Hash{Symbol => Dry::Types::Type}] new_schema
       # @return [Dry::Struct]
       # @raise [RepeatedAttributeError] when trying to define attribute with the
       #   same name as previously defined one
@@ -147,14 +144,17 @@ module Dry
       #   end
       #
       #   Book.schema
-      #     #=> {title: #<Dry::Types::Definition primitive=String options={}>,
-      #     #    author: #<Dry::Types::Definition primitive=String options={}>}
+      #   # => #<Dry::Types[Constructor<Schema<keys={
+      #   #      title: Nominal<String>
+      #   #      author: Nominal<String>
+      #   #    }> fn=Kernel.Hash>]>
       def attributes(new_schema)
-        check_schema_duplication(new_schema)
+        keys = new_schema.keys.map { |k| k.to_s.chomp('?').to_sym }
+        check_schema_duplication(keys)
 
-        input input.schema(new_schema)
+        schema schema.schema(new_schema)
 
-        new_schema.each_key do |key|
+        keys.each do |key|
           next if instance_methods.include?(key)
           class_eval(<<-RUBY)
             def #{ key }
@@ -165,9 +165,11 @@ module Dry
 
         @attribute_names = nil
 
-        descendants.
-          select { |d| d.superclass == self }.
-          each { |d| d.attributes(new_schema.reject { |k, _| d.schema.key?(k) }) }
+        direct_descendants = descendants.select { |d| d.superclass == self }
+        direct_descendants.each do |d|
+          inherited_attrs = new_schema.reject { |k, _| d.has_attribute?(k.to_s.chomp('?').to_sym) }
+          d.attributes(inherited_attrs)
+        end
 
         self
       end
@@ -183,10 +185,10 @@ module Dry
       #     attribute :title, Types::Strict::String
       #   end
       #
-      #   Book.schema[:title].meta # => { struct: :Book }
+      #   Book.schema.key(:title).meta # => { struct: :Book }
       #
       def transform_types(proc = nil, &block)
-        input input.with_type_transform(proc || block)
+        schema schema.with_type_transform(proc || block)
       end
 
       # Add an arbitrary transformation for input hash keys.
@@ -203,16 +205,18 @@ module Dry
       #   Book.new('title' => "The Old Man and the Sea")
       #   # => #<Book title="The Old Man and the Sea">
       def transform_keys(proc = nil, &block)
-        input input.with_key_transform(proc || block)
+        schema schema.with_key_transform(proc || block)
       end
 
-      # @param [Hash{Symbol => Dry::Types::Definition, Dry::Struct}] new_schema
+      # @param [Hash{Symbol => Dry::Types::Type, Dry::Struct}] new_schema
       # @raise [RepeatedAttributeError] when trying to define attribute with the
       #   same name as previously defined one
-      def check_schema_duplication(new_schema)
-        shared_keys = new_schema.keys & (schema.keys - superclass.schema.keys)
+      def check_schema_duplication(new_keys)
+        overlapping_keys = new_keys & (attribute_names - superclass.attribute_names)
 
-        raise RepeatedAttributeError, shared_keys.first if shared_keys.any?
+        if overlapping_keys.any?
+          raise RepeatedAttributeError, overlapping_keys.first
+        end
       end
       private :check_schema_duplication
 
@@ -222,12 +226,19 @@ module Dry
         if attributes.instance_of?(self)
           attributes
         else
-          super(input[attributes])
+          super(schema[attributes])
         end
       rescue Types::SchemaError, Types::MissingKeyError, Types::UnknownKeysError => error
         raise Struct::Error, "[#{self}.new] #{error}"
       end
 
+      # @api private
+      def load(attributes)
+        struct = allocate
+        struct.send(:initialize, attributes)
+        struct
+      end
+
       # Calls type constructor. The behavior is identical to `.new` but returns
       # the input back if it's a subclass of the struct.
       #
@@ -321,16 +332,11 @@ module Dry
         schema.key?(key)
       end
 
-      # @return [Hash{Symbol => Dry::Types::Definition, Dry::Struct}]
-      def schema
-        input.member_types
-      end
-
       # Gets the list of attribute names
       #
       # @return [Array<Symbol>]
       def attribute_names
-        @attribute_names ||= schema.keys
+        @attribute_names ||= schema.map(&:name)
       end
 
       # @return [{Symbol => Object}]
@@ -367,15 +373,15 @@ module Dry
       #
       # @return [Hash{Symbol => Object}]
       def default_attributes(default_schema = schema)
-        default_schema.each_with_object({}) do |(name, type), result|
-          result[name] = default_attributes(type.schema) if struct?(type)
+        default_schema.each_with_object({}) do |key, result|
+          result[key.name] = default_attributes(key.schema) if struct?(key.type)
         end
       end
       private :default_attributes
 
       # Checks if the given type is a Dry::Struct
       #
-      # @param [Dry::Types::Definition, Dry::Struct] type
+      # @param [Dry::Types::Type] type
       # @return [Boolean]
       def struct?(type)
         type.is_a?(Class) && type <= Struct

data/lib/dry/struct/struct_builder.rb

@@ -73,7 +73,7 @@ module Dry
         member
       end
 
-      def visit_definition(*)
+      def visit_nominal(*)
         default_superclass
       end
 

data/lib/dry/struct/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-struct
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-24 00:00:00.000000000 Z
+date: 2019-03-22 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.13'
+        version: '0.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '0.15'
 - !ruby/object:Gem::Dependency
   name: dry-core
   requirement: !ruby/object:Gem::Requirement
@@ -76,16 +76,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -178,15 +178,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Typed structs and value objects.