solidity 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e72e223ba2202849d7dbb405a56b1edf7345b911813b3449bbf2059a9ebe87e5
-  data.tar.gz: 2aa7d53cc55bc04929440cb3c49c99b85cc3efe0a151d24f9b887c2ac6297f09
+  metadata.gz: 2450cdadc297a615031d2a910fc70e39b6a29514ee4387e532bb3a7febec7fb4
+  data.tar.gz: 572f8c43f7cc641fc3d970b00287eec3e9adf7412ad046950d0bfa116930822c
 SHA512:
-  metadata.gz: 25a530da83da24bbbf6ae85bc97a4ecac8d27eb0745d2952f3f43fda6ad3422021d798edffcafc9e03afcf6bd6d0c7985103fec52caa34987ffdb5d84a8699fd
-  data.tar.gz: '09339328d15e47d6d9a6345f000cbc1dee7fce14dee04e14765f82add73824dbce6fa41ba0dfe1a190059b5aeef93b6c27dc3acf759f67bb0348556098f127e5'
+  metadata.gz: 2cdb28abe2cafb57f53df2d07af8a61c0f4c80177b0267bd7de2fa1afb96d423ff2399d628f11f34edd6896eaaeb4af3ebed5aa2b3489817c49c20560a536818
+  data.tar.gz: bcef0cdea7f22b7960db8269738d612d6a51f46626560762e8e85ffd52dc343e8a3d652de74b1d4c6ca89ee98fe7a1066a4de85535b5c704e1d6aa732bef7033

data/README.md

@@ -24,9 +24,7 @@ Get / generate outline from source in the solidity (`.sol`) contract programming
 ].each do |addr|
 
   path = "awesome-contracts/address/#{addr}/contract.sol"
-  txt = read_text( path )
-
-  parser = Solidity::Parser.new( txt )
+  parser = Solidity::Parser.read( path )
 
   puts "---"
   puts "outline:"
@@ -67,6 +65,7 @@ library Address
 library Base64
 abstract contract Context
 library MerkleProof
