rbjs 0.9.14 → 0.9.15

data/lib/rbjs.rb

@@ -26,33 +26,33 @@ module Rbjs
         extend @_view_context.helpers
       end
       @_block = block
-      @_called_statements = []
+      @_called_expressions = []
     end
     
     def evaluate function_parameters = nil
       instance_exec *function_parameters, &@_block
-      @_called_statements.map(&:last_of_chain).reject(&:is_argument).map(&:to_s).join(";\n")
+      @_called_expressions.map(&:last_of_chain).reject(&:is_argument).map(&:to_s).join(";\n")
     end
     
     def method_missing name, *args, &block
       if @_view_context and @_view_context.respond_to?(name)
         @_view_context.send name, *args, &block
       else
-        statement = Statement.new name, @_view_context, *args, &block
-        @_called_statements << statement
-        statement
+        expression = Expression.new name, @_view_context, *args, &block
+        @_called_expressions << expression
+        expression
       end
     end
     alias_method :const_missing, :method_missing
     
     def << line
-      @_called_statements << Statement.new(line)
+      @_called_expressions << Expression.new(line)
     end
   end
   
-  class Statement
-    attr_accessor :parent_statement
-    attr_accessor :child_statement
+  class Expression
+    attr_accessor :parent_expression
+    attr_accessor :child_expression
     attr_accessor :is_argument
     
     def initialize name, view_context = nil, *args, &block
@@ -63,21 +63,21 @@ module Rbjs
     end
     
     def method_missing name, *args, &block
-      statement = Statement.new name, @_view_context, *args, &block
-      statement.parent_statement = self
-      self.child_statement = statement
-      statement
+      expression = Expression.new name, @_view_context, *args, &block
+      expression.parent_expression = self
+      self.child_expression = expression
+      expression
     end
     
     def to_s
       if ['+','-','*','/'].include?(@name)
-        @parent_statement.to_s + @name + @arguments.first
+        @parent_expression.to_s + @name + @arguments.first
       elsif @name == '[]='
-        @parent_statement.to_s + '[' + @arguments.first + ']= ' + @arguments.last
+        @parent_expression.to_s + '[' + @arguments.first + ']= ' + @arguments.last
       elsif @name == '[]'
-        @parent_statement.to_s + '[' + @arguments.first + ']'
-      elsif @parent_statement
-        parent_str = @parent_statement.to_s
+        @parent_expression.to_s + '[' + @arguments.first + ']'
+      elsif @parent_expression
+        parent_str = @parent_expression.to_s
         parent_str += parent_str == 'var' ? ' ' : '.'
         parent_str + @name + argument_list
       else
@@ -91,15 +91,15 @@ module Rbjs
     end
     
     def last_of_chain
-      if @child_statement
-        @child_statement.last_of_chain
+      if @child_expression
+        @child_expression.last_of_chain
       else
         self
       end
     end
     
     def to_argument arg
-      if arg.is_a?(Statement)
+      if arg.is_a?(Expression)
         arg.is_argument = true
         arg.to_s
       elsif arg.is_a?(ArgumentProxy)
@@ -117,6 +117,8 @@ module Rbjs
           function_parameters << ArgumentProxy.new(root, param[1])
         end
         "function(#{function_parameter_names.join ', '}) {\n#{root.evaluate function_parameters}}"
+      elsif arg.is_a?(Regexp)
+        arg.inspect
       else
         arg.to_json
       end
@@ -130,8 +132,8 @@ module Rbjs
     end
 
     def method_missing name, *args, &block
-      statement = @root.send(@name)
-      statement.send name, *args, &block
+      expression = @root.send(@name)
+      expression.send name, *args, &block
     end
 
     def to_s

data/lib/rbjs/version.rb

@@ -1,3 +1,3 @@
 module Rbjs
-  VERSION = "0.9.14"
+  VERSION = "0.9.15"
 end

data/readme.md

@@ -1,113 +1,17 @@
-## RJS IS BACK
+# Remote Javascript for Ruby on Rails 3.1
 
