lab42_data_class 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70b03224373a4bdfe219cfb5d71d735f4a5b4d02c57531ea0f80a1729e542ce5
-  data.tar.gz: b04020b335831a2c8fb8070bb17056874bb9103c5dda7b0e313da93c8afd80a0
+  metadata.gz: 1819694c4684f3f4e377f04f4eb17d0842a1075ff7859eeef443c66dd7cfb458
+  data.tar.gz: 5af74933329ed924d51a1820d666c671973004edbd3ab00f6ba93378df71180f
 SHA512:
-  metadata.gz: c360a0eb554b9356c92e0a395d09a2dd29dc76f64d2a805ef6ac8e1699a057bb01fc8a41be4bf2f34f3e3ec5d9eff336817541bc59d39f7d94c74131303e2f0d
-  data.tar.gz: 63395d4ede760ce63e7d92753ef370b2da666bafec309dee43f8c8549e768cc653d1976742441b583fd09a1a85535cc783834998ce494b903f2a40d380073a46
+  metadata.gz: 5e14f2656f03703aa867dce065bf9e4770cf043fd97d035cab9a6b869d9fb6e9749c2de3eef0b948e02c7ade07f85f75423c4b2412ed154574a6672e28411d9f
+  data.tar.gz: f831c9c8094f7224de088f6f03847791bcc91a33db6e565fc1ef3f45d5f3f5e29d18b05dfbcdbc7dcc422755d0ab87dc73f0c50a9de45dcd3df0916d87fb1c16

data/README.md

@@ -40,6 +40,7 @@ Well let us [speculate about](https://github.com/RobertDober/speculate_about) it
 
 ## Context `DataClass`
 
+
 ### Context: `DataClass` function
 
 Given
@@ -452,6 +453,47 @@ And remark how bad unnamed validation errors might be
       .to raise_error(validation_error, error_message_rgx)
 ```
 
+### Context: Usage with `extend`
+
+All the above mentioned features can be achieved with a more conventional syntax by extending a class
+with `Lab42::DataClass`
+
+Given a class that extends `DataClass`
+```ruby
+    let :my_class do
+      Class.new do
+        extend Lab42::DataClass
+        attributes :age, member: false
+        constraint :member, Set.new([false, true])
+        validate(:too_young_for_member) { |instance| !(instance.member && instance.age < 18) }
+      end
+    end
+    let(:constraint_error) { Lab42::DataClass::ConstraintError }
+    let(:validation_error) { Lab42::DataClass::ValidationError }
+    let(:my_instance) { my_class.new(age: 42) }
+    let(:my_vip)      { my_instance.merge(member: true) }
+```
+
+Then we can observe that instances of such a class
+```ruby
+    expect(my_instance.to_h).to eq(age: 42, member: false)
+    expect(my_vip.to_h).to eq(age: 42, member: true)
+    expect(my_instance.member).to be_falsy
+```
+
+And we will get constraint errors if applicable
+```ruby
+    expect{my_instance.merge(member: nil)}
+      .to raise_error(constraint_error)
+```
+
+And of course validations still work too
+```ruby
+    expect{ my_vip.merge(age: 17) }
+      .to raise_error(validation_error, "too_young_for_member")
+```
+
+
 ## Context: `Pair` and `Triple`
 
 Two special cases of a `DataClass` which behave like `Tuple` of size 2 and 3 in _Elixir_

data/lib/lab42/data_class/kernel.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+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/data_class/proxy/constraints.rb

@@ -23,6 +23,16 @@ module Lab42
           end
         end
 
+        def define_constraints(constraints)
+          errors = constraints.map(&define_constraint).compact
+          unless errors.empty?
+            raise ArgumentError,
+                  "constraints cannot be defined for undefined attributes #{errors.inspect}"
+          end
+
+          check_constraints_against_defaults(constraints)
+        end
+
         private
 
         def _check_constraint_against_default
@@ -68,13 +78,7 @@ module Lab42
           proxy = self
           ->(*) do
             define_method :with_constraint do |**constraints|
-              errors = constraints.map(&proxy.define_constraint).compact
-              unless errors.empty?
-                raise ArgumentError,
-                      "constraints cannot be defined for undefined attributes #{errors.inspect}"
-              end
-
-              proxy.check_constraints_against_defaults(constraints)
+              proxy.define_constraints(constraints)
               self
             end
           end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Lab42
+  module DataClass
+    class Proxy
+      module Memos
+        def constraints
+          @__constraints__ ||= Hash.new { |h, k| h[k] = [] }
+        end
+
+        def defaults
+          @__defaults__ ||= {}
+        end
+
+        def members
+          @__members__ ||= unless (positionals + defaults.keys).empty?
+                             Set.new(positionals + defaults.keys)
+                           end
+        end
+
+        def positionals
+          @__positionals__ ||= []
+        end
+
+        def validations
+          @__validations__ ||= []
+        end
+
+        private
+
+        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
+end
+#  SPDX-License-Identifier: Apache-2.0

data/lib/lab42/data_class/proxy.rb

@@ -2,22 +2,22 @@
 
 require 'set'
 require_relative 'proxy/constraints'
+require_relative 'proxy/memos'
 require_relative 'proxy/validations'
 require_relative 'proxy/mixin'
 module Lab42
   module DataClass
     class Proxy
-      include Constraints, Validations
+      include Constraints, Memos, Validations
 
-      attr_reader :actual_params, :all_params, :block, :constraints, :defaults, :klass, :members, :positionals
+      attr_reader :actual_params, :block, :klass
 
       def check!(**params)
         @actual_params = params
-        @all_params = defaults.merge(params)
         raise ArgumentError, "missing initializers for #{_missing_initializers}" unless _missing_initializers.empty?
         raise ArgumentError, "illegal initializers #{_illegal_initializers}" unless _illegal_initializers.empty?
 
-        _check_constraints!(all_params)
+        _check_constraints!(defaults.merge(params))
       end
 
       def define_class!
@@ -39,21 +39,22 @@ module Lab42
           .to_h
       end
 
-      def validations
-        @__validations__ ||= []
+      def update!(with_positionals, with_keywords)
+        positionals.push(*with_positionals)
+        defaults.update(with_keywords)
       end
 
       private
       def initialize(*args, **kwds, &blk)
-        @klass = Class.new
-
-        @constraints = Hash.new { |h, k| h[k] = [] }
+        @klass = if Class === args.first
+                   args.shift
+                 else
+                   Class.new
+                 end
 
         @block = blk
-        @defaults = kwds
-        @members = Set.new(args + kwds.keys)
-        # TODO: Check for all symbols and no duplicates ⇒ v0.5.1
-        @positionals = args
+        defaults.update(kwds)
+        positionals.push(*args)
       end
 
       def _define_attr_reader
@@ -128,16 +129,6 @@ module Lab42
           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

data/lib/lab42/data_class/version.rb

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

data/lib/lab42/data_class.rb

@@ -1,24 +1,34 @@
 # frozen_string_literal: true
 
 require_relative './data_class/constraint_error'
+require_relative './data_class/kernel'
 require_relative './data_class/validation_error'
 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
+module Lab42
+  module DataClass
+    def self.extended(extender)
+      proxy = Proxy.new(extender)
 
-  def Pair(first, second)
-    Lab42::Pair.new(first, second)
-  end
+      extender.module_eval do
+        define_singleton_method(:__data_class_proxy__){ proxy }
+      end
+    end
+
+    def attributes(*args, **kwds)
+      __data_class_proxy__.tap do |proxy|
+        proxy.update!(args, kwds)
+        proxy.define_class!
+      end
+    end
 
-  def Triple(first, second, third)
-    Lab42::Triple.new(first, second, third)
+    def constraint(member, constraint = nil, &block)
+      raise ArgumentError, "must not provide constraint (2nd argument) and a block" if block && constraint
+
+      __data_class_proxy__.define_constraints(member => constraint || block)
+    end
   end
 end
-
 #  SPDX-License-Identifier: Apache-2.0

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: lab42_data_class
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Robert Dober
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
 date: 2022-02-24 00:00:00.000000000 Z
@@ -25,9 +25,11 @@ files:
 - README.md
 - lib/lab42/data_class.rb
 - lib/lab42/data_class/constraint_error.rb
+- lib/lab42/data_class/kernel.rb
 - lib/lab42/data_class/proxy.rb
 - lib/lab42/data_class/proxy/constraints.rb
 - lib/lab42/data_class/proxy/constraints/maker.rb
+- lib/lab42/data_class/proxy/memos.rb
 - lib/lab42/data_class/proxy/mixin.rb
 - lib/lab42/data_class/proxy/validations.rb
 - lib/lab42/data_class/validation_error.rb
@@ -39,7 +41,7 @@ homepage: https://github.com/robertdober/lab42_data_class
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -55,7 +57,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: []