jquery_on_rails 0.1.2 → 0.2.0

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.0

data/jquery_on_rails.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{jquery_on_rails}
-  s.version = "0.1.2"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Joe Khoobyar"]
-  s.date = %q{2010-05-22}
+  s.date = %q{2010-05-23}
   s.description = %q{A complete replacement for Rails 3 javascript helpers and unobstrusive javacript (ujs) using JQuery instead of prototype/scriptaculous}
   s.email = %q{joe@ankhcraft.com}
   s.extra_rdoc_files = [

data/lib/jquery_on_rails/helpers/jquery_helper.rb

@@ -55,7 +55,7 @@ module JQueryOnRails
         function
       end
     
-      # Mostly copied from PrototypeHelper
+      # Mostly copied from Rails 3 PrototypeHelper
       class JavaScriptGenerator #:nodoc:
         def initialize(context, &block) #:nodoc:
           @context, @lines = context, []
@@ -71,6 +71,7 @@ module JQueryOnRails
 	        extend GeneratorMethods
 	      end
     
+	      # Mostly copied from Rails 3 PrototypeHelper
         module GeneratorMethods
           def to_s #:nodoc:
             returning javascript = @lines * $/ do
@@ -84,10 +85,10 @@ module JQueryOnRails
     
           def [](id)
             case id
-              when String, Symbol, NilClass
-                JavaScriptElementProxy.new(self, id)
-              else
-                JavaScriptElementProxy.new(self, ActionController::RecordIdentifier.dom_id(id))
+            when String, Symbol, NilClass
+              JavaScriptElementProxy.new(self, id)
+            else
+              JavaScriptElementProxy.new(self, ActionController::RecordIdentifier.dom_id(id))
             end
           end
     
@@ -101,18 +102,18 @@ module JQueryOnRails
     
           def insert_html(position, id, *options_for_render)
             content = javascript_object_for(render(*options_for_render))
-	          position = INSERTION_POSITIONS[position.to_sym] || position.to_s.downcase
-            record "jQuery('##{id}').#{position}(#{content});"
+	          position = INSERT_POSITIONS[position.to_sym] || position.to_s.downcase
+            record "jQuery(\"##{id}\").#{position}(#{content});"
           end
     
           def replace_html(id, *options_for_render)
             content = javascript_object_for(render(*options_for_render))
-            record "jQuery('##{id}').html(#{content});"
+            record "jQuery(\"##{id}\").html(#{content});"
           end
     
           def replace(id, *options_for_render)
             content = javascript_object_for(render(*options_for_render))
-            record "jQuery('##{id}').replaceWith(#{content});"
+            record "jQuery(\"##{id}\").replaceWith(#{content});"
           end
     
           def remove(*ids)
@@ -157,14 +158,14 @@ module JQueryOnRails
           end
     
           def delay(seconds = 1)
-            record "setTimeout(function() {\n\n"
+            record "setTimeout(function(){\n\n"
             yield
             record "}, #{(seconds * 1000).to_i})"
           end
     
           private
             def loop_on_multiple_ids(method, ids)
-	            record "jQuery('##{ids.join(', #')}').#{method} ();"
+	            record "jQuery(\"##{ids.join(', #')}\").#{method}();"
             end
     
             def page
@@ -210,6 +211,19 @@ module JQueryOnRails
               JavaScriptProxy.new(self, method.to_s.camelize)
             end
         end
+        
+        module CompatibilityMethods
+          def [](id)
+            case id
+            when String, Symbol, NilClass
+              proxy = JavaScriptElementProxy.new(self, id)
+            else
+              proxy = JavaScriptElementProxy.new(self, ActionController::RecordIdentifier.dom_id(id))
+            end
+            Object.instance_method(:extend).bind(proxy).call JavaScriptElementCompatibility
+            proxy
+          end
+        end
       end
     
       def update_page(&block)
@@ -314,15 +328,18 @@ module JQueryOnRails
     class JavaScriptVariableProxy < ActionView::Helpers::JavaScriptVariableProxy 
     end
 
-    # Adapted from Rails 3
+    # Adapted from Rails 3 ActionView::Helpers::JavaScriptProxy
     class JavaScriptElementProxy < JavaScriptProxy
+
       def initialize(generator, id)
         @id = id
-        super(generator, "$(#{::ActiveSupport::JSON.encode('#'+id)})")
+        super(generator, "jQuery(#{::ActiveSupport::JSON.encode('#'+id.to_s)})")
       end
 
       def [](attribute)
-        append_to_function_chain!(attribute)
+        if Fixnum === attribute then array_access(attribute) else
+	        append_to_function_chain!(attribute)
+	      end
         self
       end
 
@@ -341,6 +358,42 @@ module JQueryOnRails
       def reload(options_for_replace = {})
         replace(options_for_replace.merge({ :partial => @id.to_s }))
       end
+
+    private
+
+	    def array_access(index)
+	      function_chain[-1].chomp!(';')
+	      function_chain[-1] += "[#{index}];"
+	    end
+	    
+    end
+    
+    # Compatibility methods that can be mixed into JavaScriptElementProxy
+    # to provide at least some level of compatibility for code that tries
+    # to access or set properties directly onto the element object.
+    module JavaScriptElementCompatibility
+      
+      def [](attribute)
+        refer_to_native_element!
+        super
+      end
+      
+    private
+	
+	    def assign(variable, value)
+        refer_to_native_element!
+        super
+	    end
+	    
+	    def call(function, *arguments, &block)
+	      singleton_class.class_eval{ def refer_to_native_element!; end}
+	      super
+	    end
+	    
+	    def refer_to_native_element!
+	      array_access(0)
+	      singleton_class.class_eval{ def refer_to_native_element!; end}
+	    end
     end
 
   end

data/spec/jquery_helper_spec.rb

@@ -1,14 +1,29 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 require 'dummy_controller'
+require 'active_model'
+require 'active_model/naming'
+require 'active_model/conversion'
+
+class Ovechkin < Struct.new(:Ovechkin, :id)
+  extend ActiveModel::Naming
+  include ActiveModel::Conversion
+  def to_key() id ? [id] : nil end
+end
 
 describe JQueryOnRails::Helpers::JQueryHelper do
+  before(:all) do
+    ActiveSupport::JSON::Encoding.escape_html_entities_in_json = true
+  end
   before(:each) do
     @t = DummyController.new.tap do |c|
 	    c.request = ActionDispatch::Request.new Rack::MockRequest.env_for('/dummy')
     end.view_context
   end
   
+  it "is automatically mixed into the template class" do
+    @t.class.included_modules.should be_include(JQueryOnRails::Helpers::JQueryHelper)
+  end
   it "overrides all instance methods ActionView::Helpers::PrototypeHelper" do
     (ActionView::Helpers::PrototypeHelper.instance_methods -
       JQueryOnRails::Helpers::JQueryHelper.instance_methods).should == []
@@ -59,6 +74,7 @@ describe JQueryOnRails::Helpers::JQueryHelper do
 		    @t.remote_function(:url=>'/foo', :form=>true).should_not =~ @regex
 	    end
 	  end
+	  
 	  describe ':url' do
 		  it "accepts a string" do
 		    @t.remote_function(:url=>'/foo').should =~ /url: *'\/foo'/
@@ -67,6 +83,7 @@ describe JQueryOnRails::Helpers::JQueryHelper do
 		    @t.remote_function(:url=>{:controller=>'dummy', :action=>'index'}).should =~ /url: *'\/dummy'/
 		  end
 	  end
+	  
 	  describe ':method' do
 		  it "defaults to GET" do
 		    @t.remote_function(:url=>'/foo').should =~ /method: *'GET'/
@@ -76,4 +93,185 @@ describe JQueryOnRails::Helpers::JQueryHelper do
 		  end
 	  end
   end
+  
+  describe "javascript generation" do
+    before(:each) do
+      @block = proc{|page| page.replace_html 'foo', 'bar'}
+    end
+    
+    def create_generator
+      block = Proc.new{|*args| yield *args if block_given?}
+      @t.class::JavaScriptGenerator.new @t, &block
+    end
+    
+    describe 'JavaScriptGenerator' do
+      before(:each) do
+        @g = create_generator
+      end
+      it "replaces the PrototypeHelper's generator" do
+	      @t.class::JavaScriptGenerator.should == JQueryOnRails::Helpers::JQueryHelper::JavaScriptGenerator
+	      JQueryOnRails::Helpers::JQueryHelper::JavaScriptGenerator.should === @g
+      end
+      it "#insert_html" do
+        @g.insert_html(:top, 'element', '<p>This is a test</p>').should ==
+          'jQuery("#element").prepend("\\u003Cp\\u003EThis is a test\\u003C/p\\u003E");'
+        @g.insert_html(:bottom, 'element', '<p>This is a test</p>').should ==
+          'jQuery("#element").append("\\u003Cp\\u003EThis is a test\\u003C/p\\u003E");'
+        @g.insert_html(:before, 'element', '<p>This is a test</p>').should ==
+          'jQuery("#element").before("\\u003Cp\\u003EThis is a test\\u003C/p\\u003E");'
+        @g.insert_html(:after, 'element', '<p>This is a test</p>').should ==
+          'jQuery("#element").after("\\u003Cp\\u003EThis is a test\\u003C/p\\u003E");'
+      end
+      it "#replace_html" do
+	      @g.replace_html('element', '<p>This is a test</p>').should ==
+			    'jQuery("#element").html("\\u003Cp\\u003EThis is a test\\u003C/p\\u003E");'
+      end
+      it "#replace" do
+	      @g.replace('element', '<div id="element"><p>This is a test</p></div>').should ==
+			    'jQuery("#element").replaceWith("\\u003Cdiv id=\"element\"\\u003E\\u003Cp\\u003EThis is a test\\u003C/p\\u003E\\u003C/div\\u003E");'
+      end
+      it "#remove" do
+	      @g.remove('foo').should == 'jQuery("#foo").remove();'
+	      @g.remove('foo', 'bar', 'baz').should == 'jQuery("#foo, #bar, #baz").remove();'
+      end
+      it "#show" do
+        @g.show('foo').should == 'jQuery("#foo").show();'
+	      @g.show('foo', 'bar', 'baz').should == 'jQuery("#foo, #bar, #baz").show();'
+      end
+      it "#hide" do
+        @g.hide('foo').should == 'jQuery("#foo").hide();'
+	      @g.hide('foo', 'bar', 'baz').should == 'jQuery("#foo, #bar, #baz").hide();'
+      end
+      it "#toggle" do
+        @g.toggle('foo').should == 'jQuery("#foo").toggle();'
+	      @g.toggle('foo', 'bar', 'baz').should == 'jQuery("#foo, #bar, #baz").toggle();'
+      end
+      it "#alert" do
+				@g.alert('hello').should == 'alert("hello");'
+      end
+      it "#redirect_to" do
+				@g.redirect_to(:controller=>'dummy', :action=>'index').should ==
+				  'window.location.href = "/dummy";'
+				@g.redirect_to("http://www.example.com/welcome?a=b&c=d").should == 
+				  'window.location.href = "http://www.example.com/welcome?a=b&c=d";'
+      end
+      it "#reload" do
+				@g.reload.should == 'window.location.reload();'
+      end
+      it "#delay" do
+        @g.delay(20){@g.hide('foo')}
+        @g.to_s.should == "setTimeout(function(){\n;\njQuery(\"#foo\").hide();\n}, 20000);"
+      end
+      it "#to_s" do
+		    @g.insert_html(:top, 'element', '<p>This is a test</p>')
+		    @g.insert_html(:bottom, 'element', '<p>This is a test</p>')
+		    @g.remove('foo', 'bar')
+		    @g.replace_html('baz', '<p>This is a test</p>')
+
+        @g.to_s.should == <<-EOS.chomp
+jQuery("#element").prepend("\\u003Cp\\u003EThis is a test\\u003C/p\\u003E");
+jQuery("#element").append("\\u003Cp\\u003EThis is a test\\u003C/p\\u003E");
+jQuery("#foo, #bar").remove();
+jQuery("#baz").html("\\u003Cp\\u003EThis is a test\\u003C/p\\u003E");
+EOS
+      end
+		  it "#literal" do
+		    ActiveSupport::JSON.encode(@g.literal("function() {}")).should == "function() {}"
+		    @g.to_s.should == ""
+		  end
+		  it "proxies to class methods" do
+		    @g.form.focus('my_field')
+		    @g.to_s.should == "Form.focus(\"my_field\");"
+		  end
+		  it "proxies to class methods with blocks" do
+		    @g.my_object.my_method do |p|
+		      p[:one].show
+		      p[:two].hide
+		    end
+		    @g.to_s.should == "MyObject.myMethod(function() { jQuery(\"#one\").show();\njQuery(\"#two\").hide(); });"
+		  end
+		  it "calls with or without blocks" do
+		    @g.call(:before)
+		    @g.call(:my_method) do |p|
+		      p[:one].show
+		      p[:two].hide
+		    end
+		    @g.call(:in_between)
+		    @g.call(:my_method_with_arguments, true, "hello") do |p|
+		      p[:three].toggle
+		    end
+		    @g.to_s.should == "before();\nmy_method(function() { jQuery(\"#one\").show();\njQuery(\"#two\").hide(); });\nin_between();\nmy_method_with_arguments(true, \"hello\", function() { jQuery(\"#three\").toggle(); });"
+		  end
+
+      describe "element proxy compatibility" do
+        before(:each) do
+          @g.extend @g.class::CompatibilityMethods
+        end
+        it "gets properties" do
+          @g['hello']['style']
+          @g.to_s.should == 'jQuery("#hello")[0].style;'
+        end
+        it "gets nested properties" do
+          @g['hello']['style']['color']
+          @g.to_s.should == 'jQuery("#hello")[0].style.color;'
+        end
+        it "sets properties" do
+          @g['hello'].width = 400;
+          @g.to_s.should == 'jQuery("#hello")[0].width = 400;'
+        end
+        it "sets nested properties" do
+          @g['hello']['style']['color'] = 'red';
+          @g.to_s.should == 'jQuery("#hello")[0].style.color = "red";'
+        end
+      end
+      describe "element proxy" do
+	      it "refers by element ID" do
+				  @g['hello'].should == 'jQuery("#hello");'
+	      end
+	      it "refers via ActiveModel::Naming" do
+				  @g[Ovechkin.new(:id=>5)].should == 'jQuery("#bunny_5");'
+				  @g[Ovechkin.new].should == 'jQuery("#new_bunny");'
+	      end
+	      it "refers indirectly" do
+	        @g['hello'].hide('first').show
+	        @g.to_s.should == 'jQuery("#hello").hide("first").show();'
+	      end
+	      it "calls methods" do
+	        @g['hello'].hide
+	        @g.to_s.should == 'jQuery("#hello").hide();'
+	      end
+	      it "gets properties" do
+	        @g['hello'][0]['style']
+	        @g.to_s.should == 'jQuery("#hello")[0].style;'
+	      end
+	      it "gets nested properties" do
+	        @g['hello'][0]['style']['color']
+	        @g.to_s.should == 'jQuery("#hello")[0].style.color;'
+	      end
+	      it "sets properties" do
+	        @g['hello'][0].width = 400;
+	        @g.to_s.should == 'jQuery("#hello")[0].width = 400;'
+	      end
+	      it "sets nested properties" do
+	        @g['hello'][0]['style']['color'] = 'red';
+	        @g.to_s.should == 'jQuery("#hello")[0].style.color = "red";'
+	      end
+      end
+    end
+  
+	  describe '#update_page' do
+	    it 'matches output from #create_generator' do
+	      @t.update_page(&@block).should == create_generator(&@block).to_s
+	    end
+	  end
+  
+	  describe '#update_page_tag' do
+	    it 'matches output from #create_generator wrapped in a script tag' do
+	      @t.update_page_tag(&@block).should == @t.javascript_tag(create_generator(&@block).to_s)
+	    end
+	    it 'outputs html attributes' do
+	      @t.update_page_tag(:defer=>true, &@block).should == @t.javascript_tag(create_generator(&@block).to_s, :defer=>true)
+	    end
+	  end
+  end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
   - 2
-  version: 0.1.2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Joe Khoobyar
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-22 00:00:00 -04:00
+date: 2010-05-23 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency