solidity 0.0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9faf35cb510544cdeeda413efe3b0e4afef0f066
-  data.tar.gz: '013219c327a0515ddac5f3359ad20a1b533f904d'
+SHA256:
+  metadata.gz: e72e223ba2202849d7dbb405a56b1edf7345b911813b3449bbf2059a9ebe87e5
+  data.tar.gz: 2aa7d53cc55bc04929440cb3c49c99b85cc3efe0a151d24f9b887c2ac6297f09
 SHA512:
-  metadata.gz: ae5925d7c00a81b194fa52e885f81ab1c29f4f377547fdc7d39f1db34275f93e18e92025296463005a6c8a034e15448c3ebe8bc0bccfc8272b18b90720808560
-  data.tar.gz: d6d5bdbbc7a7b0f5bef7a727c3f40980a2375436b3dfe990026c1430005a539fcc1bc16d68a8df18d532c8fe14f6cd18808a47f69a992489a3f8862e44bfdae5
+  metadata.gz: 25a530da83da24bbbf6ae85bc97a4ecac8d27eb0745d2952f3f43fda6ad3422021d798edffcafc9e03afcf6bd6d0c7985103fec52caa34987ffdb5d84a8699fd
+  data.tar.gz: '09339328d15e47d6d9a6345f000cbc1dee7fce14dee04e14765f82add73824dbce6fa41ba0dfe1a190059b5aeef93b6c27dc3acf759f67bb0348556098f127e5'

data/Manifest.txt

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

data/README.md

@@ -1,22 +1,103 @@
+# Solidity
 
-# Solidity -  type-safe (crypto) contracts
+solidity gem - (fuzzy) parser for (crypto) contracts for ethereum & co.
 
-solidity gem / library - type-safe (crypto) contracts
 
-* home  :: [github.com/s6ruby/ruby-to-solidity](https://github.com/s6ruby/ruby-to-solidity)
-* bugs  :: [github.com/s6ruby/ruby-to-solidity/issues](https://github.com/s6ruby/ruby-to-solidity/issues)
+* home  :: [github.com/rubycocos/blockchain](https://github.com/rubycocos/blockchain)
+* bugs  :: [github.com/rubycocos/blockchain/issues](https://github.com/rubycocos/blockchain/issues)
 * gem   :: [rubygems.org/gems/solidity](https://rubygems.org/gems/solidity)
 * rdoc  :: [rubydoc.info/gems/solidity](http://rubydoc.info/gems/solidity)
 
 
 
+
+
 ## Usage
 
-To be done
+Get / generate outline from source in the solidity (`.sol`) contract programming language:
 
-## License
+```ruby
+[
+ "0x34625ecaa75c0ea33733a05c584f4cf112c10b6b",
+ "0x0cfdb3ba1694c2bb2cfacb0339ad7b1ae5932b63",
+ "0x031920cc2d9f5c10b444fd44009cd64f829e7be2"
+].each do |addr|
+
+  path = "awesome-contracts/address/#{addr}/contract.sol"
+  txt = read_text( path )
+
+  parser = Solidity::Parser.new( txt )
+
+  puts "---"
+  puts "outline:"
+  puts parser.outline
+
+  ## bonus: dump the pragmas (required solidity compiler versions)
+  puts
+  puts "pragmas:"
+  puts parser.pragmas
+```
+
+Resulting in:
+
+```
+outline:
+contract NounsDescriptor is INounsDescriptor, Ownable
+abstract contract Ownable is Context
+library Strings
+interface INounsDescriptor
+interface INounsSeeder
+library NFTDescriptor
+library MultiPartRLEToSVG
+abstract contract Context
+library Base64
+```
 
-![](https://publicdomainworks.github.io/buttons/zero88x31.png)
+
+```
+outline:
+contract Indelible is ERC721A, ReentrancyGuard, Ownable
+library DynamicBuffer
+library HelperLib
+library SSTORE2
+library Bytecode
+abstract contract Ownable is Context
+abstract contract ReentrancyGuard
+library Address
+library Base64
+abstract contract Context
+library MerkleProof
+contract ERC721A is IERC721A
+interface IERC721A
+```
+
+
+```
+outline:
+contract CryptoZunks is Ownable, ERC721Enumerable, ERC721Burnable, ReentrancyGuard
+abstract contract Ownable is Context
+abstract contract ReentrancyGuard
+contract ERC721 is Context, ERC165, IERC721, IERC721Metadata
+abstract contract ERC721Burnable is Context, ERC721
+abstract contract ERC721Enumerable is ERC721, IERC721Enumerable
+library Strings
+library EnumerableMap
+library console
+abstract contract Context
+interface IERC721 is IERC165
+interface IERC721Receiver
+interface IERC721Metadata is IERC721
+library Address
+abstract contract ERC165 is IERC165
+interface IERC165
+interface IERC721Enumerable is IERC721
+library EnumerableSet
+```
+
+
+
+
+## License
 
 The `solidity` scripts are dedicated to the public domain.
 Use it as you please with no restrictions whatsoever.
@@ -24,5 +105,5 @@ Use it as you please with no restrictions whatsoever.
 
 ## Questions? Comments?
 
-Send them along to the [wwwmake forum](http://groups.google.com/group/wwwmake).
-Thanks!
+Post them on the [D.I.Y. Punk (Pixel) Art reddit](https://old.reddit.com/r/DIYPunkArt). Thanks.
+

data/Rakefile

@@ -5,10 +5,10 @@ Hoe.spec 'solidity' do
 
   self.version = Solidity::VERSION
 
-  self.summary = "solidity - type-safe (crypto) contracts"
+  self.summary = "solidity - (fuzzy) parser for (crypto) contracts for ethereum & co."
   self.description = summary
 
-  self.urls    = ['https://github.com/s6ruby/ruby-to-solidity']
+  self.urls    = { home: 'https://github.com/rubycocos/blockchain' }
 
   self.author  = 'Gerald Bauer'
   self.email   = 'wwwmake@googlegroups.com'
@@ -18,6 +18,7 @@ Hoe.spec 'solidity' do
   self.history_file = 'CHANGELOG.md'
 
   self.extra_deps = [
+    ['cocos'],
   ]
 
   self.licenses = ['Public Domain']

data/lib/solidity/version.rb

@@ -1,10 +1,8 @@
-# encoding: utf-8
-
 
 module Solidity
 
   MAJOR = 0
-  MINOR = 0
+  MINOR = 1
   PATCH = 1
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
@@ -13,11 +11,11 @@ module Solidity
   end
 
   def self.banner
-    "solidity/#{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
+    "solidity/#{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}] in (#{root})"
   end
 
   def self.root
-    "#{File.expand_path( File.dirname(File.dirname(File.dirname(__FILE__))) )}"
+    File.expand_path( File.dirname(File.dirname(File.dirname(__FILE__))) )
   end
 
 end # module Solidity

data/lib/solidity.rb

@@ -1,9 +1,128 @@
-# encoding: utf-8
+require 'cocos'
 
-require 'pp'
 
 ## our own code
-require 'solidity/version'    # note: let version always go first
+require_relative 'solidity/version'    # note: let version always go first
+
+
+
+
+module Solidity
+
+class Parser
+   def initialize( txt )
+     @txt = txt
+   end
+
+
+   SINGLE_COMMENT_RX         = %r{^[ ]*//}
+   MULTI_COMMENT_BEGIN_RX    = %r{^[ ]*/\*}
+   MULTI_COMMENT_END_RX      = %r{\*/[ ]*$}
+
+   ID = '[a-zA-Z][a-zA-Z0-9]*'
+
+   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})[ \{]}
+
+
+   def _quick_pass_one
+     tree = []
+     node = nil
+
+     inside_comment = false
+
+     @txt.each_line do |line|
+         line = line.chomp ## remove trailing newline
+         ## pp line
+
+         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
+
+     tree
+   end
+
+
+   def outline
+      buf = String.new( '' )
+      tree = _quick_pass_one
+
+      tree.each do |node|
+         if node.is_a?( Array )
+            case node[0]
+            when :contract           then  buf << node[1] << "\n"
+            when :abstract_contract  then  buf << node[1] << "\n"
+            when :interface          then  buf << node[1] << "\n"
+            when :library            then  buf << node[1] << "\n"
+            else
+            end
+         end
+      end
+
+      buf
+   end
+
+   def pragmas
+      buf = String.new( '' )
+      tree = _quick_pass_one
+
+      tree.each do |node|
+         if node.is_a?( Array )
+            case node[0]
+            when :pragma             then  buf << node[1] << "\n"
+            end
+         end
+      end
+
+      buf
+   end
+
+
+end  # class Parser
+
+
+end  # module Solidity
+
 
 
 puts Solidity.banner    ## say hello

metadata

@@ -1,65 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: solidity
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors:
 - Gerald Bauer
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-04-11 00:00:00.000000000 Z
+date: 2023-01-29 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: cocos
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: hoe
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.16'
+        version: '3.23'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.16'
-description: solidity - type-safe (crypto) contracts
+        version: '3.23'
+description: solidity - (fuzzy) parser for (crypto) contracts for ethereum & co.
 email: wwwmake@googlegroups.com
 executables: []
 extensions: []
 extra_rdoc_files:
 - CHANGELOG.md
-- LICENSE.md
 - Manifest.txt
 - README.md
 files:
 - CHANGELOG.md
-- LICENSE.md
 - Manifest.txt
 - README.md
 - Rakefile
 - lib/solidity.rb
 - lib/solidity/version.rb
-homepage: https://github.com/s6ruby/ruby-to-solidity
+homepage: https://github.com/rubycocos/blockchain
 licenses:
 - Public Domain
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--main"
 - README.md
@@ -76,9 +94,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
-summary: solidity - type-safe (crypto) contracts
+summary: solidity - (fuzzy) parser for (crypto) contracts for ethereum & co.
 test_files: []

data/LICENSE.md

@@ -1,116 +0,0 @@
-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/