ruby2js 3.3.5 → 3.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 290afa338befd02c8b83d54b13032a5e2d59c8a9cb96f2c413042d069c2614f8
-  data.tar.gz: ed8506fa6b7dfbdcec3c59f6496a4cae822b18e597fb7030a10ae403d8b7c942
+  metadata.gz: 8995ca731fa2bedb5306084bca13f70aa01c269a3b3ac9b6c0ace540a0d58fae
+  data.tar.gz: 71c6cbb010ddf18f67623307c469f1ce4f55c4938c33a9e3172161f71819de87
 SHA512:
-  metadata.gz: 3bfe229a4ac6718d7a79cc41d2ef8b014ac49c4f73366791ffb2b2487b1661dc9a74d91672f866464ba00b83dcbae464b4d1ce0f602aa37fef7c59cd0c2865be
-  data.tar.gz: 9a2a2c7feb84284009900ece1a605922de023fb3173158799fb889cfd0d4ac6ff12d10cfbafa062e8cb133024ee58be204d0abc8fd7ef76d0b8fc20714069346
+  metadata.gz: b51e4838e7180248ffb00debab0758049dcc6a989bcc4b9e1087fb7112ac1a8142507c96e21309b23c3b69d987065e9d7fafb91dd0a7d8961b25f125fafc3788
+  data.tar.gz: fe7b943fc51b4f1685b5cc7020c969101d7a9aa17834bc6a8af746fdbe9472f9cc55960ef464f8dcfc10125598d6966a8cf38322ce432ec88e6dd787a49158ac

data/README.md

@@ -5,6 +5,7 @@ Minimal yet extensible Ruby to JavaScript conversion.
 
 [![Build Status](https://travis-ci.org/rubys/ruby2js.svg)](https://travis-ci.org/rubys/ruby2js)
 [![Gem Version](https://badge.fury.io/rb/ruby2js.svg)](https://badge.fury.io/rb/ruby2js)
+[![Gitter](https://badges.gitter.im/ruby2js/community.svg)](https://gitter.im/ruby2js/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
 
 Description
 ---
@@ -80,6 +81,12 @@ require 'ruby2js/filter/functions'
 puts Ruby2JS.convert('"2A".to_i(16)')
 ```
 
+Host variable substitution:
+
+```ruby
+ puts Ruby2JS.convert("@name", ivars: {:@name => "Joe"})
+```
+
 Enable ES2015 support:
 
 ```ruby
@@ -104,6 +111,13 @@ Emit nullish coalescing operators:
 puts Ruby2JS.convert('a || 1', or: :nullish)
 ```
 
+Emit underscored private fields (allowing subclass access):
+
+```ruby
+puts Ruby2JS.convert('class C; def initialize; @f=1; end; end',
+  eslevel: 2020, underscored_private: true)
+```
+
 With [ExecJS](https://github.com/sstephenson/execjs):
 ```ruby
 require 'ruby2js/execjs'
@@ -193,7 +207,7 @@ Integrations
 
 While this is a low level library suitable for DIY integration, one of the
 obvious uses of a tool that produces JavaScript is by web servers.  Ruby2JS
-includes three such integrations:
+includes several integrations:
 
 *  [CGI](https://github.com/rubys/ruby2js/blob/master/lib/ruby2js/cgi.rb)
 *  [Sinatra](https://github.com/rubys/ruby2js/blob/master/lib/ruby2js/sinatra.rb)
@@ -204,6 +218,9 @@ As you might expect, CGI is a bit sluggish.  By contrast, Sinatra and Rails
 are quite speedy as the bulk of the time is spent on the initial load of the
 required libraries.
 
+For easy integration with Webpack (and Webpacker in Rails 5+), you can use the
+[rb2js-loader](https://github.com/whitefusionhq/rb2js-loader) plugin.
+
 Filters
 ---
 
@@ -226,8 +243,10 @@ the script.
 
 * <a id="functions" href="https://github.com/rubys/ruby2js/blob/master/lib/ruby2js/filter/functions.rb">functions</a>
 
+    * `.abs` becomes `Math.abs()`
     * `.all?` becomes `.every`
     * `.any?` becomes `.some`
+    * `.ceil` becomes `Math.ceil()`
     * `.chr` becomes `fromCharCode`
     * `.clear` becomes `.length = 0`
     * `.delete` becomes `delete target[arg]`
@@ -242,6 +261,7 @@ the script.
     * `.find_index` becomes `findIndex`
     * `.first` becomes `[0]`
     * `.first(n)` becomes `.slice(0, n)`
+    * `.floor` becomes `Math.floor()`
     * `.gsub` becomes `replace(//g)`
     * `.include?` becomes `.indexOf() != -1`
     * `.inspect` becomes `JSON.stringify()`
@@ -270,10 +290,12 @@ the script.
     * `(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`
+    * `.tap {|n| n}` becomes `(function(n) {n; return n})(...)`
     * `.to_f` becomes `parseFloat`
     * `.to_i` becomes `parseInt`
     * `.to_s` becomes `.to_String`
     * `.upcase` becomes `.toUpperCase`
+    * `.yield_self {|n| n}` becomes `(function(n) {return n})(...)`
     * `[-n]` becomes `[*.length-n]` for literal values of `n`
     * `[n...m]` becomes `.slice(n,m)`
     * `[n..m]` becomes `.slice(n,m+1)`
@@ -297,12 +319,78 @@ the script.
       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(...)`
+    * `block_given?` will check for the presence of optional argument `_implicitBlockYield` which is a function made accessible through the use of `yield` in a method body.
 
     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>:
+    included (pass `include: :class` as a `convert` option to enable):
 
     * `.class` becomes `.constructor`
 
+* <a id="tagged_templates" href="https://github.com/rubys/ruby2js/blob/master/lib/ruby2js/filter/tagged_templates.rb">tagged_templates</a>
+
+    Allows you to turn certain method calls with a string argument into tagged
+    template literals. By default it supports html and css, so you can write
+    `html "<div>#{1+2}</div>"` which converts to `` html`<div>${1+2}</div>` ``.
+    Works nicely with squiggly heredocs for multi-line templates as well. If you
+    need to configure the tag names yourself, pass a `template_literal_tags`
+    option to `convert` with an array of tag name symbols.
+
+    Note: these conversions are only done if eslevel >= 2015
+
+* <a href="https://github.com/rubys/ruby2js/blob/master/lib/ruby2js/filter/esm.rb">esm</a>
+
+    Provides conversion of import and export statements for use with modern ES builders like Webpack.
+
+    Examples:
+
+    **import**
+
+    ```ruby
+    import "./index.scss"
+    # => import "./index.scss"
+
+    import Something from "./lib/something"
+    # => import Something from "./lib/something"
+
+    import Something, "./lib/something"
+    # => import Something from "./lib/something"
+
+    import [ LitElement, html, css ], from: "lit-element"
+    # => import { LitElement, html, css } from "lit-element"
+
+    import React, from: "react"
+    # => import React from "react"
+
+    import React, as: "*", from: "react"
+    # => import React as * from "react"
+    ```
+
+    **export**
+
+    ```ruby
+    export hash = { ab: 123 }
+    # => export const hash = {ab: 123};
+
+    export func = ->(x) { x * 10 }
+    # => export const func = x => x * 10;
+
+    export def multiply(x, y)
+      return x * y
+    end
+    # => export function multiply(x, y) {
+    #      return x * y
+    #    }
+
+    export default class MyClass
+    end
+    # => export default class MyClass {
+    #    };
+
+    # or final export statement:
+    export [ one, two, default: three ]
+    # => export { one, two, three as default }
+    ```
+
 * <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"})`
@@ -388,68 +476,6 @@ the script.
     * `text` becomes `textContent`
     * `to_html` becomes `outerHTML`
 
-* <a id="rubyjs" href="https://github.com/rubys/ruby2js/blob/master/spec/rubyjs_spec.rb">rubyjs</a>
-    * `.at()` becomes `_a.at()`
-    * `.between?()` becomes `R().between()`
-    * `.capitalize()` becomes `_s.capitalize()`
-    * `.center()` becomes `_s.center()`
-    * `.chomp()` becomes `_s.chomp()`
-    * `.collect_concat()` becomes `_e.collect_concat()`
-    * `.compact()` becomes `_a.compact()`
-    * `.compact!()` becomes `_a.compact_bang()`
-    * `.count()` becomes `_e.count()`
-    * `.cycle()` becomes `_e.cycle()`
-    * `.delete_at()` becomes `_a.delete_at()`
-    * `.delete_if()` becomes `_a.delete_if()`
-    * `.drop_while()` becomes `_e.drop_while()`
-    * `.each_index()` becomes `_e.each_index()`
-    * `.each_slice()` becomes `_e.each_slice()`
-    * `.each_with_index()` becomes `_e.each_with_index()`
-    * `.each_with_object()` becomes `_e.each_with_object()`
-    * `.find_all()` becomes `_e.find_all()`
-    * `.find()` becomes `_e.find()`
-    * `.flat_map()` becomes `_e.flat_map()`
-    * `.flatten()` becomes `_a.flatten()`
-    * `.grep()` becomes `_e.grep()`
-    * `.group_by()` becomes `_e.group_by()`
-    * `.inject()` becomes `_e.inject()`
-    * `.insert()` becomes `_a.insert()`
-    * `.keep_if()` becomes `_a.keep_if()`
-    * `.ljust()` becomes `_s.ljust()`
-    * `.lstrip()` becomes `_s.lstrip()`
-    * `.map()` becomes `_e.map()`
-    * `.max_by()` becomes `_e.max_by()`
-    * `.min_by()` becomes `_e.min_by()`
-    * `.one?()` becomes `_e.one()`
-    * `.partition()` becomes `_e.partition()`
-    * `.reject()` becomes `_e.reject()`
-    * `.reverse()` becomes `_a.reverse()`
-    * `.reverse!()` becomes `_a.reverse_bang()`
-    * `.reverse_each()` becomes `_e.reverse_each()`
-    * `.rindex()` becomes `_s.rindex()`
-    * `.rjust()` becomes `_s.rjust()`
-    * `.rotate()` becomes `_a.rotate()`
-    * `.rotate!()` becomes `_a.rotate_bang()`
-    * `.rstrip()` becomes `_s.rstrip()`
-    * `.scan()` becomes `_s.scan()`
-    * `.select()` becomes `_a.select()`
-    * `.shift()` becomes `_a.shift()`
-    * `.shuffle()` becomes `_a.shuffle()`
-    * `.shuffle!()` becomes `_a.shuffle_bang()`
-    * `.slice()` becomes `_a.slice()`
-    * `.slice!()` becomes `_a.slice_bang()`
-    * `.sort_by()` becomes `_e.sort_by()`
-    * `.strftime()` becomes `_t.strftime()`
-    * `.swapcase()` becomes `_s.swapcase()`
-    * `.take_while()` becomes `_e.take_while(`)
-    * `.transpose()` becomes `_a.transpose()`
-    * `.tr()` becomes `_s.tr()`
-    * `.union()` becomes `_a.union()`
-    * `.uniq()` becomes `_a.uniq()`
-    * `.uniq!()` becomes `_a.uniq_bang()`
-    * `<=>` becomes `R.Comparable.cmp()`
-    * `(n..m)` becomes `R.Range.new()`
-
 * <a id="underscore" href="https://github.com/rubys/ruby2js/blob/master/spec/underscore.rb">underscore</a>
 
     * `.clone()` becomes `_.clone()`
@@ -605,6 +631,14 @@ conversions are made by the `functions` filter:
 * `.entries()` becomes `Object.entries()`
 * `.each_pair {}` becomes `for (let [key, value] of Object.entries()) {}'
 
+async support:
+
+* `async def` becomes `async function`
+* `async lambda` becomes `async =>`
+* `async proc` becomes `async =>`
+* `async ->` becomes `async =>`
+* `foo bar, async do...end` becomes `foo(bar, async () => {})`
+
 ES2018 support
 ---
 
@@ -677,7 +711,7 @@ License
 
 (The MIT License)
 
-Copyright (c) 2009, 2013 Macario Ortega, Sam Ruby
+Copyright (c) 2009, 2020 Macario Ortega, Sam Ruby, Jared White
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/ruby2js.rb

@@ -17,6 +17,7 @@ module Ruby2JS
 
   @@eslevel_default = 2009 # ecmascript 5
   @@strict_default = false
+  @@module_default = nil
 
   def self.eslevel_default
     @@eslevel_default
@@ -34,6 +35,14 @@ module Ruby2JS
     @@strict_default = level
   end
 
+  def self.module_default
+    @@module_default
+  end
+
+  def self.module_default=(module_type)
+    @@module_default = module_type
+  end
+
   module Filter
     DEFAULTS = []
 
@@ -52,10 +61,14 @@ module Ruby2JS
       include Ruby2JS::Filter
       BINARY_OPERATORS = Converter::OPERATORS[2..-1].flatten
 
+      attr_accessor :prepend_list
+
       def initialize(comments)
         @comments = comments
         @ast = nil
         @exclude_methods = []
+        @esm = false
+        @prepend_list = Set.new
       end
 
       def options=(options)
@@ -134,6 +147,7 @@ module Ruby2JS
       def on_xnode(node); end
       def on_export(node); end
       def on_import(node); end
+      def on_taglit(node); end
 
       # provide a method so filters can call 'super'
       def on_sym(node); node; end
@@ -160,6 +174,7 @@ module Ruby2JS
   def self.convert(source, options={})
     options[:eslevel] ||= @@eslevel_default
     options[:strict] = @@strict_default if options[:strict] == nil
+    options[:module] ||= @@module_default || :esm
 
     if Proc === source
       file,line = source.source_location
@@ -191,6 +206,11 @@ module Ruby2JS
 
       filter.options = options
       ast = filter.process(ast)
+
+      if filter.prepend_list
+        prepend = filter.prepend_list.sort_by {|ast| ast.type == :import ? 0 : 1}
+        ast = Parser::AST::Node.new(:begin, [*prepend, ast])
+      end
     end
 
     ruby2js = Ruby2JS::Converter.new(ast, comments)
@@ -201,6 +221,8 @@ module Ruby2JS
     ruby2js.strict = options[:strict]
     ruby2js.comparison = options[:comparison] || :equality
     ruby2js.or = options[:or] || :logical
+    ruby2js.module_type = options[:module] || :esm
+    ruby2js.underscored_private = (options[:eslevel] < 2020) || options[:underscored_private]
     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

@@ -3,9 +3,11 @@ require 'ruby2js/serializer'
 module Ruby2JS
   class Error < NotImplementedError
     def initialize(message, ast)
-      message += ' at ' + ast.loc.expression.source_buffer.name.to_s
-      message += ':' + ast.loc.expression.line.inspect
-      message += ':' + ast.loc.expression.column.to_s
+      if ast.loc
+        message += ' at ' + ast.loc.expression.source_buffer.name.to_s
+        message += ':' + ast.loc.expression.line.inspect
+        message += ':' + ast.loc.expression.column.to_s
+      end
       super(message)
     end
   end
@@ -63,6 +65,7 @@ module Ruby2JS
       @strict = false
       @comparison = :equality
       @or = :logical
+      @underscored_private = true
     end
 
     def width=(width)
@@ -127,7 +130,7 @@ module Ruby2JS
       Parser::AST::Node.new(type, args)
     end
 
-    attr_accessor :strict, :eslevel, :comparison, :or
+    attr_accessor :strict, :eslevel, :module_type, :comparison, :or, :underscored_private
 
     def es2015
       @eslevel >= 2015
@@ -332,6 +335,7 @@ require 'ruby2js/converter/self'
 require 'ruby2js/converter/send'
 require 'ruby2js/converter/super'
 require 'ruby2js/converter/sym'
+require 'ruby2js/converter/taglit'
 require 'ruby2js/converter/undef'
 require 'ruby2js/converter/until'
 require 'ruby2js/converter/untilpost'
@@ -341,3 +345,4 @@ require 'ruby2js/converter/while'
 require 'ruby2js/converter/whilepost'
 require 'ruby2js/converter/xstr'
 require 'ruby2js/converter/xnode'
+require 'ruby2js/converter/yield'

data/lib/ruby2js/converter/block.rb

@@ -9,6 +9,11 @@ module Ruby2JS
 
     handle :block do |call, args, block|
 
+      if es2017 and call.children.last == s(:send, nil, :async)
+        return parse call.updated(nil, [*call.children[0..-2],
+        s(:send, nil, :async, s(:block, s(:send, nil, :proc), args, block))])
+      end
+
       if \
         @state == :statement and args.children.length == 1 and
         call.children.first and call.children.first.type == :begin and

data/lib/ruby2js/converter/class2.rb

@@ -49,7 +49,7 @@ module Ruby2JS
         end
 
         # private variable declarations
-        if es2020
+        unless underscored_private
           ivars = Set.new
           cvars = Set.new
 
@@ -202,7 +202,7 @@ module Ruby2JS
             end
 
           elsif m.type == :send and m.children.first == nil
-            p = es2020 ? '#' : '_'
+            p = underscored_private ? '_' : '#'
 
             if m.children[1] == :attr_accessor
               m.children[2..-1].each_with_index do |child_sym, index2|
@@ -236,7 +236,7 @@ module Ruby2JS
             end
 
           else
-            if m.type == :cvasgn and es2020
+            if m.type == :cvasgn and !underscored_private
               put 'static #$'; put m.children[0].to_s[2..-1]; put ' = '
               parse m.children[1]
             else
@@ -288,6 +288,12 @@ module Ruby2JS
                 [name, innerclass_name.children[1]])
             end
             parse m.updated(nil, [innerclass_name, *m.children[1..-1]])
+          elsif m.type == :send && (m.children[0].nil? || m.children[0].type == :self)
+            if m.children[0].nil?
+              parse m.updated(:send, [@class_name, *m.children[1..-1]])
+            else
+              parse m.updated(:send, [@class_name, *m.children[1..-1]])
+            end
           else
             parse m, :statement
           end

data/lib/ruby2js/converter/cvar.rb

@@ -4,7 +4,7 @@ module Ruby2JS
     # (cvar :@@a)
 
     handle :cvar do |var|
-      prefix = es2020 ? '#$' : '_'
+      prefix = underscored_private ? '_' : '#$'
 
       @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 = underscored_private ? '_' : '#$'
 
       if @class_name
         parse @class_name