elisp2any 0.0.5 → 0.0.7

data/README.md

@@ -15,12 +15,24 @@ $ 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 run tests, run `test-unit`.
 
-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).
+Two paragraph types:
+
+```emacs-lisp
+;; This is a major one.
+
+;; This is another major one (1), and a minor one.
+;;
+;; This is still (1) but another minor one.
+```
+
+Heading levels:
+
+```emacs-lisp
+;;; Level 2
+;;;; Level 3
+```
 
 ## Contributing
 
@@ -28,5 +40,17 @@ Bug reports and pull requests are welcome.
 
 ## License
 
-This package is provided under the Apache License.
-See `LICENSE.txt` for details.
+Copyright (C) 2025  gemmaro
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/Rakefile

@@ -1,55 +1,8 @@
 require 'bundler/gem_tasks'
-require 'rake/testtask'
+require "open3"
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.libs << 'lib'
-  t.test_files = FileList['test/**/*_test.rb']
-end
-
-default_tasks = %i[test]
-
-rubocop = true
-
-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|
-  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
+task :deploy do
+  out, _stat = Open3.capture2("./bin/dev")
+  File.write("/tmp/index.html", out)
+  sh "rsync", "-av", "/tmp/index.html", "pi:/srv/www/emacs/"
 end

data/exe/elisp2any

@@ -1,40 +1,50 @@
 #!/usr/bin/env ruby
 
+# Copyright (C) 2025  gemmaro
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
 require 'optparse'
 
 $LOAD_PATH << File.join(__dir__, "../lib")
-require 'elisp2any'
-require 'elisp2any/html_renderer'
+require 'elisp'
 
 input = $stdin
 output = $stdout
 css = nil
-mode = :old
+dump = false
 
 OptionParser.new do |parser|
-  parser.on('--input=PATH') do |path|
+  parser.on('--input=PATH', 'ELisp file (default: stdin)') do |path|
     input = File.open(path)
   end
 
-  parser.on('--output=PATH') do |path|
+  parser.on('--output=PATH', 'HTML file (default: stdout)') do |path|
     output = File.open(path, 'w')
   end
 
-  parser.on('--css=PATH') do |path|
+  parser.on('--css=PATH', 'stylesheet') do |path|
     css = path
   end
 
-  parser.on("--new") do
-    mode = :new
-  end
+  parser.on("--dump") { dump = true }
 end.parse!
 
-file = nil
-case mode
-in :new
-  file = Elisp2any::File.scan(input)
-in :old
-  file = Elisp2any::File.parse(input)
+doc = Elisp.parse(input)
+if dump
+  pp doc
+  exit
 end
-renderer = Elisp2any::HTMLRenderer.new(file, css:, mode:)
-output.write(renderer.render)
+
+doc.write(output, css:)

data/lib/elisp/comment.rb

@@ -0,0 +1,32 @@
+# Copyright (C) 2025  gemmaro
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+class Elisp::Comment
+  def initialize(content)
+    @content = content
+  end
+
+  def <<(content)
+    @content << "\n#{content}"
+  end
+
+  def to_minor_para
+    Elisp::MinorPara.new(@content)
+  end
+
+  def html
+    self.class.parse(@content)
+  end
+end

data/lib/elisp/default.css

@@ -0,0 +1,11 @@
+.description {
+    font-style: italic;
+}
+pre {
+    font-family: serif;
+    white-space: pre-wrap;
+}
+pre[class="code"] {
+    border-left: 2px solid black;
+    padding-left: 0.5rem;
+}

data/lib/elisp/doc_string_parser.rb

