safestruct 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 74b37cac746195871cc30eec8b8b54622958c6a5
-  data.tar.gz: 80def63037cd23ce8812529a4f208e1ebfbbab7a
+  metadata.gz: c7bf46e7fc7abcced2da4628ab2640f4f3136482
+  data.tar.gz: 693e1ad041258390403893df801673955e574c7e
 SHA512:
-  metadata.gz: 508027ee5576e342154bc62d6d5b5e25cf2f829a075a7b942fc9a3af2bb2295f6e6d71eec58597b7de5c69106ecde9ee6fb1f8d0c503215ab7f15735afa01f62
-  data.tar.gz: a9172d32b881902e273bc54cb4e41875edb0c2dd40efd62ca19a07170e8cf01596457b31fa1c63fe244096c3a69b2ab9a280c93241656abedf99f1fd5eeb4c60
+  metadata.gz: 2f548ea0b261a9fe0e829ad2205aa21b46ea6cac99ff082a80bcaaa5418fe75e9684200f31033f099450c3b688240664949ad0bbc70ad4f8abf57f197a33020a
+  data.tar.gz: 9fc0faf2c9373cfa146a7f7d5d8b18e17c7ea6e419d10b19d9ab95323650d825bbb3e6b7818c475360aa89101c9f17543731bc07dd02f2e17ce102a5ede5e92e

data/LICENSE.md

@@ -0,0 +1,116 @@
+CC0 1.0 Universal
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator and
+subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for the
+purpose of contributing to a commons of creative, cultural and scientific
+works ("Commons") that the public can reliably and without fear of later
+claims of infringement build upon, modify, incorporate in other works, reuse
+and redistribute as freely as possible in any form whatsoever and for any
+purposes, including without limitation commercial purposes. These owners may
+contribute to the Commons to promote the ideal of a free culture and the
+further production of creative, cultural and scientific works, or to gain
+reputation or greater distribution for their Work in part through the use and
+efforts of others.
+
+For these and/or other purposes and motivations, and without any expectation
+of additional consideration or compensation, the person associating CC0 with a
+Work (the "Affirmer"), to the extent that he or she is an owner of Copyright
+and Related Rights in the Work, voluntarily elects to apply CC0 to the Work
+and publicly distribute the Work under its terms, with knowledge of his or her
+Copyright and Related Rights in the Work and the meaning and intended legal
+effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not limited
+to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display, communicate,
+  and translate a Work;
+
+  ii. moral rights retained by the original author(s) and/or performer(s);
+
+  iii. publicity and privacy rights pertaining to a person's image or likeness
+  depicted in a Work;
+
+  iv. rights protecting against unfair competition in regards to a Work,
+  subject to the limitations in paragraph 4(a), below;
+
+  v. rights protecting the extraction, dissemination, use and reuse of data in
+  a Work;
+
+  vi. database rights (such as those arising under Directive 96/9/EC of the
+  European Parliament and of the Council of 11 March 1996 on the legal
+  protection of databases, and under any national implementation thereof,
+  including any amended or successor version of such directive); and
+
+  vii. other similar, equivalent or corresponding rights throughout the world
+  based on applicable law or treaty, and any national implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention of,
+applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and
+unconditionally waives, abandons, and surrenders all of Affirmer's Copyright
+and Related Rights and associated claims and causes of action, whether now
+known or unknown (including existing as well as future claims and causes of
+action), in the Work (i) in all territories worldwide, (ii) for the maximum
+duration provided by applicable law or treaty (including future time
+extensions), (iii) in any current or future medium and for any number of
+copies, and (iv) for any purpose whatsoever, including without limitation
+commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes
+the Waiver for the benefit of each member of the public at large and to the
+detriment of Affirmer's heirs and successors, fully intending that such Waiver
+shall not be subject to revocation, rescission, cancellation, termination, or
+any other legal or equitable action to disrupt the quiet enjoyment of the Work
+by the public as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason be
+judged legally invalid or ineffective under applicable law, then the Waiver
+shall be preserved to the maximum extent permitted taking into account
+Affirmer's express Statement of Purpose. In addition, to the extent the Waiver
+is so judged Affirmer hereby grants to each affected person a royalty-free,
+non transferable, non sublicensable, non exclusive, irrevocable and
+unconditional license to exercise Affirmer's Copyright and Related Rights in
+the Work (i) in all territories worldwide, (ii) for the maximum duration
+provided by applicable law or treaty (including future time extensions), (iii)
+in any current or future medium and for any number of copies, and (iv) for any
+purpose whatsoever, including without limitation commercial, advertising or
+promotional purposes (the "License"). The License shall be deemed effective as
+of the date CC0 was applied by Affirmer to the Work. Should any part of the
+License for any reason be judged legally invalid or ineffective under
+applicable law, such partial invalidity or ineffectiveness shall not
+invalidate the remainder of the License, and in such case Affirmer hereby
+affirms that he or she will not (i) exercise any of his or her remaining
+Copyright and Related Rights in the Work or (ii) assert any associated claims
+and causes of action with respect to the Work, in either case contrary to
+Affirmer's express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+  a. No trademark or patent rights held by Affirmer are waived, abandoned,
+  surrendered, licensed or otherwise affected by this document.
+
+  b. Affirmer offers the Work as-is and makes no representations or warranties
+  of any kind concerning the Work, express, implied, statutory or otherwise,
+  including without limitation warranties of title, merchantability, fitness
+  for a particular purpose, non infringement, or the absence of latent or
+  other defects, accuracy, or the present or absence of errors, whether or not
+  discoverable, all to the greatest extent permissible under applicable law.
+
+  c. Affirmer disclaims responsibility for clearing rights of other persons
+  that may apply to the Work or any use thereof, including without limitation
+  any person's Copyright and Related Rights in the Work. Further, Affirmer
+  disclaims responsibility for obtaining any necessary consents, permissions
+  or other rights required for any use of the Work.
+
+  d. Affirmer understands and acknowledges that Creative Commons is not a
+  party to this document and has no duty or obligation with respect to this
+  CC0 or use of the Work.
+
+For more information, please see
+<http://creativecommons.org/publicdomain/zero/1.0/

data/Manifest.txt

@@ -1,4 +1,5 @@
 CHANGELOG.md
+LICENSE.md
 Manifest.txt
 README.md
 Rakefile

data/README.md

@@ -83,7 +83,7 @@ voter2 == Voter.zero     #=> false
 
 Voter.zero.frozen?       #=> true
 
-voter3 = Voter.new( 0 )  #=> ArgumentError - wrong number of arguments
+voter3 = Voter.new( 0 )  #=> ArgumentError: wrong number of arguments
                          #     for Voter.new - 1 for 4
 ```
 
@@ -101,7 +101,7 @@ Example:
 ArrayInteger = SafeArray.build_class( Integer )
 ary = ArrayInteger.new
 ary.size       #=> 0
-ary[0]         #=> IndexError
+ary[0]         #=> IndexError: index 0 outside of array bounds
 ary.size = 2   #=> [0,0]
 ary[0]         #=> 0
 ```
@@ -111,7 +111,7 @@ or use the `Array.of` convenience shortcut:
 ``` ruby
 ary = Array.of( Integer )
 ary.size       #=> 0
-ary[0]         #=> IndexError
+ary[0]         #=> IndexError: index 0 outside of array bounds
 ary.size = 2   #=> [0, 0]
 ary[0]         #=> 0
 
@@ -119,7 +119,7 @@ ary[0]         #=> 0
 
 another_ary = Array.of( Bool )
 another_ary.size      #=> 0
-another_ary[0]        #=> IndexError
+another_ary[0]        #=> IndexError: index 0 outside of array bounds
 another_ary.size = 2  #=> [false, false]
 another_ary[0]        #=> false
 
@@ -135,7 +135,7 @@ Yes, Safe Array works with structs (or nested arrays or hash mappings) too. Exam
 ``` ruby
 ary = Array.of( Vote )
 
-ary[0]         #=> IndexError
+ary[0]         #=> IndexError: index 0 outside of array bounds
 ary.size = 2   #=> [#<Vote @weight=0, @voted=false, @vote=0, @delegate='0x0000'>,
                #    #<Vote @weight=0, @voted=false, @vote=0, @delegate='0x0000'>]
 ary[0]         #=> #<Vote @weight=0, @voted=false, @vote=0, @delegate='0x0000'>

data/lib/safestruct.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 require 'pp'
+require 'forwardable'     # uses def_delegator
 
 
 ## our own code
@@ -13,16 +14,24 @@ require 'safestruct/safe_struct'
 
 
 ####################################
-## add dummy bool class for mapping and (payable) method signature
+## add zero/zero_new machinery for builin classes
 
+#### value semantics
 class Integer
-  def self.zero() 0; end
+  def self.zero() 0; end      ## note: 0.frozen? == true  by default
 end
 
 class Bool
-  def self.zero() false; end
+  def self.zero() false; end   ## note: false.frozen? == true  by default
 end
 
+#### reference semantics (new copy ALWAYS needed)
+class String
+  def self.new_zero() new; end
+  def self.zero() @zero ||= new_zero.freeze;  end
+end
+
+
 
 
 #####
@@ -50,13 +59,16 @@ end
 
 class Array
   ## "typed" safe array "constructor"
-  ## e.g.  Array.of( Address ) or Array.of( Money ) or Array.of( Proposal, size: 2 ) etc.
-  def self.of( klass_value )
+  ## e.g.  Array.of( Address ) or Array.of( Money ) or
+  ##       Array.of( Proposal, 2 ) etc.
+  def self.of( klass_value, size=0 )
     klass = Safe::SafeArray.build_class( klass_value )
-    klass.new  ## todo: add klass.new( **kwargs ) for size: 2 etc.
+    klass.new( size )
   end
 end
 
+
+
 module Safe
   ############################
   # note: HACK redefine built in struct in module Safe "context"

data/lib/safestruct/safe_array.rb

@@ -13,50 +13,84 @@ class SafeArray
     ## note: keep a class cache
     cache = @@cache ||= {}
     klass = cache[ klass_value ]
-    return klass   if klass
 
-    klass = Class.new( SafeArray )
-    klass.class_eval( <<RUBY )
-      def self.klass_value
-        @klass_value ||= #{klass_value}
-      end
+    if klass.nil?
+
+      klass = Class.new( SafeArray )
+      klass.class_eval( <<RUBY )
+        def self.klass_value
+          @klass_value ||= #{klass_value}
+        end
 RUBY
-    ## add to cache for later (re)use
-    cache[ klass_value ] = klass
+      ## add to cache for later (re)use
+      cache[ klass_value ] = klass
+    end
     klass
   end
 
 
   def self.new_zero()  new;  end
-  def self.zero()      @zero ||= new_zero;  end
+  def self.zero()      @zero ||= new_zero.freeze;  end
 
 
 
-  def initialize
+  def initialize( size=0 )
     ## todo/check: if array works if value is a (nested/multi-dimensional) array
     @ary  = []
+    self.size = size   if size > 0  ## auto-init with zeros
+    self   # return reference to self
+  end
+
+  def freeze
+    super
+    @ary.freeze  ## note: pass on freeze to "wrapped" array
+    self   # return reference to self
+  end
+
+
+  def ==( other )
+    if other.is_a?( self.class )                       ## note: must be same array class
+      @ary == other.instance_variable_get( '@ary' )    ## compare "wrapped" array
+    else
+      false
+    end
   end
+  alias_method :eql?, :==
+
+
+  def size=(value)
+    ## todo/check: value must be greater 0 and greater than current size
+    diff = value - @ary.size
+
+    ## todo/check:
+    ##    always return (deep) frozen zero object - why? why not?
+    ##     let user change the returned zero object - why? why not?
+    if self.class.klass_value.respond_to?( :new_zero )
+      ## 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
+      ## puts "use value semantics"
+      diff.times { @ary << self.class.klass_value.zero }
+   end
+   self  # return reference to self
+  end
+  alias_method :'length=', :'size='
+
 
   def []=(index, value)
+    ## note: use fetch
+    #    throws / raises an IndexError exception
+    #    if the referenced index lies outside of the array bounds
+    # todo/fix: is there a better way to check for index out-of-bounds error?
+    old_value = @ary.fetch( index )
     @ary[index] = value
   end
 
   def [](index)
-    item = @ary[ index ]
-    if item.nil?
-      ## todo/check:
-      ##    always return (deep) frozen zero object - why? why not?
-      ##     let user change the returned zero object - why? why not?
-      if self.class.klass_value.respond_to?( :new_zero )
-        ## note: use a new unfrozen copy of the zero object
-        ##    changes to the object MUST be possible (new "empty" modifable object expected)
-       item = self.class.klass_value.new_zero
-     else  # assume value semantics e.g. Integer, Bool, etc. zero values gets replaced
-       ## puts "use value semantics"
-       item = self.class.klass_value.zero
-     end
-    end
-    item
+    ## note: throws / raises an IndexError exception
+    #    if the referenced index lies outside of the array bounds
+    @ary.fetch( index )
   end
 
   def push( item )
@@ -66,7 +100,10 @@ RUBY
     @ary.push( item )
   end
 
-  def size() @ary.size; end
-  def length() size; end
+extend Forwardable
+def_delegators :@ary, :size, :length,
+                      :each, :each_with_index
+
+
 end # class SafeArray
 end # module Safe

data/lib/safestruct/safe_hash.rb

@@ -19,32 +19,51 @@ class SafeHash
     ## note: keep a class cache
     cache = @@cache ||= {}
     klass = cache[ klass_value ]
-    return klass   if klass
-
-    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
+
+    if klass.nil?
+      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
-    ## add to cache for later (re)use
-    cache[ klass_value ] = klass
+      ## add to cache for later (re)use
+      cache[ klass_value ] = klass
+    end
+
     klass
   end
 
 
   def self.new_zero()  new;  end
-  def self.zero()      @zero ||= new_zero;  end
+  def self.zero()      @zero ||= new_zero.freeze;  end
 
 
   def initialize
     ## todo/check: if hash works if value is a (nested) hash
-    @h  = {}
+    @h = {}
   end
 
+  def freeze
+    super
+    @h.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
+    else
+      false
+    end
+  end
+  alias_method :eql?, :==
+
+
+
 
   def []=(key, value)
     @h[key] = value
@@ -73,7 +92,9 @@ RUBY
     item
   end
 
-  def size() @h.size; end
-  def length() size; end
+  extend Forwardable
+  def_delegators :@h, :size, :length,   ## todo/fix: remove size and length for (safe) hash - why? why not?
+                      :has_key?, :key?
+
 end # class SafeHash
 end # module Safe

data/lib/safestruct/safe_struct.rb

@@ -27,11 +27,23 @@ def self.build_class( **attributes )
       end
     end
 
+    alias_method :old_freeze, :freeze   # note: store "old" orginal version of freeze
+    define_method( :freeze ) do
+      old_freeze    ## same as calling super
+      attributes.keys.each do |key|
+        instance_variable_get( "@#{key}" ).freeze
+      end
+      self   # return reference to self
+    end
+
     define_method( :== ) do |other|
-       return false unless other.is_a?( klass )
-        attributes.keys.all? do |key|
-          __send__( key ) == other.__send__( key )
-        end
+       if other.is_a?( klass )
+         attributes.keys.all? do |key|
+           __send__( key ) == other.__send__( key )
+         end
+       else
+         false
+       end
     end
     alias_method :eql?, :==
   end
@@ -54,10 +66,14 @@ def self.build_class( **attributes )
     ##     use new_zero to create a new instance!!!
     ##     do NOT use the passed in reference!!!!
     values = attributes.values.map do |value|
-      if value.is_a?(SafeStruct) ||
-         value.is_a?(SafeArray)  ||
-         value.is_a?(SafeHash)
-         value.class.new_zero
+      ## note: was: use more "generic" check for respond_to?( :new_zero )
+      ##  value.is_a?(SafeStruct) ||
+      ##  value.is_a?(SafeArray)  ||
+      ##  value.is_a?(SafeHash)
+      if value.is_a?(String) && value == '0x0000'
+        value.dup    ## special case for Address(0) or Address.zero encoded as string for now!!!!
+      elsif value.class.respond_to?( :new_zero )
+        value.class.new_zero
       else
         ## assume "value" object / semantics (e.g. 0, false, '0x0000' etc.) and pass through
         value

data/lib/safestruct/version.rb

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

data/test/test_array.rb

@@ -17,7 +17,7 @@ class TestArray < MiniTest::Test
 
 def test_integer
   pp Array_Integer
-  pp ary = Array_Integer.new
+  pp ary = Array_Integer.new(2)
 
   assert_equal Integer, Array_Integer.klass_value
   assert_equal 0, ary[0]
@@ -28,6 +28,23 @@ def test_integer
   assert_equal 101,  ary[0]
   assert_equal 102,  ary[1]
 
+  assert_equal 2,     ary.size
+  assert_equal 2,     ary.length
+  assert_equal false, ary.frozen?
+
+  ary.each { |item| pp item }
+  ary.each_with_index { |item,i| puts "[#{i}] #{item}"}
+
+  ary.size = 3
+  assert_equal 3, ary.size
+  assert_equal 0, ary[2]
+  assert       Array_Integer.zero != ary
+
+  pp Array_Integer.zero
+  assert_equal true,               Array_Integer.zero.frozen?
+  assert_equal Array_Integer.zero, Array_Integer.zero
+  assert_equal Array_Integer.zero, Array_Integer.new
+
   ## check Array.of  (uses cached classes)
   assert_equal Array_Integer, Array.of( Integer ).class
 end
@@ -35,7 +52,7 @@ end
 
 def test_bool
   pp Array_Bool
-  pp ary = Array_Bool.new
+  pp ary = Array_Bool.new(2)
 
   assert_equal Bool, Array_Bool.klass_value
   assert_equal false,  ary[0]

data/test/test_hash.rb

@@ -23,6 +23,22 @@ def test_integer
   pp Hash_X_Integer
   pp h = Hash_X_Integer.new
 
+  assert_equal false, h.key?( '0x1111' )
+  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 Hash_X_Integer.zero, h
+  assert_equal Hash_X_Integer.zero, Hash_X_Integer.new
+
+  pp Hash_X_Integer.zero
+  assert_equal true,   Hash_X_Integer.zero.frozen?
+  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']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: safestruct
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-15 00:00:00.000000000 Z
+date: 2019-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -45,10 +45,12 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - CHANGELOG.md
+- LICENSE.md
 - Manifest.txt
 - README.md
 files:
 - CHANGELOG.md
+- LICENSE.md
 - Manifest.txt
 - README.md
 - Rakefile