return_hook 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6e9d96e1f37fc671eab1f5cd8266e202a29f8336
+  data.tar.gz: 55a24fadbaa7eba3a8573190cb2359cdf60aa4cd
+SHA512:
+  metadata.gz: dc45b77024fca587e76715cef50d92fff547cda3ba85a771aea874cc87d79e73bf069a3b8c52b7377483ab1f967c534efdfa69c951a41342c99904b7dbdbba1f
+  data.tar.gz: caad7a4ffba9240e3a57fcd7756e9e70a6f394851d29e8864bbaa022719010652588bfdda4281d8395d0f69fe3abbb355af45ce528c424d8e61cb1178df37fbb

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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.markdown

@@ -0,0 +1,45 @@
+ReturnHook
+==========
+
+ReturnHook gives you some conveniences for hooking returns from controller redirects. It works by interacting with a url parameter 'return'  (`params[:return]`). By specifying this parameter, you are able to override the redirect in a controller action to return the user to the url of your choice.
+
+Convenience Methods
+-------------------
+
+### smart_redirect
+This method is a replacement for redirect_to in your controllers.  It takes the same parameters, but is aware of any pending return hooks.  If it detects `params[:return]`, then it will redirect to the url specified under `params[:return]`, instead of the one given to it in it's first parameter.
+
+##### Example:
+You have accessed a controller action with `?return=/your-url`.  At the end of your action you write:  `smart_redirect(users_path)`.  Because `?return=/your-url` is present in your calling url, it will redirect to `/your-url` instead of `users_path`.  Otherwise it will follow the same semantics of `redirect_to`.
+
+### url_for_return
+This method is available to both controllers and views.  It takes a url_for argument, and adds a return parameter equal to the present url.
+
+##### Example:
+You want to have the user go to a certain action, but once they have completed that flow, they will be redirect back to this page.
+
+### forward_return_hook
+This method is also available to both controllers and views.  You feed it a url, and if `params[:return]` is present, then it will automatically add the return parameter to the url specified.  It returns the url + the return hook.
+
+#### Form Helpers:
+The form helper is automatically overridden to forward the return hook to it's action parameter.  This works with all form builders.  (simple_form, formatastic, etc...).  So if you use the return hook in the url, and that page has a form in it, then that form will submit to it's action, and include the return hook in that url.  The controller action responsible for handling that action can then handle the form submission, and use `smart_redirect` to redirect to the return hook if specified.
+
+Responders, respond_with
+------------------------
+If you would like to have respond_with at the end of your controller methods, and use ReturnHook, then you can `include ReturnHook::Responder` in your own responder class.  This will override the redirect_to inside your responder to use `smart_redirect` for catching any return hooks.
+
+##### Example:
+
+###### lib/app_responder.rb
+```ruby
+  class AppResponder < ActionController::Responder
+    include ReturnHook::Responder
+  end
+```
+###### app/controllers/application_controller.rb
+```ruby
+  require 'app_responder'
+  class ApplicationController < ActionController::Base
+    self.responder = AppResponder
+    ...
+```

data/Rakefile

@@ -0,0 +1,27 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ReturnHook'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/return_hook/controller.rb

@@ -0,0 +1,43 @@
+module ReturnHook
+  module Controller
+    def self.included(base)
+      base.send :helper_method, :url_for_return, :forward_return_hook
+    end
+    def smart_redirect(options = {}, response_status = {})
+      if !((response_status.include?(:override_return) ||
+          (options.is_a?(Hash) && options.include?(:override_return))))
+        uri = params[:return]
+        if uri
+          redirect_to CGI.unescape(uri), response_status
+        elsif (options == :back)  && request.env['HTTP_REFERER'].blank?
+          redirect_to '/'
+        else
+          redirect_to options, response_status
+        end
+      elsif (options == :back)  && request.env['HTTP_REFERER'].blank?
+        redirect_to '/'
+      else
+        redirect_to options, response_status
+      end
+    end
+    def url_for_return(params)
+      escaped_url = CGI.escape request.url
+      if params.is_a? String
+        params = params.include?('?') ? params + '&return=' + escaped_url : params + '?return=' + CGI.escape(escaped_url)
+      elsif params.is_a? Hash
+        params[:return] = escaped_url
+      end
+      url_for params
+    end
+    def forward_return_hook(url)
+      if params[:return]
+        if url.is_a? String
+          url = url.include?('?') ? url + '&return=' + params[:return] : url + '?return=' + params[:return]
+        elsif url.is_a? Hash
+         url[:return] = params[:return]
+        end
+      end
+      url_for url
+    end
+  end
+end

data/lib/return_hook/form_tag_helper.rb

@@ -0,0 +1,32 @@
+module ReturnHook
+  module FormTagHelper
+    private
+    # This method overrides the rails built in form helper's action setting code
+    # to inject a return path
+    def html_options_for_form(url_for_options, options)
+      options.stringify_keys.tap do |html_options|
+        html_options["enctype"] = "multipart/form-data" if html_options.delete("multipart")
+        # The following URL is unescaped, this is just a hash of options, and it is the
+        # responsibility of the caller to escape all the values.
+
+        ## OVERRIDDEN HERE:
+        html_options["action"] = forward_return_hook(url_for(url_for_options))
+
+        html_options["accept-charset"] = "UTF-8"
+
+        html_options["data-remote"] = true if html_options.delete("remote")
+
+        if html_options["data-remote"] &&
+           !embed_authenticity_token_in_remote_forms &&
+           html_options["authenticity_token"].blank?
+          # The authenticity token is taken from the meta tag in this case
+          html_options["authenticity_token"] = false
+        elsif html_options["authenticity_token"] == true
+          # Include the default authenticity_token, which is only generated when its set to nil,
+          # but we needed the true value to override the default of no authenticity_token on data-remote.
+          html_options["authenticity_token"] = nil
+        end
+      end
+    end
+  end
+end

data/lib/return_hook/responder.rb

@@ -0,0 +1,12 @@
+module ReturnHook
+  module Responder
+    def redirect_to(options = {}, response_status = {})
+      if format == :html && !request.xhr?
+        # follow returns by using the smart method
+        controller.smart_redirect(options,response_status)
+      else
+        controller.redirect_to options,response_status
+      end
+    end
+  end
+end

data/lib/return_hook/version.rb

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

data/lib/return_hook.rb

@@ -0,0 +1,11 @@
+require 'return_hook/version'
+require 'return_hook/controller'
+require 'return_hook/form_tag_helper'
+require 'return_hook/responder'
+
+module ReturnHook
+
+end
+
+ActionController::Base.send :include, ReturnHook::Controller
+ActionController::Base.helper ReturnHook::FormTagHelper

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: return_hook
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nik Petersen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: adds some convenience helpers and methods for hooking the redirect in
+  a controller
+email:
+- demersus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/return_hook/controller.rb
+- lib/return_hook/responder.rb
+- lib/return_hook/version.rb
+- lib/return_hook/form_tag_helper.rb
+- lib/return_hook.rb
+- MIT-LICENSE
+- Rakefile
+- README.markdown
+homepage: https://github.com/demersus/return_hook
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: adds some convenience helpers and methods for hooking the redirect in a controller
+test_files: []