contracted_value 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1955c7fa4eaf8ae64db37e57575a6da241315ebd5855d72097e8e175292d0ee3
-  data.tar.gz: d34b3b78b78e7e27466468851e96968293e978cadfc40104e3a67425e69eb4a5
+  metadata.gz: 26c83184ecb824d29bc3d258555f6f915d0478e7e1d5e8dde8bf8a21935b69a4
+  data.tar.gz: 73caf82b999e6e65cd158316982f5051a19f219eabe85e96434c98be72d973ca
 SHA512:
-  metadata.gz: 125f0ff78bdf35d47b2fd7400ebb93db3a249d0b04abe1462394b732ad1d804326d7d89c7b04e0d3ca28cb738bc1f350a5091d2ae559490cfea468b864a1d03d
-  data.tar.gz: 184cd1009cbd96af31d5fce7c075c483ce4762fc77936843c66a13df2c43b0aa95e70fe14e5e7c8ddaea1ebaf6a85084fc0345479af1e2a273cab6ca8942f64d
+  metadata.gz: b712d12af9079d88a5d44c56aaad07fa8e29ae56bed4f37f6fdcd5f36ab2c1e392e1afc56b1e84e98ef9d621a16843ca407dc31002345761c74e16e2301654cc
+  data.tar.gz: eece1cec55a0e03b15da9c7c97d4b8dc5aa55f3e7138ecc5448a2f0b36bcc73da5f6e0b245f4c1d03819342cdee0c39de2c8516afeae47d671bb8db841d8af80

data/.github/workflows/coverage.yml

@@ -6,11 +6,13 @@ on:
       - master
     paths-ignore:
       - 'README.md'
+      - 'CHANGELOG.md'
   push:
     branches:
       - master
     paths-ignore:
       - 'README.md'
+      - 'CHANGELOG.md'
 
 jobs:
   coverage:
@@ -24,7 +26,8 @@ jobs:
         os:
           - ubuntu-latest
         ruby:
-          - "3.2"
+          - "3.4"
+          - "4.0"
         gemfile:
           - gemfiles/contracts_17_0.gemfile
     env:
@@ -33,7 +36,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
 
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1

data/.github/workflows/tests.yaml

@@ -6,11 +6,13 @@ on:
       - master
     paths-ignore:
       - 'README.md'
+      - 'CHANGELOG.md'
   push:
     branches:
       - master
     paths-ignore:
       - 'README.md'
+      - 'CHANGELOG.md'
 
 jobs:
   unit_tests:
@@ -24,9 +26,11 @@ jobs:
         os:
           - ubuntu-latest
         ruby:
-          - "3.0"
           - "3.1"
           - "3.2"
+          - "3.3"
+          - "3.4"
+          - "4.0"
         gemfile:
           - gemfiles/contracts_17_0.gemfile
         allow_failures:
@@ -43,7 +47,7 @@ jobs:
     continue-on-error: ${{ endsWith(matrix.ruby, 'head') || matrix.ruby == 'debug' }}
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1
         with:

data/CHANGELOG.md

@@ -4,6 +4,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 
 ## [Unreleased]
+[Unreleased]: https://github.com/PikachuEXE/contracted_value/compare/v0.2.0...master
 
 ### Added
 
@@ -18,7 +19,26 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - Nothing
 
 
-## [0.1.2]
+## [0.2.0] - 2026-04-29
+[0.2.0]: https://github.com/PikachuEXE/contracted_value/releases/tag/v0.2.0
+
+### Added
+
+- Add feature detect_unexpected_keys
+  (https://github.com/PikachuEXE/contracted_value/pull/9)
+
+
+## [0.1.3] - 2023-10-11
+[0.1.3]: https://github.com/PikachuEXE/contracted_value/releases/tag/v0.1.3
+
+### Fixed
+
+- Revert `Make code "Object Shape friendly"`
+  Strange issue discovered in an app in production environment
+
+
+## [0.1.2] - 2023-10-11
+[0.1.2]: https://github.com/PikachuEXE/contracted_value/releases/tag/v0.1.2
 
 ### Changed
 
@@ -27,7 +47,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
   (https://github.com/PikachuEXE/contracted_value/pull/5)
 
 
-## [0.1.1]
+## [0.1.1] - 2022-09-07
+[0.1.1]: https://github.com/PikachuEXE/contracted_value/releases/tag/v0.1.1
 
 ### Changed
 
@@ -38,11 +59,9 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - Fix Ruby 3.x compatibility
 
 
-## 0.1.0 - 2019-06-05
+## [0.1.0] - 2019-06-05
+[0.1.0]: https://github.com/PikachuEXE/contracted_value/releases/tag/v0.1.0
 
 ### Added
 
 - Initial release
-
-[0.1.2]: https://github.com/PikachuEXE/contracted_value/compare/v0.1.1...v0.1.2
-[0.1.1]: https://github.com/PikachuEXE/contracted_value/compare/v0.1.0...v0.1.1

data/README.md

@@ -247,6 +247,35 @@ WhatIsThis::Entry.new(
 ).something_optional # => nil
 ```
 
+#### Unexpected keys
+Call `detect_unexpected_keys` to detect unexpected keys by raising error  
+It's off by default  
+
+
+```ruby
+module ::WhatIsThis
+  class Entry < ::ContractedValue::Value
+    include ::Contracts::Core
+    include ::Contracts::Builtin
+
+    detect_unexpected_keys
+
+    attribute(
+      :something_required,
+    )
+    attribute(
+      :something_optional,
+      default_value: nil,
+    )
+  end
+end
+
+WhatIsThis::Entry.new(
+  something_required: 123,
+  something_unexpected: "whatever",
+) # => error
+```
+
 
 ### Object Freezing
 All input values are frozen using [`ice_nine`](https://github.com/dkubb/ice_nine) by default  
@@ -353,6 +382,10 @@ Pikachu.new.name.frozen? # => true, as mentioned above default value are always
 Pikachu.new(name: "Pikaaaachuuu").name.frozen? # => false
 ```
 
+#### `detect_unexpected_keys` inherited
+If parent class already called `detect_unexpected_keys`, all children classes would have it enabled too  
+Otherwise you can call `detect_unexpected_keys` in child class(es) without affecting parent class  
+
 
 ## Related gems
 Here is a list of gems which I found and I have tried some of them.  

data/Rakefile

@@ -7,7 +7,7 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-if !ENV["APPRAISAL_INITIALIZED"] && !ENV["TRAVIS"]
+if !ENV["APPRAISAL_INITIALIZED"] && !ENV["CI"]
   task :default do
     sh "appraisal install && rake appraisal spec"
   end

data/contracted_value.gemspec

@@ -38,7 +38,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "appraisal", "~> 2.0", ">= 2.5.0"
 
   s.add_development_dependency "rspec", "~> 3.0"
-  s.add_development_dependency "rspec-its", "~> 1.0"
+  s.add_development_dependency "rspec-its", "~> 2.0"
 
   s.add_development_dependency "simplecov", ">= 0.21"
   s.add_development_dependency "simplecov-lcov", ">= 0.8"
@@ -52,4 +52,8 @@ Gem::Specification.new do |s|
   s.required_ruby_version = ">= 3.0.0"
 
   s.required_rubygems_version = ">= 1.4.0"
+
+  # requiring all owners to enable MFA on their account
+  # https://guides.rubygems.org/mfa-requirement-opt-in/
+  s.metadata["rubygems_mfa_required"] = "true"
 end

data/lib/contracted_value/core.rb

@@ -79,6 +79,16 @@ module ContractedValue
         )
       end
     end
+
+    class UnexpectedInputKeys < ArgumentError
+      def initialize(keys)
+        super(
+          <<~MSG
+            Unexpected key(s) #{keys.map{|key| ":#{key}" }.join(", ")} detected in input
+          MSG
+        )
+      end
+    end
   end
 
   module Private
@@ -112,6 +122,10 @@ module ContractedValue
       end
     end
 
+    def detect_unexpected_keys(hash)
+      hash.keys - attr_names
+    end
+
     protected
 
     def merge!(other_attr_set)
@@ -238,9 +252,8 @@ module ContractedValue
           )
         end
 
-      @attr_values = {}
-
-      self.class.send(:attribute_set).each_attribute do |attribute|
+      attribute_set = self.class.send(:attribute_set)
+      attribute_set.each_attribute do |attribute|
         attr_value = attribute.extract_value(input_attr_values_hash)
 
         sometimes_frozen_attr_value =
@@ -262,27 +275,48 @@ module ContractedValue
 
         # Using symbol since attribute names are limited in number
         # An alternative would be using frozen string
-        @attr_values.store(
-          attribute.name.to_sym,
+        instance_variable_set(
+          :"@#{attribute.name}",
           sometimes_frozen_attr_value,
         )
       end
 
+      if self.class.send(:should_detect_unexpected_keys)
+        unexpected_keys = attribute_set.detect_unexpected_keys(input_attr_values_hash)
+        if unexpected_keys.any?
+          raise Errors::UnexpectedInputKeys.new(
+            unexpected_keys,
+          )
+        end
+      end
+
       freeze
     end
     # rubocop:enable Metrics/AbcSize
     # rubocop:enable Metrics/CyclomaticComplexity
 
     def to_h
-      @attr_values.clone
+      self.class.send(:attribute_set).
+        each_attribute.each_with_object({}) do |attribute, hash|
+          hash[attribute.name] = instance_variable_get(:"@#{attribute.name}")
+        end
     end
 
     # == Class interface == #
     class << self
-      def inherited(klass)
+      def inherited(child_klass)
         super
 
-        klass.instance_variable_set(:@attribute_set, AttributeSet.new)
+        child_klass.instance_variable_set(:@attribute_set, AttributeSet.new)
+        child_klass.instance_variable_set(
+          :@should_detect_unexpected_keys,
+          if child_klass.superclass.respond_to?(:should_detect_unexpected_keys, true)
+            child_klass.superclass.send(:should_detect_unexpected_keys)
+          else
+            false
+          end
+        )
+
       end
 
       private
@@ -306,7 +340,7 @@ module ContractedValue
         )
         @attribute_set = @attribute_set.add(attr)
 
