dry-struct 1.3.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64b4b12493455f8f916b5708d7c2afdc2649099d3b7b8c41045b73517cce05f8
-  data.tar.gz: 84989a15e01c83c1d71b0d5e034ca54d7727fc7c37db29c0e8b2db88ece51f15
+  metadata.gz: fd8d3f0f41192daff14ed892da9e9a86e3dddefc4f7f94f26f58e1d091257532
+  data.tar.gz: 88d94467b25ec8f3a0e6f897232829ffbfb1ee3a1c1ec331e60ce3d5c386cb72
 SHA512:
-  metadata.gz: 2462f24f972cbaa0c89399f76e3247c3b1fac9a6a88a0f1ea3a6e4ceb37fea2a463b58967c26b102456d589755fe2d3350c324b0646b870db27c6c434eba5acf
-  data.tar.gz: 6156aa3704d9afffedc1370bf17371177d41696c289005fe5d41e4d356049ab881a6e40675756ab6bacd59ca4ac41f792a0dc872da9ffd2724b12cdd44c78e28
+  metadata.gz: a3d3a0a161d2a81053e7081a1d2deeead9a565c64a432350145c79083c58e400a8ed984e70b06388128c615d335cbccb29cb43b48f2669830bbf238064965c9e
+  data.tar.gz: 4c6a1a4c1a47f7b941e33c10ad515ce96247bae7e916088863a56c8c1104de5e4344b7314150eeb774627778c76fb79b6f209ba554627786a02ec918f7cf43df

data/CHANGELOG.md