+interface ERC721A__IERC721Receiver
 contract ERC721A is IERC721A
 interface IERC721A
 ```

data/lib/solidity/version.rb

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

data/lib/solidity.rb

@@ -10,74 +10,132 @@ require_relative 'solidity/version'    # note: let version always go first
 module Solidity
 
 class Parser
+
+   def self.read( path )
+      txt = read_text( path )
+      new( txt )
+   end
+
+
+
    def initialize( txt )
      @txt = txt
    end
 
 
-   SINGLE_COMMENT_RX         = %r{^[ ]*//}
-   MULTI_COMMENT_BEGIN_RX    = %r{^[ ]*/\*}
-   MULTI_COMMENT_END_RX      = %r{\*/[ ]*$}
+  ###############
+  ## quotes
+  ##
+  ## note: regex pattern \\ needs to get escaped twice, thus, \\.
+  ##  and for literal \\ use \\\\\.
+
+  ## => \\\\.    --  allow backslash escapes e.g. \n \t \\ etc.
+  ## => [^`]     --  everything except backquote
+
+  ## todo/fix - check if [^`] includes/matches newline too (yes)? -- add \n for multi-line!
+
+  SINGLE_QUOTE       = %r{'
+                           ( \\\\. | [^'] )*
+                         '}x
 
-   ID = '[a-zA-Z][a-zA-Z0-9]*'
+  DOUBLE_QUOTE       = %r{"
+                           ( \\\\. | [^"] )*
+                          "}x
 
-   PRAGMA_RX            = %r{^[ ]*pragma}
-   LIBRARY_RX           = %r{^[ ]*library[ ]+(?<id>#{ID})[ \{]}
-   ABSTRACT_CONTRACT_RX = %r{^[ ]*abstract[ ]+contract[ ]+(?<id>#{ID})[ \{]}
-   CONTRACT_RX          = %r{^[ ]*contract[ ]+(?<id>#{ID})[ \{]}
-   INTERFACE_RX         = %r{^[ ]*interface[ ]+(?<id>#{ID})[ \{]}
 
+   NAME                    = /[a-zA-Z][a-zA-Z0-9_]*/
+   END_OF_LINE             = /\n|$/
+   ## inline comments (multi- or end-of-line)
+   END_OF_LINE_OR_COMMENT_OR_KEYWORD_OR_QUOTE  = / \n
+                                         | $
+                                         | (?=['"])
+                                         | (?=\/(\/|\*))
+                                         | (?=pragma\b)
+                                         | (?=contract\b)
+                                         | (?=abstract\b)
+                                         | (?=library\b)
+                                         | (?=interface\b)
+                                       /x
+
+
+   def _norm_whitespace( str )
+      ## change newlines to spaces and
+      ##   all multiple spaces to one
+      str = str.gsub( /[ \t\n\r]+/, ' ' )
+      str.strip
+   end
 
    def _quick_pass_one
-     tree = []
-     node = nil
+     ## note:  CANNOT handle inline comments
+     ##           in pragma, contract, etc.  (get "silently" slurped)
+     ##         report a parse error - if comments slurped - why? why not?
+     ##
 
-     inside_comment = false
 
-     @txt.each_line do |line|
-         line = line.chomp ## remove trailing newline
-         ## pp line
+     tree = []
 
-         if inside_comment
-            node[1] << line
-            if  MULTI_COMMENT_END_RX.match( line )
-               tree << node
-               inside_comment = false
-            end
-         else
-           if SINGLE_COMMENT_RX.match( line )   #  end-of-line comments
-               line = line.strip  ## remove leading & trailing spaces
-               ## note: fold end-of-line comments into a block (if not separated by newline)
-               node = tree[-1]
-               if  node.is_a?( Array ) &&
-                   node[0] == :comment && node[1][0].start_with?( '//' )
-                  node[1] << line
-               else
-                 tree << [:comment, [line]]
-               end
-           elsif MULTI_COMMENT_BEGIN_RX.match( line )
-              inside_comment = true
-              node = [:comment, [line]]
-           elsif PRAGMA_RX.match( line )
-              line = line.strip
-              tree << [:pragma, line]
-           elsif LIBRARY_RX.match( line )
-              line = line.strip
-              tree << [:library, line]
-           elsif ABSTRACT_CONTRACT_RX.match( line )
-              line = line.strip
-              tree << [:abstract_contract, line]
-           elsif CONTRACT_RX.match( line )
-              line = line.strip
-              tree << [:contract, line]
-           elsif INTERFACE_RX.match( line )
-              line = line.strip
-              tree << [:interface, line]
-           else
-              tree << line
-           end
-         end
-     end # each_line
+     s = StringScanner.new( @txt )
+
+     loop do
+       s.skip( /[ \t]+/ )  ## note: do NOT skip newlines here; pass along blank/empty lines for now - why? why not?
+       if s.check( "'" )   ## single-quoted string
+          str = s.scan( SINGLE_QUOTE )
+          tree << [:string, str]
+       elsif s.check( '"' )  ## double-quoted string
+          str = s.scan( DOUBLE_QUOTE )
+          tree << [:string, str]
+       elsif s.check( '/*' )
+          comment = s.scan_until( /\*\// )
+          ## print "multi-line comment:"
+          ## pp comment
+          tree << [:comment, comment]
+       elsif s.check( '//' )
+          comment = s.scan_until( END_OF_LINE ).rstrip
+          ## print "comment:"
+          ## pp comment
+          tree << [:comment, comment]
+       else
+          name = s.check( NAME )
+          case name
+          when 'pragma'
+             code = s.scan_until( /;/ )
+             code = _norm_whitespace( code )
+             ## print "pragma:"
+             ## pp code
+             tree << [:pragma, code]
+          when 'contract'
+             code = s.scan_until( /(?=\{)/ )
+             code = _norm_whitespace( code )
+             ## print "contract:"
+             ## pp code
+             tree << [:contract, code]
+          when 'abstract'
+            code = s.scan_until( /(?=\{)/ )
+            code = _norm_whitespace( code )
+            ## print "abstract contract:"
+            ## pp code
+            tree << [:abstract_contract, code]
+         when 'library'
+            code = s.scan_until( /(?=\{)/ )
+            code = _norm_whitespace( code )
+            ## print "library:"
+            ## pp code
+            tree << [:library, code]
+          when 'interface'
+            code = s.scan_until( /(?=\{)/ )
+            code = _norm_whitespace( code )
+            ## print "interface:"
+            ## pp code
+            tree << [:interface, code]
+          else
+            ## slurp chunk ,that is, until newline or comment or tracked keyword
+            chunk = s.scan_until( END_OF_LINE_OR_COMMENT_OR_KEYWORD_OR_QUOTE ).rstrip
+            ## puts "chunk: >#{chunk.inspect}<"
+            tree << chunk
+          end
+       end
+       break if s.eos?
+      end
 
      tree
    end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solidity
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-29 00:00:00.000000000 Z
+date: 2023-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocos