roundabout 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: dcb58b4a2e5cc4434b6cfe400420f51ca98db935
-  data.tar.gz: 1075039a0f8931e5f680372c88a77f86bee32a98
+SHA256:
+  metadata.gz: 3e04a70b5737616244de5b9c4fa9d71fb3befb049732f9690dbc0e7b8a41e0b9
+  data.tar.gz: 79bf12bc73b6aff9a9caad512bb9d7a5a668847a56914cbe40b35da6a5e107ac
 SHA512:
-  metadata.gz: 1cb6ac0560493f4ceb19d0f6291d367d31d1d68976cfc760bcfa4ffbca7058f426b6e543848fd12ec591061a7714e0137fb315778c1c3fc6d7385ccce5615ee2
-  data.tar.gz: 691efe7c90e8e138e04179a5a662a533e53118a4378b85b694f601f109a426693a8007ab56b551a9f625e35e3b3b6a65a3c68680026ef58e4b60e7a4408d5d9a
+  metadata.gz: a9e1cc7575ed994138a771b4807c95586b7d776026a46acefc91e46550dcbe5f76e111e4fc80967769cb0022bcbdf3c107a7ec6db31aeb949451e45ea2806fb6
+  data.tar.gz: b2a3f5e70f1081e13c45a53aa9301a92ca15901a7d3fd11682fec3908c62315ab1b93dbf558218ed13a696b34e88d9ca069c3c32e695d05c33b8fdd77f66095a

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+test/log

data/README.md

@@ -1,58 +1,52 @@
 # Roundabout
 
-A Rails Engine that generates a page transition diagram for your Rails app.
+A Rails Engine that generates and shows a page transition diagram for your Rails app from system tests.
+
+![Example](example_diagram.png)
 
 
 ## Requirements
 
-- Ruby 1.9 or 2.0
+- Ruby 2.x
 
-- Rails 3 or 4
+- Rails 3 or newer
 
-- RSpec 2
+- RSpec / Minitest / TestUnit
 
-- Capybara 1 or 2
+- Capybara
 
 
 ## Installation
 
-Add this line to your Rails app's Gemfile:
+Bundle this gem to your Rails app's development and test env:
 
 ```ruby
-  gem 'roundabout'
+  gem 'roundabout', group :development, :test
 ```
 
-And execute:
 
-```bash
-% bundle
-```
+## Usage
 
-Then add this line to your `spec/spec_helper.rb`:
+Run the whole tests with `ROUNDABOUT` envvar (I suppose parallel spec is not supported ATM):
 
-```ruby
-require 'roundabout/rspec'
+```bash
+% ROUNDABOUT=1 rails test:system
 ```
 
+All page transitions via capybara will be recorded, then woven into a diagram.
 
-## Usage
+To see the generated diagram, just browse at your `http://localhost:3000/roundabout`.
+You can also download a png image version and a PDF version from that page.
 
-Firstly, run the whole test (I suppose parallel spec is not supported ATM)
 
-```bash
-% rake spec
-```
+## Example
 
-Then browse at your `http://localhost:3000/roundabout`
+The image shown at the very top of this documentation was generated from [Redmine](https://github.com/redmine/redmine) project's codebase.
 
 
 ## Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+Send me a PR with a patch.
 
 
 ## Team

data/Rakefile

@@ -1 +1,9 @@
 require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/**/*_test.rb'
+  t.libs << 'test'
+end
+
+task default: :test

data/app/assets/javascripts/roundabout/application.js

@@ -1,3 +1,2 @@
-//= require jquery
 //= require raphael-min
 //= require_tree .

data/app/controllers/roundabout/application_controller.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Roundabout
-  class ApplicationController < ActionController::Base
+  class ApplicationController < ::ActionController::Base
     protect_from_forgery
   end
 end

data/app/controllers/roundabout/roundabout_controller.rb

@@ -1,4 +1,5 @@
-require 'pp'
+# frozen_string_literal: true
+
 require 'roundabout/application_controller'
 require 'graphviz'
 
@@ -35,8 +36,9 @@ module Roundabout
           end
           format.html do
             graph = GraphViz.parse_string(viz.output(dot: String))
-            @nodes, @edges = graph.each_node.values, graph.each_edge.map {|e| e[:pos].source.split(' ').take(2).reverse << e[:color].source }
-            @graph_width, @graph_height = graph.graph.data['bb'].to_s.scan(/.*?(\d+),(\d+)"/).first
+            @nodes = graph.each_node.values
+            @edges = graph.each_edge.map {|e| e[:pos].source.split(' ').take(2).map {|s| s.sub(/^e,/, '') }.reverse << e[:color].source << e.node_one << e.node_two }
+            @graph_width, @graph_height = graph.graph.data['bb'].to_ruby.last(2)
           end
         end
       else

data/app/views/roundabout/roundabout/index.html.erb

@@ -1,5 +1,5 @@
 <div id="roundabout-container" style="width: <%= @graph_width %>px; height: <%= @graph_height %>px;">
-  <div id="roundabout" data-svg-width="<%= @graph_width %>" data-svg-height="<%= @graph_height %>">
+  <div id="roundabout">
     <% @nodes.each.with_index(1) do |node, i| %>
       <% width, height = BigDecimal.new(node[:width].source) * 72, BigDecimal.new(node[:height].source) * 72 %>
       <div id="roundabout-node-<%= i %>" class="node" style="top: <%= node[:pos].point[1] - height / 2 %>px; left: <%= node[:pos].point[0] - width / 2 %>px; width: <%= width %>px; height: <%= height %>px;">
@@ -7,7 +7,6 @@
         <div class="node-name"><span class="controller_name"><%= node_controller_name %></span><span class="controller_name"><%= node_action_name %></span></div>
       </div>
     <% end %>
-    <script>window.raw_edges = '<%= @edges.to_json.html_safe %>';</script>
   </div>
 </div>
 <div id="downloads">
@@ -26,3 +25,18 @@
     </li>
 </ul>
 </div>
+<script>
+(function () {
+  window.paper = Raphael(0, 0, <%= @graph_width %>, <%= @graph_height %>);
+
+  <%= @edges.to_json.html_safe %>.forEach(function(e) {
+    var path;
+    if (e[3] == e[4]) {
+      path = ['M', e[0], 'A', 10, 10, 180, 0, 0, e[1]]
+    } else {
+      path = ['M', e[0], e[1]]
+    }
+    window.paper.path(path).attr({'stroke-width': 2, stroke: e[2], 'arrow-end': 'classic-wide-long'})
+  })
+})();
+</script>

data/config/routes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Roundabout::Engine.routes.draw do
-  get '/(.:format)' => 'roundabout#index', as: 'root'
+  get '/(.:format)' => 'roundabout#index'
 end

data/lib/roundabout.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 require 'roundabout/version'
 require 'roundabout/railtie'
 require 'roundabout/recorder'
-require 'roundabout/monkey/capybara'
 
 module Roundabout
   def self.record_transition(from, to, method, type)
@@ -20,4 +21,9 @@ module Roundabout
     h = Rails.application.routes.recognize_path(path, method: method)
     "#{h[:controller]}##{h[:action]}"
   end
+
+  def self.save_results
+    transitions = compile_page_transitions
+    Rails.root.join('tmp/roundabout.json').open('w') {|f| f.write transitions.to_json} unless transitions.empty?
+  end
 end

data/lib/roundabout/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Roundabout
   class Engine < ::Rails::Engine
     isolate_namespace Roundabout

data/lib/roundabout/minitest.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Minitest.after_run do
+  Roundabout.save_results
+end

data/lib/roundabout/monkey/action_controller.rb

@@ -1,14 +1,21 @@
-module ActionController
-  module Redirecting
-    def redirect_to_with_recording(options = {}, response_status = {})
-      redirect_to_without_recording options, response_status
-      begin
-        h = @_request.env['action_dispatch.request.path_parameters'].with_indifferent_access
-        Roundabout.record_transition "#{h[:controller]}##{h[:action]}", Roundabout.normalize_url(self.location), :get, :redirect
-      rescue => e
-        p e
+# frozen_string_literal: true
+
+module Roundabout
+  module ActionController
+    module Redirecting
+      def redirect_to(*)
+        ret = super
+
+        begin
+          h = @_request.env['action_dispatch.request.path_parameters'].with_indifferent_access
+          Roundabout.record_transition "#{h[:controller]}##{h[:action]}", Roundabout.normalize_url(self.location), :get, :redirect
+        rescue => e
+          p e
+        end
+        ret
       end
     end
-    alias_method_chain :redirect_to, :recording
   end
 end
+
+::ActionController::Base.prepend Roundabout::ActionController::Redirecting

data/lib/roundabout/monkey/capybara.rb

@@ -1,28 +1,52 @@
+# frozen_string_literal: true
+
 require 'capybara'
 
-class Capybara::RackTest::Browser
-  def follow_with_recording(method, path, attributes = {})
-    return if path.gsub(/^#{request_path}/, '').start_with?('#')
-    begin
-      Roundabout.record_transition Roundabout.normalize_url(URI.parse(driver.current_url).path), Roundabout.normalize_url(path, method), method, :link
-    rescue => e
-      p e
-    end
+module Roundabout
+  module Capybara
+    module Node
+      module Element
+        def click(*)
+          path_from = session.current_path
+          case tag_name
+          when 'input'
+            type = :form
+            begin
+              form = ancestor 'form'
+              path_to = form[:action]
+              method = form[:method]
+              begin
+                if (hidden = form.first('input[type=hidden][name=_method]', visible: false))
+                  method = hidden.value
+                end
+              rescue ::Capybara::ExpectationNotMet
+              end
+            rescue ::Capybara::ElementNotFound
+            end
+          when 'a'
+            if (method = self[:'data-method'])
+              type = :form
+            else
+              method = :get
+              type = :link
+            end
+            path_to = self[:href]
+          end
 
-    follow_without_recording method, path, attributes
-  end
-  alias_method_chain :follow, :recording
+          ret = super
 
-  def submit_with_recording(method, path, attributes)
-    begin
-      p = (path.nil? || path.empty?) ? request_path : path
-      m = attributes['_method'] || method
-      Roundabout.record_transition Roundabout.normalize_url(URI.parse(driver.current_url).path), Roundabout.normalize_url(p, m), m, :form
-    rescue => e
-      p e
+          if path_from && path_to && (path_from != path_to)
+            begin
+              Roundabout.record_transition Roundabout.normalize_url(path_from), Roundabout.normalize_url(path_to, method), method.to_sym, type
+            rescue => e
+              p e
+            end
+          end
+          ret
+        end
+      end
     end
-
-    submit_without_recording method, path, attributes
   end
-  alias_method_chain :submit, :recording
 end
+
+::Capybara::Node::Element.prepend Roundabout::Capybara::Node::Element

data/lib/roundabout/railtie.rb

@@ -1,16 +1,37 @@
+# frozen_string_literal: true
+
 require 'rails'
 require 'roundabout/engine'
 
 module Roundabout
   class Railtie < ::Rails::Railtie #:nodoc:
-    initializer 'roundabout' do |app|
-      ActiveSupport.on_load(:action_controller) do
-        require 'roundabout/monkey/action_controller'
+    initializer 'roundabout' do
+      if ENV['ROUNDABOUT']
+        if Rails::VERSION::MAJOR >= 5
+          ActiveSupport.on_load :action_dispatch_integration_test do
+            require 'roundabout/minitest' if defined? Minitest
+          end
+        else
+          ActiveSupport.on_load :active_support_test_case do
+            require 'roundabout/minitest' if defined? Minitest
+          end
+        end
+
+        ActiveSupport.on_load :action_controller do
+          require 'roundabout/monkey/action_controller'
+        end
+
+        config.after_initialize do |app|
+          require 'roundabout/monkey/capybara'
+          require 'roundabout/rspec' if defined? RSpec
+          require 'roundabout/test-unit' if defined? TestUnitRails
+        end
       end
-      ActiveSupport.on_load(:after_initialize) do
-        if Rails.env.development?
-          Rails.application.routes.append do
-            mount Roundabout::Engine, :at => '/roundabout'
+
+      if Rails.env.development?
+        config.after_initialize do |app|
+          app.routes.append do
+            mount Roundabout::Engine => '/roundabout'
           end
         end
       end

data/lib/roundabout/recorder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'set'
 
 module Roundabout

data/lib/roundabout/rspec.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 RSpec.configure do |config|
   config.after :suite do
-    transitions = Roundabout.compile_page_transitions
-    Rails.root.join('tmp/roundabout.json').open('w') {|f| f.write transitions.to_json} unless transitions.empty?
+    Roundabout.save_results
   end
 end

data/lib/roundabout/test-unit.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+at_exit do
+  Roundabout.save_results
+end

data/lib/roundabout/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Roundabout
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/roundabout.gemspec

@@ -18,6 +18,16 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_runtime_dependency 'capybara', ['>= 1.0.0']
-  gem.add_runtime_dependency 'rspec', ['>= 2.0.0']
   gem.add_runtime_dependency 'ruby-graphviz', ['>= 1.0.0']
+
+  gem.add_development_dependency 'rails'
+  gem.add_development_dependency 'minitest'
+  gem.add_development_dependency 'sqlite3'
+  gem.add_development_dependency 'selenium-webdriver'
+  gem.add_development_dependency 'chromedriver-helper'
+  gem.add_development_dependency 'puma'
+  gem.add_development_dependency 'sass-rails'
+  gem.add_development_dependency 'uglifier'
+  gem.add_development_dependency 'sprockets-rails'
+  gem.add_development_dependency 'coffee-rails'
 end

data/test/app/assets/javascripts/application.js

@@ -0,0 +1,14 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, or any plugin's
+// vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require rails-ujs
+//= require_tree .

data/test/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, or any plugin's
+ * vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */