abidoc 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e04cd527574913ca48d6b137779994b1b8591e5f6fef541eb15bf8e3b6189b2c
+  data.tar.gz: f7ad37ae9775b095d34f74907fee9b84f6af5e574ff939de34090fe654ce98cf
+SHA512:
+  metadata.gz: 9c60fab097d3b48c02367f98a4f64690c7679467b7c68ab0f7d50631d9da65a75b1546c03cba5644da23fd671643cfef9f9ba8ea89aa832d7926f623495b5aeb
+  data.tar.gz: c9aa02b3c23cc0b0bc147138726f352d70dedb5e9ecd09b6f4e0be479379d61522b5f15af1c3bccbc75d16ed0e36dded8fcc77356499266e1458928d7d234e12

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### 0.0.1 / 2022-12-26
+
+* Everything is new. First release

data/Manifest.txt

@@ -0,0 +1,6 @@
+CHANGELOG.md
+Manifest.txt
+README.md
+Rakefile
+lib/abidoc.rb
+lib/abidoc/version.rb

data/README.md

@@ -0,0 +1,28 @@
+#  Application Binary Inteface (ABI) Documentation Generator For Ethereum & Co.
+
+abidoc - application binary interface (abi) documentation generator for Ethereum & Co. (blockchain) contracts
+
+
+* 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/abidoc](https://rubygems.org/gems/abidoc)
+* rdoc  :: [rubydoc.info/gems/abidoc](http://rubydoc.info/gems/abidoc)
+
+
+## Usage
+
+
+
+
+## License
+
+The scripts are dedicated to the public domain.
+Use it as you please with no restrictions whatsoever.
+
+
+## Questions? Comments?
+
+
+Post them on the [D.I.Y. Punk (Pixel) Art reddit](https://old.reddit.com/r/DIYPunkArt). Thanks.
+
+

data/Rakefile

@@ -0,0 +1,32 @@
+require 'hoe'
+require './lib/abidoc/version.rb'
+
+
+Hoe.spec 'abidoc' do
+
+  self.version = ABIDoc::VERSION
+
+  self.summary = "abidoc - application binary interface (abi) documentation generator for Ethereum & Co. (blockchain) contracts"
+  self.description = summary
+
+  self.urls    = { home: 'https://github.com/rubycocos/blockchain' }
+
+  self.author  = 'Gerald Bauer'
+  self.email   = 'wwwmake@googlegroups.com'
+
+  # switch extension to .markdown for gihub formatting
+  self.readme_file  = 'README.md'
+  self.history_file = 'CHANGELOG.md'
+
+  self.extra_deps = [
+    ['abiparser'],
+  ]
+
+  self.licenses = ['Public Domain']
+
+  self.spec_extras = {
+    required_ruby_version: '>= 2.3'
+  }
+
+end
+

data/lib/abidoc/version.rb

@@ -0,0 +1,25 @@
+
+module ABIDoc
+
+  MAJOR = 0
+  MINOR = 0
+  PATCH = 1
+  VERSION = [MAJOR,MINOR,PATCH].join('.')
+
+  def self.version
+    VERSION
+  end
+
+  def self.banner
+    "abidoc/#{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__))) )
+  end
+
+end # module ABIDoc
+
+## add convenience alternate spellings - why? why not?
+AbiDoc = ABIDoc
+

data/lib/abidoc.rb

@@ -0,0 +1,64 @@
+require 'abiparser'
+
+
+## our own code
+require_relative 'abidoc/version'    # note: let version always go first
+
+
+
+module ABI
+  class Contract
+
+
+def generate_doc( title: 'Contract ABI' )
+  buf = ''
+  buf << "# #{title}\n\n"
+
+  if @ctor
+    buf << "\n"
+    buf << "**Constructor**\n\n"
+    buf << "- #{@ctor.doc}\n"
+    ## buf << "  - sig #{@ctor.sig}  =>  0x#{sig(@ctor.sig).hexdigest}\n"
+  end
+
+  if payable_functions.size > 0
+    buf << "\n"
+    buf << "**#{payable_functions.size} Payable Function(s)**\n\n"
+    payable_functions.each do |func|
+      buf << "- #{func.doc} _payable_\n"
+      ## buf << "  - sig #{func.sig}  =>  0x#{sig(func.sig).hexdigest}\n"
+    end
+  end
+
+  if transact_functions.size > 0
+    buf << "\n"
+    buf << "**#{transact_functions.size} Transact Functions(s)**\n\n"
+    transact_functions.each do |func|
+      buf << "- #{func.doc}\n"
+      ## buf << "  - sig #{func.sig}  =>  0x#{sig(func.sig).hexdigest}\n"
+    end
+  end
+
+  if query_functions.size > 0
+    buf << "\n"
+    buf << "**#{query_functions.size} Query Functions(s)**\n\n"
+    query_functions.each do |func|
+      buf << "- #{func.doc} _readonly_\n"
+      ## buf << "  - sig #{func.sig}  =>  0x#{sig(func.sig).hexdigest}\n"
+    end
+  end
+
+  if helper_functions.size > 0
+    buf << "\n"
+    buf << "**#{helper_functions.size} Helper Functions(s)**\n\n"
+    helper_functions.each do |func|
+      buf << "- #{func.doc}\n"
+      ## buf << "  - sig #{func.sig}  =>  0x#{sig(func.sig).hexdigest}\n"
+    end
+  end
+
+  buf
+end
+
+end  ## class Contract
+end ##  module ABI

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: abidoc
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gerald Bauer
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-12-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: abiparser
+  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.23'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.23'
+description: abidoc - application binary interface (abi) documentation generator for
+  Ethereum & Co. (blockchain) contracts
+email: wwwmake@googlegroups.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- CHANGELOG.md
+- Manifest.txt
+- README.md
+files:
+- CHANGELOG.md
+- Manifest.txt
+- README.md
+- Rakefile
+- lib/abidoc.rb
+- lib/abidoc/version.rb
+homepage: https://github.com/rubycocos/blockchain
+licenses:
+- Public Domain
+metadata: {}
+post_install_message:
+rdoc_options:
+- "--main"
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: abidoc - application binary interface (abi) documentation generator for Ethereum
+  & Co. (blockchain) contracts
+test_files: []