elisp2any 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88e1120d995f02da6d5637763a9c2ddfa5bb5977b6abdab9b49fd03b69914bac
-  data.tar.gz: 9de0696b8af77040f5dd0655b5f5fc9c9a8d069b8329c2877961e1e43a7011a6
+  metadata.gz: 5bf30639582d2ecf42060b4db852d32438545e209b2c2eeac8b23ded371a4d50
+  data.tar.gz: 0ae7c862c01e4e5cdb0995d2ce31d6fe8b0df253f3e29ffd58fd5bfed580edbb
 SHA512:
-  metadata.gz: cb7a79d6801f2c0b21a61a98fbdf8e965a423ba67e7988f598d9ab6d9f9e390cb361028e7ced4f2fce501234308aa0d0d43adc283dde1499765b6e12254fab8d
-  data.tar.gz: c955943ac810407fedededfa1ef075108ac54b66b4f7ed6ed07518337f8903f79c92a3e39c177c29d3378c91181cd12e8ad3c6fc13fb03fd272a44345447e629
+  metadata.gz: 747da66f11028d3da70cc731b5bf60e3ed44a261c19359022a33d3a151611e14df560dae64ec650ecb4cb8e8bc9509164e76f72586a7454d44ddf76805d8c856
+  data.tar.gz: 63928b7c7b20e1e045159f3457b309e47c9be922c63ce3fda708ac1be98b46c66000052cc7849d157ddce7d8dd1127dc39ba21b2f1a6ea49d9bd3869707c9fca

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Change log of Elisp2any
 
+## Unreleased
+
+## 0.0.7 - 2026-07-05
+
+* Add dump flag for debugging.
+* Allow other variables in headers.
+* Remove sidebar.
+* Markup copyright mark.
+* Hide navigation by default.
+* Add comments for command line options.
+
 ## 0.0.6 - 2025-06-22
 
 Removed previous parsers and added simple strscan base parser.

data/README.md

@@ -15,6 +15,8 @@ $ elisp2any --input /path/to/input/file --output /path/to/output/file
 
 ## Development
 
