elisp2any 0.0.4 → 0.0.6

metadata

@@ -1,43 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: elisp2any
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors:
 - gemmaro
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-08 00:00:00.000000000 Z
+date: 2025-06-22 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: 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'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.21'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.21'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
@@ -80,22 +38,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !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'
 description: elisp2any is a command line tool and library for converting Emacs Lisp
-  source to some document markup, such as HTML or AsciiDoc.
+  source to some document markup, such as HTML.
 email:
 - gemmaro.dev@gmail.com
 executables:
@@ -103,10 +47,6 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".document"
-- ".envrc"
-- ".rdoc_options"
-- ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -114,38 +54,32 @@ files:
 - Rakefile
 - exe/elisp2any
 - fixtures/init.el
+- lib/elisp.rb
+- lib/elisp/comment.rb
+- lib/elisp/parser.rb
 - lib/elisp2any.rb
-- lib/elisp2any/asciidoc_renderer.rb
-- lib/elisp2any/asciidoc_renderer/index.adoc.erb
+- lib/elisp2any/aside.rb
 - lib/elisp2any/blanklines.rb
 - lib/elisp2any/code.rb
-- lib/elisp2any/code_block.rb
+- lib/elisp2any/codeblock.rb
 - lib/elisp2any/comment.rb
 - lib/elisp2any/commentary.rb
 - lib/elisp2any/expression.rb
-- lib/elisp2any/file.rb
-- lib/elisp2any/filename.rb
+- lib/elisp2any/footer_line.rb
 - lib/elisp2any/header_line.rb
-- lib/elisp2any/header_line_variable_assignment.rb
-- lib/elisp2any/header_line_variables.rb
 - lib/elisp2any/heading.rb
+- lib/elisp2any/html_renderer.erb
 - 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/section.rb
-- lib/elisp2any/top_heading.rb
-- lib/elisp2any/tree_sitter_parser.rb
-- lib/elisp2any/variable.rb
+- lib/elisp2any/text.rb
 - lib/elisp2any/version.rb
-- manifest.scm
-- sig/elisp2any.gen.rbs
-- sig/elisp2any.rbs
 homepage: https://codeberg.org/gemmaro/elisp2any
 licenses:
-- Apache-2.0
+- GPL-3.0-or-later
 metadata:
   rubygems_mfa_required: 'true'
   bug_tracker_uri: https://codeberg.org/gemmaro/elisp2any/issues
@@ -162,14 +96,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.3.27
 signing_key:
 specification_version: 4
 summary: Converter from Emacs Lisp to some document markup

data/.document

@@ -1,4 +0,0 @@
-README.md
-lib/**/*.rb
-CHANGELOG.md
-LICENSE.txt

data/.envrc

@@ -1,3 +0,0 @@
-watch_file manifest.scm
-export ELISP2ANY_GUIX_USE_PROFILE_PATH=yes
-use guix

data/.rdoc_options

@@ -1,2 +0,0 @@
-main_page: README.md
-op_dir: html

data/.rubocop.yml

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

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

@@ -1,15 +0,0 @@
-= <%= 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

@@ -1,57 +0,0 @@
-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 # :nodoc:
-    def_delegators :@file, :name, :synopsis, :commentary, :code
-  end
-end

data/lib/elisp2any/code_block.rb

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

data/lib/elisp2any/file.rb

@@ -1,47 +0,0 @@
-require_relative 'node'
-require_relative 'tree_sitter_parser'
-require "elisp2any/header_line"
-require "elisp2any/blanklines"
-require "elisp2any/commentary"
-require "elisp2any/code"
-
-module Elisp2any
-  class File
-    attr_reader :name, # TODO: filename
-                :synopsis, # TODO: header_line, including description
-                :commentary, :code
-
-    def self.scan(scanner)
-      scanner = StringScanner.new(scanner) unless scanner.respond_to?(:skip)
-      line = HeaderLine.scan(scanner) or return
-      Blanklines.scan(scanner) # optional
-      commentary = Commentary.scan(scanner)
-      Blanklines.scan(scanner) # optional
-      code = Code.scan(scanner)
-      new(name: line.filename, synopsis: line.description, commentary:, code:)
-    end
-
-    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/filename.rb