-        define_method(name_in_sym) { @attr_values[name_in_sym] }
+        attr_reader(name_in_sym)
       end
 
       # @api private
@@ -325,6 +359,14 @@ module ContractedValue
         # @attribute_set would be nil
         super_attribute_set.merge(@attribute_set || AttributeSet.new)
       end
+
+      # @api
+      def detect_unexpected_keys
+        @should_detect_unexpected_keys = true
+      end
+
+      # @api private
+      attr_reader :should_detect_unexpected_keys
     end
     # == Class interface == #
   end

data/lib/contracted_value/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ContractedValue
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/spec/contracted_value/value_spec.rb

@@ -48,12 +48,13 @@ require "spec_helper"
       }.to_not raise_error
     end
 
-    example "does not raise error when declaring 1 attribute with number name" do
+    example "does raise error when declaring 1 attribute with number name" do
       expect {
         value_class.class_eval do
           attribute(1)
         end
-      }.to raise_error(::NoMethodError, /undefined method `to_sym'/)
+      }.to raise_error(::NoMethodError, /undefined method `to_sym'|undefined method 'to_sym'/)
+      # ruby 3.4+ uses different quotes
     end
   end
 
@@ -83,6 +84,12 @@ require "spec_helper"
           }
         end
 
+        let(:inputs_with_extra) do
+          default_inputs.merge(
+            attribute_3: 1,
+          )
+        end
+
         let(:non_hash) do
           []
         end
@@ -156,6 +163,30 @@ require "spec_helper"
             end
           end
         end
+
+        it "does not raise error when extra attribute is input" do
+          aggregate_failures do
+            expect {
+              value_class.new(
+                inputs_with_extra,
+              )
+            }.to_not raise_error
+          end
+        end
+
+        it "does not raise error when extra attribute is input" do
+          aggregate_failures do
+            value_class.class_eval do
+              detect_unexpected_keys
+            end
+
+            expect {
+              value_class.new(
+                inputs_with_extra,
+              )
+            }.to raise_error(::ContractedValue::Errors::UnexpectedInputKeys)
+          end
+        end
       end
 
       context "with class with some attributes declared with contract" do
@@ -621,6 +652,7 @@ require "spec_helper"
             end
             child_value_class.new(attribute_1: "")
           }.to raise_error(::ContractedValue::Errors::InvalidAttributeValue)
+          # Note that the error above is for the input not the attribute declaration
         end
 
         example "does not raise error when declaring existing attribute with different default_value" do
@@ -651,6 +683,66 @@ require "spec_helper"
 
     end
 
+    describe "for detect_unexpected_keys" do
+      let(:child_value_class) do
+        Class.new(parent_value_class)
+      end
+
+      context "when detect_unexpected_keys declared inside parent class" do
+        let(:parent_value_class) do
+          Class.new(described_class).tap do |klass|
+            klass.class_eval do
+              detect_unexpected_keys
+
+              # Too lazy to include parent attributes in all examples
+              attribute(:attribute_1)
+            end
+          end
+        end
+
+        it "does raise error on parent class object" do
+          expect {
+            parent_value_class.new(attribute_1: 1, attribute_2: 2)
+          }.to raise_error(::ContractedValue::Errors::UnexpectedInputKeys)
+        end
+
+        it "does raise error on child class object" do
+          expect {
+            child_value_class.new(attribute_1: 1, attribute_2: 2)
+          }.to raise_error(::ContractedValue::Errors::UnexpectedInputKeys)
+        end
+      end
+
+      context "when detect_unexpected_keys declared inside child class" do
+        let(:parent_value_class) do
+          Class.new(described_class).tap do |klass|
+            klass.class_eval do
+              # Too lazy to include parent attributes in all examples
+              attribute(:attribute_1)
+            end
+          end
+        end
+
+        before do
+          child_value_class.class_eval do
+            detect_unexpected_keys
+          end
+        end
+
+        it "does not raise error on parent class object" do
+          expect {
+            parent_value_class.new(attribute_1: 1, attribute_2: 2)
+          }.to_not raise_error
+        end
+
+        it "does raise error on child class object" do
+          expect {
+            child_value_class.new(attribute_1: 1, attribute_2: 2)
+          }.to raise_error(::ContractedValue::Errors::UnexpectedInputKeys)
+        end
+      end
+    end
+
   end
 
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: contracted_value
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - PikachuEXE
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-11 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: contracts
@@ -126,14 +125,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -238,8 +237,8 @@ files:
 homepage: http://github.com/PikachuEXE/contracted_value
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -254,8 +253,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.4.0
 requirements: []
-rubygems_version: 3.4.20
-signing_key:
+rubygems_version: 4.0.9
 specification_version: 4
 summary: Contracted immutable(by default) value objects
 test_files: