ruby2js 3.0.15 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7acab4a28c4ec163da40b2f1847692df089ff593af8d735bf163cfe566ed7f5b
-  data.tar.gz: f0f33e2c6beba7785d535ece64e4402cb5aac29fca9f9541087857905ba33d8f
+  metadata.gz: b2ad87139fac25c7b097f2ee32c59b141936bb8424cf93a4a20c2d9393495528
+  data.tar.gz: 4de6a0b69d4d496faae496b37c21c66caee4f3793b1241baf134b5a05c85c7f9
 SHA512:
-  metadata.gz: d53db4145f632be93c234cf706b25e6c7c27a0d0c1a864543045e6d9a9672e9e9792281677da6a4b107a3eac0d173ca2cd151a0d0f91acf3171ecc5a84dd06c4
-  data.tar.gz: 49364f4bb8cf3f05ea9d07664d800a86af81817b096a40c89ec8848a6f45fe62b755cc2e0c995ce49f300bb84a6caa1de4b5fd822b8ae403579e9244dde9e442
+  metadata.gz: 8e359e299801b09bc428a93fdf95d4ac1128fbb19266636034fad929d3fa3759f504e59bbd70eb923733b0656770309f845e23aeb0e4e24424ab0161f6fe528a
+  data.tar.gz: '0874df3f8606f65be7cbae4114c2d384938f7827391020ee0f85d0d99340e4e905010dbe7216ebab17f0adf72fa7793525c95a6e083273abc08cae3dd076d849'

data/README.md

@@ -92,6 +92,18 @@ Enable strict support:
 puts Ruby2JS.convert('a=1', strict: true)
 ```
 
+Emit strict equality comparisons:
+
+```ruby
+puts Ruby2JS.convert('a==1', comparison: :identity)
+```
+
+Emit nullish coalescing operators:
+
+```ruby
+puts Ruby2JS.convert('a || 1', or: :nullish)
+```
+
 With [ExecJS](https://github.com/sstephenson/execjs):
 ```ruby
 require 'ruby2js/execjs'
@@ -220,9 +232,10 @@ the script.
     * `.clear` becomes `.length = 0`
     * `.delete` becomes `delete target[arg]`
     * `.downcase` becomes `.toLowerCase`
-    * `.each` becomes `for (i in ...) {}`
-    * `.each_key` becomes `Object.keys().forEach`
-    * `.each_value` becomes `for (i in ...) {}`
+    * `.each` becomes `.forEach`
+    * `.each_key` becomes `for (i in ...) {}`
+    * `.each_pair` becomes `for (var key in item) {var value = item[key]; ...}`
+    * `.each_value` becomes `.forEach`
     * `.each_with_index` becomes `.forEach`
     * `.end_with?` becomes `.slice(-arg.length) == arg`
     * `.empty?` becomes `.length == 0`
@@ -232,10 +245,12 @@ the script.
     * `.gsub` becomes `replace(//g)`
     * `.include?` becomes `.indexOf() != -1`
     * `.inspect` becomes `JSON.stringify()`
-    * `.keys` becomes `Object.keys()`
+    * `.keys()` becomes `Object.keys()`
     * `.last` becomes `[*.length-1]`
     * `.last(n)` becomes `.slice(*.length-1, *.length)`
+    * `.lstrip` becomes `.replace(/^\s+/, "")`
     * `.max` becomes `Math.max.apply(Math)`
+    * `.merge` becomes `Object.assign({}, ...)`
     * `.merge!` becomes `Object.assign()`
     * `.min` becomes `Math.min.apply(Math)`
     * `.nil?` becomes `== null`
@@ -243,12 +258,16 @@ the script.
     * `puts` becomes `console.log`
     * `.replace` becomes `.length = 0; ...push.apply(*)`
     * `.respond_to?` becomes `right in left`
+    * `.rstrip` becomes `.replace(/s+$/, "")`
     * `.scan` becomes `.match(//g)`
     * `.start_with?` becomes `.substring(0, arg.length) == arg`
     * `.upto(lim)` becomes `for (var i=num; i<=lim; i+=1)`
     * `.downto(lim)` becomes `for (var i=num; i>=lim; i-=1)`
     * `.step(lim, n).each` becomes `for (var i=num; i<=lim; i+=n)`
     * `.step(lim, -n).each` becomes `for (var i=num; i>=lim; i-=n)`
+    * `(0..a).to_a` becomes `Array.apply(null, {length: a}).map(Function.call, Number)`
+    * `(b..a).to_a` becomes `Array.apply(null, {length: (a-b+1)}).map(Function.call, Number).map(function (idx) { return idx+b })`
+    * `(b...a).to_a` becomes `Array.apply(null, {length: (a-b)}).map(Function.call, Number).map(function (idx) { return idx+b })`
     * `.strip` becomes `.trim`
     * `.sub` becomes `.replace`
     * `.to_f` becomes `parseFloat`
