opal 1.7.0 → 1.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96d55712831ec604d204ffbd2a92a5478daf36f7c24b8b58f52412fc7b2e2ca5
-  data.tar.gz: 557869c042954fc18a1d48cf93008485471e6e1db5a936b4834ffc9700fac755
+  metadata.gz: 3221ae5854f26b0d0722ddf2689773633648086a616add372e8fdd617b31d7c0
+  data.tar.gz: b6b4a65b1905bddb6c1fd2310b13c03600ef4bb8fb416fff54e5499bfae8616c
 SHA512:
-  metadata.gz: 8747d6023e6e0e309f622c1f8ad879bd2c5ce2493662f2dc09053ab0cdbc268ad0110291a1b403c9d19272f6ceb2ebed6e15998b9673b6c5aff356898877202d
-  data.tar.gz: 83f23a7651fd6804759f9e22e284c37eaa27aa4dce2db0ee2d9da91bd1533acf853a9b18767787af267201a0e481736f5e5694ca29d5259ebb1bc67772ec62bc
+  metadata.gz: 5a009bcca000c8fef3d73cda99453023b2860615e4c4c7176e328448cd12d5f26bbf6d2809ca040f064e64af7b04ddb94857b35ac36486a0c7996be28a63230b
+  data.tar.gz: d9154247ad9e90fbc770d647524db30fc8132b3fb77f8c5115abb67a3507fe66c0f7306a2965f1aca11bc790b2f6b7308d7db7bda7e9c3443b54bce42a957bab

data/.github/workflows/build.yml

@@ -24,12 +24,12 @@ jobs:
           - name: mspec-chrome
             ruby: '3.0'
             command: bin/rake mspec_chrome
-          - name: minitest-firefox
+          - name: mspec-firefox
             env:
               # when changing version, also change it below
               MOZILLA_FIREFOX_BINARY: '/opt/hostedtoolcache/firefox/106.0.4/x64/firefox'
             ruby: '3.0'
-            command: xvfb-run bin/rake minitest_firefox
+            command: xvfb-run bin/rake mspec_firefox
           - name: minitest
             ruby: '3.0'
             command: bin/rake minitest
@@ -59,13 +59,17 @@ jobs:
             command: bundle exec rake mspec_chrome
             ruby: '3.0'
             os: windows-latest
-          - name: windows-minitest-firefox
+          - name: windows-mspec-firefox
             env:
               # when changing version, also change it below and above
               MOZILLA_FIREFOX_BINARY: 'C:/Program Files/Firefox_106.0.4/firefox.exe'
             ruby: '3.0'
-            command: bundle exec rake minitest_firefox
+            command: bundle exec rake mspec_firefox
             os: windows-latest
+          - name: macos-mspec-safari
+            command: bundle exec rake mspec_safari
+            ruby: '3.0'
+            os: 'macos-latest'
           - name: windows-minitest
             command: bundle exec rake minitest
             ruby: '3.0'
@@ -74,6 +78,10 @@ jobs:
             command: bundle exec rake rspec
             ruby: '3.0'
             os: windows-latest
+          - name: macos
+            command: bundle exec rake rspec
+            ruby: '3.0'
+            os: 'macos-latest'
           - name: lint
             command: bin/rake lint
             ruby: '3.0'

data/CHANGELOG.md

@@ -16,7 +16,7 @@ Changes are grouped as follows:
 
 
 
-## [1.7.0](https://github.com/opal/opal/compare/v1.6.1...v1.7.0) - 2022-12-26
+## [1.7.2](https://github.com/opal/opal/compare/v1.7.1...v1.7.2) - 2023-01-20
 
 
 <!--
@@ -29,6 +29,44 @@ Changes are grouped as follows:
 ### Fixed
 -->
 
+### Fixed
+
+- Fix the `--debug-source-map` CLI option ([#2520](https://github.com/opal/opal/pull/2520))
+- Fix links in `docs/compiler.md` ([#2519](https://github.com/opal/opal/pull/2519))
+
+
+
+
+## [1.7.1](https://github.com/opal/opal/compare/v1.7.0...v1.7.1) - 2023-01-05
+
+
+### Added
+
+- Add safari runner ([#2513](https://github.com/opal/opal/pull/2513))
+
+### Fixed
+
+- Fix CLI file reading for macOS ([#2510](https://github.com/opal/opal/pull/2510))
+- Make Date/Time.parse on Firefox more compatible with Chrome and Ruby ([#2506](https://github.com/opal/opal/pull/2506))
+- Safari/WebKit can now parse code compiled with lookbehind regexps, failing at runtime instead ([#2511](https://github.com/opal/opal/pull/2511))
+- Fix `--watch` ignoring some directories (e.g. `tmp`) ([#2509](https://github.com/opal/opal/pull/2509))
+- Fix rake dist not generating libraries correctly for the CDN ([#2515](https://github.com/opal/opal/pull/2515))
+- Prefork: output processed files in a correct, deterministic order ([#2516](https://github.com/opal/opal/pull/2516))
+- Fix the handling of ARGV for the opal executable ([#2518](https://github.com/opal/opal/pull/2518))
+
+### Internal
+
+- Platform specific spec filters ([#2508](https://github.com/opal/opal/pull/2508))
+- Run Firefox specs by default ([#2507](https://github.com/opal/opal/pull/2507))
+- Run Safari specs by default ([#2513](https://github.com/opal/opal/pull/2513))
+- [mspec_opal] Avoid lookbehind Regexp for compatibility with various javascript engines ([#2512](https://github.com/opal/opal/pull/2512))
+
+
+
+
+## [1.7.0](https://github.com/opal/opal/compare/v1.6.1...v1.7.0) - 2022-12-26
+
+
 ### Added
 
 - Update benchmarking and CLI runners, added support for Deno and Firefox (#2490, #2492, #2494, #2495, #2497, #2491, #2496)

data/UNRELEASED.md

@@ -7,3 +7,4 @@
 ### Performance
 ### Fixed
 -->
+

data/docs/cdp_common.md

@@ -1,4 +1,4 @@
-### Common CDP of Chrome, Firefox, Node and Deno
+# Common CDP of Chrome, Firefox, Node and Deno
 
 cdp_common.json documents a subset of the common CDP as reported by Chrome, version 107 and Firefox, version 106.
 All entries that where marked as "experimental" or "deprecated" have been removed.

data/docs/compiler.md

@@ -27,7 +27,7 @@ code as well as a reference back to the original sexp which is useful for
 generating source maps afterwards.
 
 
-[sexps]: https://github.com/opal/opal/tree/master/lib/opal/parser/sexp.rb
+[parser]: https://github.com/opal/opal/tree/master/lib/opal/parser.rb
 [compiler]: https://github.com/opal/opal/tree/master/lib/opal/compiler.rb
 [fragments]: https://github.com/opal/opal/tree/master/lib/opal/fragment.rb
 [base-node]: https://github.com/opal/opal/tree/master/lib/opal/nodes/base.rb

data/docs/releasing.md

@@ -2,40 +2,56 @@
 
 _This guide is a work-in-progress._
 
-## Updating the version
+---
+
+## Before the release
+
+All of the following is now covered by `bin/rake release:prepare VERSION=v1.2.3`
+
+### Updating the version
 
 - Update `lib/opal/version.rb`
 - Update `opal/corelib/constants.rb` with the same version number along with release dates
 
-## Updating the changelog
+### Updating the changelog
 
 - Ensure all the unreleased changes are documented in UNRELEASED.md
 - [skip for pre-releases] Run `bin/rake changelog VERSION=v1.2.3` specifying the version number you're about to release
 - [skip for pre-releases] Empty UNRELEASED.md
 
-## The commit
+### The commit
 
 - Commit the updated changelog along with the version bump using this commit message:
   "Release v1.2.3"
-- Push the commit and run `bin/rake release` to release the new version to Rubygems
+
+---
+
+## Release!
+
+- Push the commit to `master`
+- Run `bin/rake release` to release the new version to Rubygems
 - Go to GitHub releases and create a new release from the latest tag pasting the contents from CHANGELOG.md (or UNRELEASED.md for pre-releases)
 
-## Opal docs
+---
+
+## After the release
+
+### Opal docs
 
 - Open `opal-docs` and run `bin/build v1.2.3`
 - Then run `bin/deploy`
 
-## [skip for pre-releases] Opal site
+### [skip for pre-releases] Opal site
 
 - Open `opal.github.io` and update the opal version in the `Gemfile`
 - run `bin/build`
 - `git push` the latest changes
 
-## Opal CDN
+### Opal CDN
 
 - Run `bin/release v1.2.3`
 
-## [skip for minor-releases] Prepare for the next release
+### [skip for minor-releases] Prepare for the next release
 
 - Create a new pull request that:
   - Updates a version to `v1.x.0.dev` in both `lib/opal/version.rb` and `opal/corelib/constants.rb`

data/exe/opal

@@ -2,8 +2,6 @@
 
 # Error codes are taken from /usr/include/sysexits.h
 
-OriginalARGV = ARGV.dup
-
 require 'opal/cli_options'
 options = Opal::CLIOptions.new
 begin
@@ -15,11 +13,7 @@ end
 
 require 'opal/cli'
 options_hash = options.options
-options_hash.merge!(
-  file:     ARGF.file,
-  filename: ARGF.filename,
-  argv:     ARGV.dup
-) unless options_hash[:lib_only]
+options_hash.merge!(argv: ARGV.dup) unless options_hash[:lib_only]
 cli = Opal::CLI.new options_hash
 
 begin
@@ -28,4 +22,8 @@ begin
 rescue Opal::CliRunners::RunnerError => e
   $stderr.puts e.message
   exit 72
+rescue SignalException => e
+  raise unless e.message == 'SIGUSR2'
+
+  exec($0, *ARGV)
 end

data/lib/opal/builder.rb

@@ -197,6 +197,19 @@ module Opal
       processed.map(&:abs_path).compact.select { |fn| File.exist?(fn) }
     end
 
+    def expand_ext(path)
+      abs_path = path_reader.expand(path)
+
+      if abs_path
+        File.join(
+          File.dirname(path),
+          File.basename(abs_path)
+        )
+      else
+        path
+      end
+    end
+
     private
 
     def process_requires(rel_path, requires, autoloads, options)
@@ -261,19 +274,6 @@ module Opal
       end
     end
 
-    def expand_ext(path)
-      abs_path = path_reader.expand(path)
-
-      if abs_path
-        File.join(
-          File.dirname(path),
-          File.basename(abs_path)
-        )
-      else
-        path
-      end
-    end
-
     def expand_path(path)
       return if stub?(path)
       (path_reader.expand(path) || File.expand_path(path)).to_s

data/lib/opal/builder_processors.rb

@@ -148,7 +148,10 @@ module Opal
 
       def compiled
         @compiled ||= begin
-          @source = ::ERB.new(@source.to_s).result
+          erb = ::ERB.new(@source.to_s)
+          erb.filename = @abs_path
+
+          @source = erb.result
 
           compiler = compiler_for(@source, file: @filename)
           compiler.compile
@@ -163,7 +166,10 @@ module Opal
       handles :erb
 
       def source
-        result = ::ERB.new(@source.to_s).result
+        erb = ::ERB.new(@source.to_s)
+        erb.filename = @abs_path
+
+        result = erb.result
         module_name = ::Opal::Compiler.module_name(@filename)
         "Opal.modules[#{module_name.inspect}] = function() {#{result}};"
       end

data/lib/opal/builder_scheduler/prefork.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'etc'
+require 'set'
 
 module Opal
   class BuilderScheduler
@@ -13,12 +14,64 @@ module Opal
           io = @in_fork
           io.send(:new_requires, rel_path, requires, autoloads, options)
         else
-          prefork_reactor(rel_path, requires, autoloads, options)
+          processed = prefork_reactor(rel_path, requires, autoloads, options)
+
+          processed = OrderCorrector.correct_order(processed, requires, builder)
+
+          builder.processed.append(*processed)
         end
       end
 
       private
 
+      # Prefork is not deterministic. This module corrects an order of processed
+      # files so that it would be exactly the same as if building sequentially.
+      # While for Ruby files it usually isn't a problem, because the real order
+      # stems from how `Opal.modules` array is accessed, the JavaScript files
+      # are executed verbatim and their order may be important. Also, having
+      # deterministic output is always a good thing.
+      module OrderCorrector
+        module_function
+
+        def correct_order(processed, requires, builder)
+          # Let's build a hash that maps a filename to an array of files it requires
+          requires_hash = processed.to_h do |i|
+            [i.filename, expand_requires(i.requires, builder)]
+          end
+          # Let's build an array with a correct order of requires
+          order_array = build_require_order_array(expand_requires(requires, builder), requires_hash)
+          # If a key is duplicated, remove the last duplicate
+          order_array = order_array.uniq
+          # Create a hash from this array: [a,b,c] => [a => 0, b => 1, c => 2]
+          order_hash = order_array.each_with_index.to_h
+          # Let's return a processed array that has elements in the order provided
+          processed.sort_by do |asset|
+            # If a filename isn't present somehow in our hash, let's put it at the end
+            order_hash[asset.filename] || order_array.length
+          end
+        end
+
+        # Expand a requires array, so that the requires filenames will be
+        # matching BuilderProcessor#. Builder needs to be passed so that
+        # we can access an `expand_ext` function from its context.
+        def expand_requires(requires, builder)
+          requires.map { |i| builder.expand_ext(i) }
+        end
+
+        def build_require_order_array(requires, requires_hash, built_for = Set.new)
+          array = []
+          requires.each do |name|
+            next if built_for.include?(name)
+            built_for << name
+
+            asset_requires = requires_hash[name]
+            array += build_require_order_array(asset_requires, requires_hash, built_for) if asset_requires
+            array << name
+          end
+          array
+        end
+      end
+
       class ForkSet < Array
         def initialize(count, &block)
           super([])
@@ -192,13 +245,16 @@ module Opal
       def prefork_reactor(rel_path, requires, autoloads, options)
         prefork
 
+        processed = []
+
         first = rel_path
         queue = requires.map { |i| [rel_path, i, autoloads, options] }
 
         awaiting = 0
         built = 0
+        should_log = $stderr.tty? && !ENV['OPAL_DISABLE_PREFORK_LOGS']
 
-        $stderr.print "\r\e[K" if $stderr.tty?
+        $stderr.print "\r\e[K" if should_log
 
         loop do
           events, idles = @forks.get_events(queue.length)
@@ -206,7 +262,7 @@ module Opal
           idles.each do |io|
             break if queue.empty?
 
-            rel_path, req, autoloads, options = *queue.pop
+            rel_path, req, autoloads, options = *queue.shift
 
             next if builder.already_processed.include?(req)
             awaiting += 1
@@ -225,11 +281,8 @@ module Opal
               asset, = *args
               if !asset
                 # Do nothing, we received a nil which is expected.
-              elsif asset.filename == 'corelib/runtime.js'
-                # Opal runtime should go first... the rest can go their way.
-                builder.processed.unshift(asset)
               else
-                builder.processed << asset
+                processed << asset
               end
               built += 1
               awaiting -= 1
@@ -244,7 +297,7 @@ module Opal
             end
           end
 
-          if $stderr.tty?
+          if should_log
             percent = (100.0 * built / (awaiting + built)).round(1)
             str = format("[opal/builder] Building %<first>s... (%<percent>4.3g%%)\r", first: first, percent: percent)
             $stderr.print str
@@ -252,8 +305,10 @@ module Opal
 
           break if awaiting == 0 && queue.empty?
         end
+
+        processed
       ensure
-        $stderr.print "\r\e[K\r" if $stderr.tty?
+        $stderr.print "\r\e[K\r" if should_log
         @forks.close
         @forks.wait
       end

data/lib/opal/cli.rb

@@ -3,18 +3,25 @@
 require 'opal/requires'
 require 'opal/builder'
 require 'opal/cli_runners'
+require 'stringio'
 
 module Opal
   class CLI
     attr_reader :options, :file, :compiler_options, :evals, :load_paths, :argv,
       :output, :requires, :rbrequires, :gems, :stubs, :verbose, :runner_options,
-      :preload, :filename, :debug, :no_exit, :lib_only, :missing_require_severity,
-      :no_cache
+      :preload, :debug, :no_exit, :lib_only, :missing_require_severity,
+      :filename, :stdin, :no_cache
 
     class << self
       attr_accessor :stdout
     end
 
+    class Evals < StringIO
+      def to_path
+        '-e'
+      end
+    end
+
     def initialize(options = nil)
       options ||= {}
 
@@ -25,7 +32,6 @@ module Opal
       @options     = options
       @sexp        = options.delete(:sexp)
       @repl        = options.delete(:repl)
-      @file        = options.delete(:file)
       @no_exit     = options.delete(:no_exit)
       @lib_only    = options.delete(:lib_only)
       @argv        = options.delete(:argv)       { [] }
@@ -37,10 +43,10 @@ module Opal
       @output      = options.delete(:output)     { self.class.stdout || $stdout }
       @verbose     = options.delete(:verbose)    { false }
       @debug       = options.delete(:debug)      { false }
-      @filename    = options.delete(:filename)   { @file && @file.path }
       @requires    = options.delete(:requires)   { [] }
       @rbrequires  = options.delete(:rbrequires) { [] }
       @no_cache    = options.delete(:no_cache)   { false }
+      @stdin       = options.delete(:stdin)      { $stdin }
 
       @debug_source_map = options.delete(:debug_source_map) { false }
 
@@ -55,9 +61,20 @@ module Opal
         [key, value]
       end.compact.to_h
 
-      raise ArgumentError, 'no libraries to compile' if @lib_only && @requires.empty?
-      raise ArgumentError, 'no runnable code provided (evals or file)' if @evals.empty? && @file.nil? && !@lib_only
-      raise ArgumentError, "can't accept evals or file in `library only` mode" if (@evals.any? || @file) && @lib_only
+      if @lib_only
+        raise ArgumentError, 'no libraries to compile' if @requires.empty?
+        raise ArgumentError, "can't accept evals, file, or extra arguments in `library only` mode" if @argv.any? || @evals.any?
+      elsif @evals.any?
+        @filename = '-e'
+        @file = Evals.new(@evals.join("\n"))
+      elsif @argv.first && @argv.first != '-'
+        @filename = @argv.shift
+        @file = File.open(@filename)
+      else
+        @filename = @argv.shift || '-'
+        @file = @stdin
+      end
+
       raise ArgumentError, "unknown options: #{options.inspect}" unless @options.empty?
     end
 
@@ -93,7 +110,7 @@ module Opal
       require 'opal/repl'
 
       repl = REPL.new
-      repl.run(OriginalARGV)
+      repl.run(argv)
     end
 
     attr_reader :exit_status
@@ -127,7 +144,8 @@ module Opal
       builder.build_str '$DEBUG = true', '(flags)', no_export: true if debug
 
       # --eval / stdin / file
-      evals_or_file { |source, filename| builder.build_str(source, filename) }
+      source = evals_or_file_source
+      builder.build_str(source, filename) if source
 
       # --no-exit
       builder.build_str '::Kernel.exit', '(exit)', no_export: true unless no_exit
@@ -136,27 +154,28 @@ module Opal
     end
 
     def show_sexp
-      evals_or_file do |contents, filename|
-        buffer = ::Opal::Parser::SourceBuffer.new(filename)
-        buffer.source = contents
-        sexp = Opal::Parser.default_parser.parse(buffer)
-        output.puts sexp.inspect
-      end
+      source = evals_or_file_source or return # rubocop:disable Style/AndOr
+
+      buffer = ::Opal::Parser::SourceBuffer.new(filename)
+      buffer.source = source
+      sexp = Opal::Parser.default_parser.parse(buffer)
+      output.puts sexp.inspect
     end
 
     def debug_source_map
-      evals_or_file do |contents, filename|
-        compiler = Opal::Compiler.new(contents, file: filename, **compiler_options)
+      source = evals_or_file_source or return # rubocop:disable Style/AndOr
 
-        compiler.compile
+      compiler = Opal::Compiler.new(source, file: filename, **compiler_options)
 
-        result = compiler.result
-        source_map = compiler.source_map.to_json
+      compiler.compile
 
-        b64 = [result, source_map, contents].map { |i| Base64.strict_encode64(i) }.join(',')
+      b64 = [
+        compiler.result,
+        compiler.source_map.to_json,
+        evals_or_file_source,
+      ].map { |i| Base64.strict_encode64(i) }.join(',')
 
-        output.puts "https://sokra.github.io/source-map-visualization/#base64,#{b64}"
-      end
+      output.puts "https://sokra.github.io/source-map-visualization/#base64,#{b64}"
     end
 
     def compiler_option_names
@@ -177,29 +196,27 @@ module Opal
 
     # 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'
-      elsif file && (filename != '-' || evals.empty?)
-        return @content if @content
-
-        if file.tty?
-          save = true
-        else
-          begin
-            file.rewind
-          rescue Errno::ESPIPE
-            save = true
-          end
+    def evals_or_file_source
+      return if lib_only # --library
+      return @cached_content if @cached_content
+
+      unless file.tty?
+        begin
+          file.rewind
+          can_read_again = true
+        rescue Errno::ESPIPE # rubocop:disable Lint/HandleExceptions
+          # noop
         end
+      end
 
-        content = yield(file.read, filename)
-        @content = content if save
-        content
+      if @cached_content.nil? || can_read_again
+        # On MacOS file.read is not enough to pick up changes, probably due to some
+        # cache or buffer, unclear if coming from ruby or the OS.
+        content = File.file?(file) ? File.read(file) : file.read
       end
+
+      @cached_content ||= content unless can_read_again
+      content
     end
   end
 end

data/lib/opal/cli_runners/compiler.rb

@@ -52,22 +52,20 @@ class Opal::CliRunners::Compiler
   end
 
   def fail_unrewindable!
-    warn <<~ERROR
+    abort <<~ERROR
       You have specified --watch, but for watch to work, you must specify an
       --output file.
     ERROR
-    exit 1
   end
 
   def fail_no_listen!
-    warn <<~ERROR
+    abort <<~ERROR
       --watch mode requires the `listen` gem present. Please try to run:
 
           gem install listen
 
       Or if you are using bundler, add listen to your Gemfile.
     ERROR
-    exit 1
   end
 
   def watch_compile
@@ -88,10 +86,13 @@ class Opal::CliRunners::Compiler
     $stderr.puts "* Opal v#{Opal::VERSION} successfully compiled your program in --watch mode"
 
     sleep
+  rescue Interrupt
+    $stderr.puts '* Stopping watcher...'
+    @code_listener.stop
   end
 
   def reexec
-    system($0, *OriginalARGV) && exit
+    Process.kill('USR2', Process.pid)
   end
 
   def on_code_change(modified)
@@ -133,7 +134,7 @@ class Opal::CliRunners::Compiler
   def watch_files
     @directories = files_to_directories
 
-    Listen.to(*@directories) do |modified, added, removed|
+    Listen.to(*@directories, ignore!: []) do |modified, added, removed|
       our_modified = @files & (modified + added + removed)
       on_code_change(our_modified) unless our_modified.empty?
     end