elisp2any 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfaef7d1de4a445f1055d3093dd6afb0b3f87db67dff17b4a3bf17e451e042c6
-  data.tar.gz: 3746dd755e216ffda34d037bb3c1070dadb1b8b485426a25c59555d284e7f55a
+  metadata.gz: 43ac0e60fb0505d1dfedf717b38966d20340412d119b4ad6842751e92b6d6774
+  data.tar.gz: ca6adc49a9eff939fac9aa31b97b2f07194d276042aea5c46b9bcc099a392326
 SHA512:
-  metadata.gz: 13d87c5c455d13766deea274183b1a3f32e4165c0f7edbb68e680f977e1c8987eec0808bff8a1285ed9a617d0796e9fdee43784f8955e681feffc41fd0be06d6
-  data.tar.gz: 97d5d3ca8dfe1f14a26c21bb5d4062a789ac77e2a05ddeb568a624f2ff16dc3cc2e83415d979e612d504aa883af50cd44275289e633521622049188d8db37bd5
+  metadata.gz: 3ae7c237a6d260412d87ed8b506efb52694a3b85e10a27e2a0277839a6512ec06a4c3945a368bc2b9e876b1c8fe89c822ed282c1a0c921e864b651b911f84d7c
+  data.tar.gz: 257b9a436a46b010773af8e0180b4e8417be2469a464bda2214cafac6734d5bb85771bc0213a8073fead2fdfe461595a44952483c477f698a3b4514febce9228

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/CHANGELOG.md

@@ -1,6 +1,8 @@
 # Change log of Elisp2any
 
-## Unreleased
+## 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/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/blanklines.rb

@@ -0,0 +1,17 @@
+module Elisp2any
+  class Blanklines
+    attr_reader :count
+
+    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
+  end
+end

data/lib/elisp2any/code.rb

@@ -0,0 +1,35 @@
+require "elisp2any/top_heading"
+require "elisp2any/paragraph"
+require "elisp2any/blanklines"
+require "elisp2any/section"
+
+module Elisp2any
+  class Code
+    attr_reader :paragraphs, :sections
+
+    def self.scan(scanner)
+      pos = scanner.pos
+      heading = TopHeading.scan(scanner) or return
+      unless heading.content == "Code:"
+        scanner.pos = pos
+        return
+      end
+      Blanklines.scan(scanner) # optional
+      paragraphs = []
+      while (par = Paragraph.scan(scanner))
+        paragraphs << par
+        Blanklines.scan(scanner) # optional
+      end
+      section = Section.scan(scanner)
+      unless section.heading.level == 1
+        raise "TODO"
+      end
+      new(paragraphs:, sections: [section])
+    end
+
+    def initialize(paragraphs:, sections:)
+      @paragraphs = paragraphs
+      @sections = sections
+    end
+  end
+end

data/lib/elisp2any/code_block.rb

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

data/lib/elisp2any/comment.rb

@@ -0,0 +1,17 @@
+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,29 @@
+require "elisp2any/top_heading"
+require "elisp2any/paragraph"
+require "elisp2any/blanklines"
+
+module Elisp2any
+  class Commentary
+    attr_reader :paragraphs
+
+    def self.scan(scanner)
+      pos = scanner.pos
+      heading = TopHeading.scan(scanner) or return
+      unless heading.content == "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
+  end
+end

data/lib/elisp2any/expression.rb

@@ -0,0 +1,14 @@
+module Elisp2any
+  class Expression
+    attr_reader :content
+
+    def self.scan(scanner)
+      content = scanner.scan(/t\b/) or return
+      new(content:)
+    end
+
+    def initialize(content:)
+      @content = content
+    end
+  end
+end

data/lib/elisp2any/file.rb

@@ -1,9 +1,25 @@
 require_relative 'node'
 require_relative 'tree_sitter_parser'
+require "elisp2any/header_line"
+require "elisp2any/blanklines"
+require "elisp2any/commentary"
+require "elisp2any/code"
 
 module Elisp2any
   class File
-    attr_reader :name, :synopsis, :commentary, :code
+    attr_reader :name, # TODO: filename
+                :synopsis, # TODO: header_line, including description
+                :commentary, :code
+
+    def self.scan(scanner)
+      scanner = StringScanner.new(scanner) unless scanner.respond_to?(:skip)
+      line = HeaderLine.scan(scanner) or return
+      Blanklines.scan(scanner) # optional
+      commentary = Commentary.scan(scanner)
+      Blanklines.scan(scanner) # optional
+      code = Code.scan(scanner)
+      new(name: line.filename, synopsis: line.description, commentary:, code:)
+    end
 
     def self.parse(source)
       source = source.respond_to?(:read) ? source.read : source

data/lib/elisp2any/filename.rb

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

data/lib/elisp2any/header_line.rb

