pivotal-honkster-jelly 0.3.0

data/.gitignore

@@ -0,0 +1,3 @@
+.idea
+*.svn
+pkg

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2009 Pivotal Labs, Inc.
+with contributions by: Brian Takita, Nate Clark, Eric Metens
+
+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/README.markdown

@@ -0,0 +1,112 @@
+Jelly
+=====
+
+INSTALLATION
+------------
+
+If you haven't already, add GitHub to your gem sources:
+
+    gem sources -a http://gems.github.com
+
+Then run:
+
+    sudo gem install pivotal-jelly
+
+
+GETTING STARTED
+---------------
+
+In your `environment.rb` in the `Rails::Initializer.run` block, be sure to require jelly:
+
+    config.gem "jelly"
+
+Then install the required JavaScript files by running this command in your Rails project:
+
+    script/generate jelly
+
+Then, in your layout, add the following:
+
+    <%= javascript_include_tag :jelly, *application_jelly_files %>
+    <%= spread_jelly %>
+
+This will include the required JavaScripts for jelly and activate the current page.  The `:jelly` javascript expansion
+includes jQuery.  If you already have jQuery included in the page, use the `:only_jelly` expansion instead.
+
+EXAMPLE USAGE
+-------------
+
+Assuming you have controller named `fun` with an action called `index` and that you have a layout called `fun.html.erb`
+that is already setup as described above.  In your fun index view (`index.html.erb`), put:
+
+    <h1>Your page's 'index' function did not run. Jelly is not configured correctly.</h1>
+    <span class="all">Your page's 'all' function did not run. Jelly is not configured correctly.</span>
+
+Then, in `public/javascripts/pages/fun.js`, put:
+
+    Jelly.add("Fun", {
+      all: function() {
+        $('span.all').text("I am displayed on every action in this controller.");
+      },
+      index: function() {
+        $('h1').text("Welcome to the index page.");
+      }
+    });
+
+Now goto `/fun/index` and see Jelly in action!
+
+AJAX CALLBACKS WITH JELLY
+-------------------------
+
+You can trigger callbacks on the page object from Rails with the `jelly_callback` method.
+Adding to the `index.html.erb` file from above:
+
+    <a href="#" id="jelly_ajax_link">Click me for Jelly Ajax Action</a>
+    <span id="jelly_callback_element">This gets filled in by the Jelly Ajax callback</span>
+
+And update your controller:
+
+    class FunController < ApplicationController
+      def index
+      end
+
+      def ajax_action
+        jelly_callback do
+          [
+            render(:partial => 'fun_partial'),
+            "second_parameter"
+          ]
+        end
+      end
+    end
+
+Update your page object in `fun.js`:
+
+    Jelly.add("Fun", {
+      all: function() {
+        $('title').text("Hello!  Isn't this fun?");
+      },
+      index: function() {
+        $('h1').text("Welcome to the index page.");
+        $("#jelly_ajax_link").click(function() {
+          $.ajaxWithJelly({
+            type: "GET",
+            url: "/fun/ajax_action"
+          });
+        });
+      },
+      on_ajax_action: function(html, second_parameter) {
+        $('#jelly_callback_element').html(html);
+      }
+    });
+
+And finally, make the partial `_fun_partial.html.erb` and just put "Hello from the server!" in it, then visit your page
+and watch the ajax callbacks in action.
+
+The `jelly_callback` method takes an optional parameter for the name of the callback, and the provided block can return
+either one parameter, or an array of parameters.
+
+DEVELOPMENT
+-----------
+
+To run ruby tests, run `rake spec`.
+To run JavaScript tests, open `jelly/spec/jasmine_runner.html` in a web browser.

data/Rakefile

@@ -0,0 +1,39 @@
+require 'spec/version'
+require 'spec/rake/spectask'
+require 'rake/rdoctask'
+
+desc 'Default: run specs'
+task :default => :spec
+
+desc 'Test the jelly plugin with Rspec.'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.libs << 'lib'
+  t.libs << 'spec'
+  t.pattern = 'spec/**/*_spec.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the jelly plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Jelly.'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "honkster-jelly"
+    gemspec.summary = "a sweet unobtrusive javascript framework for jQuery and Rails"
+    gemspec.description = "Jelly provides a set of tools and conventions for creating rich ajax/javascript web applications with jQuery and Ruby on Rails."
+    gemspec.email = "opensource@pivotallabs.com"
+    gemspec.homepage = "http://github.com/pivotal/jelly"
+    gemspec.authors = ["Pivotal Labs, Inc"]
+    gemspec.files.exclude 'spec/**/*'
+    gemspec.add_dependency('rails', '>= 2.3.0')
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/generators/jelly/USAGE