@@ -0,0 +1,96 @@
+# Copyright (C) 2025  gemmaro
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require "cgi"
+require "uri"
+require "strscan"
+
+class Elisp::DocStringParser
+  URI_PATTERN = URI.regexp
+  URI_PATTERN_WITH_ANGLES = /[<](?<uri>#{ URI_PATTERN })[>]/
+  EMAIL = Regexp.new(URI::MailTo::EMAIL_REGEXP.to_s
+                       .sub(/\A[(][?]-mix:\\A/, "(?-mix:")
+                       .sub(/\\z[)]\z/, ")"))
+  EMAIL_WITH_ANGLES = /[<](?<address>#{ EMAIL })[>]/
+
+  def initialize(source)
+    @scanner = StringScanner.new(source)
+  end
+
+  def html
+    result = +""
+    normal = +""
+    until @scanner.eos?
+      if @scanner.skip(/[`](?<code>[A-Za-z!.-]+)[']/)
+        result << normal
+        normal.clear
+        code = CGI.escape_html(@scanner[:code])
+        result << "<code>#{code}</code>"
+        normal.clear
+      elsif @scanner.skip(/\\\\=(?<quote>['`])/)
+        normal << @scanner[:quote]
+      elsif (uri = scan_http_uri)
+        result << normal
+        normal.clear
+        result << html_url(uri)
+      elsif (address = scan_email)
+        result << normal
+        normal.clear
+        uri = CGI.escape(address)
+        address = CGI.escape_html(address)
+        result << %(<a href="mailto:#{uri}">#{address}</a>)
+      elsif @scanner.skip(/Copyright [(]C[)]/)
+        result << "Copyright &copy;"
+      else
+        normal << @scanner.getch
+      end
+    end
+    result << normal
+    normal.clear
+    result
+  end
+
+  def scan_email
+    if (address = @scanner.scan(EMAIL))
+      address
+    elsif @scanner.skip(EMAIL_WITH_ANGLES)
+      @scanner[:address]
+    else
+      return
+    end
+  end
+
+  def scan_http_uri
+    if (uri = @scanner.scan(URI_PATTERN))
+    elsif @scanner.skip(URI_PATTERN_WITH_ANGLES)
+      uri = @scanner[:uri]
+    else
+      return
+    end
+    uri = URI(uri)
+    unless uri.is_a?(URI::HTTP)
+      @scanner.unscan
+      return
+    end
+    uri
+  end
+
+  def html_url(url)
+    url = url.to_s
+    ref = CGI.escape(url)
+    label = CGI.escape_html(url)
+    %(<a class="pure-url" href="#{ref}">#{label}</a>)
+  end
+end

data/lib/elisp/heading.rb

@@ -0,0 +1,31 @@
+# Copyright (C) 2025  gemmaro
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require "cgi"
+
+class Elisp::Heading
+  attr_reader :level, :content
+
+  def initialize(content, level: 2)
+    @content = content
+    @level = level
+  end
+
+  def html
+    name = "h#{@level}"
+    content = CGI.escape_html(@content)
+    "<#{name}>#{content}</#{name}>"
+  end
+end

data/lib/elisp/parser.rb

@@ -0,0 +1,161 @@
+# Copyright (C) 2025  gemmaro
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+class Elisp::Parser
+  HEADER_LINE = %r{
+    ;;;[ ]
+    (?<title>[a-z]+[.]el)[ ]---[ ](?<desc>.*?)
+    (?:[ ]+-[*]-[ ]*(?<vars>.*?)[ ]*-[*]-)?
+    \n+
+  }x
+  COMMENT = / *;; (?<comment>.*)\n/
+  CODE = %r{
+    (?<content>
+      (?:
+        [A-Za-z0-9&,.:=?_#'`<>()\[\]\t +*/-]
+        | [?]\\.
+        | "(?:[^\\"]|\\(?:.|\n))*"
+      )+?
+      (?:[ ]*;.*)?
+      | ;;;[#][#][#]autoload.*
+    )
+    \n
+  }x
+  BLANKLINES = /\n+/
+  CODE_OR_BLANKLINES = Regexp.union(CODE, BLANKLINES)
+  
+  css = File.read(File.join(__dir__, "default.css"))
+  DEFAULT_CSS = "<style>#{css}</style>"
+  
+  HEADING = %r{
+    ;;;(?<level>;*)[ ](?<title>.+)\n
+    (?:(?:;;)?\n)*
+  }x
+
+  def initialize(input)
+    @scanner = StringScanner.new(input.read)
+    @state = :start
+    @nodes = []
+  end
+
+  def parse
+    until @scanner.eos?
+
+      if @state == :start && @scanner.skip(HEADER_LINE)
+        @nodes << Elisp::Heading.new(@scanner[:title], level: 1)
+        @nodes << Elisp::Desc.new(@scanner[:desc])
+        @nodes << Elisp::Variables.new(@scanner[:vars])
+        @state = :after_header_line
+
+      elsif [:after_header_line,
+             :after_major_para,
+             :after_minor_para,
+             :after_code,
+             :after_page_delimiter,
+             :after_heading].include?(@state) &&
+            @scanner.skip(HEADING)
+        level = @scanner[:level].size
+        title = @scanner[:title]
+        if level.zero?
+          if ["Commentary:", "Code:"].include?(title)
+            title.chop!
+          elsif title.match?(/[a-z]+[.]el ends here/)
+            next  # validate file name?
+          end
+        end
+        @nodes << Elisp::Heading.new(title, level: level + 2)
+        @state = :after_heading
+
+      elsif [:after_heading,
+             :after_major_para,
+             :after_minor_para,
+             :after_code,
+             :after_header_line].include?(@state) &&
+            @scanner.skip(COMMENT)
+        @nodes << Elisp::Comment.new(@scanner[:comment])
+        @state = :after_comment
+
+      elsif @state == :after_comment && @scanner.skip(";;\n")
+        @nodes[-1] = @nodes.last.to_minor_para
+        @state = :after_minor_para
+
+      elsif @state == :after_comment && @scanner.skip(COMMENT)
+        @nodes.last << @scanner[:comment]
+
+      elsif @state == :after_comment && @scanner.skip(BLANKLINES)
+        make_major_para
+        @state = :after_major_para
+
+      elsif [:after_major_para, :after_page_delimiter, :after_heading].include?(@state) &&
+            @scanner.skip(CODE)
+        @nodes << Elisp::Code.new(@scanner[:content])
+        @state = :after_code
+
+      elsif @state == :after_comment && @scanner.skip(CODE)
+        make_major_para
+        @nodes << Elisp::Code.new(@scanner[:content])
+        @state = :after_code
+
+      elsif @state == :after_code && @scanner.skip(CODE_OR_BLANKLINES)
+        @nodes.last << @scanner[:content]
+
+      elsif @state == :after_code && @scanner.skip(/\f\n+/)
+        @nodes << Elisp::PageDelimiter.new
+        @state = :after_page_delimiter
+
+      else
+        raise Elisp::Error, <<~MESSAGE
+          parse failed
+          --- rest line (#{@state}) ---
+          #{@scanner.rest.lines.first.inspect}
+          --- scanner ---
+          #{@scanner.inspect}
+        MESSAGE
+      end
+    end
+    self
+  end
+
+  def make_major_para
+    paras = [@nodes.pop.to_minor_para]
+    while (node = @nodes.pop)
+      if node.is_a?(Elisp::MinorPara)
+        paras.unshift(node)
+      else
+        @nodes.push(node)
+        break
+      end
+    end
+    @nodes << Elisp::MajorPara.new(paras)
+  end
+
+  def write(output, css: nil)
+    css = css ? %(<link rel="stylesheet" href="#{CGI.escape(css)}">) : DEFAULT_CSS
+    body = @nodes.map(&:html).join("\n")
+    output.write(<<~END_HTML)
+      <!doctype html>
+      <html>
+        <head>
+          #{css}
+          <meta charset="utf8">
+          <meta name="viewport" content="width=device-width, initial-scale=1">
+        </head>
+        <body>
+          <main>#{body}</main>
+        </body>
+      </html>
+    END_HTML
+  end
+end

data/lib/elisp/version.rb

@@ -0,0 +1,18 @@
+# Copyright (C) 2025  gemmaro
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+class Elisp
+  VERSION = "0.0.7"
+end

data/lib/elisp.rb

@@ -0,0 +1,99 @@
+# Copyright (C) 2025  gemmaro
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require "strscan"
+require "cgi"
+require "uri"
+
+class Elisp
+  Error = Class.new(StandardError)
+
+  def self.parse(input)
+    Elisp::Parser.new(input).parse
+  end
+end
+
+class Elisp::PageDelimiter
+  def html = "<hr>"
+end
+
+class Elisp::Desc
+  def initialize(content)
+    @content = content
+  end
+
+  def html
+    content = CGI.escape_html(@content)
+    %(<p class="description">#{content}</p>)
+  end
+end
+
+class Elisp::Variables
+  def initialize(content)
+    @content = content
+  end
+
+  def html
+    content = CGI.escape_html(@content)
+    <<~END_HTML
+      <article>
+        Header line variables:
+        <pre class="code"><code>#{content}</code></pre>
+      </article>
+    END_HTML
+  end
+end
+
+class Elisp::MajorPara
+  def initialize(paras)
+    @paras = paras
+  end
+
+  def html
+    paras = @paras.map(&:html).join("\n")
+    "<article>#{paras}</article>"
+  end
+end
+
+class Elisp::MinorPara
+  def initialize(content)
+    @content = content
+  end
+
+  def html
+    content = Elisp::DocStringParser.new(@content).html
+    "<pre>#{content}</pre>"
+  end
+end
+
+class Elisp::Code
+  def initialize(content)
+    @content = content
+  end
+
+  def <<(content)
+    @content << "\n#{content}"
+  end
+
+  def html
+    content = CGI.escape_html(@content)
+    %(<pre class="code"><code>#{content}</code></pre>)
+  end
+end
+
+require_relative "elisp/comment"
+require_relative "elisp/parser"
+require_relative "elisp/heading"
+require_relative "elisp/doc_string_parser"