polyfill-data 1.0.2 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 156f764bced601a2ebf8cc7a6ee095d63a4d3f813ee3e9fe7c3b273ce68f007f
-  data.tar.gz: d7425307509c331ac61c33541da58effcbbb1f5b6ce675ede734b27c2acf0ed3
+  metadata.gz: 62f13af5e73dbe544ce73a294748dee539285c7f8405ec7e68f4d2187b51364c
+  data.tar.gz: 0d4c325885a85e5ced977b50e38af25d44508d6c85a7d6e02f512a9e56d2dff8
 SHA512:
-  metadata.gz: 76a56991f1759077af526ef30236fcde606cd7fdc4dd9b5264e6d3012ad02e5a27feafa2dcf6900a54cd47e25525ee221702e07f41b6178f5cbb3cb7c4c2abfc
-  data.tar.gz: 995d6359685044724e2fda6a31e8dab8c73cbdee97dc49034ef7c45ee39a04a3a05ab7ec3046f78705e931316e2957a0992cbe3b3a36c1fd7d43794e89ee22ca
+  metadata.gz: 73f956793df2920f6c13d564d56592c72a19327ed9451dd536c3f69a8057038775e5a02e1ec8962f85c135d588b0d54df8f337297eaf18f992e6d29ce910d6de
+  data.tar.gz: 25d0e20f500b2715c2ec352f8f2a46150832e40a9482f782450b2e0b2ebe3d9c6f78cafa19fc978b8fa78569771d22d10626b423ba71e555aa05f42112d38d03

data/CHANGELOG.md

@@ -5,6 +5,21 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 1.0.4
+
+### Fixed
+
+- loading from `Marshal.load` will create a frozen object
+- `dup` will return a frozen object
+- `define` cannot be used on Data subclasses
+- `with` returns `self` when given no arguments
+
+## 1.0.3
+
+### Fixed
+
+- `new` correctly raises ArugmentErrors with incorrect arguments on Data subclasses
+
 ## 1.0.2
 
 ### Fixed

data/lib/data.rb

@@ -9,6 +9,7 @@ else
   class Data < Object
     class << self
       undef_method :new
+      attr_reader :members
     end
 
     def self.define(*args, &block)
@@ -20,11 +21,11 @@ else
         Data.const_set(name, klass)
       end
 
-      klass.define_singleton_method(:members) { args.map{ _1.intern } }
+      klass.instance_variable_set(:@members, args)
 
       klass.define_singleton_method(:new) do |*new_args, **new_kwargs, &block|
-
         init_kwargs = if new_args.any?
+          raise ArgumentError, "unknown arguments #{new_args[members.size..].join(', ')}" if new_args.size > members.size
           Hash[members.take(new_args.size).zip(new_args)]
         else
           new_kwargs
@@ -36,6 +37,7 @@ else
       end
       class << klass
         alias_method :[], :new
+        undef_method :define
       end
 
       args.map do |arg|
@@ -55,6 +57,17 @@ else
     end
 
     def initialize(**kwargs)
+      kwargs_size = kwargs.size
+      members_size = members.size
+
+      if kwargs_size > members_size
+        extras = kwargs.reject{|k, _v| members.include?(k) }.keys
+        raise ArgumentError, "unknown arguments #{extras.join(', ')}"
+      elsif kwargs_size < members_size
+        missing = members.select {|k, _v| !kwargs.include?(k) }
+        raise ArgumentError, "missing arguments #{missing.map{ ":#{_1}" }.join(', ')}"
+      end
+
       @attributes = Hash[members.map {|m| [m,kwargs[m]] }]
     end
 
@@ -96,7 +109,24 @@ else
     alias_method :to_s, :inspect
 
     def with(**kwargs)
+      return self if kwargs.empty?
+
       self.class.new(**@attributes.merge(kwargs))
     end
+
+    private
+
+    def marshal_dump
+      @attributes
+    end
+
+    def marshal_load(attributes)
+      @attributes = attributes
+      freeze
+    end
+
+    def initialize_copy(source)
+      super.freeze
+    end
   end
 end

data/lib/polyfill/data/version.rb

@@ -2,6 +2,6 @@
 
 module Polyfill
   module Data
-    VERSION = "1.0.2"
+    VERSION = "1.0.4"
   end
 end

data/test/test_data.rb

@@ -13,6 +13,8 @@ class TestData < Minitest::Test
 
     # Because some code is shared with Struct, check we don't share unnecessary functionality
     assert_raises(TypeError) { Data.define(:foo, keyword_init: true) }
+
+    refute_respond_to(Data.define, :define, "Cannot define from defined Data class")
   end
 
   def test_define_edge_cases
@@ -59,6 +61,7 @@ class TestData < Minitest::Test
     assert_equal(1, test.foo)
     assert_equal(2, test.bar)
     assert_equal(test, klass.new(1, 2))