-### And it's better than ever before.
-
-Rbjs is a modern RJS (remote javascript) extension for Rails 3 and up. It stands for **r**u**b**y**j**ava**s**cript. In contrast to prototype-rails, this library is designed to work with all javascript frameworks.
-
-However, it is *not* a drop-in replacement for _.rjs_ -- it does things quite differently.
-
-This is a very fresh gem. Feel free to test it while the documentation and tests are still being written. I've added some examples to this readme file. These should help you get a general idea of what this is about.
+Rbjs is a ruby gem that enables you to write remote javascript in Rails 3. It keeps the browser logic-less. [read more](http://buhrmi.github.com/rbjs)
 
 ## Installation
 
-Add the following line to your Gemfile
-
-> gem 'rbjs'
-
-and run _bundle install_ to install the gem and it's dependencies.
-
-## Examples
-
-### Take a look at a simple example:
-  
-    # controllers/greeter_controller.rb
-    def greet_me
-      render :js do
-        window.alert "Hello, #{current_user_name}"
-      end
-    end
-
-    # views/greeter/index.html.erb
-    link_to "Hi there!", "/greeter/greet_me", :remote => true
-
-### And a more complex example:
-
-    # controllers/posts_controller.rb
-    def refresh
-      post = Post.find params[:id]
-      render :js do
-        post_element = jQuery(post.selector)
-        post_element.html(render post)
-        post_element.css(:opacity => 0).animate(:opacity => 1)
-      end
-    end
-
-    # views/posts/index.html.erb
-    link_to "Refresh Post", refresh_post_path(post), :remote => true
+Add the line
 
-### You can also create .rbjs templates:
-
-    # controllers/posts_controller.rb
-    def refresh_all
-      @posts = Post.limit(10)
-    end
-
-    # views/posts/refresh_all.js.rbjs
-    for post in @posts
-      jQuery(post.selector).html(render post)
-    end
-
-### Do complex stuff:
-
-    # controllers/posts_controller.rb
-    def increase_counter
-      @increment = 4
-    end
-    
-    # views/posts/increase_counter.js.rbjs
-    allCounters = jQuery('.post.counter')
-    allCounters.each do |index, element|
-      element = jQuery(element)
-      currentValue = element.html!.to_i!
-      element.html(currentValue + @increment)
-    end
+    gem 'rbjs'
     
-    # And the rendered result. Note the behavior of local variables.
-    jQuery(".post.counter").each(
-      function(index, element) {
-        jQuery(element).html(jQuery(element).html().to_i()+4)
-      }
-    )
-    
-    
-    # Here is the same example, this time declaring the variables in javascript 
-    # by prefixing them with var.
-    # views/posts/increase_counter.js.rbjs
-    var.allCounters = jQuery('.post.counter')
-    allCounters.each do |index, element|
-      var.element = jQuery(element)
-      var.currentValue = element.html!.to_i!
-      element.html(currentValue + @increment)
-    end
+to your Gemfile and run
 
-    # And the rendered result:
-    var allCounters=(jQuery(".post.counter"));
-    allCounters.each(function(index, element) {
-      var element=(jQuery(element));
-      var currentValue=(element.html().to_i());
-      element.html(currentValue+4)
-    })
+    bundle install
     
-### And even more stuff
+## Usage
 
-    # Raw Javascript:
-    self << 'myFunc($)'
-    
-    # Hashes and Arrays
-    foo[3]= {name => @user.name}
-    
-    # lambdas
-    func = lambda{ window.alert(@message)}
-    setTimeout func, 1000
-    
-More to come.
+Please refer to the [documentation](http://buhrmi.github.com/rbjs) for a quick example and usage guide.

data/spec/rbjs_spec.rb

@@ -0,0 +1,136 @@
+require 'rbjs'
+
+describe Rbjs::Root, '#evaluate' do
+
+	def dummy_context
+		Struct.new(:assigns).new 'instance_var' => "Instance"
+		#@instance_var = "Instance"
+	end
+
+  def build &block
+  	js = Rbjs::Root.new dummy_context, &block
+  	js.evaluate
+  end
+
+	it "should call simple functions" do
+    js = build do
+      alert "hi"
+    end
+    js.strip.should == 'alert("hi")'
+  end
+
+
+  it "should call nested functions" do
+    js = build do
+      alert(hey(123, :foo), ho('wow', level3(:yey)))
+    end
+    js.strip.should == 'alert(hey(123, "foo"), ho("wow", level3("yey")))'
+  end
+  
+  it "should call simple functions on objects" do
+    js = build do
+      window.alert "hi"
+    end
+    js.strip.should == 'window.alert("hi")'
+  end
+  
+  it "should distinguish between property access and method calls" do
+    js = build do
+      window.alert
+      window.alert!
+    end
+    js.strip.should == "window.alert;\nwindow.alert()"
+  end
+  
+  it 'should convert symbols into strings' do
+    js = build do
+      alert :hi
+    end
+    js.strip.should == 'alert("hi")'
+  end
+    
+  it "should convert blocks to functions" do
+    js = build do
+      func do |an_argument, another_arg|
+        an_argument.some_func!
+        alert(another_arg)
+        alert(another_arg.some_property)
+      end
+    end
+    js.strip.should == "func(function(an_argument, another_arg) {\nan_argument.some_func();\nalert(another_arg);\nalert(another_arg.some_property)})"
+  end
+
+  it "should convert procs to functions" do
+    js = build do
+      some_proc = ->(an_argument, another_arg) do
+        an_argument.some_func!
+        alert(another_arg)
+        alert(another_arg.some_property)
+      end
+      setTimeout some_proc, 1000
+    end
+    js.strip.should == "setTimeout(function(an_argument, another_arg) {\nan_argument.some_func();\nalert(another_arg);\nalert(another_arg.some_property)}, 1000)"
+  end
+
+  it "should convert hashes to javascript objects" do
+    js = build do
+      func(a_key => :a_value)
+    end
+    js.strip.should == 'func({a_key: "a_value"})'
+  end
+
+  it "should correctly nest property access" do
+    js = build do
+      foo.bar!.bla ble => some!.thing(with => :alot), :of_stuff => 1234
+    end
+    js.strip.should == 'foo.bar().bla({ble: some().thing({with: "alot"}),"of_stuff": 1234})'
+  end
+
+  it "should support array conversion" do
+    js = build do
+      self.my_array = [1,:asd, some(innermethod)];
+    end
+    js.strip.should == 'my_array=([1, "asd", some(innermethod)])'
+  end
+
+  it "should support array access" do 
+    js = build do
+      alert(something[:name])
+    end
+    js.strip.should == 'alert(something["name"])'
+  end
+  
+  it "should support array assignment" do
+    js = build do
+      something[:name] = 123
+    end
+    js.strip.should == 'something["name"]= 123'
+  end  
+  
+  it "should escape javascript" do
+    js = build do
+      alert("This is a quote: \", this is a backslash: \\")
+    end
+    js.strip.should == 'alert("This is a quote: \\", this is a backslash: \\\\")'
+  end
+  
+  it "should can access outer local scope and the view context" do
+
+    local_var = "Local"
+    js = build do
+      alert(@instance_var+local_var)
+    end
+    js.strip.should == 'alert("InstanceLocal")'
+  end
+
+  it "should convert regexp to javascript" do
+    js = build do
+      docs.map do |doc|
+        w.match /^_/
+        emit doc
+      end
+    end
+    js.strip.should == "docs.map(function(doc) {\nw.match(/^_/);\nemit(doc)})"
+  end
+
+end

metadata

@@ -2,7 +2,7 @@
 name: rbjs
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.9.14
+  version: 0.9.15
 platform: ruby
 authors: 
 - Stefan Buhrmester
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-04 00:00:00 Z
+date: 2011-11-07 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json
@@ -65,6 +65,7 @@ files:
 - lib/rbjs/version.rb
 - rbjs.gemspec
 - readme.md
+- spec/rbjs_spec.rb
 homepage: http://github.com/buhrmi/rbjs
 licenses: []
 
@@ -92,5 +93,5 @@ rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Remote Javascript re-imagined
-test_files: []
-
+test_files: 
+- spec/rbjs_spec.rb