contracted_value 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 761fdc9b4b487bb54d59724fa87a6e2e3ca1665cae0774bc2f7cdcf50d076913
-  data.tar.gz: c051835f898ce826968eb7616fc414ffeff3677926b48d001904528432354a88
+  metadata.gz: 1955c7fa4eaf8ae64db37e57575a6da241315ebd5855d72097e8e175292d0ee3
+  data.tar.gz: d34b3b78b78e7e27466468851e96968293e978cadfc40104e3a67425e69eb4a5
 SHA512:
-  metadata.gz: a6d714074711c3d1ef3856e15cf2ba4e0035f90c493cdebe485d90aef52990f8b03d0055c0a96d7f34ccbbc1b230e0f905ea7baf8258200e739ec0bdd0b3cb87
-  data.tar.gz: 7543ae38d5eddb8b0304a7171caec91b4472b66210752c79783b481ee07b32b34924d122db46cf90442ed6127fe4055d862224b3c49b1f0c33b1d07fb53753cc
+  metadata.gz: 125f0ff78bdf35d47b2fd7400ebb93db3a249d0b04abe1462394b732ad1d804326d7d89c7b04e0d3ca28cb738bc1f350a5091d2ae559490cfea468b864a1d03d
+  data.tar.gz: 184cd1009cbd96af31d5fce7c075c483ce4762fc77936843c66a13df2c43b0aa95e70fe14e5e7c8ddaea1ebaf6a85084fc0345479af1e2a273cab6ca8942f64d

data/.github/workflows/coverage.yml

@@ -24,16 +24,16 @@ jobs:
         os:
           - ubuntu-latest
         ruby:
-          - "2.7"
+          - "3.2"
         gemfile:
-          - gemfiles/contracts_16_0.gemfile
+          - gemfiles/contracts_17_0.gemfile
     env:
       BUNDLE_GEMFILE: ${{ matrix.gemfile }}
       COVERALLS: true
     runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1

data/.github/workflows/tests.yaml

@@ -26,15 +26,12 @@ jobs:
         ruby:
           - "3.0"
           - "3.1"
+          - "3.2"
         gemfile:
           - gemfiles/contracts_17_0.gemfile
         allow_failures:
           - false
         include:
-          - os: ubuntu-latest
-            ruby: "2.7"
-            gemfile: gemfiles/contracts_16_0.gemfile
-            allow_failures: false
           - os: ubuntu-latest
             ruby: "ruby-head"
             gemfile: gemfiles/contracts_17_0.gemfile
@@ -46,7 +43,7 @@ jobs:
     continue-on-error: ${{ endsWith(matrix.ruby, 'head') || matrix.ruby == 'debug' }}
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1
         with:

data/Appraisals

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-appraise "contracts_16_0" do
-  gem "contracts", "~> 0.16.0"
+appraise "contracts_17_0" do
+  gem "contracts", "~> 0.17.0"
 end

data/CHANGELOG.md

