redirectr 0.1.0 → 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2d2e5bda91ce0407fb196a450cf6adf0fc33aba2
+  data.tar.gz: bc3a10bed54b7ff7a3804d2894de0c8cb64d3a2d
+SHA512:
+  metadata.gz: 3f6eba38b0be27a841e24ed82381723befad33f545cd6ac603f8da33e91d582afb7b4d826a7e65032d6f48113cc2c8ddd7c77bb8adab01c24e62694f05b3cbca
+  data.tar.gz: 9bc23622bb0a245bff831d0c7323149e91da3c44c011d8209cf22a90b9c0ae1c9d07d84ad011492bb6a5631423c3aa399be8763fceb2abebc1b745a4066275df

data/README

@@ -1,4 +1,4 @@
-# Redirectr
+h1. Redirectr
 
 In many web applications, the user triggers actions that result in simple or complex workflows that should, after that workflow is finished, result in the user being redirected to the page where he initially started it. Another example would be a "back"-Link on any page.
 A simple but completely Un-RESTful way would be to store the "current" page in a cookie each time the user calls an action and redirect to the url stored there if needed.
@@ -9,27 +9,29 @@ Redirectr really does nothing more than provide a simple API for exactly that.
 
 Redirectr provides a few Controller and Helper methods that will be included in your ApplicationController and ApplicationHelper, respectively.
 
-## Installation
+h2. Installation
 
-With Rails 3, just at the following to your Gemfile
+when Using bundler, just at the following to your Gemfile
 
-    gem 'redirectr', :git => 'https://github.com/wvk/redirectr.git'
+    gem 'redirectr'
 
 and then call
 
     bundle install
 
-## Example
+h2. Examples
+
+h3. Contact Form
 
 Suppose you have an application with a contact form that can be reached via a footer link on every page. After submitting the form, the user should be redirected to the page he was before clicking on the "contact form" link.
 
 for the footer link to the contact form:
 
-    <%= link_to 'Contact us!', new_contact_path(referrer_param => current_path) %>
+    <%= link_to 'Contact us!', new_contact_path(referrer_param => current_url) %>
 
 In the 'new contact' view:
 
-    <%= form for ... do |f| %>
+    <%= form_for ... do |f| %>
       <%= hidden_referrer_input_tag %>
       <!-- ... -->
     <% end %>
@@ -41,11 +43,42 @@ and finally, in the 'create' action of your ContactsController:
       redirect_to back_or_default
     end
 
-for more detailled examples, see the Rdoc documentation.
+h3. Custom default_url
+
+The above will redirect the user back to the page specified in the referrer param. However, if you want to provide a custom fallback url per controller in case no referrer param is provided, just define the `#default_url` in your controller:
+
+    class MyController < ApplicationController
+      def default_url
+        if @record
+          my_record_path(@record)
+        else
+          my_record_index_path
+        end
+      end
+    end
+
+h3. Nesting referrers
+
+Referrer params can be nested, which is helpful if your workflow involves branching into subworkflows. Thus, it is always possible to pass the referrer_param to another url:
+
+    <%= link_to 'go back directly', referrer_or_current_url %>
+    <%= link_to 'add new Foobar before going back', new_foobar_url(:foobar =>  {:name => 'My Foo'}, referrer_param => referrer_or_current_url) %>
+
+for more detailed examples, see the Rdoc documentation.
+
+h2. Contributions
+
+Contributions like bugfixes and new ideas are more than welcome. Please just fork this project on github (https://github.com/wvk/redirectr) and send me a pull request with your changes.
+
+Thanks so far to:
 
+* Falk Hoppe for Rails 2.3.x interoperability
+* Dimitar Haralanov for Rails 3.0.x interoperability
+* Raffael Schmid for spotting a typo in the gemspec description ;)
 
 ## Changelog
 
+0.1.1: deprecate *_path methods; improve Rails 5 compatibility by removing `alias` in view helpers
 0.1.0: Use absolute URI instead of path in current_path method
 0.0.8: Use ActiveSupport::Concern (Thanks to Dimitar Haralanov)
 0.0.7: Add Rails 3.0 compatibility (Thanks to Falk Hoppe)

data/lib/redirectr.rb

