wiselinks 0.2.0 → 0.3.0

data/Gemfile

@@ -6,3 +6,10 @@ group :development do
   gem "bundler"
   gem "jeweler"
 end
+
+group :test do
+  gem 'sqlite3'
+  gem "shoulda", ">= 0"
+
+  gem 'rails', '>= 3.2.0'
+end

data/Gemfile.lock

@@ -1,23 +1,80 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    actionmailer (3.2.9)
+      actionpack (= 3.2.9)
+      mail (~> 2.4.4)
+    actionpack (3.2.9)
+      activemodel (= 3.2.9)
+      activesupport (= 3.2.9)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.9)
+      activesupport (= 3.2.9)
+      builder (~> 3.0.0)
+    activerecord (3.2.9)
+      activemodel (= 3.2.9)
+      activesupport (= 3.2.9)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.9)
+      activemodel (= 3.2.9)
+      activesupport (= 3.2.9)
     activesupport (3.2.9)
       i18n (~> 0.6)
       multi_json (~> 1.0)
+    arel (3.0.2)
     bourne (1.1.2)
       mocha (= 0.10.5)
+    builder (3.0.4)
+    erubis (2.7.0)
     git (1.2.5)
+    hike (1.2.1)
     i18n (0.6.1)
     jeweler (1.8.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
       rdoc
+    journey (1.0.4)
     json (1.7.5)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
     metaclass (0.0.1)
+    mime-types (1.19)
     mocha (0.10.5)
       metaclass (~> 0.0.1)
     multi_json (1.5.0)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (3.2.9)
+      actionmailer (= 3.2.9)
+      actionpack (= 3.2.9)
+      activerecord (= 3.2.9)
+      activeresource (= 3.2.9)
+      activesupport (= 3.2.9)
+      bundler (~> 1.0)
+      railties (= 3.2.9)
+    railties (3.2.9)
+      actionpack (= 3.2.9)
+      activesupport (= 3.2.9)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
     rake (10.0.3)
     rdoc (3.12)
       json (~> 1.4)
@@ -28,6 +85,18 @@ GEM
     shoulda-matchers (1.4.2)
       activesupport (>= 3.0.0)
       bourne (~> 1.1.2)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.6)
+    thor (0.16.0)
+    tilt (1.3.3)
+    treetop (1.4.12)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.35)
 
 PLATFORMS
   ruby
@@ -35,5 +104,7 @@ PLATFORMS
 DEPENDENCIES
   bundler
   jeweler
+  rails (>= 3.2.0)
   rdoc (~> 3.12)
   shoulda
+  sqlite3

data/README.md

