router-visualizer 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 40a124d4a262fb535e51473aa9741cf290e33bee
+  data.tar.gz: 381ebf9600b5465bd465604e53a06d4d49bfe664
+SHA512:
+  metadata.gz: fee7978538572b4c3eaea1e5bf6e473c26fd21b600e513d8602d07ac1e037de6b44c9192895c0657e765de1cc084d9613a7d788c7ee0ba665c7d24be7ef790e0
+  data.tar.gz: 4e33cf8f4d1f33a2900d58b2c0ea2649aed7364c0618dbe0c91c8df0c546baffd2e34a289b02e30e29ca874dd7b5c169ece7a60787aa44c2a090b2aac9ce9afc

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+*.gem

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Joseph Tibbertsma
+
+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/Rakefile

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require "router-visualizer/version"
+
+task :build do  
+  system "gem build router-visualizer.gemspec"
+end
+
+task :release => :build do  
+  system "gem push router-visualizer-#{RouterVisualizer::VERSION}.gem"
+end  

data/app/controllers/router_visualizer/application_controller.rb

@@ -0,0 +1,4 @@
+module RouterVisualizer
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/router_visualizer/visualizer_controller.rb

@@ -0,0 +1,9 @@
+module RouterVisualizer
+  class VisualizerController < ApplicationController
+    layout "blank"
+
+    def visualize
+      @nfa = Rails.application.routes.router.visualizer
+    end
+  end
+end

data/app/views/layouts/blank.html.erb

@@ -0,0 +1 @@
+<%= yield %>

data/app/views/router_visualizer/visualizer/visualize.html.erb

@@ -0,0 +1 @@
+<%= @nfa.html_safe %>

data/config/routes.rb

@@ -0,0 +1,3 @@
+RouterVisualizer::Engine.routes.draw do
+  root to: 'visualizer#visualize'
+end

data/lib/router-visualizer.rb

@@ -0,0 +1,4 @@
+require 'router-visualizer/engine'
+
+module RouterVisualizer
+end

data/lib/router-visualizer/engine.rb

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

data/lib/router-visualizer/version.rb

@@ -0,0 +1,3 @@
+module RouterVisualizer
+  VERSION = "1.0.0"
+end

data/readme.md

@@ -0,0 +1,47 @@
+# Rails Router Visualizer
+
+This gem allows you to see a visualization of the router of your Rails 4 application.
+
+This visualization is generated by the Rails Journey router. It was written by [tenderlove](http://tenderlove.github.io) back before Journey was incorporated into Rails. Calling `Rails.application.routes.router.visualizer` from your application will return the text of an html file titled "Routes FSM with NFA simulation". This gem just wraps this functionality into a simple engine that you can mount at some route.
+
+The visualizer also shows a list of all of your application's routes. It doesn't list the REST methods associated with the routes.
+
+## Installation
+
+Add the gem to your app's development environment and run the `bundle` command to install it.
+
+```ruby
+gem 'router-visualizer', group: :development
+```
+
+## Requirements
+
+For this to work, you need the `dot` command. This command is used for drawing directed graphs; this is what Rails uses to generate the visualization of the router NFA.
+
+If you're on OS X, you can do
+
+```bash
+$ brew install gprof2dot
+```
+
+## Usage
+
+```ruby
+# config/routes.rb
+
+Rails.application.routes.draw do
+  # ...
+
+  if Rails.env.development?
+    mount RouterVisualizer::Engine, at: "/routes"
+  end
+
+  # ...
+end
+```
+
+Then you can navigate to `localhost:3000/routes` to see the visualization.
+
+## What is the point of this?
+
+I want to learn to write gems and rails engines. This is a simple starting point.

data/router-visualizer.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'router-visualizer/version'
+
+Gem::Specification.new do |gem|
+  gem.name           = "router-visualizer"
+  gem.version        = RouterVisualizer::VERSION
+  gem.authors        = ["Joseph Tibbertsma"]
+  gem.email          = ["josephtibbertsma@gmail.com"]
+  gem.description    = "Shows a NFA visualization of a rails application's router"
+  gem.summary        = gem.description
+  gem.homepage       = "https://github.com/jtibbertsma/router-visualizer"
+  gem.license        = 'MIT'
+
+  gem.files          = `git ls-files`.split($/)
+  gem.require_paths  = ['lib']
+
+  gem.add_dependency 'railties', '>= 4.0'
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: router-visualizer
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Joseph Tibbertsma
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Shows a NFA visualization of a rails application's router
+email:
+- josephtibbertsma@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE
+- Rakefile
+- app/controllers/router_visualizer/application_controller.rb
+- app/controllers/router_visualizer/visualizer_controller.rb
+- app/views/layouts/blank.html.erb
+- app/views/router_visualizer/visualizer/visualize.html.erb
+- config/routes.rb
+- lib/router-visualizer.rb
+- lib/router-visualizer/engine.rb
+- lib/router-visualizer/version.rb
+- readme.md
+- router-visualizer.gemspec
+homepage: https://github.com/jtibbertsma/router-visualizer
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Shows a NFA visualization of a rails application's router
+test_files: []