simple_workflow 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a401f2ff7174eab0a404f384aaf5cf6e0145c4df
-  data.tar.gz: 2c7550459676d6176f5ef806b936cea4d5f5ffe6
+  metadata.gz: df30a1c9f24abcc2eed8341f903f43dc726dfa0c
+  data.tar.gz: 7a67d053ee88dcb7860b3b3bc0046b633610913c
 SHA512:
-  metadata.gz: 735d22fee950b342604df519018045b16df0edb84cb1b6d2704459577415a0843c705a46cdd9727042904d15b2a337414b8ff59bf8e09a94ce2083e52dd41762
-  data.tar.gz: 36563aade7344805d5a6995f298a07cfa6a6f1b409547c2cd184dbe5edd607aea6ea891f6d2cdad737f137b8cce91acef4a1fc694cc8fa2696baec47c0ea7bf2
+  metadata.gz: 31b7fde7ad4ae7b569b85b4b625621cb10e7f5878c0d27311c3fb2f79afa78e9b1f21c8c091197be3090e79848e45daa527b02f076d194bf808de51898badd50
+  data.tar.gz: 1d33d84a1ad300aeca822ca9f821362ed896f0c37505de24e3ea34589f816911b834b936a90bd88257596a4516ae4d702ee6df5d25547383deee2bb9828429d0

data/Gemfile.lock

@@ -1,45 +1,45 @@
 PATH
   remote: .
   specs:
-    simple_workflow (1.3.0)
+    simple_workflow (1.3.2)
       rails (>= 4, < 5.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (5.0.1)
-      actionpack (= 5.0.1)
-      nio4r (~> 1.2)
+    actioncable (5.0.2)
+      actionpack (= 5.0.2)
+      nio4r (>= 1.2, < 3.0)
       websocket-driver (~> 0.6.1)
-    actionmailer (5.0.1)
-      actionpack (= 5.0.1)
-      actionview (= 5.0.1)
-      activejob (= 5.0.1)
+    actionmailer (5.0.2)
+      actionpack (= 5.0.2)
+      actionview (= 5.0.2)
+      activejob (= 5.0.2)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (5.0.1)
-      actionview (= 5.0.1)
-      activesupport (= 5.0.1)
+    actionpack (5.0.2)
+      actionview (= 5.0.2)
+      activesupport (= 5.0.2)
       rack (~> 2.0)
       rack-test (~> 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.0.1)
-      activesupport (= 5.0.1)
+    actionview (5.0.2)
+      activesupport (= 5.0.2)
       builder (~> 3.1)
       erubis (~> 2.7.0)
       rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    activejob (5.0.1)
-      activesupport (= 5.0.1)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.0.2)
+      activesupport (= 5.0.2)
       globalid (>= 0.3.6)
-    activemodel (5.0.1)
-      activesupport (= 5.0.1)
-    activerecord (5.0.1)
-      activemodel (= 5.0.1)
-      activesupport (= 5.0.1)
+    activemodel (5.0.2)
+      activesupport (= 5.0.2)
+    activerecord (5.0.2)
+      activemodel (= 5.0.2)
+      activesupport (= 5.0.2)
       arel (~> 7.0)
-    activesupport (5.0.1)
+    activesupport (5.0.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (~> 0.7)
       minitest (~> 5.1)
@@ -47,15 +47,14 @@ GEM
     ansi (1.5.0)
     arel (7.1.4)
     ast (2.3.0)
-    builder (3.2.2)
-    concurrent-ruby (1.0.3)
+    builder (3.2.3)
+    concurrent-ruby (1.0.5)
     docile (1.1.5)
     erubis (2.7.0)
     globalid (0.3.7)
       activesupport (>= 4.1.0)
-    i18n (0.7.0)
-    json (2.0.2)
-    json (2.0.2-java)
+    i18n (0.8.1)
+    json (2.0.3)
     loofah (2.0.3)
       nokogiri (>= 1.5.9)
     mail (2.6.4)
@@ -66,53 +65,53 @@ GEM
     mime-types-data (3.2016.0521)
     mini_portile2 (2.1.0)
     minitest (5.10.1)
-    minitest-reporters (1.1.13)
+    minitest-reporters (1.1.14)
       ansi
       builder
       minitest (>= 5.0)
       ruby-progressbar
-    nio4r (1.2.1)
-    nokogiri (1.6.8.1)
+    nio4r (2.0.0)
+    nokogiri (1.7.1)
       mini_portile2 (~> 2.1.0)
-    parser (2.3.3.1)
+    parser (2.4.0.0)
       ast (~> 2.2)
     powerpack (0.1.1)
     rack (2.0.1)
     rack-test (0.6.3)
       rack (>= 1.0)
-    rails (5.0.1)
-      actioncable (= 5.0.1)
-      actionmailer (= 5.0.1)
-      actionpack (= 5.0.1)
-      actionview (= 5.0.1)
-      activejob (= 5.0.1)
-      activemodel (= 5.0.1)
-      activerecord (= 5.0.1)
-      activesupport (= 5.0.1)
+    rails (5.0.2)
+      actioncable (= 5.0.2)
+      actionmailer (= 5.0.2)
+      actionpack (= 5.0.2)
+      actionview (= 5.0.2)
+      activejob (= 5.0.2)
+      activemodel (= 5.0.2)
+      activerecord (= 5.0.2)
+      activesupport (= 5.0.2)
       bundler (>= 1.3.0, < 2.0)
-      railties (= 5.0.1)
+      railties (= 5.0.2)
       sprockets-rails (>= 2.0.0)
-    rails-dom-testing (2.0.1)
+    rails-dom-testing (2.0.2)
       activesupport (>= 4.2.0, < 6.0)
-      nokogiri (~> 1.6.0)
+      nokogiri (~> 1.6)
     rails-html-sanitizer (1.0.3)
       loofah (~> 2.0)
-    railties (5.0.1)
-      actionpack (= 5.0.1)
-      activesupport (= 5.0.1)
+    railties (5.0.2)
+      actionpack (= 5.0.2)
+      activesupport (= 5.0.2)
       method_source
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
-    rainbow (2.1.0)
+    rainbow (2.2.1)
     rake (12.0.0)
-    rubocop (0.46.0)
-      parser (>= 2.3.1.1, < 3.0)
+    rubocop (0.47.1)
+      parser (>= 2.3.3.1, < 3.0)
       powerpack (~> 0.1)
       rainbow (>= 1.99.1, < 3.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-progressbar (1.8.1)
-    simplecov (0.12.0)
+    simplecov (0.14.1)
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
@@ -125,16 +124,15 @@ GEM
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
     thor (0.19.4)
-    thread_safe (0.3.5)
-    tzinfo (1.2.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.3)
       thread_safe (~> 0.1)
-    unicode-display_width (1.1.2)
-    websocket-driver (0.6.4)
+    unicode-display_width (1.1.3)
+    websocket-driver (0.6.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.2)
 
 PLATFORMS
-  java
   ruby
 
 DEPENDENCIES
@@ -144,4 +142,4 @@ DEPENDENCIES
   simplecov (~> 0.9)
 
 BUNDLED WITH
-   1.13.6
+   1.14.6

data/lib/simple_workflow/controller.rb

@@ -53,21 +53,20 @@ module SimpleWorkflow::Controller
       flash[:notice] = notice
     end
 
-    if (other_flashes = response_status_and_flash.delete(:flash))
-      flash.update(other_flashes)
-    end
+    return unless (other_flashes = response_status_and_flash.delete(:flash))
+    flash.update(other_flashes)
   end
   private :save_flash
 
   def redirect_to_post(options)
     url = url_for options
-    render text: <<EOF, layout: false
-<html>
-  <body onload="document.getElementById('form').submit()">
-    <form id="form" action="#{url}" method="POST">
-    </form>
-  </body>
-</html>
+    render text: <<EOF.strip_heredoc, layout: false
+      <html>
+        <body onload="document.getElementById('form').submit()">
+          <form id="form" action="#{url}" method="POST">
+          </form>
+        </body>
+      </html>
 EOF
   end
 end

data/lib/simple_workflow/helper.rb

@@ -1,4 +1,7 @@
+require_relative 'detour'
 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,
@@ -33,7 +36,7 @@ module SimpleWorkflow::Helper
   end
 
   def origin_options
-    params.reject { |k, _v| [: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)
@@ -70,14 +73,24 @@ module SimpleWorkflow::Helper
 
   def back_or_link_to(title, options = nil, html_options = nil)
     if session[:detours]
-      options      = { return_from_detour: true }.update(session[:detours].last)
+      link_options = { return_from_detour: true }.update(session[:detours].last)
 
       # FIXME(uwe): Write a test to prove this line is needed.
-      options['id'] ||= nil
+      link_options['id'] ||= nil
       # EMXIF
 
-      logger.debug "linked return from detour: #{options.inspect}"
+      logger.debug "linked return from detour: #{link_options.inspect}"
+    else
+      link_options = options
+    end
+
+    link_to(title, link_options, html_options) if options
+  rescue ActionController::UrlGenerationError => e
+    if session[:detours]
+      logger.error "Exception linking to origin: #{e.class} #{e}"
+      pop_detour(session)
+      retry
     end
-    link_to(title, options, html_options) if options
+    raise
   end
 end

data/lib/simple_workflow/middleware.rb

@@ -38,33 +38,30 @@ class SimpleWorkflow::Middleware
   end
 
   def remove_old_detours(env)
-    if session(env).instance_variable_get('@by').is_a?(ActionDispatch::Session::CookieStore)
-      session_size = workflow_size = nil
-      session = session(env)
-      # env[ActionDispatch::Cookies::COOKIES_SERIALIZER]
-      cookie_jar = cookie_jar(env)
-      encryptor = encryptor(env)
-      loop do
-        ser_val = serialize_session(cookie_jar, session.to_hash)
-        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."
-        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"
-      if session_size > 4096
-        Rails.logger.warn "simple_workflow: session exceeds cookie size limit: #{session_size} bytes.  Workflow empty!  Not My Fault!"
-        Rails.logger.warn "simple_workflow: session: #{session.to_hash}"
-        if (old_flashes = session[:flash] && session[:flash]['discard'])
-          Rails.logger.warn "simple_workflow: found discarded flash entries: #{old_flashes}.  Deleting them."
-          session[:flash]['flashes'] = session[:flash]['flashes'].except(*old_flashes)
-          Rails.logger.warn "simple_workflow: session: #{session.to_hash}"
-        end
-      end
+    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]
+    cookie_jar = cookie_jar(env)
+    encryptor = encryptor(env)
+    loop do
+      ser_val = serialize_session(cookie_jar, session.to_hash)
+      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."
+      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"
+    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 "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."
+    session[:flash]['flashes'] = session[:flash]['flashes'].except(*old_flashes)
+    Rails.logger.warn "simple_workflow: session: #{session.to_hash}"
   end
 
   if ActionPack::VERSION::MAJOR == 5
@@ -96,8 +93,7 @@ class SimpleWorkflow::Middleware
     if params(env)[:detour]
       store_detour_in_session(session(env), params(env)[:detour])
     end
-    if params(env)[:return_from_detour] && session(env)[:detours]
-      pop_detour(session(env))
-    end
+    return unless params(env)[:return_from_detour] && session(env)[:detours]
+    pop_detour(session(env))
   end
 end

data/lib/simple_workflow/version.rb

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

data/test/helper_test.rb

@@ -35,17 +35,42 @@ class HelperTest < MiniTest::Test
         image_link_to('my_image.png', 'Link Title', { id: 'image_tag_id' }, title: 'Image title')
   end
 
+  def test_back_or_link_to
+    assert_equal ['Link title', { controller: :mycontroller, action: :my_action }, nil],
+        back_or_link_to('Link title', controller: :mycontroller, action: :my_action)
+  end
+
+  def test_back_or_link_to_with_routing_error
+    @session = { detours: [{ controller: :does_not_exist }] }
+    @routing_error = ActionController::UrlGenerationError
+    assert_equal ['Link title', { controller: :mycontroller, action: :my_action }, nil],
+        back_or_link_to('Link title', controller: :mycontroller, action: :my_action)
+  end
+
   private
 
+  def logger
+    @logger ||= Logger.new(File.expand_path('../log/test.log', __dir__))
+  end
+
   def params
     { controller: 'mycontroller', action: 'myaction', id: 42, query: { nested: 'criterium' } }
   end
 
+  def session
+    @session ||= {}
+  end
+
   def url_for(options)
     options.to_s
   end
 
   def link_to(*options)
+    if defined?(@routing_error) && @routing_error
+      e = @routing_error
+      @routing_error = nil
+      raise e
+    end
     options
   end
 

data/test/middleware_test.rb

@@ -54,12 +54,14 @@ class MiddlewareTest < MiniTest::Test
     assert_equal 'app response', response
     assert_equal(%w(session_id detours), env['rack.session'].to_hash.keys)
 
-    assert_equal([{ 'controller' => 'test_57' }, { 'controller' => 'test_58' }, { 'controller' => 'test_59' }, { 'controller' => 'test_60' }, { 'controller' => 'test_61' }, { 'controller' => 'test_62' }, { 'controller' => 'test_63' }, { 'controller' => 'test_64' }, { 'controller' => 'test_65' }, { 'controller' => 'test_66' }, { 'controller' => 'test_67' }, { 'controller' => 'test_68' }, { 'controller' => 'test_69' }, { 'controller' => 'test_70' }, { 'controller' => 'test_71' }, { 'controller' => 'test_72' }, { 'controller' => 'test_73' }, { 'controller' => 'test_74' }, { 'controller' => 'test_75' }, { 'controller' => 'test_76' }, { 'controller' => 'test_77' }, { 'controller' => 'test_78' }, { 'controller' => 'test_79' }, { 'controller' => 'test_80' }, { 'controller' => 'test_81' }, { 'controller' => 'test_82' }, { 'controller' => 'test_83' }, { 'controller' => 'test_84' }, { 'controller' => 'test_85' }, { 'controller' => 'test_86' }, { 'controller' => 'test_87' }, { 'controller' => 'test_88' }, { 'controller' => 'test_89' }, { 'controller' => 'test_90' }, { 'controller' => 'test_91' }, { 'controller' => 'test_92' }, { 'controller' => 'test_93' }, { 'controller' => 'test_94' }, { 'controller' => 'test_95' }, { 'controller' => 'test_96' }, { 'controller' => 'test_97' }, { 'controller' => 'test_98' }, { 'controller' => 'test_99' }, { 'controller' => 'test_last' }],
+    assert_equal(((57..99).to_a + [:last]).map { |i| { 'controller' => "test_#{i}" } },
         env['rack.session'].to_hash['detours'])
   end
 
   def test_huge_detour_over_4k
+    # rubocop:disable Metrics/LineLength
     query = "/orders/TeYphD2wcYyBDFaKTnmAog/edit?detour%5Baction%5D=index&detour%5Bcommit%5D=Search&detour%5Bcontroller%5D=order_drilldown&detour%5Bdrilldown_search%5D%5Bdimensions%5D%5B%5D=arrival&detour%5Bdrilldown_search%5D%5Bdimensions%5D%5B%5D=delay&detour%5Bdrilldown_search%5D%5Bdisplay_type%5D=NONE&detour%5Bdrilldown_search%5D%5Bfields%5D%5Bactual_time%5D=1&detour%5Bdrilldown_search%5D%5Bfields%5D%5Bcomments%5D=1&detour%5Bdrilldown_search%5D%5Bfields%5D%5Bdelay%5D=1&detour%5Bdrilldown_search%5D%5Bfields%5D%5Bdescription%5D=1&detour%5Bdrilldown_search%5D%5Bfields%5D%5Bdirection%5D=0&detour%5Bdrilldown_search%5D%5Bfields%5D%5Bdrop_off_stand%5D=0&detour%5Bdrilldown_search%5D%5Bfields%5D%5Bestimated%5D=1&detour%5Bdrilldown_search%5D%5Bfields%5D%5Bfirst_vehicle%5D=1&detour%5Bdrilldown_search%5D%5Bfields%5D%5Bofb%5D=0&detour%5Bdrilldown_search%5D%5Bfields%5D%5Bonb%5D=0&detour%5Bdrilldown_search%5D%5Bfields%5D%5Boperation%5D=0&detour%5Bdrilldown_search%5D%5Bfields%5D%5Bpick_up%5D=1&detour%5Bdrilldown_search%5D%5Bfields%5D%5Bpick_up_stand%5D=0&detour%5Bdrilldown_search%5D%5Bfields%5D%5Bplanned%5D=0&detour%5Bdrilldown_search%5D%5Bfields%5D%5Bprobable%5D=1&detour%5Bdrilldown_search%5D%5Bfields%5D%5Bscheduled%5D=1&detour%5Bdrilldown_search%5D%5Bfields%5D%5Bsta%5D=0&detour%5Bdrilldown_search%5D%5Bfields%5D%5Btime%5D=0&detour%5Bdrilldown_search%5D%5Bfilter%5D%5Barrival%5D%5B%5D=Arrival&detour%5Bdrilldown_search%5D%5Bfilter%5D%5Barrival%5D%5B%5D=Departure&detour%5Bdrilldown_search%5D%5Bfilter%5D%5Bcalendar_date%5D%5B%5D=2016-03-01&detour%5Bdrilldown_search%5D%5Blist%5D=1&detour%5Bdrilldown_search%5D%5Blist_change_times%5D=0&detour%5Bdrilldown_search%5D%5Border_by_value%5D=0&detour%5Bdrilldown_search%5D%5Bpercent%5D=1&detour%5Bdrilldown_search%5D%5Bselect_value%5D=COUNT&detour%5Bdrilldown_search%5D%5Btitle%5D=OSL+Daily+Delay+Report+2016-04-16#{'+etc' * 200}&detour%5Butf8%5D=%E2%9C%93"
+    # rubocop:enable Metrics/LineLength
     env = env_for(query)
 
     status, headers, response = @stack.call env

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_workflow
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors:
 - Uwe Kubosch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-23 00:00:00.000000000 Z
+date: 2017-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -116,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: donv/simple_workflow
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Add simple breadcrumbs "detour" workflow to Ruby On Rails.