djot 0.0.5 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38368915f0c2573a1daa39f56bbce7f81b66ff5a8da7253bd9f9cd414970e1b9
-  data.tar.gz: d3828d6c7ed236474840a2c43289211c0c341b2a7a308b86633bc3e7df3b943d
+  metadata.gz: b05a8f0740be3ef7a6d70beef262278b751c2c2bf7b199831857a00ea1209b15
+  data.tar.gz: b4f037b12f3c5f96807b3b4b089df2f2b266b4e8b3cec58c4a96016b653fa143
 SHA512:
-  metadata.gz: 93057af842daddd20a723d5132be5d97a63f456dd94fab083e2bc40955dd644fbb67bb69f1a2d38cd1f646b687733cb7d228675ac17b3b6796763d0ee593ce61
-  data.tar.gz: 92060c827d1a52f662a804ad83a8722727cf70c3ff6e9c0bc55785262aaba1f6cc3b8e4b89dfa851ed0310ad08aadfe2c1f104c2268792f76aeb1ccb896d98b5
+  metadata.gz: 7c51a726fe392ac8085ea2014aab561bff1596d6f70b28583c8147fecfa2e5b8e10e70df8c0420d92cf8f997f9ac7a714c7ddab22707dccd51e14626516c9473
+  data.tar.gz: 1ef8cc01d4a8076d1763799d304a3b7bf67a383bdd1abe9ff3b47ddde419474175bcbf7310552be00c1bd95a2e50ef96abfc8dbe9f044e6b3c84daf202cba313

data/.mdl_style.rb

@@ -0,0 +1,4 @@
+all
+rule "MD007", indent: 2
+exclude_rule "MD013"
+exclude_rule "MD024"

data/.mdlrc

@@ -0,0 +1 @@
+style ".mdl_style.rb"

data/.rubocop.yml

@@ -15,11 +15,22 @@ Style/StringLiteralsInInterpolation:
 Layout/LineLength:
   Max: 120
 
-Style/Documentation:
-  Enabled: false
-
 Style/FrozenStringLiteralComment:
   EnforcedStyle: never
 
+Style/DocumentDynamicEvalDefinition:
+  Enabled: true
+  Exclude:
+    - lib/djot/javascript.rb
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
 require:
   - rubocop-rake

data/.rubocop_todo.yml

@@ -1,18 +1,15 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2023-01-21 02:00:17 UTC using RuboCop version 1.43.0.
+# on 2023-05-25 12:41:00 UTC using RuboCop version 1.50.2.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 2
-# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, AllowedMethods, AllowedPatterns, IgnoredMethods.
-# AllowedMethods: refine
-Metrics/BlockLength:
-  Max: 37
-
 # Offense count: 1
-# Configuration parameters: CountComments, CountAsOne.
-Metrics/ClassLength:
-  Max: 139
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/djot/pure.rb'

data/CHANGELOG.md

@@ -2,6 +2,51 @@
 
 ## [Unreleased]
 
+## [0.0.7] - 2023-05-25
+
+### Removed
+
+* References to Lua implementation (djot.lua)
+
+### Changed
+
+* Update djot.js to v0.2.1.
+
+### Fixed
+
+* `Djot.render_html` to accept `warn` option
+* Remove `Djot.render_matches`
+* `Djot.render_ast` to accept `source_positions` option
+* `Djot::JavaScript` to accept `source_positions` option
+
+### Added
+
+* Sckelton `Djot::Pure` module for pure Ruby implementation
+
+## [0.0.6] - 2023-01-31
+
+Note again that the default parser might be changed from djot.lua to djot.js in future version.
+
+### Added
+
+* `Djot::Lua` module, which contains ex-`Djot.render_*` methods.
+  Now `Djot.render_*` methods are pointers to `Djot::Lua.render_*` (default is not changed for this release).
+* Option `warn` for `Djot::JavaScript.parse`.
+* `Djot::JavaScript.parse_events` method.
+* Option `warn` for `Djot::JavaScript.render_html`.
+  (Option `overrides` are not yet supported.)
+* Option `warn` and `smart_punctuation_map` for `Djot::JavaScript.to_pandoc`.
+  (Please caution that `warn` options has not yet tested.)
+* Option `warn` for `Djot::JavaScript.from_pandoc`.
+  (Please caution that `warn` options has not yet tested.)
+
+### Changed
+
+* JavaScript runtime has changed from ExecJS to MiniRacer, for passing Ruby proc to JavaScript runtime.
+  See also [rails/execjs#71 > Custom configuration of runtime](https://github.com/rails/execjs/issues/71).
+* `Djot::JavaScript::VERSION` and `Djot::JavaScript::PATH` is deprecated.
+  Use `Djot::JavaScript.version` and `Djot::JavaScript.path` instead.
+
 ## [0.0.5] - 2023-01-21
 
 Note that the default parser might be changed from djot.lua to djot.js in future version.

data/Dockerfile

@@ -0,0 +1,10 @@
+FROM ruby
+ARG WORKDIR=/app
+RUN mkdir $WORKDIR
+WORKDIR $WORKDIR
+COPY djot.gemspec ./djot.gemspec
+COPY lib/djot/version.rb ./lib/djot/version.rb
+COPY Gemfile ./Gemfile
+RUN bundle -j$(nproc)
+COPY . .
+RUN rake

data/Gemfile

@@ -2,9 +2,11 @@ source "https://rubygems.org"
 
 gemspec
 
+gem "mdl", "~> 0.12.0"
 gem "rake", "~> 13.0"
 gem "rdoc", "~> 6.4"
 gem "rubocop", "~> 1.21"
 gem "rubocop-rake", "~> 0.6.0"
 gem "steep", "~> 1.1"
 gem "test-unit", "~> 3.0"
+gem "typeprof", "~> 0.21.4"

data/README.md

@@ -1,6 +1,6 @@
 # Djot
 
-[Djot](https://djot.net/) parser for Ruby, using original JavaScript ([jdm/djot.js](https://github.com/jgm/djot.js)) and Lua ([djot.lua](https://github.com/jgm/djot.lua)) implementations.
+[Djot](https://djot.net/) parser for Ruby, using original JavaScript ([jdm/djot.js](https://github.com/jgm/djot.js)) implementation.
 
 ## Installation
 
@@ -20,7 +20,23 @@ gem install djot
 
 ```ruby
 require 'djot'
+
 Djot.render_html('This is *djot*')
+#=> "<p>This is <strong>djot</strong></p>\n"
+
+Djot::JavaScript.parse("- `hello", warn: ->(w) { p w })
+#=>
+# {"tag"=>"doc",
+#  "references"=>{},
+#  "footnotes"=>{},
+#  "children"=>
+#   [{"tag"=>"bullet_list",
+#     "tight"=>true,
+#     "style"=>"-",
+#     "children"=>[{"tag"=>"list_item", "children"=>[{"tag"=>"para", "children"=>[{"tag"=>"str", "text"=>"hello"}]}]}]}]}
+#
+# stdout:
+# {"message"=>"Unclosed verbatim", "offset"=>7}
 ```
 
 ## Development
@@ -39,8 +55,8 @@ and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ### TODO
 
-* Use [Attach global Ruby functions to your JavaScript context](https://github.com/rubyjs/mini_racer#attach-global-ruby-functions-to-your-javascript-context) for the functions' options which accepts lambda expressions.
 * Create document class (and more) for idiomatic control in Ruby.
+* Write parser in pure Ruby.
 
 ## Contributing
 
@@ -52,9 +68,8 @@ to the [code of conduct](CODE_OF_CONDUCT.md).
 
 ## Acknowledgement
 
-As mentioned earlier, this library only calls the original JavaScript and Lua implementations; the important work is done in those libraries.
-The Lua implementation was sufficient to render in HTML, but thanks to the more Ruby-friendly JavaScript implementation, even more flexible operations can now be performed in Ruby.
-This gem also uses [rails/execjs](https://github.com/rails/execjs) and [ruby-lua](https://github.com/glejeune/ruby-lua) to call JavaScript and Lua source codes respectibly.
+As mentioned earlier, this library only calls the original JavaScript implementation; the important work is done in that library.
+This gem also uses [MiniRacer](https://github.com/rubyjs/mini_racer) to call JavaScript source code.
 
 ## License
 

data/Rakefile

@@ -11,7 +11,7 @@ require "rubocop/rake_task"
 
 RuboCop::RakeTask.new
 
-task default: %i[copy copy_js test rubocop]
+task default: %i[copy_js test rubocop sig mdl]
 
 desc "Copy JavaScript files"
 task copy_js: "lib/js/djot.js"
@@ -30,22 +30,6 @@ end
 
 directory "lib/js"
 
-desc "Copy Lua files"
-task copy: "lib/lua/djot" do
-  license = File.read("vendor/djot/LICENSE")
-  (["vendor/djot/djot.lua"] + Dir["vendor/djot/djot/*.lua"]).each do |file|
-    File.write(file.sub(%r{vendor/djot}, "lib/lua"), <<~END_LUA)
-      #{File.read(file)}
-
-      --[[
-      #{license}
-      ]]
-    END_LUA
-  end
-end
-
-directory "lib/lua/djot"
-
 require "rdoc/task"
 
 RDoc::Task.new do |rdoc|
@@ -53,3 +37,20 @@ RDoc::Task.new do |rdoc|
   rdoc.main = readme
   rdoc.rdoc_files.include(readme, "lib/**/*.rb")
 end
+
+desc "Lint Markdown files"
+task "mdl" do
+  sh "bundle exec mdl CHANGELOG.md README.md"
+end
+
+desc "Type check"
+task tc: :sig do
+  sh "bundle exec steep check"
+end
+
+desc "Update generated RBS"
+task sig: "sig/djot.gen.rbs"
+
+file "sig/djot.gen.rbs" => ["sig/djot.rbs", *Dir["lib/**/*.rb"]] do |t|
+  sh "bundle", "exec", "typeprof", "-o", t.name, *t.sources
+end

data/Steepfile

@@ -3,6 +3,8 @@ D = Steep::Diagnostic
 target :lib do
   signature "sig"
 
+  library "pathname"
+
   check "lib"
   check "Gemfile"
 

data/djot.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.email = ["gemmaro.dev@gmail.com"]
 
   spec.summary = "Djot parser"
-  spec.description = "djot gem provides parsing functions using original JavaScript and Lua implementations"
+  spec.description = "djot gem provides parsing functions using original JavaScript implementation"
   spec.homepage = "https://gitlab.com/gemmaro/ruby-djot"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 2.6.0"
@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   end
 
   spec.require_paths = ["lib"]
+  spec.rdoc_options << "--include" << "lib"
 
-  spec.add_dependency "execjs", "~> 2.8"
-  spec.add_dependency "ruby-lua", "~> 0.4"
+  spec.add_dependency "mini_racer", "~> 0.6.3"
 end

data/lib/djot/javascript.rb

@@ -1,75 +1,146 @@
 require "pathname"
-require "execjs"
+require "mini_racer"
 
 module Djot
   # Functionalities of djot.js
   module JavaScript
-    PATH = Pathname(__dir__) / ".." / "js" / "djot.js"
+    def self.path # :nodoc:
+      @path ||= Pathname(__dir__ || (raise Error)) / ".." / "js" / "djot.js"
+    end
+
+    PATH = path # :nodoc:
 
-    def self.source
+    deprecate_constant :PATH
+
+    def self.source # :nodoc:
       @source ||= PATH.read
     end
 
-    def self.context
-      @context ||= ExecJS.compile(source)
+    def self.context # :nodoc:
+      return @context if @context
+
+      context = MiniRacer::Context.new
+      context.eval("let args, result")
+      context.eval(source)
+      @context = context
     end
 
     # Correspond to +djot.parse+
     # (https://github.com/jgm/djot.js#parsing-djot-to-an-ast)
-    #
-    # TODO: support +warn+ option
-    def self.parse(input, source_positions: false)
-      context.call("djot.parse", input, { "sourcePositions" => source_positions })
+    def self.parse(input, source_positions: nil, warn: nil)
+      args = [input]
+      options = {}
+      options["sourcePositions"] = source_positions if source_positions
+      args << options
+      context.eval("args = #{JSON.generate(args)}")
+      if warn
+        context.attach("warn", warn)
+        context.eval('args[1]["warn"] = warn')
+      end
+      context.eval("djot.parse.apply(this, args)")
     end
 
-    # TODO: support +djot.EventParser+
+    # Correspond to +djot.parseEvents+
     # (https://github.com/jgm/djot.js#parsing-djot-to-a-stream-of-events)
+    def self.parse_events(input, warn: nil, &block)
+      context.eval("args = #{JSON.generate([input, {}])}")
+      if warn
+        context.attach("warn", warn)
+        context.eval('args[1]["warn"] = warn')
+      end
+      source = if block_given?
+                 context.attach("fun", block)
+                 <<~END_JAVASCRIPT
+                   for (let event of djot.parseEvents(...args)) {
+                     fun(event)
+                   }
+                 END_JAVASCRIPT
+               else
+                 # TODO: Use enum_for
+                 <<~END_JAVASCRIPT
+                   events = []
+                   for (let event of djot.parseEvents(...args)) {
+                     events.push(event)
+                   }
+                   events
+                 END_JAVASCRIPT
+               end
+      context.eval(source)
+    end
 
     # Correspond to +djot.renderAST+
     # (https://github.com/jgm/djot.js#pretty-printing-the-djot-ast)
-    def self.render_ast(doc)
-      context.call("djot.renderAST", doc)
+    def self.render_ast(doc, source_positions: false)
+      args = [doc]
+      args << { "sourcePositions" => source_positions } if source_positions
+      context.eval("djot.renderAST.apply(this, #{JSON.generate(args)})")
     end
 
     # Correspond to +djot.renderHTML+
     # (https://github.com/jgm/djot.js#rendering-the-djot-ast-to-html)
     #
-    # TODO: support +options+
-    def self.render_html(doc)
-      context.call("djot.renderHTML", doc)
+    # TODO: support +overrides+ option
+    def self.render_html(doc, warn: nil)
+      context.eval("args = #{JSON.generate([doc, {}])}")
+      if warn
+        context.attach("warn", warn)
+        context.eval('args[1]["warn"] = warn')
+      end
+      context.eval("djot.renderHTML.apply(this, args)")
     end
 
     # Correspond to +djot.renderDjot+
     # (https://github.com/jgm/djot.js#rendering-djot)
-    #
-    # TODO: support options
     def self.render_djot(doc, wrap_width: nil)
       options = {}
       options["wrapWidth"] = wrap_width if wrap_width
 
-      context.call("djot.renderDjot", doc, options)
+      call("renderDjot", doc, options)
     end
 
     # Correspond to +djot.toPandoc+
     # (https://github.com/jgm/djot.js#pandoc-interoperability)
     #
-    # TODO: support +warn+ and +smart_punctuation_map+ option
-    def self.to_pandoc(doc)
-      context.call("djot.toPandoc", doc)
+    # CAUTION: +warn+ option hasn't yet tested.
+    # There may be bugs.
+    def self.to_pandoc(doc, warn: nil, smart_punctuation_map: nil)
+      options = {}
+      options["smartPunctuationMap"] = smart_punctuation_map if smart_punctuation_map
+      context.eval("args = #{JSON.generate([doc, options])}")
+      if warn
+        context.attach("warn", warn)
+        context.eval('args[1]["warn"] = warn')
+      end
+      context.eval("djot.toPandoc.apply(this, args)")
     end
 
     # Correspond to +djot.fromPandoc+
     # (https://github.com/jgm/djot.js#pandoc-interoperability)
     #
-    # TODO: support options
-    def self.from_pandoc(pandoc)
-      context.call("djot.fromPandoc", pandoc)
+    # CAUTION: +warn+ options hasn't yet tested.
+    def self.from_pandoc(pandoc, warn: nil)
+      context.eval("args = #{JSON.generate([pandoc, {}])}")
+      if warn
+        context.attach("warn", warn)
+        context.eval('args[1]["warn"] = warn')
+      end
+      context.eval("djot.fromPandoc.apply(this, args)")
     end
 
     # TODO: support filters
 
     # Correspond to +djot.version+
     # (https://github.com/jgm/djot.js#getting-the-version)
-    VERSION = context.eval("djot.version")
+    def self.version
+      @version ||= context.eval("djot.version")
+    end
+
+    VERSION = version # :nodoc:
+
+    deprecate_constant :VERSION
+
+    def self.call(name, *args) # :nodoc:
+      context.eval("djot.#{name}.apply(this, #{::JSON.generate(args)})")
+    end
   end
 end

data/lib/djot/pure.rb

@@ -0,0 +1,4 @@
+module Djot
+  module Pure
+  end
+end

data/lib/djot/version.rb

@@ -1,3 +1,3 @@
 module Djot
-  VERSION = "0.0.5".freeze
+  VERSION = "0.0.7".freeze
 end

data/lib/djot.rb

@@ -1,49 +1,18 @@
 require_relative "djot/version"
 require_relative "djot/javascript"
-require "language/lua"
-require "pathname"
+require_relative "djot/pure"
 
+# Provides Djot parsing functionalities.
+# +Djot.*+ methods are pointing to JavaScript implementation now.
+# See also Djot::JavaScript for ones pointing to JavaScript implementation.
 module Djot
   class Error < StandardError; end
 
-  LUA = Language::Lua.new
-  LUA.eval(<<~END_LUA)
-    function djot_parser(input)
-      local parser = require("djot").Parser:new(input)
-      parser:parse()
-      return parser
-    end
-
-    function djot_render_html(input)
-      return djot_parser(input):render_html()
-    end
-
-    function djot_render_matches(input)
-      return djot_parser(input):render_matches()
-    end
-
-    function djot_render_ast(input)
-      return djot_parser(input):render_ast()
-    end
-  END_LUA
-
-  ROOT = Pathname(__dir__) / "lua"
-
-  def self.render_html(input)
-    Dir.chdir(ROOT) do
-      LUA.djot_render_html(input)
-    end
-  end
-
-  def self.render_matches(input)
-    Dir.chdir(ROOT) do
-      LUA.djot_render_matches(input)
-    end
+  def self.render_html(doc, warn: nil)
+    JavaScript.render_html(doc, warn: warn)
   end
 
-  def self.render_ast(input)
-    Dir.chdir(ROOT) do
-      LUA.djot_render_ast(input)
-    end
+  def self.render_ast(input, source_positions: false)
+    JavaScript.render_ast(input, source_positions: source_positions)
   end
 end

data/manifest.scm

@@ -0,0 +1,2 @@
+(specifications->manifest (list "ruby-test-unit" "ruby-rubocop"
+                                "ruby-rubocop-rake" "ruby" "node"))

data/sig/djot.gen.rbs

@@ -0,0 +1,32 @@
+# TypeProf 0.21.7
+
+# Classes
+module Djot
+  VERSION: String
+
+  def self.render_html: (untyped input) -> ((Array[untyped] | Hash[untyped, untyped] | MiniRacer::JavaScriptFunction | Time)?)
+  def self.render_matches: (untyped input) -> untyped
+  def self.render_ast: (untyped input) -> ((Array[untyped] | Hash[untyped, untyped] | MiniRacer::JavaScriptFunction | Time)?)
+
+  module JavaScript
+    PATH: Pathname
+    VERSION: (Array[untyped] | Hash[untyped, untyped] | MiniRacer::JavaScriptFunction | Time)?
+    self.@path: Pathname
+    self.@version: (Array[untyped] | Hash[untyped, untyped] | MiniRacer::JavaScriptFunction | Time)?
+    self.@context: MiniRacer::Context
+    self.@source: String
+
+    def self.path: -> Pathname
+    def self.source: -> String
+    def self.context: -> MiniRacer::Context?
+    def self.parse: (untyped input, ?source_positions: nil, ?warn: nil) -> ((Array[untyped] | Hash[untyped, untyped] | MiniRacer::JavaScriptFunction | Time)?)
+    def self.parse_events: (untyped input, ?warn: nil) -> ((Array[untyped] | Hash[untyped, untyped] | MiniRacer::JavaScriptFunction | Time)?)
+    def self.render_ast: (untyped doc) -> ((Array[untyped] | Hash[untyped, untyped] | MiniRacer::JavaScriptFunction | Time)?)
+    def self.render_html: (untyped doc, ?warn: nil) -> ((Array[untyped] | Hash[untyped, untyped] | MiniRacer::JavaScriptFunction | Time)?)
+    def self.render_djot: (untyped doc, ?wrap_width: nil) -> ((Array[untyped] | Hash[untyped, untyped] | MiniRacer::JavaScriptFunction | Time)?)
+    def self.to_pandoc: (untyped doc, ?warn: nil, ?smart_punctuation_map: nil) -> ((Array[untyped] | Hash[untyped, untyped] | MiniRacer::JavaScriptFunction | Time)?)
+    def self.from_pandoc: (untyped pandoc, ?warn: nil) -> ((Array[untyped] | Hash[untyped, untyped] | MiniRacer::JavaScriptFunction | Time)?)
+    def self.version: -> ((Array[untyped] | Hash[untyped, untyped] | MiniRacer::JavaScriptFunction | Time)?)
+    def self.call: (String name, *Hash[String, untyped] args) -> ((Array[untyped] | Hash[untyped, untyped] | MiniRacer::JavaScriptFunction | Time)?)
+  end
+end

data/sig/djot.rbs

@@ -1,6 +1,8 @@
+# TODO
 module Djot
-  VERSION: String
-  def self.render_html: (String) -> String
-  def self.render_matches: (String) -> String
-  def self.render_ast: (String) -> String
+  module JavaScript
+  end
+
+  class Error < StandardError
+  end
 end