safestruct 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c7bf46e7fc7abcced2da4628ab2640f4f3136482
-  data.tar.gz: 693e1ad041258390403893df801673955e574c7e
+  metadata.gz: 566fae2d8f89cb24afd577666383dd7944811152
+  data.tar.gz: 6b72e279ae328f1fdac760691ad57d92e991ab21
 SHA512:
-  metadata.gz: 2f548ea0b261a9fe0e829ad2205aa21b46ea6cac99ff082a80bcaaa5418fe75e9684200f31033f099450c3b688240664949ad0bbc70ad4f8abf57f197a33020a
-  data.tar.gz: 9fc0faf2c9373cfa146a7f7d5d8b18e17c7ea6e419d10b19d9ab95323650d825bbb3e6b7818c475360aa89101c9f17543731bc07dd02f2e17ce102a5ede5e92e
+  metadata.gz: f756d180e311fef89fc4325bcb873bcaaaa02e73cba6ce8d34081352ff46a99307e76470dadec5ede89ab7ea7869d8d1f8a70260860c452f4a5a8783165bd5c2
+  data.tar.gz: bf9226fd8c07a2f63ee309e5b6ebbd7da7551bcaf350691bf715c9ebb8c7e48250b9b88765ad1dbf8d7c09ee07f46b6e3d39e63684276e759529187e7cbc15e4

data/README.md

@@ -168,7 +168,7 @@ hash['0x0000']         #=> 42
 Note: Safe Hash will ALWAYS return a value.
 If the key is missing in the hash mapping on lookup,
 the key gets auto-added with a zero value.
-Use `has_key?` or `key?` to check if a key is present.
+Use `has_key?` or `key?` to check if a key is present (or missing).
 
 
 Yes, Safe Hash works with structs (or arrays or nested hash mappings) too. Example:
@@ -180,8 +180,22 @@ hash['0x0000']                #=> #<Vote @weight=0, @voted=false, @vote=0, @dele
 hash['0x0000'].voted?         #=> false
 hash['0x0000'].voted = true
 hash['0x0000'].voted?         #=> true
-```
 
+# or
+
+allowances = Hash.of( String => Hash.of( String => Integer ) )
+
+allowances['0x1111']['0xaaaa'] = 100
+allowances['0x1111']['0xbbbb'] = 200
+allowances['0x2222']['0xaaaa'] = 300
+
+allowances['0x1111']['0xaaaa']  #=> 100
+allowances['0x1111']['0xbbbb']  #=> 200
+allowances['0x2222']['0xaaaa']  #=> 300
+
+allowances['0x2222'].delete( '0xaaaa' )
+allowances['0x2222']['0xaaaa']  #=> 0
+```
 
 
 

data/lib/safestruct.rb

@@ -43,15 +43,17 @@ class Hash
      ## e.g. gets passed in [{Address=>Integer}]
      ##  check for Integer - use Hash.new(0)
      ##  check for Bool    - use Hash.new(False)
-     if args[0].is_a? Hash
+     if args[0].is_a?( Hash ) && args.size == 1
        arg = args[0].to_a   ## convert to array (for easier access)
        klass_key   = arg[0][0]
-       klass_value = arg[0][1]
+       ## note: for nested Hash.of or Array.of a ("prototype") object
+       ##        gets passed in (NOT class) - auto-convert to use class
+       klass_or_proto_value = arg[0][1]
+       klass_value = klass_or_proto_value.is_a?( Class ) ? klass_or_proto_value : klass_or_proto_value.class
        klass = Safe::SafeHash.build_class( klass_key, klass_value )
        klass.new
      else
-       ## todo/fix: throw argument error/exception
-       Hash.new    ## that is, "plain" {} with all "standard" defaults
+       raise ArgumentError.new( "[Hash.of] wrong argument; expected (default) hash e.g. String => Integer" )
      end
   end
 end