@@ -1,14 +0,0 @@
-module Elisp2any
-  class Filename
-    attr_reader :content
-
-    def self.scan(scanner)
-      content = scanner.scan(/[a-z]+[.]el\b/) or return
-      new(content:)
-    end
-
-    def initialize(content:)
-      @content = content
-    end
-  end
-end

data/lib/elisp2any/header_line_variable_assignment.rb

@@ -1,27 +0,0 @@
-require "elisp2any/variable"
-require "elisp2any/expression"
-
-module Elisp2any
-  class HeaderLineVariableAssignment
-    attr_reader :variable, :expression
-
-    def self.scan(scanner)
-      pos = scanner.pos
-      variable = Variable.scan(scanner) or return
-      unless scanner.skip(/ *: */)
-        scanner.pos = pos
-        return
-      end
-      unless (expression = Expression.scan(scanner))
-        scanner.pos = pos
-        return
-      end
-      new(variable: variable.name, expression: expression.content)
-    end
-
-    def initialize(variable:, expression:)
-      @variable = variable
-      @expression = expression
-    end
-  end
-end

data/lib/elisp2any/header_line_variables.rb

@@ -1,33 +0,0 @@
-require "elisp2any/variable"
-require "elisp2any/expression"
-require "elisp2any/header_line_variable_assignment"
-
-module Elisp2any
-  class HeaderLineVariables
-    attr_reader :variables
-
-    def self.scan(scanner)
-      scanner = StringScanner.new(scanner) unless scanner.respond_to?(:pos)
-      pos = scanner.pos
-      scanner.skip(/ *-[*]- +/) or return
-      variables = {}
-      until scanner.skip(/ +-[*]- */)
-        if scanner.eos?
-          scanner.pos = pos
-          return
-        elsif (assign = HeaderLineVariableAssignment.scan(scanner))
-          variables[assign.variable] = assign.expression
-        elsif scanner.skip(";")
-          break
-        else
-          raise scanner.inspect
-        end
-      end
-      new(variables:)
-    end
-
-    def initialize(variables:)
-      @variables = variables
-    end
-  end
-end

data/lib/elisp2any/node.rb

@@ -1,66 +0,0 @@
-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'
-          scanner.skip(';') or
-            begin
-              (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)
-              next
-            end
-
-          if (level = scanner.skip(/;+/))
-            scanner.skip(' ') or raise Error, 'no space after heading semicolons'
-            nodes << Heading.new(node, level, scanner.rest.chomp)
-            next
-          elsif scanner.skip("\n")
-            next
-          end
-
-          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
-        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/top_heading.rb

@@ -1,21 +0,0 @@
-require "elisp2any/heading"
-
-module Elisp2any
-  class TopHeading
-    attr_reader :content
-
-    def self.scan(scanner)
-      pos = scanner.pos
-      heading = Heading.scan(scanner)
-      unless heading.level.zero?
-        scanner.pos = pos
-        return
-      end
-      new(content: heading.content)
-    end
-
-    def initialize(content:)
-      @content = content
-    end
-  end
-end

data/lib/elisp2any/tree_sitter_parser.rb

@@ -1,36 +0,0 @@
-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']
-        shared_object = ::File.join(ENV["GUIX_ENVIRONMENT"], "lib/tree-sitter", shared_object)
-      end
-
-      shared_object
-    end
-  end
-end

data/lib/elisp2any/variable.rb

@@ -1,14 +0,0 @@
-module Elisp2any
-  class Variable
-    attr_reader :name
-
-    def self.scan(scanner)
-      name = scanner.scan(/[a-z-]+/) or return
-      new(name:)
-    end
-
-    def initialize(name:)
-      @name = name
-    end
-  end
-end

