lab42_data_class 0.3.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e4127a34f013386209c71666f9d77e1b5c8fd439324443580e00c7e9018fdb4
-  data.tar.gz: c61d6f1648c9c73cd89883a0c0e6ebd6ea813f51dcdb26f141a99a962e4db5fa
+  metadata.gz: e64e5ffb63619de67de53f6618db6f25dc61e6a69b99fb6ae6cdc96446bbc490
+  data.tar.gz: ccf55ee9ef5d9bd3beabba0f852910ab37294a23415df78ca800e5ae411905ab
 SHA512:
-  metadata.gz: 74b643eb6d43c00aedede31195354412a0b7dcabc5f5da0d1c3f5dbfca4dc03abc1b13a68e10307813153b6e8fe0c502a075a9c4ef17c61f1163ec251e03b3f7
-  data.tar.gz: '007384216191284048c0fcec62adedb04c8f41a549b92d7cdefcbaa3fa2f4536cce737d4a21a6c8d3648fe62a539fd9f201cd036566b9ff3251ac2929856a6a7'
+  metadata.gz: c37f77d7fd444f7b64ba489e6d170b28e49ca176f74311f9aa0f269976e1561e56ba8561dd2f4b2f47cc526dc677943a98f9cd4c356c073bdc6bcebfcff29580
+  data.tar.gz: ed8a76bd074ad26ac625b17aec759d36300d5f0ba4ebe6ed6c827ee38149d6b8303d5bca7e8c62575fad3f2c29513577c89de0c607d15d5e109a9e813de7e59c

data/README.md

@@ -1,12 +1,14 @@
 
-[![Gem Version](http://img.shields.io/gem/v/lab42_data_class.svg)](https://rubygems.org/gems/lab42_data_class)
+[![Issue Count](https://codeclimate.com/github/RobertDober/lab42_data_class/badges/issue_count.svg)](https://codeclimate.com/github/RobertDober/lab42_data_class)
 [![CI](https://github.com/robertdober/lab42_data_class/workflows/CI/badge.svg)](https://github.com/robertdober/lab42_data_class/actions)
 [![Coverage Status](https://coveralls.io/repos/github/RobertDober/lab42_data_class/badge.svg?branch=main)](https://coveralls.io/github/RobertDober/lab42_data_class?branch=main)
+[![Gem Version](http://img.shields.io/gem/v/lab42_data_class.svg)](https://rubygems.org/gems/lab42_data_class)
+[![Gem Downloads](https://img.shields.io/gem/dt/lab42_data_class.svg)](https://rubygems.org/gems/lab42_data_class)
 
 
 # Lab42::DataClass
 
-An immutable dataclass
+An immutable Dataclass, Tuples and Triples
 
 ## Usage
 
@@ -31,6 +33,8 @@ require 'lab42/data_class'
 
 Well let us [speculate about](https://github.com/RobertDober/speculate_about) it to find out:
 
+## Context `DataClass`
+
 ### Context: `DataClass` function
 
 Given
@@ -181,7 +185,7 @@ Then we can access the included method
 
 ### Context: Pattern Matching
 
-An `DataClass` object behaves like the result of it's `to_h` in pattern matching
+A `DataClass` object behaves like the result of it's `to_h` in pattern matching
 
 Given
 ```ruby
@@ -211,6 +215,128 @@ And in `in` expressions
     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])
+```
+
+## Context: `Pair` and `Triple`
+
+Two special cases of a `DataClass` which behave like `Tuple` of size 2 and 3 in _Elixir_
+
+
+They distinguish themselves from `DataClass` classes by accepting only positional arguments, and
+cannot be converted to hashes.
+
+These are actually two classes and not class factories as they have a fixed interface , but let us speculate about them to learn what they can do for us.
+
+### Context: Constructor functions
+
+Given a pair
+```ruby
+    let(:token) { Pair("12", 12) }
+    let(:node)  { Triple("42", 4, 2) }
+```
+
+Then we can access their elements
+```ruby
+    expect(token.first).to eq("12")
+    expect(token.second).to eq(12)
+    expect(node.first).to eq("42")
+    expect(node.second).to eq(4)
+    expect(node.third).to eq(2)
+```
+
+And we can treat them like _Indexable_
+```ruby
+    expect(token[1]).to eq(12)
+    expect(token[-2]).to eq("12")
+    expect(node[2]).to eq(2)
+```
+
+And convert them to arrays of course
+```ruby
+    expect(token.to_a).to eq(["12", 12])
+    expect(node.to_a).to eq(["42", 4, 2])
+```
+
+And they behave like arrays in pattern matching too
+```ruby
+    token => [str, int]
+    node  => [root, lft, rgt]
+    expect(str).to eq("12")
+    expect(int).to eq(12)
+    expect(root).to eq("42")
+    expect(lft).to eq(4)
+    expect(rgt).to eq(2)
+```
+
+And of course the factory functions are equivalent to the constructors
+```ruby
+    expect(token).to eq(Lab42::Pair.new("12", 12))
+    expect(node).to eq(Lab42::Triple.new("42", 4, 2))
+```
+
 # LICENSE
 
 Copyright 2022 Robert Dober robert.dober@gmail.com

data/lib/lab42/data_class/proxy.rb

@@ -69,18 +69,17 @@ module Lab42
       end
 
       def _define_merge
-        proxy = self
         ->(*) do
           define_method :merge do |**params|
             values = to_h.merge(params)
-            DataClass(*proxy.positionals, **proxy.defaults, &proxy.block)
-              .new(**values)
+            self.class.new(**values)
           end
         end
       end
 
       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)
       end
@@ -91,6 +90,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.3.1"
+    VERSION = "0.4.1"
   end
 end
 #  SPDX-License-Identifier: Apache-2.0

data/lib/lab42/data_class.rb

@@ -1,12 +1,22 @@
 # frozen_string_literal: true
 
 require_relative './data_class/proxy'
+require_relative './pair'
+require_relative './triple'
 
 module Kernel
   def DataClass(*args, **kwds, &blk)
     proxy = Lab42::DataClass::Proxy.new(*args, **kwds, &blk)
     proxy.define_class!
   end
+
+  def Pair(first, second)
+    Lab42::Pair.new(first, second)
+  end
+
+  def Triple(first, second, third)
+    Lab42::Triple.new(first, second, third)
+  end
 end
 
 #  SPDX-License-Identifier: Apache-2.0

data/lib/lab42/eq_and_patterns.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Lab42
+  module EqAndPatterns
+    def [](idx)
+      to_a[idx]
+    end
+
+    def ==(other)
+      other.is_a?(self.class) &&
+        to_a == other.to_a
+    end
+
+    def deconstruct(*)
+      to_a
+    end
+  end
+end
+#  SPDX-License-Identifier: Apache-2.0

data/lib/lab42/pair.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative 'eq_and_patterns'
+module Lab42
+  class Pair
+    attr_reader :first, :second
+    include EqAndPatterns
+
+    def to_a
+      [first, second]
+    end
+
+    private
+
+    def initialize(first, second)
+      @first = first
+      @second = second
+    end
+  end
+end
+#  SPDX-License-Identifier: Apache-2.0

data/lib/lab42/triple.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative 'eq_and_patterns'
+module Lab42
+  class Triple
+    attr_reader :first, :second, :third
+    include EqAndPatterns
+
+    def to_a
+      [first, second, third]
+    end
+
+    private
+
+    def initialize(first, second, third)
+      @first = first
+      @second = second
+      @third = third
+    end
+  end
+end
+#  SPDX-License-Identifier: Apache-2.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lab42_data_class
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.1
 platform: ruby
 authors:
 - Robert Dober
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-23 00:00:00.000000000 Z
+date: 2022-02-22 00:00:00.000000000 Z
 dependencies: []
 description: |
   An Immutable DataClass for Ruby
@@ -26,6 +26,9 @@ files:
 - lib/lab42/data_class/proxy.rb
 - lib/lab42/data_class/proxy/mixin.rb
 - lib/lab42/data_class/version.rb
+- lib/lab42/eq_and_patterns.rb
+- lib/lab42/pair.rb
+- lib/lab42/triple.rb
 homepage: https://github.com/robertdober/lab42_data_class
 licenses:
 - Apache-2.0