natspec 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f9c9f2377b94fed29636cb0895bb347c6879af7daf032a0b22c6e1d0c2543bc3
+  data.tar.gz: 13269cbe3eb879e217cabbb56128312a0349c4ecb23ce6a0da405eaed4bd671f
+SHA512:
+  metadata.gz: 4fbca50fe5cfaa526d94c39b75e9f635b794a3281124a5179343168ddce0f6c2baeb8eb3e45da62457ad32044c397fcb72f37c10198b9ea3c7ba3fdcf4951093
+  data.tar.gz: c7dfd9ea9d0e3423b6497db39c74deca392eed8e6b78e3ce8190566ef46ba3c192f7fc12de3040ca69907ee8d8ba8f71a6255e5fa846465d86737c2ca627d3d0

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### 0.0.1 / 2023-01-13
+
+* Everything is new. First release

data/Manifest.txt

@@ -0,0 +1,5 @@
+CHANGELOG.md
+Manifest.txt
+README.md
+Rakefile
+lib/natspec.rb

data/README.md

@@ -0,0 +1,32 @@
+#  Natspec -  Natural Spec(ification) Documentation Parser
+
+natspec - natural specification (comments) parser / machinery; document application binary interfaces (abis) 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/natspec](https://rubygems.org/gems/natspec)
+* rdoc  :: [rubydoc.info/gems/natspec](http://rubydoc.info/gems/natspec)
+
+
+
+## Usage
+
+To be done
+
+
+
+
+## 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,30 @@
+require 'hoe'
+
+
+Hoe.spec 'natspec' do
+
+  self.version = '0.0.1'
+
+  self.summary = "natspec - natural specification (comments) parser / machinery; document application binary interfaces (abis) 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 = [
+  ]
+
+  self.licenses = ['Public Domain']
+
+  self.spec_extras = {
+    required_ruby_version: '>= 2.3'
+  }
+
+end
+

data/lib/natspec.rb

@@ -0,0 +1,139 @@
+require 'cocos'
+
+
+module Natspec
+
+
+class Document
+   attr_reader :head, :sections,
+               :storage, :functions
+   def initialize( head, sections )
+      @head      = head
+      @sections = sections
+
+      @storage, @functions = _parse_sections( @sections )
+   end
+
+   def _parse_sections( sections )
+
+     storage = {}
+     functions = {}
+
+     sections.each do |heading, lines|
+
+       if (m=heading.match(/\Astorage[ ]+(.+)[ ]+(?<id>[_A-Za-z0-9]+)\z/))
+          storage[ m[:id] ] = [heading,lines]
+       elsif (m=heading.match(/\Afunction[ ]+(?<id>[_A-Za-z0-9]+)([ (]|\z)/))
+          functions[ m[:id] ] = [heading,lines]
+       else
+         puts "!! ERROR - unsupported heading type in line >#{heading}<; sorry"
+         exit 1
+       end
+     end
+
+     [storage, functions]
+   end
+end
+
+
+class Parser
+  def initialize( txt )
+    @txt = txt
+  end
+
+  def parse
+    head = []
+    sections = []
+
+    section = nil
+    @txt.each_line do |line|
+
+      line = line.rstrip
+      if (m=line.match( /\A[ ]*\#{2}[ ]*(?<heading>.+)[ ]*\z/ ))
+        puts "  found heading >#{m[:heading]}<"
+        sections << section   if section
+        section = [m[:heading],[]]
+      elsif (m=line.match(/\A[ ]*\#{1,}/ ))
+        puts "   !! ERROR - unsupported heading level in line >#{line}<; sorry"
+        exit 1
+      else
+          if section
+            section[1] << line
+          else
+            head << line
+          end
+      end
+    end
+
+    sections <<  section  if section
+
+
+    ## pre-process sections
+    ##  remove trailing empty lines
+    _strip_empty_leading_lines( head )
+    _strip_empty_trailing_lines( head )
+    _indent_code_block( head )
+
+    sections.each do |heading, lines|
+      _strip_empty_leading_lines( lines )
+      _strip_empty_trailing_lines( lines )
+      _strip_code_block( lines )
+    end
+
+
+    Document.new( head, sections )
+  end
+
+
+  def _strip_code_block( sect )
+    sect.reject! { |line| line.start_with?( '```' ) }
+  end
+
+  def _indent_code_block( sect )
+    ## step 1: indent code blocks
+    inside_block = false
+    sect.each_with_index do |line,i|
+      if line.start_with?( '```' )
+         inside_block = !inside_block
+      elsif inside_block
+          sect[i] = (' '*4) + sect[i]
+      else
+         ## regular line; keep going
+      end
+    end
+    ## step 2: remove all code block lines
+    _strip_code_block( sect )
+  end
+
+
+  def _strip_empty_trailing_lines( sect )
+     loop do
+       line = sect[-1]
+         if line && line.empty?
+            sect.pop
+         else
+            break
+         end
+     end
+     sect
+  end
+
+  def _strip_empty_leading_lines( sect )
+    loop do
+      line = sect[0]
+        if line && line.empty?
+           sect.shift
+        else
+           break
+        end
+    end
+    sect
+ end
+end  # class Parser
+
+
+  def self.read( path )
+    Parser.new( read_text( path ) ).parse
+  end
+
+end  # module Natspec

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: natspec
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gerald Bauer
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-01-13 00:00:00.000000000 Z
+dependencies:
+- !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: natspec - natural specification (comments) parser / machinery; document
+  application binary interfaces (abis) 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/natspec.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: natspec - natural specification (comments) parser / machinery; document application
+  binary interfaces (abis) for Ethereum & Co. (blockchain) contracts
+test_files: []