opal-rails 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed236f416a615a09d374712bcdc11ddc57c316ee
-  data.tar.gz: b4912b61deeacf0f1ff22f12abb3082c4c9e9a8f
+  metadata.gz: 36eac0db3f7ca54d4e90348a784fc39719be3524
+  data.tar.gz: db4a917040f7c9869303fa76131dde1f297135d3
 SHA512:
-  metadata.gz: e79a4ca05c7917dacdc1af9a37cfd23b5d394b7e3158b9bcd4bcbf181c63ca678ca39606c1c3cb8a72591d0343a8e50bd529f06f832ddf8420d0fe1511239aa1
-  data.tar.gz: 42f971503e34be50854cfc28cbad4669a7b9e498c669797e677002216e9662f36a4a6932b52c01267915aa5e295291c6214b6895b9db96f14ab981068dc4a04c
+  metadata.gz: c79a5503e7c54e39c83f71349e053a5cb5c3eca1d6d1cc93847813b560f14fb05396fa885562ea088b36db64a573b6f788adf82096413a53926f5f4d6aa17722
+  data.tar.gz: 78332734b60237a4e77a6797d76c659bf6b9e5b3013098973c93c33d53bff27dd3a2127d87d37f3945887e2ff40ebe59ac577b865f0d229f4459fe83e35ff237

data/.travis.yml

@@ -6,9 +6,9 @@ cache:
   bundler: true
 
 rvm:
-  - 2.3.0
-  - 2.2.3
-  - 2.1.6
+  - 2.3.3
+  - 2.2.4
+  - 2.1.10
   - 2.0.0
 
 before_script:

data/Appraisals

@@ -7,5 +7,5 @@ appraise "rails-4-2" do
 end
 
 appraise "rails-5" do
-  gem "rails", "~> 5.0.0.beta1"
+  gem "rails", "~> 5.0.0"
 end if  Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.2.2')

data/CHANGELOG.md

@@ -22,7 +22,22 @@ Whitespace conventions:
 
 
 
-## [0.9.0] - Unreleased
+## [0.9.1] - 2016-11-30
+
+
+### Added
+
+- Added ability to disable passing local and instance variables to the Opal template handler by setting `Rails.application.config.opal.assigns_in_templates = false` in `config/initializers/assets.rb` (thanks to @lorefnon)
+- Added dependency to `opal-sprockets` in preparation for Opal 0.11
+
+
+### Changed
+
+- Simplified the Opal file generated for a controller
+
+
+
+## [0.9.0] - 2016-06-16
 
 
 ### Added
@@ -136,7 +151,12 @@ Whitespace conventions:
 - Add `opal_ujs`, now it's possible to use Opal for new Rails apps: `rails new <app-name> -j opal`
 - Updated README examples
 
-[0.9.0]: https://github.com/opal/opal-rails/compare/v0.8.1...HEAD
+
+
+
+[Unreleased]: https://github.com/opal/opal-rails/compare/v0.9.1...HEAD
+[0.9.1]: https://github.com/opal/opal-rails/compare/v0.9.0...v0.9.1
+[0.9.0]: https://github.com/opal/opal-rails/compare/v0.8.1...v0.9.0
 [0.8.1]: https://github.com/opal/opal-rails/compare/v0.8.0...v0.8.1
 [0.8.0]: https://github.com/opal/opal-rails/compare/v0.7.0...v0.8.0
 [0.7.0]: https://github.com/opal/opal-rails/compare/v0.6.3...v0.7.0

data/Gemfile

@@ -1,2 +1,6 @@
 source 'https://rubygems.org'
 gemspec
+
+if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.2.2')
+  gem 'rails', '< 5'
+end

data/README.md

@@ -27,82 +27,78 @@ rails new <app-name> --javascript=opal
 
 ### Configuration
 
-Add your configuration in `config/application.rb` with the following contents:
+Add your configuration in `config/initializers/assets.rb` with the following contents:
 
 ```ruby
-module MyApp
-  class Application < Rails::Application
-    # These are the available options with their default values
-
-    # Compiler options
-    config.opal.method_missing      = true
-    config.opal.optimized_operators = true
-    config.opal.arity_check         = false
-    config.opal.const_missing       = true
-    config.opal.dynamic_require_severity = :ignore
-
-    # Enable/disable /opal_specs route
-    config.opal.enable_specs = true
-
-    # The path to opal specs from Rails.root
-    config.opal.spec_location = 'spec-opal'
-  end
-end
+# Compiler options
+Rails.application.config.opal.method_missing           = true
+Rails.application.config.opal.optimized_operators      = true
+Rails.application.config.opal.arity_check              = !Rails.env.production?
+Rails.application.config.opal.const_missing            = true
+Rails.application.config.opal.dynamic_require_severity = :ignore
 ```
 
