opal 1.0.5 → 1.1.0.rc1

data/lib/opal/cli_runners/system_runner.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'tempfile'
+
+# Generic runner that will resort to calling an external program.
+#
+# @option :options [Hash,nil] :env a hash of options to be used as env in the
+#   call to system.
+# @option :options [true,false] :debug enabling debug mode will write the
+#   compiled JavaScript file in the current working directory.
+# @yield tempfile [File] Gives a file to the block, its #path can be used to
+#   construct the command
+# @yieldreturn command [Array<String>] the command to be used in the system call
+SystemRunner = ->(data, &block) {
+  options  = data[:options] || {}
+  builder  = data.fetch(:builder)
+  output   = data.fetch(:output)
+
+  env      = options.fetch(:env, {})
+  debug    = options.fetch(:debug, false)
+
+  code = builder.to_s + "\n" + builder.source_map.to_data_uri_comment
+
+  tempfile =
+    if debug
+      File.new('opal-nodejs-runner.js', 'w')
+    else
+      Tempfile.new('opal-system-runner-')
+    end
+
+  tempfile.write code
+  cmd = block.call tempfile
+  tempfile.close
+
+  # JRuby (v9.2) doesn't support using `out:` to redirect output.
+  if IO.try_convert(output) && RUBY_PLATFORM != 'java'
+    system(env, *cmd, out: output)
+    $?.exitstatus
+  else
+    require 'open3'
+    captured_output, status = Open3.capture2(env, *cmd)
+    output.write captured_output
+    status.exitstatus
+  end
+}

data/lib/opal/compiler.rb

@@ -6,6 +6,7 @@ require 'opal/fragment'
 require 'opal/nodes'
 require 'opal/eof_content'
 require 'opal/errors'
+require 'opal/magic_comments'
 
 module Opal
   # Compile a string of ruby code into javascript.
@@ -57,18 +58,38 @@ module Opal
       Pathname(path).cleanpath.to_s
     end
 
-    # defines a compiler option, also creating method of form 'name?'
-    def self.compiler_option(name, default_value, options = {})
-      mid          = options[:as]
-      valid_values = options[:valid_values]
-      define_method(mid || name) do
-        value = @options.fetch(name) { default_value }
-        if valid_values && !valid_values.include?(value)
-          raise ArgumentError, "invalid value #{value.inspect} for option #{name.inspect} " \
-                               "(valid values: #{valid_values.inspect})"
-        end
-        value
+    # Defines a compiler option.
+    # @option as: [Symbol] uses a different method name, e.g. with a question mark for booleans
+    # @option default: [Object] the default value for the option
+    # @option magic_comment: [Bool] allows magic-comments to override the option value
+    def self.compiler_option(name, config = {})
+      method_name = config.fetch(:as, name)
+      define_method(method_name) { option_value(name, config) }
+    end
+
+    # Fetches and memoizes the value for an option.
+    def option_value(name, config)
+      return @option_values[name] if @option_values.key? name
+
+      default_value = config[:default]
+      valid_values  = config[:valid_values]
+      magic_comment = config[:magic_comment]
+
+      value = @options.fetch(name, default_value)
+
+      if magic_comment && @magic_comments.key?(name)
+        value = @magic_comments.fetch(name)
+      end
+
+      if valid_values && !valid_values.include?(value)
+        raise(
+          ArgumentError,
+          "invalid value #{value.inspect} for option #{name.inspect} " \
+          "(valid values: #{valid_values.inspect})"
+        )
       end
+
+      @option_values[name] = value
     end
 
     # @!method file
@@ -77,21 +98,21 @@ module Opal
     # as well as finding relative require()
     #
     # @return [String]
-    compiler_option :file, '(file)'
+    compiler_option :file, default: '(file)'
 
     # @!method method_missing?
     #
     # adds method stubs for all used methods in file
     #
     # @return [Boolean]
-    compiler_option :method_missing, true, as: :method_missing?
+    compiler_option :method_missing, default: true, as: :method_missing?
 
     # @!method arity_check?
     #
     # adds an arity check to every method definition
     #
     # @return [Boolean]
-    compiler_option :arity_check, false, as: :arity_check?
+    compiler_option :arity_check, default: false, as: :arity_check?
 
     # @deprecated
     # @!method freezing?
