dry-struct 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64b4b12493455f8f916b5708d7c2afdc2649099d3b7b8c41045b73517cce05f8
-  data.tar.gz: 84989a15e01c83c1d71b0d5e034ca54d7727fc7c37db29c0e8b2db88ece51f15
+  metadata.gz: bf0892469a434b85578e7350f52039b85203dbd251ca5c4bd6b038373edc703e
+  data.tar.gz: 263e3d2d4ce824be64210a27d074fb42126dde12d94e56290307d9ff08c0efad
 SHA512:
-  metadata.gz: 2462f24f972cbaa0c89399f76e3247c3b1fac9a6a88a0f1ea3a6e4ceb37fea2a463b58967c26b102456d589755fe2d3350c324b0646b870db27c6c434eba5acf
-  data.tar.gz: 6156aa3704d9afffedc1370bf17371177d41696c289005fe5d41e4d356049ab881a6e40675756ab6bacd59ca4ac41f792a0dc872da9ffd2724b12cdd44c78e28
+  metadata.gz: '08ea5f7780bac10495f93a5043c5e100fc9386688920e4e7fd1b2304ceaeb8f37853f6ed70f5d5a69b1d7a30c0340450f8ce41fba91e812e00cf6a008f9c2de0'
+  data.tar.gz: da176db2c5d8127ea7ef6a088edf7f8f4d18c74e65d96e7f6a80dd9822c0baefdfa1dd7eb6d607ac077c033d64dcddb0ca6c1498eb411c4cd94ea96e23c701b4

data/CHANGELOG.md

