safestruct 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 45b65afeb50dbc59c31112c55d488a76b0de48b5
-  data.tar.gz: 82b0e94423bfd55c11d4d4667d29017ec7e12cea
+  metadata.gz: e5b47433e234edeb8d8ddddfaa7d6eac51ce1845
+  data.tar.gz: 49d711cfbef0941d9cf91762c47858d790d96ef2
 SHA512:
-  metadata.gz: 13400c0b1154a455baae1b46108186e1c5d8a6cc03608f0a924b21fb8656b61182b803e9c63c5a3fc2138c0b0ed1b516e0f5f1ae7ff252be6e39e9c313e8cb31
-  data.tar.gz: 80f08cf43e05456ee749e5a2249191cfd74bb7149512c3169ae98db305b3caa3ae8ce60971184324c546f8a7f284d41c8b8e234b3b3819a97e9314f2843f116d
+  metadata.gz: 2ea81799da3ab6d4a4dca8468a5b7515c6ee64717b5350577ad0f8cad32cc2db423fe90ed7d69e018da40044a9d70fa9f643f8723214109d998507f11216dd57
+  data.tar.gz: c4e4388b63a6771fbd98c34aa4bd8599e7a0d70a7efa8400c30461409af833fba0e8bef75a7171fee0e19ea0285b680f8c45c0213c2086b87c68a274206db484

data/README.md

@@ -94,11 +94,13 @@ Note: You can use `Struct` as an alias for `SafeStruct`
 class method macro:
 
 ``` ruby
-struct( 'Voter', weight: 0, voted: false, vote: 0, delegate: '0x0000')
+struct( :Voter, weight: 0, voted: false, vote: 0, delegate: '0x0000')
 # or
-struct 'Voter', weight: 0, voted: false, vote: 0, delegate: '0x0000'
+struct :Voter, { weight: 0, voted: false, vote: 0, delegate: '0x0000' }
 # or
-struct 'Voter',
+struct :Voter, weight: 0, voted: false, vote: 0, delegate: '0x0000'
+# or
+struct :Voter,
   weight:    0,
   voted:     false,
   vote:      0,
@@ -211,6 +213,57 @@ allowances['0x2222'].delete( '0xaaaa' )
 allowances['0x2222']['0xaaaa']  #=> 0
 ```
 
+### Bonus: Auto-Generated Unicode (UTF-8) Class Constants / Names for Pretty Printing
+
+Did you know? Yes, you can use unicode characters in your identifiers.
+The safe data structures library auto-generates unicode class constants / names
+for pretty printing and more. Examples:
+
+| Class Builder                          | Class Constant / Name |
+|----------------------------------------|-----------------------|
+| `Array.of( Integer )`                  | `Array‹Integer›` |
+| `Array.of( Bool )`                     | `Array‹Bool›`    |
+| `Array.of( Bool, 2 )`                  | `Array‹Bool›×2`  |
+| `Array.of( Vote )`                     | `Array‹Vote›`    |
+| `Array.of( Array.of( Integer, 3), 3 )` | `Array‹Array‹Integer›×3›×3`  |
+| `Hash.of( String => Integer )`         | `Hash‹String→Integer›`       |
+| `Hash.of( String => Vote )`            | `Hash‹String→Vote›`          |
+| `Hash.of( String => Hash.of( String => Integer ))` | `Hash‹String→Hash‹String→Integer››` |
+| ...                                                |                                     |
+
+
+Note, and yes if the typing is not too much - you can use
+the "magic" names in your code too. Example:
+
+``` ruby
+ary = Array‹Integer›.new
+ary.size       #=> 0
+ary[0]         #=> IndexError: index 0 outside of array bounds
+ary.size = 2   #=> [0,0]
+ary[0]         #=> 0
+
+# or
+
+another_ary = Array‹Bool›×2.new
+another_ary.size      #=> 2
+another_ary[0]        #=> false
+
+# or
+
+hash = Hash‹String→Integer›.new
+hash['0x0000']         #=> 0
+hash['0x0000'] += 42
+hash['0x0000']         #=> 42
+
+# or
+
+allowances = Hash‹String→Hash‹String→Integer››.new
+allowances['0x1111']['0xaaaa'] = 100
+allowances['0x1111']['0xbbbb'] = 200
+allowances['0x2222']['0xaaaa'] = 300
+```
+
+and so on.
 
 
 ### What about Safe Enumeration (Integer) Types?

data/lib/safestruct.rb

@@ -89,14 +89,15 @@ class Array
 end
 
 
-module Classic   ## use/add Unsafe alias too - why? why not?
+module Standard
   ############################
   # note: HACK redefine built in struct in module Safe "context"
   Struct = ::Struct        ## save old classic struct class
-
-  ### add Hash and Array too - why? why not?
+  Array  = ::Array
+  Hash   = ::Hash
 end
-
+## use/add Unsafe alias too - why? why not?
+Std = Standard ## add alias lets use you use Std::Struct,Std::Array, Std::Hash etc.
 
 
 

data/lib/safestruct/safe_array.rb

@@ -40,12 +40,12 @@ class SafeArray
 
       ## note: also add a Constant to Safe for easy debugging and (re)use - will "auto"name class
       class_name = "Array"
-      class_name << "#{size}"  if size > 0   ## add size if non-zero
 
       name = klass_value.name
       name = name.sub( /\bSafe::/, '' )   ## remove safe module from name if present
       name = name.gsub( '::', '' )        ## remove module separator if present