@@ -99,45 +120,44 @@ module Opal
     # stubs out #freeze and #frozen?
     #
     # @return [Boolean]
-    compiler_option :freezing, true, as: :freezing?
-
-    # @deprecated
-    # @!method tainting?
-    #
-    # stubs out #taint, #untaint and #tainted?
-    compiler_option :tainting, true, as: :tainting?
+    compiler_option :freezing, default: true, as: :freezing?
 
     # @!method irb?
     #
     # compile top level local vars with support for irb style vars
-    compiler_option :irb, false, as: :irb?
+    compiler_option :irb, default: false, as: :irb?
 
     # @!method dynamic_require_severity
     #
     # how to handle dynamic requires (:error, :warning, :ignore)
-    compiler_option :dynamic_require_severity, :ignore, valid_values: %i[error warning ignore]
+    compiler_option :dynamic_require_severity, default: :ignore, valid_values: %i[error warning ignore]
 
     # @!method requirable?
     #
     # Prepare the code for future requires
-    compiler_option :requirable, false, as: :requirable?
+    compiler_option :requirable, default: false, as: :requirable?
 
     # @!method inline_operators?
     #
     # are operators compiled inline
-    compiler_option :inline_operators, true, as: :inline_operators?
+    compiler_option :inline_operators, default: true, as: :inline_operators?
 
-    compiler_option :eval, false, as: :eval?
+    compiler_option :eval, default: false, as: :eval?
 
     # @!method enable_source_location?
     #
     # Adds source_location for every method definition
-    compiler_option :enable_source_location, false, as: :enable_source_location?
+    compiler_option :enable_source_location, default: false, as: :enable_source_location?
+
+    # @!method use_strict?
+    #
+    # Adds source_location for every method definition
+    compiler_option :use_strict, default: false, as: :use_strict?, magic_comment: true
 
     # @!method parse_comments?
     #
     # Adds comments for every method definition
-    compiler_option :parse_comments, false, as: :parse_comments?
+    compiler_option :parse_comments, default: false, as: :parse_comments?
 
     # @return [String] The compiled ruby code
     attr_reader :result
@@ -157,6 +177,9 @@ module Opal
     # Comments from the source code
     attr_reader :comments
 
+    # Magic comment flags extracted from the leading comments
+    attr_reader :magic_comments
+
     def initialize(source, options = {})
       @source = source
       @indent = ''
@@ -164,6 +187,8 @@ module Opal
       @options = options
       @comments = Hash.new([])
       @case_stmt = nil
+      @option_values = {}
+      @magic_comments = {}
     end
 
     # Compile some ruby code to a string.
@@ -188,6 +213,7 @@ module Opal
 
       @sexp = s(:top, sexp || s(:nil))
       @comments = ::Parser::Source::Comment.associate_locations(sexp, comments)
+      @magic_comments = MagicComments.parse(sexp, comments)
       @eof_content = EofContent.new(tokens, @source).eof
     end
 
@@ -206,7 +232,9 @@ module Opal
     #
     # @return [Set<Symbol>]
     def helpers
-      @helpers ||= Set.new(%i[breaker slice])
+      @helpers ||= Set.new(
+        magic_comments[:helpers].to_s.split(',').map { |h| h.strip.to_sym }
+      )
     end
 
     # Operator helpers

data/lib/opal/config.rb

@@ -93,11 +93,6 @@ module Opal
     # @return [true, false]
     config_option :freezing_stubs_enabled, true, compiler_option: :freezing
 
-    # Add stubs for methods related to tainting objects (for compatibility).
-    #
-    # @return [true, false]
-    config_option :tainting_stubs_enabled, true, compiler_option: :tainting
-
     # Set the error severity for when a require can't be parsed at compile time.
     #
     # @example

data/lib/opal/erb.rb

@@ -29,7 +29,7 @@ module Opal
     end
 
     class Compiler
