simple_workflow 1.3.2 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df30a1c9f24abcc2eed8341f903f43dc726dfa0c
-  data.tar.gz: 7a67d053ee88dcb7860b3b3bc0046b633610913c
+  metadata.gz: e1e29715cba13f98137c9b007e1adfe1a19cebfa
+  data.tar.gz: 03c8dd09e5f4de89fdb82d8a5e8e0ef3b5e57c5c
 SHA512:
-  metadata.gz: 31b7fde7ad4ae7b569b85b4b625621cb10e7f5878c0d27311c3fb2f79afa78e9b1f21c8c091197be3090e79848e45daa527b02f076d194bf808de51898badd50
-  data.tar.gz: 1d33d84a1ad300aeca822ca9f821362ed896f0c37505de24e3ea34589f816911b834b936a90bd88257596a4516ae4d702ee6df5d25547383deee2bb9828429d0
+  metadata.gz: e0c307cd9aa2798cf1e623546e7713d4b7ac3decc285a9948884ef0b7216ad72f77226e48edb95874e84e2cedeae26f1f1f7ff23b2c74d3e7e2e26e3f67c44c3
+  data.tar.gz: 45f5b80db062ec965d57703ea28eb544fecdbd234b083a4bdc2e9071818351421514952a1285fd4d92bf6b24f7bc8c231640d5507a953d066b290ca56205c4a9

data/Gemfile.lock

@@ -104,7 +104,7 @@ GEM
       thor (>= 0.18.1, < 2.0)
     rainbow (2.2.1)
     rake (12.0.0)
-    rubocop (0.47.1)
+    rubocop (0.48.1)
       parser (>= 2.3.3.1, < 3.0)
       powerpack (~> 0.1)
       rainbow (>= 1.99.1, < 3.0)

data/README.md

@@ -45,7 +45,7 @@ In your tests:
 ## REQUIREMENTS
 
 * Ruby 2.1 or newer.  JRuby supported!
-* Rails 4.x
+* Rails 4.x or newer.
 
 ## INSTALL
 

data/lib/simple_workflow.rb

@@ -1,4 +1,5 @@
-unless $LOAD_PATH.include?(File.dirname(__FILE__)) || $LOAD_PATH.include?(File.expand_path(File.dirname(__FILE__)))
+unless $LOAD_PATH.include?(File.dirname(__FILE__)) ||
+       $LOAD_PATH.include?(File.expand_path(File.dirname(__FILE__)))
   $LOAD_PATH.unshift(File.dirname(__FILE__))
 end
 
@@ -11,15 +12,18 @@ require 'simple_workflow/test_helper'
 require 'simple_workflow/middleware'
 require 'simple_workflow/railtie'
 
+# Make workflow test utility methods available in views
 module ApplicationHelper
   include SimpleWorkflow::Helper
 end
 
+# Make workflow test utility methods available in controllers
 class ActionController::Base
   include SimpleWorkflow::Helper
   include SimpleWorkflow::Controller
 end
 
+# Make workflow test utility methods available in ActiveSupport test cases
 class ActiveSupport::TestCase
   include SimpleWorkflow::TestHelper
 end

data/lib/simple_workflow/controller.rb

@@ -1,9 +1,11 @@
 require 'simple_workflow/detour'
 
+# Mixin to add controller methods for workflow navigation.
 module SimpleWorkflow::Controller
   include SimpleWorkflow::Detour
 
-  # Like ActionController::Base#redirect_to, but stores the location we come from, enabling returning here later.
+  # Like ActionController::Base#redirect_to, but stores the location we come from, enabling
+  # returning here later.
   def detour_to(options)
     store_detour(params)
     redirect_to(options)

data/lib/simple_workflow/detour.rb

@@ -1,3 +1,4 @@
+# Utility methods to manage the breadcrumb history
 module SimpleWorkflow::Detour
   def store_detour_in_session(session, options)
     if session[:detours] && session[:detours].last == options