+    assert_predicate(test, :frozen?)
 
     # Keywords
     test_kw = klass.new(foo: 1, bar: 2)
@@ -86,7 +89,7 @@ class TestData < Minitest::Test
         super(foo: 1, bar: 2) # so we can experiment with passing wrong numbers of args
       end
     end
-    # require 'debug'; debugger
+
     assert_equal([[], {foo: 1, bar: 2}], klass.new(foo: 1, bar: 2).passed)
 
     # Positional arguments are converted to keyword ones
@@ -121,8 +124,6 @@ class TestData < Minitest::Test
     test = klass.new(bar: 2, foo: 1)
     assert_equal([1, 2], test.deconstruct)
 
-    assert_predicate(test, :frozen?)
-
     assert_kind_of(Integer, test.hash)
   end
 
@@ -165,6 +166,65 @@ class TestData < Minitest::Test
     refute_operator(o1, :eql?, o3)
   end
 
+  def test_with
+    klass = Data.define(:foo, :bar)
+    source = klass.new(foo: 1, bar: 2)
+
+    # Simple
+    test = source.with
+    assert_equal(source.object_id, test.object_id)
+
+    # Changes
+    test = source.with(foo: 10)
+
+    assert_equal(1, source.foo)
+    assert_equal(2, source.bar)
+    assert_equal(source, klass.new(foo: 1, bar: 2))
+
+    assert_equal(10, test.foo)
+    assert_equal(2, test.bar)
+    assert_equal(test, klass.new(foo: 10, bar: 2))
+
+    test = source.with(foo: 10, bar: 20)
+
+    assert_equal(1, source.foo)
+    assert_equal(2, source.bar)
+    assert_equal(source, klass.new(foo: 1, bar: 2))
+
+    assert_equal(10, test.foo)
+    assert_equal(20, test.bar)
+    assert_equal(test, klass.new(foo: 10, bar: 20))
+
+    # Keyword splat
+    changes = { foo: 10, bar: 20 }
+    test = source.with(**changes)
+
+    assert_equal(1, source.foo)
+    assert_equal(2, source.bar)
+    assert_equal(source, klass.new(foo: 1, bar: 2))
+
+    assert_equal(10, test.foo)
+    assert_equal(20, test.bar)
+    assert_equal(test, klass.new(foo: 10, bar: 20))
+
+    # Wrong protocol
+    assert_raises(ArgumentError, "wrong number of arguments (given 1, expected 0)") do
+      source.with(10)
+    end
+    assert_raises(ArgumentError, "unknown keywords: :baz, :quux") do
+      source.with(foo: 1, bar: 2, baz: 3, quux: 4)
+    end
+    assert_raises(ArgumentError, "wrong number of arguments (given 1, expected 0)") do
+      source.with(1, bar: 2)
+    end
+    assert_raises(ArgumentError, "wrong number of arguments (given 2, expected 0)") do
+      source.with(1, 2)
+    end
+    assert_raises(ArgumentError, "wrong number of arguments (given 1, expected 0)") do
+      source.with({ bar: 2 })
+    end unless RUBY_VERSION < "2.8.0"
+  end
+
   def test_memberless
     klass = Data.define
 
@@ -187,6 +247,23 @@ class TestData < Minitest::Test
     assert_equal('km', distance.unit)
   end
 
+  def test_dup
+    klass = Data.define(:foo, :bar)
+    test = klass.new(foo: 1, bar: 2)
+    assert_equal(klass.new(foo: 1, bar: 2), test.dup)
+    assert_predicate(test.dup, :frozen?)
+  end
+
+  Klass = Data.define(:foo, :bar)
+
+  def test_marshal
+    test = Klass.new(foo: 1, bar: 2)
+    loaded = Marshal.load(Marshal.dump(test))
+    assert_equal(test, loaded)
+    refute_same(test, loaded)
+    assert_predicate(loaded, :frozen?)
+  end
+
   def test_namespaced_constant
     klass = Data.define("Measure", :amount, :unit)
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: polyfill-data
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.4
 platform: ruby
 authors:
 - Jim Gay
@@ -34,9 +34,9 @@ cert_chain:
   dxkiKqcX+yzo9RJLD9l/E1AWX125r1Fhiif4l6ehdl7Vllc3NQUOm1abdmHtCYjw
   dG3yPWBWzzN4ovoBRqsuTJbF1wjkCjl5ex5KhfYbeDc=
   -----END CERTIFICATE-----
-date: 2023-01-21 00:00:00.000000000 Z
+date: 2023-01-22 00:00:00.000000000 Z
 dependencies: []
-description: Add the ruby 3.2 Data class to older rubies
+description: Add the ruby 3.2 Data class to older rubies. Do nothing in 3.2
 email:
 - jim@saturnflyer.com
 executables: []