backtrail 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 21168de9bcbf086287dbd7d4a3569f2fccad0cc5
+  data.tar.gz: 7eb6730f974c9c9ba7e8485bcd965fc5d4995e48
+SHA512:
+  metadata.gz: e245f024438576b408bc587e271b9bfc37960c3cfeb14742eb07406b6efb1782d48e4c81174e187a0f460f77b4f86267314690137bb848fd735084dc89533e6d
+  data.tar.gz: b21c678aed7ff102f3700bc55683a61a1c06510b85b2c1d0285d843065a2830b0d29782d262fe440c2ffb254dc599d363a48c31adadb2188266269c8460414ce

data/.gitignore

@@ -0,0 +1,2 @@
+.ruby-version
+.ruby-gemset

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    backtrail (0.1.0)
+      railties (>= 4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (4.2.1)
+      actionview (= 4.2.1)
+      activesupport (= 4.2.1)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.1)
+    actionview (4.2.1)
+      activesupport (= 4.2.1)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.1)
+    activesupport (4.2.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    builder (3.2.2)
+    erubis (2.7.0)
+    i18n (0.7.0)
+    json (1.8.2)
+    loofah (2.0.1)
+      nokogiri (>= 1.5.9)
+    metaclass (0.0.4)
+    mini_portile (0.6.2)
+    minitest (5.6.0)
+    mocha (1.1.0)
+      metaclass (~> 0.0.1)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    rack (1.6.0)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.6)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.2)
+      loofah (~> 2.0)
+    railties (4.2.1)
+      actionpack (= 4.2.1)
+      activesupport (= 4.2.1)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.4.2)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  backtrail!
+  mocha

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Daniel Ferraz
+
+MIT License
+
+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,59 @@
+# Backtrail
+
+Keep a trail of request paths for your Rails application
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'backtrail'
+```
+
+And then execute:
+
+```
+$ bundle install
+```
+
+Or install it yourself as:
+
+```
+$ gem install backtrail
+```
+
+## Usage
+
+In your `ApplicationController` add:
+
+```ruby
+class ApplicationController < ActionController::Base
+  include Backtrail::BaseController
+end
+```
+
+With that, all your `get` and `non xhr` request paths will start to be keep tracked on a trail stack. To generate links that go back on the trail of paths, use the view helper `<%= backtrail %>`. This will generate a link like:
+
+```html
+<a class="backtrail" href="/[path]?trail=back">Back</a>
+```
+
+The `[path]` is the top path from the trail stack. It can be returned through the `previous_path` method (that is also a view helper) included with `Backtrail::BaseController`.
+
+## Contributing
+
+Questions or problems? Please post them on the [issue tracker](https://github.com/dferrazm/backtrail/issues).
+
+You can contribute by doing the following:
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+To test the application run `bundle install` and then `rake test`.
+
+## License
+
+MIT License.

data/Rakefile

@@ -0,0 +1,16 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end

data/backtrail.gemspec

@@ -0,0 +1,22 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+require "backtrail/version"
+
+Gem::Specification.new do |s|
+  s.name        = "backtrail"
+  s.version     = Backtrail::VERSION
+  s.authors     = ["Daniel Ferraz"]
+  s.email       = ["d.ferrazm@gmail.com"]
+  s.homepage    = "https://github.com/dferrazm/backtrail"
+  s.summary     = "Keep a trail of request paths for your Rails application"
+  s.description = "Keep a trail of request paths for your Rails application"
+  s.license     = "MIT"
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'railties', '>= 4.0'
+  s.add_development_dependency 'mocha'
+end

data/lib/backtrail.rb

@@ -0,0 +1,5 @@
+require 'backtrail/controllers'
+require 'backtrail/helpers'
+require 'backtrail/railtie' if defined?(Rails)
+
+module Backtrail;end

data/lib/backtrail/controllers.rb

@@ -0,0 +1,46 @@
+module Backtrail
+  module BaseController
+    extend ActiveSupport::Concern
+
+    included do
+      before_action :update_previous_paths
+      helper_method :previous_path
+    end
+
+    def previous_path
+      get_from_stack_path || backtrail_starting_point
+    end
+
+    protected
+
+    def update_previous_paths
+      current = request.url.split('?')[0]
+      if request.get? and !request.xhr?
+        if session['_referer'].present? and !params[:trail]
+          previous = session['_referer']
+          if session['previous_paths'].nil?
+            session['previous_paths'] = []
+          end
+          if session['previous_paths'].length == 5
+            session['previous_paths'].delete_at 0
+          end
+          if previous != current
+            session['previous_paths'].push previous
+          end
+        end
+        session['_referer'] = current
+      end
+    end
+
+    def get_from_stack_path
+      if params[:trail] == 'back'
+        session['previous_paths'].try(:pop)
+      end
+      session['previous_paths'].try(:last)
+    end
+
+    def backtrail_starting_point
+      root_path
+    end
+  end
+end

data/lib/backtrail/helpers.rb

@@ -0,0 +1,7 @@
+module Backtrail
+  module ViewHelpers
+    def backtrail
+      link_to 'Back', "#{previous_path}?trail=back", class: 'backtrail'
+    end
+  end
+end

data/lib/backtrail/railtie.rb

@@ -0,0 +1,7 @@
+module MyGem
+  class Railtie < Rails::Railtie
+    initializer "backtrail.view_helpers" do
+      ActionView::Base.send :include, Backtrail::ViewHelpers
+    end
+  end
+end

data/lib/backtrail/version.rb

@@ -0,0 +1,3 @@
+module Backtrail
+  VERSION = "0.1.0"
+end

data/test/controllers_test.rb

@@ -0,0 +1,135 @@
+require 'test_helper'
+require 'action_controller'
+require 'backtrail/controllers'
+
+class FooController < ActionController::Base
+  include Backtrail::BaseController
+end
+
+class ControllersTest < ActionController::TestCase
+
+  # returns the default path when the paths's stack is nil
+  def test_previous_path_when_stack_is_nil
+    controller = new_controller
+    assert_equal '/root_path', controller.previous_path
+  end
+
+  # returns the root path when the paths's stack is empty
+  def test_previous_path_when_stack_is_empty
+    controller = new_controller previous_paths: []
+    assert_equal '/root_path', controller.previous_path
+  end
+
+  # holds only the last 5 requests paths
+  def test_update_previous_paths_max_storage
+    controller = new_controller
+
+    paths = (1..7).map { |i| "/path#{i}" }
+    trail controller, paths
+
+    assert_equal 5, controller.session['previous_paths'].length
+  end
+
+  # does not save the previous path when referrer equals to the current
+  def test_when_referrer_equals_to_current
+    controller = new_controller
+    fake_request controller, "/same_path", "/same_path"
+    assert_equal 0, controller.session['previous_paths'].length
+  end
+
+  # returns the top path from the stack when going forward
+  def test_when_going_forward
+    controller = new_controller
+    trail controller, ['/path1', '/path2']
+
+    assert_equal '/path1', controller.previous_path
+    assert_equal 1, controller.session['previous_paths'].length
+  end
+
+  # pops the top path and returns the former when going back
+  def test_when_going_backwards
+    controller = new_controller
+    trail controller, ['/path1', '/path2', '/path3']
+    go_back controller, '/path2'
+
+    assert_equal '/path1', controller.previous_path
+    assert_equal 1, controller.session['previous_paths'].length
+  end
+
+  # does not save the path on non GET requests
+  def test_on_non_get_requests
+    controller = new_controller
+    fake_request controller, '/path1', '/referrer', get?: false
+    assert_equal nil, controller.session['previous_paths']
+  end
+
+  # does not save the path when on async request
+  def test_on_async_requests
+    controller = new_controller
+    fake_request controller, '/path1', '/referrer', xhr?: true
+    assert_equal nil, controller.session['previous_paths']
+  end
+
+  # does not save the path when there's no referer
+  def test_on_non_referrer_requests
+    controller = new_controller
+    fake_request controller, '/path1', nil
+    assert_equal nil, controller.session['previous_paths']
+  end
+
+  # does not save the path when going back
+  def test_on_back_requests
+    controller = new_controller
+    go_back controller, '/path1'
+    assert_equal nil, controller.session['previous_paths']
+  end
+
+  # does not save the referer on async request
+  def test_referrer_on_async_requests
+    controller = new_controller
+    fake_request controller, '/path1', nil, xhr?: true
+    assert_equal nil, controller.session['_referer']
+  end
+
+  # does not save the referer on non GET method
+  def test_referrer_on_non_get_requests
+    controller = new_controller
+    fake_request controller, '/path1', nil, get?: false
+    assert_equal nil, controller.session['_referer']
+  end
+
+  private
+
+  def new_controller(params = {})
+    controller = FooController.new
+    controller.stubs(:params).returns Hash.new
+    controller.stubs(:session).returns({'previous_paths' => params[:previous_paths]})
+    controller.stubs(:root_path).returns '/root_path'
+    request = mock 'object'
+    controller.stubs(:request).returns request
+
+    controller
+  end
+
+  def trail(controller, path_trail)
+    referrer = nil
+
+    path_trail.each do |path|
+      fake_request controller, path, referrer
+      referrer = path
+    end
+  end
+
+  def fake_request(controller, path, referrer, options = {})
+    controller.request.stubs(:get?).returns(options[:get?].nil? ? true : options[:get?])
+    controller.request.stubs(:xhr?).returns(options[:xhr?] || false)
+    controller.request.stubs(:url).returns path
+    controller.session['_referer'] = referrer
+    controller.send :update_previous_paths
+  end
+
+  def go_back(controller, path)
+    controller.params[:trail] = 'back'
+    trail controller, [path]
+  end
+end

data/test/helpers_test.rb

@@ -0,0 +1,12 @@
+require 'test_helper'
+require 'action_view/test_case'
+require 'backtrail/helpers'
+
+class HelpersTest < ActionView::TestCase
+  include Backtrail::ViewHelpers
+
+  def test_backtrail_link
+    self.stubs(:previous_path).returns '/previous'
+    assert_equal '<a class="backtrail" href="/previous?trail=back">Back</a>', backtrail
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,17 @@
+require 'bundler/setup'
+require 'active_support'
+require 'minitest'
+require 'minitest/autorun'
+require 'minitest/unit'
+require 'mocha/mini_test'
+
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+
+Minitest::Test = Minitest::Unit::TestCase unless defined?(Minitest::Test)
+
+# Filter out Minitest backtrace while allowing backtrace  from other libraries
+# to be shown.
+Minitest.backtrace_filter = Minitest::BacktraceFilter.new
+
+ActiveSupport::TestCase.test_order = :random

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: backtrail
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Ferraz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  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'
+description: Keep a trail of request paths for your Rails application
+email:
+- d.ferrazm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- backtrail.gemspec
+- lib/backtrail.rb
+- lib/backtrail/controllers.rb
+- lib/backtrail/helpers.rb
+- lib/backtrail/railtie.rb
+- lib/backtrail/version.rb
+- test/controllers_test.rb
+- test/helpers_test.rb
+- test/test_helper.rb
+homepage: https://github.com/dferrazm/backtrail
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Keep a trail of request paths for your Rails application
+test_files:
+- test/controllers_test.rb
+- test/helpers_test.rb
+- test/test_helper.rb