elisp2any 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cc2fe1682b2547fa70fda8d7f8690040fc0a0276437ac5faf2797b9e776c09f6
+  data.tar.gz: 7717313833f55ef58f5377ecdf09466176e8ef16ad792fe55f8a6e15a54195f0
+SHA512:
+  metadata.gz: 7f0142bcf30fd78d46f280a4c4c7f1dbe29242bba02b45aff44afb0e045c31eaba2f22e9198e94d0c22a5a73a5bddcc155c76cb5291d9cd067b2cb563bf41d26
+  data.tar.gz: 868629bfbbcdd6812c007332f9137c218bcf5b28565191c9b6649986ccb0a5cf904610fb9ff35a5aa4f91d06b21ddbc006b354c6f3d7879b6d1126b382ccf683

data/.envrc

@@ -0,0 +1 @@
+export ELISP2ANY_GUIX_USE_PROFILE_PATH=yes

data/.rubocop.yml

@@ -0,0 +1,19 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+  DisabledByDefault: true
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Layout/LineLength:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: never

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.0.1] - 2023-10-27
+
+- Initial release

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake', '~> 13.0'
+gem 'test-unit', '~> 3.0'
+gem 'rubocop', '~> 1.21'

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,32 @@
+# Elisp2any
+
+## Installation
+
+Install the gem and add to the application's `Gemfile` by executing `bundle add elisp2any`.
+If Bundler is not being used to manage dependencies, install the gem by executing `gem install elisp2any`.
+
+## Usage
+
+Currently the command line tool only supports HTML rendering.
+
+```shell
+$ elisp2any --input /path/to/input/file --output /path/to/output/file
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake test` to run the tests.
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome.
+
+## License
+
+This package is provided under the Apache License.
+See `LICENSE.txt` for details.

data/Rakefile

@@ -0,0 +1,44 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]
+
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  readme = 'README.md'
+  rdoc.main = readme
+  rdoc.rdoc_files.include(readme, 'lib/**/*.rb')
+end
+
+desc 'start API document server'
+task :serve_api do
+  serve('html')
+end
+
+desc 'generate type signatures'
+task :sig do
+  sh 'typeprof', *Dir['lib/**/*.rb'], 'sig/elisp2any.rbs', '-o', 'sig/elisp2any.gen.rbs'
+end
+
+desc 'start HTML fixture server'
+task :serve_fixture do
+  serve('fixtures/init')
+end
+
+def serve(path)
+  sh 'ruby', '-run', '-e', 'httpd', path
+end
+
+file 'fixtures/init/adoc/index.html' => 'fixtures/init/index.adoc' do |t|
+  sh 'asciidoctor', t.source, '--out-file', t.name
+end

data/exe/elisp2any

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+require_relative "../lib/elisp2any"
+require_relative "../lib/elisp2any/html_renderer"
+require 'optparse'
+input = $stdin
+output = $stdout
+OptionParser.new do |parser|
+  parser.on('--input=PATH') do |path|
+    input = File.open(path)
+  end
+  parser.on('--output=PATH') do |path|
+    output = File.open(path, 'w')
+  end
+end.parse!
+file = Elisp2any::File.parse(input)
+renderer = Elisp2any::HTMLRenderer.new(file)
+output.write(renderer.render)

data/fixtures/init.el

@@ -0,0 +1,64 @@
+;;; init.el --- Emacs configuration
+
+;;; Commentary:
+
+;; This is my Emacs configuration file.  It sets up various
+;; preferences, packages, and keybindings.
+
+;; This is a second paragraph.
+
+;;; Code:
+
+;;;; Package
+
+;;;;; Initialize package manager
+
+(require 'package)
+(add-to-list 'package-archives '("melpa" . "https://melpa.org/packages/") t)
+(package-initialize)
+(unless package-archive-contents
+  (package-refresh-contents))
+
+;; This is a sample sentence including `inline-code'.
+
+;;;;; Install and configure `use-package' for managing packages
+
+(unless (package-installed-p 'use-package)
+  (package-install 'use-package))
+(require 'use-package)
+(setq use-package-always-ensure t)
+
+;;;; Basic UI and keybindings
+
+(setq inhibit-startup-screen t)
+(scroll-bar-mode -1)
+(tool-bar-mode -1) ;sample comment
+(menu-bar-mode -1)
+(column-number-mode 1)
+
+(global-hl-line-mode 1) ;sample comment 1
+                        ;sample comment 2
+
+;;;; Font
+
+(set-face-attribute 'default nil :font "DejaVu Sans Mono-11")
+
+;;;; Theme
+
+(use-package dracula-theme
+  :config
+  (load-theme 'dracula t))
+
+;;;; Hooks
+
+(add-hook 'prog-mode-hook #'prettify-symbols-mode)
+
+;;;; Finalize and run
+
+(require 'server)
+(unless (server-running-p)
+  (server-start))
+
+(provide 'init)
+
+;;; init.el ends here

data/lib/elisp2any/asciidoc_renderer/index.adoc.erb

@@ -0,0 +1,15 @@
+= <%= name %>
+
+<%= synopsis %>
+
+== Commentary
+
+<% commentary.each do |paragraph| %>
+<%= render_paragraph(paragraph) %>
+<% end %>
+
+== Code
+
+<% code.each do |block| %>
+<%= render_block(block, level: 2) %>
+<% end %>

data/lib/elisp2any/asciidoc_renderer.rb

@@ -0,0 +1,57 @@
+require 'forwardable'
+
+module Elisp2any
+  # This renderer is experimental.
+  class AsciiDocRenderer
+    def initialize(file)
+      @file = file
+    end
+
+    def render
+      erb_renderer('index.adoc.erb')
+    end
+
+    private
+
+    def render_paragraph(paragraph)
+      adoc = ''
+      paragraph.each do |line|
+        line.each do |chunk|
+          case chunk
+          when InlineCode
+            adoc << "``#{chunk.content}``"
+          when String
+            adoc << chunk
+          end
+        end
+      end
+      adoc
+    end
+
+    def render_block(block, level:)
+      adoc = ''
+      case block
+      when Heading
+        prefix = '=' * (level + block.level - 1)
+        adoc << "#{prefix} #{block.content}"
+      when Paragraph
+        adoc << render_paragraph(block)
+      when CodeBlock
+        adoc << <<~ADOC
+          ----
+          #{block.content}
+          ----
+        ADOC
+      end
+      adoc
+    end
+
+    def erb_renderer(path)
+      source = ::File.read(::File.join(__dir__, 'asciidoc_renderer', path))
+      ERB.new(source).result(binding)
+    end
+
+    extend Forwardable
+    def_delegators :@file, :name, :synopsis, :commentary, :code
+  end
+end

data/lib/elisp2any/code_block.rb

@@ -0,0 +1,16 @@
+require 'forwardable'
+
+module Elisp2any
+  class CodeBlock
+    def initialize(node) # :nodoc:
+      @node = node
+    end
+
+    def append(source, end_byte) # :nodoc:
+      @node.append(source, end_byte)
+    end
+
+    extend Forwardable
+    def_delegators :@node, :content
+  end
+end

data/lib/elisp2any/file.rb

@@ -0,0 +1,31 @@
+require_relative 'node'
+require_relative 'tree_sitter_parser'
+
+module Elisp2any
+  class File
+    attr_reader :name, :synopsis, :commentary, :code
+
+    def self.parse(source)
+      source = source.respond_to?(:read) ? source.read : source
+      ts_node = TreeSitterParser.parse(source)
+      first_heading, second_heading, *nodes, last_heading = Node.from_tree_sitter(source, ts_node)
+      name, synopsis = first_heading.name_and_synopsis
+      second_heading.commentary? or raise Error, "no commentary heading: #{second_heading.inspect}"
+      commentary = []
+      until nodes.empty?
+        (node = nodes.shift).code? and break
+        commentary << node
+      end
+      code = nodes
+      last_heading.final_name == name or raise Error, 'different names'
+      new(name: name, synopsis: synopsis, commentary: commentary, code: code)
+    end
+
+    def initialize(name:, synopsis:, commentary:, code:) # :nodoc:
+      @name = name
+      @synopsis = synopsis
+      @commentary = commentary
+      @code = code
+    end
+  end
+end

data/lib/elisp2any/heading.rb

@@ -0,0 +1,40 @@
+require 'strscan'
+require 'forwardable'
+
+module Elisp2any
+  class Heading
+    attr_reader :level, :content
+
+    def initialize(node, level, content) # :nodoc:
+      @node = node
+      @level = level
+      @content = content
+    end
+
+    # Returns nil if failed
+    def name_and_synopsis # :nodoc:
+      scanner = StringScanner.new(@content)
+      name = scanner.scan_until(/\.el/) or return
+      name = name[nil...-3] or return
+      scanner.skip(/\s+---\s+/) or return
+      scanner.skip(/(?<synopsis>.+?)(:?\s+-\*- .+? -\*-)?\Z/) or return
+      synopsis = scanner[:synopsis]
+      return name, synopsis
+    end
+
+    def commentary? # :nodoc:
+      @level == 1 && @content == 'Commentary:'
+    end
+
+    def code? # :nodoc:
+      @level == 1 && @content == 'Code:'
+    end
+
+    def final_name # :nodoc:
+      @content.match(/\A(?<name>.+?)\.el ends here\Z/)[:name]
+    end
+
+    extend Forwardable
+    def_delegator :@level, :<=>
+  end
+end

data/lib/elisp2any/html_renderer/index.html.erb

@@ -0,0 +1,23 @@
+<!doctype html>
+<html>
+    <head>
+	<meta charset="UTF-8">
+	<meta name="viewport" content="width=device-width, initial-scale=1">
+	<title><%= name %></title>
+	<link rel="stylesheet" href="https://unpkg.com/mvp.css">
+    </head>
+    <body>
+	<main>
+	    <h1><%= name %></h1>
+	    <p><%= synopsis %></p>
+	    <h3>Commentary</h3>
+	    <% commentary.each do |paragraph| %>
+		<p><%= render_paragraph(paragraph) %></p>
+	    <% end %>
+	    <h2>Code</h2>
+	    <% code.each do |block| %>
+		<%= render_block(block, level: 2) %>
+	    <% end %>
+	</main>
+    </body>
+</html>

data/lib/elisp2any/html_renderer.rb

@@ -0,0 +1,62 @@
+require 'erb'
+require 'forwardable'
+require 'cgi/util'
+require_relative 'inline_code'
+require_relative 'heading'
+require_relative 'paragraph'
+require_relative 'code_block'
+
+module Elisp2any
+  class HTMLRenderer
+    def initialize(file)
+      @file = file
+    end
+
+    def render
+      erb_render('index.html.erb')
+    end
+
+    private
+
+    def render_paragraph(paragraph)
+      html = ''
+      paragraph.each do |line|
+        line.each do |chunk|
+          case chunk
+          when InlineCode
+            html << "<code>#{h(chunk.content)}</code>"
+          when String
+            html << h(chunk)
+          end
+        end
+      end
+      html
+    end
+
+    def render_block(block, level:)
+      html = ''
+      case block
+      when Heading
+        name = "h#{level + block.level - 1}"
+        html << "<#{name}>#{h(block.content)}</#{name}>"
+      when Paragraph
+        html << render_paragraph(block)
+      when CodeBlock
+        html << "<pre><code>#{h(block.content)}</code></pre>"
+      end
+      html
+    end
+
+    def erb_render(path)
+      source = ::File.read(::File.join(__dir__, 'html_renderer', path))
+      ERB.new(source).result(binding)
+    end
+
+    def h(string)
+      CGI.escape_html(string)
+    end
+
+    extend Forwardable
+    def_delegators :@file, :name, :synopsis, :commentary, :code
+  end
+end

data/lib/elisp2any/inline_code.rb

@@ -0,0 +1,9 @@
+module Elisp2any
+  class InlineCode
+    attr_reader :content
+
+    def initialize(content)
+      @content = content
+    end
+  end
+end

data/lib/elisp2any/line.rb

@@ -0,0 +1,36 @@
+require 'strscan'
+require 'forwardable'
+require_relative 'inline_code'
+
+module Elisp2any
+  class Line
+    def initialize(chunks) # :nodoc:
+      @chunks = chunks
+    end
+
+    def self.parse(string) # :nodoc:
+      scanner = StringScanner.new(string)
+      chunks = []
+
+      until scanner.eos?
+        if scanner.skip(/`(?<content>[^']+)'/)
+          chunks << InlineCode.new(scanner[:content])
+        else
+          chunk = scanner.getch
+          if (last = chunks.last).is_a?(String)
+            last << chunk
+          else
+            chunks << chunk
+          end
+        end
+      end
+
+      new(chunks)
+    end
+
+    extend Forwardable
+    def_delegators :@chunks, :each
+
+    include Enumerable
+  end
+end

data/lib/elisp2any/node.rb

@@ -0,0 +1,63 @@
+require_relative 'code_block'
+require_relative 'line'
+require_relative 'heading'
+require_relative 'paragraph'
+require 'strscan'
+
+module Elisp2any
+  class Node
+    attr_reader :range # :nodoc:
+    attr_reader :content
+
+    def self.from_tree_sitter(source, ts_node) #:nodoc:
+      nodes = []
+      (0 ... ts_node.child_count).map { |index| ts_node[index] }.each do |top_level_node|
+        range = top_level_node.start_byte .. top_level_node.end_byte
+        content = source.byteslice(range)
+        node = Node.new(content, range)
+        case top_level_node.type
+        when :comment
+          scanner = StringScanner.new(content)
+          scanner.skip(';') or raise Error, 'no semicolon for comment'
+          if scanner.skip(';')
+            if (level = scanner.skip(/;+/))
+              scanner.skip(' ') or raise Error, 'no space after heading semicolons'
+              nodes << Heading.new(node, level, scanner.rest.chomp)
+            elsif scanner.skip("\n")
+              # nop
+            else
+              scanner.skip(' ') or raise Error, "no space after semicolons: #{scanner.inspect}"
+              line = Line.parse(scanner.rest)
+              if (last_node = nodes.last) && last_node.is_a?(Paragraph) && last_node.end_row + 1 == top_level_node.start_point.row
+                last_node << line
+              else
+                paragraph = Paragraph.new(node, [line], top_level_node.end_point.row)
+                nodes << paragraph
+              end
+            end
+          else
+            (last_node = nodes.last) && last_node.is_a?(CodeBlock) or raise Error, 'no prior code for single semicolon comment'
+            last_node.append(source, range.end)
+          end
+        else
+          if (last_node = nodes.last) && last_node.is_a?(CodeBlock)
+            last_node.append(source, range.end)
+          else
+            nodes << CodeBlock.new(node)
+          end
+        end
+      end
+      nodes
+    end
+
+    def append(source, end_byte) # :nodoc:
+      @range = range = @range.begin .. end_byte
+      @content = source.byteslice(range)
+    end
+
+    def initialize(content, range) # :nodoc:
+      @content = content
+      @range = range
+    end
+  end
+end

data/lib/elisp2any/paragraph.rb

@@ -0,0 +1,23 @@
+require 'forwardable'
+
+module Elisp2any
+  class Paragraph
+    attr_reader :end_row # :nodoc:
+
+    def initialize(node, lines, end_row) # :nodoc:
+      @node = node
+      @lines = lines
+      @end_row = end_row
+    end
+
+    def code?
+      false
+    end
+
+    extend Forwardable
+    def_delegators :@lines, :empty?, :clear, :<<, :each
+    def_delegators :@node, :adjucent?
+
+    include Enumerable
+  end
+end

data/lib/elisp2any/tree_sitter_parser.rb

@@ -0,0 +1,37 @@
+require 'tree_sitter'
+
+module Elisp2any
+  class TreeSitterParser # :nodoc:
+    def self.parse(source)
+      new(source).parse
+    end
+
+    def parse
+      @node = parser.parse_string(nil, @source).root_node
+    end
+
+    private
+
+    def initialize(source)
+      @source = source
+    end
+
+    def parser
+      TreeSitter::Parser.new.tap do |p|
+        p.language = TreeSitter::Language.load('elisp', elisp_library)
+      end
+    end
+
+    def elisp_library
+      shared_object = 'libtree-sitter-elisp.so'
+
+      # Set this env var for Guix shell environment or shared object file is not found
+      if ENV['ELISP2ANY_GUIX_USE_PROFILE_PATH']
+        profile = ::File.dirname(ENV['PATH'].split(':').select { |path| path.start_with?('/gnu/store/') }.first)
+        shared_object = ::File.join(profile, 'lib/tree-sitter', shared_object)
+      end
+
+      shared_object
+    end
+  end
+end

data/lib/elisp2any/version.rb

@@ -0,0 +1,3 @@
+module Elisp2any
+  VERSION = '0.0.1'
+end

data/lib/elisp2any.rb

@@ -0,0 +1,6 @@
+require_relative 'elisp2any/version'
+require_relative 'elisp2any/file'
+
+module Elisp2any
+  class Error < StandardError; end
+end

data/manifest.scm

@@ -0,0 +1,6 @@
+(specifications->manifest (list "ruby@3.1"
+                                "ruby-tree-sitter"
+                                "tree-sitter-elisp"
+                                "ruby-webrick"
+                                "ruby-rubocop"
+				"ruby-asciidoctor"))

data/sig/elisp2any.gen.rbs

@@ -0,0 +1,112 @@
+# TypeProf 0.21.3
+
+# Classes
+module Elisp2any
+  VERSION: String
+
+  class AsciiDocRenderer
+    extend Forwardable
+    @file: untyped
+
+    def initialize: (untyped file) -> void
+    def render: -> untyped
+
+    private
+    def render_paragraph: (untyped paragraph) -> String
+    def render_block: (untyped block, level: untyped) -> String
+    def erb_renderer: (String path) -> untyped
+  end
+
+  class CodeBlock
+    extend Forwardable
+    @node: Node
+
+    def initialize: (Node node) -> void
+    def append: (untyped source, untyped end_byte) -> untyped
+  end
+
+  class InlineCode
+    attr_reader content: untyped
+    def initialize: (untyped content) -> void
+  end
+
+  class Line
+    extend Forwardable
+    include Enumerable
+    @chunks: Array[(InlineCode | String)?]
+
+    def initialize: (Array[(InlineCode | String)?] chunks) -> void
+    def self.parse: (String string) -> Line
+  end
+
+  class Heading
+    extend Forwardable
+    @node: Node
+
+    attr_reader level: Integer
+    attr_reader content: String
+    def initialize: (Node node, Integer level, String content) -> void
+    def name_and_synopsis: -> [untyped, untyped]?
+    def commentary?: -> bool
+    def code?: -> bool
+    def final_name: -> String?
+  end
+
+  class Paragraph
+    extend Forwardable
+    include Enumerable
+    @node: Node
+    @lines: [Line]
+
+    attr_reader end_row: untyped
+    def initialize: (Node node, [Line] lines, untyped end_row) -> void
+    def code?: -> false
+  end
+
+  class Node
+    attr_reader range: Range
+    attr_reader content: untyped
+    def self.from_tree_sitter: (untyped source, untyped ts_node) -> (Array[CodeBlock | Heading | Paragraph])
+    def append: (untyped source, untyped end_byte) -> untyped
+    def initialize: (untyped content, Range range) -> void
+  end
+
+  class TreeSitterParser
+    @source: untyped
+    @node: untyped
+
+    def self.parse: (untyped source) -> untyped
+    def parse: -> untyped
+
+    private
+    def initialize: (untyped source) -> void
+    def parser: -> untyped
+    def elisp_library: -> String
+  end
+
+  class File
+    attr_reader name: nil
+    attr_reader synopsis: nil
+    attr_reader commentary: Array[(CodeBlock | Heading | Paragraph)?]
+    attr_reader code: Array[CodeBlock | Heading | Paragraph]
+    def self.parse: (untyped source) -> File
+    def initialize: (name: nil, synopsis: nil, commentary: Array[(CodeBlock | Heading | Paragraph)?], code: Array[CodeBlock | Heading | Paragraph]) -> void
+  end
+
+  class HTMLRenderer
+    extend Forwardable
+    @file: untyped
+
+    def initialize: (untyped file) -> void
+    def render: -> String
+
+    private
+    def render_paragraph: (untyped paragraph) -> String
+    def render_block: (untyped block, level: untyped) -> String
+    def erb_render: (String path) -> String
+    def h: (untyped string) -> String
+  end
+
+  class Error < StandardError
+  end
+end

data/sig/elisp2any.rbs

@@ -0,0 +1,4 @@
+module Elisp2any
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: elisp2any
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- gemmaro
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby_tree_sitter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.8.1
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: asciidoctor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: elisp2any is a command line tool and library for converting Emacs Lisp
+  source to some document markup, such as HTML or Markdown.
+email:
+- gemmaro.dev@gmail.com
+executables:
+- elisp2any
+extensions: []
+extra_rdoc_files: []
+files:
+- ".envrc"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/elisp2any
+- fixtures/init.el
+- lib/elisp2any.rb
+- lib/elisp2any/asciidoc_renderer.rb
+- lib/elisp2any/asciidoc_renderer/index.adoc.erb
+- lib/elisp2any/code_block.rb
+- lib/elisp2any/file.rb
+- lib/elisp2any/heading.rb
+- lib/elisp2any/html_renderer.rb
+- lib/elisp2any/html_renderer/index.html.erb
+- lib/elisp2any/inline_code.rb
+- lib/elisp2any/line.rb
+- lib/elisp2any/node.rb
+- lib/elisp2any/paragraph.rb
+- lib/elisp2any/tree_sitter_parser.rb
+- lib/elisp2any/version.rb
+- manifest.scm
+- sig/elisp2any.gen.rbs
+- sig/elisp2any.rbs
+homepage:
+licenses: []
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Converter from Emacs Lisp to some document markup
+test_files: []