lab42_data_class 0.1.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4e2d75e76874aa4cce514081f4be6cd1ab19d827b8e8bb60645f4036a202402
-  data.tar.gz: 4f2dd94d174acd1ea78b70b5063709566ba16b323d8d549221fdecaf10d184d3
+  metadata.gz: 8e4127a34f013386209c71666f9d77e1b5c8fd439324443580e00c7e9018fdb4
+  data.tar.gz: c61d6f1648c9c73cd89883a0c0e6ebd6ea813f51dcdb26f141a99a962e4db5fa
 SHA512:
-  metadata.gz: da62522c51b10954ca4dd86e4b2edcf31a13497a1ec65d169a6944d95c0c7aa6b53d8fb3d7f025ea369420ee8676a312db16c7120677f22753b61996a745bfee
-  data.tar.gz: fc638df334bfb4ad58934d2e9736aad751465cb078a106f47758edbd7265bb9f49a48ef1d0af3d5626b14d7376c20e8be3880fdd53c17e9e26beeeb6e3bf02db
+  metadata.gz: 74b643eb6d43c00aedede31195354412a0b7dcabc5f5da0d1c3f5dbfca4dc03abc1b13a68e10307813153b6e8fe0c502a075a9c4ef17c61f1163ec251e03b3f7
+  data.tar.gz: '007384216191284048c0fcec62adedb04c8f41a549b92d7cdefcbaa3fa2f4536cce737d4a21a6c8d3648fe62a539fd9f201cd036566b9ff3251ac2929856a6a7'

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
 
@@ -90,24 +105,110 @@ Then I have defined a method on my dataclass
 ```ruby
     expect(my_instance.show).to eq("<42>")
 ```
-### Context: Making a dataclass from a class
 
-Given
+### Context: Equality
+
+Given two instances of a DataClass
+```ruby
+    let(:data_class) { DataClass :a }
+    let(:instance1) { data_class.new(a: 1) }
+    let(:instance2) { data_class.new(a: 1) }
+```
+Then they are equal in the sense of `==` and `eql?`
 ```ruby
-    class DC
-      dataclass x: 1, y: 41
-      def sum; x + y end
+    expect(instance1).to eq(instance2)
+    expect(instance2).to eq(instance1)
+    expect(instance1 == instance2).to be_truthy
+    expect(instance2 == instance1).to be_truthy
+```
+But not in the sense of `equal?`, of course
+```ruby
+    expect(instance1).not_to be_equal(instance2)
+    expect(instance2).not_to be_equal(instance1)
+```
+
+#### Context: Immutability of `dataclass` modified classes
+
+Then we still get frozen instances
+```ruby
+    expect(instance1).to be_frozen
+```
+
+### Context: Inheritance
+
+... is a no, we do not want inheritance although we **like** code reuse, how to do it then?
+
+Well there shall be many different possibilities, depending on your style, use case and
+context, here is just one example:
+
+Given a class factory
+```ruby
+    let :token do
+      ->(*a, **k) do
+        DataClass(*a, **(k.merge(text: "")))
+        end
+    end
+```
+
+Then we have reused the `token` successfully
+```ruby
+    empty = token.()
+    integer = token.(:value)
+    boolean = token.(value: false)
+
+    expect(empty.new.to_h).to eq(text: "")
+    expect(integer.new(value: -1).to_h).to eq(text: "", value: -1)
+    expect(boolean.new.value).to eq(false)
+```
+
+#### Context: Mixing in a module can be used of course
+
+Given a behavior like
+```ruby
+    module Humanize
+      def humanize
+        "my value is #{value}"
+      end
     end
+
+    let(:class_level) { DataClass(value: 1).include(Humanize) }
+```
+
+Then we can access the included method
+```ruby
+    expect(class_level.new.humanize).to eq("my value is 1")
+```
+
+### Context: Pattern Matching
+
+An `DataClass` object behaves like the result of it's `to_h` in pattern matching
+
+Given
+```ruby
+    let(:numbers) { DataClass(:name, values: []) }
+    let(:odds) { numbers.new(name: "odds", values: (1..4).map{ _1 + _1 + 1}) }
+    let(:evens) { numbers.new(name: "evens", values: (1..4).map{ _1 + _1}) }
 ```
 
