lab42_checked_class 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6a2f963809a4e9d945d7f856d5ed6e8bd2af2462e6af8f1c27ec666900adf89
-  data.tar.gz: b40b601f78decd3af0d7ee5e24e097f64bd546381e92b7d17cd6be532de80431
+  metadata.gz: ff1daba1d7c01bd5f4af095171c104f71fdaa6d180659ebdf6fdbb86a6f9c6e9
+  data.tar.gz: ac04957601c51e0a505dfb2621a5f44ff3664aeb09a0e00d412fba45de71bc33
 SHA512:
-  metadata.gz: 909347acc4fe94f3573718e6a74f325a438dbd4c05af727356c2defce73cac2e4a8e0e80748f6c0333e5cb0b3aff25da52433ab836d76701caf0a33bcca5949d
-  data.tar.gz: 66921f5b30a49125c5a437a494260dd7c5602e27088d0b34c280cb6eccee9b151cac5582fb15a1ba5e0af224895ca367ce33765614fbca0a00bed3c077b4d6e7
+  metadata.gz: cae9380f7d40546c63af28f0abdb59bca958298208cc9b9ec39b1d0ca93acbdfd3eeec642af53e9eeceae9c75259abe79ce7b313dd6be33e6a4d52da7c94755c
+  data.tar.gz: a57c32b8094f45501ca71c7bbcf77fa3880732ecadcff5b56ce44a50df824b458cdc6ba4a391c2f12ce58dc32416776b833e0d9ca1f6ab1b159716bf17aead7d

data/README.md

@@ -58,8 +58,27 @@ These specs assume the following setup code
     require 'lab42/checked_class'
     CheckedClass = Lab42::CheckedClass
     ConstraintError = CheckedClass::ConstraintError
+    Constraint = CheckedClass::Constraint
 ```
+This is realized in the spec_helper, but if you want to have these three constants in your namespace you can
+do the following:
 
+## Context: Importing constants into your namespace
+
+Then we will get them loaded
+```ruby
+  expected_output = <<~EOT
+  #{ENV["PWD"]}/lib/lab42/checked_class/all.rb:5: warning: already initialized constant CheckedClass
+  #{ENV["PWD"]}/spec/spec_helper.rb:36: warning: previous definition of CheckedClass was here
+  #{ENV["PWD"]}/lib/lab42/checked_class/all.rb:6: warning: already initialized constant Constraint
+  #{ENV["PWD"]}/spec/spec_helper.rb:37: warning: previous definition of Constraint was here
+  #{ENV["PWD"]}/lib/lab42/checked_class/all.rb:7: warning: already initialized constant ConstraintError
+  #{ENV["PWD"]}/spec/spec_helper.rb:38: warning: previous definition of ConstraintError was here
+  EOT
+  expect {
+    require 'lab42/checked_class/all'
+  }.to output(expected_output).to_stderr
+```
 ## Context: Attribute definitions and constraints
 
 Given a checked class
@@ -119,7 +138,40 @@ And also we cannot create an instance that violates the constraints
     expect { MyChecked.new(a: 10, c: -4, e: 90, f: 0) }.to raise_error(ConstraintError, "a + b > e")
 ```
 
-## Context: More on constraints
+### Context: Defining attributes with `method` missing.
+
+As long as a method is called that is not defined inside the `attributes` block, it will be
+interpreted as an attribute definition, as it cannot have a default value assigned, we can
+also use the `defaults` macro
+
+Given such implicit attribute definitions
+```ruby
+    Implicit = Class.new do
+      extend CheckedClass
+      attributes do
+        alpha Numeric
+        beta Constraint.bool?
+
+        defaults alpha: 0, beta: true
+      end
+    end
+    let(:instance) { Implicit.new }
+```
+
+Then we can access the implicitly defined attributes
+```ruby
+    expect(instance.to_h).to eq(alpha: 0, beta: true)
+```
+And we will get a constraint error as expeced
+```ruby
+    expected_message = "bool? constraint for beta"
+    expect { instance.update(beta: 42) }
+      .to raise_error(ConstraintError, expected_message)
+```
+
+You can see all predefined builtin constraints [here](speculations/built_in_constraints.md)
+
+## Context: Runtime Semantics of Constraints
 
 ### Context: Checked und unchecked attribute updates
 

data/lib/lab42/checked_class/all.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'lab42/checked_class'
+
+CheckedClass = Lab42::CheckedClass
+Constraint = CheckedClass::Constraint
+ConstraintError = CheckedClass::ConstraintError
+
+# SPDX-License-Identifier: AGPL-3.0-or-later

data/lib/lab42/checked_class/constraint/predefined.rb

@@ -0,0 +1,24 @@
+
+# frozen_string_literal: true
+module Lab42
+  module CheckedClass
+    class Constraint
+      module Predefined
+
+        def bool? =
+          tagged('bool?') { [false, true].member? it } 
+
+        def match?(rgx) =
+          tagged("match?(#{rgx}") { rgx === it rescue false }
+
+        def member?(container) =
+          tagged("member?(#{container.inspect}") { container.member? it }
+
+        private
+        def tagged(name, &blk) = [self, blk, name]
+
+      end
+    end
+  end
+end
+# SPDX-License-Identifier: AGPL-3.0-or-later

data/lib/lab42/checked_class/constraint.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
+require_relative 'constraint/predefined'
 module Lab42
   module CheckedClass
     class Constraint
+      extend Predefined
+
 
       def check(subject)
         subject = @attr ? subject[@attr] : subject
@@ -31,6 +34,9 @@ module Lab42
           -> { it.send(*args) }
         in Module
           -> { constraint === it }
+        in [Predefined, blk, name]
+          @name = [name, @name].join(' ')   
+          blk
         in nil
           blk
         in _

data/lib/lab42/checked_class/injector.rb

@@ -59,6 +59,13 @@ module Lab42
             constraint_checker.check!(self)
           end
 
+          define_method :legal? do
+            check!
+            true
+          rescue ConstraintError
+            false
+          end
+
           define_method :to_h do
             attributes.inject(Hash.new) { |result, ele|
               result.update(ele => self[ele])

data/lib/lab42/checked_class/proxy.rb

@@ -52,12 +52,24 @@ module Lab42
         _constraints["object"] << Constraint.new(name:, &blk)
       end
 
+      def defaults(**params)
+        params.each do |k,  v|
+          raise ArgumentError, "must not redefine default for key #{k.inspect}" if _defaults.has_key?(k)
+
+          _defaults[k] = v
+        end
+      end
+
       def init(&blk)
         raise ArgumentError, "init needs a block" unless blk
 
         @init = blk
       end
 
+      def method_missing(name, *a, **k, &b)
+        attr(name, *a, **k, &b)
+      end
+
       def _define_att(name, constraint = nil, default: None, &blk)
         _attributes << name
 

data/lib/lab42/checked_class/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 module Lab42
   module CheckedClass
-    VERSION = '0.1.1'
+    VERSION = '0.2.0'
   end
 end
 # SPDX-License-Identifier: AGPL-3.0-or-later

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lab42_checked_class
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Robert Dober
@@ -20,8 +20,10 @@ files:
 - LICENSE
 - README.md
 - lib/lab42/checked_class.rb
+- lib/lab42/checked_class/all.rb
 - lib/lab42/checked_class/argument_checker.rb
 - lib/lab42/checked_class/constraint.rb
+- lib/lab42/checked_class/constraint/predefined.rb
 - lib/lab42/checked_class/constraint_checker.rb
 - lib/lab42/checked_class/constraint_error.rb
 - lib/lab42/checked_class/injector.rb