@@ -0,0 +1,47 @@
+require "elisp2any/comment"
+require "elisp2any/filename"
+require "elisp2any/header_line_variables"
+
+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 = TopHeading.scan(scanner))
+        scanner.pos = pos
+        return
+      end
+      cscanner = StringScanner.new(heading.content)
+      unless (filename = Filename.scan(cscanner))
+        scanner.pos = pos
+        return
+      end
+      unless cscanner.skip(/ +--- +/)
+        scanner.pos = pos
+        return
+      end
+      description = +""
+      variables = nil
+      until cscanner.eos?
+        if (variables = HeaderLineVariables.scan(cscanner)) # nop
+          break
+        else
+          description << cscanner.getch
+        end
+      end
+      if description.empty?
+        scanner.pos = pos
+        return
+      end
+      new(filename: filename.content, description:, variables: variables.variables)
+    end
+
+    def initialize(filename:, description:, variables:)
+      @filename = filename
+      @description = description
+      @variables = variables
+    end
+  end
+end

data/lib/elisp2any/header_line_variable_assignment.rb

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

data/lib/elisp2any/header_line_variables.rb

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

data/lib/elisp2any/heading.rb

@@ -5,6 +5,17 @@ module Elisp2any
   class Heading
     attr_reader :level, :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)
+    end
+
+    # TODO
     def initialize(node, level, content) # :nodoc:
       @node = node
       @level = level

data/lib/elisp2any/html_renderer.rb

@@ -57,7 +57,7 @@ module Elisp2any
       CGI.escape_html(string)
     end
 
-    extend Forwardable
+    extend Forwardable # :nodoc:
     def_delegators :@file, :name, :synopsis, :commentary, :code
   end
 end

data/lib/elisp2any/line.rb

@@ -1,9 +1,23 @@
 require 'strscan'
 require 'forwardable'
 require_relative 'inline_code'
+require "elisp2any/comment"
 
 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
+      new(["#{comment.padding[1..]}#{comment.content}"])
+    end
+
     def initialize(chunks) # :nodoc:
       @chunks = chunks
     end

data/lib/elisp2any/paragraph.rb

@@ -1,9 +1,24 @@
 require 'forwardable'
+require "elisp2any/line"
 
 module Elisp2any
   class Paragraph
+    attr_reader :lines
+
+    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

data/lib/elisp2any/section.rb

@@ -0,0 +1,25 @@
+require "elisp2any/heading"
+require "elisp2any/paragraph"
+require "elisp2any/blanklines"
+
+module Elisp2any
+  class Section
+    attr_reader :heading
+
+    def self.scan(scanner)
+      heading = Heading.scan(scanner) or return
+      Blanklines.scan(scanner) # optional
+      paragraphs = []
+      while (par = Paragraph.scan(scanner))
+        paragraphs << par
+        Blanklines.scan(scanner) # optional
+      end
+      new(heading:, paragraphs:)
+    end
+
+    def initialize(heading:, paragraphs:)
+      @heading = heading
+      @paragraphs = paragraphs
+    end
+  end
+end

data/lib/elisp2any/top_heading.rb

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

data/lib/elisp2any/tree_sitter_parser.rb

@@ -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/variable.rb

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

data/lib/elisp2any/version.rb

@@ -1,3 +1,3 @@
 module Elisp2any
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/lib/elisp2any.rb

@@ -2,5 +2,7 @@ require_relative 'elisp2any/version'
 require_relative 'elisp2any/file'
 
 module Elisp2any
-  class Error < StandardError; end
+  autoload :HeaderLine, "elisp2any/header_line.rb"
+  autoload :Blanklines, "elisp2any/blanklines.rb"
+  Error = Class.new(StandardError)
 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.4
 platform: ruby
 authors:
 - gemmaro
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-16 00:00:00.000000000 Z
+date: 2025-02-08 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,8 +117,17 @@ files:
 - lib/elisp2any.rb
 - lib/elisp2any/asciidoc_renderer.rb
 - lib/elisp2any/asciidoc_renderer/index.adoc.erb
+- lib/elisp2any/blanklines.rb
+- lib/elisp2any/code.rb
 - lib/elisp2any/code_block.rb
+- lib/elisp2any/comment.rb
+- lib/elisp2any/commentary.rb
+- lib/elisp2any/expression.rb
 - lib/elisp2any/file.rb
+- lib/elisp2any/filename.rb
+- lib/elisp2any/header_line.rb
+- lib/elisp2any/header_line_variable_assignment.rb
+- lib/elisp2any/header_line_variables.rb
 - lib/elisp2any/heading.rb
 - lib/elisp2any/html_renderer.rb
 - lib/elisp2any/html_renderer/index.html.erb
@@ -124,13 +135,17 @@ files:
 - lib/elisp2any/line.rb
 - lib/elisp2any/node.rb
 - lib/elisp2any/paragraph.rb
+- lib/elisp2any/section.rb
+- lib/elisp2any/top_heading.rb
 - lib/elisp2any/tree_sitter_parser.rb
+- lib/elisp2any/variable.rb
 - lib/elisp2any/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