safestruct 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 04e5c95875cd6c4fbdd2865525ed7853d5c549e3
-  data.tar.gz: c2f2eab9840be5183219caec2132c08b5a6d9297
+  metadata.gz: f085259a240f99941fe60eef6a271a6066e649d3
+  data.tar.gz: a289d416c0ade1aa76eae8e0c897fac7b63e6700
 SHA512:
-  metadata.gz: 552e6f386d52b6b4bbd312b2c80f9f09073eb187fbb899e0de0d4e0070477da7e8f9bd520bc56c0bdee6fef8462af634c42045ebc87d8c307ff5cd1c4b0003d3
-  data.tar.gz: 82725de07669291702ce15b805f24073abe8dce0131f89d98e346c9e19f309d60e1b083c58a04e455a1c950f2674602b8c3e06a1c505463ac9ca68eb7e952bcb
+  metadata.gz: 7a71c903f7ecddfe2a42c48465f7a76969db5566e7d0cdf18bf53878f5bad067c7b7e86029a1516e5515124547a6ce5a2c9badc36f84e1a1ca05cb6fcd049e65
+  data.tar.gz: aade5b05f5666e89204cd5b95a4561829d7f70bae9380a7d204013527bdd03e21757c9f30f379c74f5ced2b558e25b702ccf1cbcaa13cd2d4e9df71c833688fb

data/Rakefile

@@ -3,7 +3,7 @@ require './lib/safestruct/version.rb'
 
 Hoe.spec 'safestruct' do
 
-  self.version = Safe::VERSION
+  self.version = SaferStruct::VERSION
 
   self.summary = "safestruct - safe data structures (array, hash, struct) - say goodbye to null / nil (and maybe) - say hello to zero"
   self.description = summary

data/lib/safestruct.rb

@@ -19,19 +19,31 @@ require 'safestruct/safe_struct'
 ####################################
 ## add zero/zero_new machinery for builin classes
 
-#### value semantics
+#########################
+#### with value semantics
 class Integer
   def self.zero() 0; end      ## note: 0.frozen? == true  by default
+  def zero?() self == self.class.zero;  end
 end
 
 class Bool
   def self.zero() false; end   ## note: false.frozen? == true  by default
 end
 
-#### reference semantics (new copy ALWAYS needed)
+class TrueClass    # note: ruby has no builtin/default bool (base) class only TrueClass|FalseClass
+  def zero?() false; end
+end
+
+class FalseClass
+  def zero?() true; end
+end
+
+##################
+#### with reference semantics (new copy ALWAYS needed)
 class String
   def self.new_zero() new; end
   def self.zero() @zero ||= new_zero.freeze;  end
+  def zero?() self == self.class.zero; end
 end
 
 
@@ -90,9 +102,14 @@ module Safe
     def struct( class_name, **attributes )
       SafeStruct.new( class_name, attributes )
     end
+
+    ### note: do NOT add helpers for
+    ##   - hash( class_name, ...)  and
+    ##   - array( class_name, ...) for now
+    ##   why? why not? needs more testing/considerations for overloading / breaking builtin defaults
   end # module ClassMethods
 end # module Safe
 
 
 
-puts Safe.banner    ## say hello
+puts SaferStruct.banner    ## say hello

data/lib/safestruct/safe_array.rb

@@ -18,14 +18,23 @@ class SafeArray
     if klass.nil?
 
       klass = Class.new( SafeArray )
-      klass.class_eval( <<RUBY )
-        def self.klass_value
-          @klass_value ||= #{klass_value}
-        end
-        def self.klass_size
-          @klass_size  ||= #{size}
-        end
-RUBY
+      klass.define_singleton_method( :klass_value ) do
+        @klass_value ||= klass_value
+      end
+      klass.define_singleton_method( :klass_size ) do
+        @klass_size  ||= size
+      end
+
+      ##### was: not working for anymous class e.g. klass_value.to_s => #<Class:>
+#      klass.class_eval( <<RUBY )
+#        def self.klass_value
+#          @klass_value ||= #{klass_value}
+#        end
+#        def self.klass_size
+#          @klass_size  ||= #{size}
+#        end
+# RUBY
+
       ## add to cache for later (re)use
       cache[ klass_value ][ size ] = klass
     end
@@ -36,6 +45,8 @@ RUBY
   def self.new_zero()  new;  end
   def self.zero()      @zero ||= new_zero.freeze;  end
 
+  def zero?()   self == self.class.zero; end
+
 
   def initialize( size=self.class.klass_size )
     @ary  = []
@@ -71,11 +82,11 @@ RUBY
       ## note: use a new unfrozen copy of the zero object
       ##    changes to the object MUST be possible (new "empty" modifable object expected)
       diff.times { @ary << self.class.klass_value.new_zero }
-   else  # assume value semantics e.g. Integer, Bool, etc. zero values gets replaced
+    else  # assume value semantics e.g. Integer, Bool, etc. zero values gets replaced
       ## puts "use value semantics"
       diff.times { @ary << self.class.klass_value.zero }
-   end
-   self  # return reference to self
+    end
+    self  # return reference to self
   end
   alias_method :'length=', :'size='
 

data/lib/safestruct/safe_hash.rb

@@ -26,6 +26,7 @@ class SafeHash
     if debug?
       puts "[debug] SafeHash - build_class klass_value:"
       pp klass_value
+      pp klass_value.to_s    ## note: for "anonymous" class something like #<Class:>
     end
 
     if klass.nil?
@@ -34,14 +35,24 @@ class SafeHash
       end
 
       klass = Class.new( SafeHash )
