opal-rails 0.2.0 → 0.2.1

data/Gemfile

@@ -4,8 +4,8 @@ source :rubygems
 gemspec
 
 
-gem 'opal-jquery', :git => 'git://github.com/adambeynon/opal-jquery.git', :require => false
-gem 'opal-spec',   :git => 'git://github.com/adambeynon/opal-spec.git',   :require => false
+gem 'opal-jquery', :git => 'git://github.com/opal/opal-jquery.git', :require => false
+gem 'opal-spec',   :git => 'git://github.com/opal/opal-spec.git',   :require => false
 
 
 # Test app stuff

data/README.md

@@ -1,8 +1,12 @@
 # Opal Rails
 
+[![Build Status](https://secure.travis-ci.org/elia/opal-rails.png)](http://travis-ci.org/elia/opal-rails)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/elia/opal-rails)
+
 _Rails (3.2+) bindings for [Opal JS](http://opalrb.org) engine._
 
 
+
 ## Installation
 
 In your `Gemfile`
@@ -12,8 +16,10 @@ gem 'opal-rails'
 ```
 
 
+
 ## Usage
 
+
 ### Asset Pipeline
 
 ``` js
@@ -32,19 +38,33 @@ and then just use the `.rb` or `.opal` extensions:
 ```ruby
 # app/assets/javascripts/hi-world.js.rb
 
-puts "G'day world!"
+puts "G'day world!" # check the console
 ```
 
 
 
+
 ### As a template
 
-You can use it for your dynamic templates too (Probably in conjunction with ERB to pass dynamic state)
+You can use it for your views too, it even inherits instance and local variables from actions:
+
+```ruby
+# app/controllers/posts_controller.rb
+
+def create
+  @post = Post.create!(params[:post])
+  render type: :js, locals: {comments_html: render_to_string(@post.comments)}
+end
+```
+
+Each assign is filtered through JSON so it's reduced to basic types:
 
 ```ruby
-# app/views/posts/show.js.opal.erb
+# app/views/posts/cerate.js.opal
 
-Element.id('<%= dom_id @post %>').show
+Document['.post .title'].html    = @post[:title]
+Document['.post .body'].html     = @post[:body]
+Document['.post .comments'].html = comments_html
 ```
 
 
@@ -55,7 +75,9 @@ Of course you need to require `haml-rails` separately since its presence is not
 ```haml
 -# app/views/posts/show.html.haml
 
-%article= post.body
+%article.post
+  %h1.title= post.title
+  .body= post.body
 
 %a#show-comments Display Comments!
 
@@ -65,9 +87,9 @@ Of course you need to require `haml-rails` separately since its presence is not
 
 :opal
   Document.ready? do
-    Element.id('show-comments').on :click do
-      Element.find('.comments').first.show
-      false # aka preventDefault
+    Document['#show-comments'].on :click do
+      Document['.comments'].first.show
+      false
     end
   end
 ```
@@ -102,22 +124,22 @@ Then visit `/opal_spec` from your app and **reload at will**.
 
 ## License
 
-Copyright © 2012 by 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
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+© 2012 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
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in
+    all copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+    THE SOFTWARE.

data/lib/opal/rails/template_handler.rb

@@ -1,10 +1,30 @@
 module Opal
   module Rails
     class TemplateHandler
+
       def self.call(template)
+        new.call(template)
+      end
+
+
+      def call(template)
         escaped = template.source.gsub(':', '\:')
-        string = '%q:' + escaped + ':;'
-        "Opal.parse(#{string})"
+        string = '%q:' + escaped + ':'
+        "Opal.parse('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
       end
     end
   end

data/lib/opal/rails/version.rb

@@ -1,6 +1,6 @@
 module Opal
   module Rails
-    VERSION = '0.2.0'
+    VERSION = '0.2.1'
     OPAL_VERSION = '0.3.22'
   end
 end

data/spec/integration/assigns_spec.rb

@@ -0,0 +1,33 @@
+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)
+    end
+  end
+
+  def get_source_of path
+    get path
+    response.should be_success
+    source = response.body
+  end
+
+  def opal_eval source
+    opal_source = get_source_of '/assets/opal.js'
+    context = ExecJS.compile opal_source
+    context.eval source
+  end
+end

data/spec/integration/{opal_spec.rb → in_browser_specs_spec.rb}

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe '/opal_spec' do
+describe 'In-browser specs runner' do
   it 'runs all specs', :js do
     visit '/opal_spec'
     page.should have_content('Running: spec')

data/test_app/app/controllers/application_controller.rb

@@ -1,3 +1,18 @@
 class ApplicationController < ActionController::Base
   protect_from_forgery
+
+  def with_assignments
+    object = Object.new
+    def object.as_json options = {}
+      {:contents => 'json representation'}
+    end
+
+    @number_var = 1234
+    @string_var = 'hello'
+    @array_var  = [1,'a']
+    @hash_var   = {:a => 1, :b => 2}
+    @object_var = object
+
+    render :type => :js, :locals => { :local_var => 'i am local' }
+  end
 end

data/test_app/app/views/application/with_assignments.js.opal

@@ -0,0 +1,31 @@
+# Fix to native which is broken on some basic types
+class Hash
+  def to_native
+    %x{
+      var result = {}, map = #{self}.map, bucket, value;
+
+      for (var assoc in map) {
+        bucket = map[assoc];
+        value  = bucket[1];
+
+        if (value.$to_native) {
+          result[assoc] = #{ `value`.to_native };
+        }
+        else {
+          result[assoc] = value;
+        }
+      }
+
+      return result;
+    }
+  end
+end
+
+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_native

data/test_app/config/routes.rb

@@ -1,4 +1,6 @@
 TestApp::Application.routes.draw do
+  get 'application/with_assignments' => 'application#with_assignments'
+
   # The priority is based upon order of creation:
   # first created -> highest priority.
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opal-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-07 00:00:00.000000000 Z
+date: 2012-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: opal
-  requirement: &70314270486520 !ruby/object:Gem::Requirement
+  requirement: &70118596042580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -21,10 +21,10 @@ dependencies:
         version: 0.3.22
   type: :runtime
   prerelease: false
-  version_requirements: *70314270486520
+  version_requirements: *70118596042580
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70314270486060 !ruby/object:Gem::Requirement
+  requirement: &70118596041060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 3.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70314270486060
+  version_requirements: *70118596041060
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70314270485560 !ruby/object:Gem::Requirement
+  requirement: &70118596039100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '2.4'
   type: :development
   prerelease: false
-  version_requirements: *70314270485560
+  version_requirements: *70118596039100
 - !ruby/object:Gem::Dependency
   name: rspec-rails
-  requirement: &70314270485100 !ruby/object:Gem::Requirement
+  requirement: &70118596037020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,7 +54,7 @@ dependencies:
         version: '2.4'
   type: :development
   prerelease: false
-  version_requirements: *70314270485100
+  version_requirements: *70118596037020
 description: Rails bindings for opal JS engine
 email:
 - elia@schito.me
@@ -87,7 +87,8 @@ files:
 - lib/tasks/opal-rails_tasks.rake
 - opal-rails.gemspec
 - script/rails
-- spec/integration/opal_spec.rb
+- spec/integration/assigns_spec.rb
+- spec/integration/in_browser_specs_spec.rb
 - spec/opal/rails/processor_spec.rb
 - spec/spec_helper.rb
 - test_app/.gitignore
@@ -98,6 +99,7 @@ files:
 - test_app/app/assets/javascripts/spec/example_spec.js.rb
 - test_app/app/assets/stylesheets/application.css
 - test_app/app/controllers/application_controller.rb
+- test_app/app/views/application/with_assignments.js.opal
 - test_app/app/views/layouts/application.html.erb
 - test_app/config.ru
 - test_app/config/application.rb
@@ -138,7 +140,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3556514632691640513
+      hash: 934058803805341785
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -147,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3556514632691640513
+      hash: 934058803805341785
 requirements: []
 rubyforge_project: opal-rails
 rubygems_version: 1.8.17
@@ -155,6 +157,7 @@ signing_key:
 specification_version: 3
 summary: Rails bindings for opal JS engine
 test_files:
-- spec/integration/opal_spec.rb
+- spec/integration/assigns_spec.rb
+- spec/integration/in_browser_specs_spec.rb
 - spec/opal/rails/processor_spec.rb
 - spec/spec_helper.rb