@@ -18,7 +18,16 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - Nothing
 
 
-## [Unreleased]
+## [0.1.2]
+
+### Changed
+
+- Requires Ruby 3.0, contracts >= 0.17 (Ruby 2.7 EOL)
+- Make code "Object Shape friendly"
+  (https://github.com/PikachuEXE/contracted_value/pull/5)
+
+
+## [0.1.1]
 
 ### Changed
 
@@ -35,4 +44,5 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 - Initial release
 
-[Unreleased]: https://github.com/PikachuEXE/contracted_value/compare/v0.1.0...HEAD
+[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

@@ -11,7 +11,7 @@ See details explanation in below sections
 
 ## Status
 
-[![GitHub Build Status](https://img.shields.io/github/workflow/status/PikachuEXE/contracted_value/Tests?style=flat-square)](https://github.com/PikachuEXE/contracted_value/actions?query=workflow%3ATests)
+[![GitHub Build Status](https://img.shields.io/github/actions/workflow/status/PikachuEXE/contracted_value/tests.yaml?branch=master&style=flat-square)](https://github.com/PikachuEXE/contracted_value/actions/workflows/tests.yaml)
 
 [![Gem Version](http://img.shields.io/gem/v/contracted_value.svg?style=flat-square)](http://badge.fury.io/rb/contracted_value)
 [![License](https://img.shields.io/github/license/PikachuEXE/contracted_value.svg?style=flat-square)](http://badge.fury.io/rb/contracted_value)

data/contracted_value.gemspec

@@ -12,9 +12,9 @@ Gem::Specification.new do |s|
   s.platform      = Gem::Platform::RUBY
   s.name          = gem_name
   s.version       = ContractedValue::VERSION
-  s.summary       = "Some Tweaks for ActiveRecord"
+  s.summary       = "Contracted immutable(by default) value objects"
   s.description   = <<-DOC
-    ActiveRecord is great, but could be better. Here are some tweaks for it.
+    Library for creating contracted immutable(by default) value objects supported by contracts.ruby & ice_nine
   DOC
 
   s.license       = "MIT"
@@ -28,14 +28,14 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency "contracts", "~> 0.15"
+  s.add_dependency "contracts", "~> 0.17"
   s.add_dependency "ice_nine"
 
   s.add_development_dependency "bundler", ">= 1.0.0"
   s.add_development_dependency "rake", ">= 10.0", "<= 14.0"
   s.add_development_dependency "pry"
 
-  s.add_development_dependency "appraisal", "~> 2.0"
+  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"
@@ -49,7 +49,7 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency "rubocop", ">= 0.70"
 
-  s.required_ruby_version = ">= 2.7.0"
+  s.required_ruby_version = ">= 3.0.0"
 
   s.required_rubygems_version = ">= 1.4.0"
 end

data/lib/contracted_value/core.rb

@@ -182,10 +182,17 @@ module ContractedValue
     attr_reader :default_value
 
     def raise_error_if_inputs_invalid
+      raise_error_if_name_invalid
       raise_error_if_refrigeration_mode_invalid
       raise_error_if_default_value_invalid
     end
 
+    def raise_error_if_name_invalid
+      return if name.is_a?(Symbol)
+
+      raise NotImplementedError, "Internal error: name is not a symbol (#{name.class.name})"
+    end
+
     def raise_error_if_refrigeration_mode_invalid
       return if RefrigerationMode::Enum.all.include?(refrigeration_mode)
 
@@ -231,6 +238,8 @@ module ContractedValue
           )
         end
 
+      @attr_values = {}
+
       self.class.send(:attribute_set).each_attribute do |attribute|
         attr_value = attribute.extract_value(input_attr_values_hash)
 
@@ -253,8 +262,8 @@ module ContractedValue
 
         # Using symbol since attribute names are limited in number
         # An alternative would be using frozen string
-        instance_variable_set(
-          :"@#{attribute.name}",
+        @attr_values.store(
+          attribute.name.to_sym,
           sometimes_frozen_attr_value,
         )
       end
@@ -265,10 +274,7 @@ module ContractedValue
     # rubocop:enable Metrics/CyclomaticComplexity
 
     def to_h
-      self.class.send(:attribute_set).
-        each_attribute.each_with_object({}) do |attribute, hash|
-          hash[attribute.name] = instance_variable_get(:"@#{attribute.name}")
-        end
+      @attr_values.clone
     end
 
     # == Class interface == #
@@ -288,16 +294,19 @@ module ContractedValue
         refrigeration_mode: RefrigerationMode::Enum::DEEP,
         default_value: Private::ATTR_DEFAULT_VALUE_ABSENT_VAL
       )
+        # Using symbol since attribute names are limited in number
+        # An alternative would be using frozen string
+        name_in_sym = name.to_sym
 
         attr = Attribute.new(
-          name: name,
+          name: name_in_sym,
           contract: contract,
           refrigeration_mode: refrigeration_mode,
           default_value: default_value,
         )
         @attribute_set = @attribute_set.add(attr)
 
-        attr_reader(name)
+        define_method(name_in_sym) { @attr_values[name_in_sym] }
       end
 
       # @api private

data/lib/contracted_value/version.rb

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

data/spec/contracted_value/value_spec.rb

@@ -10,40 +10,50 @@ require "spec_helper"
     end
 
     example "does not raise error when NOT declaring any attribute" do
-      expect(->{ value_class }).to_not raise_error
+      expect { value_class }.to_not raise_error
     end
 
     example "does not raise error when declaring 1 attribute" do
-      expect(
-        ->{
-          value_class.class_eval do
-            attribute(:attribute_1)
-          end
-        },
-      ).to_not raise_error
+      expect {
+        value_class.class_eval do
+          attribute(:attribute_1)
+        end
+      }.to_not raise_error
     end
 
     example "does not raise error when declaring N attributes with different names" do
-      expect(
-        ->{
-          value_class.class_eval do
-            attribute(:attribute_1)
-            attribute(:attribute_2)
-          end
-        },
-      ).to_not raise_error
+      expect {
+        value_class.class_eval do
+          attribute(:attribute_1)
+          attribute(:attribute_2)
+        end
+      }.to_not raise_error
     end
 
     example "does raise error when declaring N attributes with the same name" do
-      expect(
-        ->{
-          value_class.class_eval do
-            attribute(:attribute_1)
-            attribute(:attribute_2)
-            attribute(:attribute_1)
-          end
-        },
-      ).to raise_error(::ContractedValue::Errors::DuplicateAttributeDeclaration)
+      expect {
+        value_class.class_eval do
+          attribute(:attribute_1)
+          attribute(:attribute_2)
+          attribute(:attribute_1)
+        end
+      }.to raise_error(::ContractedValue::Errors::DuplicateAttributeDeclaration)
+    end
+
+    example "does not raise error when declaring 1 attribute with string name" do
+      expect {
+        value_class.class_eval do
+          attribute("attribute_1")
+        end
+      }.to_not raise_error
+    end
+
+    example "does not 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'/)
     end
   end
 
@@ -79,39 +89,39 @@ require "spec_helper"
 
         it "does raise error when input is not a hash" do
           aggregate_failures do
-            expect(
-              ->{
-                value_class.new(
-                  non_hash,
-                )
-              },
-            ).to raise_error(::ContractedValue::Errors::InvalidInputType)
+            expect {
+              value_class.new(
+                non_hash,
+              )
+            }.to raise_error(::ContractedValue::Errors::InvalidInputType)
           end
         end
 
         it "does not raise error when input is a hash" do
           aggregate_failures do
-            expect(
-              ->{
-                value_class.new(
-                  default_inputs,
-                )
-              },
-            ).to_not raise_error
+            expect {
+              value_class.new(
+                default_inputs,
+              )
+            }.to_not raise_error
           end
         end
 
         it "does not raise error when input is a value" do
           aggregate_failures do
-            expect(
-              ->{
+            new_val = nil
+            expect {
+              new_val = value_class.new(
                 value_class.new(
-                  value_class.new(
-                    default_inputs,
-                  ),
-                )
-              },
-            ).to_not raise_error
+                  default_inputs,
+                ),
+              )
+            }.to_not raise_error
+            if new_val
+              default_inputs.each_pair do |attr_name, attr_val|
+                expect(new_val.public_send(attr_name)).to eq(attr_val)
+              end
+            end
           end
         end
 
@@ -121,13 +131,11 @@ require "spec_helper"
               :attribute_1,
               :attribute_2,
             ].each do |attr_name|
-              expect(
-                ->{
-                  value_class.new(
-                    default_inputs.dup.tap{|h| h.delete(attr_name)},
-                  )
-                },
-              ).to raise_error(::ContractedValue::Errors::MissingAttributeInput)
+              expect {
+                value_class.new(
+                  default_inputs.dup.tap{|h| h.delete(attr_name)},
+                )
+              }.to raise_error(::ContractedValue::Errors::MissingAttributeInput)
             end
           end
         end
@@ -138,15 +146,13 @@ require "spec_helper"
               :attribute_1,
               :attribute_2,
             ].each do |attr_name|
-              expect(
-                ->{
-                  value_class.new(
-                    default_inputs.each_with_object({}) do |(k, _v), h|
-                      h[k] = nil
-                    end
-                  )
-                },
-              ).to_not raise_error
+              expect {
+                value_class.new(
+                  default_inputs.each_with_object({}) do |(k, _v), h|
+                    h[k] = nil
+                  end
+                )
+              }.to_not raise_error
             end
           end
         end
@@ -175,36 +181,30 @@ require "spec_helper"
 
 
         it "does not raise error when all values are valid according to contracts" do
-          expect(
-            ->{
-              value_class.new(
-                default_inputs
-              )
-            },
-          ).to_not raise_error
+          expect {
+            value_class.new(
+              default_inputs
+            )
+          }.to_not raise_error
         end
 
         it "does raise error when any value is invalid according to contracts" do
           aggregate_failures do
-            expect(
-              ->{
-                value_class.new(
-                  default_inputs.merge(
-                    attribute_with_contract_1: "",
-                  ),
-                )
-              },
-            ).to raise_error(::ContractedValue::Errors::InvalidAttributeValue)
+            expect {
+              value_class.new(
+                default_inputs.merge(
+                  attribute_with_contract_1: "",
+                ),
+              )
+            }.to raise_error(::ContractedValue::Errors::InvalidAttributeValue)
 
-            expect(
-              ->{
-                value_class.new(
-                  default_inputs.merge(
-                    attribute_with_contract_2: 0,
-                  ),
-                )
-              },
-            ).to raise_error(::ContractedValue::Errors::InvalidAttributeValue)
+            expect {
+              value_class.new(
+                default_inputs.merge(
+                  attribute_with_contract_2: 0,
+                ),
+              )
+            }.to raise_error(::ContractedValue::Errors::InvalidAttributeValue)
           end
         end
       end
@@ -237,22 +237,18 @@ require "spec_helper"
         # Create it just before expectation
         value_object
 
-        expect(
-          ->{
-            hash_as_input[:a] = nil
-          },
-        ).to raise_error(::RuntimeError, /can't modify frozen/)
+        expect {
+          hash_as_input[:a] = nil
+        }.to raise_error(::RuntimeError, /can't modify frozen/)
       end
 
       it "does deeply freeze the inputs" do
         # Create it just before expectation
         value_object
 
-        expect(
-          ->{
-            hash_as_deep_nested_content[:a] = nil
-          },
-        ).to raise_error(::RuntimeError, /can't modify frozen/)
+        expect {
+          hash_as_deep_nested_content[:a] = nil
+        }.to raise_error(::RuntimeError, /can't modify frozen/)
       end
     end
 
@@ -265,22 +261,18 @@ require "spec_helper"
         # Create it just before expectation
         value_object
 
-        expect(
-          ->{
-            hash_as_input[:a] = nil
-          },
-        ).to raise_error(::RuntimeError, /can't modify frozen/)
+        expect {
+          hash_as_input[:a] = nil
+        }.to raise_error(::RuntimeError, /can't modify frozen/)
       end
 
       it "does not deeply freeze the inputs" do
         # Create it just before expectation
         value_object
 
-        expect(
-          ->{
-            hash_as_deep_nested_content[:a] = nil
-          },
-        ).to_not raise_error
+        expect {
+          hash_as_deep_nested_content[:a] = nil
+        }.to_not raise_error
       end
     end
 
@@ -293,22 +285,18 @@ require "spec_helper"
         # Create it just before expectation
         value_object
 
-        expect(
-          ->{
-            hash_as_input[:a] = nil
-          },
-        ).to_not raise_error
+        expect {
+          hash_as_input[:a] = nil
+        }.to_not raise_error
       end
 
       it "does not deeply freeze the inputs" do
         # Create it just before expectation
         value_object
 
-        expect(
-          ->{
-            hash_as_deep_nested_content[:a] = nil
-          },
-        ).to_not raise_error
+        expect {
+          hash_as_deep_nested_content[:a] = nil
+        }.to_not raise_error
       end
     end
 
@@ -533,11 +521,9 @@ require "spec_helper"
         end
 
         example "does not raise error" do
-          expect(
-            ->{
-              child_value_class.new(attribute_1: "wut")
-            },
-          ).to_not raise_error
+          expect {
+            child_value_class.new(attribute_1: "wut")
+          }.to_not raise_error
         end
 
       end
@@ -559,36 +545,30 @@ require "spec_helper"
         end
 
         example "does not raise error when declaring 1 new attribute" do
-          expect(
-            ->{
-              child_value_class.class_eval do
-                attribute(:attribute_3)
-              end
-            },
-          ).to_not raise_error
+          expect {
+            child_value_class.class_eval do
+              attribute(:attribute_3)
+            end
+          }.to_not raise_error
         end
 
         example "does not raise error when declaring N attributes with different names" do
-          expect(
-            ->{
-              child_value_class.class_eval do
-                attribute(:attribute_3)
-                attribute(:attribute_4)
-              end
-            },
-          ).to_not raise_error
+          expect {
+            child_value_class.class_eval do
+              attribute(:attribute_3)
+              attribute(:attribute_4)
+            end
+          }.to_not raise_error
         end
 
         example "does raise error when declaring N attributes with the same name" do
-          expect(
-            ->{
-              child_value_class.class_eval do
-                attribute(:attribute_3)
-                attribute(:attribute_4)
-                attribute(:attribute_3)
-              end
-            },
-          ).to raise_error(::ContractedValue::Errors::DuplicateAttributeDeclaration)
+          expect {
+            child_value_class.class_eval do
+              attribute(:attribute_3)
+              attribute(:attribute_4)
+              attribute(:attribute_3)
+            end
+          }.to raise_error(::ContractedValue::Errors::DuplicateAttributeDeclaration)
         end
 
       end
@@ -632,31 +612,27 @@ require "spec_helper"
         end
 
         example "does not raise error when declaring existing attribute with different contract" do
-          expect(
-            ->{
-              child_value_class.class_eval do
-                attribute(
-                  :attribute_1,
-                  contract: ::Contracts::Builtin::NatPos
-                )
-              end
-              child_value_class.new(attribute_1: "")
-            },
-          ).to raise_error(::ContractedValue::Errors::InvalidAttributeValue)
+          expect {
+            child_value_class.class_eval do
+              attribute(
+                :attribute_1,
+                contract: ::Contracts::Builtin::NatPos
+              )
+            end
+            child_value_class.new(attribute_1: "")
+          }.to raise_error(::ContractedValue::Errors::InvalidAttributeValue)
         end
 
         example "does not raise error when declaring existing attribute with different default_value" do
-          expect(
-            ->{
-              child_value_class.class_eval do
-                attribute(
-                  :attribute_1,
-                  default_value: nil,
-                )
-              end
-              child_value_class.new
-            },
-          ).to_not raise_error
+          expect {
+            child_value_class.class_eval do
+              attribute(
+                :attribute_1,
+                default_value: nil,
+              )
+            end
+            child_value_class.new
+          }.to_not raise_error
         end
 
         example "does not raise error when declaring existing attribute with different refrigeration_mode" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: contracted_value
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - PikachuEXE
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-07 00:00:00.000000000 Z
+date: 2023-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: contracts
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.17'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.17'
 - !ruby/object:Gem::Dependency
   name: ice_nine
   requirement: !ruby/object:Gem::Requirement
@@ -93,6 +93,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -100,6 +103,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -198,8 +204,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0.70'
-description: "    ActiveRecord is great, but could be better. Here are some tweaks
-  for it.\n"
+description: "    Library for creating contracted immutable(by default) value objects
+  supported by contracts.ruby & ice_nine\n"
 email:
 - pikachuexe@gmail.com
 executables: []
@@ -222,7 +228,6 @@ files:
 - README.md
 - Rakefile
 - contracted_value.gemspec
-- gemfiles/contracts_16_0.gemfile
 - gemfiles/contracts_17_0.gemfile
 - lib/contracted_value.rb
 - lib/contracted_value/core.rb
@@ -242,17 +247,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: 1.4.0
 requirements: []
-rubygems_version: 3.3.21
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
-summary: Some Tweaks for ActiveRecord
+summary: Contracted immutable(by default) value objects
 test_files:
 - spec/contracted_value/value_spec.rb
 - spec/contracted_value_spec.rb

data/gemfiles/contracts_16_0.gemfile

@@ -1,7 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "contracts", "~> 0.16.0"
-
-gemspec path: "../"