polyfill-data 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fc564f62f95089c90ab7c84d558694513c676e2720e30a5587fda794b0446e2
-  data.tar.gz: 2466958db19b441691124b8085c60dbb16ad9522b257aa647bb5d816f6bb0b42
+  metadata.gz: 156f764bced601a2ebf8cc7a6ee095d63a4d3f813ee3e9fe7c3b273ce68f007f
+  data.tar.gz: d7425307509c331ac61c33541da58effcbbb1f5b6ce675ede734b27c2acf0ed3
 SHA512:
-  metadata.gz: '09a20ba5e0db01e1693fd27f63eafcd62e3cb6e7dbf49bc9f061e7bec5f9259f3cef29de156f5319791059ac152a169157dfbd4375b13e2f73f551511fb256b7'
-  data.tar.gz: 056fa220c31d080a4b3c3a68d606772bc8791495d42abcad66e80d59146568255d45a613411741223b82ddcc34ee5f3978099ed2aff79e4a9257d6720331dbff
+  metadata.gz: 76a56991f1759077af526ef30236fcde606cd7fdc4dd9b5264e6d3012ad02e5a27feafa2dcf6900a54cd47e25525ee221702e07f41b6178f5cbb3cb7c4c2abfc
+  data.tar.gz: 995d6359685044724e2fda6a31e8dab8c73cbdee97dc49034ef7c45ee39a04a3a05ab7ec3046f78705e931316e2957a0992cbe3b3a36c1fd7d43794e89ee22ca

data/CHANGELOG.md

@@ -0,0 +1,34 @@
+# Changelog
+
+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.2
+
+### Fixed
+
+- freeze after initializing
+- `to_a` removed
+- `deconstruct` fixed to return array in order of members as defined
+
+## 1.0.1
+
+### Added 
+
+- `define` uses the first argument as a constant name if it is a string
+- `[]` class method as an alias to `new`
+- `to_s` method as an alias to `inspect`
+- `deconstruct` method
+
+### Fixed
+
+- `initialize` only receives keyword arguments
+- `inspect` includes comma separated list of members and values
+
+## 1.0.0
+
+### Added
+
+- Initial implementation

data/README.md

@@ -1,6 +1,6 @@
 # Polyfill - Data
 
-Add the Ruby 3.2 Data class to earlier Rubies.
+Add the Ruby 3.2 [Data](https://docs.ruby-lang.org/en/3.2/Data.html) class to earlier Rubies.
 
 ## Installation
 
@@ -14,7 +14,7 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 Polyfill-Data is cryptographically signed. To be sure the gem you install hasn’t been tampered with:
 
-Add my the key (if you haven’t already) as a trusted certificate
+Add the public key (if you haven’t already) as a trusted certificate
 
     gem cert --add <(curl -Ls https://raw.github.com/saturnflyer/polyfill-data/main/certs/saturnflyer.pem)
 

data/lib/data.rb

@@ -15,21 +15,27 @@ else
       raise ArgumentError if args.any?(/=/)
       klass = ::Class.new(self, &block)
 
+      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.define_singleton_method(:new) do |*new_args, **new_kwargs, &block|
-        arg_comparison = new_kwargs.any? ? new_kwargs.keys : new_args
-        if arg_comparison.size != args.size
-          raise ArgumentError
+
+        init_kwargs = if new_args.any?
+          Hash[members.take(new_args.size).zip(new_args)]
+        else
+          new_kwargs
         end
+
         self.allocate.tap do |instance|
-          args_to_hash = if !new_kwargs.any?
-            Hash[members.take(new_args.size).zip(new_args)]
-          else
-            new_kwargs
-          end
-          instance.send(:initialize, **args_to_hash, &block)
-        end
+          instance.send(:initialize, **init_kwargs, &block)
+        end.freeze
+      end
+      class << klass
+        alias_method :[], :new
       end
 
       args.map do |arg|
@@ -48,16 +54,12 @@ else
       self.class.members
     end
 
-    def initialize(*args, **kwargs)
-      @attributes = case
-      when args.empty? && kwargs.empty?
-        {}
-      when args.empty?
-        kwargs
-      else
-        raise ArgumentError unless args.length == members.length
-        Hash[members.zip(args)]
-      end
+    def initialize(**kwargs)
+      @attributes = Hash[members.map {|m| [m,kwargs[m]] }]
+    end
+
+    def deconstruct
+      @attributes.values
     end
 
     def deconstruct_keys(array)
@@ -89,11 +91,12 @@ else
         insect_key = key.to_s.start_with?("@") ? ":#{key}" : key
         "#{insect_key}=#{value}"
       end
-      %(#<#{name} #{attribute_markers.join(" ")}>)
+      %(#<#{name} #{attribute_markers.join(", ")}>)
     end
+    alias_method :to_s, :inspect
 
     def with(**kwargs)
-      self.class.new(*@attributes.merge(kwargs).values)
+      self.class.new(**@attributes.merge(kwargs))
     end
   end
 end

data/lib/polyfill/data/version.rb

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

data/test/test_data.rb

@@ -118,6 +118,11 @@ class TestData < Minitest::Test
     assert_equal({foo: 1}, test.deconstruct_keys(%i[foo baz]))
     assert_raises(TypeError) { test.deconstruct_keys(0) }
 
+    test = klass.new(bar: 2, foo: 1)
+    assert_equal([1, 2], test.deconstruct)
+
+    assert_predicate(test, :frozen?)
+
     assert_kind_of(Integer, test.hash)
   end
 
@@ -133,6 +138,11 @@ class TestData < Minitest::Test
     klass = Data.define(:@a)
     o = klass.new(1)
     assert_equal("#<data :@a=1>", o.inspect)
+
+    klass = Data.define(:one, :two)
+    o = klass.new(1,2)
+    assert_equal("#<data one=1, two=2>", o.inspect)
+    assert_equal("#<data one=1, two=2>", o.to_s)
   end
 
   def test_equal
@@ -167,4 +177,19 @@ class TestData < Minitest::Test
     assert_equal([], test.members)
     assert_equal({}, test.to_h)
   end
+
+  def test_square_braces
+    klass = Data.define(:amount, :unit)
+
+    distance = klass[10, 'km']
+
+    assert_equal(10, distance.amount)
+    assert_equal('km', distance.unit)
+  end
+
+  def test_namespaced_constant
+    klass = Data.define("Measure", :amount, :unit)
+
+    assert_equal(Data::Measure, klass)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: polyfill-data
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Jim Gay
@@ -34,7 +34,7 @@ cert_chain:
   dxkiKqcX+yzo9RJLD9l/E1AWX125r1Fhiif4l6ehdl7Vllc3NQUOm1abdmHtCYjw
   dG3yPWBWzzN4ovoBRqsuTJbF1wjkCjl5ex5KhfYbeDc=
   -----END CERTIFICATE-----
-date: 2023-01-19 00:00:00.000000000 Z
+date: 2023-01-21 00:00:00.000000000 Z
 dependencies: []
 description: Add the ruby 3.2 Data class to older rubies
 email:
@@ -43,6 +43,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - README.md
 - Rakefile
 - certs/saturnflyer.pem
@@ -75,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.27
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Add the ruby 3.2 Data class to older rubies