opal 0.11.0.rc1 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d3c1ac220f86c552e522eaad298f9e4dcce4e8f6
-  data.tar.gz: 5294190e2a015e036d8824126837fb8ead1e219a
+  metadata.gz: 031fb6b695b92330faf6fda3d93b6fddb84e8c90
+  data.tar.gz: f44d491f731708162c5ab566be18514aa1d3567d
 SHA512:
-  metadata.gz: 9c84a1b7d4c5c1e493dcdff3f8823141fac4048b96ac409ded2ce223b4e591d7fccbb00d7edd00f4cc8eafe76385c3caa8d540bf285cada64fc9d24ec5048072
-  data.tar.gz: 8e8a3ec7a272f221856d36787fe8edf774f418694fb28b18f30b3e38d8c10ee059154c2d3218b29300bd8e5818667ba3481bb2b499dfeae19641526477d60ee0
+  metadata.gz: 6af49d8a0000654461f171748688bbf39dc21d5e8bcec76414ea7eaa65fd45ad3b5b2fdfcbf7cfbbd8dac47f0f96cc671547b2e36bbff399f15461c7304f1464
+  data.tar.gz: f68f7d5581668620ce96ef7766266a62f003d785ae934f515f7ddb2e67f4443793f354475e89e9153882af82baaafc4a96d3474f9a4a43edeb961e1ba91e94a2

data/.jshintrc

@@ -10,7 +10,7 @@
   "undef"         : true, // Prohibit the use of explicitly undeclared variables
   "unused"        : true, // Warn when you define and never use your variables
 
-  "predef"        : ["Opal", "JSON", "Java", "callPhantom", "OpalNode", "jsyaml"],
+  "predef"        : ["Opal", "JSON", "Java", "OpalNode", "jsyaml"],
 
   "browser": true,
   "node": true,

data/.travis.yml

@@ -2,6 +2,10 @@ language: ruby
 
 sudo: false
 
+dist: trusty
+addons:
+  chrome: stable
+
 cache:
   bundler: true
   directories:
@@ -12,6 +16,12 @@ matrix:
   fast_finish: true
 
   include:
+    - rvm: 2.4.0
+      env: RUN=mspec_opal_chrome
+
+    - rvm: 2.4.0
+      env: RUN=mspec_ruby_chrome
+
     # - rvm: 2.4.0
     #   env:
     #     - RUN=browser_test
@@ -65,14 +75,16 @@ matrix:
 
 
 before_install:
-  # Keep track of which version of node and phantomjs we're running the specs against
+  # Keep track of which version of node we're running the specs against
   - node -v
-  - phantomjs -v
   - git submodule update --init
   - npm install -g jshint
   - npm install -g uglify-js
   - type bundle || gem install bundler
   - bundle config without doc
+  - which google-chrome-stable
+  - google-chrome-stable --version
+  - export RUBYOPT=-w
 
 script:
   - "bundle exec rake $RUN"

data/CHANGELOG.md

@@ -63,6 +63,7 @@ Whitespace conventions:
 ### Removed
 
 - Dropped support for IE8 and below, and restricted Safari and Opera support to the last two versions
+- Dropped support for PhantomJS as it was [abandoned](https://groups.google.com/forum/#!topic/phantomjs/9aI5d-LDuNE).
 
 
 ### Changed
@@ -122,20 +123,32 @@ Whitespace conventions:
 
 
 
-## [0.10.3] - 2016-10-31
+
+## [0.10.5] - 2017-06-21
+
+
+### Fixed
+
+- Fix `Time#zone` for zones expressed numerically
+
+
+
+
+## [0.10.4] - 2017-05-07
 
 
 ### Changed
 
-- Avoid special utf-8 chars in method names, now they start with `$$`
+- Better `Opal::Config` options documentation and organization
+- Always cache source-maps at build-time so they're available once enabled
 
 
 
 
-## [0.10.2] - 2016-09-09
+## [0.10.3] - 2016-10-31
 
 
-## Fixed
+### Fixed
 
 - Fixed inheritance from the `Module` class (#1476)
 - Fixed source map server with url-encoded paths
@@ -145,6 +158,16 @@ Whitespace conventions:
 
 
 
+## [0.10.2] - 2016-09-09
+
+
+### Changed
+
+- Avoid special utf-8 chars in method names, now they start with `$$`
+
+
+
+
 ## [0.10.1] - 2016-07-06
 
 
@@ -983,7 +1006,9 @@ Whitespace conventions:
 
 
 
-[0.11.0]: https://github.com/opal/opal/compare/v0.10.3...HEAD
+[0.11.0]: https://github.com/opal/opal/compare/v0.10.5...HEAD
+[0.10.5]: https://github.com/opal/opal/compare/v0.10.4...v0.10.5
+[0.10.4]: https://github.com/opal/opal/compare/v0.10.3...v0.10.4
 [0.10.3]: https://github.com/opal/opal/compare/v0.10.2...v0.10.3
 [0.10.2]: https://github.com/opal/opal/compare/v0.10.1...v0.10.2
 [0.10.1]: https://github.com/opal/opal/compare/v0.10.0...v0.10.1

data/HACKING.md

@@ -202,7 +202,7 @@ To enable debug output in the Racc grammar set the `RACC_DEBUG` env var and reco
 ```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
+$ bundle exec exe/opal --sexp -e "42" # ask Opal for the SExp of some code
 
 read    :tINTEGER(tINTEGER) [42, [1, 0]]
 
@@ -227,6 +227,6 @@ 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
+$ bundle exec exe/opal --sexp -e "42" # ask Opal for the SExp of some code
 (:int, 42)
 ```

data/README.md

@@ -70,7 +70,7 @@ string of JavaScript code.
 Opal.compile("puts 'wow'")  # => "(function() { ... self.$puts("wow"); ... })()"
 ```
 
-Running this by itself is not enough, you need the opal runtime/corelib.
+Running this by itself is not enough; you need the opal runtime/corelib.
 
 #### Using Opal::Builder
 
@@ -119,8 +119,8 @@ your web applications.
 Just open this page and check the JavaScript console.
 
 **NOTE**: Although this is possible, this is not really recommended for
-production and should only be used as a quick way to getting you hands
-on opal
+production and should only be used as a quick way to get your hands
+on opal.
 
 ## Running tests
 
@@ -133,7 +133,7 @@ Then, install dependencies:
     $ bundle install
     $ npm install -g jshint
 
-The test suite can be run using (requires [phantomjs][]):
+The test suite can be run using:
 
     $ bundle exec rake
 
@@ -231,6 +231,5 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 
 
-[phantomjs]: http://phantomjs.org
 [MSpec]: https://github.com/ruby/mspec#readme
 [RSpec]: https://github.com/rspec/rspec#readme

data/appveyor.yml

@@ -19,12 +19,11 @@ install:
   - ruby --version
   - gem --version
   - node --version
-  - gem install bundler --quiet --no-ri --no-rdoc
   - bundler --version
   - bundle
-  - choco install phantomjs --version 2.0.0 -y
-  
+
 build: off
 
+# TODO: add mspec_chrome and minitest_chrome once Chrome 60 will be released
 test_script:
-  - bundle exec rake
+  - bundle exec rake rspec mspec_nodejs minitest_nodejs minitest_node_nodejs

data/bin

@@ -0,0 +1 @@
+./exe

data/docs/headless_chrome.md

@@ -0,0 +1,105 @@
+# Headless Chrome
+
+## Requirements
+
+First of all, make sure that you have Chrome at least 59.0 installed.
+Also for now it's supported only on Mac and Linux. (version 60 may get support on Windows)
+
+## Using the runner
+
+To run your code using headless chrome, use `-R chrome` (`--runner chrome`) option:
+
+    $ opal -Rchrome -e "puts 'Hello, Opal'"
+    Hello, Opal
+
+The runner also listens for any exceptions and prints formatted stracktraces back to your console:
+
+    $ opal -Rchrome -e "
+    def raising_method
+      raise 'test error'
+    end
+
+    raising_method
+    "
+
+    RuntimeError : test error
+        at $$raise (file:///tmp/chrome-opal.js:4996:6)
+        at $$raising_method (file:///tmp/chrome-opal.js:21144:16)
+        at  (file:///tmp/chrome-opal.js:21146:14)
+        at  (file:///tmp/chrome-opal.js:21147:2)
+
+## Using exit codes
+
+By default headless chrome runner explicitly sets exit code to 1 when there was any error in the code.
+
+    $ opal -Rchrome -e "42"; echo $?
+    0
+
+    $ opal -Rchrome -e "raise 'error'"; echo $?
+    RuntimeError : error
+        at $$raise (file:///tmp/chrome-opal.js:4996:6)
+        at  (file:///tmp/chrome-opal.js:21139:14)
+        at  (file:///tmp/chrome-opal.js:21140:2)
+    1
+
+You can change final exit code by using `Kernel#exit`, but make sure to require `opal/platform` in your code.
+
+    $ opal -Rchrome -ropal/platform -e "exit(0)"; echo $?
+    0
+
+    $ opal -Rchrome -ropal/platform -e "exit(1)"; echo $?
+    1
+
+Also `Kernel#exit` doesn't abort your script. It simply takes the value that was passed to the first
+invocation and persists it in `window.OPAL_EXIT_CODE`. Later headless chrome runner extracts it from the chrome runtime.
+
+## Known limitations
+
+1. `exit` doesn't abort you script (but `raise/throw` does)
+2. When you call `console.log(one, two, three)` from your code headless chrome prints only the first passed object.
+   The reason behind it is the format of the message that chrome sends to the runner.
+   Opal intentionally uses a simplified method from Chrome API (`Console.messageAdded`) to catch `console.log` invocations.
+   (Check `lib/opal/cli_runners/chrome.js` do get more information)
+
+## Internals
+
+Under the hood when you call `opal -Rchrome -e 'your code'` Opal uses chrome runner that is defined in
+`lib/opal/cli_runners/chrome.rb`. This runner tries to connect to `localhost:9222` (9222 is a default port for a headless chrome server)
+or runs the server on its own. It detects your platform and uses a default path to the chrome executable
+(`Opal::CliRunners::Chrome#chrome_executable`) but you can override it by specifying `GOOGLE_CHROME_BINARY` environment
+variable.
+
+When the server is up and running it passes compiled js code to `node lib/opal/cli_runners/chrome.js`
+as a plain input using stdin (basically, it's a second part of the runner).
+`chrome.js` is a node js script that does the main job. It runs any provided code on the running chrome server,
+catches errors and forwards console messages.
+
+
+Moreover, you can actually call any js using headless chrome by running
+
+      $ echo "console.log('Hello, Opal')" | node lib/opal/cli_runners/chrome.js
+
+NOTE: to run it you need to have a chrome server running on `localhost:9222` (usually `chrome.rb` does it for you)
+
+      $ chrome --disable-gpu --headless --remote-debugging-port=9222
+
+## Using a remote chrome server
+
+If you want to change a default chrome port or your chrome server is running on a different host:port
+you can override default values by specifying `CHROME_HOST` and `CHROME_PORT` environment variables:
+
+      $ CHROME_HOST=10.10.10.10 CHROME_PORT=8080 opal -Rchrome -e "puts 42"
+      Connecting to 10.10.10.10:8080...
+      42
+
+NOTE: `CHROME_HOST` requires a chrome server to be started. You can't start remotely a server on a different host.
+
+
+## Additional options
+
+If you need to pass additional CLI options to the Chrome executable you can do so by setting the `CHROME_OPTS` environment variable:
+
+      $ CHROME_OPS="--window-size=412,732" opal -Rchrome -e "puts 42"
+      42
+
+_For a list of additional options see https://developers.google.com/web/updates/2017/04/headless-chrome_

data/docs/rspec.md

@@ -1,8 +1,8 @@
 # RSpec
 
 `opal-rspec` allows opal to use rspec for running specs in javascript
-environments. It comes with built-in support for running rspec with custom
-`phantomjs` and standard web browser formatters. Also, async spec examples
+environments. It comes with built-in support for running rspec with
+standard web browser formatters. Also, async spec examples
 are supported to reflect browser usage of ruby applications.
 
 ```ruby
@@ -25,23 +25,6 @@ gem 'opal-rspec'
 
 ## Running specs
 
-### phantomjs
-
-To run specs, a rake task can be added which will load all spec files
-from `spec/`:
-
-```ruby
-# Rakefile
-require 'opal/rspec/rake_task'
-Opal::RSpec::RakeTask.new(:default)
-```
-
-Then, to run your specs inside phantomjs, just run the rake task:
-
-```sh
-$ bundle exec rake
-```
-
 ### In a Browser
 
 `opal-rspec` can use sprockets to build and serve specs over a simple rack server. Add the following to a `config.ru` file:

data/lib/opal.rb

@@ -2,6 +2,7 @@
 require 'opal/config'
 require 'opal/compiler'
 require 'opal/builder'
+require 'opal/builder_processors'
 require 'opal/erb'
 require 'opal/paths'
 require 'opal/version'

data/lib/opal/ast/builder.rb

@@ -5,10 +5,6 @@ require 'parser/ruby23'
 module Opal
   module AST
     class Builder < ::Parser::Builders::Default
-      def string_value(token)
-        token[0]
-      end
-
       def n(type, children, location)
         ::Opal::AST::Node.new(type, children, location: location)
       end

data/lib/opal/builder.rb

@@ -1,17 +1,62 @@
 # frozen_string_literal: true
 require 'opal/path_reader'
-require 'opal/builder_processors'
 require 'opal/paths'
 require 'opal/config'
 require 'set'
 
 module Opal
   class Builder
-    include BuilderProcessors
+    # The registered processors
+    def self.processors
+      @processors ||= []
+    end
+
+    # All the extensions supported by registered processors
+    def self.extensions
+      @extensions ||= []
+    end
+
+    # @public
+    # Register a builder processor and the supported extensions.
+    # A processor will respond to:
+    #
+    # ## `#requires`
+    # An array of string containing the logic paths of required assets
+    #
+    # ## `#required_trees`
+    # An array of string containing the logic paths of required directories
+    #
+    # ## `#to_s`
+    # The processed source
+    #
+    # ## `#source_map`
+    # An instance of `::SourceMap::Map` representing the processd asset's source
+    # map.
+    #
+    # ## `.new(source, filename, compiler_options)`
+    # The processor will be instantiated passing:
+    # - the unprocessed source
+    # - the asset's filename
+    # - Opal's compiler options
+    #
+    # ## `.match?(path)`
+    # The processor is able to recognize paths suitable for its type of
+    # processing.
+    #
+    def self.register_processor(processor, processor_extensions)
+      return if processors.include?(processor)
+      processors << processor
+      processor_extensions.each { |ext| extensions << ext }
+    end
+
+
 
     class MissingRequire < LoadError
     end
 
+    class ProcessorNotFound < LoadError
+    end
+
     def initialize(options = nil)
       (options || {}).each_pair do |k,v|
         public_send("#{k}=", v)
@@ -19,11 +64,10 @@ module Opal
 
       @stubs             ||= []
       @preload           ||= []
-      @processors        ||= DEFAULT_PROCESSORS
-      @path_reader       ||= PathReader.new
+      @processors        ||= ::Opal::Builder.processors
+      @path_reader       ||= PathReader.new(Opal.paths, extensions.map{|e| [".#{e}", ".js.#{e}"]}.flatten)
       @prerequired       ||= []
       @compiler_options  ||= Opal::Config.compiler_options
-      @default_processor ||= RubyProcessor
 
       @processed = []
     end
@@ -38,7 +82,7 @@ module Opal
     end
 
     def build_str source, filename, options = {}
-      path = path_reader.expand(filename).to_s unless stub?(filename)
+      path = path_from_filename(filename)
       asset = processor_for(source, filename, path, options)
       requires = preload + asset.requires + tree_requires(asset, path)
       requires.map { |r| process_require(r, options) }
@@ -79,9 +123,8 @@ module Opal
 
     attr_reader :processed
 
-    attr_accessor :processors, :default_processor, :path_reader,
-                  :compiler_options, :stubs, :prerequired, :preload
-
+    attr_accessor :processors, :path_reader, :compiler_options,
+                  :stubs, :prerequired, :preload
 
 
 
@@ -110,14 +153,20 @@ module Opal
     end
 
     def processor_for(source, filename, path, options)
-      processor   = processors.find { |p| p.match? path }
-      processor ||= default_processor
-      return processor.new(source, filename, compiler_options.merge(options))
+      processor = processors.find { |p| p.match? path } or
+        raise ProcessorNotFound, "can't find processor for filename: #{filename.inspect}, path: #{path.inspect}, source: #{source.inspect}, processors: #{processors.inspect}"
+      processor.new(source, filename, compiler_options.merge(options))
     end
 
     def read(path)
       path_reader.read(path) or begin
-        message = "can't find file: #{path.inspect} in #{path_reader.paths.inspect}"
+        print_list = lambda { |list| "- #{list.join("\n- ")}\n" }
+        message = "can't find file: #{path.inspect} in:\n"+
+                  print_list[path_reader.paths]+
+                  "\nWith the following extensions:\n"+
+                  print_list[path_reader.extensions]+
+                  "\nAnd the following processors:\n"+
+                  print_list[processors]
 
         case compiler_options[:dynamic_require_severity]
         when :raise   then raise MissingRequire, message
@@ -145,12 +194,17 @@ module Opal
         end
       end
 
-      path = path_reader.expand(filename).to_s unless stub?(filename)
+      path = path_from_filename(filename)
       asset = processor_for(source, filename, path, options.merge(requirable: true))
       process_requires(filename, asset.requires+tree_requires(asset, path), options)
       processed << asset
     end
 
+    def path_from_filename(filename)
+      return if stub?(filename)
+      (path_reader.expand(filename) || File.expand_path(filename)).to_s
+    end
+
     def process_requires(filename, requires, options)
       requires.map { |r| process_require(r, options) }
     rescue MissingRequire => error
@@ -166,7 +220,7 @@ module Opal
     end
 
     def extensions
-      @extensions ||= DEFAULT_PROCESSORS.flat_map(&:extensions).compact
+      ::Opal::Builder.extensions
     end
   end
 end