lab42_data_class 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04c191005baa65d6d21f1bea2bfbf8361651ab06e9c81e45cc2ab0ac7d8531e8
-  data.tar.gz: d66a6a791c4102e5d9347441a713e893a74e1d49efd39ee145db890ea5d9db07
+  metadata.gz: e882ef6623d30a0203797a53f31e4d3607e3d3e883adbb20ac63ee517db6c71e
+  data.tar.gz: 3ce45a762f3b3628ea6ee19392b1a2202f3da5f55b8f4b9d341b25f4236581aa
 SHA512:
-  metadata.gz: 8ee5d308afdb75b72840846a7c968d95693204f9db441e8c20825c239c3a9895f0ebfb0cf49e8c2fef5c5e31b79c858cee837c91281a7b48b888451dc6f49e50
-  data.tar.gz: 3f170816817a20cd00827d87bf4257cfa7a8e8c748f0a46be64ca30ea3d4533c1d9af9a3192676abf3ea9119b8f6c5a7ef69144c89ee1a1dd71bd165bc0d8af1
+  metadata.gz: a50fabe74deb22f46e0bc33c062547514fba922e138a3af2bbd6faeabe69f137a98ef5925166e04367366474bcfddf59d4c4067e81f0ebfc2ef61f86312702b0
+  data.tar.gz: 61a6d7e6d7b4fca517622d49516cda9406daab3265b076eff18a0e65fa9ad60a188b295d302b64918600deef5c68d3a2684a6344e4bc2e96ff61dff9aa89d998

data/README.md

@@ -6,7 +6,7 @@
 
 # Lab42::DataClass
 
-A dataclass with an immutable API (you can still change the state of the object with metaprogramming and `lab42_immutable` is not ready yet!)
+An immutable dataclass
 
 ## Usage
 
@@ -60,7 +60,18 @@ And we can extract the values
     expect(my_instance.to_h).to eq(name: "robert", email: nil)
 ```
 
-#### Context: Immutable
+#### Context: Immutable → self
+
+Then `my_instance` is frozen:
+```ruby
+    expect(my_instance).to be_frozen
+```
+And we cannot even mute `my_instance`  by means of metaprogramming
+```ruby
+    expect{ my_instance.instance_variable_set("@x", nil) }.to raise_error(FrozenError)
+```
+
+#### Context: Immutable → Cloning
 
 Given
 ```ruby
@@ -71,6 +82,10 @@ Then we have a new instance with the old instance unchanged
     expect(other_instance.to_h).to eq(name: "robert", email: "robert@mail.provider")
     expect(my_instance.to_h).to eq(name: "robert", email: nil)
 ```
+And the new instance is frozen again
+```ruby
+    expect(other_instance).to be_frozen
+```
 
 ### Context: Defining behavior with blocks
 
@@ -131,6 +146,12 @@ But not in the sense of `equal?`, of course
     expect(instance2).not_to be_equal(instance1)
 ```
 
+#### Immutability of `dataclass` modified classes
+
+Then we still get frozen instances
+```ruby
+    expect(instance1).to be_frozen
+```
 # LICENSE
 
 Copyright 2022 Robert Dober robert.dober@gmail.com

data/lib/lab42/data_class/proxy.rb

@@ -57,6 +57,14 @@ module Lab42
         end
       end
 
+      def _define_freezing_constructor
+        ->(*) do
+          define_method :new do |*a, **p, &b|
+            super(*a, **p, &b).freeze
+          end
+        end
+      end
+
       def _define_initializer
         proxy = self
         ->(*) do
@@ -79,6 +87,7 @@ module Lab42
       end
 
       def _define_methods
+        (class << klass; self end).module_eval(&_define_freezing_constructor)
         klass.module_eval(&_define_to_h)
         klass.module_eval(&_define_merge)
         klass.module_eval(&_define_eql?)

data/lib/lab42/data_class/version.rb

@@ -2,7 +2,7 @@
 
 module Lab42
   module DataClass
-    VERSION = "0.1.2"
+    VERSION = "0.2.0"
   end
 end
 #  SPDX-License-Identifier: Apache-2.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lab42_data_class
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Robert Dober
@@ -10,7 +10,11 @@ bindir: bin
 cert_chain: []
 date: 2022-01-21 00:00:00.000000000 Z
 dependencies: []
-description: introduces a new Kernel function DataClass
+description: |
+  An Immutable DataClass for Ruby
+
+  Exposes a class factory function `Kernel::DataClass` and a class
+  modifer `Module#dataclass'
 email: robert.dober@gmail.com
 executables: []
 extensions: []