Merge pull request #194 from dry-rb/do-not-raise-on-optional-keys

Update `Struct#[]` to return nil for unset optional attributes

Author: flash-gordon

changelog.yml

@@ -11,6 +11,9 @@
   - '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)'
 - version: 1.6.0
   date: 2022-11-04
   changed:

lib/dry/struct.rb

@@ -146,7 +146,11 @@ def initialize(attributes)
     #   rom_n_roda[:subtitle] #=> nil
     def [](name)
       @attributes.fetch(name) do
-        raise MissingAttributeError.new(attribute: name, klass: self.class)
+        if self.class.attribute_names.include?(name)
+          nil
+        else
+          raise MissingAttributeError.new(attribute: name, klass: self.class)
+        end
       end
     end
 

spec/integration/struct_spec.rb

@@ -356,6 +356,19 @@ class Task < Dry::Struct
         .with_message("Missing attribute: :name on Test::Task")
     end
 
+    describe "optional attributes" do
+      before do
+        class Test::Task
+          attribute :name?, "string"
+        end
+      end
+
+      it "returns nil if the attribute is not set" do
+        value = Test::Task[user: "Jane"]
+        expect(value[:name]).to be_nil
+      end
+    end
+
     describe "protected methods" do
       before do
         class Test::Task