jump_back 0.2.2 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13b46750e5e152338c99ca95598a07da26f2520c
-  data.tar.gz: bcfc2c6ff049737adca0d7d039ec284e76caae0d
+  metadata.gz: 0af5b300967e7ac035f3ebb0cec0c0d12a48f068
+  data.tar.gz: 05424a881293b19251376c3cf655eab3e989de54
 SHA512:
-  metadata.gz: ae36bde7619da211b1d0277079188c376734124f926ebb65ccce53e5251c742a26ffd37e03651e67e9baea4292f2078ff41be724724fe3ee16c15f35ebc844b0
-  data.tar.gz: 44ec9bd6e00a0fa7f45c9f43ffe603386ae9b8d4cf2978d5a538613831100c013fc9ce1d255f40db3f9d682fdf3c1778520a15a0a323e6f7c258d5f16c500a8a
+  metadata.gz: c63a0123fba02897bae16ede59524a275fe62ccf5d675ccc8167bcf9beb84e4f01791c898f7c6590ade0bad45a9b56e3bdf0c663b5890de5dc9208d94a416fb5
+  data.tar.gz: 6ecd0e9ca8aa795a94387134bd01e5239fb69baadbaca72b1f554fc84a658405e5512d0f0facc77111475adca6227711d1365d75449810f7c01f446a0e6fcd96

data/lib/jump_back/engine.rb

@@ -7,6 +7,7 @@ module JumpBack
     end
     initializer "jump_back.methods" do |app|
       ApplicationController.send :include, JumpBack::Redirection
+      ActionView::Base.send :include, JumpBack::Helpers
     end
   end
 end

data/lib/jump_back/link_back.rb

@@ -0,0 +1,31 @@
+module JumpBack
+  
+  module Helpers
+    
+    def link_back(name='back', path=root_path, options={})
+      args = HelpersArguments.parse(name, path, options, root_path)
+      link_to args[:name], PathFinder.new(request, args[:path], args[:jump_back_options]).path, args[:redirect_options]
+    end
+  end
+  
+  module HelpersArguments
+    
+    def self.parse(name, path, options, root_path)
+      if first_arg_is_path?(name, path, root_path)
+        options = path if path.is_a? Hash
+        path = name
+        name = 'back'
+      end
+      if name.is_a? Hash
+        options = name
+        name = 'back'
+      end
+      options = OptionsParser.new(default: root_path, path: path, options: options)
+      { name: name, path: options.path, jump_back_options: options.jump_back_options, redirect_options: options.redirect_options }
+    end
+    
+    def self.first_arg_is_path?(name, path, root_path)
+      Urls.is_url?(name) && (path == root_path || path.is_a?(Hash))
+    end
+  end
+end

data/lib/jump_back/options_parser.rb

@@ -2,18 +2,25 @@ module JumpBack
   
   class OptionsParser
     
-    def self.parse(path, options, default)
-      if path.is_a? Hash
-        options = path
-        path = default
+    attr_reader :path, :redirect_options, :jump_back_options
+    
+    def initialize(options)
+      @path = parse(options)[:path]
+      @redirect_options = parse(options)[:redirect_options]
+      @jump_back_options = parse(options)[:jump_back_options]
+    end
+    
+    def parse(options)
+      return @options if @options
+      
+      if options[:path].is_a? Hash
+        options[:options] = options[:path]
+        options[:path] = options[:default]
       end
       
-      jump_back_options = { offsite: options.delete(:offsite) }
-      {
-        redirect_options: options,
-        jump_back_options: jump_back_options,
-        path: path
-      }
+      options[:jump_back_options] = { offsite: options[:options].delete(:offsite) }
+      options[:redirect_options] = options.delete(:options)
+      @options = options
     end
   end
 end

data/lib/jump_back/path_finder.rb

