turbolinks-redirect 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in turbolinks-redirect.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jeremy Ruppel
+
+MIT License
+
+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.md

@@ -0,0 +1,65 @@
+# Turbolinks::Redirect
+
+Simple `redirect_to` support for [turbolinks][turbolinks] and
+[jquery-rails][jquery-rails].
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'turbolinks-redirect'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install turbolinks-redirect
+
+## Usage
+
+This approach assumes that you are trying to get turbolinks to play nice
+with rails_ujs and want your ajax forms to be able to "redirect" on success.
+
+Simply require `turbolinks.redirect` in your javascripts:
+
+``` javascript
+//= require turbolinks
+//= require turbolinks.redirect
+```
+
+Now, write your controller actions as you normally would:
+
+``` ruby
+class PostsController < ActionController::Base
+
+  def create
+    @post = Post.new params[ :post ]
+    if @post.save
+      redirect_to @post
+    else
+      render :new
+    end
+  end
+end
+```
+
+Under the hood, `redirect_to` checks to see if the request is an XHR. If
+it is, instead of responding with a 3xx status code, it responds with a
+custom 2xx status code, still setting the Location header.
+
+Then, a handler is attached to the rails_ujs "ajax:success" event. It
+checks for this particular status code, and if it finds it, tells
+turbolinks to visit the page located in the header.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+[turbolinks]: https://github.com/rails/turbolinks/
+[jquery-rails]: https://github.com/rails/jquery-rails

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/assets/javascripts/turbolinks.redirect.js.coffee.erb

@@ -0,0 +1,10 @@
+#= require jquery_ujs
+#= require turbolinks
+
+##
+# On form success, we check for a custom status code we use to denote a
+# "Turbolinks Redirect". If we find it, we will have the redirect location
+# in the Location header and manually direct turbolinks to visit that url.
+$( @ ).on 'ajax:success', ( event, data, status, xhr ) ->
+  if xhr.status is <%= Rack::Utils::SYMBOL_TO_STATUS_CODE[ :turbolinks ] %>
+    Turbolinks.visit( xhr.getResponseHeader( 'Location' ) )

data/lib/turbolinks-redirect.rb

@@ -0,0 +1 @@
+require 'turbolinks/redirect'

data/lib/turbolinks/redirect.rb

@@ -0,0 +1,44 @@
+require 'turbolinks/redirect/version'
+require 'turbolinks'
+require 'jquery-rails'
+
+module Turbolinks
+  module Redirect
+    ##
+    # Allows client-side redirection for rails ujs ajax requests. The client
+    # will look for HTTP status code 278, and will use turbolinks to request
+    # the new page if found. Status code 278 has no real significance, except
+    # that it is mentioned for this purpose at the following stackoverflow
+    # conversation: http://stackoverflow.com/a/304654
+    STATUS_CODE = 278
+    ::Rack::Utils::HTTP_STATUS_CODES[ STATUS_CODE ] = 'Turbolinks Redirect'
+    ::Rack::Utils::SYMBOL_TO_STATUS_CODE[ :turbolinks ] = STATUS_CODE
+
+    ##
+    # All methods that will be included in ActionController::Base.
+    module Concern
+
+      ##
+      # Override #redirect_to to automatically respond with a status
+      # of :turbolinks if this request is AJAX.
+      def redirect_to( options={}, response_status={} )
+        if request.xhr?
+          super options, response_status.merge( :status => :turbolinks )
+        else
+          super
+        end
+      end
+    end
+
+    ##
+    # Rails integration
+    class Engine < Rails::Engine
+
+      initializer :turbolinks_redirect do
+        ActionController::Base.class_eval do
+          include Turbolinks::Redirect::Concern
+        end
+      end
+    end
+  end
+end

data/lib/turbolinks/redirect/version.rb

@@ -0,0 +1,5 @@
+module Turbolinks
+  module Redirect
+    VERSION = '0.0.1'
+  end
+end

data/turbolinks-redirect.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'turbolinks/redirect/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "turbolinks-redirect"
+  spec.version       = Turbolinks::Redirect::VERSION
+  spec.authors       = ["Jeremy Ruppel"]
+  spec.email         = ["jeremy.ruppel@gmail.com"]
+  spec.description   = %q{Simple redirect_to support for Turbolinks.}
+  spec.summary       = %q{Simple redirect_to support for Turbolinks.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'railties'
+  spec.add_dependency 'turbolinks'
+  spec.add_dependency 'jquery-rails'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: turbolinks-redirect
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jeremy Ruppel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: turbolinks
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple redirect_to support for Turbolinks.
+email:
+- jeremy.ruppel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/assets/javascripts/turbolinks.redirect.js.coffee.erb
+- lib/turbolinks-redirect.rb
+- lib/turbolinks/redirect.rb
+- lib/turbolinks/redirect/version.rb
+- turbolinks-redirect.gemspec
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Simple redirect_to support for Turbolinks.
+test_files: []