@@ -61,7 +63,10 @@ class Array
   ## "typed" safe array "constructor"
   ## e.g.  Array.of( Address ) or Array.of( Money ) or
   ##       Array.of( Proposal, 2 ) etc.
-  def self.of( klass_value, size=0 )
+  def self.of( klass_or_proto_value, size=0 )
+    ## note: for nested Hash.of or Array.of a ("prototype") object
+    ##        gets passed in (NOT class) - auto-convert to use class
+    klass_value = klass_or_proto_value.is_a?( Class ) ? klass_or_proto_value : klass_or_proto_value.class
     klass = Safe::SafeArray.build_class( klass_value )
     klass.new( size )
   end

data/lib/safestruct/safe_array.rb

@@ -98,10 +98,12 @@ RUBY
     ##   note: Address might be a String too (Address | String)
     ##     store Address always as String!!! - why? why not?
     @ary.push( item )
+    ## note: returns array.size (NOT array itself!!!) to keep compatible with solidity - why? why not?
+    @ary.size
   end
 
 extend Forwardable
-def_delegators :@ary, :size, :length,
+def_delegators :@ary, :size, :length, :clear,
                       :each, :each_with_index
 
 

data/lib/safestruct/safe_hash.rb

@@ -93,8 +93,10 @@ RUBY
   end
 
   extend Forwardable
-  def_delegators :@h, :size, :length,   ## todo/fix: remove size and length for (safe) hash - why? why not?
-                      :has_key?, :key?
+  def_delegators :@h, :has_key?, :key?, :delete, :clear
+
+  ## note:  remove size and length for (safe) hash (for now) - follows solidity convention - why? why not?
+  ##   :size, :length,
 
 end # class SafeHash
 end # module Safe

data/lib/safestruct/version.rb

@@ -4,7 +4,7 @@
 module Safe
 
   MAJOR = 1
-  MINOR = 0
+  MINOR = 1
   PATCH = 0
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 

data/test/test_array.rb

@@ -15,6 +15,26 @@ class TestArray < MiniTest::Test
   Array_Integer = SafeArray.build_class( Integer )
   Array_Bool    = SafeArray.build_class( Bool )
 
+  ## multi-dimensional / nested  array
+  Array_Array_Integer = SafeArray.build_class( Array_Integer )
+
+
+def test_push_and_clear
+  ary = Array_Integer.new
+
+  ## note: push returns array.size after adding new item
+  ##   std ruby returns reference to array itself
+  assert_equal 0, ary.size
+  assert_equal 1, ary.push( 10 )
+  assert_equal 1, ary.size
+
+  assert_equal 2, ary.push( 20 )
+  assert_equal 2, ary.size
+
+  ary.clear
+  assert_equal 0, ary.size
+end
+
 def test_integer
   pp Array_Integer
   pp ary = Array_Integer.new(2)
@@ -67,5 +87,55 @@ def test_bool
   assert_equal Array_Bool, Array.of( Bool ).class
 end
 
+def test_array_of
+    assert_equal true,  Array.is_a?( Class )
+
+    ary = Array.of( Integer )   # note:Array.of returns a new ("prototype") object and NOT a class
+    assert_equal false, ary.is_a?( Class )
+    assert_equal true,  ary.class.is_a?( Class )
+end
+
+def test_multi  # nested (multi-dimensional) array
+  ## todo/fix: try with size: 3  e.g. 3x3
+  ##   make it work with size too!!!!!
+  ##    remember size if passed in in c'tor!!!!!!
+
+   multi = Array_Array_Integer.new
+   multi.push( Array_Integer.new )
+   multi[0].push( 100 )
+   multi[0].push( 200 )
+   multi.push( Array_Integer.new )
+   multi[1].push( 300 )
+   pp multi
+
+   assert_equal 100, multi[0][0]
+   assert_equal 200, multi[0][1]
+   assert_equal 300, multi[1][0]
+
+   multi[1].clear
+   assert_equal 0, multi[1].size
+   multi.clear
+   assert_equal 0, multi.size
+
+   ##############################################
+   ## try Array.of convenience helper
+
+   multi = Array.of( Array.of( Integer ) )
+   multi.push( Array.of( Integer ) )
+   multi[0].push( 100 )
+   multi[0].push( 200 )
+   multi.push( Array.of( Integer ) )
+   multi[1].push( 300 )
+   pp multi
+
+   assert_equal 100, multi[0][0]
+   assert_equal 200, multi[0][1]
+   assert_equal 300, multi[1][0]
+
+   multi[1].clear
+   assert_equal 0, multi[1].size
+   multi.clear
+   assert_equal 0, multi.size
+end
 
 end # class TestArray

