opal 0.7.0.beta3 → 0.7.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 56f72a2aa585530e324d1024147329f90ac699ef
-  data.tar.gz: a75ca4d5fc0abc995d98d6e9884286986fe54666
+  metadata.gz: 92e17e48bf5a163e7dae89bb90448a82ec66baa1
+  data.tar.gz: 313106590cfd949c9810a5866b1866e20de0b3cd
 SHA512:
-  metadata.gz: 2dd0158e79a73ea54fed5a02fe222606b8a4d45198c1338f3c17f902a30e37e19da3d8347d82256a2f8e70faeb31c04a6076bc16a630662c93d9c0d52b657cd7
-  data.tar.gz: f59534fa214044c4cb01096f722745db095b4c67dc4b1129b5ec70fe24d4e7653729e219847b62445281ca061f905a83a945f917b92825d43c42a1059a4be0d8
+  metadata.gz: 40b7b2836d698ab35eff8fb344335d376ccebad0b9c01998cab188ba94e0b4e77d2b9873163fbaa3d19665b916da51ec55ca76ab0d30122e175ed50dd57c1c20
+  data.tar.gz: fe4e07293db5de3a1b4441453c9f9288dcfd3db46d71679a7de247ead82fc59661f7a6f1111790f05c952b8be8e503607871330f07b24929609cceb50e49abf5

data/.gitmodules

@@ -25,3 +25,7 @@
 [submodule "spec/stdlib/rubysl-date"]
 	path = spec/stdlib/rubysl-date
 	url = https://github.com/rubysl/rubysl-date
+[submodule "test/cruby"]
+	path = test/cruby
+	url = https://github.com/ruby/ruby.git
+	branch = ruby_2_2

data/.travis.yml

@@ -1,5 +1,7 @@
 language: ruby
 
+sudo: false
+
 cache:
   bundler: true
   directories:
@@ -9,15 +11,17 @@ matrix:
   fast_finish: true
 
   include:
-    - rvm: 2.1
+    - rvm: 2.2
       env: RUN=default TZ="/usr/share/zoneinfo/Pacific/Fiji"
-      before_install: test -d node_modules || npm install
+
+    - rvm: 2.1
+      env: RUN=rspec
 
     - rvm: 1.9.3
       env: RUN=rspec
 
     - rvm: 2.0.0
-      env: RUN="rspec mspec"
+      env: RUN="rspec mspec_phantom"
 
     - rvm: rbx
       env: RUN=rspec

data/.yardopts

@@ -0,0 +1,6 @@
+lib/opal.rb
+lib/opal/**/*.rb
+--markup markdown
+-
+CHANGELOG.md
+docs/compiler_directives.md

data/CHANGELOG.md

@@ -1,5 +1,33 @@
 ## edge (upcoming 0.7)
 
+*   `Class#native_class` now also exposes `MyClass.new` (Ruby) as `Opal.global.MyClass.new()` (JS)
+
+*   Add CRuby (MRI) tests harness to start checking Opal against them too.
+
+*   Add Minitest to the stdlib.
+
+*   Add `Date#<=>` with specs.
+
+*   Show extended info and context upon parsing, compiling and building errors.
+
+*   Support keyword arguments in method calls and definitions.
+
+*   Fix `begin`/`rescue` blocks to evaluate to last expression.
+
+*   Add support for `RUBY_ENGINE/RUBY_PLATFORM != "opal"` pre-processor directives.
+
+        if RUBY_ENGINE != "opal"
+          # this code never compiles
+        end
+
+*   Fix donating methods defined in modules. This ensures that if a class includes more than one module, then the methods defined on the class respect the order in which the modules are included.
+
+*   Improved support for recursive `Hash` for both `#inspect` and `#hash`.
+
+*   Optimized `Hash` implementation for `String` and `Symbol`, they have a separate hash-table in which they're used as both keys and hashes.
+
+*   Added real `#hash` / `eql?` support, previously was relying on `.toString()`.
+
 *   `String#to_proc` now uses `__send__` instead of `send` for calling
     methods on receivers.
 

data/Gemfile

@@ -24,4 +24,4 @@ unless ENV['CI']
   gem 'terminal-notifier-guard'
 end
 
-gem 'mspec', github: 'opal/mspec'
+gem 'mspec', github: 'rubyspec/mspec'

data/README.md

