opal 0.9.0.beta2 → 0.9.0.rc1

data/CONTRIBUTING.md

@@ -23,6 +23,8 @@ the guides.
 
 If unsure about having satisfied any of the above points ask in the [Gitter channel](https://gitter.im/opal/opal) or just open the issue/pull-request asking for help. There's a good chance someone will help you through the necessary steps.
 
+**A note on squashing commits in pull-requests:** There's no need to have a single commit in a PR, rather it's better to have focused commits with specific changes and just avoid the sequence of changes and reverts that tell an interesting story but make the use of `git blame` quite problematic. _That said these are quite loose requirements in the spirit of keeping contributing enjoyable 🤓_
+
 ## Quick Start
 
 Fork https://github.com/opal/opal, then clone the fork to your machine:
@@ -194,3 +196,42 @@ Array#permutation_truncates_Float_arguments
 Array#permutation_returns_an_Enumerator_which_works_as_expected_even_when_the_array_was_modified                              0.056
 Array#permutation_generates_from_a_defensive_copy,_ignoring_mutations                                                         0.038
 ```
+
+
+## Parser
+
+## Enabling debug output from Racc
+
+To enable debug output in the Racc grammar set the `RACC_DEBUG` env var and recompile the grammar. While the env variable is set the parser will output the debug info for the parsing process.
+
+```bash
+$ export RACC_DEBUG=true
+$ bundle exec rake racc               # recompile the grammar
+$ bundle exec bin/opal --sexp -e "42" # ask Opal for the SExp of some code
+
+read    :tINTEGER(tINTEGER) [42, [1, 0]]
+
+shift   tINTEGER
+        [ (tINTEGER [42, [1, 0]]) ]
+
+…cut…
+
+shift   $end
+        [ (program (:int, 42)) ($end [false, [1, 2]]) ($end [false, [1, 2]]) ]
+
+goto    403
+        [ 0 1 97 403 ]
+
+accept
+
+(:int, 42)
+```
+
+When done unset the env variable and recompile the grammar.
+
+```bash
+$ unset RACC_DEBUG
+$ bundle exec rake racc               # recompile the grammar
+$ bundle exec bin/opal --sexp -e "42" # ask Opal for the SExp of some code
+(:int, 42)
+```

data/README.md

@@ -11,7 +11,7 @@ Opal is [hosted on GitHub](http://github.com/opal/opal). Chat is available on *G
 Ask questions on [stackoverflow (tag #opalrb)](http://stackoverflow.com/questions/ask?tags=opalrb). Get the [Opalist newsletter](http://opalist.co) for updates and community news.
 
 [![Inline docs](http://inch-ci.org/github/opal/opal.svg?branch=master&style=flat)](http://opalrb.org/docs/api)
-[![Gitter chat](http://img.shields.io/badge/gitter-opal%2Fopal-009966.svg?style=flat)](https://gitter.im/opal/opal)
+[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/opal/opal?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
 [![Stack Overflow](http://img.shields.io/badge/stackoverflow-%23opalrb-orange.svg?style=flat)](http://stackoverflow.com/questions/ask?tags=opalrb)
 
 ## Usage
@@ -29,7 +29,7 @@ puts 'Hello world!'
 Then from the terminal
 
 ```bash
-$ opal --compile app.rb > app.js # The Opal runtime is included by default but
+$ opal --compile app.rb > app.js # The Opal runtime is included by default
                                  # but can be skipped with the --no-opal flag
 ```
 
@@ -168,20 +168,20 @@ What code is supposed to run where?
 * `opal/` is the runtime+corelib for our implementation (runs in browser).
 * `stdlib/` is our implementation of Ruby's stdlib. It is optional (runs in browser).
 
-### lib
+### lib/
 
-The `lib` directory holds the Opal parser/compiler used to compile Ruby
+The `lib` directory holds the **Opal parser/compiler** used to compile Ruby
 into JavaScript. It is also built ready for the browser into `opal-parser.js`
 to allow compilation in any JavaScript environment.
 
-### corelib
+### opal/
 
-This directory holds the Opal runtime and corelib implemented in Ruby and
+This directory holds the **Opal runtime and corelib** implemented in Ruby and
 JavaScript.
 
-### stdlib
+### stdlib/
 
-Holds the stdlib that Opal currently supports. This includes `Observable`,
+Holds the **stdlib currently supported by Opal**. This includes `Observable`,
 `StringScanner`, `Date`, etc.
 
 ## Browser support

data/Rakefile

@@ -11,4 +11,4 @@ import 'tasks/building.rake'
 import 'tasks/linting.rake'
 import 'tasks/benchmarking.rake'
 
-task :default => [:rspec, :mspec_node, :cruby_tests]
+task :default => [:rspec, :mspec_nodejs, :cruby_tests]

data/lib/opal/cli.rb

@@ -76,6 +76,7 @@ module Opal
                   when :nodejs;      CliRunners::Nodejs.new(output)
                   when :phantomjs;   CliRunners::Phantomjs.new(output)
                   when :applescript; CliRunners::AppleScript.new(output)
+                  when :nashorn;     CliRunners::Nashorn.new(output)
                   else raise ArgumentError, @runner_type.inspect
                   end
     end

data/lib/opal/cli_options.rb

@@ -84,7 +84,7 @@ module Opal
         options[:compile] = true
       end
 
-      on('-R', '--runner RUNNER', %w[nodejs server phantomjs applescript], 'Choose the runner: nodejs (default), server') do |runner|
+      on('-R', '--runner RUNNER', %w[nodejs server phantomjs applescript nashorn], 'Choose the runner: nodejs (default), server') do |runner|
         options[:runner] = runner.to_sym
       end
 
@@ -93,7 +93,7 @@ module Opal
         options[:port] = port.to_i
       end
 
-      on('--no-exit', 'Do not append a Kernel#exit at the end of file') do |no_exit|
+      on('-E', '--no-exit', 'Do not append a Kernel#exit at the end of file') do |no_exit|
         options[:no_exit] = true
       end
 

data/lib/opal/cli_runners.rb

@@ -9,3 +9,4 @@ require 'opal/cli_runners/apple_script'
 require 'opal/cli_runners/phantomjs'
 require 'opal/cli_runners/nodejs'
 require 'opal/cli_runners/server'
+require 'opal/cli_runners/nashorn'

data/lib/opal/cli_runners/nashorn.rb

@@ -0,0 +1,58 @@
+require 'opal/cli_runners'
+require 'opal/paths'
+
+module Opal
+  module CliRunners
+    class Nashorn
+      def initialize(output)
+        @output ||= output
+      end
+      attr_reader :output, :exit_status
+
+      def puts(*args)
+        output.puts(*args)
+      end
+
+      def run(code, argv)
+        require 'tempfile'
+        tempfile = Tempfile.new('opal-nashorn-runner-')
+        tempfile.write code
+        tempfile.close
+        system_with_output({}, 'jjs', tempfile.path , *argv)
+      rescue Errno::ENOENT
+        raise MissingNashorn, 'Please install JDK to be able to run Opal scripts.'
+      end
+
+      # Let's support fake IO objects like StringIO
+      def system_with_output(env, *cmd)
+        if IO.try_convert(output)
+          system(env,*cmd)
+          @exit_status = $?.exitstatus
+          return
+        end
+
+        if RUBY_PLATFORM == 'java'
+          # JRuby has issues in dealing with subprocesses (at least up to 1.7.15)
+          # @headius told me it's mostly fixed on master, but while we wait for it
+          # to ship here's a tempfile workaround.
+          require 'tempfile'
+          require 'shellwords'
+          tempfile = Tempfile.new('opal-nashorn-output')
+          system(env,cmd.shelljoin+" > #{tempfile.path}")
+          @exit_status = $?.exitstatus
+          captured_output = File.read tempfile.path
+          tempfile.close
+        else
+          require 'open3'
+          captured_output, status = Open3.capture2(env,*cmd)
+          @exit_status = status.exitstatus
+        end
+
+        output.write captured_output
+      end
+
+      class MissingNashorn < RunnerError
+      end
+    end
+  end
+end

data/lib/opal/cli_runners/phantom.js

@@ -33,12 +33,14 @@ page.onCallback = function(data) {
   }
 };
 
-page.content =  '<!doctype html>'+
-                '<html>'+
-                '  <head><meta charset="utf-8"/></head>'+
-                "  <body><script>//<![CDATA[\n"+
-                opal_code+
-                "  //]]></script>"+
-                '  <script>callPhantom(["exit", 0]);</script></body>\n'+
-                '  </body>'+
-                '</html>';
+
+page.onInitialized = function() {
+  page.evaluate('function(code) {window.eval(code)}', opal_code)
+};
+
+page.setContent("<!doctype html>\n"+
+                "<html>"+
+                "<head><meta charset='utf-8'/></head><body>"+
+                "</body></html>",
+                'http://www.example.com');
+

data/lib/opal/compiler.rb

@@ -116,6 +116,8 @@ module Opal
     # are operators compiled inline
     compiler_option :inline_operators, true, :as => :inline_operators?
 
+    compiler_option :eval, false, as: :eval?
+
     # @return [String] The compiled ruby code
     attr_reader :result
 

data/lib/opal/erb.rb

@@ -71,7 +71,8 @@ module Opal
 
       def find_code(result)
         result.gsub(/<%([\s\S]+?)%>/) do
-          "\")\n#{ $1 }\noutput_buffer.append(\""
+          inner = $1.gsub(/\\"/, '"')
+          "\")\n#{ inner }\noutput_buffer.append(\""
         end
       end
 

data/lib/opal/nodes/def.rb

@@ -79,14 +79,22 @@ module Opal
             scope.locals.delete(rest_arg[1])
           end
 
+          if scope.uses_zuper
+            add_local '$zuper'
+            add_local '$zuper_index'
+
+            line "$zuper = [];"
+            line "for($zuper_index = 0; $zuper_index < arguments.length; $zuper_index++) {"
+            line "  $zuper[$zuper_index] = arguments[$zuper_index];"
+            line "}"
+          end
+
           unshift "\n#{current_indent}", scope.to_vars
 
           line arity_code if arity_code
 
           line stmt_code
 
-          unshift "var $zuper = $slice.call(arguments, 0);" if scope.uses_zuper
-
           if scope.catch_return
             unshift "try {\n"
             line "} catch ($returner) { if ($returner === Opal.returner) { return $returner.$v }"
@@ -139,11 +147,12 @@ module Opal
       def compile_rest_arg
         if rest_arg and rest_arg[1]
           splat = variable(rest_arg[1].to_sym)
+          add_local '$splat_index'
           line "var array_size = arguments.length - #{argc};"
           line "if(array_size < 0) array_size = 0;"
           line "var #{splat} = new Array(array_size);"
-          line "for(var arg_index = 0; arg_index < array_size; arg_index++) {"
-          line "  #{splat}[arg_index] = arguments[arg_index + #{argc}];"
+          line "for($splat_index = 0; $splat_index < array_size; $splat_index++) {"
+          line "  #{splat}[$splat_index] = arguments[$splat_index + #{argc}];"
           line "}"
         end
       end
@@ -199,14 +208,14 @@ module Opal
             arg_name = kwarg[1]
             var_name = variable(arg_name.to_s)
             add_local var_name
-            line "if ((#{var_name} = $kwargs.smap['#{arg_name}']) == null) {"
+            line "if ((#{var_name} = $kwargs.$$smap['#{arg_name}']) == null) {"
             line "  #{var_name} = ", expr(kwarg[2])
             line "}"
           when :kwarg
             arg_name = kwarg[1]
             var_name = variable(arg_name.to_s)
             add_local var_name
-            line "if ((#{var_name} = $kwargs.smap['#{arg_name}']) == null) {"
+            line "if ((#{var_name} = $kwargs.$$smap['#{arg_name}']) == null) {"
             line "  throw new Error('expecting keyword arg: #{arg_name}')"
             line "}"
           when :kwrestarg

data/lib/opal/nodes/helpers.rb

@@ -12,7 +12,7 @@ module Opal
       ES3_RESERVED_WORD_EXCLUSIVE = /#{REGEXP_START}(?:int|byte|char|goto|long|final|float|short|double|native|throws|boolean|abstract|volatile|transient|synchronized)#{REGEXP_END}/
 
       # Prototype special properties.
-      PROTO_SPECIAL_PROPS = /#{REGEXP_START}(?:constructor|__proto__|__parent__|__noSuchMethod__|__count__)#{REGEXP_END}/
+      PROTO_SPECIAL_PROPS = /#{REGEXP_START}(?:constructor|displayName|__proto__|__parent__|__noSuchMethod__|__count__)#{REGEXP_END}/
 
       # Prototype special methods.
       PROTO_SPECIAL_METHODS = /#{REGEXP_START}(?:hasOwnProperty|valueOf)#{REGEXP_END}/

data/lib/opal/nodes/literal.rb

@@ -129,7 +129,7 @@ module Opal
             push part.inspect
           elsif part.type == :evstr
             push "("
-            push expr(part[1])
+            push part[1] ? expr(part[1]) : '""'
             push ")"
           elsif part.type == :str
             push part[1].inspect

data/lib/opal/nodes/masgn.rb

@@ -3,58 +3,108 @@ require 'opal/nodes/base'
 module Opal
   module Nodes
     class MassAssignNode < Base
-      handle :masgn
+      # TODO: does this work for cvars?? constants??
+      SIMPLE_ASSIGNMENT = [:lasgn, :iasgn, :lvar, :gasgn]
 
+      handle :masgn
       children :lhs, :rhs
 
       def compile
-        tmp = scope.new_temp
-        len = 0 # how many rhs items are we sure we have
+        array = scope.new_temp
 
         if rhs.type == :array
-          len = rhs.size - 1
-          push "#{tmp} = ", expr(rhs)
+          push "#{array} = ", expr(rhs)
+          compile_masgn(lhs.children, array, rhs.size - 1)
+          push ", #{array}" # a mass assignment evaluates to the RHS
         elsif rhs.type == :to_ary
-          push "#{tmp} = Opal.to_ary(", expr(rhs[1]), ")"
+          retval = scope.new_temp
+          push "#{retval} = ", expr(rhs[1])
+          push ", #{array} = Opal.to_ary(#{retval})"
+          compile_masgn(lhs.children, array)
+          push ", #{retval}"
+          scope.queue_temp(retval)
         elsif rhs.type == :splat
-          push "#{tmp} = Opal.to_a(", expr(rhs[1]), ")"
+          push "#{array} = Opal.to_a(", expr(rhs[1]), ")"
+          compile_masgn(lhs.children, array)
+          push ", #{array}"
         else
           raise "unsupported mlhs type"
         end
 
-        lhs.children.each_with_index do |child, idx|
-          push ', '
+        scope.queue_temp(array)
+      end
+
+      # 'len' is how many rhs items are we sure we have
+      def compile_masgn(lhs_items, array, len = nil)
+        pre_splat  = lhs_items.take_while { |child| child.type != :splat }
+        post_splat = lhs_items.drop(pre_splat.size)
+
+        pre_splat.each_with_index do |child, idx|
+          compile_assignment(child, array, idx, len)
+        end
+
+        unless post_splat.empty?
+          splat = post_splat.shift
 
-          if child.type == :splat
-            if part = child[1]
-              part = part.dup
-              part << s(:js_tmp, "$slice.call(#{tmp}, #{idx})")
+          if post_splat.empty? # trailing splat
+            if part = splat[1]
+              part = part.dup << s(:js_tmp, "$slice.call(#{array}, #{pre_splat.size})")
+              push ', '
               push expr(part)
             end
           else
-            if idx >= len
-              assign = s(:js_tmp, "(#{tmp}[#{idx}] == null ? nil : #{tmp}[#{idx}])")
-            else
-              assign = s(:js_tmp, "#{tmp}[#{idx}]")
+            tmp = scope.new_temp # end index for items consumed by splat
+            push ", #{tmp} = #{array}.length - #{post_splat.size}"
+            push ", #{tmp} = (#{tmp} < #{pre_splat.size}) ? #{pre_splat.size} : #{tmp}"
+
+            if part = splat[1]
+              part = part.dup << s(:js_tmp, "$slice.call(#{array}, #{pre_splat.size}, #{tmp})")
+              push ', '
+              push expr(part)
             end
 
-            part = child.dup
-            if child.type == :lasgn or child.type == :iasgn or child.type == :lvar or child.type == :gasgn
-              part << assign
-            elsif child.type == :call
-              part[2] = "#{part[2]}=".to_sym
-              part.last << assign
-            elsif child.type == :attrasgn
-              part.last << assign
-            else
-              raise "Bad lhs for masgn"
+            post_splat.each_with_index do |child, idx|
+              if idx == 0
+                compile_assignment(child, array, tmp)
+              else
+                compile_assignment(child, array, "#{tmp} + #{idx}")
+              end
             end
 
-            push expr(part)
+            scope.queue_temp(tmp)
           end
         end
+      end
+
+      def compile_assignment(child, array, idx, len = nil)
+        if !len || idx >= len
+          assign = s(:js_tmp, "(#{array}[#{idx}] == null ? nil : #{array}[#{idx}])")
+        else
+          assign = s(:js_tmp, "#{array}[#{idx}]")
+        end
+
+        part = child.dup
+        if SIMPLE_ASSIGNMENT.include?(child.type)
+          part << assign
+        elsif child.type == :call
+          part[2] = "#{part[2]}=".to_sym
+          part.last << assign
+        elsif child.type == :attrasgn
+          part.last << assign
+        elsif child.type == :array
+          # nested destructuring
+          tmp = scope.new_temp
+          push ", (#{tmp} = Opal.to_ary(#{assign[1]})"
+          compile_masgn(child.children, tmp)
+          push ')'
+          scope.queue_temp(tmp)
+          return
+        else
+          raise "Bad child node in masgn LHS: #{child}. LHS: #{lhs}"
+        end
 
-        scope.queue_temp tmp
+        push ', '
+        push expr(part)
       end
     end
   end