@@ -1,9 +1,32 @@
+<!--- DO NOT EDIT THIS FILE - IT'S AUTOMATICALLY GENERATED VIA DEVTOOLS --->
+
+## 1.4.0 2021-01-21
+
+
+### Added
+
+- Support for wrapping constructors and fallbacks, see release notes for dry-types 1.5.0 (@flash-gordon)
+- Improvements of the attribute DSL, now it's possible to use optional structs as a base class (@flash-gordon)
+  ```ruby
+  class User < Dry::Struct
+    attribute :name, Types::String
+    attribute :address, Dry::Struct.optional do
+      attribute :city, Types::String
+    end
+  end
+
+  User.new(name: "John", address: nil) # => #<User name="John" address=nil>
+  ```
+
+
+[Compare v1.3.0...v1.4.0](https://github.com/dry-rb/dry-struct/compare/v1.3.0...v1.4.0)
+
 ## 1.3.0 2020-02-10
 
 
 ### Added
 
-- Nested structures will reuse type and key transformations from of the enclosing struct (flash-gordon)
+- Nested structures will reuse type and key transformations from the enclosing struct (@flash-gordon)
 
   ```ruby
   class User < Dry::Struct
@@ -22,13 +45,32 @@
     end
   end
   ```
-- `Dry::Struct::Constructor` finally acts like a fully-featured type (flash-gordon)
-- `Dry::Struct.abstract` declares a struct class as abstract. An abstract class is used as a default superclass for nested structs (flash-gordon)
-- `Struct.to_ast` and struct compiler (@flash-gordon)
+- `Dry::Struct::Constructor` finally acts like a fully-featured type (@flash-gordon)
+- `Dry::Struct.abstract` declares a struct class as abstract. An abstract class is used as a default superclass for nested structs (@flash-gordon)
+- `Dry::Struct.to_ast` and struct compiler (@flash-gordon)
+- Struct composition with `Dry::Struct.attributes_from`. It's more flexible than inheritance (@waiting-for-dev + @flash-gordon)
+
+  ```ruby
+  class Address < Dry::Struct
+    attribute :city, Types::String
+    attribute :zipcode, Types::String
+  end
+
+  class Buyer < Dry::Struct
+    attribute :name, Types::String
+    attributes_from Address
+  end
+
+  class Seller < Dry::Struct
+    attribute :name, Types::String
+    attribute :email, Types::String
+    attributes_from Address
+  end
+  ```
 
 ### Changed
 
-- [internal] metadata is now stored inside schema (flash-gordon)
+- [internal] metadata is now stored inside schema (@flash-gordon)
 
 [Compare v1.2.0...v1.3.0](https://github.com/dry-rb/dry-struct/compare/v1.2.0...v1.3.0)
 

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2020 dry-rb team
+Copyright (c) 2015-2021 dry-rb team
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

data/README.md

@@ -21,7 +21,7 @@
 
 This library officially supports the following Ruby versions:
 
-* MRI >= `2.4`
+* MRI >= `2.5`
 * jruby >= `9.2`
 
 ## License

data/dry-struct.gemspec

@@ -25,12 +25,11 @@ Gem::Specification.new do |spec|
   spec.metadata['source_code_uri']   = 'https://github.com/dry-rb/dry-struct'
   spec.metadata['bug_tracker_uri']   = 'https://github.com/dry-rb/dry-struct/issues'
 
-  spec.required_ruby_version = ">= 2.4.0"
+  spec.required_ruby_version = ">= 2.5.0"
 
   # to update dependencies edit project.yml
-  spec.add_runtime_dependency "dry-core", "~> 0.4", ">= 0.4.4"
-  spec.add_runtime_dependency "dry-equalizer", "~> 0.3"
-  spec.add_runtime_dependency "dry-types", "~> 1.3"
+  spec.add_runtime_dependency "dry-core", "~> 0.5", ">= 0.5"
+  spec.add_runtime_dependency "dry-types", "~> 1.5"
   spec.add_runtime_dependency "ice_nine", "~> 0.11"
 
   spec.add_development_dependency "bundler"

data/lib/dry-struct.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-require 'dry/struct'
+require "dry/struct"

data/lib/dry/struct.rb

@@ -1,16 +1,16 @@
 # frozen_string_literal: true
 
-require 'dry-types'
-require 'dry-equalizer'
-require 'dry/core/extensions'
-require 'dry/core/constants'
-require 'dry/core/deprecations'
-
-require 'dry/struct/version'
-require 'dry/struct/errors'
-require 'dry/struct/class_interface'
-require 'dry/struct/hashify'
-require 'dry/struct/struct_builder'
+require "dry/types"
+require "dry/core/equalizer"
+require "dry/core/extensions"
+require "dry/core/constants"
+require "dry/core/deprecations"
+
+require "dry/struct/version"
+require "dry/struct/errors"
+require "dry/struct/class_interface"
+require "dry/struct/hashify"
+require "dry/struct/struct_builder"
 
 module Dry
   # Constructor method for easily creating a {Dry::Struct}.
@@ -95,14 +95,14 @@ module Dry
       define_method(:prepend, ::Module.method(:prepend))
     end
 
-    autoload :Value, 'dry/struct/value'
+    autoload :Value, "dry/struct/value"
 
     include ::Dry::Equalizer(:__attributes__, inspect: false, immutable: true)
 
     # {Dry::Types::Hash::Schema} subclass with specific behaviour defined for
     # @return [Dry::Types::Hash::Schema]
     defines :schema
-    schema Types['coercible.hash'].schema(EMPTY_HASH)
+    schema Types["coercible.hash"].schema(EMPTY_HASH)
 
     defines :abstract_class
     abstract
@@ -134,7 +134,7 @@ module Dry
     #   rom_n_roda[:title] #=> 'Web Development with ROM and Roda'
     #   rom_n_roda[:subtitle] #=> nil
     def [](name)
-      @attributes.fetch(name) { raise MissingAttributeError.new(name) }
+      @attributes.fetch(name) { raise MissingAttributeError, name }
     end
 
     # Converts the {Dry::Struct} to a hash with keys representing
@@ -185,8 +185,8 @@ module Dry
     def new(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 Error, "[#{self}.new] #{error}"
+    rescue Types::SchemaError, Types::MissingKeyError, Types::UnknownKeysError => e
+      raise Error, "[#{self}.new] #{e}"
     end
     alias_method :__new__, :new
 
@@ -197,16 +197,16 @@ module Dry
       "#<#{klass.name || klass.inspect}#{attrs}>"
     end
 
-    if RUBY_VERSION >= '2.7'
+    if RUBY_VERSION >= "2.7"
       # Pattern matching support
       #
       # @api private
-      def deconstruct_keys(keys)
+      def deconstruct_keys(_keys)
         attributes
       end
     end
   end
 end
 
-require 'dry/struct/extensions'
-require 'dry/struct/printer'
+require "dry/struct/extensions"
+require "dry/struct/printer"

data/lib/dry/struct/class_interface.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require 'weakref'
-require 'dry/core/class_attributes'
-require 'dry/core/inflector'
-require 'dry/core/descendants_tracker'
+require "weakref"
+require "dry/core/class_attributes"
+require "dry/core/inflector"
+require "dry/core/descendants_tracker"
 
-require 'dry/struct/errors'
-require 'dry/struct/constructor'
-require 'dry/struct/sum'
+require "dry/struct/errors"
+require "dry/struct/constructor"
+require "dry/struct/sum"
 
 module Dry
   class Struct
@@ -22,7 +22,7 @@ module Dry
       def inherited(klass)
         super
 
-        unless klass.name.eql?('Dry::Struct::Value')
+        unless klass.name.eql?("Dry::Struct::Value")
           klass.extend(Core::DescendantsTracker)
         end
       end
@@ -149,8 +149,8 @@ module Dry
       def attribute?(*args, &block)
         if args.size == 1 && block.nil?
           Core::Deprecations.warn(
-            'Dry::Struct.attribute? is deprecated for checking attribute presence, '\
-            'use has_attribute? instead',
+            "Dry::Struct.attribute? is deprecated for checking attribute presence, "\
+            "use has_attribute? instead",
             tag: :'dry-struct'
           )
 
@@ -181,7 +181,7 @@ module Dry
       #   #      author: Constrained<Nominal<String> rule=[type?(String)]>
       #   #    }> fn=Kernel.Hash>]>
       def attributes(new_schema)
-        keys = new_schema.keys.map { |k| k.to_s.chomp('?').to_sym }
+        keys = new_schema.keys.map { |k| k.to_s.chomp("?").to_sym }
         check_schema_duplication(keys)
 
         schema schema.schema(new_schema)
@@ -192,7 +192,7 @@ module Dry
 
         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) }
+          inherited_attrs = new_schema.reject { |k, _| d.has_attribute?(k.to_s.chomp("?").to_sym) }
           d.attributes(inherited_attrs)
         end
 
@@ -233,7 +233,7 @@ module Dry
         schema schema.with_key_transform(proc || block)
       end
 
-      # @param [Hash{Symbol => Dry::Types::Type, Dry::Struct}] new_schema
+      # @param [Hash{Symbol => Dry::Types::Type, Dry::Struct}] new_keys
       # @raise [RepeatedAttributeError] when trying to define attribute with the
       #   same name as previously defined one
       def check_schema_duplication(new_keys)
@@ -264,8 +264,8 @@ module Dry
         else
           load(schema.call_unsafe(attributes))
         end
-      rescue Types::CoercionError => error
-        raise Error, "[#{self}.new] #{error}", error.backtrace
+      rescue Types::CoercionError => e
+        raise Error, "[#{self}.new] #{e}", e.backtrace
       end
 
       # @api private
@@ -289,7 +289,7 @@ module Dry
       # @api private
       def load(attributes)
         struct = allocate
-        struct.send(:initialize, attributes)
+        struct.__send__(:initialize, attributes)
         struct
       end
 
@@ -297,7 +297,7 @@ module Dry
       # @param [#call,nil] block
       # @return [Dry::Struct::Constructor]
       def constructor(constructor = nil, **, &block)
-        Constructor.new(self, fn: constructor || block)
+        Constructor[self, fn: constructor || block]
       end
 
       # @param [Hash{Symbol => Object},Dry::Struct] input
@@ -345,7 +345,7 @@ module Dry
         false
       end
 
-      # @param [Object, Dry::Struct] value
+      # @param [Object, Dry::Struct] other
       # @return [Boolean]
       def ===(other)
         other.is_a?(self)
@@ -463,7 +463,7 @@ module Dry
           elsif block.nil? && Undefined.equal?(type)
             raise(
               ::ArgumentError,
-              'you must supply a type or a block to `Dry::Struct.attribute`'
+              "you must supply a type or a block to `Dry::Struct.attribute`"
             )
           else
             type

data/lib/dry/struct/compiler.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'weakref'
-require 'dry/types/compiler'
+require "weakref"
+require "dry/types/compiler"
 
 module Dry
   class Struct

data/lib/dry/struct/errors.rb

@@ -25,7 +25,7 @@ module Dry
     # This shouldn't happen in a working application
     class RecycledStructError < ::RuntimeError
       def initialize
-        super('Reference to struct class was garbage collected')
+        super("Reference to struct class was garbage collected")
       end
     end
   end

data/lib/dry/struct/extensions.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 Dry::Struct.register_extension(:pretty_print) do
-  require 'dry/struct/extensions/pretty_print'
+  require "dry/struct/extensions/pretty_print"
 end

data/lib/dry/struct/extensions/pretty_print.rb

@@ -1,18 +1,18 @@
 # frozen_string_literal: true
 
-require 'pp'
+require "pp"
 
 module Dry
   class Struct
     def pretty_print(pp)
       klass = self.class
-      pp.group(1, "#<#{klass.name || klass.inspect}", '>') do
-        pp.seplist(@attributes.keys, proc { pp.text ',' }) do |column_name|
+      pp.group(1, "#<#{klass.name || klass.inspect}", ">") do
+        pp.seplist(@attributes.keys, proc { pp.text "," }) do |column_name|
           column_value = @attributes[column_name]
-          pp.breakable ' '
+          pp.breakable " "
           pp.group(1) do
             pp.text column_name
-            pp.text '='
+            pp.text "="
             pp.pp column_value
           end
         end

data/lib/dry/struct/printer.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'dry/types/printer'
+require "dry/types/printer"
 
 module Dry
   module Types

data/lib/dry/struct/struct_builder.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'dry/struct/compiler'
+require "dry/struct/compiler"
 
 module Dry
   class Struct
@@ -30,10 +30,13 @@ module Dry
 
           class_exec(&block)
         end
+
         struct.const_set(const_name, new_type)
 
         if array?(type)
           type.of(new_type)
+        elsif optional?(type)
+          new_type.optional
         else
           new_type
         end
@@ -41,13 +44,23 @@ module Dry
 
       private
 
+      def type?(type)
+        type.is_a?(Types::Type)
+      end
+
       def array?(type)
-        type.is_a?(Types::Type) && type.primitive.equal?(::Array)
+        type?(type) && !type.optional? && type.primitive.equal?(::Array)
+      end
+
+      def optional?(type)
+        type?(type) && type.optional?
       end
 
       def parent(type)
         if array?(type)
           visit(type.to_ast)
+        elsif optional?(type)
+          type.right
         else
           type
         end
@@ -65,10 +78,12 @@ module Dry
       end
 
       def check_name(name)
-        raise(
-          Error,
-          "Can't create nested attribute - `#{struct}::#{name}` already defined"
-        ) if struct.const_defined?(name, false)
+        if struct.const_defined?(name, false)
+          raise(
+            Error,
+            "Can't create nested attribute - `#{struct}::#{name}` already defined"
+          )
+        end
       end
 
       def visit_constrained(node)

data/lib/dry/struct/sum.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'dry/types/sum'
-require 'dry/types/printer'
+require "dry/types/sum"
+require "dry/types/printer"
 
 module Dry
   class Struct

data/lib/dry/struct/value.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'ice_nine'
-require 'dry/core/deprecations'
+require "ice_nine"
+require "dry/core/deprecations"
 
 module Dry
   class Struct

data/lib/dry/struct/version.rb

@@ -3,6 +3,6 @@
 module Dry
   class Struct
     # @private
-    VERSION = '1.3.0'.freeze
+    VERSION = "1.4.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-struct
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Piotr Solnica
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-10 00:00:00.000000000 Z
+date: 2021-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-core
@@ -16,48 +16,34 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.4
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.4
-- !ruby/object:Gem::Dependency
-  name: dry-equalizer
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: dry-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: ice_nine
   requirement: !ruby/object:Gem::Requirement
@@ -169,14 +155,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Typed structs and value objects