@@ -27,7 +27,7 @@ See the website, [http://opalrb.org](http://opalrb.org).
 string of javascript code.
 
 ```ruby
-Opal.compile("puts 'wow'")  # => "(function() { ... })()"
+Opal.compile("puts 'wow'")  # => "(function() { ... self.$puts("wow"); ... })()"
 ```
 
 Running this by itself is not enough, you need the opal runtime/corelib.
@@ -116,17 +116,8 @@ javascript.
 
 ### stdlib
 
-Holds the stdlib that opal currently supports. This includes Observable,
-StringScanner, Date, etc.
-
-### spec
-
-* **rubyspecs** (file) a whitelist of RubySpec files to be ran
-* **corelib** RubySpec examples (submodule)
-* **stdlib** `rubysl-*` examples (submodules)
-* **filters** The list of MSpec/RubySpec examples that are either bugs or unsupported
-* **opal** opal additions/special behaviour in the runtime/corelib
-* **cli** specs for opal lib (parser, lexer, grammar, compiler etc)
+Holds the stdlib that opal currently supports. This includes `Observable`,
+`StringScanner`, `Date`, etc.
 
 ## Browser support
 

data/Rakefile

@@ -6,154 +6,8 @@ Bundler.require
 Bundler::GemHelper.install_tasks
 
 import 'tasks/github.rake'
+import 'tasks/documenting.rake'
+import 'tasks/testing.rake'
+import 'tasks/building.rake'
 
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:rspec) do |t|
-  t.pattern = 'spec/lib/**/*_spec.rb'
-end
-
-require 'mspec/opal/rake_task'
-MSpec::Opal::RakeTask.new(:mspec) do |config|
-  config.pattern = ENV['MSPEC_PATTERN'] if ENV['MSPEC_PATTERN']
-  config.basedir = ENV['MSPEC_BASEDIR'] if ENV['MSPEC_BASEDIR']
-end
-
-task :default => [:rspec, :mspec_node]
-
-
-task :mspec_node do
-  rubyspecs = File.read('spec/rubyspecs').lines.reject do |l|
-    l.strip!; l.start_with?('#') || l.empty?
-  end.flat_map do |path|
-    path = "spec/#{path}"
-    File.directory?(path) ? Dir[path+'/*.rb'] : "#{path}.rb"
-  end
-
-  filters = Dir['spec/filters/**/*.rb']
-  shared = Dir['spec/{opal,lib/parser}/**/*_spec.rb'] + ['spec/lib/lexer_spec.rb']
-
-  specs = []
-  add_specs = ->(name, new_specs) { p [new_specs.size, name]; specs + new_specs}
-
-  specs = add_specs.(:filters, filters)
-  pattern = ENV['PATTERN']
-  whitelist_pattern = !!ENV['RUBYSPECS']
-
-  if pattern
-    custom = Dir[pattern]
-    custom &= rubyspecs if whitelist_pattern
-    specs = add_specs.(:custom, custom)
-  else
-    specs = add_specs.(:shared, shared)
-    specs = add_specs.(:rubyspecs, rubyspecs)
-  end
-
-  requires = specs.map{|s| "require '#{s.sub(/^spec\//,'')}'"}
-  filename = 'tmp/mspec_node.rb'
-  mkdir_p File.dirname(filename)
-  File.write filename, <<-RUBY
-    require 'spec_helper'
-    #{requires.join("    \n")}
-    OSpecRunner.main.did_finish
-  RUBY
-
-  stubs = " -smspec/helpers/tmp -smspec/helpers/environment -smspec/guards/block_device -smspec/guards/endian"
-
-  sh 'RUBYOPT="-rbundler/setup -rmspec/opal/special_calls" '\
-     "bin/opal -Ispec -Ilib -gmspec #{stubs} -rnodejs -Dwarning -A #{filename}"
-end
-
-require 'opal/version'
-desc <<-DESC
-Build *corelib* and *stdlib* to "build/"
-
-You can restrict the file list with the FILES env var (comma separated)
-and the destination dir with the DIR env var.
-
-Example: rake dist DIR=/tmp/foo FILES='opal.rb,base64.rb'
-Example: rake dist DIR=cdn/opal/#{Opal::VERSION}
-Example: rake dist DIR=cdn/opal/master
-DESC
-task :dist do
-  require 'opal/util'
-  require 'opal/sprockets/environment'
-
-  Opal::Processor.arity_check_enabled = false
-  Opal::Processor.const_missing_enabled = false
-  Opal::Processor.dynamic_require_severity = :warning
-  env = Opal::Environment.new
-
-  build_dir = ENV['DIR'] || 'build'
-  files     = ENV['FILES'] ? ENV['FILES'].split(',') :
-              Dir['{opal,stdlib}/*.rb'].map { |lib| File.basename(lib, '.rb') }
-
-  Dir.mkdir build_dir unless File.directory? build_dir
-  width = files.map(&:size).max
-
-  files.each do |lib|
-    print "* building #{lib}...".ljust(width+'* building ... '.size)
-    $stdout.flush
-
-    src = env[lib].to_s
-    min = Opal::Util.uglify src
-    gzp = Opal::Util.gzip min
-
-    File.open("#{build_dir}/#{lib}.js", 'w+')        { |f| f << src }
-    File.open("#{build_dir}/#{lib}.min.js", 'w+')    { |f| f << min } if min
-    File.open("#{build_dir}/#{lib}.min.js.gz", 'w+') { |f| f << gzp } if gzp
-
-    print "done. ("
-    print "development: #{('%.2f' % (src.size/1000.0)).rjust(6)}KB"
-    print  ", minified: #{('%.2f' % (min.size/1000.0)).rjust(6)}KB" if min
-    print   ", gzipped: #{('%.2f' % (gzp.size/1000.0)).rjust(6)}KB" if gzp
-    puts  ")."
-  end
-end
-
-desc 'Rebuild grammar.rb for opal parser'
-task :racc do
-  %x(racc -l lib/opal/parser/grammar.y -o lib/opal/parser/grammar.rb)
-end
-
-desc 'Remove any generated file.'
-task :clobber do
-  rm_r './build'
-end
-
-namespace :doc do
-  doc_repo = Pathname(ENV['DOC_REPO'] || 'gh-pages')
-  doc_base = doc_repo.join('doc')
-  current_git_release = -> { `git rev-parse --abbrev-ref HEAD`.chomp }
-  template_option = "--template opal --template-path #{doc_repo.join('yard-templates')}"
-
-  directory doc_repo.to_s do
-    remote = ENV['DOC_REPO_REMOTE'] || '.'
-    sh 'git', 'clone', '-b', 'gh-pages', '--', remote, doc_repo.to_s
-  end
-
-  task :corelib => doc_repo.to_s do
-    git  = current_git_release.call
-    name = 'corelib'
-    glob = 'opal/**/*.rb'
-
-    command = "doxx --template #{doc_repo.join('doxx-templates/opal.jade')} "\
-              "--source opal/corelib --target #{doc_base}/#{git}/#{name} "\
-              "--title \"Opal runtime.js Documentation\" --readme opal/README.md"
-    puts command; system command or $stderr.puts "Please install doxx with: npm install"
-
-    command = "yard doc #{glob} #{template_option} "\
-              "--readme opal/README.md -o #{doc_base}/#{git}/#{name}"
-    puts command; system command
-  end
-
-  task :stdlib => doc_repo do
-    git  = current_git_release.call
-    name = 'stdlib'
-    glob = '{stdlib/**/*,opal/compiler,opal/erb,opal/version}.rb'
-    command = "yard doc #{glob} #{template_option} "\
-              "--readme stdlib/README.md -o gh-pages/doc/#{git}/#{name}"
-    puts command; system command
-  end
-end
-
-task :doc => ['doc:corelib', 'doc:stdlib']
+task :default => [:rspec, :mspec_node, :cruby_tests]

data/bin/opal-mspec

@@ -7,4 +7,4 @@ pattern = %Q{MSPEC_PATTERN="{#{specs.join(',')}}"} if specs.any?
 command = [pattern, 'rake mspec'].compact.join(' ')
 exec command
 
-# bundle exec mspec run -t opal -pspec/corelib/spec_helper spec/corelib/core/true/*
+# RUBYOPT="-rbundler/setup -rmspec/opal/special_calls" bundle exec mspec run -t opal -pspec/corelib/spec_helper spec/corelib/core/true/*

data/docs/compiler_directives.md

@@ -0,0 +1,127 @@
+# @title Compiler Directives
+
+# Compiler Directives
+
+The Opal compiler supports some special directives that can optimize or
+enhance the output of compiled ruby code to suit the ruby environment.
+
+## Require Directive
+
+All calls to `require` are captured so that the compiler and build tools
+can determine which dependencies a file has. In the case of `Builder`,
+these are collated and then added to a list of files to be processed.
+
+### `require`
+
+Assuming we have a file `foo.rb`:
+
+    # foo.rb
+    require 'bar'
+    require 'baz'
+
+The compiler will collect these two dependencies, and then `Builder`
+will attempt to discover them within the opal load path to also compile
+them into the target output. If these dependencies cannot be resolved,
+then a compile time error will be thrown.
+
+#### Dynamic Requires
+
+Opal only supports hard-coded requires. This means that any dynamically
+generated require statemnts cannot be discoeverd. Opal may raise an
+error or just produce a warning if a dynamic require is used. A dynamic
+require is any require that cannot be resolved using static analysis. A
+common use case of dynamic requires is to include a directory of ruby
+files. In this case, see `require_tree` below.
+
+### `require_relative`
+
+`require_relative` is also supported by opals compiler for ahead-of-time
+inclusion.
+
+    # foo.rb
+    require_relative 'bar'
+
+This example will try to resolve `bar.rb` in the same directory.
+
+### `autoload`
+
+`autoload` is used to load a modules and classes within a modules
+namespace. Aslong as the string argument given to `autoload` can be
+resolved in Opals load paths, in the same way as `require`, then these
+referenced dependencies will also be compiled.
+
+    # foo.rb
+    module Foo
+      autoload :Bar, 'bar'
+    end
+
+In this example, `bar.rb` will also be required.
+
+### `require_tree`
+
+`require_tree` can be used as an Opal friendly alternative to globbing
+over a directory to require a list of dependencies.
+
+    # foo.rb
+    require_tree './models'
+
+This will, at compile time, resolve all files inside the `models/`
+directory and also compile them to the output. At runtime this method
+will then loop over all modules defined, and require them if they match
+that given module path.
+
+Note: The given directory **must** be inside Opals load path, otherwise
+no files will be compiled.
+
+### Handling non-ruby requirements
+
+Opal's `require` method is also special as it allows non-ruby source
+files to be required and generated in the output. The obvious example of
+this is requiring javascript source files. Javascript sources are
+treated as first class citizens in Opal. The  Opal gem also supports
+compiling `.erb` files using the same process.
+
+## Opal Specific Code Compilation
+
+A special case `if` and `unless` statements can hide or show blocks of
+code from the Opal compiler. These check against `RUBY_ENGINE` or
+`RUBY_PLATFORM`. As these are valid ruby statements against constants
+that exist in all ruby runtimes, they will not affect any running code:
+
+    if RUBY_ENGINE == 'opal'
+      # this code compiles
+    else
+      # this code never compiles
+    end
+
+Unless statements are also supported:
+
+    unless RUBY_ENGINE == 'opal'
+      # this code will not run
+    end
+
+Also `!=` statements work:
+
+    if RUBY_ENGINE != 'opal'
+      puts "do not run this code"
+    end
+
+These blocks of code dont run at all at runtime, but they also never
+compile so will never be in the output javascript code. This is
+particularly useful for using code in both mri and Opal.
+
+Some uses are:
+
+  * Avoid `require` statements being picked up by Opal compile time
+    require handling.
+
+  * To stop certain requires taking place for opal (and vice-versa for
+    shared libraries).
+
+  * To wrap x-strings which might break in compiled javascript output.
+
+  * To simply avoid compiling large blocks of code that are not needed
+    in the javascript/opal version of an app.
+
+In all these examples `RUBY_PLATFORM` can be used instead of
+`RUBY_ENGINE`.

data/examples/rack/.gitignore

@@ -0,0 +1 @@
+tmp

data/examples/rack/app/user.rb

@@ -1,5 +1,6 @@
 class User
   def initialize(name)
+    puts "wow"
     @name = name
   end
 

data/lib/mspec/opal/special_calls.rb

@@ -1,9 +1,10 @@
 require 'opal/nodes'
+
 class Opal::Nodes::CallNode
   # Rubyspec uses this call to load in language specific features at runtime.
   # We can't do this at runtime, so handle it during compilation
   add_special :language_version do
-    if meth == :language_version and scope.top?
+    if scope.top?
       lang_type = arglist[2][1]
       target = "corelib/language/versions/#{lang_type}_1.9"
 
@@ -16,7 +17,19 @@ class Opal::Nodes::CallNode
   end
 
   add_special :not_supported_on do
-    unless meth == :not_supported_on and arglist[1][1] == :opal
+    unless arglist.flatten.include? :opal
+      compile_default!
+    end
+  end
+
+  add_special :platform_is_not do
+    unless arglist.flatten.include? :opal
+      compile_default!
+    end
+  end
+
+  add_special :platform_is do
+    if arglist.flatten.include? :opal
       compile_default!
     end
   end