spakit 0.9.0

data/History.txt

@@ -0,0 +1,2 @@
+=== 0.9.0 / 2008-04-08
+* release 0.9

data/Manifest.txt

@@ -0,0 +1,7 @@
+History.txt
+init.rb
+Manifest.txt
+Rakefile
+lib/spakit.rb
+lib/spakit_helper.rb
+README.txt

data/README.txt

@@ -0,0 +1,142 @@
+Author:: Wen-Tien Chang(mailto:ihower@handlino.com), hlb(mailto:hlb@handlino.com)
+Copyright:: Copyright (c) 2007 Handlino Inc.
+License:: Distributed under the New BSD License
+
+== Description ==
+Spakit is a plugin that makes it very easy to turn your Rails App
+Into a "single page application" (SPA).
+
+To enable SPA, simply install the plug-in, create a spakit layout and use Spakit helper.
+Don't need modify any model/controller code... ;)
+
+Spakit will send xhr request(i.e. prototype's Ajax.Updater ) with ?layout=spakit, 
+and controller return HTML with spakit layout. Note that spakit_form_for not support file upload submit.
+
+By the way, Message plugin is another SPA plugin,using different approach.
+
+== Requirements
+ * Rails 2.0.2
+
+== Install ==
+ * gem install spakit
+ * cd /your_app/vendor/plugin/
+ * gem unpack spakit
+ 
+== Usage ==
+
+For now, Spakit provide three helper:
+
+ * spakit_link_to, just like remote_link_to
+ * spakit_form_for, just like form_for, but you must specify :url
+ * spakit_form_tag, just like form_tag
+
+by default spakit will replace HTML element called #content.
+
+== Layout code example ==
+You should write flash message here because we often place that in application layout.
+
+# /view/layouts/spakit.rhtml
+
+<p><%= flash[:notice] %></p>
+<%= yield %>
+
+== History Bookmarks ==
+
+We recommend Really Simple History(RSH) library to handle browser forward/back.
+
+Example code:
+
+# environment.rb
+
+module SpakitHelper
+  @@spa_options = {
+    :update => 'content-region',
+    :loading => 'SPA.loading',
+    :complete => 'SPA.complete'
+  }
+end
+
+# application.js
+# We use jquery syntax, you can use prototype to define your function.
+
+var $j = jQuery.noConflict();
+
+(function($) {
+    SPA = {
+        currentHash: null,
+        currentLocation: null,
+        init: function() {
+            if ( $('#waiting-message').length == 0 ) {
+                $('<div id="waiting-message"><img src="/images/ajax-loader.gif"></div>').appendTo('#bd');
+                $('#waiting-message').hide();
+            }
+        },
+        loading: function() {
+            this.init();
+            $('#waiting-message').show();
+        },
+        hide: function() {
+            $('#waiting-message').hide();
+        },
+        historyChange: function(newLocation, historyData, isFresh) {
+            if (isFresh == null) {
+                if (historyStorage.hasKey(newLocation)) {
+                    if (newLocation == "start") {
+                        newLocation = location.pathname;
+                    }
+
+                    $.ajax({
+                        type: "GET",
+                        url: newLocation,
+                        data: { layout: "spakit" },
+                        beforeSend: function(){ SPA.loading(); },
+                        complete: function(res, status){
+                            if ( status == "success" || status == "notmodified" ) {
+                                $('#content-region').html(res.responseText);
+                            }
+                            SPA.hide();
+                        }
+                    });
+                }
+            } else {
+                /* new data */
+                dhtmlHistory.add(newLocation, historyData);
+            }
+        },
+        complete: function(newLocation) {
+            this.historyChange(newLocation, "", true);
+            this.hide();
+        }
+    };
+    
+    SPA.currentHash = window.location.hash;
+    if (SPA.currentHash.length) {
+        if (SPA.currentHash.charAt(0) == '#' && SPA.currentHash.charAt(1) == '/') {
+            SPA.currentLocation = SPA.currentHash.slice(1);
+        }
+    }
+
+    $(document).ready(function(){
+        dhtmlHistory.initialize();
+        if (SPA.currentLocation) {
+            if (SPA.currentLocation != '#start') {
+                window.location.href = SPA.currentLocation;
+            }
+        } else {
+            dhtmlHistory.addListener(SPA.historyChange);
+            if (dhtmlHistory.isFirstLoad()) {
+                dhtmlHistory.add("start", "");
+            }
+        }
+    });
+
+})(jQuery);
+
+window.dhtmlHistory.create({
+    toJSON: function(o) {
+        return JSON.stringify(o);
+    },
+    fromJSON: function(s) {
+        return JSON.parse(s);
+    }
+});

data/Rakefile

@@ -0,0 +1,11 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+Hoe.new('spakit', '0.9.0') do |p|
+   p.rubyforge_name = 'spakit' # if different than lowercase project name
+   p.developer('Wen-Tien Chang', 'ihower@handlino.com')
+end
+
+# vim: syntax=Ruby

data/init.rb

@@ -0,0 +1,2 @@
+require 'spakit'
+ActionController::Base.helper SpakitHelper

data/lib/spakit.rb

@@ -0,0 +1,27 @@
+module ActionController
+  
+  class Base
+    alias :rails_redirect_to :redirect_to
+    alias :rails_render :render
+    
+    def redirect_to(options = {}, response_status = {})
+      if options.class == Hash
+         options.merge!( :layout => 'spakit' ) if ( self.params[:layout].to_s == 'spakit' && !options.include?(:layout) )
+      elsif options.class == String
+        options = options + '?layout=spakit' if ( self.params[:layout].to_s == 'spakit' && !options.include?('layout=') )
+      end
+      
+      rails_redirect_to(options, response_status)
+    end
+    
+    # deprecated_status is for rspec compatible
+    # http://rubyforge.org/pipermail/rspec-users/2007-November/004780.html
+    def render(options = nil,deprecated_status=nil, &block) #:doc:
+      options.merge!( :layout => 'spakit' ) if ( options.class == Hash && !options.include?(:layout) && self.params[:layout].to_s == 'spakit' )
+      options = { :layout => 'spakit' } if ( !options && self.params[:layout].to_s == 'spakit' ) #rails default
+      
+      rails_render(options, &block)
+    end
+  end
+  
+end

data/lib/spakit_helper.rb

@@ -0,0 +1,70 @@
+module SpakitHelper
+  
+    @@spa_options = {
+      :update => 'content',
+      :loading => nil,
+      :complete => nil
+    }
+    
+    # api is the same as remote_link_to
+    # TODO: omit CSRF auth token if method is get
+    def spakit_link_to(name, options = {}, html_options = nil) 
+        #abs path will use non-SPA
+        return link_to(name,options[:url]) if options[:url].class == String && options[:url].include?('http://')
+      
+        html_options = { :href => url_for(options[:url]) } unless html_options
+        html_options[:href] = url_for(options[:url]) unless (html_options && html_options[:href] )
+              
+        options.merge!( :method => :get ) unless options[:method]
+        options.merge!( :update => @@spa_options[:update] ) if (@@spa_options[:update] && !options[:update])
+        options.merge!( :loading => "#{@@spa_options[:loading]}()" ) if (@@spa_options[:loading] && !options[:loading])
+        options.merge!( :complete => "#{@@spa_options[:complete]}('#{html_options[:href]}');" ) if (@@spa_options[:complete] && !options[:complete])
+        options.merge! ( :with  => "'layout=spakit'" ) unless options[:with]
+        
+        link_to_remote(name, options, html_options)
+    end
+      
+    # api is the same as remote_remote_for, but you must provide :url
+    # spakit_remote_for @event, :url => hash_for_events_path, :html => {...} do |f|
+    # is just equal
+    # form_remote_for @event, :url => hash_for_events_path.merge(:layout => 'spakit'), :update => 'content', :loading => "SPA.show()",:complete => "SPA.hide()" do |f|
+    # TODO: can omit :url
+    def spakit_form_for(record_or_name_or_array, *args, &proc)
+      options = args.extract_options!
+      
+      target = url_for( options[:url] )
+      options.merge!( :update => @@spa_options[:update] ) if (@@spa_options[:update] && !options[:update])
+      options.merge!( :loading => "#{@@spa_options[:loading]}()" ) if (@@spa_options[:loading] && !options[:loading])
+      options.merge!( :complete => "#{@@spa_options[:complete]}('#{target}');" ) if (@@spa_options[:complete] && !options[:complete])
+      
+      #can't use options[:with] here because it will force to use Form.serialize
+      if options[:url].is_a?(Hash)
+        options[:url].merge!( :layout => 'spakit' )
+      elsif options[:url].is_a?(String)
+        options[:url] = options[:url] + '?layout=spakit' #String
+      end
+      
+      options[:html] = { :action => target } unless options[:html] 
+      options[:html].merge!( :action => target ) if ( options[:html] and !options[:html][:action] )
+      
+      form_remote_for(record_or_name_or_array, *(args << options), &proc) 
+    end
+    
+    def spakit_form_tag( options = {}, &block)  
+      target = ( options[:url].is_a?(Hash) ) ? url_for( options[:url] ) : options[:url]
+      options.merge!( :update => @@spa_options[:update] ) if (@@spa_options[:update] && !options[:update])
+      options.merge!( :loading => "#{@@spa_options[:loading]}()" ) if (@@spa_options[:loading] && !options[:loading])
+      options.merge!( :complete => "#{@@spa_options[:complete]}('#{target}');" ) if (@@spa_options[:complete] && !options[:complete])
+      
+      if options[:url].is_a?(Hash)
+        options[:url].merge!( :layout => 'spakit' )
+      elsif options[:url].is_a?(String)
+        options[:url] = options[:url] + '?layout=spakit' #String
+      end
+      
+      options[:html] = { :action => target } unless options[:html] 
+      options[:html].merge!( :action => target ) if ( options[:html] and !options[:html][:action] )
+      
+      form_remote_tag(options, &block)
+    end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: spakit
+version: !ruby/object:Gem::Version 
+  version: 0.9.0
+platform: ruby
+authors: 
+- Wen-Tien Chang
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-04-08 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.1
+    version: 
+description: ""
+email: 
+- ihower@handlino.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- init.rb
+- Manifest.txt
+- Rakefile
+- lib/spakit.rb
+- lib/spakit_helper.rb
+- README.txt
+has_rdoc: true
+homepage: Spakit is a plugin that makes it very easy to turn your Rails App
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: spakit
+rubygems_version: 1.1.0
+signing_key: 
+specification_version: 2
+summary: ""
+test_files: []
+