@@ -259,6 +278,7 @@ the script.
     * `[n...m]` becomes `.slice(n,m)`
     * `[n..m]` becomes `.slice(n,m+1)`
     * `[/r/, n]` becomes `.match(/r/)[n]`
+    * `[/r/, n]=` becomes `.replace(/r/, ...)`
     * `(1..2).each {|i| ...}` becomes `for (var i=1 i<=2; i+=1)`
     * `"string" * length` becomes `new Array(length + 1).join("string")`
     * `.sub!` and `.gsub!` become equivalent `x = x.replace` statements
@@ -276,13 +296,14 @@ the script.
     * New classes subclassed off of `Exception` will become subclassed off
       of `Error` instead; and default constructors will be provided
     * `loop do...end` will be replaced with `while (true) {...}`
+    * `raise Exception.new(...)` will be replaced with `throw new Error(...)`
 
     Additionally, there is one mapping that will only be done if explicitly
     <a href="https://github.com/rubys/ruby2js/blob/master/lib/ruby2js/filter.rb">included</a>:
 
     * `.class` becomes `.constructor`
 
-* <a id="node" * href="https://github.com/rubys/ruby2js/blob/master/spec/node_spec.rb">node</a>
+* <a id="node" href="https://github.com/rubys/ruby2js/blob/master/spec/node_spec.rb">node</a>
 
     * `` `command` `` becomes `child_process.execSync("command", {encoding: "utf8"})`
     * `ARGV` becomes `process.argv.slice(2)`
@@ -511,6 +532,16 @@ the script.
     * maps `export default async proc` to `module.exports = async`
     * maps `export default` to `module.exports =`
 
