backtrack 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Scott Tadman, The Working Group Inc.
+
+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.rdoc

@@ -0,0 +1,23 @@
+= backtrack
+
+Backtrack is a "back" tracking system for Rails that allows to to save
+and restore the back-out state of forms.
+
+Add backtracking to your forms with the backtrack_fields method:
+
+    <%= backtrack_fields %>
+    
+Add a link to a page that goes to the previous entry in the backtracking
+table:
+
+    <%= link_to('Back', backtrack_url) %>
+
+Create a link that captures the backtracking state:
+
+    <%= link_to('Forward', some_path(backtrack_params)) %>
+    <%= link_to('Forward', some_path(backtrack_params(:other_id => other_id))) %>
+    
+== Copyright
+
+Copyright (c) 2012 Scott Tadman, The Working Group Inc. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'rake'
+require 'jeweler'
+
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "backtrack"
+  gem.homepage = "http://github.com/twg/backtrack"
+  gem.license = "MIT"
+  gem.summary = %Q{Form Link Backtrack Tracking for Ruby on Rails}
+  gem.description = %Q{Makes it easier to provide a 'Cancel' or 'Back' link on web forms in Ruby on Rails}
+  gem.email = "github@tadman.ca"
+  gem.authors = [ "Scott Tadman" ]
+  # dependencies defined in Gemfile
+end
+
+Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/backtrack.gemspec

@@ -0,0 +1,49 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "backtrack"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Scott Tadman"]
+  s.date = "2012-01-23"
+  s.description = "Makes it easier to provide a 'Cancel' or 'Back' link on web forms in Ruby on Rails"
+  s.email = "github@tadman.ca"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "backtrack.gemspec",
+    "lib/backtrack.rb",
+    "lib/backtrack/extensions.rb",
+    "lib/backtrack/extensions/action_controller.rb",
+    "lib/backtrack/extensions/action_view.rb",
+    "rails/init.rb",
+    "test/helper.rb",
+    "test/test_backula.rb"
+  ]
+  s.homepage = "http://github.com/twg/backtrack"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.11"
+  s.summary = "Form Link Backtrack Tracking for Ruby on Rails"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/backtrack.rb

@@ -0,0 +1,33 @@
+module Backtrack
+  # == Submodules ===========================================================
+  
+  autoload(:Extensions, 'backtrack/extensions')
+  
+  # == Constants ============================================================
+  
+  BACKTRACK_PARAM = :_back
+  
+  # == Module Methods =======================================================
+  
+  def self.install!
+    ActionController::Base.send(:include, Backtrack::Extensions::ActionController)
+
+    ActionView::Base.send(:include, Backtrack::Extensions::ActionView)
+  end
+  
+  def self.backtrack_param
+    @backtrack_param ||= BACKTRACK_PARAM
+  end
+  
+  def self.backtrack_param=(value)
+    @backtrack_param = value
+  end
+  
+  def self.default_path
+    @default_path
+  end
+
+  def self.default_path=(value)
+    @default_path = value
+  end
+end

data/lib/backtrack/extensions.rb

@@ -0,0 +1,4 @@
+module Backtrack::Extensions
+  autoload(:ActionController, 'backtrack/extensions/action_controller')
+  autoload(:ActionView, 'backtrack/extensions/action_view')
+end

data/lib/backtrack/extensions/action_controller.rb

@@ -0,0 +1,31 @@
+module Backtrack::Extensions::ActionController
+  def self.included(base)
+    base.send(:helper_method, :backtrack_params)
+    base.send(:helper_method, :backtrack_path)
+    base.send(:helper_method, :backtrack_stack)
+  end
+  
+  def backtrack_stack
+    [
+      request.request_uri,
+      (
+        params[Backtrack.backtrack_param] or
+          request.referrer or
+          Backtrack.default_path or
+          root_path
+      )
+    ].flatten
+  end
+  
+  def backtrack_path
+    self.backtrack_stack[1]
+  end
+
+  def backtrack_params(params = nil)
+    _params = {
+      Backtrack.backtrack_param => backtrack_path
+    }
+  
+    params ? _params.merge(params) : _params
+  end
+end

data/lib/backtrack/extensions/action_view.rb

@@ -0,0 +1,7 @@
+module Backtrack::Extensions::ActionView
+  def backtrack_fields
+    self.backtrack_stack.collect do |backtrack_path|
+      hidden_field_tag("#{Backtrack.backtrack_param}[]", backtrack_path)
+    end.join('')
+  end
+end

data/rails/init.rb

@@ -0,0 +1,3 @@
+require 'backtrack'
+
+Backtrack.install!

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'backula'
+
+class Test::Unit::TestCase
+end

data/test/test_backula.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestBackula < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: backtrack
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Scott Tadman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-23 00:00:00.000000000 Z
+dependencies: []
+description: Makes it easier to provide a 'Cancel' or 'Back' link on web forms in
+  Ruby on Rails
+email: github@tadman.ca
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- backtrack.gemspec
+- lib/backtrack.rb
+- lib/backtrack/extensions.rb
+- lib/backtrack/extensions/action_controller.rb
+- lib/backtrack/extensions/action_view.rb
+- rails/init.rb
+- test/helper.rb
+- test/test_backula.rb
+homepage: http://github.com/twg/backtrack
+licenses:
+- MIT
+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.11
+signing_key: 
+specification_version: 3
+summary: Form Link Backtrack Tracking for Ruby on Rails
+test_files: []