data/test/test_hash.rb

@@ -19,6 +19,9 @@ class TestHash < MiniTest::Test
   Hash_X_Bool    = SafeHash.build_class( String, Bool )
   Hash_X_Voter   = SafeHash.build_class( String, Voter )
 
+  ## nested e.g. String => (String => Integer)
+  Hash_Hash_X_Integer = SafeHash.build_class( String, Hash_X_Integer )
+
 def test_integer
   pp Hash_X_Integer
   pp h = Hash_X_Integer.new
@@ -27,8 +30,8 @@ def test_integer
   assert_equal false, h.has_key?( '0x1111' )
 
   ## todo/fix: remove size and length for (safe) hash - why? why not?
-  assert_equal 0, h.size
-  assert_equal 0, h.length
+  assert_equal 0, h.instance_variable_get('@h').size
+  assert_equal 0, h.instance_variable_get('@h').length
 
   assert_equal Hash_X_Integer.zero, h
   assert_equal Hash_X_Integer.zero, Hash_X_Integer.new
@@ -38,7 +41,7 @@ def test_integer
   assert_equal false,  Hash_X_Integer.new.frozen?
   assert_equal false,  h.frozen?
 
-  
+
   assert_equal Integer, Hash_X_Integer.klass_value
   assert_equal 0,  h['0x1111']
   assert_equal 0,  h['0x2222']
@@ -92,4 +95,47 @@ def test_voter
 end
 
 
+def test_allowances   # nested hash
+   ## allowances = Hash.of( String => Hash.of( String => Integer ) )
+   allowances = Hash_Hash_X_Integer.new
+
+   allowances['0x1111']['0xaaaa'] = 100
+   allowances['0x1111']['0xbbbb'] = 200
+   allowances['0x2222']['0xaaaa'] = 300
+   pp allowances
+
+   assert_equal 100, allowances['0x1111']['0xaaaa']
+   assert_equal 200, allowances['0x1111']['0xbbbb']
+   assert_equal 300, allowances['0x2222']['0xaaaa']
+
+   allowances['0x2222'].delete( '0xaaaa' )
+   assert_equal 0, allowances['0x2222']['0xaaaa']
+
+   ##############################################
+   ## try Hash.of convenience helper
+   allowances = Hash.of( String => Hash.of( String => Integer ))
+
+   allowances['0x1111']['0xaaaa'] = 100
+   allowances['0x1111']['0xbbbb'] = 200
+   allowances['0x2222']['0xaaaa'] = 300
+   pp allowances
+
+   assert_equal 100, allowances['0x1111']['0xaaaa']
+   assert_equal 200, allowances['0x1111']['0xbbbb']
+   assert_equal 300, allowances['0x2222']['0xaaaa']
+
+   allowances['0x2222'].delete( '0xaaaa' )
+   assert_equal 0, allowances['0x2222']['0xaaaa']
+end
+
+
+def test_hash_of
+    assert_equal true,  Hash.is_a?( Class )
+
+    h = Hash.of( String => Integer )   # note:Hash.of returns a new ("prototype") object and NOT a class
+    assert_equal false, h.is_a?( Class )
+    assert_equal true,  h.class.is_a?( Class )
+end
+
+
 end # class TestHash

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: safestruct
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-16 00:00:00.000000000 Z
+date: 2019-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc