safestruct 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e972352c0dbb2c3684a3de9385f33efb706a7cca
-  data.tar.gz: 9fb3502f891afab88650aa288bfc39d84ac5f236
+  metadata.gz: 04e5c95875cd6c4fbdd2865525ed7853d5c549e3
+  data.tar.gz: c2f2eab9840be5183219caec2132c08b5a6d9297
 SHA512:
-  metadata.gz: de271ceb36e33cf627911d60e69c5120e2e8cde48ac84d1ef258571a98e36757695345b4e3ac58a77e0086e76f8ad393a13a6567f8b738fe380c41a47c63bb94
-  data.tar.gz: 4863ee4959e548d6686ca1020b8be99897a0945ebb3eef35becc7bc77d028ba1858d0d2c9b4e6f9b9066baedf636c6c3b2911aaa8a49d1e1b33bda9c2b6420e8
+  metadata.gz: 552e6f386d52b6b4bbd312b2c80f9f09073eb187fbb899e0de0d4e0070477da7e8f9bd520bc56c0bdee6fef8462af634c42045ebc87d8c307ff5cd1c4b0003d3
+  data.tar.gz: 82725de07669291702ce15b805f24073abe8dce0131f89d98e346c9e19f309d60e1b083c58a04e455a1c950f2674602b8c3e06a1c505463ac9ca68eb7e952bcb

data/Manifest.txt

@@ -12,3 +12,4 @@ test/helper.rb
 test/test_array.rb
 test/test_hash.rb
 test/test_struct.rb
+test/voter.rb

data/README.md

@@ -61,7 +61,7 @@ Let's you define (auto-build) new struct classes.
 Example:
 
 ``` ruby
-Voter = SafeStruct.new( weight: 0, voted: false, vote: 0, delegate: '0x0000' )
+SafeStruct.new( 'Voter', weight: 0, voted: false, vote: 0, delegate: '0x0000' )
 
 voter1 = Voter.new    # or Voter.new_zero
 voter1.weight      #=> 0
@@ -71,6 +71,7 @@ voter1.delegate    #=> '0x0000'
 voter1.frozen?     #=> false
 
 voter1 == Voter.zero    #=> true
+voter1 == Voter(0)      #=> true
 
 voter1.delegate = '0x1111'
 voter1 == Voter.zero    #=> false
@@ -89,7 +90,20 @@ voter3 = Voter.new( 0 )  #=> ArgumentError: wrong number of arguments
 
 
 Note: You can use `Struct` as an alias for `SafeStruct`
-(in the `Safe` namespace / module context).
+(in the `Safe` namespace) or use the `struct`
+class method macro:
+
+``` ruby
+struct( 'Voter', weight: 0, voted: false, vote: 0, delegate: '0x0000')
+# or
+struct 'Voter', weight: 0, voted: false, vote: 0, delegate: '0x0000'
+# or
+struct 'Voter',
+  weight:    0,
+  voted:     false,
+  vote:      0,
+  delegate: '0x0000'
+```
 
 
 ### Safe Array
@@ -199,6 +213,23 @@ allowances['0x2222']['0xaaaa']  #=> 0
 
 
 
+### What about Safe Enumeration (Integer) Types?
+
+Yes, yes, yes. The `Enum` class from the enums library gets auto-required.
+Use like:
+
+``` ruby
+Enum.new( 'Color', :red, :green, :blue )
+## or
+enum 'Color', :red, :green, :blue
+## or
+enum 'Color', [:red, :green, :blue]
+```
+
+See the [enums library documentation for more »](https://github.com/s6ruby/enums)
+
+
+
 ## More "Real World" Safe Data Structures (Array, Hash, Struct) Samples
 
 - [The "Red Paper" about sruby](https://github.com/s6ruby/redpaper) - Small, Smart, Secure, Safe, Solid & Sound (S6) Ruby - The Ruby Programming Language for Contract / Transaction Scripts on the Blockchain World Computer - Yes, It's Just Ruby

data/Rakefile

@@ -18,6 +18,7 @@ Hoe.spec 'safestruct' do
   self.history_file = 'CHANGELOG.md'
 
   self.extra_deps = [
+    ['enums', '>=1.1.0'],
   ]
 
   self.licenses = ['Public Domain']

data/lib/safestruct.rb

@@ -3,10 +3,13 @@
 require 'pp'
 require 'forwardable'     # uses def_delegator
 
+## 3rd party libs
+require 'enums'
 
 ## our own code
 require 'safestruct/version'    # note: let version always go first
 
+
 require 'safestruct/safe_array'
 require 'safestruct/safe_hash'
 require 'safestruct/safe_struct'
@@ -79,6 +82,17 @@ module Safe
   # note: HACK redefine built in struct in module Safe "context"
   ClassicStruct = ::Struct        ## save old classic struct class
   Struct        = SafeStruct
-end
+
+  module ClassMethods
+    ## add more convenience "constructor" methods
+    ##   e.g. struct 'Voter', { weight: 0, voted: false, vote: 0, delegate: '0x0000'}
+    ##    or  struct 'Voter', weight: 0, voted: false, vote: 0, delegate: '0x0000'
+    def struct( class_name, **attributes )
+      SafeStruct.new( class_name, attributes )
+    end
+  end # module ClassMethods
+end # module Safe
+
+
 
 puts Safe.banner    ## say hello

data/lib/safestruct/safe_hash.rb

@@ -4,6 +4,10 @@ module Safe
 
 class SafeHash
 
+  def self.debug?()      @debug ||= false; end
+  def self.debug=(value) @debug = value; end
+
+
   ## e.g.
   ##  Hash.of( Address => Money )
 
@@ -19,8 +23,16 @@ class SafeHash
     ## note: keep a class cache
     cache = @@cache ||= {}
     klass = cache[ klass_value ]
+    if debug?
+      puts "[debug] SafeHash - build_class klass_value:"
+      pp klass_value
+    end
 
     if klass.nil?
+      if debug?
+        puts "[debug] SafeHash - build_class new class (no cache hit)"
+      end
+
       klass = Class.new( SafeHash )
       klass.class_eval( <<RUBY )
         def self.klass_key
@@ -32,6 +44,11 @@ class SafeHash
 RUBY
       ## add to cache for later (re)use
       cache[ klass_value ] = klass
+    else
+      if debug?
+        puts "[debug] SafeHash - build_class bingo!! (re)use cached class:"
+        pp klass
+      end
     end
 
     klass

data/lib/safestruct/safe_struct.rb

@@ -4,7 +4,24 @@ module Safe
 
 class SafeStruct
 
-def self.build_class( **attributes )
+
+def self.convert( arg )
+  ## note: for now only supports 0 for Vote(0) as Vote.zero shortcut
+  if arg == 0
+    zero
+  else
+    raise ArgumentError.new( "[SafeStruct] invalid argument #{arg} - cannot convert to #{name}" )
+  end
+end
+
+
+def self.build_class( class_name, **attributes )
+
+ ## todo/fix:
+ ## 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|
@@ -82,7 +99,22 @@ def self.build_class( **attributes )
     old_new( *values )
   end
 
-  klass
+
+  ## note: use Object 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
+  ##  e.g. Vote(0) is same as Vote.convert(0)
+  Object.class_eval( <<RUBY )
+    def #{class_name}( arg )
+       #{class_name}.convert( arg )
+    end
+RUBY
+
+ ## note: use Safe (module) and NOT Object for namespacing
+ ##   use include Safe to make all structs global
+  Safe.const_set( class_name, klass )   ## returns klass (plus sets global constant class name)
 end # method build_class
 
 class << self

data/lib/safestruct/version.rb

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

data/test/helper.rb

@@ -6,3 +6,6 @@ require 'minitest/autorun'
 ## our own code
 
 require 'safestruct'
+
+## turn on debug out
+Safe::SafeHash.debug = true

data/test/test_hash.rb

@@ -8,13 +8,14 @@
 require 'helper'
 
 
+## note: require voter to avoid DUPLICATE definition (with undefined state/errors etc.)
+require_relative 'voter'
+
+
 class TestHash < MiniTest::Test
 
   include Safe
 
-  ## sig: [Integer, Bool, Integer, Address]
-  Voter = SafeStruct.new( weight: 0, voted: false, vote: 0, delegate: '0x0000' )
-
   Hash_X_Integer = SafeHash.build_class( String, Integer )
   Hash_X_Bool    = SafeHash.build_class( String, Bool )
   Hash_X_Voter   = SafeHash.build_class( String, Voter )
@@ -22,6 +23,7 @@ class TestHash < MiniTest::Test
   ## 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

data/test/test_struct.rb

@@ -8,52 +8,41 @@
 require 'helper'
 
 
+## note: require voter to avoid DUPLICATE definition (with undefined state/errors etc.)
+require_relative 'voter'
+
+
 class TestStruct < MiniTest::Test
 
 include Safe
 
-## sig: [Integer, Bool, Integer, Address]
-Voter = SafeStruct.new( weight: 0, voted: false, vote: 0, delegate: '0x0000' )
-
 ## sig: [Address, Integer, Integer, Money]
-Bet   = SafeStruct.new( user: '0x0000', block: 0, cap: 0, amount: 0 )
+## SafeStruct.new( 'Bet', user: '0x0000', block: 0, cap: 0, amount: 0 )
+struct :Bet,
+  user:   '0x0000',
+  block:  0,
+  cap:    0,
+  amount: 0
 
-
-
-### test with "real" enum
-class Enum
-  def initialize( key, value )
-    @key   = key
-    @value = value
-  end
-end
-
-class Winner < Enum
-  NONE       = new(:none, 0 )
-  DRAW       = new(:draw, 1 )
-  HOST       = new(:host, 2 )
-  CHALLENGER = new(:challenger, 3)
-
-  def self.none()       NONE;       end
-  def self.draw()       DRAW;       end
-  def self.host()       HOST;       end
-  def self.challenger() CHALLENGER; end
-
-  def none?()       self == NONE; end
-  def draw?()       self == DRAW; end
-  def host?()       self == HOST; end
-  def challenger?() self == CHALLENGER; end
-end
+## Enum.new( 'Winner', :none, :draw, :host, :challenger )
+enum :Winner, :none, :draw, :host, :challenger
 
 Board = Array_9_Integer = SafeArray.build_class( Integer, 3*3 )
 
 ## sig: [Address, Address, Address, Winner(Enum), Board(Array9)]
-Game = SafeStruct.new( host:       '0x0000',
-                       challenger: '0x0000',
-                       turn:       '0x0000',   ## address of host/ challenger
-                       winner:     Winner.none,
-                       board:      Board.zero
-                     )
+## SafeStruct.new( 'Game',
+##                  host:       '0x0000',
+##                  challenger: '0x0000',
+##                  turn:       '0x0000',   ## address of host/ challenger
+##                  winner:     Winner.none,  ## e.g. Winner(0)
+##                  board:      Board.zero)
+struct :Game,
+  host:       '0x0000',
+  challenger: '0x0000',
+  turn:       '0x0000',   ## address of host/ challenger
+  winner:     Winner.none,  ## e.g. Winner(0)
+  board:      Board.zero
+
 
 def test_voter
   assert_equal true,       Voter.zero.frozen?

data/test/voter.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+
+module Safe
+
+## sig: [Integer, Bool, Integer, Address]
+Struct.new( :Voter,
+  weight:   0,
+  voted:    false,
+  vote:     0,
+  delegate: '0x0000' )
+
+end # module Safe

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: safestruct
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-21 00:00:00.000000000 Z
+date: 2019-03-07 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: enums
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -63,6 +77,7 @@ files:
 - test/test_array.rb
 - test/test_hash.rb
 - test/test_struct.rb
+- test/voter.rb
 homepage: https://github.com/s6ruby/safestruct
 licenses:
 - Public Domain