elisp2any 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfaef7d1de4a445f1055d3093dd6afb0b3f87db67dff17b4a3bf17e451e042c6
-  data.tar.gz: 3746dd755e216ffda34d037bb3c1070dadb1b8b485426a25c59555d284e7f55a
+  metadata.gz: 03c6ff5df7f72271d8142db9389a003ca5b322de13de72f1d9eacf917545972d
+  data.tar.gz: f46bb2e1926e017be9488f94ddc447c47f6eeebfd9060bc360a124d29555a373
 SHA512:
-  metadata.gz: 13d87c5c455d13766deea274183b1a3f32e4165c0f7edbb68e680f977e1c8987eec0808bff8a1285ed9a617d0796e9fdee43784f8955e681feffc41fd0be06d6
-  data.tar.gz: 97d5d3ca8dfe1f14a26c21bb5d4062a789ac77e2a05ddeb568a624f2ff16dc3cc2e83415d979e612d504aa883af50cd44275289e633521622049188d8db37bd5
+  metadata.gz: eb50642a370b0736b37fae9892833e27d5c7b11088e97f5f906b5f265502d94b859b3e8df59f804daab5f45290ea6f165f5caa1433f121f12783de16d0f49999
+  data.tar.gz: dc5cf591eb9661fb8da170e5ff7359dcc6965fe7cda678c31f4b4f4518e6a16183d5c8daf372529e883a62fdccefb88736ac1638a18b7bf9e0279919795f30b7

data/.document

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

data/.rdoc_options

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

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3.1
   NewCops: enable
   DisabledByDefault: true
 

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 # Change log of Elisp2any
 
-## Unreleased
+## 0.0.5 - 2025-02-10
+
+* Upgrade required Ruby version to 3.1 or later.
+* Add `--new` flag to the `elisp2any` command.  It uses new scanner (parser)
+  written in pure Ruby with strscan gem.  The older ones which uses
+  Tree-sitter as parser is deprecated and will be removed from the next
+  version.
+
+## 0.0.4 - 2025-02-08
+
+* Improved shared object searching for Guix.
 
 ## 0.0.3 - 2024-11-16
 

data/Rakefile

@@ -7,11 +7,22 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList['test/**/*_test.rb']
 end
 
-require 'rubocop/rake_task'
+default_tasks = %i[test]
 
-RuboCop::RakeTask.new
+rubocop = true
 
-task default: %i[test rubocop]
+begin
+  require 'rubocop/rake_task'
+rescue LoadError
+  rubocop = false
+end
+
+if rubocop
+  RuboCop::RakeTask.new
+  default_tasks << :rubocop
+end
+
+task default: default_tasks
 
 require 'rdoc/task'
 RDoc::Task.new do |rdoc|

data/exe/elisp2any

@@ -1,12 +1,15 @@
 #!/usr/bin/env ruby
 
-require_relative '../lib/elisp2any'
-require_relative '../lib/elisp2any/html_renderer'
 require 'optparse'
 
+$LOAD_PATH << File.join(__dir__, "../lib")
+require 'elisp2any'
+require 'elisp2any/html_renderer'
+
 input = $stdin
 output = $stdout
 css = nil
+mode = :old
 
 OptionParser.new do |parser|
   parser.on('--input=PATH') do |path|
@@ -20,8 +23,18 @@ OptionParser.new do |parser|
   parser.on('--css=PATH') do |path|
     css = path
   end
+
+  parser.on("--new") do
+    mode = :new
+  end
 end.parse!
 
-file = Elisp2any::File.parse(input)
-renderer = Elisp2any::HTMLRenderer.new(file, css:)
+file = nil
+case mode
+in :new
+  file = Elisp2any::File.scan(input)
+in :old
+  file = Elisp2any::File.parse(input)
+end
+renderer = Elisp2any::HTMLRenderer.new(file, css:, mode:)
 output.write(renderer.render)

data/fixtures/init.el

@@ -1,4 +1,4 @@
-;;; init.el --- Emacs configuration
+;;; init.el --- Emacs configuration  -*- lexical-binding: t; -*-
 
 ;;; Commentary:
 