+To run tests, run `test-unit`.
+
 Two paragraph types:
 
 ```emacs-lisp
@@ -38,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,10 +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']
+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
-
-task default: :test

data/exe/elisp2any

@@ -1,5 +1,20 @@
 #!/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")
@@ -8,19 +23,28 @@ require 'elisp'
 input = $stdin
 output = $stdout
 css = nil
+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("--dump") { dump = true }
 end.parse!
 
-Elisp.parse(input).write(output, css:)
+doc = Elisp.parse(input)
+if dump
+  pp doc
+  exit
+end
+
+doc.write(output, css:)

data/lib/elisp/comment.rb

@@ -1,3 +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::Comment
   def initialize(content)
     @content = content
@@ -15,79 +30,3 @@ class Elisp::Comment
     self.class.parse(@content)
   end
 end
-
-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>)
-      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/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

@@ -1,8 +1,23 @@
+# 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>lexical-binding:[ ]?t);?[ ]-[*]-)?
+    (?:[ ]+-[*]-[ ]*(?<vars>.*?)[ ]*-[*]-)?
     \n+
   }x
   COMMENT = / *;; (?<comment>.*)\n/
@@ -20,45 +35,10 @@ class Elisp::Parser
   }x
   BLANKLINES = /\n+/
   CODE_OR_BLANKLINES = Regexp.union(CODE, BLANKLINES)
-  DEFAULT_CSS = <<~END_CSS
-    <style>
-      :root {
-        --sidebar-width: 200px;
-      }
-      body {
-        display: flex;
-      }
-      main {
-        max-width: 80rem;
-        margin: auto auto auto var(--sidebar-width);
-        padding-left: 0.5rem;
-        border-box: box-sizing;
-      }
-      .sidebar {
-        padding-right: 0.5rem;
-        width: var(--sidebar-width);
-        position: fixed;
-        boxed-sizing: border-box;
-        overflow-y: auto;
-        height: 100%;
-      }
-      .sidebar details ul {
-        position: relative;
-        left: -1.5rem;
-      }
-      .description {
-        font-style: italic;
-      }
-      pre {
-        font-family: serif;
-      }
-      pre[class="code"] {
-        border-left: solid;
-        padding-left: 0.5rem;
-        white-space: pre-wrap;
-      }
-    </style>
-  END_CSS
+  
+  css = File.read(File.join(__dir__, "default.css"))
+  DEFAULT_CSS = "<style>#{css}</style>"
+  
   HEADING = %r{
     ;;;(?<level>;*)[ ](?<title>.+)\n
     (?:(?:;;)?\n)*
@@ -132,7 +112,7 @@ class Elisp::Parser
         @nodes.last << @scanner[:content]
 
       elsif @state == :after_code && @scanner.skip(/\f\n+/)
-        @nodes << PageDelimiter.new
+        @nodes << Elisp::PageDelimiter.new
         @state = :after_page_delimiter
 
       else
@@ -163,9 +143,6 @@ class Elisp::Parser
 
   def write(output, css: nil)
     css = css ? %(<link rel="stylesheet" href="#{CGI.escape(css)}">) : DEFAULT_CSS
-    sidebar = Elisp::Sidebar.new(@nodes.select { |node| node.is_a?(Elisp::Heading) \
-                                                          && node.level >= 2 })
-                .html
     body = @nodes.map(&:html).join("\n")
     output.write(<<~END_HTML)
       <!doctype html>
@@ -173,14 +150,10 @@ class Elisp::Parser
         <head>
           #{css}
           <meta charset="utf8">
+          <meta name="viewport" content="width=device-width, initial-scale=1">
         </head>
         <body>
-          <nav class="sidebar">
-            #{sidebar}
-          </nav>
-          <main>
-            #{body}
-          </main>
+          <main>#{body}</main>
         </body>
       </html>
     END_HTML

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

@@ -1,3 +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/>.
+
 require "strscan"
 require "cgi"
 require "uri"
@@ -10,70 +25,10 @@ class Elisp
   end
 end
 
-class Elisp::Sidebar
-  def initialize(headings)
-    @headings = headings
-  end
-
-  def html
-    rest = @headings.dup
-    result = +""
-    while (head = rest.shift)
-      level = head.level
-      subheadings = []
-      while (heading = rest.shift)
-        if heading.level > level
-          subheadings << heading
-        else
-          rest.unshift(heading)
-          break
-        end
-      end
-      sub_sidebar =
-        subheadings.empty? ? nil
-          : (html = self.class.new(subheadings).html
-            "<details open>#{html}</details>")
-      content = CGI.escape_html(head.content)
-      result << <<~END_HTML
-        <li>
-          <a href="##{head.html_id}">#{content}</a>
-          #{sub_sidebar}
-        </li>
-      END_HTML
-    end
-    "<ul>#{result}</ul>"
-  end
-end
-
-class PageDelimiter
+class Elisp::PageDelimiter
   def html = "<hr>"
 end
 
-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)
-    <<~END_HTML
-      <#{name} id="#{html_id}">
-        #{content}
-        <a href="##{html_id}">#</a>
-      </#{name}>
-    END_HTML
-  end
-
-  def html_id
-    content = CGI.escape(@content)
-    "#{@level}-#{content}"
-  end
-end
-
 class Elisp::Desc
   def initialize(content)
     @content = content
@@ -95,7 +50,7 @@ class Elisp::Variables
     <<~END_HTML
       <article>
         Header line variables:
-        <pre><code>#{content}</code></pre>
+        <pre class="code"><code>#{content}</code></pre>
       </article>
     END_HTML
   end
@@ -140,3 +95,5 @@ end
 
 require_relative "elisp/comment"
 require_relative "elisp/parser"
+require_relative "elisp/heading"
+require_relative "elisp/doc_string_parser"

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: elisp2any
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - gemmaro
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-06-22 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -56,27 +55,11 @@ files:
 - fixtures/init.el
 - lib/elisp.rb
 - lib/elisp/comment.rb
+- lib/elisp/default.css
+- lib/elisp/doc_string_parser.rb
+- lib/elisp/heading.rb
 - lib/elisp/parser.rb
-- lib/elisp2any.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/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/paragraph.rb
-- lib/elisp2any/section.rb
-- lib/elisp2any/text.rb
-- lib/elisp2any/version.rb
+- lib/elisp/version.rb
 homepage: https://codeberg.org/gemmaro/elisp2any
 licenses:
 - GPL-3.0-or-later
@@ -88,7 +71,6 @@ metadata:
   homepage_uri: https://codeberg.org/gemmaro/elisp2any
   source_code_uri: https://codeberg.org/gemmaro/elisp2any
   wiki_uri: https://codeberg.org/gemmaro/elisp2any/wiki
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -103,8 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.27
-signing_key:
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Converter from Emacs Lisp to some document markup
 test_files: []

data/lib/elisp2any/aside.rb

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