@@ -1,3 +1,4 @@
+
 module Redirectr
   REFERRER_PARAM_NAME = :referrer
 
@@ -5,10 +6,10 @@ module Redirectr
     extend ActiveSupport::Concern
 
     included do
-      helper_method :current_path,
-                    :referrer_or_current_path,
+      helper_method :current_path, :current_url,
+                    :referrer_or_current_path, :referrer_or_current_url,
                     :back_or_default,
-                    :referrer_path,
+                    :referrer_path, :referrer_url,
                     :referrer_param
     end
 
@@ -39,7 +40,7 @@ module Redirectr
       Redirectr::REFERRER_PARAM_NAME
     end
 
-    # Return the complete uri of the current request.
+    # Return the complete URL of the current request.
     # Note that this path does include ALL query parameters and the host name,
     # thus allowing you to navigate back and forth between different hosts. If you
     # want the pre-0.1.0 behaviour back, just overwrite this method
@@ -48,9 +49,20 @@ module Redirectr
     #
     #  <%= link_to my_messages_path referrer_param => current_path %>
     #
-    def current_path
+    def current_url
 #       request.env['PATH_INFO'] # old behaviour
-      request.env['REQUEST_URI']
+      if request.respond_to? :url # for rack >= 2.0.0
+        request.url
+      elsif request.respond_to? :original_url # for rails >= 4.0.0
+        request.original_url
+      else
+        request.env['REQUEST_URI']
+      end
+    end
+
+    # deprecated
+    def current_path
+      current_url
     end
 
     # Return the referrer or the current path, it the former is not set.
@@ -61,15 +73,20 @@ module Redirectr
     #
     #  <%= link_to my_messages_path referrer_param => referrer_or_current_path %>
     #
+    def referrer_or_current_url
+      referrer_path.blank? ? current_url : referrer_url
+    end
+
+    # deprecated
     def referrer_or_current_path
-      referrer_path.blank? ? current_path : referrer_path
+      referrer_or_current_url
     end
 
     # Used in back links, referrer based redirection after actions etc.
     # Accepts a default redirect path in case no param[referrer_param]
     # is set, default being root_path.
     # To set an own default path (per controller), you can overwrite
-    # the default_path method (see below).
+    # the default_url method (see below).
     # Example:
     #
     #   class MyController
@@ -97,19 +114,29 @@ module Redirectr
       unless referrer_path.blank?
         referrer_path
       else
-        default || default_path
+        default || default_url
       end
     end
 
     # to be overwritten by your controllers
-    def default_path
+    def default_url
       root_path
     end
 
+    # deprecated
+    def default_path
+      default_url
+    end
+
     # Convenience method for params[referrer_param]
-    def referrer_path
+    def referrer_url
       params[referrer_param]
     end
+
+    # deprecated
+    def referrer_path
+      referrer_url
+    end
   end
 
   module Helpers
@@ -127,12 +154,11 @@ module Redirectr
     # Handy for use in forms that are called with a referrer param which
     # has to be passed on and respected by the form processing action.
     def hidden_referrer_input_tag(options = {})
-      hidden_field_tag :referrer, referrer_or_current_path, options
+      hidden_field_tag :referrer, referrer_or_current_url, options
     end
   end # module Helpers
 end # module Redirectr
 
-
 ActionController::Base.send :include, Redirectr::ControllerMethods
 ActionView::Helpers.send :include, Redirectr::Helpers
 ActionView::Base.send :include, Redirectr::Helpers

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redirectr
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 0.1.1
 platform: ruby
 authors:
 - Willem van Kerkhof
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-22 00:00:00.000000000 Z
+date: 2017-10-18 00:00:00.000000000 Z
 dependencies: []
 description: Provides Rails-helper methods for referrer-style backlinks and setting
   redirect URLs after form submission
@@ -19,31 +18,28 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README
-- init.rb
 - lib/redirectr.rb
 homepage: http://github.com/wvk/redirectr
 licenses: []
+metadata: {}
 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
+rubygems_version: 2.5.2.1
 signing_key: 
-specification_version: 3
-summary: Provides Rails-helper methods for referrer-style backlinks
+specification_version: 4
+summary: Provides Rails helper methods for referrer-style backlinks
 test_files: []
-has_rdoc: