action-segue 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b90ce3d4469b84001c3943b782e42fd6cfdf1b95
+  data.tar.gz: e892a1627ab29669d3f66c7d1148d8a2dd7b38a7
+SHA512:
+  metadata.gz: 8efd253601337c233e0bb5a4cd94edf3c141f96567db1f9688eda0093784c58fd4209db6b3d8e4618f83b29dffac428c38ed0d64a12bfedb39d020ec9ceaa767
+  data.tar.gz: 384ba41ad591820698b6cd81bfcde02d76bd0b2165772ea14ac2c87a15f3fd317b93b645d4d7eda24f380086ac16f0e85dcb59b5adc383e6714a1c304c2dbb6f

data/.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

data/.gitignore

@@ -0,0 +1,3 @@
+.bundle/
+log/*.log
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format=documentation

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,97 @@
+PATH
+  remote: .
+  specs:
+    action-segue (0.0.1)
+      railties (>= 4.2.0, < 5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (4.2.4)
+      actionview (= 4.2.4)
+      activesupport (= 4.2.4)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.4)
+      activesupport (= 4.2.4)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activesupport (4.2.4)
+      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)
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    i18n (0.7.0)
+    json (1.8.3)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    method_source (0.8.2)
+    mini_portile (0.6.2)
+    minitest (5.8.0)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.6.4)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.7)
+      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.4)
+      actionpack (= 4.2.4)
+      activesupport (= 4.2.4)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.4.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-rails (3.3.3)
+      actionpack (>= 3.0, < 4.3)
+      activesupport (>= 3.0, < 4.3)
+      railties (>= 3.0, < 4.3)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    slop (3.6.0)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  action-segue!
+  pry (~> 0.10)
+  rspec (~> 3.3)
+  rspec-rails (~> 3.3)

data/README.md

@@ -0,0 +1,37 @@
+# ActionSegue
+
+Allows you to create simple flows between controllers and actions which you can then complete or resume.
+
+To begin with, you can register the beginning of a segue in a controller:
+
+```ruby
+class MyController < ApplicationController
+  register_segue action: :index, as: :looking_at_index
+
+  def index
+    ...
+  end
+end
+```
+
+Then, at any point in the future, you can return to this segue start point. You must also pass in a fallback location which is used in the event no segue with the id is in progress.
+
+```ruby
+complete_segue_with_redirect :looking_at_index, or_redirect_to: dashboard_path
+```
+
+If you just want to clear a segue to remove it from the stack, you can use `clear_segue`:
+
+```ruby
+clear_segue :looking_at_index
+```
+
+If you don't know (or care) what current segue is in progress (useful in situations where many actions could lead away from their flow, and you just want to return to the original flow), you can just complete the current segue. This also requires a fallback location in case there is no current segue in progress.
+
+```ruby
+complete_current_segue_with_redirect or_redirect_to: dashboard_path
+```
+
+## TODO
+
+* Make it possible to use something other than the session to store segue info

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = ['--format progress']
+end
+
+task :default => :spec

data/action-segue.gemspec

@@ -0,0 +1,23 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "action-segue"
+  s.version     = "1.0.0"
+  s.authors     = ["Damien Timewell"]
+  s.email       = ["mail@damientimewell.com"]
+  s.licenses    = ['MIT']
+  s.homepage    = "https://github.com/iZettle/action-segue"
+  s.summary     = "Control Rails redirect flows with smarter redirect logic"
+  s.description = ""
+
+  s.add_dependency "railties", ">= 4.2.0", "< 5"
+
+  s.add_development_dependency "rspec", '~> 3.3'
+  s.add_development_dependency "rspec-rails", '~> 3.3'
+  s.add_development_dependency "pry", '~> 0.10'
+
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- spec/*`.split("\n")
+
+  s.require_paths = ["lib"]
+end

data/lib/action-segue.rb

@@ -0,0 +1,19 @@
+require 'action_controller'
+require 'rails/railtie'
+
+module ActionSegue
+  autoload :Segue, 'action_segue/segue'
+  autoload :SegueRegistration, 'action_segue/segue_registration'
+
+  def self.load_action_segue
+    ActiveSupport.on_load(:action_controller) do
+      include ActionSegue::SegueRegistration
+    end
+  end
+
+  class Railtie < Rails::Railtie
+    initializer "action-segue" do
+      ActionSegue.load_action_segue
+    end
+  end
+end

data/lib/action_segue/segue.rb

@@ -0,0 +1,10 @@
+module ActionSegue
+  class Segue
+    attr_accessor :id, :params
+
+    def initialize(id:, params:)
+      @id = id
+      @params = params
+    end
+  end
+end

data/lib/action_segue/segue_registration.rb

@@ -0,0 +1,40 @@
+module ActionSegue
+  module SegueRegistration
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def register_segue(action:, as:)
+        before_action only: action do
+          session[:action_segues] ||= ActiveSupport::OrderedHash.new
+          Rails.logger.debug "[ActionSegue] registering new segue as '#{as}' with params: #{params}"
+          session[:action_segues][as] = Segue.new(id: as, params: params)
+        end
+      end
+    end
+
+    # Completes the segue named ++id++ and redirects back to the start point, or
+    # fallback url.
+    def complete_segue_with_redirect(id, or_redirect_to:)
+      if segue = session[:action_segues].delete(id)
+        Rails.logger.debug "[ActionSegue] completed '#{id}'. Redirecting to #{or_redirect_to}"
+        redirect_to url_for(segue.params)
+      else
+        Rails.logger.debug "[ActionSegue] no segue matched '#{id}'. Redirecting to #{or_redirect_to}"
+        redirect_to or_redirect_to
+      end
+    end
+
+    # Remove a segue from the stack
+    def clear_segue(id)
+      Rails.logger.debug "[ActionSegue] clearing segue '#{id}'"
+      session[:action_segues].delete(id)
+    end
+
+    # Completes the last segue, regardless of what it was, or redirects to the fallback
+    # if no segues are in progress.
+    def complete_current_segue_with_redirect(or_redirect_to:)
+      complete_segue_with_redirect session[:action_segues].keys.last, or_redirect_to: or_redirect_to
+    end
+
+  end
+end

data/spec/action_segue/integration_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe NamedSeguesController, type: :controller do
+
+  after(:each) do
+    session[:action_segues] = nil
+  end
+
+  it "should store the segue on the first page" do
+    get :segue_start_page
+    expect(session[:action_segues][:named_segue].params).to eq({ "controller" => "named_segues", "action" => "segue_start_page" })
+  end
+
+  it "should redirect to the segue entry point" do
+    get :segue_start_page
+    get :normal_page
+    get :segue_complete_page
+    expect(response).to redirect_to(segue_start_page_named_segue_path)
+  end
+
+  it "should remove the segue from the stack after it is completed" do
+    get :segue_start_page
+    get :normal_page
+    get :segue_complete_page
+    expect(session[:action_segues]).to eq({})
+  end
+
+  it "should be possible to remove the segue" do
+    get :segue_start_page
+    get :segue_clear_page
+    get :segue_complete_page
+    expect(response).to redirect_to(normal_page_named_segue_path)
+  end
+
+end

data/spec/fixtures/controllers.rb

@@ -0,0 +1,23 @@
+class NamedSeguesController < ActionController::Base
+  include Rails.application.routes.url_helpers
+
+  register_segue action: :segue_start_page, as: :named_segue
+
+  def segue_start_page
+    render text: "Start page"
+  end
+
+  def normal_page
+    render text: "Normal page"
+  end
+
+  def segue_complete_page
+    complete_segue_with_redirect :named_segue, or_redirect_to: { action: :normal_page }
+  end
+
+  def segue_clear_page
+    clear_segue :named_segue
+    render text: "Clear page"
+  end
+
+end

data/spec/fixtures/fake_application.rb

@@ -0,0 +1,20 @@
+module Rails
+  class App
+    def env_config; {} end
+    def routes
+      return @routes if defined?(@routes)
+      @routes = ActionDispatch::Routing::RouteSet.new
+      @routes.draw do
+        resource :named_segue, only: [] do
+          collection do
+            get :segue_start_page, :normal_page, :segue_complete_page, :segue_clear_page
+          end
+        end
+      end
+      @routes
+    end
+  end
+  def self.application
+    @app ||= App.new
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require "pry"
+require "rails/all"
+require "action-segue"
+
+ActionSegue.load_action_segue
+
+require "rspec/rails"
+require "fixtures/fake_application"
+require "fixtures/controllers"
+
+Rails.logger = Logger.new(STDOUT)
+Rails.logger.level = Logger::ERROR

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: action-segue
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Damien Timewell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: ''
+email:
+- mail@damientimewell.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- action-segue.gemspec
+- lib/action-segue.rb
+- lib/action_segue/segue.rb
+- lib/action_segue/segue_registration.rb
+- spec/action_segue/integration_spec.rb
+- spec/fixtures/controllers.rb
+- spec/fixtures/fake_application.rb
+- spec/spec_helper.rb
+homepage: https://github.com/iZettle/action-segue
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Control Rails redirect flows with smarter redirect logic
+test_files:
+- spec/action_segue/integration_spec.rb
+- spec/fixtures/controllers.rb
+- spec/fixtures/fake_application.rb
+- spec/spec_helper.rb