lab42_data_class 0.2.0 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e882ef6623d30a0203797a53f31e4d3607e3d3e883adbb20ac63ee517db6c71e
-  data.tar.gz: 3ce45a762f3b3628ea6ee19392b1a2202f3da5f55b8f4b9d341b25f4236581aa
+  metadata.gz: 8b6b4667c08da4511e2e4889bf35d21badc1018d7c8ce61efb66c65162c1ca0f
+  data.tar.gz: 0206dff912a52398e24488fd53aaac9c65ceceb3706b38bb562aac37d6d9d296
 SHA512:
-  metadata.gz: a50fabe74deb22f46e0bc33c062547514fba922e138a3af2bbd6faeabe69f137a98ef5925166e04367366474bcfddf59d4c4067e81f0ebfc2ef61f86312702b0
-  data.tar.gz: 61a6d7e6d7b4fca517622d49516cda9406daab3265b076eff18a0e65fa9ad60a188b295d302b64918600deef5c68d3a2684a6344e4bc2e96ff61dff9aa89d998
+  metadata.gz: 23d410a7701bbdf4d175ab650e62fea5845c91d825d8346fa31955007571e2b862deccf478a831dab3e4404ef1d7f9f96018e13c672fe74a9592a534aceea186
+  data.tar.gz: 1e349c67fa94a4633ad5e933e755a5ab762e3b13fa28cd5a7cdfdc18a70cfe7f5190dd9d2d0ac78474a44df2dcf4010785b155b8920706cd17da98125aa55ba7

data/README.md

@@ -105,25 +105,6 @@ 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
-```ruby
-    class DC
-      dataclass x: 1, y: 41
-      def sum; x + y end
-    end
-```
-
-Then we can define methods on it
-```ruby
-   expect(DC.new.sum).to eq(42)
-```
-
-And we have a nice name for our instances
-```ruby
-    expect(DC.new.class.name).to eq("DC")
-```
 
 ### Context: Equality
 
@@ -146,12 +127,156 @@ But not in the sense of `equal?`, of course
     expect(instance2).not_to be_equal(instance1)
 ```
 
-#### Immutability of `dataclass` modified classes
+#### 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
+
+A `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 match accordingly
+```ruby
+    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 in `in` expressions
+```ruby
+    evens => {values: [_, second, *]}
+    expect(second).to eq(4)
+```
+
+#### Context: In Case Statements
+
+Given a nice little dataclass `Box`
+```ruby
+    let(:box) { DataClass content: nil }
+```
+
+Then we can also use it in a case statement
+```ruby
+    value = case box.new
+      when box
+        42
+      else
+        0
+      end
+    expect(value).to eq(42)
+```
+
+And all the associated methods
+```ruby
+    expect(box.new).to be_a(box)
+    expect(box === box.new).to be_truthy
+```
+
+### Context: Behaving like a `Proc`
+
+It is useful to be able to filter heterogeneous lists of `DataClass` instances by means of `&to_proc`, therefore
+
+Given two different `DataClass` objects
+```ruby
+    let(:class1) { DataClass :value }
+    let(:class2) { DataClass :value }
+```
+
+And a list of instances
+```ruby
+    let(:list) {[class1.new(value: 1), class2.new(value: 2), class1.new(value: 3)]}
+```
+
+Then we can filter
+```ruby
+    expect(list.filter(&class2)).to eq([class2.new(value: 2)])
+```
+
+### Context: Behaving like a `Hash`
+
+We have already seen the `to_h` method, however if we want to pass an instance of `DataClass` as 
+keyword parameters we need an implementation of `to_hash`, which of course is just an alias
+
+Given this keyword method
+```ruby
+    def extract_value(value:, **others)
+      [value, others]
+    end
+```
+And this `DataClass`:
+```ruby
+    let(:my_class) { DataClass(value: 1, base: 2) }
+```
+
+Then we can pass it as keyword arguments
+```ruby
+    expect(extract_value(**my_class.new)).to eq([1, base: 2])
+```
+
+
 # LICENSE
 
 Copyright 2022 Robert Dober robert.dober@gmail.com

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,15 +50,6 @@ module Lab42
         end
       end
 
-      def _define_eql?
-        ->(*) do
-          define_method :== do |other|
-            other.is_a?(self.class) &&
-              to_h == other.to_h
-          end
-        end
-      end
-
       def _define_freezing_constructor
         ->(*) do
           define_method :new do |*a, **p, &b|
@@ -80,7 +73,7 @@ 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
@@ -88,10 +81,9 @@ module Lab42
 
       def _define_methods
         (class << klass; self end).module_eval(&_define_freezing_constructor)
+        (class << klass; self end).module_eval(&_define_to_proc)
         klass.module_eval(&_define_to_h)
         klass.module_eval(&_define_merge)
-        klass.module_eval(&_define_eql?)
-        klass.module_eval(&block) if block
       end
 
       def _define_to_h
@@ -100,6 +92,15 @@ module Lab42
           define_method :to_h do
             proxy.to_hash(self)
           end
+          alias_method :to_hash, :to_h
+        end
+      end
+
+      def _define_to_proc
+        ->(*) do
+          define_method :to_proc do
+            ->(other) { self === other }
+          end
         end
       end
 

data/lib/lab42/data_class/version.rb

@@ -2,7 +2,7 @@
 
 module Lab42
   module DataClass
-    VERSION = "0.2.0"
+    VERSION = "0.3.3"
   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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lab42_data_class
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.3
 platform: ruby
 authors:
 - Robert Dober
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-21 00:00:00.000000000 Z
+date: 2022-01-31 00:00:00.000000000 Z
 dependencies: []
 description: |
   An Immutable DataClass for Ruby
@@ -23,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