djot 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38368915f0c2573a1daa39f56bbce7f81b66ff5a8da7253bd9f9cd414970e1b9
-  data.tar.gz: d3828d6c7ed236474840a2c43289211c0c341b2a7a308b86633bc3e7df3b943d
+  metadata.gz: 2419533ac547deab5c4ec161d2147c47895839050151bf1233c093d03c7f6202
+  data.tar.gz: 2aae784074f6b9df2827d6dfc6ce05cb4a53fb9ad117b1c8a1141bc18234f6df
 SHA512:
-  metadata.gz: 93057af842daddd20a723d5132be5d97a63f456dd94fab083e2bc40955dd644fbb67bb69f1a2d38cd1f646b687733cb7d228675ac17b3b6796763d0ee593ce61
-  data.tar.gz: 92060c827d1a52f662a804ad83a8722727cf70c3ff6e9c0bc55785262aaba1f6cc3b8e4b89dfa851ed0310ad08aadfe2c1f104c2268792f76aeb1ccb896d98b5
+  metadata.gz: d3e5caed7e26dd27fea38c2c323024d64803ed88de74ed37e81020d6cb8117a810b6926c3e4b0d877781989d526e83916ba441be7a81c8f8ee7074413e50de0d
+  data.tar.gz: aa3fa15f1deb0b930779806e0cad85b2a7a65be32a252825b8211089e38341c59f29fb9713a1755aef514b2a540067e706f022188571a35725190f94128654f6

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,16 @@ 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
+
 require:
   - rubocop-rake

data/.rubocop_todo.yml

@@ -1,18 +1,23 @@
 # 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-01-30 13:50:23 UTC using RuboCop version 1.44.1.
 # 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: 1
+# Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 18
+
 # 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
+# Offense count: 2
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, AllowedMethods, AllowedPatterns, IgnoredMethods.
+Metrics/MethodLength:
+  Max: 22

data/CHANGELOG.md

@@ -2,6 +2,30 @@
 
 ## [Unreleased]
 
+## [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/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

@@ -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,10 @@ 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.
+* Make JavaScript version as default. Currently the default is Lua version.
+* Update Lua implementation from djot to djot.lua.
 
 ## Contributing
 
@@ -54,7 +72,7 @@ to the [code of conduct](CODE_OF_CONDUCT.md).
 
 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.
+This gem also uses [MiniRacer](https://github.com/rubyjs/mini_racer) and [ruby-lua](https://github.com/glejeune/ruby-lua) to call JavaScript and Lua source codes respectibly.
 
 ## 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 copy_js test rubocop sig mdl]
 
 desc "Copy JavaScript files"
 task copy_js: "lib/js/djot.js"
@@ -53,3 +53,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

@@ -27,6 +27,6 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "execjs", "~> 2.8"
+  spec.add_dependency "mini_racer", "~> 0.6.3"
   spec.add_dependency "ruby-lua", "~> 0.4"
 end

data/lib/djot/javascript.rb

@@ -1,75 +1,144 @@
 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)
+      call("renderAST", doc)
     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/lua.rb

@@ -0,0 +1,52 @@
+require "language/lua"
+require "pathname"
+
+module Djot
+  # Functionalities of djot (Lua implementation)
+  module Lua
+    LUA = Language::Lua.new # :nodoc:
+    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__ || (raise Error)) / ".." / "lua" # :nodoc:
+
+    def self.render_html(input)
+      run_at_root do
+        LUA.djot_render_html(input)
+      end
+    end
+
+    def self.render_matches(input)
+      run_at_root do
+        LUA.djot_render_matches(input)
+      end
+    end
+
+    def self.render_ast(input)
+      run_at_root do
+        LUA.djot_render_ast(input)
+      end
+    end
+
+    def self.run_at_root(&block) # :nodoc:
+      Dir.chdir(ROOT.to_s, &block)
+    end
+  end
+end

data/lib/djot/version.rb

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

data/lib/djot.rb

@@ -1,49 +1,22 @@
 require_relative "djot/version"
 require_relative "djot/javascript"
-require "language/lua"
-require "pathname"
+require_relative "djot/lua"
 
+# Provides Djot parsing functionalities.
+# +Djot.*+ methods are pointing to Lua 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
+    Lua.render_html(input)
   end
 
   def self.render_matches(input)
-    Dir.chdir(ROOT) do
-      LUA.djot_render_matches(input)
-    end
+    Lua.render_matches(input)
   end
 
   def self.render_ast(input)
-    Dir.chdir(ROOT) do
-      LUA.djot_render_ast(input)
-    end
+    Lua.render_ast(input)
   end
 end

data/sig/djot.gen.rbs

@@ -0,0 +1,42 @@
+# TypeProf 0.21.4
+
+# Classes
+module Djot
+  VERSION: String
+
+  def self.render_html: (untyped input) -> untyped
+  def self.render_matches: (untyped input) -> untyped
+  def self.render_ast: (untyped input) -> untyped
+
+  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
+
+  module Lua
+    LUA: untyped
+    ROOT: Pathname
+
+    def self.render_html: (untyped input) -> untyped
+    def self.render_matches: (untyped input) -> untyped
+    def self.render_ast: (untyped input) -> untyped
+    def self.run_at_root: { (String) -> untyped } -> untyped
+  end
+end

data/sig/djot.rbs

@@ -1,6 +1,11 @@
+# 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
+
+  module Lua
+  end
+
+  class Error < StandardError
+  end
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: djot
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - gemmaro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-21 00:00:00.000000000 Z
+date: 2023-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: execjs
+  name: mini_racer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: 0.6.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: 0.6.3
 - !ruby/object:Gem::Dependency
   name: ruby-lua
   requirement: !ruby/object:Gem::Requirement
@@ -46,6 +46,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".mdl_style.rb"
+- ".mdlrc"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - CHANGELOG.md
@@ -58,6 +60,7 @@ files:
 - djot.gemspec
 - lib/djot.rb
 - lib/djot/javascript.rb
+- lib/djot/lua.rb
 - lib/djot/version.rb
 - lib/js/djot.js
 - lib/lua/djot.lua
@@ -68,6 +71,7 @@ files:
 - lib/lua/djot/html.lua
 - lib/lua/djot/inline.lua
 - lib/lua/djot/match.lua
+- sig/djot.gen.rbs
 - sig/djot.rbs
 homepage: https://gitlab.com/gemmaro/ruby-djot
 licenses:
@@ -92,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.1
 signing_key: 
 specification_version: 4
 summary: Djot parser