-Then we can define methods on it
+Then we can match accordingly
 ```ruby
-   expect(DC.new.sum).to eq(42)
+    match = case odds
+            in {name: "odds", values: [1, *]}
+              :not_really
+            in {name: "evens"}
+              :still_naaah
+            in {name: "odds", values: [hd, *]}
+              hd
+            else
+              :strange
+            end
+    expect(match).to eq(3)
 ```
 
-And we have a nice name for our instances
+And in `in` expressions
 ```ruby
-    expect(DC.new.class.name).to eq("DC")
+    evens => {values: [_, second, *]}
+    expect(second).to eq(4)
 ```
 
 # LICENSE

data/lib/lab42/data_class/proxy/mixin.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Lab42
+  module DataClass
+    class Proxy
+      module Mixin
+        def ==(other)
+          other.is_a?(self.class) &&
+            to_h == other.to_h
+        end
+
+        def deconstruct_keys(*)
+          to_h
+        end
+      end
+    end
+  end
+end
+#  SPDX-License-Identifier: Apache-2.0

data/lib/lab42/data_class/proxy.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
 require 'set'
+require_relative 'proxy/mixin'
 module Lab42
   module DataClass
     class Proxy
-      attr_reader :actual_params, :block, :defaults, :klass, :has_parent, :members, :positionals
+      attr_reader :actual_params, :block, :defaults, :klass, :members, :positionals
 
       def check!(**params)
         @actual_params = params
@@ -16,6 +17,8 @@ module Lab42
         klass.module_eval(&_define_attr_reader)
         klass.module_eval(&_define_initializer)
         _define_methods
+        klass.include(Mixin)
+        klass.module_eval(&block) if block
         klass
       end
 
@@ -31,8 +34,7 @@ module Lab42
 
       private
       def initialize(*args, **kwds, &blk)
-        @klass = kwds.fetch(:__klass__){ Class.new }
-        @has_parent = !!kwds.delete(:__klass__)
+        @klass = Class.new
 
         @block = blk
         @defaults = kwds
@@ -48,6 +50,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
@@ -63,16 +73,16 @@ module Lab42
         ->(*) do
           define_method :merge do |**params|
             values = to_h.merge(params)
-            DataClass(*proxy.positionals, __klass__: self.class, **proxy.defaults, &proxy.block)
+            DataClass(*proxy.positionals, **proxy.defaults, &proxy.block)
               .new(**values)
           end
         end
       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(&block) if block
       end
 
       def _define_to_h

data/lib/lab42/data_class/version.rb

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

data/lib/lab42/data_class.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require_relative './data_class/for_module'
 require_relative './data_class/proxy'
 
 module Kernel

metadata

@@ -1,16 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: lab42_data_class
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.1
 platform: ruby
 authors:
 - Robert Dober
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-21 00:00:00.000000000 Z
+date: 2022-01-23 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: []
@@ -19,8 +23,8 @@ files:
 - LICENSE
 - README.md
 - lib/lab42/data_class.rb
-- lib/lab42/data_class/for_module.rb
 - lib/lab42/data_class/proxy.rb
+- lib/lab42/data_class/proxy/mixin.rb
 - lib/lab42/data_class/version.rb
 homepage: https://github.com/robertdober/lab42_data_class
 licenses:

data/lib/lab42/data_class/for_module.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'proxy'
-
-module Lab42
-  module DataClass
-    class ::Module
-      def dataclass(*args, **defaults)
-        proxy = Lab42::DataClass::Proxy.new(*args, __klass__: self, **defaults)
-        proxy.define_class!
-      end
-    end
-  end
-end
-#  SPDX-License-Identifier: Apache-2.0