ruby2js 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2414f75bafbcf153ced6b3834b19513f4589d0745ca508eb2169fdc6c190c2f
-  data.tar.gz: b8847a24e1b7f96a5602c84034623c2f3847c17458b521d949fcbd5b9cb9c2b8
+  metadata.gz: b2ad87139fac25c7b097f2ee32c59b141936bb8424cf93a4a20c2d9393495528
+  data.tar.gz: 4de6a0b69d4d496faae496b37c21c66caee4f3793b1241baf134b5a05c85c7f9
 SHA512:
-  metadata.gz: 736f8322e18bad8b0e6b70a6c41337f0db73499193ae0b7137e703bd9093ff8ff30a91610d0db93f6a8b3e9f9df017f42025cb28799fc80d72fe10ddd07a2eb1
-  data.tar.gz: 3faea6f125e9ec36c292be5afda1bf9de5a79c41e1ff8b1c46715a3508d06f977e0eae91cdb543e49899e416ce04d8aa01785244067709b75b50a6fb58da90f1
+  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'
@@ -233,9 +245,10 @@ 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()`
@@ -245,6 +258,7 @@ 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)`
@@ -264,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
@@ -281,6 +296,7 @@ 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>:
@@ -516,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),
@@ -573,9 +599,11 @@ ES2017 support
 ---
 
 When option `eslevel: 2017` is provided, the following additional
-conversion is made by the `functions` filter:
+conversions are made by the `functions` filter:
 
-* `.each_pair` becomes `for (let [key, value] of Object.entries()) {}'
+* `.values()` becomes `Object.values()`
+* `.entries()` becomes `Object.entries()`
+* `.each_pair {}` becomes `for (let [key, value] of Object.entries()) {}'
 
 ES2018 support
 ---
