tylerhunt-comeback 0.0.2

data/README.markdown

@@ -0,0 +1,61 @@
+Comeback
+========
+
+Provides a mechanism for storing URLs to return to at a later time. Allows the
+current URL, a custom URL, or the referer to be stored.
+
+When a referer is stored, it is checked against the current page URL, and if
+they're the same, then the referer won't be set and the default path will be
+used instead.
+
+By default, the session key :comeback_to is used to store the URL. The class
+inheritable accessor comeback_session_key can be set to override this.
+
+
+Example
+=======
+
+In your controller, you first call #store_referer to save the referer to the
+current page, and then to access it again, call #return_or_redirect_to and pass
+it the same arguments you would pass to #redirect_to as the default in case a
+referer has not been set:
+
+  class MyController < ApplicationController
+    def first_action
+      store_referer
+    end
+
+    def second_action
+      return_or_redirect_to root_path
+    end
+  end
+
+You can also store the referer using a before filter:
+
+  class MyController < ApplicationController
+    before_filter :store_referer, :only => :first_action
+
+    def first_action
+    end
+  end
+
+The current page URL can also be stored instead of the referer:
+
+  class MyController < ApplicationController
+    def first_action
+      store_location
+      redirect_to login_path
+    end
+  end
+
+Explicit URLs may also be stored:
+
+  class MyController < ApplicationController
+    def first_action
+      store_location dashbaord_path
+      redirect_to login_path
+    end
+  end
+  
+
+Copyright (c) 2008 Tyler Hunt, released under the MIT license

data/Rakefile

@@ -0,0 +1,29 @@
+require 'rake'
+require 'spec/rake/spectask'
+  
+begin
+  require 'jeweler'
+
+  Jeweler::Tasks.new do |gem|
+    gem.name = 'comeback'
+    gem.summary = 'Provides a mechanism for storing and accessing return URLs.'
+    gem.email = 'tyler@tylerhunt.com'
+    gem.homepage = 'http://github.com/tylerhunt/comeback'
+    gem.authors = ['Tyler Hunt']
+
+    gem.add_dependency('actionpack')
+
+    gem.add_development_dependency('jeweler', '~> 0.11.0')
+    gem.add_development_dependency('rspec', '~> 1.2.2')
+  end
+rescue LoadError
+  puts 'Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com'
+end
+
+task :default => :spec
+
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.libs << 'rails'
+  t.spec_opts = ['--colour --format progress --loadby mtime --reverse']
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 0
+:patch: 2
+:major: 0

data/lib/comeback.rb

@@ -0,0 +1,28 @@
+module Comeback
+  def self.included(base)
+    base.class_inheritable_accessor :comeback_session_key
+    base.comeback_session_key = :comeback_to
+  end
+
+  def store_location(url=nil)
+    session[comeback_session_key] ||= url ? url : request.url
+  end
+
+  def store_referer
+    referer = request.env['HTTP_REFERER']
+    store_location(referer) unless referer == request.url
+  end
+
+  def clear_location
+    session[comeback_session_key] = nil
+  end
+
+  def return_or_redirect_to(*args)
+    if session[comeback_session_key]
+      redirect_to(session[comeback_session_key])
+      clear_location
+    else
+      redirect_to(*args)
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1,5 @@
+require File.join(File.dirname(__FILE__), '..', 'lib', 'comeback')
+
+ActionController::Base.class_eval do
+  include Comeback
+end

data/spec/comeback_spec.rb

@@ -0,0 +1,47 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "Comeback" do
+  before(:each) do
+    @comeback_controller = Class.new(ActionController::Base).class_eval do
+      include ActionController::TestProcess
+    end
+
+    @request = mock("request")
+    @request.stub!(:env).and_return({ "HTTP_REFERER" => "/referer" })
+    @request.stub!(:url).and_return("/private")
+
+    @controller = @comeback_controller.new
+    @controller.stub!(:request).and_return(@request)
+    @controller.stub!(:session).and_return({})
+  end
+
+  describe "session key" do
+    it "should default to :comeback_to" do
+      @comeback_controller.comeback_session_key.should == :comeback_to
+    end
+
+    it "should be allowed to be overridden" do
+      @comeback_controller.comeback_session_key = :return_to
+      @comeback_controller.comeback_session_key.should == :return_to
+    end
+  end
+
+  describe "#store_location" do
+    it "should store the current location" do
+      @controller.store_location
+      @controller.session[:comeback_to].should == "/private"
+    end
+
+    it "should store the specified location" do
+      @controller.store_location("/other")
+      @controller.session[:comeback_to].should == "/other"
+    end
+  end
+
+  describe "#store_referer" do
+    it "should store the referer" do
+      @controller.store_referer
+      @controller.session[:comeback_to].should == "/referer"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+
+gem 'activerecord'
+require 'active_record'
+
+gem 'actionpack'
+require 'action_controller'
+require 'action_controller/test_process'
+
+require 'init'

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: tylerhunt-comeback
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Tyler Hunt
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-03 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.11.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.2.2
+    version: 
+description: 
+email: tyler@tylerhunt.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- README.markdown
+- Rakefile
+- VERSION.yml
+- lib/comeback.rb
+- rails/init.rb
+- spec/comeback_spec.rb
+- spec/spec_helper.rb
+has_rdoc: false
+homepage: http://github.com/tylerhunt/comeback
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Provides a mechanism for storing and accessing return URLs.
+test_files: 
+- spec/comeback_spec.rb
+- spec/spec_helper.rb