polyfill-data 1.0.3 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20b2218a1dd7298ead1e7bd8f08502558a2828f7aef9a5be33424084bd2d1c9b
-  data.tar.gz: fc1c0a53cab242883ffcae75f523a959e5a9b273c14f9e8fd334f5db78875802
+  metadata.gz: 159535856d8a85a17e4a90dff438911c7e3a04fcff60b1a016662f97e2575e68
+  data.tar.gz: c83127bfa5a28bd26dccfcdfbe0b095236136635c3180720cab55912a2fa9796
 SHA512:
-  metadata.gz: 9291cd87f95c34b47e5a32f87bffa79f5eca7d0419c1fc741ee88ca3e3518a7435b63c827db569a2960b7fb3d516a408058db3a7fbde49f2dc1328d8dcc5109d
-  data.tar.gz: df56331c22ecc1ce85aaf5f2e743230b944f07298b1fdc248a337c3731628152f5fffc699d4eaa6ca3490767ff71ab23ea5cb98bbe9dd3f778fbe525c46e9807
+  metadata.gz: 2527a6f9e79192cf29d798ee4eb34059e1562690d9b9e8afd921a421b816cefe6f888273d29f6d186a42f459d35217b5639e8eca505235d72c35434fcaa07177
+  data.tar.gz: f3a3fe35c950d650a13831df4fb6eabe97eac73b6dd2f55ad518a12180d74202a30492c0fad50caa854dea57d9534bf9d60c9658be0f996f752632dd694c84e7

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.5
+
+### Fixed
+
+- member methods take precedence over methods defined in the block passed to `define`
+
+## 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

data/lib/data.rb

@@ -9,18 +9,26 @@ else
   class Data < Object
     class << self
       undef_method :new
+      attr_reader :members
     end
 
     def self.define(*args, &block)
       raise ArgumentError if args.any?(/=/)
-      klass = ::Class.new(self, &block)
+      if block
+        mod = Module.new
+        mod.define_singleton_method(:_,) do |klass|
+          klass.class_eval(&block)
+        end
+        arity_converter = mod.method(:_)
+      end
+      klass = ::Class.new(self)
 
       if args.first.is_a?(String)
         name = args.shift
         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?
@@ -34,8 +42,10 @@ else
           instance.send(:initialize, **init_kwargs, &block)
         end.freeze
       end
+
       class << klass
         alias_method :[], :new
+        undef_method :define
       end
 
       args.map do |arg|
@@ -47,6 +57,10 @@ else
         end
       end
 
+      if arity_converter
+        klass.class_eval(&arity_converter)
+      end
+
       klass
     end
 
@@ -97,17 +111,36 @@ else
     end
 
     def inspect
-      name = ["data", self.class.name].compact.join(" ")
       attribute_markers = @attributes.map do |key, value|
         insect_key = key.to_s.start_with?("@") ? ":#{key}" : key
         "#{insect_key}=#{value}"
-      end
-      %(#<#{name} #{attribute_markers.join(", ")}>)
+      end.join(", ")
+
+      display = ["data", self.class.name, attribute_markers].compact.join(" ")
+
+      "#<#{display}>"
     end
     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.3"
+    VERSION = "1.0.5"
   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)
@@ -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,9 +247,47 @@ 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)
 
     assert_equal(Data::Measure, klass)
   end
+
+  def test_member_precedence
+   name_mod = Module.new do
+      def name
+        "default name"
+      end
+
+      def other
+        "other"
+      end
+    end
+
+    klass = Data.define(:name) do
+      include name_mod
+    end
+
+    data = klass.new("test")
+
+    assert_equal("test", data.name)
+    assert_equal("other", data.other)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: polyfill-data
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.5
 platform: ruby
 authors:
 - Jim Gay
@@ -34,9 +34,9 @@ cert_chain:
   dxkiKqcX+yzo9RJLD9l/E1AWX125r1Fhiif4l6ehdl7Vllc3NQUOm1abdmHtCYjw
   dG3yPWBWzzN4ovoBRqsuTJbF1wjkCjl5ex5KhfYbeDc=
   -----END CERTIFICATE-----
-date: 2023-01-22 00:00:00.000000000 Z
+date: 2023-01-24 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: []
@@ -76,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.27
 signing_key:
 specification_version: 4
 summary: Add the ruby 3.2 Data class to older rubies