lab42_data_class 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 03bada220d0a003c294685e37c3276b15786353f753b60cbafdaf6c78e3f986c
+  data.tar.gz: d36b51077068701de6ecd9db90831d6290b2620d4d403402403ad4af3f1420b2
+SHA512:
+  metadata.gz: 931c7c48bd60f8cfdc8ae711b292facf18622de31fbf7d04116af68a70c559171384a024ef628195789a9c25121db5c10879ffc36d99d81fb71cbcd88e25baca
+  data.tar.gz: b2924660d7b0476092a9c85bd4d35c26fb59d4365d1a3f0ff2021343b336bdc28dd5a60dfd9fefb49a9f150cd0c955f71da0d896d72c17f37aa9a6f4352aff3f

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright © 2014 Dave Thomas, The Pragmatic Programmers
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      https://spdx.org/licenses/Apache-2.0.html
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+
+Note:
+Individual files contain the following tag instead of the full license text.
+
+        SPDX-License-Identifier: Apache-2.0

data/README.md

@@ -0,0 +1,99 @@
+
+[![Gem Version](http://img.shields.io/gem/v/lab42_data_class.svg)](https://rubygems.org/gems/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)
+
+
+# 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!)
+
+## So what does it do?
+
+Well let us [speculate about](https://github.com/RobertDober/speculate_about) it to find out:
+
+### Context: `DataClass` function
+
+Given
+```ruby
+    let(:my_data_class) { DataClass(:name, email: nil) }
+    let(:my_instance) { my_data_class.new(name: "robert") }
+```
+
+Then we can access its fields
+```ruby
+    expect(my_instance.name).to eq("robert")
+    expect(my_instance.email).to be_nil
+```
+
+But we cannot access undefined fields
+```ruby
+    expect{ my_instance.undefined }.to raise_error(NoMethodError)
+```
+
+And we need to provide values to fields without defaults
+```ruby
+    expect{ my_data_class.new(email: "some@mail.org") }
+      .to raise_error(ArgumentError, "missing initializers for [:name]")
+```
+And we can extract the values
+```ruby
+    expect(my_instance.to_h).to eq(name: "robert", email: nil)
+```
+
+#### Context: Immutable
+
+Given
+```ruby
+    let(:other_instance) { my_instance.merge(email: "robert@mail.provider") }
+```
+Then we have a new instance with the old instance unchanged
+```ruby
+    expect(other_instance.to_h).to eq(name: "robert", email: "robert@mail.provider")
+    expect(my_instance.to_h).to eq(name: "robert", email: nil)
+```
+
+### Context: Defining behavior with blocks
+
+Given
+```ruby
+    let :my_data_class do
+      DataClass :value, prefix: "<", suffix: ">" do
+        def show
+          [prefix, value, suffix].join
+        end
+      end
+    end
+    let(:my_instance) { my_data_class.new(value: 42) }
+```
+
+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")
+```
+
+# LICENSE
+
+Copyright 2022 Robert Dober robert.dober@gmail.com
+
+Apache-2.0 [c.f LICENSE](LICENSE)
+<!-- SPDX-License-Identifier: Apache-2.0-->

data/lib/lab42/data_class/for_module.rb

@@ -0,0 +1,15 @@
+# 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

data/lib/lab42/data_class/proxy.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module Lab42
+  module DataClass
+    class Proxy
+      attr_reader :actual_params, :block, :defaults, :klass, :has_parent, :members, :positionals
+
+      def check!(**params)
+        @actual_params = params
+        raise ArgumentError, "missing initializers for #{_missing_initializers}" unless _missing_initializers.empty?
+        raise ArgumentError, "illegal initializers #{_illegal_initializers}" unless _illegal_initializers.empty?
+      end
+
+      def define_class!
+        klass.module_eval(&_define_attr_reader)
+        klass.module_eval(&_define_initializer)
+        _define_methods
+        klass
+      end
+
+      def init(data_class, **params)
+        _init(data_class, defaults.merge(params))
+      end
+
+      def to_hash(data_class_instance)
+        members
+          .map { [_1, data_class_instance.instance_variable_get("@#{_1}")] }
+          .to_h
+      end
+
+      private
+      def initialize(*args, **kwds, &blk)
+        @klass = kwds.fetch(:__klass__){ Class.new }
+        @has_parent = !!kwds.delete(:__klass__)
+
+        @block = blk
+        @defaults = kwds
+        @members = Set.new(args + kwds.keys)
+        # TODO: Check for all symbols and no duplicates ⇒ v0.1.1
+        @positionals = args
+      end
+
+      def _define_attr_reader
+        proxy = self
+        ->(*) do
+          attr_reader(*proxy.members)
+        end
+      end
+
+      def _define_initializer
+        proxy = self
+        ->(*) do
+          define_method :initialize do |**params|
+            proxy.check!(**params)
+            proxy.init(self, **params)
+          end
+        end
+      end
+
+      def _define_merge
+        proxy = self
+        ->(*) do
+          define_method :merge do |**params|
+            values = to_h.merge(params)
+            DataClass(*proxy.positionals, __klass__: self.class, **proxy.defaults, &proxy.block)
+              .new(**values)
+          end
+        end
+      end
+
+      def _define_methods
+        klass.module_eval(&_define_to_h)
+        klass.module_eval(&_define_merge)
+        klass.module_eval(&block) if block
+      end
+
+      def _define_to_h
+        proxy = self
+        ->(*) do
+          define_method :to_h do
+            proxy.to_hash(self)
+          end
+        end
+      end
+
+      def _init(data_class_instance, params)
+        params.each do |key, value|
+          data_class_instance.instance_variable_set("@#{key}", value)
+        end
+      end
+
+      def _missing_initializers
+        @___missing_initializers__ ||=
+          positionals - actual_params.keys
+      end
+
+      def _illegal_initializers
+        @___illegal_initializers__ ||=
+          actual_params.keys - positionals - defaults.keys
+      end
+    end
+  end
+end
+#  SPDX-License-Identifier: Apache-2.0

data/lib/lab42/data_class/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Lab42
+  module DataClass
+    VERSION = "0.1.0"
+  end
+end
+#  SPDX-License-Identifier: Apache-2.0

data/lib/lab42/data_class.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative './data_class/for_module'
+require_relative './data_class/proxy'
+
+module Kernel
+  def DataClass(*args, **kwds, &blk)
+    proxy = Lab42::DataClass::Proxy.new(*args, **kwds, &blk)
+    proxy.define_class!
+  end
+end
+
+#  SPDX-License-Identifier: Apache-2.0

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: lab42_data_class
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Robert Dober
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-01-20 00:00:00.000000000 Z
+dependencies: []
+description: introduces a new Kernel function DataClass
+email: robert.dober@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+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: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key: 
+specification_version: 4
+summary: Finally a dataclass in ruby
+test_files: []