@@ -598,6 +626,7 @@ conversion is made by the `functions` filter:
 * `.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.
@@ -606,10 +635,21 @@ ES2020 support
 ---
 
 When option `eslevel: 2020` is provided, the following additional
-conversion is made:
+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

@@ -94,6 +94,10 @@ module Ruby2JS
         @options[:eslevel] >= 2020
       end
 
+      def es2021
+        @options[:eslevel] >= 2021
+      end
+
       def process(node)
         ast, @ast = @ast, node
         replacement = super
@@ -127,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
@@ -156,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 )
@@ -169,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|
@@ -189,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)]}]'

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
@@ -150,6 +153,10 @@ module Ruby2JS
       @eslevel >= 2020
     end
 
+    def es2021
+      @eslevel >= 2021
+    end
+
     @@handlers = []
     def self.handle(*types, &block)
       types.each do |type| 
@@ -238,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
@@ -307,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'
@@ -333,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

@@ -41,7 +41,7 @@ module Ruby2JS
     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/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

data/lib/ruby2js/converter/class2.rb

@@ -56,10 +56,30 @@ module Ruby2JS
           # find ivars and cvars
           walk = proc do |ast|
             ivars << ast.children.first if ast.type === :ivar
+            ivars << ast.children.first if ast.type === :ivasgn
             cvars << ast.children.first if ast.type === :cvar
+            cvars << ast.children.first if ast.type === :cvasgn
+
             ast.children.each do |child|
               walk[child] if child.is_a? Parser::AST::Node
             end
+
+	    if ast.type == :send and ast.children.first == nil
+	      if ast.children[1] == :attr_accessor
+		ast.children[2..-1].each_with_index do |child_sym, index2|
+		  ivars << :"@#{child_sym.children.first}"
+		end
+	      elsif ast.children[1] == :attr_reader
+		ast.children[2..-1].each_with_index do |child_sym, index2|
+		  ivars << :"@#{child_sym.children.first}"
+		end
+	      elsif ast.children[1] == :attr_writer
+		ast.children[2..-1].each_with_index do |child_sym, index2|
+		  ivars << :"@#{child_sym.children.first}"
+		end
+	      end
+	    end
+
           end
           walk[@ast]
 
@@ -77,7 +97,7 @@ module Ruby2JS
           cvars.to_a.sort.each do |cvar|
             put(index == 0 ? @nl : @sep)
             index += 1
-            put 'static #' + cvar.to_s[2..-1]
+            put 'static #$' + cvar.to_s[2..-1]
           end
 
           while constructor.length > 0 and constructor.first.type == :ivasgn
@@ -131,7 +151,7 @@ module Ruby2JS
                 next
               end
 
-              m = m.updated(m.type, [@prop, m.children[1], *constructor])
+              m = m.updated(m.type, [@prop, m.children[1], s(:begin, *constructor)])
             elsif not m.is_method?
               @prop = "get #{@prop}"
               m = m.updated(m.type, [*m.children[0..1], 
@@ -147,12 +167,13 @@ module Ruby2JS
 
             begin
               @instance_method = m
+              @class_method = nil
               parse m # unless skipped
             ensure
               @instance_method = nil
             end
 
-          elsif 
+          elsif \
             [:defs, :asyncs].include? m.type and m.children.first.type == :self
           then
 
@@ -172,27 +193,35 @@ module Ruby2JS
             @prop.sub! 'static', 'static async' if m.type == :asyncs
 
             m = m.updated(:def, m.children[1..3])
-            parse m
+            begin
+              @instance_method = nil
+              @class_method = m
+              parse m # unless skipped
+            ensure
+              @instance_method = nil
+            end
 
           elsif m.type == :send and m.children.first == nil
+            p = es2020 ? '#' : '_'
+
             if m.children[1] == :attr_accessor
               m.children[2..-1].each_with_index do |child_sym, index2|
                 put @sep unless index2 == 0
                 var = child_sym.children.first
-                put "get #{var}() {#{@nl}return this._#{var}#@nl}#@sep"
-                put "set #{var}(#{var}) {#{@nl}this._#{var} = #{var}#@nl}"
+                put "get #{var}() {#{@nl}return this.#{p}#{var}#@nl}#@sep"
+                put "set #{var}(#{var}) {#{@nl}this.#{p}#{var} = #{var}#@nl}"
               end
             elsif m.children[1] == :attr_reader
               m.children[2..-1].each_with_index do |child_sym, index2|
                 put @sep unless index2 == 0
                 var = child_sym.children.first
-                put "get #{var}() {#{@nl}return this._#{var}#@nl}"
+                put "get #{var}() {#{@nl}return this.#{p}#{var}#@nl}"
               end
             elsif m.children[1] == :attr_writer
               m.children[2..-1].each_with_index do |child_sym, index2|
                 put @sep unless index2 == 0
                 var = child_sym.children.first
-                put "set #{var}(#{var}) {#{@nl}this._#{var} = #{var}#@nl}"
+                put "set #{var}(#{var}) {#{@nl}this.#{p}#{var} = #{var}#@nl}"
               end
             elsif [:private, :protected, :public].include? m.children[1]
               raise Error.new("class #{m.children[1]} is not supported", @ast)
@@ -208,7 +237,7 @@ module Ruby2JS
 
           else
             if m.type == :cvasgn and es2020
-              put 'static #'; put m.children[0].to_s[2..-1]; put ' = '
+              put 'static #$'; put m.children[0].to_s[2..-1]; put ' = '
               parse m.children[1]
             else
               skipped = true

data/lib/ruby2js/converter/cvar.rb

@@ -4,7 +4,7 @@ module Ruby2JS
     # (cvar :@@a)
 
     handle :cvar do |var|
-      prefix = es2020 ? '#' : '_'
+      prefix = es2020 ? '#$' : '_'
 
       @class_name ||= nil
       if @class_name

data/lib/ruby2js/converter/cvasgn.rb

@@ -7,7 +7,7 @@ module Ruby2JS
     handle :cvasgn do |var, expression=nil|
       multi_assign_declarations if @state == :statement
 
-      prefix = es2020 ? '#' : '_'
+      prefix = es2020 ? '#$' : '_'
 
       if @class_name
         parse @class_name

data/lib/ruby2js/converter/def.rb

@@ -88,7 +88,7 @@ module Ruby2JS
       put 'async ' if @ast.type == :async
 
       # es2015 fat arrow support
-      if 
+      if \
         not name and es2015 and @state != :method and @ast.type != :defm and 
         not @prop
       then
@@ -105,7 +105,7 @@ module Ruby2JS
           else
             style = :expression
           end
-        elsif 
+        elsif \
           expr.type == :if and expr.children[1] and expr.children[2] and
           EXPRESSIONS.include? expr.children[1].type and
           EXPRESSIONS.include? expr.children[2].type

data/lib/ruby2js/converter/for.rb

@@ -10,6 +10,13 @@ module Ruby2JS
     #   (...)
 
     handle :for, :for_of do |var, expression, block|
+      if @jsx and @ast.type == :for_of
+        parse s(:block, s(:send, expression, :map),
+         s(:args, s(:arg, var.children[0])),
+         s(:autoreturn, block))
+        return
+      end
+
       begin
         vars = @vars.dup
         next_token, @next_token = @next_token, :continue