RubyGems - jelly - Versions diffs - 0.6.5 → 0.8.10 - Mend

jelly 0.6.5 → 0.8.10

Files changed (17) hide show

data/README.markdown +7 -7
data/VERSION.yml +2 -3
data/generators/jelly/jelly_generator.rb +0 -1
data/generators/jelly/templates/javascripts/ajax_with_jelly.js +4 -6
data/generators/jelly/templates/javascripts/jelly.js +134 -69
data/jelly.gemspec +7 -8
data/lib/jelly.rb +2 -3
data/lib/jelly/common.rb +8 -0
data/lib/jelly/jelly_controller.rb +30 -13
data/lib/jelly/jelly_helper.rb +24 -16
data/spec/jelly/common_spec.rb +46 -0
data/spec/jelly/jelly_controller_spec.rb +327 -0
data/spec/{helpers → jelly}/jelly_helper_spec.rb +35 -16
data/spec/spec_helper.rb +4 -0
metadata +5 -5
data/generators/jelly/templates/javascripts/jquery/jquery.protify-0.3.js +0 -345
data/spec/controllers/jelly_controller_spec.rb +0 -118

data/README.markdown CHANGED

@@ -71,7 +71,7 @@ page-specifc function when the page has loaded. Let's look at some code:
 In public/javascripts/pages/stories.js, we create a simple Jelly file:
