lab42_data_class 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03bada220d0a003c294685e37c3276b15786353f753b60cbafdaf6c78e3f986c
-  data.tar.gz: d36b51077068701de6ecd9db90831d6290b2620d4d403402403ad4af3f1420b2
+  metadata.gz: 3c062e2633e5881141e65113d2d60878733611bece697c933876ef1d9f62270e
+  data.tar.gz: bb5e524274338fda67063a8514cbe17a27c92ec8b62106061793456245729e30
 SHA512:
-  metadata.gz: 931c7c48bd60f8cfdc8ae711b292facf18622de31fbf7d04116af68a70c559171384a024ef628195789a9c25121db5c10879ffc36d99d81fb71cbcd88e25baca
-  data.tar.gz: b2924660d7b0476092a9c85bd4d35c26fb59d4365d1a3f0ff2021343b336bdc28dd5a60dfd9fefb49a9f150cd0c955f71da0d896d72c17f37aa9a6f4352aff3f
+  metadata.gz: ddfaa83d7d62a4f3ccdb6df66cc1b3462ee626ac970b2654e138d338c3e0ba8e016882445552d8fff4ffb13636953f17757991625bc1c54b5b3883c1eed43f89
+  data.tar.gz: 4dae3c50dc6b01e5f311f61e4f8aaf2b712db66a4ace5172b91df242411246e71dc2b30f29cded81ab5b95c77c0858f81282e72a481aff0921d4dbeea990d2f6

data/README.md

@@ -6,7 +6,26 @@
 
 # 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
+
+```sh
+gem install lab42_data_class
+```
+
+With bundler
+
+```ruby
+  gem 'lab42_data_class'
+```
+
+In your code
+
+```ruby
+require 'lab42/data_class'
+```
+
 
 ## So what does it do?
 
@@ -41,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
@@ -52,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
 
@@ -71,26 +105,81 @@ 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
+    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
-    class DC
-      dataclass x: 1, y: 41
-      def sum; x + y end
+    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 can define methods on it
+Then we have reused the `token` successfully
 ```ruby
-   expect(DC.new.sum).to eq(42)
+    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)
 ```
 
-And we have a nice name for our instances
+#### Context: Mixing in a module can be used of course
+
+Given a behavior like
 ```ruby
-    expect(DC.new.class.name).to eq("DC")
+    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")
+```
+
+
 # LICENSE
 
 Copyright 2022 Robert Dober robert.dober@gmail.com

data/lib/lab42/data_class/proxy.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
+require 'set'
 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
@@ -30,8 +31,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
@@ -47,6 +47,23 @@ 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|
+            super(*a, **p, &b).freeze
+          end
+        end
+      end
+
       def _define_initializer
         proxy = self
         ->(*) do
@@ -62,15 +79,17 @@ 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(&_define_eql?)
         klass.module_eval(&block) if block
       end
 

data/lib/lab42/data_class/version.rb

@@ -2,7 +2,7 @@
 
 module Lab42
   module DataClass
-    VERSION = "0.1.0"
+    VERSION = "0.3.0"
   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.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Robert Dober
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-20 00:00:00.000000000 Z
+date: 2022-01-22 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,14 +23,13 @@ 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/version.rb
 homepage: https://github.com/robertdober/lab42_data_class
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -42,7 +45,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.3.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Finally a dataclass in ruby
 test_files: []

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