@@ -1,9 +1,87 @@
+<!--- DO NOT EDIT THIS FILE - IT'S AUTOMATICALLY GENERATED VIA DEVTOOLS --->
+
+## 1.7.0 2025-01-06
+
+
+### Fixed
+
+- Fixed coercion errors for structs (issue #192 via #193) (@flash-gordon)
+- Invalid method names are now allowed as struct attributes (issue #169 via #195) (@flash-gordon)
+
+### Changed
+
+- Missing attribute error now includes the name of the class (issue #170 via #191) (@phillipoertel + @cllns)
+- 3.1 is now the minimum Ruby version (@flash-gordon)
+- `Dry::Struct::Error` is now a subclass of `Dry::Types::CoercionError` (in #193) (@flash-gordon)
+- `Dry::Struct#[]` now returns `nil` if an optional attribute is not set. This is consistent with calling accessor methods for optional attributes. (issue #171 via #194) (@ivleonov + @flash-gordon)
+
+[Compare v1.6.0...v1.7.0](https://github.com/dry-rb/dry-struct/compare/v1.6.0...v1.7.0)
+
+## 1.6.0 2022-11-04
+
+
+### Changed
+
+- This version uses dry-core 1.0 (@flash-gordon + @solnic)
+
+[Compare v1.5.2...v1.6.0](https://github.com/dry-rb/dry-struct/compare/v1.5.2...v1.6.0)
+
+## 1.5.2 2022-10-19
+
+
+### Fixed
+
+- Coercion failures keep the original error instead of just having a string (@flash-gordon + @newx)
+
+
+[Compare v1.5.1...v1.5.2](https://github.com/dry-rb/dry-struct/compare/v1.5.1...v1.5.2)
+
+## 1.5.1 2022-10-17
+
+
+### Fixed
+
+- Fixed issues with auto-loading `Extensions` module (issue #183 fixed via #184) (@solnic)
+
+
+[Compare v1.5.0...v1.5.1](https://github.com/dry-rb/dry-struct/compare/v1.5.0...v1.5.1)
+
+## 1.5.0 2022-10-15
+
+
+### Changed
+
+- Use zeitwerk for auto-loading (@flash-gordon)
+
+[Compare v1.4.0...v1.5.0](https://github.com/dry-rb/dry-struct/compare/v1.4.0...v1.5.0)
+
+## 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 +100,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-2023 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

@@ -1,28 +1,21 @@
+<!--- this file is synced from dry-rb/template-gem project -->
 [gem]: https://rubygems.org/gems/dry-struct
 [actions]: https://github.com/dry-rb/dry-struct/actions
-[codacy]: https://www.codacy.com/gh/dry-rb/dry-struct
-[chat]: https://dry-rb.zulipchat.com
-[inchpages]: http://inch-ci.org/github/dry-rb/dry-struct
 
-# 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]
-[![CI Status](https://github.com/dry-rb/dry-struct/workflows/ci/badge.svg)][actions]
-[![Codacy Badge](https://api.codacy.com/project/badge/Grade/961f5c776f1d49218b2cede3745e059c)][codacy]
-[![Codacy Badge](https://api.codacy.com/project/badge/Coverage/961f5c776f1d49218b2cede3745e059c)][codacy]
-[![Inline docs](http://inch-ci.org/github/dry-rb/dry-struct.svg?branch=master)][inchpages]
+# dry-struct [![Gem Version](https://badge.fury.io/rb/dry-struct.svg)][gem] [![CI Status](https://github.com/dry-rb/dry-struct/workflows/CI/badge.svg)][actions]
 
 ## Links
 
-* [User documentation](http://dry-rb.org/gems/dry-struct)
+* [User documentation](https://dry-rb.org/gems/dry-struct)
 * [API documentation](http://rubydoc.info/gems/dry-struct)
+* [Forum](https://discourse.dry-rb.org)
 
 ## Supported Ruby versions
 
 This library officially supports the following Ruby versions:
 
-* MRI >= `2.4`
-* jruby >= `9.2`
+* MRI `>= 3.1`
+* jruby `>= 9.4` (not tested on CI)
 
 ## License
 

data/dry-struct.gemspec

@@ -1,40 +1,37 @@
 # frozen_string_literal: true
-# this file is managed by dry-rb/devtools project
 
-lib = File.expand_path('lib', __dir__)
+# this file is synced from dry-rb/template-gem project
+
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'dry/struct/version'
+require "dry/struct/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'dry-struct'
+  spec.name          = "dry-struct"
   spec.authors       = ["Piotr Solnica"]
   spec.email         = ["piotr.solnica@gmail.com"]
-  spec.license       = 'MIT'
+  spec.license       = "MIT"
   spec.version       = Dry::Struct::VERSION.dup
 
   spec.summary       = "Typed structs and value objects"
   spec.description   = spec.summary
-  spec.homepage      = 'https://dry-rb.org/gems/dry-struct'
+  spec.homepage      = "https://dry-rb.org/gems/dry-struct"
   spec.files         = Dir["CHANGELOG.md", "LICENSE", "README.md", "dry-struct.gemspec", "lib/**/*"]
-  spec.bindir        = 'bin'
+  spec.bindir        = "bin"
   spec.executables   = []
-  spec.require_paths = ['lib']
+  spec.require_paths = ["lib"]
 
-  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
-  spec.metadata['changelog_uri']     = 'https://github.com/dry-rb/dry-struct/blob/master/CHANGELOG.md'
-  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.metadata["allowed_push_host"]     = "https://rubygems.org"
+  spec.metadata["changelog_uri"]         = "https://github.com/dry-rb/dry-struct/blob/main/CHANGELOG.md"
+  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.metadata["rubygems_mfa_required"] = "true"
 
-  spec.required_ruby_version = ">= 2.4.0"
+  spec.required_ruby_version = ">= 3.1.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 "ice_nine", "~> 0.11"
-
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "yard"
+  spec.add_dependency "dry-core", "~> 1.1"
+  spec.add_dependency "dry-types", "~> 1.8"
+  spec.add_dependency "ice_nine", "~> 0.11"
+  spec.add_dependency "zeitwerk", "~> 2.6"
 end

data/lib/dry/struct/class_interface.rb

@@ -1,32 +1,16 @@
 # frozen_string_literal: true
 
-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 "weakref"
 
 module Dry
   class Struct
     # Class-level interface of {Struct} and {Value}
-    module ClassInterface
+    module ClassInterface # rubocop:disable Metrics/ModuleLength
       include Core::ClassAttributes
 
       include Types::Type
       include Types::Builder
 
-      # @param [Class] klass
-      def inherited(klass)
-        super
-
-        unless klass.name.eql?('Dry::Struct::Value')
-          klass.extend(Core::DescendantsTracker)
-        end
-      end
-
       # Adds an attribute for this {Struct} with given `name` and `type`
       # and modifies {.schema} accordingly.
       #
@@ -49,8 +33,12 @@ module Dry
       #     end
       #   end
       #
-      #   Language.schema
-      #   # => #<Dry::Types[Constructor<Schema<keys={name: Constrained<Nominal<String> rule=[type?(String)]> details: Language::Details}> fn=Kernel.Hash>]>
+      #   Language.schema # new lines for readability
+      #   # => #<Dry::Types[
+      #           Constructor<Schema<keys={
+      #             name: Constrained<Nominal<String> rule=[type?(String)]>
+      #             details: Language::Details
+      #           }> fn=Kernel.Hash>]>
       #
       #   ruby = Language.new(name: 'Ruby', details: { type: 'OO' })
       #   ruby.name #=> 'Ruby'
@@ -67,10 +55,12 @@ module Dry
       #     end
       #   end
       #
-      #   Language.schema
+      #   Language.schema # new lines for readability
       #   => #<Dry::Types[Constructor<Schema<keys={
       #         name: Constrained<Nominal<String> rule=[type?(String)]>
-      #         versions: Constrained<Array<Constrained<Nominal<String> rule=[type?(String)]>> rule=[type?(Array)]>
+      #         versions: Constrained<
+      #                     Array<Constrained<Nominal<String> rule=[type?(String)]>
+      #                   > rule=[type?(Array)]>
       #         celebrities: Constrained<Array<Language::Celebrity> rule=[type?(Array)]>
       #      }> fn=Kernel.Hash>]>
       #
@@ -93,8 +83,8 @@ module Dry
       #   ruby.celebrities[0].pseudonym #=> 'Matz'
       #   ruby.celebrities[1].name #=> 'Aaron Patterson'
       #   ruby.celebrities[1].pseudonym #=> 'tenderlove'
-      def attribute(name, type = Undefined, &block)
-        attributes(name => build_type(name, type, &block))
+      def attribute(name, type = Undefined, &)
+        attributes(name => build_type(name, type, &))
       end
 
       # Add atributes from another struct
@@ -122,13 +112,13 @@ module Dry
       #
       # @param struct [Dry::Struct]
       def attributes_from(struct)
-        extracted_schema = struct.schema.keys.map { |key|
+        extracted_schema = struct.schema.keys.to_h do |key|
           if key.required?
             [key.name, key.type]
           else
             [:"#{key.name}?", key.type]
           end
-        }.to_h
+        end
         attributes(extracted_schema)
       end
 
@@ -146,19 +136,19 @@ module Dry
       # @param [Dry::Types::Type, nil] type or superclass of nested type
       # @return [Dry::Struct]
       #
-      def attribute?(*args, &block)
-        if args.size == 1 && block.nil?
+      def attribute?(*args, &)
+        if args.size == 1 && !block_given?
           Core::Deprecations.warn(
-            'Dry::Struct.attribute? is deprecated for checking attribute presence, '\
-            'use has_attribute? instead',
-            tag: :'dry-struct'
+            "Dry::Struct.attribute? is deprecated for checking attribute presence, " \
+            "use has_attribute? instead",
+            tag: :"dry-struct"
           )
 
           has_attribute?(args[0])
         else
           name, * = args
 
-          attribute(:"#{name}?", build_type(*args, &block))
+          attribute(:"#{name}?", build_type(*args, &))
         end
       end
 
@@ -181,7 +171,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)
@@ -190,9 +180,8 @@ module Dry
 
         @attribute_names = nil
 
-        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) }
+        subclasses.each do |d|
+          inherited_attrs = new_schema.reject { |k, _| d.has_attribute?(k.to_s.chomp("?").to_sym) }
           d.attributes(inherited_attrs)
         end
 
@@ -233,7 +222,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)
@@ -247,7 +236,7 @@ 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, safe = false, &block)
+      def new(attributes = default_attributes, safe = false, &) # rubocop:disable Style/OptionalBooleanParameter
         if attributes.is_a?(Struct)
           if equal?(attributes.class)
             attributes
@@ -257,23 +246,23 @@ module Dry
             # User.new(super_user)
             #
             # We may deprecate this behavior in future forcing people to be explicit
-            new(attributes.to_h, safe, &block)
+            new(attributes.to_h, safe, &)
           end
         elsif safe
           load(schema.call_safe(attributes) { |output = attributes| return yield output })
         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
-      def call_safe(input, &block)
+      def call_safe(input, &)
         if input.is_a?(self)
           input
         else
-          new(input, true, &block)
+          new(input, true, &)
         end
       end
 
@@ -289,7 +278,7 @@ module Dry
       # @api private
       def load(attributes)
         struct = allocate
-        struct.send(:initialize, attributes)
+        struct.__send__(:initialize, attributes)
         struct
       end
 
@@ -297,17 +286,17 @@ 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
       # @yieldparam [Dry::Types::Result::Failure] failure
-      # @yieldreturn [Dry::Types::ResultResult]
+      # @yieldreturn [Dry::Types::Result]
       # @return [Dry::Types::Result]
       def try(input)
         success(self[input])
       rescue Error => e
-        failure_result = failure(input, e.message)
+        failure_result = failure(input, e)
         block_given? ? yield(failure_result) : failure_result
       end
 
@@ -324,48 +313,32 @@ module Dry
 
       # @param [({Symbol => Object})] args
       # @return [Dry::Types::Result::Success]
-      def success(*args)
-        result(Types::Result::Success, *args)
-      end
+      def success(*args) = result(Types::Result::Success, *args)
 
       # @param [({Symbol => Object})] args
       # @return [Dry::Types::Result::Failure]
-      def failure(*args)
-        result(Types::Result::Failure, *args)
-      end
+      def failure(*args) = result(Types::Result::Failure, *args)
 
       # @param [Class] klass
       # @param [({Symbol => Object})] args
-      def result(klass, *args)
-        klass.new(*args)
-      end
+      def result(klass, *args) = klass.new(*args)
 
       # @return [false]
-      def default?
-        false
-      end
+      def default? = false
 
-      # @param [Object, Dry::Struct] value
+      # @param [Object, Dry::Struct] other
       # @return [Boolean]
-      def ===(other)
-        other.is_a?(self)
-      end
+      def ===(other) = other.is_a?(self)
       alias_method :primitive?, :===
 
       # @return [true]
-      def constrained?
-        true
-      end
+      def constrained? = true
 
       # @return [self]
-      def primitive
-        self
-      end
+      def primitive = self
 
       # @return [false]
-      def optional?
-        false
-      end
+      def optional? = false
 
       # @return [Proc]
       def to_proc
@@ -376,9 +349,7 @@ module Dry
       #
       # @param [Symbol] key Attribute name
       # @return [Boolean]
-      def has_attribute?(key)
-        schema.key?(key)
-      end
+      def has_attribute?(key) = schema.key?(key)
 
       # Gets the list of attribute names
       #
@@ -456,39 +427,45 @@ module Dry
       # Constructs a type
       #
       # @return [Dry::Types::Type, Dry::Struct]
-      def build_type(name, type = Undefined, &block)
+      def build_type(name, type = Undefined, &)
         type_object =
           if type.is_a?(::String)
             Types[type]
-          elsif block.nil? && Undefined.equal?(type)
+          elsif !block_given? && 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
           end
 
-        if block
-          struct_builder.(name, type_object, &block)
+        if block_given?
+          struct_builder.(name, type_object, &)
         else
           type_object
         end
       end
       private :build_type
 
+      # @api private
       def define_accessors(keys)
-        keys.each do |key|
-          next if instance_methods.include?(key)
-
-          class_eval(<<-RUBY)
-            def #{key}
-              @attributes[#{key.inspect}]
-            end
-          RUBY
+        (keys - instance_methods).each do |key|
+          if valid_method_name?(key)
+            class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
+              def #{key}                      # def email
+                @attributes[#{key.inspect}]   #   @attributes[:email]
+              end                             # end
+            RUBY
+          else
+            define_method(key) { @attributes[key] }
+          end
         end
       end
       private :define_accessors
+
+      # @api private
+      private def valid_method_name?(key) = key.to_s.match?(/\A[a-zA-Z_]\w*\z/)
     end
   end
 end

data/lib/dry/struct/compiler.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require 'weakref'
-require 'dry/types/compiler'
-
 module Dry
   class Struct
     class Compiler < Types::Compiler

data/lib/dry/struct/errors.rb

@@ -3,7 +3,7 @@
 module Dry
   class Struct
     # Raised when given input doesn't conform schema and constructor type
-    Error = Class.new(TypeError)
+    Error = Class.new(::Dry::Types::CoercionError)
 
     # Raised when defining duplicate attributes
     class RepeatedAttributeError < ::ArgumentError
@@ -16,8 +16,8 @@ module Dry
 
     # Raised when a struct doesn't have an attribute
     class MissingAttributeError < ::KeyError
-      def initialize(key)
-        super("Missing attribute: #{key.inspect}")
+      def initialize(attribute:, klass:)
+        super("Missing attribute: #{attribute.inspect} on #{klass}")
       end
     end
 
@@ -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/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 column_name.to_s
+            pp.text "="
             pp.pp column_value
           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/hashify.rb

@@ -9,11 +9,11 @@ module Dry
       # @return [Hash, Array]
       def self.[](value)
         if value.is_a?(Struct)
-          value.to_h.transform_values { |current| self[current] }
+          value.to_h.transform_values { self[_1] }
         elsif value.respond_to?(:to_hash)
-          value.to_hash.transform_values { |current| self[current] }
+          value.to_hash.transform_values { self[_1] }
         elsif value.respond_to?(:to_ary)
-          value.to_ary.map { |item| self[item] }
+          value.to_ary.map { self[_1] }
         else
           value
         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,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'dry/struct/compiler'
-
 module Dry
   class Struct
     # @private
@@ -14,9 +12,10 @@ module Dry
       end
 
       # @param [Symbol|String] attr_name the name of the nested type
-      # @param [Dry::Struct,Dry::Types::Type::Array,Undefined] type the superclass of the nested struct
+      # @param [Dry::Struct,Dry::Types::Type::Array,Undefined] type the superclass
+      #                                                        of the nested struct
       # @yield the body of the nested struct
-      def call(attr_name, type, &block)
+      def call(attr_name, type, &)
         const_name = const_name(type, attr_name)
         check_name(const_name)
 
@@ -28,12 +27,15 @@ module Dry
             schema builder.struct.schema.clear
           end
 
-          class_exec(&block)
+          class_exec(&)
         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 +43,19 @@ module Dry
 
       private
 
+      def type?(type) = type.is_a?(Types::Type)
+
       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?
+
       def parent(type)
         if array?(type)
           visit(type.to_ast)
+        elsif optional?(type)
+          type.right
         else
           type
         end
@@ -65,10 +73,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)
@@ -81,9 +91,7 @@ module Dry
         visit(member)
       end
 
-      def visit_nominal(*)
-        Undefined
-      end
+      def visit_nominal(*) = Undefined
 
       def visit_constructor(node)
         definition, * = node

data/lib/dry/struct/sum.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require 'dry/types/sum'
-require 'dry/types/printer'
-
 module Dry
   class Struct
     # A sum type of two or more structs
@@ -17,11 +14,11 @@ module Dry
 
       # @param [Hash{Symbol => Object},Dry::Struct] input
       # @yieldparam [Dry::Types::Result::Failure] failure
-      # @yieldreturn [Dry::Types::ResultResult]
+      # @yieldreturn [Dry::Types::Result]
       # @return [Dry::Types::Result]
       def try(input)
         if input.is_a?(Struct)
-          try_struct(input) { super }
+          ::Dry::Types::Result::Success.new(try_struct(input) { return super })
         else
           super
         end
@@ -31,7 +28,7 @@ module Dry
       # @param [Dry::Types::Type] type
       # @return [Dry::Types::Sum]
       def |(type)
-        if type.is_a?(Class) && type <= Struct || type.is_a?(Sum)
+        if (type.is_a?(::Class) && type <= Struct) || type.is_a?(Sum)
           Sum.new(self, type)
         else
           super
@@ -39,16 +36,14 @@ module Dry
       end
 
       # @return [boolean]
-      def ===(value)
-        left === value || right === value
-      end
+      def ===(value) = left === value || right === value
 
       protected
 
       # @private
-      def try_struct(input)
+      def try_struct(input, &)
         left.try_struct(input) do
-          right.try_struct(input) { yield }
+          right.try_struct(input, &)
         end
       end
     end

data/lib/dry/struct/value.rb

@@ -1,11 +1,10 @@
 # frozen_string_literal: true
 
-require 'ice_nine'
-require 'dry/core/deprecations'
+require "ice_nine"
 
 module Dry
   class Struct
-    extend Core::Deprecations[:'dry-struct']
+    extend Core::Deprecations[:"dry-struct"]
 
     # {Value} objects behave like {Struct}s but *deeply frozen*
     # using [`ice_nine`](https://github.com/dkubb/ice_nine)
@@ -30,9 +29,7 @@ module Dry
       # @param (see ClassInterface#new)
       # @return [Value]
       # @see https://github.com/dkubb/ice_nine
-      def self.new(*)
-        ::IceNine.deep_freeze(super)
-      end
+      def self.new(*) = ::IceNine.deep_freeze(super)
     end
 
     deprecate_constant :Value

data/lib/dry/struct/version.rb

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

data/lib/dry/struct.rb

@@ -1,16 +1,13 @@
 # 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 "weakref"
+
+require "dry/core"
+require "dry/types"
+
+require "dry/struct/class_interface"
+require "dry/struct/errors"
+require "dry/struct/version"
 
 module Dry
   # Constructor method for easily creating a {Dry::Struct}.
@@ -30,10 +27,10 @@ module Dry
   #   Test = Dry.Struct(expected: Types::String) { schema(schema.strict) }
   #   Test[expected: "foo", unexpected: "bar"]
   #   #=> Dry::Struct::Error: [Test.new] unexpected keys [:unexpected] in Hash input
-  def self.Struct(attributes = Dry::Core::Constants::EMPTY_HASH, &block)
+  def self.Struct(attributes = Dry::Core::Constants::EMPTY_HASH, &)
     Class.new(Dry::Struct) do
       attributes.each { |a, type| attribute a, type }
-      module_eval(&block) if block
+      module_eval(&) if block_given?
     end
   end
 
@@ -88,21 +85,35 @@ module Dry
     extend Core::Extensions
     include Core::Constants
     extend ClassInterface
-    extend Core::Deprecations[:'dry-struct']
+    extend Core::Deprecations[:"dry-struct"]
 
     class << self
       # override `Dry::Types::Builder#prepend`
       define_method(:prepend, ::Module.method(:prepend))
+
+      def loader
+        @loader ||= ::Zeitwerk::Loader.new.tap do |loader|
+          root = ::File.expand_path("..", __dir__)
+          loader.tag = "dry-struct"
+          loader.inflector = ::Zeitwerk::GemInflector.new("#{root}/dry-struct.rb")
+          loader.push_dir(root)
+          loader.ignore(
+            "#{root}/dry-struct.rb",
+            "#{root}/dry/struct/{class_interface,errors,extensions,printer,value,version}.rb",
+            "#{root}/dry/struct/extensions"
+          )
+        end
+      end
     end
 
-    autoload :Value, 'dry/struct/value'
+    loader.setup
 
     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 +145,13 @@ 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) do
+        if self.class.attribute_names.include?(name)
+          nil
+        else
+          raise MissingAttributeError.new(attribute: name, klass: self.class)
+        end
+      end
     end
 
     # Converts the {Dry::Struct} to a hash with keys representing
@@ -159,8 +176,8 @@ module Dry
         result[key.name] = Hashify[self[key.name]] if attributes.key?(key.name)
       end
     end
+    # TODO: remove in 2.0
     alias_method :to_hash, :to_h
-    # deprecate :to_hash, :to_h, message: "Implicit convertion structs to hashes is deprecated. Use .to_h"
 
     # Create a copy of {Dry::Struct} with overriden attributes
     #
@@ -183,10 +200,14 @@ module Dry
     #   rom_n_roda.new(subtitle: '3rd edition')
     #     #=> #<Book title="Web Development with ROM and Roda" subtitle="3rd edition">
     def new(changeset)
-      new_attributes = self.class.schema.apply(changeset, skip_missing: true, resolve_defaults: false)
+      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 +218,13 @@ module Dry
       "#<#{klass.name || klass.inspect}#{attrs}>"
     end
 
-    if RUBY_VERSION >= '2.7'
-      # Pattern matching support
-      #
-      # @api private
-      def deconstruct_keys(keys)
-        attributes
-      end
-    end
+    # Pattern matching support
+    #
+    # @api private
+    def deconstruct_keys(_keys) = attributes
   end
 end
 
-require 'dry/struct/extensions'
-require 'dry/struct/printer'
+require "dry/struct/extensions"
+require "dry/struct/printer"
+require "dry/struct/value"

data/lib/dry-struct.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-struct
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Piotr Solnica
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-10 00:00:00.000000000 Z
+date: 2025-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-core
@@ -16,48 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.4.4
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-    - - ">="
-      - !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'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: dry-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: ice_nine
   requirement: !ruby/object:Gem::Requirement
@@ -73,61 +53,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.11'
 - !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: yard
+  name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '2.6'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.6'
 description: Typed structs and value objects
 email:
 - piotr.solnica@gmail.com
@@ -158,10 +96,11 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  changelog_uri: https://github.com/dry-rb/dry-struct/blob/master/CHANGELOG.md
+  changelog_uri: https://github.com/dry-rb/dry-struct/blob/main/CHANGELOG.md
   source_code_uri: https://github.com/dry-rb/dry-struct
   bug_tracker_uri: https://github.com/dry-rb/dry-struct/issues
-post_install_message: 
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -169,15 +108,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.27
+signing_key:
 specification_version: 4
 summary: Typed structs and value objects
 test_files: []