jump_back 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c5c25bd37934df5bd36a00c7298d6daecb311a5d
+  data.tar.gz: 260c81ec52405db3d5c7f3f8706042104a0ac180
+SHA512:
+  metadata.gz: d774bb9f4e0e6de408df40d3752487100d679d71cbc270fd6f1cdd51d59c136859ed0f10e198a7398268183bd3a57bce2742d42f1f9da7532c05463c4eb996e9
+  data.tar.gz: f3470c7d4c1a021446d0335147a9a14f3e5f70167ed68ec862ebbfc8e30577168b13a599e8094e5ecf97031429521bcaa36ab09c93b37608f68159bf07f6d623

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Peter Debelak
+
+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/Rakefile

@@ -0,0 +1,15 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+Bundler::GemHelper.install_tasks
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+require 'rspec/core'
+require 'rspec/core/rake_task'
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+task :default => :spec

data/lib/jump_back.rb

@@ -0,0 +1,6 @@
+require 'jump_back/engine'
+require 'jump_back/redirect_back'
+require 'jump_back/return_to_referer'
+
+module JumpBack
+end

data/lib/jump_back/engine.rb

@@ -0,0 +1,12 @@
+module JumpBack
+  class Engine < ::Rails::Engine
+    config.generators do |g|
+      g.test_framework      :rspec,        :fixture => false
+      g.assets false
+      g.helper false
+    end
+    initializer "jump_back.methods" do |app|
+      ApplicationController.send :include, JumpBack
+    end
+  end
+end

data/lib/jump_back/redirect_back.rb

@@ -0,0 +1,41 @@
+module JumpBack
+  def redirect_back(path=root_path, options={})
+    if path.is_a? Hash
+      options = path
+      path = root_path
+    end
+    RefererInterpreter.new.back?(request, options) ? redirect_to(:back) : redirect_to(path)
+  end
+  
+  class RefererInterpreter
+    
+    def back?(request, options)
+      has_referer?(request) ? is_local?(request, options) ? true : false : false
+    end
+    
+    def has_referer?(request)
+      !request.env["HTTP_REFERER"].blank? and request.env["HTTP_REFERER"] != request.env["REQUEST_URI"]
+    end
+    
+    def is_local?(request, options)
+      return true if options[:offsite]
+      host = host(request.env["HTTP_REFERER"])
+      !(host && host != request.host)
+    end
+    
+    private
+    
+      def host(string)
+        return URI.parse(string).host if uri? string
+      end
+    
+      def uri?(string)
+        uri = URI.parse(string)
+        %w( http https ).include?(uri.scheme)
+        rescue URI::BadURIError
+        false
+        rescue URI::InvalidURIError
+        false
+      end
+  end
+end

data/lib/jump_back/return_to_referer.rb

@@ -0,0 +1,13 @@
+module JumpBack
+  def save_referer
+    session[:jump_back_stored_referer] ||= request.referer
+  end
+
+  def return_to_referer(path=root_path)
+    session[:jump_back_stored_referer] ? redirect_to(clear_referer) : redirect_to(path)
+  end
+
+  def clear_referer
+    session.delete(:jump_back_stored_referer)
+  end
+end

data/lib/jump_back/version.rb

@@ -0,0 +1,3 @@
+module JumpBack
+  VERSION = "0.0.1"
+end

data/lib/tasks/jump_back_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :jump_back do
+#   # Task goes here
+# end

data/spec/controller/application_controller_spec.rb

@@ -0,0 +1,18 @@
+describe ApplicationController do
+  
+  it 'should have the redirect_back method' do
+    expect(ApplicationController.new).to respond_to :redirect_back
+  end
+
+  it 'should have the save_referer method' do
+    expect(ApplicationController.new).to respond_to :save_referer
+  end
+
+  it 'should have the return_to_referer method' do
+    expect(ApplicationController.new).to respond_to :return_to_referer
+  end
+
+  it 'should have the clear_referer method' do
+    expect(ApplicationController.new).to respond_to :clear_referer
+  end
+end

data/spec/controller/tests_controller_spec.rb

@@ -0,0 +1,122 @@
+describe TestsController, type: :controller do
+
+  describe 'redirect_back' do
+    
+    it 'should redirect to default with no referer and no arguments' do
+      post :create
+      expect(response).to redirect_to(root_path)
+    end
+    
+    it 'should redirect to the supplied path with no referer' do
+      delete :destroy, id: 1
+      expect(response).to redirect_to(new_test_path)
+    end
+    
+    it 'should redirect back with a referer' do
+      @request.env['HTTP_REFERER'] = test_path(1)
+      post :create
+      expect(response).to redirect_to(test_path(1))
+      delete :destroy, id: 2
+      expect(response).to redirect_to(test_path(1))
+    end
+    
+    it 'should not redirect back when the referer is offsite' do
+      @request.env['HTTP_REFERER'] = 'http://rubyonrails.org/'
+      post :create
+      expect(response).to redirect_to(root_path)
+      delete :destroy, id: 1
+      expect(response).to redirect_to(new_test_path)
+    end
+    
+    it 'should redirect back when referer is offsite with offsite set to true' do
+      @request.env['HTTP_REFERER'] = 'http://rubyonrails.org/'
+      get :offsite_with_default
+      expect(response).to redirect_to('http://rubyonrails.org/')
+    end
+    
+    it 'should redirect back when referer is offsite with offsite set to true with no path argument' do
+      @request.env['HTTP_REFERER'] = 'http://rubyonrails.org/'
+      get :offsite_without_default
+      expect(response).to redirect_to('http://rubyonrails.org/')
+    end
+    
+    it 'should work normally with no referer if offsite is true' do
+      get :offsite_with_default
+      expect(response).to redirect_to(new_test_path)
+      get :offsite_without_default
+      expect(response).to redirect_to(root_path)
+    end
+  end
+  
+  describe 'save_referer' do
+    
+    it 'should save the referer in the session' do
+      @request.env['HTTP_REFERER'] = test_path(1)
+      get :new
+      expect(session[:jump_back_stored_referer]).to eq(test_path(1))
+    end
+    
+    it 'should not overwrite the referer once saved' do
+      @request.env['HTTP_REFERER'] = test_path(1)
+      get :new
+      @request.env['HTTP_REFERER'] = new_test_path
+      get :new
+      expect(session[:jump_back_stored_referer]).to eq(test_path(1))
+    end
+  end
+  
+  describe 'clear_referer' do
+    
+    it 'should remove the stored referer' do
+      @request.env['HTTP_REFERER'] = test_path(1)
+      get :new
+      expect(session[:jump_back_stored_referer]).to eq(test_path(1))
+      delete :destroy, id: 1
+      expect(session[:jump_back_stored_referer]).to be_nil
+    end
+    
+    it 'should remove the stored referer so it can be written' do
+      @request.env['HTTP_REFERER'] = test_path(1)
+      get :new
+      expect(session[:jump_back_stored_referer]).to eq(test_path(1))
+      @request.env['HTTP_REFERER'] = new_test_path
+      get :edit, id: 1
+      expect(session[:jump_back_stored_referer]).to eq(new_test_path)
+    end
+  end
+  
+  describe 'return_to_referer' do
+    it 'should redirect to saved referer' do
+      @request.env['HTTP_REFERER'] = test_path(1)
+      get :new
+      put :update, id: 1
+      expect(response).to redirect_to(test_path(1))
+    end
+    
+    it 'should redirect to saved referer even with actions in between' do
+      @request.env['HTTP_REFERER'] = test_path(1)
+      get :new
+      post :create
+      put :update, id: 1
+      expect(response).to redirect_to(test_path(1))
+    end
+    
+    it 'should delete the stored referer' do
+      @request.env['HTTP_REFERER'] = test_path(1)
+      get :new
+      expect(session[:jump_back_stored_referer]).to eq(test_path(1))
+      put :update, id: 1
+      expect(session[:jump_back_stored_referer]).to be_nil
+    end
+    
+    it 'should redirect to default with no referer and no arguments' do
+      put :update, id: 1
+      expect(response).to redirect_to(root_path)
+    end
+    
+    it 'should redirect to argument with no referer' do
+      get :show, id: 1
+      expect(response).to redirect_to(new_test_path)
+    end
+  end
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/controllers/tests_controller.rb

@@ -0,0 +1,38 @@
+class TestsController < ApplicationController
+  def index
+  end
+
+  def show
+    return_to_referer new_test_path
+  end
+
+  def new
+    save_referer
+  end
+
+  def create
+    redirect_back
+  end
+
+  def edit
+    clear_referer
+    save_referer
+  end
+
+  def update
+    return_to_referer
+  end
+
+  def destroy
+    clear_referer
+    redirect_back new_test_path
+  end
+  
+  def offsite_with_default
+    redirect_back new_test_path, offsite: true
+  end
+  
+  def offsite_without_default
+    redirect_back offsite: true
+  end
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/app/views/tests/edit.html.erb

@@ -0,0 +1,3 @@
+Edit Page
+
+<%= link_to 'Go to new page', new_test_path %>

data/spec/dummy/app/views/tests/index.html.erb

@@ -0,0 +1,6 @@
+Index Page
+<%= form_tag test_path(1), method: :put do %>
+  <%= submit_tag 'Update test' %>
+<% end %>
+
+<%= link_to 'Go to new page', new_test_path %>

data/spec/dummy/app/views/tests/new.html.erb

@@ -0,0 +1,6 @@
+New Page
+<%= form_tag tests_path do %>
+  <%= submit_tag 'New test' %>
+<% end %>
+
+<%= link_to 'Go to edit page', edit_test_path(1) %>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run