@@ -1,3 +1,7 @@
+[![Build Status](https://travis-ci.org/igor-alexandrov/wiselinks.png?branch=master)](https://travis-ci.org/igor-alexandrov/wiselinks)
+[![Dependency Status](https://gemnasium.com/igor-alexandrov/wiselinks.png)](https://gemnasium.com/igor-alexandrov/wiselinks)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/igor-alexandrov/wiselinks)
+
 #Wiselinks
 
 Wiselinks makes following links and submitting some forms in your web application faster. 
@@ -22,17 +26,17 @@ Wiselinks works in all major browsers including browsers that do not support HTM
 	</thead>
 	<tbody>
 		<tr>
-			<td>Browsers with History API</td>
+			<td>Work in browsers with History API</td>
 			<td>Yes</td>
 			<td><strong>Yes</strong></td>
 		</tr>
 		<tr>
-			<td>Browsers without History API</td>
+			<td>Work in browsers without History API</td>
 			<td>No, degrades to normal request processing.</td>
 			<td><strong>Yes</strong></td>
 		</tr>
 		<tr>
-			<td>No JavaScript</td>
+			<td>Work without JavaScript</td>
 			<td>No, degrades to normal request processing.</td>
 			<td>No, degrades to normal request processing.</td>
 		</tr>
@@ -46,6 +50,11 @@ Wiselinks works in all major browsers including browsers that do not support HTM
 			<td>No</td>
 			<td><strong>Yes</strong></td>
 		</tr>
+		<tr>
+			<td>Asset change detection</td>
+			<td>Yes, by parsing document head on every request.</td>
+			<td><strong>Yes</strong>, by calculating assets MD5 hash on boot.</td>
+		</tr>
 	</tbody>
 </table>
 
@@ -221,7 +230,9 @@ Event is triggered if the request fails.
 * *status* – a string describing the type of error that occurred;
 * *error* – optional exception object, if one occurred;
 
-## Request methods
+So if you wanted to have a client-side spinner, you could listen for `page:loading` to start it and `page:success` or `page:error` to stop it.
+
+## ActionDispatch::Request extensions
 
 Wiselinks adds a couple of methods to `ActionDispatch::Request`. These methods are mostly syntax sugar and don't have any complex logic, so you can use them or not.
 
@@ -234,6 +245,20 @@ Method returns `true` if current request is initiated by Wiselinks and client wa
 ### #wiselinks_partial? ###
 Method returns `true` if current request is initiated by Wiselinks and client want to render partial, `false` otherwise. 
 
+## Title handling
+
+Wiselinks handles page titles by passing `X-Title` header with response. To do this you can use `wiselinks_title` helper.
+
+```html	
+<% wiselinks_title("Wiselinks is awesome") %>
+
+<div>
+	<!-- your content -->
+	...
+</div>
+```
+
+Of course you can use `wiselinks_title` helper in your own helpers too.
 
 ##Example
 

data/Rakefile

@@ -26,7 +26,7 @@ Jeweler::RubygemsDotOrgTasks.new
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
+  test.pattern = 'test/**/*_test.rb'  
   test.verbose = true
 end
 

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

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

@@ -5,7 +5,7 @@ String.prototype.ends_with = (suffix) ->
 
 class Wiselinks
   constructor: (@$target = $('body'), options = {}) ->
-    # check that JQuery or Zepto.js are available
+    # Check that JQuery is available
     throw "Load JQuery to use Wiselinks" unless window.jQuery?
 
     self = this
@@ -34,14 +34,16 @@ class Wiselinks
     $(document).on(
       "click", "a[data-push], a[data-replace]"
       (event) ->      
-        if (event.ctrlKey || event.metaKey)
+        if self._cross_origin_link(event.target) || self._non_standard_click(event)
           return true;
-        
+
         self._process_link($(this))
 
         event.preventDefault()
         return false
     )
+
+    @assets_digest = $("meta[name='assets-digest']").attr("content")
   
   load: (url, target, render = 'template') ->
     History.ready = true
@@ -62,12 +64,15 @@ class Wiselinks
       url: url
       headers:
         'X-Render': render
-      success: (data, status, xhr) ->
-        document.title = xhr.getResponseHeader('X-Title')        
-        
-        $target.html(data)
+      success: (data, status, xhr) ->                
+        if self._assets_changed(xhr.getResponseHeader('X-Assets-Digest'))
+          window.location.reload(true)
+        else
+          document.title = xhr.getResponseHeader('X-Title')
+          
+          $target.html(data)
 
-        $(document).trigger('page:success', [data, status])
+          $(document).trigger('page:success', [data, status])
       error: (xhr, status, error)->        
         $(document).trigger('page:error', [status, error])
       dataType: "html"
@@ -115,4 +120,13 @@ class Wiselinks
 
     self.load($link.attr("href"), $link.attr("data-target"), type)
 
+  _cross_origin_link: (link) ->
+    (location.protocol != link.protocol) || (location.host != link.host)
+
+  _non_standard_click: (event) ->
+    event.metaKey || event.ctrlKey || event.shiftKey || event.altKey  
+
+  _assets_changed: (digest) ->
+    digest? && @assets_digest != digest
+
 window.Wiselinks = Wiselinks

data/lib/wiselinks.rb

@@ -1,16 +1,24 @@
-require 'wiselinks/headers'
 require 'wiselinks/request'
+require 'wiselinks/headers'
+require 'wiselinks/helpers'
+
 require 'wiselinks/logger'
 
+require 'wiselinks/rails' if defined?(::Rails)
+
 module Wiselinks
-  class Engine < ::Rails::Engine
-    initializer 'wiselinks.setup_logger' do
-      Wiselinks::Logger.logger = Rails.logger
-    end
+  extend Logger
+
+  DEFAULTS = {    
+    :assets_digest => nil,
+    :logger => nil
+  }
+
+  def self.options
+    @options ||= DEFAULTS.dup
+  end
 
-    initializer "wiselinks.register"  do
-      ActionController::Base.send :include, Headers
-      ActionDispatch::Request.send :include, Request
-    end    
+  def self.options=(value)
+    @options = value
   end
 end

data/lib/wiselinks/headers.rb

@@ -1,5 +1,9 @@
 module Wiselinks
   module Headers    
+    
+    def self.included(base)      
+      base.helper_method :wiselinks_title
+    end
 
   protected
 
@@ -8,17 +12,31 @@ module Wiselinks
     end
 
     def render(options = {}, *args, &block)
-      if self.request.wiselinks?
+      if self.request.wiselinks?                
         if self.request.wiselinks_partial?
+          Wiselinks.log("processing partial request")
           options[:partial] ||= action_name
         else
+          Wiselinks.log("processing template request")
           options[:layout] = self.wiselinks_layout        
         end
+
+        if Wiselinks.options[:assets_digest].present?
+          Wiselinks.log("assets digest #{Wiselinks.options[:assets_digest]}")
+
+          self.headers['X-Assets-Digest'] = Wiselinks.options[:assets_digest]          
+        end
       end
 
       super
     end
 
+    def wiselinks_title(value)
+      Wiselinks.log("title: #{value}")
+
+      self.headers['X-Title'] = value if self.request.wiselinks?
+    end    
+
     def wiselinks_request?
       Wiselinks::Logger.log "DEPRECATION WARNING: Method `wiselinks_request?` is deprecated. Please use `request.wiselinks?` instead."
 

data/lib/wiselinks/helpers.rb

@@ -0,0 +1,9 @@
+module Wiselinks
+  module Helpers    
+    def wiselinks_meta_tag
+      if Wiselinks.options[:assets_digest].present?       
+        tag('meta', :name => 'assets-digest', :content => Wiselinks.options[:assets_digest])
+      end
+    end 
+  end
+end

data/lib/wiselinks/logger.rb

@@ -1,17 +1,11 @@
 module Wiselinks
-  module Logger
-    extend self
-
-    def self.logger
-      @logger ||= ::Logger.new(STDOUT)
-    end
-
-    def logger=(logger)
-      @logger = logger
+  module Logger    
+    def logger
+      @logger ||= Wiselinks.options[:logger] || ::Logger.new(STDOUT)
     end
 
     def log(message)
-      logger.info("[wiselinks] #{message}")
+      self.logger.info("[wiselinks] #{message}")
     end
   end
 end

data/lib/wiselinks/rails.rb

@@ -0,0 +1,21 @@
+module Wiselinks
+  module Rails
+    class Engine < ::Rails::Engine
+      initializer 'wiselinks.register_logger' do        
+        Wiselinks.options[:logger] = ::Rails.logger
+      end
+
+      initializer "wiselinks.register_extensions"  do
+        ActionDispatch::Request.send :include, Request
+        ActionController::Base.send :include, Headers
+        ActionView::Base.send :include, Helpers        
+      end    
+
+      initializer "wiselinks.register_assets_digest"  do
+        if ::Rails.application.config.assets.digest && ::Rails.application.config.assets.digests.present?
+          Wiselinks.options[:assets_digest] ||= Digest::MD5.hexdigest(::Rails.application.config.assets.digests.values.join)
+        end
+      end
+    end
+  end
+end

data/test/cases/application_controller_test.rb

@@ -0,0 +1,35 @@
+require 'helper'
+
+class ApplicationControllerTest < ActionController::TestCase
+  tests ApplicationController
+ 
+  context "Request" do 
+    setup do
+      @request = @controller.request
+    end
+
+    should "respond to #wiselinks?" do
+      assert_respond_to @request, :wiselinks?
+    end
+    
+    should "respond to #wiselinks_partial?" do
+      assert_respond_to @request, :wiselinks_partial?
+    end    
+    
+    should "respond to #wiselinks_template?" do
+      assert_respond_to @request, :wiselinks_template?
+    end
+  end
+
+  context "Layout" do
+    should "respond to #wiselinks_layout" do
+      assert_respond_to @controller, :wiselinks_layout
+    end
+  end
+
+  context "Title" do
+    should "respond to #wiselinks_title" do
+      assert_respond_to @controller, :wiselinks_title
+    end
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.