-    Jelly.add("Stories", {
+    Jelly.Pages.add("Stories", {
       index: function() {
         $('a.clickme').click(function() {
@@ -85,7 +85,7 @@ Jelly will automatically execute the `index` function when the Rails app runs th
 continue the example by adding more Javascript functions that map to the `new` and `show` Rails actions. We can also
 specify an `all` function, which will be executed on all actions in the `StoriesController`.
-    Jelly.add("Stories", {
+    Jelly.Pages.add("Stories", {
       index: function() {
         $('a.clickme').click(function() {
@@ -134,15 +134,15 @@ method in our view. This can be done either in your layout (for components to at
 in the `<head>` tag of the layout:
-    <%= attach_javascript_component('SearchBox') %>
+    <% attach_javascript_component('SearchBox') %>
 or in a view:
     <% content_for :javascript do -%>
-      <%= attach_javascript_component('SearchBox') %>
+      <% attach_javascript_component('SearchBox') %>
     <% end -%>
-Components always get initialized **after** the page-specific Javascript functions.
+Components are initialized **before** the page-specific Javascript functions by default.
 AJAX With Jelly
 ---------------
@@ -179,7 +179,7 @@ The controller, stories_controller.rb
 The javascript, pages/stories.js:
-    Jelly.add("Stories", {
+    Jelly.Pages.add("Stories", {
       new: function() {
         $("#create_story_link").click(function() {
@@ -234,7 +234,7 @@ The controller, stories_controller.rb
 The javascript, pages/stories.js:
-    Jelly.add("Stories", {
+    Jelly.Pages.add("Stories", {
       new: function() {
         $("#create_story_link").click(function() {

data/VERSION.yml CHANGED

@@ -1,5 +1,4 @@
 ---
-:minor: 6
-:patch: 5
-:build:
+:minor: 8
+:patch: 10
 :major: 0

data/generators/jelly/jelly_generator.rb CHANGED

@@ -5,7 +5,6 @@ class JellyGenerator < Rails::Generator::Base
       m.file 'javascripts/ajax_with_jelly.js', "public/javascripts/ajax_with_jelly.js"
       m.directory('public/javascripts/jquery')
       m.file 'javascripts/jquery/jquery-1.3.2.js', "public/javascripts/jquery/jquery-1.3.2.js"
-      m.file 'javascripts/jquery/jquery.protify-0.3.js', "public/javascripts/jquery/jquery.protify-0.3.js"
       m.directory('public/javascripts/pages')
     end
   end

data/generators/jelly/templates/javascripts/ajax_with_jelly.js CHANGED

@@ -19,15 +19,13 @@ if(!window.Jelly) Jelly = new Object();
         authenticity_token: window._token
       });
     }
+    var observers = otherParams.observers || Jelly.observers;
     return $.extend({
       dataType: 'json',
       cache: false,
-      success : $.ajaxWithJelly.onSuccess
+      success : function(callbacks) {
+        Jelly.Observers.notify.call(observers, callbacks);
+      }
     }, otherParams);
   };
-  $.ajaxWithJelly.onSuccess = function(json) {
-    Jelly.notifyObservers(json);
-    return true;
-  };
 })(jQuery);

data/generators/jelly/templates/javascripts/jelly.js CHANGED

@@ -2,7 +2,7 @@
  *  Jelly. a sweet unobtrusive javascript framework
  *  for jQuery and Rails
  *
- *  version 0.5
+ *  version 0.8.10
  *
  * Copyright (c) 2009 Pivotal Labs
  * Licensed under the MIT license.
@@ -12,83 +12,148 @@
  */
 if (!window.Jelly) Jelly = new Object();
-Jelly.init = function() {
-  this.components = [];
-  Jelly.Pages.init();
-  $(document).ready(function() {
-    Jelly.Components.init();
-  });
-};
-Jelly.attach = function(component, args) {
-  this.components.push([component, args]);
-};
-Jelly.notifyObservers = function(params) {
-  var context = params.on ? eval(params.on) : page;
-  if (context[params.method]) {
-    context[params.method].apply(context, params.arguments);
-  }
-  $.protify(Jelly.components).each(function(componentAndArgs) {
-    var component = componentAndArgs[0];
-    if (component[params.method] && component != context) {
-      component[params.method].apply(component, params.arguments);
+if (!Function.prototype.bind) {
+  Function.prototype.bind = function(object) {
+    var self = this;
+    return function() {
+      return self.apply(object, arguments);
     }
-  });
-};
-Jelly.Components = {
-  init: function() {
-    $.protify(Jelly.components).each(function(componentAndArgs) {
-      var component = componentAndArgs[0];
-      var args = componentAndArgs[1] || [];
-      if (component.init) component.init.apply(component, args);
-    });
   }
-};
-Jelly.Pages = {
+}
+$.extend(Jelly, {
   init: function() {
-    this.all = {};
-    Jelly.all = this.all; // Deprecated
+    this.observers = [];
+    this.attach = this.Observers.attach;
+    this.notifyObservers = this.Observers.notify;
+    this.Pages.init();
   },
-  add: function(name) {
-    var page = new Jelly.Page(name);
-    for (var i = 1; i < arguments.length; i++) {
-      $.extend(page, arguments[i]);
+  Observers: {
+    attach: function() {
+      if (this == Jelly) {
+        return Jelly.Observers.attach.apply(this.observers, arguments);
+      }
+      for (var i = 0; i < arguments.length; i++) {
+        var definitionOrComponent = arguments[i];
+        if (definitionOrComponent.component) {
+          var component = Jelly.Observers.evaluateComponent(definitionOrComponent.component);
+          if (component.init) {
+            var initReturnValue = component.init.apply(component, definitionOrComponent.arguments);
+            if (initReturnValue === false || initReturnValue === null) {
+            } else {
+              Jelly.Observers.pushIfObserver.call(this, initReturnValue || component);
+            }
+          } else {
+            Jelly.Observers.pushIfObserver.call(this, component);
+          }
+        } else {
+          Jelly.Observers.pushIfObserver.call(this, Jelly.Observers.evaluateComponent(definitionOrComponent));
+        }
+      }
+    },
+    evaluateComponent: function(component) {
+      return (typeof component == "string") ? eval(component) : component;
+    },
+    pushIfObserver: function(observer) {
+      if (observer) {
+        this.push(observer);
+      }
+    },
+    notify: function(callbacks) {
+      if (this == Jelly) {
+        return Jelly.Observers.notify.apply(this.observers, arguments);
+      }
+      if (!$.isArray(callbacks)) {
+        callbacks = [callbacks];
+      }
+      var observers = this.slice(0);
+      for (var i = 0; i < callbacks.length; i++) {
+        var callback = callbacks[i];
+        // Deprecate 'on' in favor of making each page action a Component.
+        if (callback.on) {
+          var additionalObserver = eval(callback.on);
+          if (observers.indexOf(additionalObserver) == -1) {
+            observers.push(additionalObserver);
+          }
+        }
+        if (callback.method) {
+          for (var j = 0; j < observers.length; j++) {
+            var observer = observers[j];
+            if (observer[callback.method]) {
+              if (observer.detach && observer.detach()) {
+                Jelly.Observers.garbageCollectObserver.call(this, observer);
+              } else {
+                observer[callback.method].apply(observer, callback.arguments);
+              }
+            }
+          }
+        }
+        if (callback.attach) {
+          Jelly.Observers.attach.apply(this, callback.attach);
+        }
+      }
+    },
+    garbageCollectObserver: function(observer) {
+      var index = this.indexOf(observer);
+      if (index > -1) {
+        Jelly.Observers.remove.call(this, index, index + 1);
+      }
+    },
+    remove: function(from, to) {
+      var rest = this.slice((to || from) + 1 || this.length);
+      this.length = from < 0 ? this.length + from : from;
+      return this.push.apply(this, rest);
     }
-    return page;
-  }
-};
-Jelly.add = Jelly.Pages.add; // Deprecated
+  },
-Jelly.Page = function(name) {
-  this.documentHref = Jelly.Location.documentHref;
-  this.name = name;
-  this.components = [];
-  Jelly.Pages.all[name] = this;
-};
-Jelly.Page.prototype.loaded = false;
-Jelly.Page.prototype.all = function() {
-};
-Jelly.Page.init = function(controllerName, actionName) {
-  var page = Jelly.Pages.all[controllerName] || new Jelly.Page(controllerName);
-  window.page = page;
-  if (page.all) page.all();
-  if (page[actionName]) page[actionName].call(page);
-  page.loaded = true;
-};
-Jelly.Location = {
-  init: function() {
+  Pages: {
+    init: function() {
+      this.all = {};
+      Jelly.all = this.all; // Deprecated
+    },
+    add: function(name) {
+      var page = new Jelly.Page.Constructor(name);
+      for (var i = 1; i < arguments.length; i++) {
+        $.extend(page, arguments[i]);
+      }
+      return page;
+    }
   },
-  on_redirect: function(location) {
-    top.location.href = location;
+  Page: {
+    init: function(controllerName, actionName) {
+      var page = Jelly.Pages.all[controllerName] || new Jelly.Page.Constructor(controllerName);
+      window.page = page;
+      if (page.all) page.all();
+      if (page[actionName]) page[actionName].call(page);
+      page.loaded = true;
+      return page;
+    },
+    Constructor: function(name) {
+      this.loaded = false;
+      this.documentHref = Jelly.Location.documentHref;
+      this.name = name;
+      Jelly.Pages.all[name] = this;
+    }
+  },
+  Location: {
+    on_redirect: function(location) {
+      top.location.href = location;
+    }
   }
-};
+});
+Jelly.add = Jelly.Pages.add; // Deprecated
 Jelly.init();

data/jelly.gemspec CHANGED

@@ -1,15 +1,15 @@
 # Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |s|
   s.name = %q{jelly}
-  s.version = "0.6.5"
+  s.version = "0.8.10"
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Pivotal Labs, Inc"]
-  s.date = %q{2009-11-19}
+  s.date = %q{2010-01-20}
   s.description = %q{Jelly provides a set of tools and conventions for creating rich ajax/javascript web applications with jQuery and Ruby on Rails.}
   s.email = %q{opensource@pivotallabs.com}
   s.extra_rdoc_files = [
@@ -26,7 +26,6 @@ Gem::Specification.new do |s|
      "generators/jelly/templates/javascripts/ajax_with_jelly.js",
      "generators/jelly/templates/javascripts/jelly.js",
      "generators/jelly/templates/javascripts/jquery/jquery-1.3.2.js",
-     "generators/jelly/templates/javascripts/jquery/jquery.protify-0.3.js",
      "install.rb",
      "jelly.gemspec",
      "lib/jelly.rb",
@@ -42,8 +41,9 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{a sweet unobtrusive javascript framework for jQuery and Rails}
   s.test_files = [
-    "spec/controllers/jelly_controller_spec.rb",
-     "spec/helpers/jelly_helper_spec.rb",
+    "spec/jelly/common_spec.rb",
+     "spec/jelly/jelly_controller_spec.rb",
+     "spec/jelly/jelly_helper_spec.rb",
      "spec/rails_root/app/controllers/application_controller.rb",
      "spec/rails_root/app/helpers/application_helper.rb",
      "spec/rails_root/config/boot.rb",
@@ -76,4 +76,3 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<rails>, [">= 2.3.0"])
   end
 end

data/lib/jelly.rb CHANGED

@@ -12,6 +12,5 @@ ActionView::Base.class_eval do
   include JellyHelper
 end
-ActionView::Helpers::AssetTagHelper.register_javascript_expansion :jelly => ["jquery/jquery-1.3.2", "jquery/jquery.protify-0.3",
-                                                                             "ajax_with_jelly", "jelly"]
-ActionView::Helpers::AssetTagHelper.register_javascript_expansion :only_jelly => ["jquery/jquery.protify-0.3", "jelly", "ajax_with_jelly"]
+ActionView::Helpers::AssetTagHelper.register_javascript_expansion :jelly => ["jquery/jquery-1.3.2", "ajax_with_jelly", "jelly"]
+ActionView::Helpers::AssetTagHelper.register_javascript_expansion :only_jelly => ["jelly", "ajax_with_jelly"]

data/lib/jelly/common.rb CHANGED

@@ -3,5 +3,13 @@ module Jelly
     def jelly_callback_hash(method, *arguments)
       {"method" => method, "arguments" => arguments}
     end
+    def jelly_callback_attach_hash(components=jelly_attachments)
+      {"attach" => components}
+    end
+    def jelly_attachment_hash(component_name, *args)
+      {'component' => component_name, 'arguments' => args}
+    end
   end
 end

data/lib/jelly/jelly_controller.rb CHANGED

@@ -3,22 +3,39 @@ module JellyController
   include Jelly::Common
   def jelly_callback(callback_base_name = @action_name, options = {}, &block)
-    render :inline => jelly_callback_erb("on_#{callback_base_name}", options, block)
+    raw_jelly_callback(options) do
+      arguments = block ? instance_eval(&block) : []
+      arguments = [arguments] unless arguments.is_a?(Array)
+      jelly_callback_hash("on_#{callback_base_name}", *arguments).merge(options)
+    end
   end
-  def jelly_callback_erb(callback_name, options, block)
-    @callback_name = callback_name
-    @options = options
-    @block = block
-    erb = <<-ERB
-      <%= begin
-        args = @block ? instance_eval(&@block) : []
-        args = [args] unless args.is_a?(Array)
-        jelly_callback_hash(@callback_name, *args).reverse_merge(@options).to_json
-      end %>
-    ERB
-    request.xhr? ? erb : "<textarea>#{erb}</textarea>"
+  def raw_jelly_callback(options={}, &block)
+    options.symbolize_keys!
+    options[:format] ||= if params[:callback]
+      :jsonp
+    elsif request.xhr?
+      :json
+    else
+      :iframe
+    end
+    render :inline => jelly_callback_erb(options, &block)
   end
+  def jelly_callback_erb(options={}, &block)
+    options[:format] ||= :json
+    @jelly_block = block
+    case options[:format].to_sym
+      when :iframe
+        "<textarea>#{jelly_callback_erb_template}</textarea>"
+      when :jsonp
+        "#{params[:callback]}(#{jelly_callback_erb_template});"
+      else
+        jelly_callback_erb_template
+    end
+  end
+  def jelly_callback_erb_template
+    "<%= instance_eval(&@jelly_block).to_json %>"
+  end
 end

data/lib/jelly/jelly_helper.rb CHANGED

@@ -14,35 +14,43 @@ module JellyHelper
   def spread_jelly
     attach_javascript_component("Jelly.Location")
     attach_javascript_component("Jelly.Page", controller.controller_path.camelcase, controller.action_name)
+    <<-HTML
+      #{window_token_javascript_tag}
+      #{attach_javascript_component_javascript_tag(jelly_attachments)}
+    HTML
+  end
+  def window_token_javascript_tag
+    javascript_tag("window._token = '#{form_authenticity_token}';")
+  end
+  def attach_javascript_component_javascript_tag(*components)
+    components = [components].flatten
     javascript_tag <<-JS
-      window._token = '#{form_authenticity_token}'
-      #{@content_for_javascript}
       $(document).ready(function() {
-        #{@content_for_javascript_on_ready}
+        Jelly.attach.apply(Jelly, #{components.to_json});
       });
     JS
   end
-  def clear_jelly_attached()
-    @jelly_attached_components = []
+  def clear_jelly_attached
+    jelly_attachments.clear
   end
   def attach_javascript_component(component_name, *args)
-    @jelly_attached_components ||= []
-    key = "Jelly.attach(#{component_name}, #{args.to_json});"
-    unless @jelly_attached_components.include? key
-      @jelly_attached_components << key
-      content_for(:javascript, key)
+    key = jelly_attachment_hash(component_name, *args)
+    unless jelly_attachments.include? key
+      jelly_attachments << key
     end
   end
   def attach_javascript_component_on_ready(component_name, *args)
-    @jelly_attached_components_on_ready ||= []
-    key = "Jelly.attach(#{component_name}, #{args.to_json});"
-    unless @jelly_attached_components_on_ready.include? key
-      @jelly_attached_components_on_ready << key
-      content_for(:javascript_on_ready, key)
-    end
+    warn "attach_javascript_component_on_ready is deprecated since attach_javascript_component adds components to be attached in a $(document).ready block\n#{puts caller.join("\n\t")}"
+    attach_javascript_component(component_name, *args)
+  end
+  def jelly_attachments
+    @jelly_attachments ||= []
   end
 end