data/lib/elisp2any/asciidoc_renderer.rb

@@ -51,7 +51,7 @@ module Elisp2any
       ERB.new(source).result(binding)
     end
 
-    extend Forwardable
+    extend Forwardable # :nodoc:
     def_delegators :@file, :name, :synopsis, :commentary, :code
   end
 end

data/lib/elisp2any/aside.rb

@@ -0,0 +1,23 @@
+require "elisp2any/comment"
+
+module Elisp2any
+  class Aside
+    def self.scan(scanner)
+      pos = scanner.pos
+      com = Comment.scan(scanner) or return
+      unless com.colons == 1
+        scanner.pos = pos
+        return
+      end
+      new(com.content)
+    end
+
+    def source
+      ";#{@content}\n"
+    end
+
+    def initialize(content)
+      @content = content
+    end
+  end
+end

data/lib/elisp2any/blanklines.rb

@@ -0,0 +1,20 @@
+require "forwardable"
+
+module Elisp2any
+  class Blanklines
+    def self.scan(scanner)
+      scanner = StringScanner.new(scanner) unless scanner.respond_to?(:skip)
+      count = 0
+      count += 1 while !scanner.eos? && scanner.skip(/ *\n/)
+      count.zero? and return
+      new(count)
+    end
+
+    def initialize(count) # :nodoc:
+      @count = count
+    end
+
+    extend Forwardable # :nodoc:
+    def_delegator :@count, :to_i
+  end
+end

data/lib/elisp2any/code.rb

@@ -0,0 +1,49 @@
+require "forwardable"
+require "elisp2any/paragraph"
+require "elisp2any/blanklines"
+require "elisp2any/section"
+
+module Elisp2any
+  class Code
+    def self.scan(scanner)
+      pos = scanner.pos
+      heading = Elisp2any.scan_top_heading(scanner) or return
+      unless heading == "Code:"
+        scanner.pos = pos
+        return
+      end
+      Blanklines.scan(scanner) # optional
+      paragraphs = []
+      while (par = Paragraph.scan(scanner))
+        paragraphs << par
+        Blanklines.scan(scanner) # optional
+      end
+      blocks = [paragraphs]
+      pos = scanner.pos
+      while (section = Section.scan(scanner))
+        if section.heading.level == 1
+          blocks << section
+          pos = scanner.pos
+        else
+          scanner.pos = pos
+          break
+        end
+      end
+      new(blocks)
+    end
+
+    def initialize(blocks)
+      @blocks = blocks
+    end
+
+    def sections
+      @blocks.drop(1)
+    end
+
+    extend Forwardable # :nodoc:
+    def_delegator :@blocks, :first, :paragraphs
+    def_delegator :@blocks, :each
+
+    include Enumerable
+  end
+end

data/lib/elisp2any/codeblock.rb

@@ -0,0 +1,56 @@
+require "forwardable"
+require "elisp2any/expression"
+require "elisp2any/blanklines"
+require "elisp2any/aside"
+
+module Elisp2any
+  class Codeblock # :nodoc:
+    def self.scan(scanner)
+      scanner = StringScanner.new(scanner) unless scanner.respond_to?(:skip)
+      expressions = []
+      while (exp = Expression.scan(scanner) ||
+                   scanner.scan(/[ \n]+/) ||
+                   Aside.scan(scanner))
+        expressions << exp
+      end
+      expressions.empty? and return
+      Blanklines.scan(scanner) # optional
+      new(:TODO, expressions:)
+    end
+
+    def source
+      @expressions.sum(+"") do |exp|
+        case exp
+        in String
+          exp
+        else
+          exp.source
+        end
+      end
+    end
+
+    # TODO: delete node
+    # TODO: Remove default empty array
+    def initialize(node, expressions: []) # :nodoc:
+      @node = node
+      @expressions = expressions
+    end
+
+    def append(source, end_byte) # :nodoc:
+      @node.append(source, end_byte)
+    end
+
+    def content
+      if @node.respond_to?(:content)
+        @node.content
+      else
+        @expressions
+      end
+    end
+
+    extend Forwardable # :nodoc:
+    def_delegator :@expressions, :each
+
+    include Enumerable
+  end
+end

data/lib/elisp2any/comment.rb

@@ -0,0 +1,19 @@
+module Elisp2any
+  class Comment
+    attr_reader :colons, :content, :padding
+
+    def self.scan(scanner)
+      scanner = StringScanner.new(scanner) unless scanner.respond_to?(:skip)
+      scanner.skip(/(?<colons>;+)(?<padding> *)(?<content>.*)\n?/) or return
+      new(colons: scanner[:colons].size,
+          content: scanner[:content],
+          padding: scanner[:padding])
+    end
+
+    def initialize(colons:, content:, padding:)
+      @colons = colons
+      @content = content
+      @padding = padding
+    end
+  end
+end

data/lib/elisp2any/commentary.rb

@@ -0,0 +1,32 @@
+require "forwardable"
+require "elisp2any/paragraph"
+require "elisp2any/blanklines"
+
+module Elisp2any
+  class Commentary
+    def self.scan(scanner)
+      pos = scanner.pos
+      heading = Elisp2any.scan_top_heading(scanner) or return
+      unless heading == "Commentary:"
+        scanner.pos = pos
+        return
+      end
+      Blanklines.scan(scanner) # optional
+      paragraphs = []
+      while (par = Paragraph.scan(scanner))
+        paragraphs << par
+        Blanklines.scan(scanner) # optional
+      end
+      new(paragraphs)
+    end
+
+    def initialize(paragraphs)
+      @paragraphs = paragraphs
+    end
+
+    extend Forwardable # :nodoc:
+    def_delegators :@paragraphs, :each, :size
+
+    include Enumerable
+  end
+end

data/lib/elisp2any/expression.rb

@@ -0,0 +1,90 @@
+require "strscan"
+
+module Elisp2any
+  class Expression
+    def self.scan(scanner)
+      scanner = StringScanner.new(scanner) unless scanner.respond_to?(:skip)
+      if scanner.skip("(")
+        exps = []
+        while (exp = scan(scanner))
+          exps << exp
+          spaces = scanner.scan(/[ \n]+/)
+          exps << spaces if spaces
+        end
+        scanner.skip(")") or raise Error, scanner.inspect
+        new(exps)
+      elsif scanner.skip("'")
+        exp = scan(scanner) or raise Error, scanner.inspect
+        new({ quoted: exp })
+      elsif scanner.skip("\"")
+        content = +""
+        while !scanner.eos? && !scanner.match?("\\") && !scanner.match?('"')
+          content << scanner.getch
+        end
+        scanner.skip('"') or raise Error, scanner.inspect
+        new(content)
+      elsif scanner.skip("#'")
+        exp = scan(scanner) or raise Error, scanner.inspect
+        new({ function: exp })
+      else
+        name = scanner.scan(/[a-z0-9_?.:-]+/) or return
+        new(name.to_sym)
+      end
+    end
+
+    def source
+      case @content
+      in { quoted: }
+        "'#{self.class.source(quoted)}"
+      in String
+        @content
+      in { function: }
+        "#'#{self.class.source(function)}"
+      in Array
+        result = +"("
+        @content.each { |exp| result << self.class.source(exp) }
+        "#{result})"
+      in Symbol
+        @content.to_s
+      end
+    end
+
+    def self.source(arg)
+      case arg
+      in Symbol
+        arg.to_s
+      in Array
+        result = +"("
+        arg.sum { |ele| result << source(ele) }
+        "#{result})"
+      in Expression
+        arg.source
+      in String
+        arg
+      else
+        raise arg.inspect
+      end
+    end
+
+    def deconstruct_keys(*keys)
+      result = {}
+      keys => [keys]
+      keys.each do |key|
+        case key
+        in :content
+          result[:content] = @content
+        else # nop
+        end
+      end
+      result
+    end
+
+    def deconstruct
+      [*@content]
+    end
+
+    def initialize(content)
+      @content = content
+    end
+  end
+end

data/lib/elisp2any/file.rb

@@ -1,9 +1,35 @@
 require_relative 'node'
 require_relative 'tree_sitter_parser'