-      BLOCK_EXPR = /\s+(do|\{)(\s*\|[^|]*\|)?\s*\Z/
+      BLOCK_EXPR = /\s+(do|\{)(\s*\|[^|]*\|)?\s*\Z/.freeze
 
       def initialize(source, file_name = '(erb)')
         @source, @file_name, @result = source, file_name, source

data/lib/opal/magic_comments.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Opal::MagicComments
+  MAGIC_COMMENT_RE = /\A# *(\w+) *: *(\S+.*?) *$/.freeze
+  EMACS_MAGIC_COMMENT_RE = /\A# *-\*- *(\w+) *: *(\S+.*?) *-\*- *$/.freeze
+
+  def self.parse(sexp, comments)
+    flags = {}
+
+    # We have an upper limit at the first line of code
+    if sexp
+      first_line = sexp.loc.line
+      comments = comments.take(first_line)
+    end
+
+    comments.each do |comment|
+      next if first_line && comment.loc.line >= first_line
+
+      if (parts = comment.text.scan(MAGIC_COMMENT_RE)).any? ||
+         (parts = comment.text.scan(EMACS_MAGIC_COMMENT_RE)).any?
+        parts.each do |key, value|
+          flags[key.to_sym] =
+            case value
+            when 'true' then true
+            when 'false' then false
+            else value
+            end
+        end
+      end
+    end
+
+    flags
+  end
+end

data/lib/opal/nodes/args/arity_check.rb

@@ -29,9 +29,10 @@ module Opal
         return unless compiler.arity_check?
 
         unless arity_checks.empty?
+          helper :ac
           meth = scope.mid.to_s.inspect
           line 'var $arity = arguments.length;'
-          push " if (#{arity_checks.join(' || ')}) { Opal.ac($arity, #{arity}, this, #{meth}); }"
+          push " if (#{arity_checks.join(' || ')}) { $ac($arity, #{arity}, this, #{meth}); }"
         end
       end
 

data/lib/opal/nodes/base.rb

@@ -62,7 +62,7 @@ module Opal
       end
 
       def unshift(*strs)
-        strs.reverse.each do |str|
+        strs.reverse_each do |str|
           str = fragment(str) if str.is_a?(String)
           @fragments.unshift str
         end

data/lib/opal/nodes/call.rb

@@ -3,7 +3,6 @@
 require 'set'
 require 'pathname'
 require 'opal/nodes/base'
-require 'opal/nodes/runtime_helpers'
 require 'opal/rewriters/break_finder'
 
 module Opal
@@ -75,7 +74,7 @@ module Opal
       # @see #compile_arguments
       #
       # When a method takes a block we have to calculate all arguments
-      # **before** asigning '$$p' property (that stores a passed block)
+      # **before** assigning '$$p' property (that stores a passed block)
       # to a method body. This is some kind of protection from method calls
       # like 'a(a {}) { 1 }'.
       def invoke_using_send?
@@ -190,8 +189,6 @@ module Opal
         if SPECIALS.include? meth
           method = method("handle_#{meth}")
           method.arity == 1 ? method[compile_default] : method[]
-        elsif RuntimeHelpers.compatible?(recvr, meth)
-          push(RuntimeHelpers.new(sexp_with_arglist, @level, @compiler).compile)
         else
           yield # i.e. compile_default.call
         end

data/lib/opal/nodes/def.rb

@@ -93,6 +93,8 @@ module Opal
 
       def source_location
         file = @sexp.loc.expression.source_buffer.name
+        file = "<internal:#{file}>" if file.start_with?("corelib/")
+        file = "<js:#{file}>" if file.end_with?(".js")
         line = @sexp.loc.line
         "['#{file}', #{line}]"
       end

data/lib/opal/nodes/iter.rb

@@ -17,7 +17,7 @@ module Opal
 
         in_scope do
           identity = scope.identify!
-          add_temp "self = #{identity}.$$s || this"
+          add_temp "self = #{identity}.$$s == null ? this : #{identity}.$$s"
 
           inline_params = process(inline_args)
 

data/lib/opal/nodes/literal.rb

@@ -41,7 +41,7 @@ module Opal
         'e' => '\\u001b'
       }.freeze
 
-      ESCAPE_REGEX = /(\\+)([#{ ESCAPE_CHARS.keys.join('') }])/
+      ESCAPE_REGEX = /(\\+)([#{ ESCAPE_CHARS.keys.join('') }])/.freeze
 
       def translate_escape_chars(inspect_string)
         inspect_string.gsub(ESCAPE_REGEX) do |original|
@@ -55,8 +55,6 @@ module Opal
 
       def compile
         string_value = value
-        encoding = string_value.encoding
-        should_encode = encoding != Encoding::UTF_8
 
         sanitized_value = string_value.inspect.gsub(/\\u\{([0-9a-f]+)\}/) do
           code_point = Regexp.last_match(1).to_i(16)
@@ -64,8 +62,13 @@ module Opal
         end
         push translate_escape_chars(sanitized_value)
 
-        if should_encode && RUBY_ENGINE != 'opal'
-          push '.$force_encoding("', encoding.name, '")'
+        if RUBY_ENGINE != 'opal'
+          encoding = string_value.encoding
+
+          unless encoding == Encoding::UTF_8
+            helper :enc
+            wrap "$enc(", ", \"#{encoding.name}\")"
+          end
         end
       end
 
@@ -104,7 +107,7 @@ module Opal
       attr_accessor :value, :flags
 
       # https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp
-      SUPPORTED_FLAGS = /[gimuy]/
+      SUPPORTED_FLAGS = /[gimuy]/.freeze
 
       def initialize(*)
         super
@@ -121,20 +124,22 @@ module Opal
           end
         end
 
-        case value.type
-        when :dstr, :begin
-          compile_dynamic_regexp
-        when :str
+        if value.type == :str
           compile_static_regexp
+        else
+          compile_dynamic_regexp
         end
       end
 
       def compile_dynamic_regexp
-        if flags.any?
-          push 'new RegExp(', expr(value), ", '#{flags.join}')"
-        else
-          push 'new RegExp(', expr(value), ')'
+        push 'Opal.regexp(['
+        value.children.each_with_index do |v, index|
+          push ', ' unless index.zero?
+          push expr(v)
         end
+        push ']'
+        push ", '#{flags.join}'" if flags.any?
+        push ")"
       end
 
       def compile_static_regexp

data/lib/opal/nodes/logic.rb

@@ -10,9 +10,10 @@ module Opal
       def compile
         if in_while?
           push 'continue;'
+        elsif scope.iter?
+          push 'return ', expr_or_nil(value), ';'
         else
-          push expr_or_nil(value)
-          wrap 'return ', ';'
+          error 'Invalid next'
         end
       end
 
@@ -85,6 +86,7 @@ module Opal
       end
 
       def compile_iter
+        helper :slice
         push "return #{scope.identity}.apply(null, $slice.call(arguments))"
       end
     end
@@ -107,83 +109,6 @@ module Opal
       end
     end
 
-    class BinaryOp < Base
-      def compile
-        if rhs.type == :break
-          compile_if
-        else
-          compile_ternary
-        end
-      end
-
-      def compile_ternary
-        raise NotImplementedError
-      end
-
-      def compile_if
-        raise NotImplementedError
-      end
-    end
-
-    class OrNode < BinaryOp
-      handle :or
-
-      children :lhs, :rhs
-
-      def compile_ternary
-        helper :truthy
-
-        with_temp do |tmp|
-          push "($truthy(#{tmp} = ", expr(lhs), ") ? #{tmp} : ", expr(rhs), ')'
-        end
-      end
-
-      def compile_if
-        helper :truthy
-
-        with_temp do |tmp|
-          push "if ($truthy(#{tmp} = ", expr(lhs), ')) {'
-          indent { line tmp }
-          line '} else {'
-          indent { line expr(rhs) }
-          line '}'
-        end
-      end
-    end
-
-    class AndNode < BinaryOp
-      handle :and
-
-      children :lhs, :rhs
-
-      def compile_ternary
-        truthy_opt = nil
-
-        with_temp do |tmp|
-          if truthy_opt = js_truthy_optimize(lhs)
-            push "((#{tmp} = ", truthy_opt
-            push ') ? '
-            push expr(rhs)
-            push ' : ', expr(lhs), ')'
-          else
-            helper :truthy
-
-            push "($truthy(#{tmp} = ", expr(lhs), ') ? ', expr(rhs), " : #{tmp})"
-          end
-        end
-      end
-
-      def compile_if
-        helper :truthy
-        condition = js_truthy_optimize(lhs) || expr(lhs)
-
-        line 'if ($truthy(', condition, ')) {'
-        indent { line expr(rhs) }
-        line '} else {'
-        indent { line expr(lhs) }
-        line '}'
-      end
-    end
 
     class ReturnNode < Base
       handle :return
@@ -221,7 +146,7 @@ module Opal
         elsif stmt?
           push 'return ', return_val
         else
-          raise SyntaxError, 'void value expression: cannot return as an expression'
+          error 'void value expression: cannot return as an expression'
         end
       end
     end