data/manifest.scm

@@ -1,87 +0,0 @@
-(use-modules (guix packages)
-             ((guix licenses) #:prefix license:)
-             (guix git-download)
-             (guix build-system ruby)
-             (guix build-system tree-sitter)
-             (gnu packages tree-sitter)
-             (gnu packages ruby))
-
-(define-public ruby-tree-sitter
-  (let ((commit "2c56b04283f2a8cfed7d6c527ca36b8e1127ee8c")
-        (revision "0"))
-    (package
-     (name "ruby-tree-sitter")
-     (version (git-version "0.20.8.1" revision commit))
-     (source
-      (origin
-       (method git-fetch)
-       (uri (git-reference
-             (url "https://github.com/Faveod/ruby-tree-sitter")
-             (commit commit)))
-       (file-name (git-file-name name version))
-       (sha256
-        (base32 "144kp0ya4rl03bgwpix17bgq2ak2kqk63pwniy6sfxfjqp5yzr7f"))))
-     (build-system ruby-build-system)
-     (arguments
-      (list
-       #:phases #~(modify-phases %standard-phases
-                                 (add-after 'extract-gemspec 'remove-depends
-                                            (lambda _
-                                              (substitute* "tree_sitter.gemspec"
-                                                           ((".*minitest-color.*")
-                                                            "\n")
-                                                           ((".*pry.*")
-                                                            "\n")
-                                                           ((".*rake.*")
-                                                            "\n"))
-                                              (substitute* "test/test_helper.rb"
-                                                           ((".*minitest/color.*")
-                                                            "\n"))))
-                                 (add-before 'build 'compile
-                                             (lambda _
-                                               (invoke "rake" "compile")))
-                                 (add-before 'check 'set-path
-                                             (lambda* (#:key inputs #:allow-other-keys)
-                                               (let ((ruby (assoc-ref inputs "tree-sitter-ruby")))
-                                                 (setenv "TREE_SITTER_PARSERS"
-                                                         (string-append ruby "/lib/tree-sitter")))))
-                                 (add-before 'check 'remove-failing-test
-                                             (lambda _
-                                               (delete-file "test/tree_sitter/node_test.rb"))))))
-     (native-inputs (list ruby-minitest ruby-rake-compiler
-                          ruby-rake-compiler-dock ruby-ruby-memcheck
-                          tree-sitter-ruby))
-     (inputs (list tree-sitter))
-     (synopsis "Ruby bindings for Tree-Sitter")
-     (description "Ruby bindings for Tree-Sitter")
-     (home-page "https://www.github.com/Faveod/ruby-tree-sitter")
-     (license license:expat))))
-
-(define-public tree-sitter-elisp
-  (let ((commit "e5524fdccf8c22fc726474a910e4ade976dfc7bb")
-        (revision "0"))
-    (package
-      (name "tree-sitter-elisp")
-      (version (git-version "0.1.4" revision commit))
-      (source
-       (origin
-         (method git-fetch)
-         (uri (git-reference
-               (url "https://github.com/Wilfred/tree-sitter-elisp")
-               (commit commit)))
-         (file-name (git-file-name name version))
-         (sha256
-          (base32 "1wyzfb27zgpvm4110jgv0sl598mxv5dkrg2cwjw3p9g2bq9mav5d"))))
-      (build-system tree-sitter-build-system)
-      (home-page "https://github.com/Wilfred/tree-sitter-elisp")
-      (synopsis "Tree-sitter grammar for Emacs Lisp")
-      (description "This package provides an Emacs Lisp grammar for the Tree-sitter library.")
-      (license license:expat))))
-
-(concatenate-manifests
- (list
-  (packages->manifest (list ruby-tree-sitter tree-sitter-elisp))
-  (specifications->manifest (list "ruby@3.1"
-                                  "ruby-webrick"
-                                  "ruby-rubocop"
-				                  "ruby-asciidoctor"))))