+require "elisp2any/header_line"
+require "elisp2any/blanklines"
+require "elisp2any/commentary"
+require "elisp2any/code"
+require "elisp2any/footer_line"
 
 module Elisp2any
   class File
-    attr_reader :name, :synopsis, :commentary, :code
+    attr_reader :name, # TODO: filename
+                :synopsis, # TODO: header_line, including description
+                :commentary, :code, :header_line
+
+    def self.scan(scanner)
+      scanner = scanner.read if scanner.respond_to?(:read)
+      scanner = StringScanner.new(scanner) unless scanner.respond_to?(:skip)
+      line = HeaderLine.scan(scanner) or return # TODO: header line
+      Blanklines.scan(scanner) # optional
+      commentary = Commentary.scan(scanner)
+      Blanklines.scan(scanner) # optional
+      code = Code.scan(scanner)
+      footer_line = FooterLine.scan(scanner)
+      footer_line == line.filename or raise Error, "header and footer filename is not same: #{line.filename} and #{footer_line.filename}"
+      Blanklines.scan(scanner) # optional
+      scanner.eos? or raise Error, "extra content after footer line"
+      new(name: line.filename,
+          synopsis: line.description,
+          commentary:,
+          code:,
+          header_line: line)
+    end
 
     def self.parse(source)
       source = source.respond_to?(:read) ? source.read : source
@@ -21,11 +47,17 @@ module Elisp2any
       new(name: name, synopsis: synopsis, commentary: commentary, code: code)
     end
 
-    def initialize(name:, synopsis:, commentary:, code:) # :nodoc:
+    # TODO: Remove nil default from footer line
+    def initialize(name:,
+                   synopsis:,
+                   commentary:,
+                   code:,
+                   header_line: nil) # :nodoc:
       @name = name
       @synopsis = synopsis
       @commentary = commentary
       @code = code
+      @header_line = header_line
     end
   end
 end

data/lib/elisp2any/footer_line.rb

@@ -0,0 +1,28 @@
+require "forwardable"
+
+module Elisp2any
+  class FooterLine
+    def self.scan(scanner)
+      scanner = StringScanner.new(scanner) unless scanner.respond_to?(:pos)
+      pos = scanner.pos
+      heading = Elisp2any.scan_top_heading(scanner) or return
+      cscanner = StringScanner.new(heading)
+      unless (filename = Elisp2any.scan_filename(cscanner))
+        scanner.pos = pos
+        return
+      end
+      unless cscanner.skip(/ ends here\n?/)
+        scanner.pos = pos
+        return
+      end
+      new(filename)
+    end
+
+    def initialize(filename)
+      @filename = filename
+    end
+
+    extend Forwardable # :nodoc:
+    def_delegator :@filename, :==
+  end
+end

data/lib/elisp2any/header_line.rb

@@ -0,0 +1,80 @@
+require "elisp2any/comment"
+require "elisp2any/expression"
+
+module Elisp2any
+  class HeaderLine
+    attr_reader :filename, :description, :variables
+
+    def self.scan(scanner)
+      scanner = StringScanner.new(scanner) unless scanner.respond_to?(:pos)
+      pos = scanner.pos
+      unless (heading = Elisp2any.scan_top_heading(scanner))
+        scanner.pos = pos
+        return
+      end
+      cscanner = StringScanner.new(heading)
+      unless (filename = Elisp2any.scan_filename(cscanner))
+        scanner.pos = pos
+        return
+      end
+      unless cscanner.skip(/ +--- +/)
+        scanner.pos = pos
+        return
+      end
+      description = +""
+      variables = nil
+      until cscanner.eos?
+        if (variables = scan_variables(cscanner)) # nop
+          break
+        else
+          description << cscanner.getch
+        end
+      end
+      if description.empty?
+        scanner.pos = pos
+        return
+      end
+      new(filename:, description:, variables:)
+    end
+
+    def self.scan_variables(scanner)
+      scanner = StringScanner.new(scanner) unless scanner.respond_to?(:pos)
+      scanner.skip(/ *-[*]- +/) or return
+      variables = {}
+      until scanner.skip(/ +-[*]- */)
+        if scanner.eos?
+          raise Error, "unexpected end"
+        elsif (assign = scan_assignments(scanner))
+          variables[assign[:variable]] = assign[:expression]
+        elsif scanner.skip(";")
+          break
+        else
+          raise Error, scanner.inspect
+        end
+      end
+      variables
+    end
+    private_class_method :scan_variables
+
+    def self.scan_assignments(scanner)
+      pos = scanner.pos
+      variable = Elisp2any.scan_variable(scanner) or return
+      unless scanner.skip(/ *: */)
+        scanner.pos = pos
+        return
+      end
+      unless (expression = Expression.scan(scanner))
+        scanner.pos = pos
+        return
+      end
+      { variable:, expression: }
+    end
+    private_class_method :scan_assignments
+
+    def initialize(filename:, description:, variables:)
+      @filename = filename
+      @description = description
+      @variables = variables
+    end
+  end
+end

data/lib/elisp2any/heading.rb

@@ -3,8 +3,36 @@ require 'forwardable'
 
 module Elisp2any
   class Heading
-    attr_reader :level, :content
+    attr_reader :level
+    attr_accessor :content
 
+    def self.scan(scanner)
+      pos = scanner.pos
+      comment = Comment.scan(scanner) or return
+      unless comment.colons >= 3
+        scanner.pos = pos
+        return
+      end
+      new(:TODO, comment.colons - 3,
+          comment.content # do not scan as text at this point
+         )
+    end
+
+    def deconstruct_keys(*keys)
+      result = {}
+      keys => [keys]
+      keys.each do |key|
+        case key
+        in :level
+          result[:level] = @level
+        in :content
+          result[:content] = @content
+        end
+      end
+      result
+    end
+
+    # TODO: delete node.  Use kwargs.
     def initialize(node, level, content) # :nodoc:
       @node = node
       @level = level
@@ -34,7 +62,7 @@ module Elisp2any
       @content.match(/\A(?<name>.+?)\.el ends here\Z/)[:name]
     end
 
-    extend Forwardable
+    extend Forwardable # :nodoc:
     def_delegator :@level, :<=>
   end
 end

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

@@ -1,23 +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="<%= @css %>">
+	    <meta charset="UTF-8">
+	    <meta name="viewport" content="width=device-width, initial-scale=1">
+	    <title><%= name %></title>
+	    <link rel="stylesheet" href="<%= @css %>">
     </head>
     <body>
-	<main>
-	    <h1><%= name %></h1>
-	    <p><%= synopsis %></p>
-	    <h2>Commentary</h2>
-	    <% commentary.each do |paragraph| %>
-		<p><%= render_paragraph(paragraph) %></p>
-	    <% end %>
-	    <h2>Code</h2>
-	    <% code.each do |block| %>
-		<%= render_block(block, level: 2) %>
-	    <% end %>
-	</main>
+	    <main>
+	        <h1><%= name %></h1>
+	        <p><%= synopsis %></p>
+	        <h2>Commentary</h2>
+	        <% 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.erb

@@ -0,0 +1,22 @@
+<!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="<%= @css %>">
+    </head>
+    <body>
+	    <main>
+	        <h1><%= name %><small> &mdash; <%= synopsis %></small></h1>
+            <div style="text-align:right"><%= render(header_line.variables) %></div>
+	        <% commentary.each do |paragraph| %>
+		        <%= render(paragraph) %>
+	        <% end %>
+	        <h2>Code</h2>
+	        <% self.code.each do |block| %>
+		        <%= render(block) %>
+	        <% end %>
+	    </main>
+    </body>
+</html>

data/lib/elisp2any/html_renderer.rb

@@ -4,17 +4,66 @@ require 'cgi/util'
 require_relative 'inline_code'
 require_relative 'heading'
 require_relative 'paragraph'
-require_relative 'code_block'
+require_relative 'codeblock'
 
 module Elisp2any
   class HTMLRenderer
-    def initialize(file, css: nil)
+    def initialize(file, css: nil, mode:)
       @file = file
       @css = css || "https://unpkg.com/mvp.css"
+      @mode = mode
     end
 
