backpedal 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e995e2ea1e00bd63532203a699a0e8d74c3d98cd9a123f96b181a75cd613f051
+  data.tar.gz: 75b3ad15fa35b45a4c72251f0e90e783e55f0f90e0f48130bf6a0cfe55cee16c
+SHA512:
+  metadata.gz: 4af6ffa5b4045b40227ebd4bf450dab6dfdf4daeca1ef587d6bdce1d50e83b21152aebd4d333a209af7fa78ccc319515a1464571341f31890061adab25f7b931
+  data.tar.gz: be39ba9506937c9c7e294986aedfcf47e9dd000d2a034e4bbf425e88258d4badf88cef5c852268935fb4084f854eaa3878f16c91e0465540f1b2499dc8821849

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in backpedal.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 greyoxide
+
+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,81 @@
+# Backpedal
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/backpedal`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+Give your users the ability to backpedal across any number of routes in your app.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'backpedal'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install backpedal
+
+## Usage
+
+Usage is simple:
+
+```ruby
+class ApplicationController < ActionController::Base
+  before_action :capture_path, if: :current_user
+end
+```
+
+This will append the referring path to the navigation stack used by Backpedal to create a back link.
+
+```erb
+<%# app/users/show.html.erb %>
+<%= back_link %>
+<h1>Users#show</h1>
+<p> Here is where your users would appear be if you had some </p>
+```
+
+Have a specific path in mind?  Try this:
+
+```erb
+<%# app/users/show.html.erb %>
+<%= back_link(users_path) %>
+<h1>Users#show</h1>
+<p> Here is where your users would appear be if you had some </p>
+```
+
+What if you want a specific controller action to wipe out the navigation stack and restart at the current action?  Then set a before_action filter to dissolve the navigation stack.
+
+```ruby
+class SomeController < ActionController::base
+  before_action :dissolve, only: [:index]
+end
+```
+This will dissolve the navigation stack and set the current controller action as the base or starting point
+
+
+
+Ok so wait, what if I have some controller actions I don't want appended to backpedal stack?  Check this out:
+
+```ruby
+#config/initializers/backpedal.rb
+Backpedal.configure do |config|
+  config.skipped_verbs = ['new', 'edit', 'destroy', 'suspend', 'resend_invitation', 'etc']
+end
+```
+
+If you add the initializer, it will overwrite the default skipped http verbs(new, edit, destroy).  So make sure you include those if you want to skip those controller actions.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/greyoxide/backpedal.
+
+## 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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/backpedal.gemspec

@@ -0,0 +1,36 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "backpedal/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "backpedal"
+  spec.version       = Backpedal::VERSION
+  spec.authors       = ["greyoxide"]
+  spec.email         = ["greyoxide@gmail.com"]
+
+  spec.summary       = %q{A Rails gem that gives your users a universal back link across multiple routes.}
+  spec.homepage      = "https://github.com/Greyoxide/backpedal"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = spec.homepage
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "backpedal"
+
+# 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/backpedal.rb

@@ -0,0 +1,9 @@
+require 'backpedal/version'
+require 'backpedal/builder'
+require 'backpedal/actions'
+require 'backpedal/back_link_helper'
+
+module Backpedal
+  ActionView::Base.send :include, BackLinkHelper
+  ActionController::Base.send :include, Actions
+end

data/lib/backpedal/actions.rb

@@ -0,0 +1,33 @@
+module Actions
+
+  extend ActiveSupport::Concern
+
+  def capture_path
+    session[:tree] = url_for(root_path) if session[:tree].blank?
+
+    tree = session[:tree].split(",")
+    previous_page = request.referer
+    current_page = request.original_url
+
+    if tree.last == current_page
+      # remove this page from the stack if the user was just here(clicked back link)
+      tree.pop
+      session[:tree] = tree.join(",")
+    elsif request.referer.present? and request.referer != tree.last and Backpedal.configuration.skipped_verbs.exclude? request.referer.split("/").last.split("?")[0]
+      tree << previous_page
+      session[:tree] = tree.join(",")
+    end
+  end
+
+  def dissolve
+    session[:tree] = request.original_url
+  end
+
+  def clear(path)
+    session[:tree] = url_for(root_path) if session[:tree].blank?
+    tree = session[:tree].split(",")
+
+    tree.delete_if { |x| x = path }
+    session[:tree] = tree.join(",")
+  end
+end

data/lib/backpedal/back_link_helper.rb

@@ -0,0 +1,17 @@
+module BackLinkHelper
+  def back_link(path = nil)
+    if path.present?
+      link_to path, class: "back_link" do
+        concat content_tag :i, "", class: "fas fa-chevron-left"
+        concat "Back"
+      end
+
+    elsif session[:tree].present?
+      last = session[:tree].split(",").last
+      link_to last, class: "back_link" do
+        concat content_tag :i, "", class: "fas fa-chevron-left"
+        concat "Back"
+      end
+    end
+  end
+end

data/lib/backpedal/builder.rb

@@ -0,0 +1,22 @@
+module Backpedal
+  class << self
+    attr_accessor :configuration
+
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+    end
+
+    def reset
+      self.configuration = Configuration.new
+    end
+  end
+end
+
+class Configuration
+  attr_accessor :skipped_verbs
+
+  def initialize
+    @skipped_verbs = ['new', 'edit', 'destroy']
+  end
+end

data/lib/backpedal/version.rb

@@ -0,0 +1,3 @@
+module Backpedal
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: backpedal
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- greyoxide
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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'
+description: 
+email:
+- greyoxide@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- backpedal.gemspec
+- bin/console
+- bin/setup
+- lib/backpedal.rb
+- lib/backpedal/actions.rb
+- lib/backpedal/back_link_helper.rb
+- lib/backpedal/builder.rb
+- lib/backpedal/version.rb
+homepage: https://github.com/Greyoxide/backpedal
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Greyoxide/backpedal
+  source_code_uri: https://github.com/Greyoxide/backpedal
+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.7.3
+signing_key: 
+specification_version: 4
+summary: A Rails gem that gives your users a universal back link across multiple routes.
+test_files: []