rails_source_path 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 59d12c6cde889b2cc180d0a0892bc5cb80fea2e6
+  data.tar.gz: 4e53fb325e25ec0a427b3a9595f98b7a470804d2
+SHA512:
+  metadata.gz: d9cd8f35d9a96c56285dd00be44292d72febdb2ad0c28aafb31e331769ad37359f298e5ce49aa1f4b053691f99696bbd7c2e7c41aa14a54b7744f34286faebcf
+  data.tar.gz: 9c86a1727d18127f8a5f5334e5c99196a35444ed16e6ee0b35c1d1e1c1f2ff159df5efc4b500e069a9365a2e3554b9b84d6026d5e7c5bd40d9034265191d9bb4

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.7
+before_install: gem install bundler -v 1.17.3

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rails_source_path.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Leo Li
+
+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.md

@@ -0,0 +1,67 @@
+# RailsSourcePath
+
+In rails project, one common scenario is:
+
+One form used to create or update an object can be routed from more than one page, when the object is created or updated, it should be redirected back to wherever it came from.
+
+Rails `redirect_back` doesn't work in this case because:
+- `redirect_back` in create/update action will go back to new/edit form.
+- usually the form is re-rendered if any error exists, which basically breaks the `redirect_back`.
+
+`rails-source-path` can hanlde this by explicily specifying the entry actions and remember the
+previous route in `session` store, hence can be used later in the whole controller. Also a helper
+method is providered so it can be used in view like `back` or `cancel` button.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_source_path'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_source_path
+
+## Usage
+```
+class YourController < ApplicationController
+  rails_source_path_entry_actions :new, :edit
+  ...
+
+  def create
+    if @object.create
+      redirect_to_source
+    else
+      ...
+    end
+  end
+
+  def update
+    if @object.save
+      redirect_to_source
+    else
+      ...
+    end
+  end
+end
+
+# in your view/partial
+link_to 'Cancel', rails_source_path, class: 'button'
+```
+
+Both `redirect_to_source` and `rails_source_path` accept an optional argument which is the path when there is no previous route remembered.
+
+```
+def rails_source_path(default_path = root_path)
+def redirect_to_source(default_path = root_path)
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rails_source_path"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rails_source_path/rails_source_path.rb

@@ -0,0 +1,37 @@
+module RailsSourcePath
+  extend ActiveSupport::Concern
+
+  included do
+    helper_method :rails_source_path
+  end
+
+  class_methods do
+    # Used in controller:
+    #   rails_source_path_entry_actions :new, :edit
+    def rails_source_path_entry_actions(*methods)
+      before_action :set_rails_source_path, only: methods.flatten
+    end
+  end
+
+  # rails_source_path is used in View like 'cancel/back' button
+  def rails_source_path(default_path = root_path)
+    session[:rails_source_path] || default_path
+  end
+
+  # used in controller when object is successfully created or updated
+  def redirect_to_source(default_path = root_path)
+    path = rails_source_path(default_path)
+    session.delete(:rails_source_path)
+    redirect_to path
+  end
+
+  private
+
+  def set_rails_source_path
+    session[:rails_source_path] = begin
+      URI(request.referer).request_uri
+    rescue
+      nil
+    end
+  end
+end

data/lib/rails_source_path/version.rb

@@ -0,0 +1,3 @@
+module RailsSourcePath
+  VERSION = "1.0.1"
+end

data/lib/rails_source_path.rb

@@ -0,0 +1,2 @@
+require "rails_source_path/version"
+require 'rails_source_path/rails_source_path'

data/rails_source_path.gemspec

@@ -0,0 +1,41 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rails_source_path/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_source_path"
+  spec.version       = RailsSourcePath::VERSION
+  spec.authors       = ["Leo Li"]
+  spec.email         = ["lxz.tty@gmail.com"]
+
+  spec.summary       = %q{Remember the route prior to the current controller and redirect/use later}
+  spec.description   = %q{In rails project, one common case is one form used to create or update
+    an object can be routed from more than one page, when the object is created or updated, it
+    should be redirected back to wherever it came from. Rails redirect_back doesn't work in this
+    case because: 1. redirect_back in create/update action will go back to new/edit form. 2.
+    usually the form is re-rendered if any error exists, which basically breaks the redirect_back.
+    rails-source-path can hanlde this by explicily specifying the entry actions and remember the
+    previous route in session store, hence can be used in the whole controller. Also a helper
+    method is providered so it can be used in view like 'back' or 'cancel' button.}
+  spec.homepage      = "https://github.com/xiuzhong/rails_source_path"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-rails"
+
+  spec.add_dependency "rails", '>= 4.0.2'
+  spec.add_dependency "activesupport", '>= 3.0'
+
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: rails_source_path
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Leo Li
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.2
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |-
+  In rails project, one common case is one form used to create or update
+      an object can be routed from more than one page, when the object is created or updated, it
+      should be redirected back to wherever it came from. Rails redirect_back doesn't work in this
+      case because: 1. redirect_back in create/update action will go back to new/edit form. 2.
+      usually the form is re-rendered if any error exists, which basically breaks the redirect_back.
+      rails-source-path can hanlde this by explicily specifying the entry actions and remember the
+      previous route in session store, hence can be used in the whole controller. Also a helper
+      method is providered so it can be used in view like 'back' or 'cancel' button.
+email:
+- lxz.tty@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rails_source_path.rb
+- lib/rails_source_path/rails_source_path.rb
+- lib/rails_source_path/version.rb
+- rails_source_path.gemspec
+homepage: https://github.com/xiuzhong/rails_source_path
+licenses:
+- MIT
+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.5.2.3
+signing_key: 
+specification_version: 4
+summary: Remember the route prior to the current controller and redirect/use later
+test_files: []