@@ -0,0 +1,11 @@
+Description:
+    Creates 'jelly.js' and dependent jQuery libraries
+
+Example:
+    ./script/generate jelly
+
+    This will create:
+        public/javascripts/jelly.js
+        public/javascripts/jquery-1.3.2.js
+        public/javascripts/jquery.protify-0.3.js
+

data/generators/jelly/jelly_generator.rb

@@ -0,0 +1,12 @@
+class JellyGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.file 'javascripts/jelly.js', "public/javascripts/jelly.js"
+      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
+end

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

@@ -0,0 +1,26 @@
+(function($) {
+  $.ajaxWithJelly = function(params) {
+    $.ajax($.ajaxWithJelly.params(params));
+  };
+
+  $.ajaxWithJelly.params = function(otherParams) {
+    otherParams = otherParams || {};
+
+    if (otherParams.type && otherParams.type != "GET") {
+      otherParams['data'] = $.extend(otherParams['data'], {
+        authenticity_token: window._token
+      });      
+    }
+    return $.extend({
+      dataType: 'json',
+      cache: false,
+      success : $.ajaxWithJelly.onSuccess
+    }, otherParams);
+  };
+
+  $.ajaxWithJelly.onSuccess = function(json) {
+    var context = json.on ? eval(json.on) : page;
+    context[json.method].apply(context, json.arguments);
+    return true;
+  };
+})(jQuery);

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

@@ -0,0 +1,77 @@
+/**
+ *  Jelly. a sweet unobtrusive javascript framework
+ *  for jQuery and Rails
+ *
+ *  version 0.5
+ *
+ * Copyright (c) 2009 Pivotal Labs
+ * Licensed under the MIT license.
+ *
+ *  * Date: 2009-07-20 9:50:50 (Mon, 20 Jul 2009)
+ *
+ */
+
+var Jelly = new Object();
+Jelly.all = {};
+
+Jelly.add = function(name) {
+  var page = new Jelly.Page(name);
+  for(var i=1; i < arguments.length; i++) {
+    $.extend(page, arguments[i]);
+  }
+  return page;
+};
+
+var page;
+Jelly.activatePage = function(controllerName, actionName) {
+  page = Jelly.all[controllerName] || new Jelly.Page(controllerName);
+  $(document).ready(function() {
+    Jelly.Page.all();
+    if(page.all) page.all();
+    if(page[actionName]) page[actionName].call(page);
+    page.loaded = true;
+  });
+};
+
+Jelly.Page = function(name) {
+  this.name = name;
+  Jelly.all[name] = this;
+};
+
+Jelly.Page.all = function() {
+  $.protify(Jelly.Page.components).each(function(componentAndArgs) {
+    var component = componentAndArgs[0];
+    var args = componentAndArgs[1] || [];
+    if(component.init) component.init.apply(component, args);
+  });
+};
+Jelly.Page.components = [];
+Jelly.Page.prototype.loaded = false;
+Jelly.Page.prototype.documentHref = function() {
+  return document.location.href;
+};
+Jelly.Page.prototype.on_redirect = function(location){
+  top.location.href = location;
+};
+
+Jelly.Page.prototype.attach = function(component, args) {
+  var methodNames = [];
+  // TODO: Figure out a better way to do this.
+  for(var methodName in component.pageMixin) {
+    methodNames.push(methodName);
+  }
+  var self = this;
+  $.protify(methodNames).each(function(methodName) {
+    self[methodName] = function() {
+      if(this['before_' + methodName]) {
+        this['before_' + methodName].apply(this, arguments);
+      }
+      var returnValue = component.pageMixin[methodName].apply(this, arguments);
+      if(this['after_' + methodName]) {
+        this['after_' + methodName].apply(this, arguments);
+      }
+      return returnValue;
+    };
+  });
+  Jelly.Page.components.push([component, args]);
+};