@@ -0,0 +1,36 @@
+module JumpBack
+  
+  class PathFinder
+    attr_reader :path
+    
+    def initialize(request, path, options)
+      @uri = Urls.uri(request.env["HTTP_REFERER"])
+      @path = determine_path(request, path, options)
+    end
+    
+    def redirect_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.host)
+    end
+    
+    private
+    
+      attr_reader :uri
+    
+      def determine_path(request, path, options)
+        redirect_back?(request, options) ? :back : path
+      end
+    
+      def host
+        uri.host if uri
+      end
+  end
+end

data/lib/jump_back/redirect_back.rb

@@ -1,14 +1,10 @@
-require 'jump_back/referer_interpreter'
-require 'jump_back/redirection_determiner'
-require 'jump_back/options_parser'
-
 module JumpBack
   
   module Redirection
     
     def redirect_back(path=root_path, options={})
-      parsed_args = OptionsParser.parse(path, options, root_path)
-      redirect_to RedirectionDeterminer.new(request, parsed_args[:path], parsed_args[:jump_back_options]).path, parsed_args[:redirect_options]
+      options = OptionsParser.new(path: path, options: options, default: root_path)
+      redirect_to PathFinder.new(request, options.path, options.jump_back_options).path, options.redirect_options
     end
   end
 end

data/lib/jump_back/return_to_referer.rb

@@ -9,8 +9,8 @@ module JumpBack
     end
   
     def return_to_referer(path=root_path, options={})
-      parsed_args = OptionsParser.parse(path, options, root_path)
-      session[:jump_back_stored_referer] ? redirect_to(clear_referer, parsed_args[:redirect_options]) : redirect_to(parsed_args[:path], parsed_args[:redirect_options])
+      options = OptionsParser.new(path: path, options: options, default: root_path)
+      session[:jump_back_stored_referer] ? redirect_to(clear_referer, options.redirect_options) : redirect_to(options.path, options.redirect_options)
     end
   
     def clear_referer

data/lib/jump_back/urls.rb

@@ -0,0 +1,28 @@
+module JumpBack
+  
+  module Urls
+    
+    def self.is_url?(string)
+      is_uri?(string) || is_path?(string)
+    end
+    
+    def self.uri(string)
+      URI.parse string if is_uri? string
+    end
+    
+    def self.is_uri?(string)
+      uri = URI.parse string
+      %w( http https ).include? uri.scheme
+      rescue URI::BadURIError
+      false
+      rescue URI::InvalidURIError
+      false
+    end
+    
+    def self.is_path?(string)
+      !!(Rails.application.routes.recognize_path string)
+      rescue ActionController::RoutingError
+      false
+    end
+  end
+end

data/lib/jump_back/version.rb

@@ -1,3 +1,3 @@
 module JumpBack
-  VERSION = "0.2.2"
+  VERSION = "0.3.1"
 end

data/lib/jump_back.rb

@@ -1,6 +1,9 @@
 require 'jump_back/engine'
 require 'jump_back/redirect_back'
 require 'jump_back/return_to_referer'
+require 'jump_back/path_finder'
+require 'jump_back/link_back'
+require 'jump_back/urls'
 
 module JumpBack
 end

data/spec/controller/application_controller_spec.rb

@@ -2,35 +2,20 @@ describe ApplicationController do
   
   describe 'jump_back methods' do
   
-    it 'should have the redirect_back method' do
+    it 'has the redirect_back method' do
       expect(ApplicationController.new).to respond_to :redirect_back
     end
   
-    it 'should have the save_referer method' do
+    it 'has the save_referer method' do
       expect(ApplicationController.new).to respond_to :save_referer
     end
   
-    it 'should have the return_to_referer method' do
+    it 'has the return_to_referer method' do
       expect(ApplicationController.new).to respond_to :return_to_referer
     end
   
-    it 'should have the clear_referer method' do
+    it 'has the clear_referer method' do
       expect(ApplicationController.new).to respond_to :clear_referer
     end
   end
-  
-  describe 'private jump_back classes' do
-    
-    it 'should not have the OptionsParser class' do
-      expect { ApplicationController::OptionsParser.new }.to raise_error
-    end
-    
-    it 'should not have the RefererInterpreter class' do
-      expect { ApplicationController::RefererInterpreter.new }.to raise_error
-    end
-    
-    it 'should not have the RedirectionDeterminer class' do
-      expect { ApplicationController::RedirectionDeterminer.new }.to raise_error
-    end
-  end
 end

data/spec/controller/tests_controller_spec.rb

@@ -2,79 +2,79 @@ describe TestsController, type: :controller do
 
   describe 'redirect_back' do
     
-    it 'should redirect to default with no referer and no arguments' do
-      post :create
+    it 'redirects to default with no referer and no arguments' do
+      post :redirect_with_options
       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)
+    it 'redirects to the supplied path with no referer' do
+      delete :clear_and_redirect
+      expect(response).to redirect_to(save_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))
+    it 'redirects back with a referer' do
+      @request.env['HTTP_REFERER'] = return_with_path_path
+      post :redirect_with_options
+      expect(response).to redirect_to(return_with_path_path)
+      delete :clear_and_redirect
+      expect(response).to redirect_to(return_with_path_path)
     end
     
-    it 'should not redirect back when the referer is offsite' do
+    it 'doesn\'t redirect back when the referer is offsite' do
       @request.env['HTTP_REFERER'] = 'http://rubyonrails.org/'
-      post :create
+      post :redirect_with_options
       expect(response).to redirect_to(root_path)
-      delete :destroy, id: 1
-      expect(response).to redirect_to(new_test_path)
+      delete :clear_and_redirect
+      expect(response).to redirect_to(save_path)
     end
     
-    it 'should redirect back when referer is offsite with offsite set to true' do
+    it 'redirects back when referer is offsite with offsite set to true' do
       @request.env['HTTP_REFERER'] = 'http://rubyonrails.org/'
-      get :offsite_with_default
+      get :offsite_with_path
       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
+    it 'redirects 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
+      get :offsite
       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
+    it 'works normally with no referer if offsite is true' do
+      get :offsite_with_path
+      expect(response).to redirect_to(save_path)
+      get :offsite
       expect(response).to redirect_to(root_path)
     end
     
-    it 'should pass additional options to redirect_to' do
-      post :create
+    it 'passes additional options to redirect_to' do
+      post :redirect_with_options
       expect(flash[:notice]).to eq('Created!')
       expect(response.status).to eq(301)
     end
     
-    it 'should pass additional options with offsite set to true with default specified and a referer' do
+    it 'passes additional options with offsite set to true with path specified and a referer' do
       @request.env['HTTP_REFERER'] = 'http://rubyonrails.org/'
-      get :offsite_with_default
+      get :offsite_with_path
       expect(response).to redirect_to('http://rubyonrails.org/')
       expect(flash[:alert]).to eq('Offsite with default!')
     end
     
-    it 'should pass additional options with offsite set to true without default specified and a referer' do
+    it 'passes additional options with offsite set to true without path specified and a referer' do
       @request.env['HTTP_REFERER'] = 'http://rubyonrails.org/'
-      get :offsite_without_default
+      get :offsite
       expect(response).to redirect_to('http://rubyonrails.org/')
       expect(flash[:alert]).to eq('Offsite without default!')
     end
     
-    it 'should pass additional options with offsite set to true with default specified and no referer' do
-      get :offsite_with_default
-      expect(response).to redirect_to(new_test_path)
+    it 'passes additional options with offsite set to true with path specified and no referer' do
+      get :offsite_with_path
+      expect(response).to redirect_to(save_path)
       expect(flash[:alert]).to eq('Offsite with default!')
     end
     
-    it 'should pass additional options with offsite set to true without default specified and no referer' do
-      get :offsite_without_default
+    it 'passes additional options with offsite set to true without path specified and no referer' do
+      get :offsite
       expect(response).to redirect_to(root_path)
       expect(flash[:alert]).to eq('Offsite without default!')
     end
@@ -82,83 +82,83 @@ describe TestsController, type: :controller do
   
   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))
+    it 'saves the referer in the session' do
+      @request.env['HTTP_REFERER'] = return_with_path_path
+      get :save
+      expect(session[:jump_back_stored_referer]).to eq(return_with_path_path)
     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))
+    it 'doesn\'t overwrite the referer once saved' do
+      @request.env['HTTP_REFERER'] = return_with_path_path
+      get :save
+      @request.env['HTTP_REFERER'] = save_path
+      get :save
+      expect(session[:jump_back_stored_referer]).to eq(return_with_path_path)
     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
+    it 'removes the stored referer' do
+      @request.env['HTTP_REFERER'] = return_with_path_path
+      get :save
+      expect(session[:jump_back_stored_referer]).to eq(return_with_path_path)
+      delete :clear_and_redirect
       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)
+    it 'removes the stored referer so it can be written' do
+      @request.env['HTTP_REFERER'] = return_with_path_path
+      get :save
+      expect(session[:jump_back_stored_referer]).to eq(return_with_path_path)
+      @request.env['HTTP_REFERER'] = save_path
+      get :clear_and_save
+      expect(session[:jump_back_stored_referer]).to eq(save_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
+    it 'redirects to saved referer' do
+      @request.env['HTTP_REFERER'] = return_with_path_path
+      get :save
+      put :return_with_options
+      expect(response).to redirect_to(return_with_path_path)
+    end
+    
+    it 'redirects to saved referer even with actions in between' do
+      @request.env['HTTP_REFERER'] = return_with_path_path
+      get :save
+      post :redirect_with_options
+      put :return_with_options
+      expect(response).to redirect_to(return_with_path_path)
+    end
+    
+    it 'deletes the stored referer' do
+      @request.env['HTTP_REFERER'] = return_with_path_path
+      get :save
+      expect(session[:jump_back_stored_referer]).to eq(return_with_path_path)
+      put :return_with_options
       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
+    it 'redirects to default with no referer and no arguments' do
+      put :return_with_options
       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)
+    it 'redirects to argument with no referer' do
+      get :return_with_path
+      expect(response).to redirect_to(save_path)
     end
     
-    it 'should pass options to redirect_to with a default path specified' do
-      get :show, id: 1
+    it 'passes options to redirect_to with a path specified' do
+      get :return_with_path
       expect(flash[:alert]).to eq('Go away!')
       expect(response.status).to eq(301)
     end
     
-    it 'should pass options to redirect_to without a default path specified' do
-      put :update, id: 1
+    it 'passes options to redirect_to without a path specified' do
+      put :return_with_options
       expect(flash[:notice]).to eq('Updated!')
       expect(response.status).to eq(302)
     end

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

@@ -1,38 +1,38 @@
 class TestsController < ApplicationController
-  def index
+  def blank
   end
 
-  def show
-    return_to_referer new_test_path, alert: 'Go away!', status: 301
+  def return_with_path
+    return_to_referer save_path, alert: 'Go away!', status: 301
   end
 
-  def new
+  def save
     save_referer
   end
 
-  def create
+  def redirect_with_options
     redirect_back notice: 'Created!', status: :moved_permanently
   end
 
-  def edit
+  def clear_and_save
     clear_referer
     save_referer
   end
 
-  def update
+  def return_with_options
     return_to_referer notice: 'Updated!', status: 302
   end
 
-  def destroy
+  def clear_and_redirect
     clear_referer
-    redirect_back new_test_path
+    redirect_back save_path
   end
   
-  def offsite_with_default
-    redirect_back new_test_path, offsite: true, alert: 'Offsite with default!'
+  def offsite_with_path
+    redirect_back save_path, offsite: true, alert: 'Offsite with default!'
   end
   
-  def offsite_without_default
+  def offsite
     redirect_back offsite: true, alert: 'Offsite without default!'
   end
 end

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