@@ -6,7 +7,8 @@ module SimpleWorkflow::Detour
     end
     session[:detours] ||= []
     session[:detours] << options
-    Rails.logger.try(:debug, "Added detour (#{session[:detours].try(:size) || 0}): #{options.inspect}")
+    Rails.logger
+         .try(:debug, "Added detour (#{session[:detours].try(:size) || 0}): #{options.inspect}")
   end
 
   def pop_detour(session)

data/lib/simple_workflow/helper.rb

@@ -1,11 +1,15 @@
 require_relative 'detour'
+
+# View helper methods augmented with breadcrumb management.
 module SimpleWorkflow::Helper
   include SimpleWorkflow::Detour
 
   def image_button_to(image_source, title, options, html_options = {})
-    image_submit_tag image_source, { class: 'image-submit', alt: title, title: title,
-                                     id: "#{title}_#{options[:id]}", name: title,
-                                     onclick: "form.action='#{url_for(options)}'" }.update(html_options)
+    image_submit_tag image_source, {
+      class: 'image-submit', alt: title, title: title,
+      id: "#{title}_#{options[:id]}", name: title,
+      onclick: "form.action='#{url_for(options)}'"
+    }.update(html_options)
   end
 
   def detour_to(title, options = nil, html_options = nil, &block)
@@ -36,7 +40,7 @@ module SimpleWorkflow::Helper
   end
 
   def origin_options
-    params.reject { |k, _v| %i(detour return_from_detour).include? k.to_sym }
+    params.reject { |k, _v| %i[detour return_from_detour].include? k.to_sym }
   end
 
   def image_detour_to(image_source, title, url_options, image_options = nil, link_options = nil)
@@ -56,7 +60,8 @@ module SimpleWorkflow::Helper
     link_to image_tag(image_source, image_options), url_options, link_options
   end
 
-  def image_link_to_remote(image_source, title, link_options, image_options = nil, html_options = {})
+  def image_link_to_remote(image_source, title, link_options, image_options = nil,
+      html_options = {})
     if html_options == true
       html_options = { method: :post }
     elsif html_options == false
@@ -84,7 +89,7 @@ module SimpleWorkflow::Helper
       link_options = options
     end
 
-    link_to(title, link_options, html_options) if options
+    link_to(title, link_options, html_options) if link_options
   rescue ActionController::UrlGenerationError => e
     if session[:detours]
       logger.error "Exception linking to origin: #{e.class} #{e}"

data/lib/simple_workflow/middleware.rb

@@ -1,5 +1,6 @@
 require 'simple_workflow/detour'
 
+# Rack middleware to detect and store detours and manage returns from detours.
 class SimpleWorkflow::Middleware
   include SimpleWorkflow::Detour
 
@@ -38,7 +39,8 @@ class SimpleWorkflow::Middleware
   end
 
   def remove_old_detours(env)
-    return unless session(env).instance_variable_get('@by').is_a?(ActionDispatch::Session::CookieStore)
+    return unless session(env).instance_variable_get('@by')
+                              .is_a?(ActionDispatch::Session::CookieStore)
     session_size = workflow_size = nil
     session = session(env)
     # env[ActionDispatch::Cookies::COOKIES_SERIALIZER]
@@ -49,17 +51,26 @@ class SimpleWorkflow::Middleware
       session_size = encryptor.encrypt_and_sign(ser_val).size
       wf_ser_val = serialize_session(cookie_jar, session[:detours])
       workflow_size = encryptor.encrypt_and_sign(wf_ser_val).size
-      break unless workflow_size >= 2048 || (session_size >= 3072 && session[:detours] && !session[:detours].empty?)
-      Rails.logger.warn "Workflow too large (#{workflow_size}/#{session_size}).  Dropping oldest detour."
+      break unless workflow_size >= 2048 ||
+                   (session_size >= 3072 && session[:detours] && !session[:detours].empty?)
+      Rails.logger.warn(
+        "Workflow too large (#{workflow_size}/#{session_size}).  Dropping oldest detour."
+      )
       session[:detours].shift
       reset_workflow(session) if session[:detours].empty?
     end
-    Rails.logger.debug "session: #{session_size} bytes, workflow(#{session[:detours].try(:size) || 0}): #{workflow_size} bytes"
+    Rails.logger.debug <<-MSG.strip_heredoc
+      session: #{session_size} bytes, workflow(#{session[:detours].try(:size) || 0}): #{workflow_size} bytes
+    MSG
     return unless session_size > 4096
-    Rails.logger.warn "simple_workflow: session exceeds cookie size limit: #{session_size} bytes.  Workflow empty!  Not My Fault!"
+    Rails.logger.warn <<-MSG.strip_heredoc
+      simple_workflow: session exceeds cookie size limit: #{session_size} bytes.  Workflow empty!  Not My Fault!
+    MSG
     Rails.logger.warn "simple_workflow: session: #{session.to_hash}"
     return unless (old_flashes = session[:flash] && session[:flash]['discard'])
-    Rails.logger.warn "simple_workflow: found discarded flash entries: #{old_flashes}.  Deleting them."
+    Rails.logger.warn <<-MSG.strip_heredoc
+      simple_workflow: found discarded flash entries: #{old_flashes}.  Deleting them.
+    MSG
     session[:flash]['flashes'] = session[:flash]['flashes'].except(*old_flashes)
     Rails.logger.warn "simple_workflow: session: #{session.to_hash}"
   end

data/lib/simple_workflow/railtie.rb

@@ -1,8 +1,8 @@
 module SimpleWorkflow
+  # Railtie to activate the middleware.
   class Railtie < Rails::Railtie
     initializer 'SimpleWorkflow.configure_rails_initialization' do |app|
-      app.middleware.insert_before ActionDispatch::Flash,
-          SimpleWorkflow::Middleware
+      app.middleware.insert_before ActionDispatch::Flash, SimpleWorkflow::Middleware
     end
   end
 end

data/lib/simple_workflow/test_helper.rb

@@ -1,3 +1,4 @@
+# Utility methods to ease testing.
 module SimpleWorkflow::TestHelper
   def add_stored_detour(location = { controller: :bogus, action: :location })
     @request.session[:detours] = [location]

data/lib/simple_workflow/version.rb

@@ -1,3 +1,3 @@
 module SimpleWorkflow
-  VERSION = '1.3.2'.freeze
+  VERSION = '1.3.3'.freeze
 end

data/test/middleware_test.rb

@@ -35,7 +35,7 @@ class MiddlewareTest < MiniTest::Test
     assert_equal 200, status
     assert_equal(env, headers)
     assert_equal 'app response', response
-    assert_equal(%w(session_id detours), headers['rack.session'].to_hash.keys)
+    assert_equal(%w[session_id detours], headers['rack.session'].to_hash.keys)
     assert_equal([{ 'controller' => 'test' }], headers['rack.session'].to_hash['detours'])
   end
 
@@ -52,7 +52,7 @@ class MiddlewareTest < MiniTest::Test
 
     assert_equal 200, status
     assert_equal 'app response', response
-    assert_equal(%w(session_id detours), env['rack.session'].to_hash.keys)
+    assert_equal(%w[session_id detours], env['rack.session'].to_hash.keys)
 
     assert_equal(((57..99).to_a + [:last]).map { |i| { 'controller' => "test_#{i}" } },
         env['rack.session'].to_hash['detours'])
@@ -69,7 +69,7 @@ class MiddlewareTest < MiniTest::Test
     assert_equal 200, status
     assert_equal(env, headers)
     assert_equal 'app response', response
-    assert_equal(%w(session_id), headers['rack.session'].to_hash.keys)
+    assert_equal(%w[session_id], headers['rack.session'].to_hash.keys)
   end
 
   def test_return_from_detour

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_workflow
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.3.3
 platform: ruby
 authors:
 - Uwe Kubosch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-03 00:00:00.000000000 Z
+date: 2017-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails