dry-struct 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3309e15a4b8084a8ddb210a4d62e51e063a54f0aec56f41398f41824bbfe687
-  data.tar.gz: 05de1a1085a1753cd22f6f42a459de2245a544fe6ab822dff2bae228fe91da45
+  metadata.gz: fd8d3f0f41192daff14ed892da9e9a86e3dddefc4f7f94f26f58e1d091257532
+  data.tar.gz: 88d94467b25ec8f3a0e6f897232829ffbfb1ee3a1c1ec331e60ce3d5c386cb72
 SHA512:
-  metadata.gz: 16f8476d1362fa11871db6be02787e8b106795ca5d4a1ebeb1c796cc22abcd5ee0c0cf8f7985191a180dcfb38a1679535be4ff13003e0b08459072a2b236e288
-  data.tar.gz: e8973dbc9cc1fc0033751299ac366504c047cd996e9e9c5718ecad6e2d4bf2cdb734d46fd76f99c074a7982cb8cff6f9085a18725a01b21ea6e42475218f06e5
+  metadata.gz: a3d3a0a161d2a81053e7081a1d2deeead9a565c64a432350145c79083c58e400a8ed984e70b06388128c615d335cbccb29cb43b48f2669830bbf238064965c9e
+  data.tar.gz: 4c6a1a4c1a47f7b941e33c10ad515ce96247bae7e916088863a56c8c1104de5e4344b7314150eeb774627778c76fb79b6f209ba554627786a02ec918f7cf43df

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 <!--- 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
 
 

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2022 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,29 +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=main)][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](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.7.0`
-* jruby `>= 9.3` (postponed until 2.7 is supported)
+* MRI `>= 3.1`
+* jruby `>= 9.4` (not tested on CI)
 
 ## License
 

data/dry-struct.gemspec

@@ -21,21 +21,17 @@ Gem::Specification.new do |spec|
   spec.executables   = []
   spec.require_paths = ["lib"]
 
-  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["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.7.0"
+  spec.required_ruby_version = ">= 3.1.0"
 
   # to update dependencies edit project.yml
-  spec.add_runtime_dependency "dry-core", "~> 1.0", "< 2"
-  spec.add_runtime_dependency "dry-types", ">= 1.7", "< 2"
-  spec.add_runtime_dependency "ice_nine", "~> 0.11"
-  spec.add_runtime_dependency "zeitwerk", "~> 2.6"
-
-  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

@@ -11,15 +11,6 @@ module Dry
       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.
       #
@@ -92,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
@@ -121,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
 
@@ -145,10 +136,10 @@ 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, "\
+            "Dry::Struct.attribute? is deprecated for checking attribute presence, " \
             "use has_attribute? instead",
             tag: :"dry-struct"
           )
@@ -157,7 +148,7 @@ module Dry
         else
           name, * = args
 
-          attribute(:"#{name}?", build_type(*args, &block))
+          attribute(:"#{name}?", build_type(*args, &))
         end
       end
 
@@ -189,8 +180,7 @@ module Dry
 
         @attribute_names = nil
 
-        direct_descendants = descendants.select { |d| d.superclass == self }
-        direct_descendants.each do |d|
+        subclasses.each do |d|
           inherited_attrs = new_schema.reject { |k, _| d.has_attribute?(k.to_s.chomp("?").to_sym) }
           d.attributes(inherited_attrs)
         end
@@ -246,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) # rubocop:disable Style/OptionalBooleanParameter
+      def new(attributes = default_attributes, safe = false, &) # rubocop:disable Style/OptionalBooleanParameter
         if attributes.is_a?(Struct)
           if equal?(attributes.class)
             attributes
@@ -256,7 +246,7 @@ 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 })
@@ -268,11 +258,11 @@ module Dry
       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
 
@@ -323,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] 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
@@ -375,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
       #
@@ -455,11 +427,11 @@ 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`"
@@ -468,26 +440,32 @@ module Dry
             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, __FILE__, __LINE__ + 1)
-            def #{key}                      # def email
-              @attributes[#{key.inspect}]   #   @attributes[:email]
-            end                             # 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/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
 

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/struct_builder.rb

@@ -15,7 +15,7 @@ module Dry
       # @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)
 
@@ -27,7 +27,7 @@ module Dry
             schema builder.struct.schema.clear
           end
 
-          class_exec(&block)
+          class_exec(&)
         end
 
         struct.const_set(const_name, new_type)
@@ -43,17 +43,13 @@ module Dry
 
       private
 
-      def type?(type)
-        type.is_a?(Types::Type)
-      end
+      def type?(type) = type.is_a?(Types::Type)
 
       def array?(type)
         type?(type) && !type.optional? && type.primitive.equal?(::Array)
       end
 
-      def optional?(type)
-        type?(type) && type.optional?
-      end
+      def optional?(type) = type?(type) && type.optional?
 
       def parent(type)
         if array?(type)
@@ -95,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

@@ -18,7 +18,7 @@ module Dry
       # @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
@@ -28,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
@@ -36,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, &block)
+      def try_struct(input, &)
         left.try_struct(input) do
-          right.try_struct(input, &block)
+          right.try_struct(input, &)
         end
       end
     end

data/lib/dry/struct/value.rb

@@ -29,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.6.0"
+    VERSION = "1.7.0"
   end
 end

data/lib/dry/struct.rb

@@ -27,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
 
@@ -145,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, 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
@@ -215,9 +221,7 @@ module Dry
     # Pattern matching support
     #
     # @api private
-    def deconstruct_keys(_keys)
-      attributes
-    end
+    def deconstruct_keys(_keys) = attributes
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-struct
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Piotr Solnica
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-04 00:00:00.000000000 Z
+date: 2025-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-core
@@ -16,40 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: dry-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.7'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.7'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: ice_nine
   requirement: !ruby/object:Gem::Requirement
@@ -78,62 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.6'
-- !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
-  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'
 description: Typed structs and value objects
 email:
 - piotr.solnica@gmail.com
@@ -167,7 +99,8 @@ metadata:
   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
@@ -175,15 +108,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.3.27
+signing_key:
 specification_version: 4
 summary: Typed structs and value objects
 test_files: []