djot 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2419533ac547deab5c4ec161d2147c47895839050151bf1233c093d03c7f6202
-  data.tar.gz: 2aae784074f6b9df2827d6dfc6ce05cb4a53fb9ad117b1c8a1141bc18234f6df
+  metadata.gz: b05a8f0740be3ef7a6d70beef262278b751c2c2bf7b199831857a00ea1209b15
+  data.tar.gz: b4f037b12f3c5f96807b3b4b089df2f2b266b4e8b3cec58c4a96016b653fa143
 SHA512:
-  metadata.gz: d3e5caed7e26dd27fea38c2c323024d64803ed88de74ed37e81020d6cb8117a810b6926c3e4b0d877781989d526e83916ba441be7a81c8f8ee7074413e50de0d
-  data.tar.gz: aa3fa15f1deb0b930779806e0cad85b2a7a65be32a252825b8211089e38341c59f29fb9713a1755aef514b2a540067e706f022188571a35725190f94128654f6
+  metadata.gz: 7c51a726fe392ac8085ea2014aab561bff1596d6f70b28583c8147fecfa2e5b8e10e70df8c0420d92cf8f997f9ac7a714c7ddab22707dccd51e14626516c9473
+  data.tar.gz: 1ef8cc01d4a8076d1763799d304a3b7bf67a383bdd1abe9ff3b47ddde419474175bcbf7310552be00c1bd95a2e50ef96abfc8dbe9f044e6b3c84daf202cba313

data/.rubocop.yml

@@ -26,5 +26,11 @@ Style/DocumentDynamicEvalDefinition:
 Metrics/ClassLength:
   Enabled: false
 
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
 require:
   - rubocop-rake

data/.rubocop_todo.yml

@@ -1,23 +1,15 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2023-01-30 13:50:23 UTC using RuboCop version 1.44.1.
+# 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: 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: 2
-# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, AllowedMethods, AllowedPatterns, IgnoredMethods.
-Metrics/MethodLength:
-  Max: 22
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/djot/pure.rb'

data/CHANGELOG.md

@@ -2,6 +2,27 @@
 
 ## [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.

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/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
 
@@ -57,8 +57,6 @@ and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 * 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
 
@@ -70,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 [MiniRacer](https://github.com/rubyjs/mini_racer) 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 sig mdl]
+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|

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 "mini_racer", "~> 0.6.3"
-  spec.add_dependency "ruby-lua", "~> 0.4"
 end

data/lib/djot/javascript.rb

@@ -70,8 +70,10 @@ module Djot
 
     # Correspond to +djot.renderAST+
     # (https://github.com/jgm/djot.js#pretty-printing-the-djot-ast)
-    def self.render_ast(doc)
-      call("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+

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.6".freeze
+  VERSION = "0.0.7".freeze
 end

data/lib/djot.rb

@@ -1,22 +1,18 @@
 require_relative "djot/version"
 require_relative "djot/javascript"
-require_relative "djot/lua"
+require_relative "djot/pure"
 
 # Provides Djot parsing functionalities.
-# +Djot.*+ methods are pointing to Lua implementation now.
+# +Djot.*+ methods are pointing to JavaScript implementation now.
 # See also Djot::JavaScript for ones pointing to JavaScript implementation.
 module Djot
   class Error < StandardError; end
 
-  def self.render_html(input)
-    Lua.render_html(input)
+  def self.render_html(doc, warn: nil)
+    JavaScript.render_html(doc, warn: warn)
   end
 
-  def self.render_matches(input)
-    Lua.render_matches(input)
-  end
-
-  def self.render_ast(input)
-    Lua.render_ast(input)
+  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

@@ -1,12 +1,12 @@
-# TypeProf 0.21.4
+# TypeProf 0.21.7
 
 # Classes
 module Djot
   VERSION: String
 
-  def self.render_html: (untyped input) -> untyped
+  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) -> untyped
+  def self.render_ast: (untyped input) -> ((Array[untyped] | Hash[untyped, untyped] | MiniRacer::JavaScriptFunction | Time)?)
 
   module JavaScript
     PATH: Pathname
@@ -29,14 +29,4 @@ module Djot
     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

@@ -3,9 +3,6 @@ module Djot
   module JavaScript
   end
 
-  module Lua
-  end
-
   class Error < StandardError
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: djot
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - gemmaro
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-31 00:00:00.000000000 Z
+date: 2023-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mini_racer
@@ -24,22 +24,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.6.3
-- !ruby/object:Gem::Dependency
-  name: ruby-lua
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-description: djot gem provides parsing functions using original JavaScript and Lua
-  implementations
+description: djot gem provides parsing functions using original JavaScript implementation
 email:
 - gemmaro.dev@gmail.com
 executables: []
@@ -52,6 +37,7 @@ files:
 - ".rubocop_todo.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- Dockerfile
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -60,17 +46,10 @@ files:
 - djot.gemspec
 - lib/djot.rb
 - lib/djot/javascript.rb
-- lib/djot/lua.rb
+- lib/djot/pure.rb
 - lib/djot/version.rb
 - lib/js/djot.js
-- lib/lua/djot.lua
-- lib/lua/djot/ast.lua
-- lib/lua/djot/attributes.lua
-- lib/lua/djot/block.lua
-- lib/lua/djot/emoji.lua
-- lib/lua/djot/html.lua
-- lib/lua/djot/inline.lua
-- lib/lua/djot/match.lua
+- manifest.scm
 - sig/djot.gen.rbs
 - sig/djot.rbs
 homepage: https://gitlab.com/gemmaro/ruby-djot
@@ -81,8 +60,10 @@ metadata:
   source_code_uri: https://gitlab.com/gemmaro/ruby-djot
   changelog_uri: https://gitlab.com/gemmaro/ruby-djot/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message: 
-rdoc_options: []
+post_install_message:
+rdoc_options:
+- "--include"
+- lib
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -96,8 +77,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Djot parser
 test_files: []

data/lib/djot/lua.rb

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