RubyGems - roundabout - Versions diffs - 0.0.1 - Mend

roundabout 0.0.1

Files changed (23) hide show

data/.gitignore +17 -0
data/Gemfile +4 -0
data/MIT-LICENSE +22 -0
data/README.md +55 -0
data/Rakefile +1 -0
data/app/assets/javascripts/roundabout/application.js +1 -0
data/app/assets/stylesheets/roundabout/application.css +4 -0
data/app/controllers/roundabout/application_controller.rb +5 -0
data/app/controllers/roundabout/roundabout_controller.rb +30 -0
data/app/views/layouts/roundabout/application.html.erb +13 -0
data/app/views/roundabout/roundabout/index.html.erb +2 -0
data/app/views/roundabout/roundabout/readme.html.erb +15 -0
data/config/routes.rb +4 -0
data/lib/roundabout/engine.rb +5 -0
data/lib/roundabout/monkey/action_controller.rb +14 -0
data/lib/roundabout/monkey/capybara.rb +28 -0
data/lib/roundabout/railtie.rb +19 -0
data/lib/roundabout/recorder.rb +15 -0
data/lib/roundabout/rspec.rb +6 -0
data/lib/roundabout/version.rb +3 -0
data/lib/roundabout.rb +23 -0
data/roundabout.gemspec +23 -0
metadata +117 -0

data/.gitignore ADDED Viewed

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile ADDED Viewed

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+# Specify your gem's dependencies in roundabout.gemspec
+gemspec

data/MIT-LICENSE ADDED Viewed

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Akira Matsuda
+MIT License
+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 ADDED Viewed

@@ -0,0 +1,55 @@
+# Roundabout
+A Rails Engine that generates a page transition diagram for your Rails app.
+## Requirements
+- Ruby 1.9 or 2.0
+- Rails 3 or 4
+- RSpec 2
+- Capybara 1 or 2
+## Installation
+Add this line to your Rails app's Gemfile:
+```ruby
+  gem 'roundabout'
+```
+And execute:
+```bash
+% bundle
+```
+Then add this line to your `spec/spec\_helper.rb`:
+```ruby
+require 'roundabout/rspec'
+```
+## Usage
+Firstly, run the whole test (I suppose parallel spec is not supported ATM)
+```bash
+% rake spec
+```
+Then browse at your `http://localhost:3000/roundabout`
+## 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

data/Rakefile ADDED Viewed

	@@ -0,0 +1 @@
1	+ require "bundler/gem_tasks"

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

	@@ -0,0 +1 @@
1	+ //= require_tree .

data/app/assets/stylesheets/roundabout/application.css ADDED Viewed

@@ -0,0 +1,4 @@
+/*
+ *= require_self
+ *= require_tree .
+*/

data/app/controllers/roundabout/application_controller.rb ADDED Viewed

@@ -0,0 +1,5 @@
+module Roundabout
+  class ApplicationController < ActionController::Base
+    protect_from_forgery
+  end
+end

data/app/controllers/roundabout/roundabout_controller.rb ADDED Viewed

@@ -0,0 +1,30 @@
+require 'pp'
+require 'roundabout/application_controller'
+require 'graphviz'
+module Roundabout
+  class RoundaboutController < ::Roundabout::ApplicationController
+    def index
+      if (json = Rails.root.join('doc/roundabout.json')).exist?
+        transitions = ActiveSupport::JSON.decode json.read
+        GraphViz.new(:G, type: :digraph, rankdir: 'LR') {|g|
+          transitions.each do |t|
+            from = g.add_nodes t['from'], shape: 'box'
+            to = g.add_nodes t['to'], shape: 'box'
+            color = case t['type']
+            when 'redirect'
+              'red'
+            when 'form'
+              'purple'
+            else
+              'blue'
+            end
+            g.add_edges from, to, color: color
+          end
+        }.output(png: Rails.root.join('public/images/roundabout.png'))
+      else
+        render 'readme'
+      end
+    end
+  end
+end

data/app/views/layouts/roundabout/application.html.erb ADDED Viewed

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset='utf-8'>
+  <title>Transition Diagram</title>
+  <%= stylesheet_link_tag    'roundabout/application', :media => 'all' %>
+  <%= javascript_include_tag 'roundabout/application' %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+<%= yield %>
+</body>
+</html>

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

	@@ -0,0 +1,2 @@
1	+ <%- pp @transitions %>
2	+ <%= image_tag '/images/roundabout.png' %>

data/app/views/roundabout/roundabout/readme.html.erb ADDED Viewed

@@ -0,0 +1,15 @@
+<p>You need to generate the page transition data first.</p>
+Add this line to your <strong>spec/spec_helper.rb</strong>:
+<pre>
+require 'roundabout/rspec'
+</pre>
+And run the specs.
+<pre>
+% rake spec
+</pre>
+Then reload this page.

data/config/routes.rb ADDED Viewed

@@ -0,0 +1,4 @@
+Roundabout::Engine.routes.draw do
+  get '/' => 'roundabout#index'
+  root :to => 'roundabout#index'
+end

data/lib/roundabout/engine.rb ADDED Viewed

@@ -0,0 +1,5 @@
+module Roundabout
+  class Engine < ::Rails::Engine
+    isolate_namespace Roundabout
+  end
+end

data/lib/roundabout/monkey/action_controller.rb ADDED Viewed

@@ -0,0 +1,14 @@
+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
+      end
+    end
+    alias_method_chain :redirect_to, :recording
+  end
+end

data/lib/roundabout/monkey/capybara.rb ADDED Viewed

@@ -0,0 +1,28 @@
+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, :link
+    rescue => e
+      p e
+    end
+    follow_without_recording method, path, attributes
+  end
+  alias_method_chain :follow, :recording
+  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
+    end
+    submit_without_recording method, path, attributes
+  end
+  alias_method_chain :submit, :recording
+end

data/lib/roundabout/railtie.rb ADDED Viewed

@@ -0,0 +1,19 @@
+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'
+      end
+      ActiveSupport.on_load(:after_initialize) do
+        if Rails.env.development?
+          Rails.application.routes.append do
+            mount Roundabout::Engine, :at => '/roundabout'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/roundabout/recorder.rb ADDED Viewed

@@ -0,0 +1,15 @@
+require 'set'
+module Roundabout
+  class Recorder
+    attr_reader :transitions
+    def initialize
+      @transitions = Set.new
+    end
+    def record_transition(from, to, method, type)
+      @transitions << {from: from, to: to, method: method, type: type}
+    end
+  end
+end

data/lib/roundabout/rspec.rb ADDED Viewed

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

data/lib/roundabout/version.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module Roundabout
+  VERSION = "0.0.1"
+end

data/lib/roundabout.rb ADDED Viewed

@@ -0,0 +1,23 @@
+require 'roundabout/version'
+require 'roundabout/railtie'
+require 'roundabout/recorder'
+require 'roundabout/monkey/capybara'
+module Roundabout
+  def self.record_transition(from, to, method, type)
+    recorder.record_transition from, to, method, type
+  end
+  def self.recorder
+    @recorder ||= Recorder.new
+  end
+  def self.compile_page_transitions
+    recorder.transitions
+  end
+  def self.normalize_url(path, method = nil)
+    h = Rails.application.routes.recognize_path(path, method: method)
+    "#{h[:controller]}##{h[:action]}"
+  end
+end

data/roundabout.gemspec ADDED Viewed

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'roundabout/version'
+Gem::Specification.new do |gem|
+  gem.name          = "roundabout"
+  gem.version       = Roundabout::VERSION
+  gem.authors       = ["Akira Matsuda"]
+  gem.email         = ["ronnie@dio.jp"]
+  gem.description   = 'A Rails Engine that generates a page transition diagram for your Rails app from request specs'
+  gem.summary       = 'A Rails Engine that generates a page transition diagram for your Rails app from request specs'
+  gem.homepage      = 'https://github.com/amatsuda/roundabout'
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  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']
+end

metadata ADDED Viewed

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: roundabout
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease:
+platform: ruby
+authors:
+- Akira Matsuda
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2012-12-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: ruby-graphviz
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: A Rails Engine that generates a page transition diagram for your Rails
+  app from request specs
+email:
+- ronnie@dio.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/roundabout/application.js
+- app/assets/stylesheets/roundabout/application.css
+- app/controllers/roundabout/application_controller.rb
+- app/controllers/roundabout/roundabout_controller.rb
+- app/views/layouts/roundabout/application.html.erb
+- app/views/roundabout/roundabout/index.html.erb
+- app/views/roundabout/roundabout/readme.html.erb
+- config/routes.rb
+- lib/roundabout.rb
+- lib/roundabout/engine.rb
+- lib/roundabout/monkey/action_controller.rb
+- lib/roundabout/monkey/capybara.rb
+- lib/roundabout/railtie.rb
+- lib/roundabout/recorder.rb
+- lib/roundabout/rspec.rb
+- lib/roundabout/version.rb
+- roundabout.gemspec
+homepage: https://github.com/amatsuda/roundabout
+licenses: []
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 1.8.24
+signing_key:
+specification_version: 3
+summary: A Rails Engine that generates a page transition diagram for your Rails app
+  from request specs
+test_files: []