-    def render
-      erb_render('index.html.erb')
+    # Write gradually?
+    def render(node = nil)
+      if node
+        case node
+        in Paragraph
+          par = node.sum(+"") { |line| render(line) }
+          "<p>#{par}</p>"
+        in Line
+          begin
+            node.sum(+"") { |chunk| render(chunk) }
+          rescue => e
+            warn node.inspect
+            raise e
+          end
+        in String
+          h(node)
+        in [] # huh?  nop.
+        in Section
+          result = render(node.heading)
+          node.blocks.each { |blo| result << render(blo) }
+          node.sections.each { |sec| result << render(sec) }
+          result
+        in Heading[level:, content:]
+          lev = level + 2
+          "<h#{lev}>#{render(content)}</h#{lev}>"
+        in Codeblock
+          "<pre><code>#{h(node.source.chomp)}</code></pre>"
+        in { code: }
+          "<code>#{h(code)}</code>"
+        in Hash
+          result = node.sum(+"<dl>") do |key, value|
+            "<dt>#{render(key)}</dt><dd>#{render(value)}</dd>"
+          end
+          "#{result}</dl>"
+        in Expression
+          "<code>#{h(node.source)}</code>"
+        in Text
+          node.sum(+"") { |ele| render(ele) }
+        else
+          raise Error, node.inspect
+        end
+      else
+        case @mode
+        in :old
+          erb_render('index.html.erb')
+        in :new
+          source = ::File.read(::File.join(__dir__, 'html_renderer.erb'))
+          ERB.new(source).result(binding)
+        end
+      end
     end
 
     private
@@ -24,26 +73,48 @@ module Elisp2any
       paragraph.each do |line|
         line.each do |chunk|
           case chunk
-          when InlineCode
+          in InlineCode
             html << "<code>#{h(chunk.content)}</code>"
-          when String
+          in String
             html << h(chunk)
+          in { code: }
+            html << "<code>#{h(code)}</code>"
+          else
+            raise Error, chunk.inspect
           end
         end
       end
       html
     end
 
-    def render_block(block, level:)
+    # TODO: remove level
+    def render_block(block, level: nil)
       html = ''
       case block
       when Heading
-        name = "h#{level + block.level - 1}"
+        lev = level
+        if level
+          lev = level + block.level - 1
+        else
+          lev = block.level
+        end
+        name = "h#{lev}"
         html << "<#{name}>#{h(block.content)}</#{name}>"
       when Paragraph
         html << render_paragraph(block)
-      when CodeBlock
+      when Codeblock
         html << "<pre><code>#{h(block.content)}</code></pre>"
+      when [] # huh?  nop
+      when Section
+        render_block(block.heading)
+        block.blocks.each do |blo|
+          render_block(blo)
+        end
+        block.sections.each do |sec|
+          render_block(sec)
+        end
+      else
+        raise Error, block.inspect
       end
       html
     end
@@ -53,11 +124,26 @@ module Elisp2any
       ERB.new(source).result(binding)
     end
 
-    def h(string)
-      CGI.escape_html(string)
+    def h(arg)
+      case arg
+      in String
+        CGI.escape_html(arg)
+      in Array
+        arg.map do |ele|
+          h(ele)
+        end.join
+      in Symbol
+        h(arg.to_s)
+      in Expression
+        h(arg.source)
+      in Integer
+        h(arg.to_s)
+      in Aside
+        h(arg.content)
+      end
     end
 
-    extend Forwardable
-    def_delegators :@file, :name, :synopsis, :commentary, :code
+    extend Forwardable # :nodoc:
+    def_delegators :@file, :name, :synopsis, :commentary, :code, :header_line
   end
 end

data/lib/elisp2any/inline_code.rb

@@ -1,4 +1,5 @@
 module Elisp2any
+  # TODO: delete
   class InlineCode
     attr_reader :content
 

data/lib/elisp2any/line.rb

@@ -1,9 +1,25 @@
 require 'strscan'
 require 'forwardable'
 require_relative 'inline_code'
+require "elisp2any/comment"
+require "elisp2any/text"
 
 module Elisp2any
   class Line