@@ -0,0 +1,10 @@
+Blank Path
+<%= form_tag return_with_options_path, method: :put do %>
+  <%= submit_tag 'Put to return_with_options' %>
+<% end %>
+
+<%= link_to 'Go to save page', save_path %>
+
+<%= link_back clear_and_save_path %>
+
+<%= link_back 'A back link', save_path %>

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

@@ -0,0 +1,17 @@
+Clear and Save Path
+
+<%= link_to 'Go to save page', save_path %>
+
+<%= link_back 'Go back from whence you came!' %>
+
+<%= link_back class: 'red' %>
+
+<%= link_back 'Just a name!', id: 'just-name', remote: true %>
+
+<%= link_back save_path, method: :put %>
+
+<%= link_back 'All options!', save_path, id: 'all-options' %>
+
+<%= link_back 'http://localhost:3000/tests/clear_and_save', save_path %>
+
+<%= link_back 'Offsite okay!', offsite: true %>

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

@@ -0,0 +1,10 @@
+Save Path
+<%= form_tag redirect_with_options_path do %>
+  <%= submit_tag 'Post to redirect_with_options' %>
+<% end %>
+
+<%= link_to 'Go to edit page', clear_and_save_path %>
+
+<%= link_to 'Go to blank page', blank_path %>
+
+<%= link_back %>

data/spec/dummy/config/routes.rb

@@ -1,61 +1,13 @@
 Rails.application.routes.draw do
-  get 'tests/offsite_with_default' => 'tests#offsite_with_default', as: 'offsite_with_default'
-  get 'tests/offsite_without_default' => 'tests#offsite_without_default', as: 'offsite_without_default'
-  resources :tests
-
-  root 'tests#index'
-  # The priority is based upon order of creation: first created -> highest priority.
-  # See how all your routes lay out with "rake routes".
-
-  # You can have the root of your site routed with "root"
-  # root 'welcome#index'
-
-  # Example of regular route:
-  #   get 'products/:id' => 'catalog#view'
-
-  # Example of named route that can be invoked with purchase_url(id: product.id)
-  #   get 'products/:id/purchase' => 'catalog#purchase', as: :purchase
-
-  # Example resource route (maps HTTP verbs to controller actions automatically):
-  #   resources :products
-
-  # Example resource route with options:
-  #   resources :products do
-  #     member do
-  #       get 'short'
-  #       post 'toggle'
-  #     end
-  #
-  #     collection do
-  #       get 'sold'
-  #     end
-  #   end
-
-  # Example resource route with sub-resources:
-  #   resources :products do
-  #     resources :comments, :sales
-  #     resource :seller
-  #   end
-
-  # Example resource route with more complex sub-resources:
-  #   resources :products do
-  #     resources :comments
-  #     resources :sales do
-  #       get 'recent', on: :collection
-  #     end
-  #   end
-
-  # Example resource route with concerns:
-  #   concern :toggleable do
-  #     post 'toggle'
-  #   end
-  #   resources :posts, concerns: :toggleable
-  #   resources :photos, concerns: :toggleable
-
-  # Example resource route within a namespace:
-  #   namespace :admin do
-  #     # Directs /admin/products/* to Admin::ProductsController
-  #     # (app/controllers/admin/products_controller.rb)
-  #     resources :products
-  #   end
+  get 'tests/offsite_with_path' => 'tests#offsite_with_path', as: 'offsite_with_path'
+  get 'tests/offsite' => 'tests#offsite', as: 'offsite'
+  get 'tests/blank' => 'tests#blank', as: 'blank'
+  get 'tests/return_with_path' => 'tests#return_with_path', as: 'return_with_path'
+  get 'tests/save' => 'tests#save', as: 'save'
+  post 'tests/redirect_with_options' => 'tests#redirect_with_options', as: 'redirect_with_options'
+  get 'tests/clear_and_save' => 'tests#clear_and_save', as: 'clear_and_save'
+  put 'tests/return_with_options' => 'tests#return_with_options', as: 'return_with_options'
+  delete 'tests/clear_and_redirect' => 'tests#clear_and_redirect', as: 'clear_and_redirect'
+
+  root 'tests#blank'
 end