RubyGems - elisp2any - Versions diffs - 0.0.5 → 0.0.7 - Mend

elisp2any 0.0.5 → 0.0.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (46) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +15 -0
data/LICENSE.txt +674 -202
data/README.md +31 -7
data/Rakefile +5 -52
data/exe/elisp2any +27 -17
data/lib/elisp/comment.rb +32 -0
data/lib/elisp/default.css +11 -0
data/lib/elisp/doc_string_parser.rb +96 -0
data/lib/elisp/heading.rb +31 -0
data/lib/elisp/parser.rb +161 -0
data/lib/elisp/version.rb +18 -0
data/lib/elisp.rb +99 -0
metadata +12 -96
data/.document +0 -4
data/.envrc +0 -3
data/.rdoc_options +0 -2
data/.rubocop.yml +0 -11
data/lib/elisp2any/asciidoc_renderer/index.adoc.erb +0 -15
data/lib/elisp2any/asciidoc_renderer.rb +0 -57
data/lib/elisp2any/aside.rb +0 -23
data/lib/elisp2any/blanklines.rb +0 -20
data/lib/elisp2any/code.rb +0 -49
data/lib/elisp2any/codeblock.rb +0 -56
data/lib/elisp2any/comment.rb +0 -19
data/lib/elisp2any/commentary.rb +0 -32
data/lib/elisp2any/expression.rb +0 -90
data/lib/elisp2any/file.rb +0 -63
data/lib/elisp2any/footer_line.rb +0 -28
data/lib/elisp2any/header_line.rb +0 -80
data/lib/elisp2any/heading.rb +0 -68
data/lib/elisp2any/html_renderer/index.html.erb +0 -23
data/lib/elisp2any/html_renderer.erb +0 -22
data/lib/elisp2any/html_renderer.rb +0 -149
data/lib/elisp2any/inline_code.rb +0 -10
data/lib/elisp2any/line.rb +0 -52
data/lib/elisp2any/node.rb +0 -67
data/lib/elisp2any/paragraph.rb +0 -37
data/lib/elisp2any/section.rb +0 -49
data/lib/elisp2any/text.rb +0 -33
data/lib/elisp2any/tree_sitter_parser.rb +0 -36
data/lib/elisp2any/version.rb +0 -4
data/lib/elisp2any.rb +0 -27
data/manifest.scm +0 -87
data/sig/elisp2any.gen.rbs +0 -112
data/sig/elisp2any.rbs +0 -4

data/lib/elisp2any/header_line.rb DELETED Viewed

@@ -1,80 +0,0 @@
-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 DELETED Viewed

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

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

@@ -1,23 +0,0 @@
-<!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 %></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 DELETED Viewed

@@ -1,22 +0,0 @@
-<!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 DELETED Viewed

@@ -1,149 +0,0 @@
-require 'erb'
-require 'forwardable'
-require 'cgi/util'
-require_relative 'inline_code'
-require_relative 'heading'
-require_relative 'paragraph'
-require_relative 'codeblock'
-module Elisp2any
-  class HTMLRenderer
-    def initialize(file, css: nil, mode:)
-      @file = file
-      @css = css || "https://unpkg.com/mvp.css"
-      @mode = mode
-    end
-    # 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
-    def render_paragraph(paragraph)
-      html = ''
-      paragraph.each do |line|
-        line.each do |chunk|
-          case chunk
-          in InlineCode
-            html << "<code>#{h(chunk.content)}</code>"
-          in String
-            html << h(chunk)
-          in { code: }
-            html << "<code>#{h(code)}</code>"
-          else
-            raise Error, chunk.inspect
-          end
-        end
-      end
-      html
-    end
-    # TODO: remove level
-    def render_block(block, level: nil)
-      html = ''
-      case block
-      when Heading
-        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
-        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
-    def erb_render(path)
-      source = ::File.read(::File.join(__dir__, 'html_renderer', path))
-      ERB.new(source).result(binding)
-    end
-    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 # :nodoc:
-    def_delegators :@file, :name, :synopsis, :commentary, :code, :header_line
-  end
-end

data/lib/elisp2any/inline_code.rb DELETED Viewed

@@ -1,10 +0,0 @@
-module Elisp2any
-  # TODO: delete
-  class InlineCode
-    attr_reader :content
-    def initialize(content)
-      @content = content
-    end
-  end
-end

data/lib/elisp2any/line.rb DELETED Viewed

@@ -1,52 +0,0 @@
-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
-    def self.parse(string) # :nodoc:
-      scanner = StringScanner.new(string)
-      chunks = []
-      until scanner.eos?
-        if scanner.skip(/`(?<content>[^']+)'/)
-          chunks << InlineCode.new(scanner[:content])
-        else
-          chunk = scanner.getch
-          if (last = chunks.last).is_a?(String)
-            last << chunk
-          else
-            chunks << chunk
-          end
-        end
-      end
-      new(chunks)
-    end
-    extend Forwardable # :nodoc:
-    def_delegators :@chunks, :each, :deconstruct
-    include Enumerable
-  end
-end

data/lib/elisp2any/node.rb DELETED Viewed

@@ -1,67 +0,0 @@
-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
-    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/paragraph.rb DELETED Viewed

@@ -1,37 +0,0 @@
-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 # :nodoc:
-    def_delegators :@lines, :empty?, :clear, :<<, :each, :deconstruct, :size
-    def_delegators :@node, :adjucent?
-    include Enumerable
-  end
-end

data/lib/elisp2any/section.rb DELETED Viewed

@@ -1,49 +0,0 @@
-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 DELETED Viewed

@@ -1,33 +0,0 @@
-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 DELETED Viewed

@@ -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/version.rb DELETED Viewed

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

data/lib/elisp2any.rb DELETED Viewed

@@ -1,27 +0,0 @@
-require_relative 'elisp2any/version'
-require_relative 'elisp2any/file'
-require_relative 'elisp2any/heading'
-module Elisp2any
-  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