opal 0.10.0 → 0.11.0.rc1

data/lib/opal/cli.rb

@@ -1,5 +1,5 @@
+# frozen_string_literal: true
 require 'opal'
-require 'rack'
 require 'opal/builder'
 require 'opal/cli_runners'
 
@@ -9,18 +9,6 @@ module Opal
                 :output, :requires, :gems, :stubs, :verbose, :port, :preload,
                 :filename, :debug, :no_exit, :lib_only
 
-    def compile?
-      @compile
-    end
-
-    def sexp?
-      @sexp
-    end
-
-    def skip_opal_require?
-      @skip_opal_require
-    end
-
     class << self
       attr_accessor :stdout
     end
@@ -29,8 +17,8 @@ module Opal
       options ||= {}
 
       # Runner
-      @runner_type = options.delete(:runner)    || :nodejs
-      @port       = options.delete(:port)       || 3000
+      @runner_type = options.delete(:runner)     || :nodejs
+      @port        = options.delete(:port)       || 3000
 
       @options     = options
       @compile     = !!options.delete(:compile)
@@ -41,7 +29,6 @@ module Opal
       @lib_only    = options.delete(:lib_only)
       @argv        = options.delete(:argv)       || []
       @evals       = options.delete(:evals)      || []
-      @requires    = options.delete(:requires)   || []
       @load_paths  = options.delete(:load_paths) || []
       @gems        = options.delete(:gems)       || []
       @stubs       = options.delete(:stubs)      || []
@@ -50,7 +37,10 @@ module Opal
       @verbose     = options.fetch(:verbose, false); options.delete(:verbose)
       @debug       = options.fetch(:debug, false);   options.delete(:debug)
       @filename    = options.fetch(:filename) { @file && @file.path }; options.delete(:filename)
-      @skip_opal_require = options.delete(:skip_opal_require)
+
+      @requires    = options.delete(:requires)   || []
+      @requires.unshift('opal') unless options.delete(:skip_opal_require)
+
       @compiler_options = Hash[
         *compiler_option_names.map do |option|
           key = option.to_sym
@@ -60,18 +50,23 @@ module Opal
         end.compact.flatten
       ]
 
+      raise ArgumentError, "no libraries to compile" if @lib_only and @requires.length == 0
       raise ArgumentError, "no runnable code provided (evals or file)" if @evals.empty? and @file.nil? and not(@lib_only)
       raise ArgumentError, "can't accept evals or file in `library only` mode" if (@evals.any? or @file) and @lib_only
       raise ArgumentError, "unknown options: #{options.inspect}" unless @options.empty?
     end
 
     def run
-      case
-      when @map;     show_source_map
-      when sexp?;    show_sexp
-      when compile?; show_compiled_source
-      else           run_code
-      end
+      return show_sexp if @sexp
+
+      compiled_source = builder.to_s
+
+      File.write @map, builder.source_map if @map
+
+      return puts compiled_source if @compile
+
+      runner.run(compiled_source, argv)
+      @exit_status = runner.exit_status
     end
 
     def runner
@@ -83,65 +78,51 @@ module Opal
       end
     end
 
-    def run_code
-      runner.run(compiled_source, argv)
-      @exit_status = runner.exit_status
-    end
-
     attr_reader :exit_status
 
-    def build
+    def builder
+      @builder ||= create_builder
+    end
+
+    def create_builder
       builder = Opal::Builder.new stubs: stubs, compiler_options: compiler_options
+
+      # --include
       builder.append_paths(*load_paths)
+
+      # --gem
       gems.each { |gem_name| builder.use_gem gem_name }
 
-      builder.build 'opal' unless skip_opal_require?
+      # --require
+      requires.each { |required| builder.build(required) }
 
+      # --preload
       preload.each { |path| builder.build_require(path) }
 
-      # FLAGS
+      # --verbose
       builder.build_str '$VERBOSE = true', '(flags)' if verbose
-      builder.build_str '$DEBUG = true', '(flags)' if debug
 
-      # REQUIRES: -r
-      requires.each do |local_require|
-        builder.build(local_require)
-      end
+      # --debug
+      builder.build_str '$DEBUG = true', '(flags)' if debug
 
-      unless lib_only
-        evals_or_file do |contents, filename|
-          builder.build_str(contents, filename)
-        end
-      end
+      # --eval / stdin / file
+      evals_or_file { |source, filename| builder.build_str(source, filename) }
 
+      # --no-exit
       builder.build_str 'Kernel.exit', '(exit)' unless no_exit
 
       builder
     end
 
-    def compiled_source
-      build.to_s
-    end
-
-    def show_compiled_source
-      puts compiled_source
-    end
-
     def show_sexp
       evals_or_file do |contents, filename|
-        sexp = Opal::Parser.new.parse(contents, filename)
+        buffer = ::Parser::Source::Buffer.new(filename)
+        buffer.source = contents
+        sexp = Opal::Parser.default_parser.parse(buffer)
         puts sexp.inspect
       end
     end
 
-    def show_source_map
-      evals_or_file do |contents, filename|
-        compiler = Opal::Compiler.new(contents, options.merge(file: filename))
-        compiler.compile
-        puts compiler.source_map.to_json
-      end
-    end
-
     def compiler_option_names
       %w[
         method_missing
@@ -150,12 +131,17 @@ module Opal
         source_map_enabled
         irb_enabled
         inline_operators
+        enable_source_location
+        parse_comments
       ]
     end
 
-    # Internal: Yelds a string of source code and the proper filename for either
+    # Internal: Yields a string of source code and the proper filename for either
     #           evals, stdin or a filepath.
     def evals_or_file
+      # --library
+      return if lib_only
+
       if evals.any?
         yield evals.join("\n"), '-e'
       else

data/lib/opal/cli_options.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'optparse'
 
 module Opal
@@ -76,10 +77,6 @@ module Opal
         options[:sexp] = true
       end
 
-      on('-m', '--map', 'Show sourcemap') do
-        options[:map] = true
-      end
-
       on('-c', '--compile', 'Compile to JavaScript') do
         options[:compile] = true
       end
@@ -97,10 +94,6 @@ module Opal
         options[:no_exit] = true
       end
 
-      on('-L', '--library', 'Generate only the code of the library. Omit [programfile] and [-e]') do |no_exit|
-        options[:lib_only] = true
-      end
-
       section 'Compilation Options:'
 
       on('-M', '--no-method-missing', 'Enable/Disable method missing') do
@@ -126,19 +119,33 @@ module Opal
         options[:dynamic_require_severity] = level.to_sym
       end
 
-      on('-P', '--source-map [FILE]', 'Enable/Disable source map') do |file|
-        options[:source_map_enabled] = true
-        options[:source_map_file] = file if file
+      on('-P', '--map FILE', 'Enable/Disable source map') do |file|
+        options[:map] = file
       end
 
       on('-F', '--file FILE', 'Set filename for compiled code') do |file|
         options[:file] = file
       end
 
+      on('-L', '--library', 'Compile only required libraries. Omit [programfile] and [-e]. Assumed [-cOE].') do
+        options[:lib_only] = true
+        options[:no_exit] = true
+        options[:compile] = true
+        options[:skip_opal_require] = true
+      end
+
       on("--irb", "Enable IRB var mode") do
         options[:irb] = true
       end
 
+      on('--enable-source-location', 'Compiles source location for each method definition.') do
+        options[:enable_source_location] = true
+      end
+
+      on('--parse-comments', 'Compiles comments for each method definition.') do
+        options[:parse_comments] = true
+      end
+
       separator ''
     end
 

data/lib/opal/cli_runners/applescript.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'opal/cli_runners'
 
 module Opal
@@ -22,15 +23,14 @@ module Opal
         # tempfile = File.new('opal-applescript-runner.js', 'w') # for debugging
         tempfile.write code
         tempfile.close
-        successful = system_with_output('osascript', '-l', 'JavaScript', tempfile.path , *argv)
-
+        _successful = system_with_output('osascript', '-l', 'JavaScript', tempfile.path , *argv)
       rescue Errno::ENOENT
         raise MissingAppleScript, 'AppleScript is only available on Mac OS X.'
       end
 
       # Let's support fake IO objects like StringIO
       def system_with_output(env, *cmd)
-        if (io_output = IO.try_convert(output))
+        if (_io_output = IO.try_convert(output))
           system(env,*cmd)
           @exit_status = $?.exitstatus
           return

data/lib/opal/cli_runners/nashorn.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'opal/cli_runners'
 require 'opal/paths'
 

data/lib/opal/cli_runners/nodejs.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
 require 'opal/cli_runners'
 require 'opal/paths'
+require 'shellwords'
 
 module Opal
   module CliRunners
@@ -25,7 +27,8 @@ module Opal
         # tempfile = File.new('opal-nodejs-runner.js', 'w') # for debugging
         tempfile.write code
         tempfile.close
-        system_with_output({'NODE_PATH' => node_modules}, 'node', tempfile.path , *argv)
+        node_opt = ENV['NODE_OPT'].to_s.shellsplit
+        system_with_output({'NODE_PATH' => node_modules}, 'node', *node_opt, tempfile.path, *argv)
       rescue Errno::ENOENT
         raise MissingNodeJS, 'Please install Node.js to be able to run Opal scripts.'
       end

data/lib/opal/cli_runners/phantom.js

@@ -6,7 +6,7 @@ page.onConsoleMessage = function(msg) {
   system.stdout.write(msg);
 };
 
-var opal_code = fs.read('/dev/stdin');
+var opal_code = system.stdin.read();
 
 /*
  * Exit phantom instance "safely" see - https://github.com/ariya/phantomjs/issues/12697
@@ -67,4 +67,3 @@ page.setContent("<!doctype html>\n"+
                 "<head><meta charset='utf-8'/></head><body>"+
                 "</body></html>",
                 'http://www.example.com');
-

data/lib/opal/cli_runners/phantomjs.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'shellwords'
 
 module Opal
@@ -11,13 +12,13 @@ module Opal
       attr_reader :output, :exit_status
 
       def run(code, argv)
-        command = [
+        phantomjs_command = [
           'phantomjs',
           SCRIPT_PATH.shellescape,
           *argv.map(&:shellescape)
         ].join(' ')
 
-        phantomjs = IO.popen(command, 'w', out: output) do |io|
+        IO.popen(phantomjs_command, 'w', out: output) do |io|
           io.write(code)
         end
 

data/lib/opal/cli_runners/server.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'opal/cli_runners'
 
 module Opal

data/lib/opal/cli_runners.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Opal
   # `Opal::CliRunners` is the namespace in which JavaScript runners can be
   # defined for use by `Opal::CLI`. The API for classes defined under

data/lib/opal/compiler.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'set'
 require 'opal/parser'
 require 'opal/fragment'
@@ -106,7 +107,7 @@ module Opal
     # @!method dynamic_require_severity
     #
     # how to handle dynamic requires (:error, :warning, :ignore)
-    compiler_option :dynamic_require_severity, :warning, :valid_values => [:error, :warning, :ignore]
+    compiler_option :dynamic_require_severity, :ignore, :valid_values => [:error, :warning, :ignore]
 
     # @!method requirable?
     #
@@ -120,6 +121,16 @@ module Opal
 
     compiler_option :eval, false, as: :eval?
 
+    # @!method enable_source_location?
+    #
+    # Adds source_location for every method definition
+    compiler_option :enable_source_location, false, :as => :enable_source_location?
+
+    # @!method parse_comments?
+    #
+    # Adds comments for every method definition
+    compiler_option :parse_comments, false, :as => :parse_comments?
+
     # @return [String] The compiled ruby code
     attr_reader :result
 
@@ -135,34 +146,47 @@ module Opal
     # Any content in __END__ special construct
     attr_reader :eof_content
 
+    # Comments from the source code
+    attr_reader :comments
+
     def initialize(source, options = {})
       @source = source
       @indent = ''
       @unique = 0
       @options = options
+      @comments = Hash.new([])
     end
 
     # Compile some ruby code to a string.
     #
     # @return [String] javascript code
     def compile
-      @parser = Parser.new
-
-      parsed = begin
-        @parser.parse(@source, self.file)
-      rescue => error
-        raise SyntaxError, error.message, error.backtrace
-      end
-
-      @sexp = s(:top, parsed || s(:nil))
-      @eof_content = @parser.lexer.eof_content
+      parse
 
       @fragments = process(@sexp).flatten
 
       @result = @fragments.map(&:code).join('')
-    rescue Exception => error
-      message = "An error occurred while compiling: #{self.file}\n#{error.message}"
-      raise error.class, message, error.backtrace
+    end
+
+    def parse
+      buffer = ::Parser::Source::Buffer.new(file)
+      buffer.source = @source
+
+      @parser = Opal::Parser.default_parser
+
+      begin
+        if parse_comments?
+          sexp, comments = @parser.parse_with_comments(buffer)
+          @comments = ::Parser::Source::Comment.associate_locations(sexp, comments)
+        else
+          sexp = @parser.parse(buffer)
+        end
+      rescue ::Parser::SyntaxError => error
+        raise ::SyntaxError, error.message, error.backtrace
+      end
+
+      @sexp = s(:top, sexp || s(:nil))
+      @eof_content = extract_eof_content
     end
 
     # Returns a source map that can be used in the browser to map back to
@@ -217,8 +241,8 @@ module Opal
     # Create a new sexp using the given parts. Even though this just
     # returns an array, it must be used incase the internal structure
     # of sexps does change.
-    def s(*parts)
-      Sexp.new(parts)
+    def s(type, *children)
+      ::Opal::AST::Node.new(type, children)
     end
 
     def fragment(str, scope, sexp = nil)
@@ -227,8 +251,19 @@ module Opal
 
     # Used to generate a unique id name per file. These are used
     # mainly to name method bodies for methods that use blocks.
-    def unique_temp
-      "TMP_#{@unique += 1}"
+    def unique_temp(name)
+      name = name.to_s
+      if name && !name.empty?
+        name = "_#{name}"
+          .gsub('?', '$q')
+          .gsub('!', '$B')
+          .gsub('=', '$eq')
+          .gsub('<', '$lt')
+          .gsub('>', '$gt')
+          .gsub(/[^\w\$]/, '$')
+      end
+      unique = (@unique += 1)
+      "TMP#{name}_#{unique}"
     end
 
     # Use the given helper
@@ -266,14 +301,14 @@ module Opal
     def in_while
       return unless block_given?
       @while_loop = @scope.push_while
-      result = yield
+      result = indent { yield }
       @scope.pop_while
-
       result
     end
 
     def in_ensure
       return unless block_given?
+
       @in_ensure = true
       result = yield
       @in_ensure = false
@@ -282,31 +317,7 @@ module Opal
     end
 
     def in_ensure?
-      @in_ensure
-    end
-
-    # With a block will detect a break in the sexp processed from within
-    # the block (see BreakNode).
-    #
-    # Without a block (but inside a `#has_break?(&block)` call) returns the
-    # current result.
-    #
-    # Works in conjunction with #has_break!
-    #
-    # @return [Boolean] whether a block has been detected
-    def has_break?
-      return @break_detected unless block_given?
-      @break_detected = false
-      result = yield
-      detected = @break_detected
-      @break_detected = nil
-      detected
-    end
-
-    # Marks the current block has having detected a break, but only from inside
-    # a `#has_break?(&block)` block.
-    def has_break!
-      @break_detected = true if @break_detected == false
+      !!@in_ensure
     end
 
     def in_case
@@ -365,69 +376,101 @@ module Opal
       return returns s(:nil) unless sexp
 
       case sexp.type
-      # Undefs go from 1 ruby undef a,b,c to multiple JS Opal.udef() calls, so need to treat them as individual statements
-      # and put the return on the last one
       when :undef
-        last = sexp.pop
-        sexp << returns(last)
+        # undef :method_name always returns nil
+        returns s(:begin, sexp, s(:nil))
       when :break, :next, :redo
         sexp
       when :yield
-        sexp[0] = :returnable_yield
-        sexp
-      when :scope
-        sexp[1] = returns sexp[1]
-        sexp
-      when :block
-        if sexp.length > 1
-          sexp[-1] = returns sexp[-1]
-        else
-          sexp << returns(s(:nil))
-        end
-        sexp
+        sexp.updated(:returnable_yield, nil)
       when :when
-        sexp[2] = returns(sexp[2])
-        sexp
+        *when_sexp, then_sexp = *sexp
+        sexp.updated(nil,
+          [*when_sexp, returns(then_sexp)]
+        )
       when :rescue
-        sexp[1] = returns sexp[1]
+        body_sexp, *resbodies, else_sexp = *sexp
 
-        if sexp[2] and sexp[2][0] == :resbody
-          if sexp[2][2]
-            sexp[2][2] = returns sexp[2][2]
-          else
-            sexp[2][2] = returns s(:nil)
-          end
+        resbodies = resbodies.map do |resbody|
+          returns(resbody)
         end
-        sexp
+
+        if else_sexp
+          else_sexp = returns(else_sexp)
+        end
+
+        sexp.updated(nil, [
+          returns(body_sexp),
+          *resbodies,
+          else_sexp
+        ])
+      when :resbody
+        klass, lvar, body = *sexp
+        sexp.updated(nil, [klass, lvar, returns(body)])
       when :ensure
-        sexp[1] = returns sexp[1]
-        sexp
-      when :begin
-        sexp[1] = returns sexp[1]
-        sexp
-      when :rescue_mod
-        sexp[1] = returns sexp[1]
-        sexp[2] = returns sexp[2]
+        rescue_sexp, ensure_body = *sexp
+        sexp = sexp.updated(nil,
+          [returns(rescue_sexp), ensure_body]
+        )
+        s(:js_return, sexp)
+      when :begin, :kwbegin
+        # Wrapping last expression with s(:js_return, ...)
+        *rest, last = *sexp
+        sexp.updated(
+          nil,
+          [*rest, returns(last)]
+        )
+      when :while, :until, :while_post, :until_post
         sexp
-      when :while
-        # sexp[2] = returns(sexp[2])
-        sexp
-      when :return, :js_return
+      when :return, :js_return, :returnable_yield
         sexp
       when :xstr
-        sexp[1] = "return #{sexp[1]};" unless /return|;/ =~ sexp[1]
-        sexp
-      when :dxstr
-        sexp[1] = "return #{sexp[1]}" unless /return|;|\n/ =~ sexp[1]
-        sexp
+        if sexp.children.any?
+          strs = sexp.
+            children.
+            select { |child| child.type == :str }.
+            map { |child| child.children[0] }
+
+          multiline = strs.any? { |str| str.end_with?(";\n") }
+
+          first_child, *rest_children = *sexp
+
+          if multiline
+            # xstr starts with interpolation
+            # then it must contain js_return inside
+            sexp
+          else
+            if first_child.type == :str
+              old_value = first_child.children[0]
+              if old_value.include?('return')
+                # 'return' is already there
+                sexp
+              else
+                first_child = s(:js_return, first_child)
+                sexp.updated(nil, [first_child, *rest_children])
+              end
+            else
+              s(:js_return, sexp)
+            end
+          end
+        else
+          returns s(:str, '')
+        end
       when :if
-        sexp[2] = returns(sexp[2] || s(:nil))
-        sexp[3] = returns(sexp[3] || s(:nil))
-        sexp
+        cond, true_body, false_body = *sexp
+        sexp.updated(
+          nil, [
+            cond,
+            returns(true_body),
+            returns(false_body)
+          ]
+        )
       else
-        return_sexp = s(:js_return, sexp)
-        return_sexp.source = sexp.source
-        return_sexp
+        s(:js_return, sexp).updated(
+          nil,
+          nil,
+          location: sexp.loc
+        )
       end
     end
 
@@ -441,5 +484,13 @@ module Opal
         fragment("false", scope, sexp)
       end
     end
+
+    # Extracts all the content after __END__ directive
+    #
+    # @return [String, nil]
+    def extract_eof_content
+      matches = @source.match(/\n__END__\n?([\w\s]*)/)
+      matches && matches[1]
+    end
   end
 end