wiselinks 0.0.2 → 0.1.0

data/Gemfile.lock

@@ -4,6 +4,8 @@ GEM
     activesupport (3.2.9)
       i18n (~> 0.6)
       multi_json (~> 1.0)
+    bourne (1.1.2)
+      mocha (= 0.10.5)
     git (1.2.5)
     i18n (0.6.1)
     jeweler (1.8.4)
@@ -12,16 +14,20 @@ GEM
       rake
       rdoc
     json (1.7.5)
-    multi_json (1.3.7)
-    rake (10.0.2)
+    metaclass (0.0.1)
+    mocha (0.10.5)
+      metaclass (~> 0.0.1)
+    multi_json (1.5.0)
+    rake (10.0.3)
     rdoc (3.12)
       json (~> 1.4)
     shoulda (3.3.2)
       shoulda-context (~> 1.0.1)
       shoulda-matchers (~> 1.4.1)
-    shoulda-context (1.0.1)
-    shoulda-matchers (1.4.1)
+    shoulda-context (1.0.2)
+    shoulda-matchers (1.4.2)
       activesupport (>= 3.0.0)
+      bourne (~> 1.1.2)
 
 PLATFORMS
   ruby

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Igor Alexandrov
+Copyright (c) 2012 Igor Alexandrov, Alexey Solilin and Julia Egorova
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,74 @@
+#Wiselinks
+Wiselinks makes following links and submitting some forms in your web application faster. 
+
+You may find Wiselinks similar to [Turbolinks](https://github.com/rails/turbolinks) or [Pjax](https://github.com/defunkt/jquery-pjax), but Wiselinks have several rather important differences from both projects. We tried to make Wiselinks as easy to use as Turbolinks are but also as configurable as Pjax.
+
+##Compatibility
+Wiselinks should work in all major browsers including browsers that do not support HTML History API out of the box.
+
+##Installation
+
+Add this to your Gemfile:
+	
+	gem 'wiselinks'
+
+Then do:
+	
+	bundle
+
+Then modify your `application.js` or `application.js.coffee` file to use Wiselinks object:
+	
+	#= require jquery
+	#= require wiselinks
+    
+    $(document).ready ->
+    	window.wiselinks = new Wiselinks()
+
+##Events
+
+While using Wiselinks you **can rely** on `DOMContentLoaded` or `jQuery.ready()` to trigger your JavaScript code, but Wiselinks gives you some additional useful event to deal with the lifecycle of the page:
+
+#### `page:loading (url, target, render = 'template')`
+Event is triggered before the `XMLHttpRequest` is initialized and performed.
+* *url* - URL of the request that will be performed;
+
+* *target* – element of the page where result of the request will be loaded into;
+
+* *render = 'template'* – what should be rendered; can be 'template' or 'partial';
+
+#### `page:success (data, status)`
+Event is triggered if the request succeeds.
+* *data* – the data returned from the server;
+
+* *status* – a string describing the status;
+
+#### `page:error (status, error)`
+
+Event is triggered if the request fails.
+
+* *status* – a string describing the type of error that occurred;
+* *error* – optional exception object, if one occurred;
+
+##Example
+
+We crafted small example application that uses Wiselinks so you can see it in action.
+
+* GitHub Repository: [https://github.com/igor-alexandrov/wiselinks_example](https://github.com/igor-alexandrov/wiselinks_example)
+
+* Live Example: [http://wiselinks.herokuapp.com/](http://wiselinks.herokuapp.com/)
+
+## Note on Patches / Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2012 [Igor Alexandrov](http://igor-alexandrov.github.com/), [Alexey Solilin](https://github.com/solilin) and [Julia Egorova](https://github.com/vankiru). See LICENSE for details.
+	

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.1.0

data/lib/assets/javascripts/wiselinks.js.coffee

@@ -17,7 +17,7 @@ class Wiselinks
         return if (!History.ready)
   
         state = History.getState()         
-        self._call(state.url, state.data.target, state.data.slide)  
+        self._call(state.url, state.data.target, state.data.render)  
 
         return false
     )
@@ -43,31 +43,31 @@ class Wiselinks
         return false
     )
   
-  load: (url, target, slide = 'template') ->
+  load: (url, target, render = 'template') ->
     History.ready = true
-    History.pushState({ timestamp: (new Date().getTime()), slide: slide, target: target }, document.title, decodeURI(url) )
+    History.pushState({ timestamp: (new Date().getTime()), render: render, target: target }, document.title, decodeURI(url) )
 
   reload: () ->
     History.ready = true
-    History.replaceState({ timestamp: (new Date().getTime()), slide: 'template' }, document.title, decodeURI(History.getState().url) )
+    History.replaceState({ timestamp: (new Date().getTime()), render: 'template' }, document.title, decodeURI(History.getState().url) )
 
-  _call: (url, target, slide = 'template') ->
+  _call: (url, target, render = 'template') ->
     self = this
-    $(document).trigger('wiselinks:loading')
+    $(document).trigger('page:loading', url, target, render)
 
     $.ajax(
       url: url
       headers:
-        'X-Slide': slide
+        'X-Render': render
       success: (data, status, xhr) ->
         document.title = xhr.getResponseHeader('X-Title')        
 
         $target = if target? then $(target) else self.$target
         $target.html(data)
 
-        $(document).trigger('wiselinks:success', data)
+        $(document).trigger('page:success', data, status)
       error: (xhr, status, error)->        
-        $(document).trigger('wiselinks:error', xhr)
+        $(document).trigger('page:error', status, error)
       dataType: "html"
     )
   

data/lib/headers.rb

@@ -0,0 +1,34 @@
+module Wiselinks
+  module Headers    
+
+  protected
+
+    def wiselinks_layout
+      'wiselinks'
+    end
+
+    def render(options = {}, *args, &block)
+      if self.wiselinks_request?
+        if self.wiselinks_partial_request?
+          options[:partial] ||= action_name
+        else
+          options[:layout] = self.wiselinks_layout        
+        end
+      end
+
+      super
+    end
+
+    def wiselinks_request?
+      request.headers['X-Render'].present?
+    end
+
+    def wiselinks_template_request?
+      self.wiselinks_request? && request.headers['X-Render'] != 'partial'
+    end
+
+    def wiselinks_partial_request?
+      self.wiselinks_request? && request.headers['X-Render'] == 'partial'
+    end
+  end
+end

data/lib/wiselinks.rb

@@ -1,10 +1,10 @@
-require 'layout'
+require 'headers'
 
 module Wiselinks
   class Engine < ::Rails::Engine
 
     initializer "wiselinks.register"  do
-      ActionController::Base.send :include, Layout
+      ActionController::Base.send :include, Headers
     end
     
   end

data/wiselinks.gemspec

@@ -5,28 +5,28 @@
 
 Gem::Specification.new do |s|
   s.name = "wiselinks"
-  s.version = "0.0.2"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Igor Alexandrov", "Alexey Solilin", "Julia Egorova"]
-  s.date = "2012-11-28"
+  s.date = "2012-12-19"
   s.email = "igor.alexandrov@gmail.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".document",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.md",
     "Rakefile",
     "VERSION",
     "app/views/layouts/wiselinks.html.erb",
     "lib/assets/javascripts/_history.js",
     "lib/assets/javascripts/wiselinks.js.coffee",
-    "lib/layout.rb",
+    "lib/headers.rb",
     "lib/wiselinks.rb",
     "test/helper.rb",
     "test/test_wiselinks.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wiselinks
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-28 00:00:00.000000000 Z
+date: 2012-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shoulda
@@ -83,19 +83,19 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
+- README.md
 files:
 - .document
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - app/views/layouts/wiselinks.html.erb
 - lib/assets/javascripts/_history.js
 - lib/assets/javascripts/wiselinks.js.coffee
-- lib/layout.rb
+- lib/headers.rb
 - lib/wiselinks.rb
 - test/helper.rb
 - test/test_wiselinks.rb
@@ -115,7 +115,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2052284491769893778
+      hash: -2438141941057179076
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/README.rdoc

@@ -1,19 +0,0 @@
-= wiselinks
-
-Description goes here.
-
-== Contributing to wiselinks
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2012 Igor Alexandrov. See LICENSE.txt for
-further details.
-

data/lib/layout.rb

@@ -1,20 +0,0 @@
-module Wiselinks
-  module Layout
-
-    def wiselinks_layout
-      'wiselinks'
-    end
-
-    def render(options = {}, *args, &block)
-      if request.headers['X-Slide'].present?
-        if request.headers['X-Slide'] == 'partial'
-          options[:partial] ||= action_name
-        else
-          options[:layout] = self.wiselinks_layout        
-        end
-      end
-
-      super
-    end
-  end
-end