+* <a id="matchAll" href="https://github.com/rubys/ruby2js/blob/master/spec/matchAll">matchAll</a>
+
+    For ES level < 2020:
+
+    * maps `str.matchAll(pattern).forEach {}` to 
+      `while (match = pattern.exec(str)) {}`
+
+    Note `pattern` must be a simple variable with a value of a regular
+    expression with the `g` flag set at runtime.
+
 [Wunderbar](https://github.com/rubys/wunderbar) includes additional demos:
 
 * [chat](https://github.com/rubys/wunderbar/blob/master/demo/chat.rb),
@@ -532,13 +563,16 @@ conversions are made:
 * `def f(a, (foo, *bar))` becomes `function f(a, [foo, ...bar])`
 * `def a(b=1)` becomes `function a(b=1)`
 * `def a(*b)` becomes `function a(...b)`
-* `.each_key` becomes `for (i of ...) {}`
+* `.each_value` becomes `for (i of ...) {}`
 * `a(*b)` becomes `a(...b)`
 * `"#{a}"` becomes <code>\`${a}\`</code>
 * `lambda {|x| x}` becomes `(x) => {return x}`
 * `proc {|x| x}` becomes `(x) => {x}`
 * `a {|x|}` becomes `a((x) => {})`
 * `class Person; end` becomes `class Person {}`
+* `(0...a).to_a` becomes `[...Array(a).keys()]`
+* `(0..a).to_a` becomes `[...Array(a+1).keys()]`
+* `(b..a).to_a` becomes `Array.from({length: (a-b+1)}, (_, idx) => idx+b)`
 
 ES2015 class support includes constructors, super, methods, class methods,
 instance methods, instance variables, class variables, getters, setters,
@@ -549,6 +583,9 @@ Additionally, the `functions` filter will provide the following conversion:
 * `Array(x)` becomes `Array.from(x)`
 * `.inject(n) {}` becomes `.reduce(() => {}, n)`
 
+Finally, keyword arguments and optional keyword arguments will be mapped to
+parameter detructuring.
+
 ES2016 support
 ---
 
@@ -562,9 +599,57 @@ ES2017 support
 ---
 
 When option `eslevel: 2017` is provided, the following additional
+conversions are made by the `functions` filter:
+
+* `.values()` becomes `Object.values()`
+* `.entries()` becomes `Object.entries()`
+* `.each_pair {}` becomes `for (let [key, value] of Object.entries()) {}'
+
+ES2018 support
+---
+
+When option `eslevel: 2018` is provided, the following additional
 conversion is made by the `functions` filter:
 
-* `.each_entry` becomes `Object.entries().forEach`
+* `.merge` becomes `{...a, ...b}`
+
+Additionally, rest arguments can now be used with keyword arguments and
+optional keyword arguments.
+
+ES2019 support
+---
+
+When option `eslevel: 2019` is provided, the following additional
+conversion is made by the `functions` filter:
+
+* `.flatten` becomes `.flat(Infinity)`
+* `.lstrip` becomes `.trimEnd
+* `.rstrip` becomes `.trimStart
+* `a.to_h` becomes `Object.fromEntries(a)`
+* `Hash[a]` becomes `Object.fromEntries(a)`
+
+Additionally, `rescue` without a variable will map to `catch` without a
+variable.
+
+ES2020 support
+---
+
+When option `eslevel: 2020` is provided, the following additional
+conversions are made:
+
+* `@x` becomes `this.#x`
+* `@@x` becomes `ClassName.#x`
+* `a&.b` becomes `a?.b`
+* `.scan` becomes `Array.from(str.matchAll(/.../g), s => s.slice(1))`
+
+ES2021 support
+---
+
+When option `eslevel: 2021` is provided, the following additional
+conversions are made:
+
+* `x ||= 1` becomes `x ||= 1`
+* `x &&= 1` becomes `x &&= 1`
 
 Picking a Ruby to JS mapping tool
 ---

data/lib/ruby2js.rb

@@ -55,6 +55,7 @@ module Ruby2JS
       def initialize(comments)
         @comments = comments
         @ast = nil
+        @exclude_methods = []
       end
 
       def options=(options)
@@ -81,6 +82,22 @@ module Ruby2JS
         @options[:eslevel] >= 2017
       end
 
+      def es2018
+        @options[:eslevel] >= 2018
+      end
+
+      def es2019
+        @options[:eslevel] >= 2019
+      end
+
+      def es2020
+        @options[:eslevel] >= 2020
+      end
+
+      def es2021
+        @options[:eslevel] >= 2021
+      end
+
       def process(node)
         ast, @ast = @ast, node
         replacement = super
@@ -114,6 +131,9 @@ module Ruby2JS
       def on_sendw(node); on_send(node); end
       def on_undefined?(node); on_defined?(node); end
       def on_nil(node); end
+      def on_xnode(node); end
+      def on_export(node); end
+      def on_import(node); end
 
       # provide a method so filters can call 'super'
       def on_sym(node); node; end
@@ -143,7 +163,7 @@ module Ruby2JS
 
     if Proc === source
       file,line = source.source_location
-      source = File.read(file.dup.untaint).untaint
+      source = IO.read(file)
       ast, comments = parse(source)
       comments = Parser::Source::Comment.associate(ast, comments) if ast
       ast = find_block( ast, line )
@@ -156,9 +176,12 @@ module Ruby2JS
       comments = Parser::Source::Comment.associate(ast, comments) if ast
     end
 
-    filters = options[:filters] || Filter::DEFAULTS
+    filters = (options[:filters] || Filter::DEFAULTS)
 
     unless filters.empty?
+      filters.dup.each do |filter|
+        filters = filter.reorder(filters) if filter.respond_to? :reorder
+      end
 
       filter = Filter::Processor
       filters.reverse.each do |mod|
@@ -176,6 +199,8 @@ module Ruby2JS
     ruby2js.ivars = options[:ivars]
     ruby2js.eslevel = options[:eslevel]
     ruby2js.strict = options[:strict]
+    ruby2js.comparison = options[:comparison] || :equality
+    ruby2js.or = options[:or] || :logical
     if ruby2js.binding and not ruby2js.ivars
       ruby2js.ivars = ruby2js.binding.eval \
         'Hash[instance_variables.map {|var| [var, instance_variable_get(var)]}]'
@@ -201,7 +226,9 @@ module Ruby2JS
     buffer.source = source.encode('utf-8')
     parser = Parser::CurrentRuby.new
     parser.builder.emit_file_line_as_literals=false
-    parser.parse_with_comments(buffer)
+    ast, comments = parser.parse_with_comments(buffer)
+    Parser::CurrentRuby.parse(source.encode('utf-8')) unless ast
+    [ast, comments]
   rescue Parser::SyntaxError => e
     split = source[0..e.diagnostic.location.begin_pos].split("\n")
     line, col = split.length, split.last.length

data/lib/ruby2js/converter.rb

@@ -28,7 +28,7 @@ module Ruby2JS
       :=== => :'!=='
     }
 
-    GROUP_OPERATORS = [:begin, :dstr, :dsym, :and, :or, :casgn]
+    GROUP_OPERATORS = [:begin, :dstr, :dsym, :and, :or, :casgn, :if]
 
     VASGN = [:cvasgn, :ivasgn, :gvasgn, :lvasgn]
 
@@ -57,9 +57,12 @@ module Ruby2JS
       @prototype = nil
       @class_parent = nil
       @class_name = nil
+      @jsx = false
 
       @eslevel = :es5
       @strict = false
+      @comparison = :equality
+      @or = :logical
     end
 
     def width=(width)
@@ -124,7 +127,7 @@ module Ruby2JS
       Parser::AST::Node.new(type, args)
     end
 
-    attr_accessor :strict, :eslevel
+    attr_accessor :strict, :eslevel, :comparison, :or
 
     def es2015
       @eslevel >= 2015
@@ -138,6 +141,22 @@ module Ruby2JS
       @eslevel >= 2017
     end
 
+    def es2018
+      @eslevel >= 2018
+    end
+
+    def es2019
+      @eslevel >= 2019
+    end
+
+    def es2020
+      @eslevel >= 2020
+    end
+
+    def es2021
+      @eslevel >= 2021
+    end
+
     @@handlers = []
     def self.handle(*types, &block)
       types.each do |type| 
@@ -226,7 +245,6 @@ module Ruby2JS
         if ast.loc and ast.loc.expression
           filename = ast.loc.expression.source_buffer.name
           if filename and not filename.empty?
-            filename = filename.dup.untaint
             @timestamps[filename] ||= File.mtime(filename)
           end
         end
@@ -295,6 +313,7 @@ require 'ruby2js/converter/for'
 require 'ruby2js/converter/hash'
 require 'ruby2js/converter/if'
 require 'ruby2js/converter/in'
+require 'ruby2js/converter/import'
 require 'ruby2js/converter/ivar'
 require 'ruby2js/converter/ivasgn'
 require 'ruby2js/converter/kwbegin'
@@ -321,3 +340,4 @@ require 'ruby2js/converter/vasgn'
 require 'ruby2js/converter/while'
 require 'ruby2js/converter/whilepost'
 require 'ruby2js/converter/xstr'
+require 'ruby2js/converter/xnode'

data/lib/ruby2js/converter/args.rb

@@ -7,11 +7,41 @@ module Ruby2JS
    #   (blockarg :c))
 
     handle :args do |*args|
+      kwargs = []
+      while args.last and 
+        [:kwarg, :kwoptarg, :kwrestarg].include? args.last.type
+        kwargs.unshift args.pop
+      end
+
+      if kwargs.length == 1 and kwargs.last.type == :kwrestarg
+        args.push s(:arg, *kwargs.last.children)
+      end
+
+      unless kwargs.empty? or es2015
+        raise NotImplementedError.new('Keyword args require ES2015')
+      end
+
       parse_all(*args, join: ', ')
+      if not kwargs.empty?
+        put ', ' unless args.empty?
+        put '{ '
+        kwargs.each_with_index do |kw, index|
+          put ', ' unless index == 0
+          if kw.type == :kwarg
+            put kw.children.first
+          elsif kw.type == :kwoptarg
+            put kw.children.first; put ' = '; parse kw.children.last
+          elsif kw.type == :kwrestarg
+            raise 'Rest arg requires ES2018' unless es2018
+            put '...'; put kw.children.first
+          end
+        end
+        put ' }'
+      end
     end
 
     handle :mlhs do |*args|
-      if es2015
+      if es2015 or @jsx
         put '['
         parse_all(*args, join: ', ')
         put ']'

data/lib/ruby2js/converter/block.rb

@@ -9,7 +9,7 @@ module Ruby2JS
 
     handle :block do |call, args, block|
 
-      if
+      if \
         @state == :statement and args.children.length == 1 and
         call.children.first and call.children.first.type == :begin and
         call.children[1] == :step and
@@ -42,7 +42,7 @@ module Ruby2JS
           @vars = vars if es2015
         end
 
-      elsif
+      elsif \
         call.children[0] == nil and call.children[1] == :function and
         call.children[2..-1].all? do |child|
           child.type == :lvar or (child.type == :send and

data/lib/ruby2js/converter/casgn.rb

@@ -8,7 +8,9 @@ module Ruby2JS
       multi_assign_declarations if @state == :statement
 
       begin
-        if @state == :statement
+        cbase ||= @rbstack.map {|rb| rb[var]}.compact.last
+
+        if @state == :statement and not cbase
           if es2015
             put "const "
           else
@@ -16,7 +18,6 @@ module Ruby2JS
           end
         end
 
-        cbase ||= @rbstack.map {|rb| rb[var]}.compact.last
         (parse cbase; put '.') if cbase
 
         put "#{ var } = "; parse value

data/lib/ruby2js/converter/class.rb

@@ -37,7 +37,7 @@ module Ruby2JS
       body.compact!
       visible = {}
       body.map! do |m| 
-        if 
+        if \
           @ast.type == :class_module and m.type == :defs and
           m.children.first == s(:self)
         then
@@ -217,7 +217,7 @@ module Ruby2JS
         end
 
         # collapse sequence to a single assignment
-        if 
+        if \
           @ast.type != :class_extend and
           (methods > 1 or (methods == 1 and body[start].type == :prop))
         then