backable 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 095956144db6fcc903c53b33120af7d25a464f09
+  data.tar.gz: ecabb07f23acf372edd21e54f156dec15ec1f46a
+SHA512:
+  metadata.gz: e2158b7575b17e601ced19a6002dd82458edf07b33f33bd541fbefd9ff575ef9b25688c3763879dbd7db089bc755aaffee2682dedaf1183ab37b5982583ecf14
+  data.tar.gz: f7cf05592fe9b33acb8fc8a5d4c2522bd36caa47d388b09372d2c83b69a02d9a9c47bb2bb16da2dbb407fb6e466aa1ae1cba48409e3d2f49eacd2df3f97e5b84

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Rick Blommers
+
+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,100 @@
+# Backable
+
+A little gem for supporting back history in your applicaton. 
+It uses a simple request-parameter 'back' with every back-path separated with a '|'.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'backable'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+
+## Usage
+
+To use this plugin. You can build up the backable stack via the controller method `backable_push`.
+To pass the history to the next page remember to use `backable_url_for` instead of `url_for`. 
+
+
+### controller
+
+
+```ruby
+class FooBarsController < ApplicationController
+
+  def index
+    backable_push([:foo_bars])			#< push the back-url. This can be a string url
+    ..
+  end
+
+  def update
+    @foo_bar = FooBar.find(params[:id])
+    if @foo_bar.update(params[:foo_bar])
+      redirect_to backable_back_path, notice: "Data is saved"
+    end
+  end
+
+end
+```
+
+Available controller methods:
+
+| Method              | description                         
+| ------------------- | ---
+| backable_push       | Pushes the given url to the stack
+| backable_url_for    | url_for replacement which includes the 'back' parameter
+| backable_back_path  | Returns the path to the previous page
+|                     | 
+| backable_param      | Returns the back parameter for the given stack (internal method)
+| backable_history    | Returns and array of the previous paths
+| backable_future     | Returns the future paths (pushed on the stack in this request)
+
+
+
+### views
+
+To make this all work you need to replace all links in your application (link_to) to `backable_link_to`
+
+```erb
+<%= backable_link_to( [:edit, @item]) %>
+```
+
+To use this with buttons etc.. there's also the `backable_url_for` method
+
+
+You can simple add a back-button via `backable_link_to_back`. This link goes back to previous page in the stack.
+
+```erb
+<%= backable_link_to_back %>
+```
+
+
+To remember your back-stack in forms you should use the `backable_form_item`
+
+```erb
+<%= backable_form_item %>
+```
+
+
+Available view-helper methods:
+
+| Method                | description                         
+| --------------------- | ---
+| backable_url_for      | url_for replacement which includes the 'back' parameter
+| backable_back_path    | Returns the path to the previous page
+| backable_form_item    | A hidden form element that includes the 'back' parameter 
+| backable_link_to      | link_to replacement which includes the 'back' parameter
+| backable_link_to_back | A link_to call to the previous page (including the text t(backable.back))
+|                       | 
+| backable_history      | Returns and array of the previous paths
+| backable_future       | Returns the future paths (pushed on the stack in this request)
+
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,18 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Backable'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+require 'bundler/gem_tasks'

data/lib/backable.rb

@@ -0,0 +1,6 @@
+require 'backable/railtie'
+require 'backable/controller_concern'
+require 'backable/view_helpers'
+
+module Backable
+end

data/lib/backable/controller_concern.rb

@@ -0,0 +1,64 @@
+module Backable
+  module ControllerConcern
+    
+    extend ActiveSupport::Concern
+
+    included do 
+      helper_method :backable_history
+      helper_method :backable_future
+      helper_method :backable_back_path
+      helper_method :backable_url_for
+    end
+
+
+    def backable_param( history=nil)
+      history ||= (backable_history + backable_future)
+      history.map{|bi| bi.to_s }.join("|")
+    end
+
+    
+    def backable_history
+      @backable_history ||= begin
+        (params[:back]||"").split('|').map do |v|
+          v
+        end
+      end
+    end
+    
+
+    def backable_future
+      @backable_future ||= []
+    end
+
+
+    def backable_back_path( fallback=nil )
+      back = backable_history.last
+      fallback = Rails.env.development? ? "http://watbenjedan.nl/" : :back
+      return fallback unless back
+      back_param = backable_param( backable_history[0..-2] ) 
+      back.index('?') ? "#{back}&back=#{CGI::escape(back_param)}" : "#{back}?back=#{CGI::escape(back_param)}"
+    end
+
+
+    def backable_push(path)
+      path = polymorphic_path(path) if !path.kind_of?( String )
+      backable_future << "#{path}"
+    end
+
+
+    def backable_url_for( link_options, extra_options = {} )
+      args = extra_options.merge( back: backable_param )
+
+      # support for strings
+      if link_options.kind_of?( String )
+        url = link_options 
+        url << ( link_options.index('?') ? '&' : '?' ) 
+        url << args.to_query
+        url
+      else
+        polymorphic_url( link_options, args )
+      end
+    end
+
+  end
+end

data/lib/backable/railtie.rb

@@ -0,0 +1,14 @@
+module Backable
+  class Railtie < Rails::Railtie
+
+    initializer "backable.controller_concerns" do
+      ActiveSupport.on_load( :action_controller ){ include Backable::ControllerConcern }
+    end
+
+    initializer "backable.view_helpers" do
+      ActiveSupport.on_load( :action_view ){ include Backable::ViewHelpers }
+    end
+
+  end
+end
+

data/lib/backable/version.rb

@@ -0,0 +1,3 @@
+module Backable
+  VERSION = '1.0.0'
+end

data/lib/backable/view_helpers.rb

@@ -0,0 +1,37 @@
+module Backable
+  module ViewHelpers
+
+    def backable_form_item
+      hidden_field_tag :back, backable_param
+    end
+
+
+    def backable_link_to(name = nil, options = nil, html_options = nil, &block)
+      if block_given?
+        link_to backable_url_for(name), options, &block
+      else
+        link_to name, backable_url_for(options), html_options
+      end
+    end
+
+
+    def backable_link_to_back( name = nil, html_options = nil, &block) 
+      if block_given?
+        arg1 = backable_back_path
+        arg2 = name
+      else       
+        if name.kind_of?(Hash) && !html_options
+          arg1 = t('backable.back') 
+          arg2 = backable_back_path
+          arg3 = name
+        else
+          arg1 = name
+          arg2 = backable_back_path
+          arg3 = html_options
+        end
+      end
+      link_to arg1, arg2, arg3, &block
+    end
+
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: backable
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Rick Blommers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+description: A rails gem for simplifying back-buttons
+email:
+- rick@blommersit.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/backable.rb
+- lib/backable/controller_concern.rb
+- lib/backable/railtie.rb
+- lib/backable/version.rb
+- lib/backable/view_helpers.rb
+homepage: https://github.com/gamecreature/backable
+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.1
+signing_key: 
+specification_version: 4
+summary: A rails gem for simplifying back-buttons
+test_files: []