+    def self.scan(scanner)
+      pos = scanner.pos
+      comment = Comment.scan(scanner) or return
+      unless comment.colons == 2
+        scanner.pos = pos
+        return
+      end
+      unless comment.padding[0] == " "
+        raise Error, "line comment should have a whitespace padding"
+      end
+      content = "#{comment.padding[1..]}#{comment.content}"
+      new(Text.scan(content).to_a)
+    end
+
     def initialize(chunks) # :nodoc:
       @chunks = chunks
     end
@@ -28,8 +44,8 @@ module Elisp2any
       new(chunks)
     end
 
-    extend Forwardable
-    def_delegators :@chunks, :each
+    extend Forwardable # :nodoc:
+    def_delegators :@chunks, :each, :deconstruct
 
     include Enumerable
   end

data/lib/elisp2any/node.rb

@@ -1,10 +1,11 @@
-require_relative 'code_block'
+require_relative 'codeblock'
 require_relative 'line'
 require_relative 'heading'
 require_relative 'paragraph'
 require 'strscan'
 
 module Elisp2any
+  # TODO: delete
   class Node
     attr_reader :range # :nodoc:
     attr_reader :content
@@ -21,7 +22,7 @@ module Elisp2any
           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 = 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
@@ -43,10 +44,10 @@ module Elisp2any
             nodes << paragraph
           end
         else
-          if (last_node = nodes.last) && last_node.is_a?(CodeBlock)
+          if (last_node = nodes.last) && last_node.is_a?(Codeblock)
             last_node.append(source, range.end)
           else
-            nodes << CodeBlock.new(node)
+            nodes << Codeblock.new(node)
           end
         end
       end

data/lib/elisp2any/paragraph.rb

@@ -1,21 +1,35 @@
 require 'forwardable'
+require "elisp2any/line"
 
 module Elisp2any
   class Paragraph
+    def self.scan(scanner)
+      scanner = StringScanner.new(scanner) unless scanner.respond_to?(:skip)
+      lines = []
+      while (line = Line.scan(scanner))
+        lines << line
+      end
+      lines.empty? and return
+      new(:TODO, lines, :TODO)
+    end
+
+    # TODO: delete
     attr_reader :end_row # :nodoc:
 
+    # TODO: delete node and end_row
     def initialize(node, lines, end_row) # :nodoc:
       @node = node
       @lines = lines
       @end_row = end_row
     end
 
+    # TODO: delete
     def code?
       false
     end
 
-    extend Forwardable
-    def_delegators :@lines, :empty?, :clear, :<<, :each
+    extend Forwardable # :nodoc:
+    def_delegators :@lines, :empty?, :clear, :<<, :each, :deconstruct, :size
     def_delegators :@node, :adjucent?
 
     include Enumerable

data/lib/elisp2any/section.rb

@@ -0,0 +1,49 @@
+require "forwardable"
+require "elisp2any/heading"
+require "elisp2any/blanklines"
+require "elisp2any/text"
+
+module Elisp2any
+  class Section
+    attr_reader :heading,
+                # TODO: gather blocks and sections
+                :blocks,
+                :sections
+
+    def self.scan(scanner)
+      heading = Heading.scan(scanner) or return
+      heading.content = Text.scan(heading.content)
+      Blanklines.scan(scanner) # optional
+      blocks = []
+      while (blo = Paragraph.scan(scanner) || Codeblock.scan(scanner))
+        blocks << blo
+        Blanklines.scan(scanner) # optional
+      end
+      pos = scanner.pos
+      sections = []
+      while (section = scan(scanner))
+        if section.level == heading.level + 1
+          sections << section
+          pos = scanner.pos
+        elsif section.level >= heading.level + 2
+          raise Error, "too demoted heading"
+        else
+          scanner.pos = pos
+          break
+        end
+      end
+      new(heading:, blocks:, sections:)
+    end
+
+    def initialize(heading:, blocks:, sections:)
+      @heading = heading
+      @blocks = blocks
+      @sections = sections
+    end
+
+    alias paragraphs blocks # TODO: delete
+
+    extend Forwardable # :nodoc:
+    def_delegator :@heading, :level
+  end
+end

data/lib/elisp2any/text.rb

@@ -0,0 +1,33 @@
+require "forwardable"
+
+module Elisp2any
+  class Text
+    def self.scan(scanner)
+      scanner = StringScanner.new(scanner) unless scanner.respond_to?(:skip)
+      tokens = []
+      until scanner.eos?
+        if scanner.skip(/`(?<content>[^']+)'/)
+          tokens << { code: scanner[:content] }
+        else
+          char = scanner.getch
+          case tokens
+          in [*, String => last]
+            last << char
+          else
+            tokens << char
+          end
+        end
+      end
+      new(tokens)
+    end
+
+    def initialize(tokens)
+      @tokens = tokens
+    end
+
+    extend Forwardable # :nodoc:
+    def_delegators :@tokens, :each, :deconstruct
+
+    include Enumerable
+  end
+end

data/lib/elisp2any/tree_sitter_parser.rb

@@ -27,8 +27,7 @@ module Elisp2any
 
       # 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)
+        shared_object = ::File.join(ENV["GUIX_ENVIRONMENT"], "lib/tree-sitter", shared_object)
       end
 
       shared_object

data/lib/elisp2any/version.rb

@@ -1,3 +1,4 @@
 module Elisp2any
-  VERSION = '0.0.3'
+  # Version of this library.
+  VERSION = '0.0.5'
 end

data/lib/elisp2any.rb

@@ -1,6 +1,27 @@
 require_relative 'elisp2any/version'
 require_relative 'elisp2any/file'
+require_relative 'elisp2any/heading'
 
 module Elisp2any
-  class Error < StandardError; end
+  autoload :HeaderLine, "elisp2any/header_line.rb"
+  autoload :Blanklines, "elisp2any/blanklines.rb"
+  Error = Class.new(StandardError)
+
+  def self.scan_filename(scanner) # :nodoc:
+    scanner.scan(/[a-z]+[.]el\b/)
+  end
+
+  def self.scan_variable(scanner) # :nodoc:
+    scanner.scan(/[a-z-]+\b/)
+  end
+
+  def self.scan_top_heading(scanner) # :nodoc:
+    pos = scanner.pos
+    heading = Heading.scan(scanner) or return
+    unless heading.level.zero?
+      scanner.pos = pos
+      return
+    end
+    heading.content
+  end
 end

data/manifest.scm

@@ -1,6 +1,87 @@
-(specifications->manifest (list "ruby@3.1"
-                                "ruby-tree-sitter"
-                                "tree-sitter-elisp"
-                                "ruby-webrick"
-                                "ruby-rubocop"
-				                "ruby-asciidoctor"))
+(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"))))

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elisp2any
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - gemmaro
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-16 00:00:00.000000000 Z
+date: 2025-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby_tree_sitter
@@ -103,7 +103,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".document"
 - ".envrc"
+- ".rdoc_options"
 - ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
@@ -115,22 +117,34 @@ files:
 - lib/elisp2any.rb
 - lib/elisp2any/asciidoc_renderer.rb
 - lib/elisp2any/asciidoc_renderer/index.adoc.erb
-- lib/elisp2any/code_block.rb
+- lib/elisp2any/aside.rb
+- lib/elisp2any/blanklines.rb
+- lib/elisp2any/code.rb
+- lib/elisp2any/codeblock.rb
+- lib/elisp2any/comment.rb
+- lib/elisp2any/commentary.rb
+- lib/elisp2any/expression.rb
 - lib/elisp2any/file.rb
+- lib/elisp2any/footer_line.rb
+- lib/elisp2any/header_line.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/text.rb
 - lib/elisp2any/tree_sitter_parser.rb
 - lib/elisp2any/version.rb
 - manifest.scm
 - sig/elisp2any.gen.rbs
 - sig/elisp2any.rbs
 homepage: https://codeberg.org/gemmaro/elisp2any
-licenses: []
+licenses:
+- Apache-2.0
 metadata:
   rubygems_mfa_required: 'true'
   bug_tracker_uri: https://codeberg.org/gemmaro/elisp2any/issues
@@ -147,14 +161,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.5.11
 signing_key:
 specification_version: 4
 summary: Converter from Emacs Lisp to some document markup

data/lib/elisp2any/code_block.rb

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