-
-## Usage
+For a full list of the available configuration options please refer to: [lib/opal/config.rb](https://github.com/opal/opal/blob/master/lib/opal/config.rb).
 
 
-### Asset Pipeline
 
-You can rename `app/assets/javascripts/application.js` to `application.js.rb`. Even if not necessary, it is recommended to change Sprockets' `//= require` statements to Ruby' `require` methods.
-Sprockets' `//= require` statements won't be known by the opal builder and therefore you can end up adding something twice.
+## Usage
 
-For Opal 0.8 and above, you have to use `application.js.rb` with the following syntax:
+Rename `app/assets/javascripts/application.js` to `app/assets/javascripts/application.js.rb` and
+replace the Sprockets directives with plain requires as follows:
 
 ```ruby
-# app/assets/javascripts/application.js.rb
-
 require 'opal'
 require 'opal_ujs'
 require 'turbolinks'
-require_tree '.'
-```
+require_tree '.' # a Ruby equivalent of the require_tree Sprockets directive is available
 
-If you want to use `application.js`, you need to `load` the Opal modules(files) manually, e.g.:
+# ---- YOUR FANCY RUBY CODE HERE ----
+#
+# Examples:
 
-```
-// application.js
-//= require opal
-//= require greeter
-//= require_self
-Opal.load('greeter');
-```
+# == Print something in the browser's console
+puts "Hello world!"
+pp hello: :world
+require 'console'
+$console.log %w[Hello world!]
 
-As you see in the example above, Opal also gives you a Ruby equivalent of `//= require_tree`.
+# == Use Native to wrap native JS objects, $$ is preconfigured to wrap `window`
+require 'native'
+$$.alert "Hello world!"
 
-Opal requires are forwarded to the Asset Pipeline at compile time (similarly to what happens for RubyMotion). You can use either the `.rb` or `.opal` extension:
-
-```ruby
-# app/assets/javascripts/greeter.js.rb
-
-puts "G'day world!" # check the console!
-
-# Dom manipulation
+# == Do some DOM manipulation with jQuery
 require 'opal-jquery'
-
 Document.ready? do
-  Element.find('body > header').html = '<h1>Hi there!</h1>'
+  Element.find('body').html = '<h1>Hello world!</h1>'
 end
+
+# == Or access the DOM api directly
+$$[:document].addEventListener(:DOMContentLoaded, -> {
+  $$[:document].querySelector('body')[:innerHTML] = '<h1>Hello world!</h1>'
+})
+
 ```
 
 
+### Using Sprockets directives
+
+If you want to use `application.js` (instead of `application.js.rb`) and keep Sprockets directives, you'll need to load the Opal files you require via Sprockets manually, e.g.:
+
+```js
+//= require opal
+//= require opal_ujs
+//= require turbolinks
+//= require_tree .
+//= require foobar
+
+Opal.load('foobar');
+```
 
 
 ### As a template
 
-You can use it for your views too, it even inherits instance and local variables from actions:
+You can use it for your views too:
 
 ```ruby
 # app/controllers/posts_controller.rb
@@ -113,7 +109,7 @@ def create
 end
 ```
 
-Each assign is filtered through JSON so it's reduced to basic types:
+Assigned instance that would normally be available in your views are converted to JSON objects first.
 
 ```ruby
 # app/views/posts/create.js.opal
@@ -124,6 +120,17 @@ post.find('.body').html     = @post[:body]
 post.find('.comments').html = comments_html
 ```
 
+#### Instance and local variables in templates
+
+By default `opal-rails` will forward any instance and local variable you'll pass to the template.
+
+This behavior can be disabled by setting `Rails.application.config.opal.assigns_in_templates` to `false` in `config/initializers/assets.rb`:
+
+```ruby
+Rails.application.config.opal.assigns_in_templates = false
+```
+
+
 
 ### As a Haml filter (optional)
 
@@ -156,14 +163,15 @@ Of course you need to require `haml-rails` separately since its presence is not
 
 ### RSpec support
 
-_Extracted to [`opal-rspec-rails`](https://github.com/opal/opal-rspec-rails)_
+_Extracted to (unreleased) [`opal-rspec-rails`](https://github.com/opal/opal-rspec-rails)_
 
-Add this line to your `Gemfile`
+Add this line to your `Gemfile`:
 
 ```ruby
 gem 'opal-rspec-rails', github: 'opal/opal-rspec-rails'
 ```
 
+
 ### Minitest support
 
 _Upcoming as `opal-minitest-rails`_
@@ -171,7 +179,7 @@ _Upcoming as `opal-minitest-rails`_
 
 ### Shared templates
 
-As long as the templates are inside the sprockets/opal load path, then you should be able to just require them.
+As long as the templates are inside the Sprockets/Opal load path, then you should be able to just require them.
 
 Let's say we have this template `app/views/shared/test.haml`:
 
@@ -206,7 +214,7 @@ template.render(self)
 
 ### Using Ruby gems from Opal
 
-Just use `Opal.use_gem` in your asset initializer (in `config/initializers`).
+Just use `Opal.use_gem` in your asset initializer (`config/initializers/assets.rb`).
 
 Example:
 
@@ -218,7 +226,7 @@ Opal.use_gem 'cannonbol'
 
 ## License
 
-© 2012-2015 Elia Schito
+© 2012-2016 Elia Schito
 
     Permission is hereby granted, free of charge, to any person obtaining a copy
     of this software and associated documentation files (the "Software"), to deal

data/lib/opal/rails/engine.rb

@@ -10,6 +10,7 @@ module Opal
       config.opal = ActiveSupport::OrderedOptions.new
 
       config.opal.dynamic_require_severity = :ignore
+      config.opal.assigns_in_templates = true
 
       # Cache eager_load_paths now, otherwise the assets dir is added
       # and its .rb files are eagerly loaded.

data/lib/opal/rails/template_handler.rb

@@ -6,24 +6,20 @@ module Opal
         new.call(template)
       end
 
-
       def call(template)
         escaped = template.source.gsub(':', '\:')
         string = '%q:' + escaped + ':'
-        "Opal.compile('Object.new.instance_eval {' << #{assigns} << #{local_assigns} << #{string} << '}')"
-      end
-
-      private
-
-      def local_assigns
-        <<-'RUBY'.strip
-          JSON.parse(local_assigns.to_json).map { |key, val| "#{key} = #{val.inspect};" }.join
-        RUBY
-      end
 
-      def assigns
-        <<-'RUBY'.strip
-          JSON.parse(@_assigns.to_json).map { |key, val| "@#{key} = #{val.inspect};" }.join
+        <<-RUBY
+          code = []
+          code << 'Object.new.instance_eval {'
+          if ::Rails.application.config.opal.assigns_in_templates
+            code << JSON.parse(local_assigns.to_json).map { |key, val| "\#{key} = \#{val.inspect};" }.join
+            code << JSON.parse(@_assigns.to_json).map { |key, val| "@\#{key} = \#{val.inspect};" }.join
+          end
+          code << #{string}
+          code << '}'
+          Opal.compile(code.join("\n"))
         RUBY
       end
     end

data/lib/opal/rails/version.rb

@@ -1,5 +1,5 @@
 module Opal
   module Rails
-    VERSION = '0.9.0'
+    VERSION = '0.9.1'
   end
 end

data/lib/rails/generators/opal/assets/assets_generator.rb

@@ -1,21 +1,11 @@
 require 'rails/generators/named_base'
-require 'rails/generators/resource_helpers'
 
 module Opal
   module Generators
     class AssetsGenerator < ::Rails::Generators::NamedBase
-      include ::Rails::Generators::ResourceHelpers
       source_root __dir__+'/templates'
-
-      def initialize(*args)
-    
-        module_name = ::Rails::Generators.const_defined?('ModelHelpers') ? 'ModelHelpers' : 'ResourceHelpers'
-        ::Rails::Generators.const_get(module_name).skip_warn = true
-        super
-      end
-
       def copy_opal
-        template 'javascript.js.rb', File.join('app/assets/javascripts', "#{controller_name.underscore}_view.js.rb")
+        template 'javascript.js.rb', File.join('app/assets/javascripts', class_path, "#{file_name}.js.rb")
       end
     end
   end

data/lib/rails/generators/opal/assets/templates/javascript.js.rb

@@ -6,37 +6,40 @@
 # Here's an example view class for your controller:
 #
 <% if namespaced? -%>
-#= require opal
-#= require <%= namespaced_file_path %>
+require <%= namespaced_file_path.to_s.inspect %>
 
 <% end -%>
 <% module_namespacing do -%>
-class <%= controller_class_name %>View
-  def initialize(selector = 'body.controller-<%= controller_class_name.underscore %>', parent = Element)
-    @element = parent.find(selector)
-    setup
+class <%= class_name %>View
+  # We should have <body class="controller-<%%= controller_name %>"> in layouts
+  def initialize(selector = 'body.controller-<%= class_name.underscore %>')
+    @selector = selector
   end
-  attr_reader :element
 
   def setup
-    # Put here the setup for the view behavior
-    say_hello_when_a_link_is_clicked
+    on(:click, 'a', &method(:link_clicked))
   end
 
-  def say_hello_when_a_link_is_clicked
-    all_links.on :click do |event|
-      # Use prevent_default to stop default behavior (as you would do in jQuery)
-      # event.prevent_default
-
-      puts "Hello! (You just clicked on a link: #{event.current_target.text})"
-    end
+  def link_clicked(event)
+    event.prevent
+    puts "Hello! (You just clicked on a link: #{event.current_target.text})"
   end
 
 
   private
 
-  def all_links
-    @all_links ||= element.find('a')
+  attr_reader :selector, :element
+
+  # Look for elements in the scope of the base selector
+  def find(selector)
+    Element.find("#{@selector} #{selector}")
+  end
+
+  # Register events on document to save memory and be friends to Turbolinks
+  def on(event, selector = nil, &block)
+    Element[`document`].on(event, selector, &block)
   end
 end
+
+<%= class_name %>View.new.setup
 <% end -%>

data/opal-rails.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.version     = Opal::Rails::VERSION
   s.authors     = ['Elia Schito']
   s.email       = ['elia@schito.me']
-  s.homepage    = 'http://elia.github.com/opal-rails'
+  s.homepage    = 'https://github.com/opal/opal-rails#readme'
   s.summary     = %q{Rails bindings for opal JS engine}
   s.description = %q{Rails bindings for opal JS engine}
   s.license     = 'MIT-LICENSE'
@@ -27,9 +27,11 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'rails',               '>= 4.0', '< 6.0'
   s.add_dependency 'sprockets-rails',     '< 3.0'
+  s.add_dependency 'jquery-rails'
+
   s.add_dependency 'opal',                '>= 0.8.0', '< 0.11'
   s.add_dependency 'opal-jquery',         '~> 0.4.0'
-  s.add_dependency 'jquery-rails'
+  s.add_dependency 'opal-sprockets',      '~> 0.4.0'
   s.add_dependency 'opal-activesupport',  '>= 0.0.5'
 
   s.add_development_dependency 'execjs'

data/spec/integration/assigns_spec.rb

@@ -2,20 +2,46 @@ require 'spec_helper'
 require 'execjs'
 
 describe 'controller assignments' do
-  it 'are in the template' do
-    source = get_source_of '/application/with_assignments.js'
-    source.gsub!(/;\s*\Z/,'') # execjs eval doesn't like the trailing semicolon
-    assignments = opal_eval(source)
-
-    {
-      :number_var => 1234,
-      :string_var => 'hello',
-      :array_var  => [1,'a'],
-      :hash_var   => {:a => 1, :b => 2}.stringify_keys,
-      :object_var => {:contents => 'json representation'}.stringify_keys,
-      :local_var  => 'i am local',
-    }.each_pair do |ivar, assignment|
-      assignments[ivar.to_s].should eq(assignment)
+  context 'when enabled' do
+    before do
+      Rails.application.config.opal.assigns_in_templates = true
+    end
+
+    it 'are in the template' do
+      source = get_source_of '/application/with_assignments.js'
+      assignments = opal_eval(source)
+
+      {
+        :number_var => 1234,
+        :string_var => 'hello',
+        :array_var  => [1,'a'],
+        :hash_var   => {:a => 1, :b => 2},
+        :object_var => {:contents => 'json representation'},
+        :local_var  => 'i am local',
+      }.each_pair do |ivar, assignment|
+        expect(assignments[ivar]).to eq(assignment)
+      end
+    end
+  end
+
+  context 'when disabled' do
+    before do
+      Rails.application.config.opal.assigns_in_templates = false
+    end
+
+    it 'are not in the template' do
+      source = get_source_of '/application/with_assignments.js'
+      assignments = opal_eval(source)
+      {
+        :number_var => 1234,
+        :string_var => 'hello',
+        :array_var  => [1,'a'],
+        :hash_var   => {:a => 1, :b => 2},
+        :object_var => {:contents => 'json representation'},
+        :local_var  => 'i am local',
+      }.each_pair do |ivar, assignment|
+        expect(assignments[ivar]).not_to eq(assignment)
+      end
     end
   end
 
@@ -26,15 +52,16 @@ describe 'controller assignments' do
   end
 
   def opal_eval source
+    source = source.gsub(/;\s*\Z/,'') # execjs eval doesn't like the trailing semicolon
     builder = Opal::Builder.new
     builder.build 'opal'
 
     # Any lib should be already required in the page,
     # require won't work in this kind of templates.
-    builder.build 'native'
+    builder.build 'json'
 
     context = ExecJS.compile builder.to_s
-    context.eval source
+    JSON.parse context.eval(source), symbolize_names: true
   rescue
     $!.message << "\n\n#{source}"
     raise

data/spec/integration/template_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe 'template handler' do
+  it 'has the correct content type' do
+    get '/application/with_assignments.js'
+    expect(response).to be_success
+    expect(response.headers['Content-Type']).to eq('text/javascript; charset=utf-8')
+  end
+end

data/spec/support/reset_config.rb

@@ -0,0 +1,5 @@
+RSpec.configure do |config|
+  config.before(:each) {
+    Rails.application.config.opal.assigns_in_templates = true
+  }
+end

data/test_apps/application_controller.rb

@@ -12,16 +12,7 @@ raise 'pippo'
 </script>
 HTML
 
-WITH_ASSIGNMENTS = <<-RUBY
-return {
-  number_var: @number_var,
-  string_var: @string_var,
-  array_var:  @array_var,
-  hash_var:   @hash_var,
-  object_var: @object_var,
-  local_var:  local_var
-}.to_n
-RUBY
+WITH_ASSIGNMENTS = File.read "#{__dir__}/assets/javascripts/with_assignments.js.rb"
 
 class ApplicationController < ActionController::Base
   include Rails.application.routes.url_helpers

data/test_apps/assets/javascripts/with_assignments.js.rb

@@ -0,0 +1,9 @@
+require 'json'
+return {
+  number_var: @number_var,
+  string_var: @string_var,
+  array_var:  @array_var,
+  hash_var:   @hash_var,
+  object_var: @object_var,
+  local_var:  defined?(local_var) ? local_var : nil
+}.to_json

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opal-rails
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Elia Schito
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-16 00:00:00.000000000 Z
+date: 2016-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -44,6 +44,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: opal
   requirement: !ruby/object:Gem::Requirement
@@ -79,19 +93,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.4.0
 - !ruby/object:Gem::Dependency
-  name: jquery-rails
+  name: opal-sprockets
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: opal-activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -214,7 +228,6 @@ files:
 - ".gitignore"
 - ".powder"
 - ".rspec"
-- ".spectator.rb"
 - ".travis.yml"
 - Appraisals
 - CHANGELOG.md
@@ -238,18 +251,21 @@ files:
 - spec/helpers/opal_helper_spec.rb
 - spec/integration/assigns_spec.rb
 - spec/integration/source_map_spec.rb
+- spec/integration/template_spec.rb
 - spec/spec_helper.rb
 - spec/support/capybara.rb
 - spec/support/reset_assets_cache.rb
+- spec/support/reset_config.rb
 - spec/support/test_app.rb
 - test_apps/application_controller.rb
 - test_apps/assets/javascripts/application.js.rb
 - test_apps/assets/javascripts/bar.rb
 - test_apps/assets/javascripts/foo.js.rb
 - test_apps/assets/javascripts/source_map_example.js.rb
+- test_apps/assets/javascripts/with_assignments.js.rb
 - test_apps/rails4.rb
 - test_apps/rails5.rb
-homepage: http://elia.github.com/opal-rails
+homepage: https://github.com/opal/opal-rails#readme
 licenses:
 - MIT-LICENSE
 metadata: {}
@@ -271,7 +287,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: opal-rails
-rubygems_version: 2.6.4
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Rails bindings for opal JS engine
@@ -279,7 +295,9 @@ test_files:
 - spec/helpers/opal_helper_spec.rb
 - spec/integration/assigns_spec.rb
 - spec/integration/source_map_spec.rb
+- spec/integration/template_spec.rb
 - spec/spec_helper.rb
 - spec/support/capybara.rb
 - spec/support/reset_assets_cache.rb
+- spec/support/reset_config.rb
 - spec/support/test_app.rb

data/.spectator.rb

@@ -1 +0,0 @@
-ENV['RSPEC_COMMAND'] = 'rspec'