-      class_name << "_#{name}"
+      class_name << "‹#{name}›"
+      class_name << "×#{size}"  if size > 0   ## add size if non-zero
       Safe.const_set( class_name, klass )
     end
     klass

data/lib/safestruct/safe_hash.rb

@@ -7,6 +7,12 @@ class SafeHash
   def self.debug?()      @debug ||= false; end
   def self.debug=(value) @debug = value; end
 
+  ## let's you configure the class name used for auto-generation class constants
+  ##  e.g. use SafeHash.klass_name = 'Mapping' to rename from (default) 'Hash'
+  def self.klass_name()        @@klass_name ||= 'Hash'; end
+  def self.klass_name=(value)  @@klass_name = value; end
+
+
 
   ## e.g.
   ##  Hash.of( Address => Money )
@@ -22,9 +28,13 @@ class SafeHash
 
     ## note: keep a class cache
     cache = @@cache ||= {}
-    klass = cache[ klass_value ]
+    cache_all_values = cache[ klass_key ] ||= {}
+    klass = cache_all_values[ klass_value ]
+
     if debug?
-      puts "[debug] SafeHash - build_class klass_value:"
+      puts "[debug] SafeHash - build_class( klass_key, klass_value ):"
+      pp klass_key
+      pp klass_key.to_s    ## note: for "anonymous" class something like #<Class:>
       pp klass_value
       pp klass_value.to_s    ## note: for "anonymous" class something like #<Class:>
     end
@@ -54,16 +64,20 @@ class SafeHash
 # RUBY
 
       ## add to cache for later (re)use
-      cache[ klass_value ] = klass
+      cache[ klass_key ][ klass_value ] = klass
 
       ## note: also add a Constant to Safe for easy debugging and (re)use - will "auto"name class
-      ##   note: use X for now for key class name
-      class_name = "Hash_X"
+      class_name = "#{klass_name}"
+
+      key_name = klass_key.name
+      key_name = key_name.sub( /\bSafe::/, '' )   ## remove safe module from name if present
+      key_name = key_name.gsub( '::', '' )        ## remove module separator if present
+
+      value_name = klass_value.name
+      value_name = value_name.sub( /\bSafe::/, '' )   ## remove safe module from name if present
+      value_name = value_name.gsub( '::', '' )        ## remove module separator if present
 
-      name = klass_value.name
-      name = name.sub( /\bSafe::/, '' )   ## remove safe module from name if present
-      name = name.gsub( '::', '' )        ## remove module separator if present
-      class_name << "_#{name}"
+      class_name << "‹#{key_name}→#{value_name}›"
       if debug?
         puts "[debug] SafeHash - class_name >#{class_name}<"
       end
@@ -87,18 +101,18 @@ class SafeHash
 
   def initialize
     ## todo/check: if hash works if value is a (nested) hash
-    @h = {}
+    @table = {}
   end
 
   def freeze
     super
-    @h.freeze  ## note: pass on freeze to "wrapped" hash
+    @table.freeze  ## note: pass on freeze to "wrapped" hash
     self   # return reference to self
   end
 
   def ==( other )
-    if other.is_a?( self.class )                    ## note: must be same hash class
-      @h == other.instance_variable_get( '@h' )    ## compare "wrapped" hash
+    if other.is_a?( self.class )                    ## note: must be same hash (table) class
+      @table == other.instance_variable_get( '@table' )    ## compare "wrapped" hash
     else
       false
     end
@@ -109,11 +123,11 @@ class SafeHash
 
 
   def []=(key, value)
-    @h[key] = value
+    @table[key] = value
   end
 
   def [](key)
-    item = @h[ key ]
+    item = @table[ key ]
     if item.nil?
       ## pp self.class.klass_value
       ## pp self.class.klass_value.zero
@@ -126,17 +140,17 @@ class SafeHash
       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
+        item = @table[ 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
+        item = @table[ key ] = self.class.klass_value.zero
       end
     end
     item
   end
 
   extend Forwardable
-  def_delegators :@h, :has_key?, :key?, :delete, :clear
+  def_delegators :@table, :has_key?, :key?, :delete, :clear
 
   ## note:  remove size and length for (safe) hash (for now) - follows solidity convention - why? why not?
   ##   :size, :length,

data/lib/safestruct/version.rb

@@ -11,8 +11,8 @@
 module SaferStruct
 
   MAJOR = 1
-  MINOR = 2
-  PATCH = 2
+  MINOR = 3
+  PATCH = 0
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
   def self.version

data/test/test_hash.rb

@@ -46,8 +46,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.instance_variable_get('@h').size
-  assert_equal 0, h.instance_variable_get('@h').length
+  assert_equal 0, h.instance_variable_get('@table').size
+  assert_equal 0, h.instance_variable_get('@table').length
 
   assert_equal true, Hash_X_Integer.zero == h
   assert_equal true, Hash_X_Integer.zero == Hash_X_Integer.new

data/test/voter.rb

@@ -3,17 +3,25 @@
 
 module Safe
 
-## sig: [Integer, Bool, Integer, Address]
+##[sig(Integer, Bool, Integer, Address)]
+##
 ## Struct.new( :Voter,
 ##  weight:   0,
 ##  voted:    false,
 ##  vote:     0,
 ##  delegate: '0x0000' )
 
-  struct :Voter,
+  struct :Voter, {
     weight:   0,
     voted:    false,
     vote:     0,
-    delegate: '0x0000'
+    delegate: '0x0000' }
+
+### -or-
+# struct :Voter,
+#   weight:   0,
+#   voted:    false,
+#   vote:     0,
+#   delegate: '0x0000'
 
 end # module Safe

metadata

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