solidity-typed 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 634cc8c8ee7cf10c3a67c0a8dbcc7c5efad7fe17a5a961128a5140f7648a8ff0
-  data.tar.gz: f6956a85d7b3e7ae5aa021052ddcc9981f0c5f394acb29f0457e2587a3cc8e56
+  metadata.gz: 6f81ad150dc806a0f2762f4d012dd5b2f64a6957f1a6b44b366823fab8a05b07
+  data.tar.gz: 269e9e51fa0a30e1b95d2abea121494bef11af559ec7f1063b6283c9315d15a3
 SHA512:
-  metadata.gz: 9537d4935ea267c3ace17ac3625552fab903dee944718e9163392167c39cdcff478f3494c9780e09db327c6228458dac5d33e3738fddd3fa08463322d9fff99e
-  data.tar.gz: 6210074c6e54f778fca18fbb738f8a884421702ceede73d73e4b5efd32ccce35ea2b30fd7507ed76f0d820753723c735bdd0f3af58ff252b480dfed2c9cf5833
+  metadata.gz: d614ebe7a9be302c64fec852d3c0105fd70574a9302315ac12d47a6dbedd434c5ec562eb00f657036bb20604ec32905644ad5af389e0fe318195c5ce26a8e892
+  data.tar.gz: 261b765c22ae3eb26c45e95ca9082dece2de4ee026d6cd74f9207db1fda6a02d040908d8bdd954e566333e6c5c2bb0d0b4423d57df2d4e1fad4b6ee7dd2d1ac1

data/CHANGELOG.md

@@ -1,4 +1,4 @@
-### 0.1.0
+### 0.2.0
 ### 0.0.1 / 2023-09-10
 
 * Everything is new. First release

data/Manifest.txt

@@ -9,6 +9,8 @@ lib/solidity/typed/bool.rb
 lib/solidity/typed/conversion.rb
 lib/solidity/typed/enum.rb
 lib/solidity/typed/enum_builder.rb
+lib/solidity/typed/event.rb
+lib/solidity/typed/event_builder.rb
 lib/solidity/typed/mapping.rb
 lib/solidity/typed/mapping_builder.rb
 lib/solidity/typed/metatypes/array.rb

data/README.md