-      klass.class_eval( <<RUBY )
-        def self.klass_key
-          @klass_key   ||= #{klass_key}
-        end
-        def self.klass_value
-          @klass_value ||= #{klass_value}
-        end
-RUBY
+
+      klass.define_singleton_method( :klass_key ) do
+        @klass_key ||= klass_key
+      end
+      klass.define_singleton_method( :klass_value ) do
+        @klass_value ||= klass_value
+      end
+
+      ### was:  - NOT working for "anonymous" classes e.g. klass_value.to_s starting with #<Class:>
+      # klass.class_eval( <<RUBY )
+      #  def self.klass_key
+      #    @klass_key   ||= #{klass_key}
+      #  end
+      #  def self.klass_value
+      #    @klass_value ||= #{klass_value}
+      #  end
+# RUBY
+
       ## add to cache for later (re)use
       cache[ klass_value ] = klass
     else
@@ -58,6 +69,8 @@ RUBY
   def self.new_zero()  new;  end
   def self.zero()      @zero ||= new_zero.freeze;  end
 
+  def zero?() self == self.class.zero; end
+
 
   def initialize
     ## todo/check: if hash works if value is a (nested) hash
@@ -100,11 +113,11 @@ RUBY
       if self.class.klass_value.respond_to?( :new_zero )
         ## note: use a dup(licated) unfrozen copy of the zero object
         ##    changes to the object MUST be possible (new "empty" modifable object expected)
-       item = @h[ key ] = self.class.klass_value.new_zero
-     else  # assume value semantics e.g. Integer, Bool, etc. zero values gets replaced
-       ## puts "use value semantics"
-       item = @h[ key ] = self.class.klass_value.zero
-     end
+        item = @h[ key ] = self.class.klass_value.new_zero
+      else  # assume value semantics e.g. Integer, Bool, etc. zero values gets replaced
+        ## puts "use value semantics"
+        item = @h[ key ] = self.class.klass_value.zero
+      end
     end
     item
   end

data/lib/safestruct/safe_struct.rb

@@ -21,7 +21,7 @@ def self.build_class( class_name, **attributes )
  ## check if valid class_name MUST start with uppercase letter etc.
  ##  todo/fix: check if constant is undefined in Safe namespace!!!!
 
-  
+
   klass = Class.new( SafeStruct ) do
     define_method( :initialize ) do |*args|
       attributes.keys.zip( args ).each do |key, arg|
@@ -100,13 +100,13 @@ def self.build_class( class_name, **attributes )
   end
 
 
-  ## note: use Object for "namespacing"
+  ## note: use Kernel for "namespacing"
   ##   make all enums convenience converters (always) global
   ##     including uppercase methods (e.g. State(), Color(), etc.) does NOT work otherwise (with other module includes)
 
-  ## add global convenience converter function
+  ## add global "Kernel" convenience converter function
   ##  e.g. Vote(0) is same as Vote.convert(0)
-  Object.class_eval( <<RUBY )
+  Kernel.class_eval( <<RUBY )
     def #{class_name}( arg )
        #{class_name}.convert( arg )
     end
@@ -130,5 +130,9 @@ def self.zero
   ##   freeze only works for now for "value" objects e.g. integer, bool, etc.
   @zero ||= new_zero.freeze
 end
+
+def zero?() self == self.class.zero; end
+
+
 end # class SafeStruct
 end # module Safe

data/lib/safestruct/version.rb

@@ -1,11 +1,18 @@
 # encoding: utf-8
 
 
-module Safe
+###
+# note: do not "pollute" Safe namespace / module
+#  use its own module
+#
+#  note: SafeStruct is already taken :-), thus, use SaferStruct
+
+
+module SaferStruct
 
   MAJOR = 1
   MINOR = 2
-  PATCH = 0
+  PATCH = 1
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
   def self.version
@@ -20,4 +27,4 @@ module Safe
     "#{File.expand_path( File.dirname(File.dirname(File.dirname(__FILE__))) )}"
   end
 
-end # module Safe
+end # module SaferStruct

data/test/test_hash.rb

@@ -23,6 +23,20 @@ class TestHash < MiniTest::Test
   ## nested e.g. String => (String => Integer)
   Hash_Hash_X_Integer = SafeHash.build_class( String, Hash_X_Integer )
 
+  SafeStruct.new( :Game123, host:       '',
+                            challenger: '',
+                            turn:       '')
+
+def test_hash_of_hash
+  ## note: use Game123 (with unique/unused name)
+  ##   for testing an "anonymous" hash class (e.g. without a class name)
+   h = Hash.of( String => Hash.of( String => Game123 ))
+   pp h
+   h2 = Hash.of( String => Hash.of( String => Game123 ))
+   pp h2
+   assert true
+end
+
 
 def test_integer
   pp Hash_X_Integer
@@ -39,6 +53,11 @@ def test_integer
   assert_equal true, Hash_X_Integer.zero == Hash_X_Integer.new
   assert_equal true, Hash_X_Integer.zero == Hash_X_Integer.new_zero
 
+  assert_equal true, h.zero?
+  assert_equal true, Hash_X_Integer.zero.zero?
+  assert_equal true, Hash_X_Integer.new.zero?
+  assert_equal true, Hash_X_Integer.new_zero.zero?
+
   pp Hash_X_Integer.zero
   assert_equal true,   Hash_X_Integer.zero.frozen?
   assert_equal false,  Hash_X_Integer.new.frozen?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: safestruct
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-07 00:00:00.000000000 Z
+date: 2019-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: enums