@@ -312,7 +312,7 @@ at the ruby code commons (rubycocos) org.
 ## Questions? Comments?
 
 Join us in the [Rubidity (community) discord (chat server)](https://discord.gg/3JRnDUap6y). Yes you can.
-Your questions and commetary welcome.
+Your questions and commentary welcome.
 
 Or post them over at the [Help & Support](https://github.com/geraldb/help) page. Thanks.
 

data/lib/solidity/typed/event.rb

@@ -0,0 +1,68 @@
+
+module Types
+class Event  < Typed
+
+def self.zero
+   raise "event cannot be zero (by defintion); sorry"
+end
+
+def zero?() false; end
+
+
+
+def initialize( *args, **kwargs  )
+   ## fix-fix-fix: first check for matching args - why? why not?
+    if kwargs.size > 0   ## assume kwargs
+      ## note: kwargs.size check matching attributes "upstream" in new!!!
+      self.class.attributes.each do |key, type|
+         value = kwargs[ key ]
+         raise ArgumentError,  "event arg with key >#{key}< missing; sorry"  if value.nil?
+         value = if value.is_a?(Typed)
+                   ## fix-fix-fix - check type match here!!!
+                   value
+                 else 
+                   type.new( value )
+                 end
+         instance_variable_set( "@#{key}", value )
+      end
+    else
+      self.class.attributes.zip( args ).each do |(key, type), value|
+         value = if value.is_a?(Typed)
+                ## fix-fix-fix - check type match here!!!
+                   value
+                 else 
+                   type.new( value )
+                 end
+         instance_variable_set( "@#{key}", value )
+      end
+   end
+   self  ## note: return reference to self for chaining method calls
+end
+
+
+def as_data
+   self.class.attributes.keys.map do |key|
+        ivar = instance_variable_get( "@#{key}" )
+        puts "  @#{key}:"
+        pp ivar
+        ivar.as_data
+   end
+end
+
+
+def ==(other)
+   if other.is_a?( self.class )
+      self.class.attributes.keys.all? do |key|
+            __send__( key ) == other.__send__( key )
+      end
+   else
+      false
+   end
+end
+##  do note override eql? why? why not?
+#       default is object id equality???
+## alias_method :eql?, :==
+ 
+
+end # class Event
+end # module Types

data/lib/solidity/typed/event_builder.rb

@@ -0,0 +1,101 @@
+
+module Types
+class Event
+
+  
+# todo/fix:  scope: keep empty by default
+
+def self.build_class( class_name, scope: Types, **attributes )
+
+ ## todo/fix:
+ ## check if valid class_name MUST start with uppercase letter etc.
+ ##  todo/fix: check if constant is undefined in scoped namespace!!!!
+
+   attributes = attributes.map do |key,type|
+                  [key, typeof( type )]
+                end.to_h
+
+
+  ## note: event is a like a value type e.g. only getters
+  ##         no setters (can only initialized via constructor or such)              
+  klass = Class.new( Event ) do
+    attributes.each do |key,type|
+      define_method( key ) do
+        instance_variable_get( "@#{key}" )
+      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
+  end
+
+
+  type = EventType.new( class_name, klass )
+  klass.define_singleton_method( :type ) do
+    @type ||= type       
+  end
+
+  ## add attributes (with keys / types) class method 
+  klass.define_singleton_method( :attributes ) do
+     attributes 
+  end
+
+  ### todo/fix:
+  ##    auto-add support for kwargs too!!!
+
+  ## add self.new too - note: call/forward to "old" orginal self.new of Event (base) class
+  klass.define_singleton_method( :new ) do |*args, **kwargs|
+      if kwargs.size > 0   ## assume kwargs
+        if kwargs.size != attributes.size
+          raise ArgumentError, "[Event] wrong number of arguments for #{name}.new - #{kwargs.size} for #{attributes.size}"
+        end
+        ## check for matching names too - why? why not?
+        if kwargs.keys.sort != attributes.keys.sort
+          raise ArgumentError, "[Event] argument key (names) not matching for #{name}.new - #{kwargs.key.sort} != #{attributes.key.sort} for #{attributes.size}"
+        end  
+        old_new( **kwargs )
+      else
+        if args.size != attributes.size
+          ## check for required args/params - all MUST be passed in!!!
+          raise ArgumentError, "[Event] wrong number of arguments for #{name}.new - #{args.size} for #{attributes.size}"
+        end
+        old_new( *args )
+      end
+  end
+
+=begin
+  ## 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 "Kernel" convenience converter function
+  ##  e.g. Vote(0) is same as Vote.convert(0)
+  Kernel.class_eval( <<RUBY )
+    def #{class_name}( arg )
+       #{class_name}.convert( arg )
+    end
+RUBY
+=end
+
+ ## note: use scoped (module) and NOT Object for namespacing
+ ##   use include Safe to make all structs global
+ ##  fix-fix-fix - make class_name unique across contracts (e.g. reuse same name in different contract)
+  scope.const_set( class_name, klass )   ## returns klass (plus sets global constant class name)
+end # method build_class
+
+
+class << self
+  alias_method :old_new, :new       # note: store "old" orginal version of new
+  alias_method :new,     :build_class    # replace original version with create
+end
+  
+
+end # class Event
+end  # module Types

data/lib/solidity/typed/metatypes/literals.rb

@@ -53,7 +53,7 @@ class Type
     
       ## todo/check - use a different base class for contracts - why? why not?
       ##   fix fix fix: check matching contract type/class too - why? why not?
-       if literal.is_a?( ContractBase )
+       if literal.is_a?( Contract )
          return literal
        else
          raise TypeError, "No literals allowed for contract types  got: #{literal}; sorry"

data/lib/solidity/typed/metatypes/types.rb

@@ -16,7 +16,6 @@
 # global helper(s) - move to ??? - why? why not?
 
 def _sanitize_class_name( name )
-  name = name.sub( /\bContractBase::/, '' )   ## remove contract module from name if present
   name = name.sub( /\bContract::/, '' )   ## remove contract module from name if present
   name = name.sub( /\bTyped::/, '' )
   name = name.sub( /\bTypes::/, '' )

data/lib/solidity/typed/typed.rb

@@ -2,7 +2,7 @@
 =begin
 class Object   ### move to core_ext/object - why? why not?
   ## check -  add scoped class here too - why? why not?
-  ##           e.g. is_a?( Typed ) || is_a?( ContractBase )
+  ##           e.g. is_a?( Typed ) 
   ##             or add a TypedContract delagate class or such - why? why not?
   ##    fix - check for class has singelton method type - why? why not?
   def typed?() is_a?( Typed ); end

data/lib/solidity/typed/version.rb

@@ -2,7 +2,7 @@ module Solidity
   module Module
     module Typed
       MAJOR = 0
-      MINOR = 1
+      MINOR = 2
       PATCH = 0
       VERSION = [MAJOR,MINOR,PATCH].join('.')
     

data/lib/solidity/typed.rb

@@ -15,7 +15,7 @@ class ValueError < StandardError; end
 
 ## forward declare contract base (from solidity)
 ##    for type checking
-class ContractBase 
+class Contract
 end
    
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solidity-typed
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-09 00:00:00.000000000 Z
+date: 2023-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -67,6 +67,8 @@ files:
 - lib/solidity/typed/conversion.rb
 - lib/solidity/typed/enum.rb
 - lib/solidity/typed/enum_builder.rb
+- lib/solidity/typed/event.rb
+- lib/solidity/typed/event_builder.rb
 - lib/solidity/typed/mapping.rb
 - lib/solidity/typed/mapping_builder.rb
 - lib/solidity/typed/metatypes/array.rb