router-visualizer 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 40a124d4a262fb535e51473aa9741cf290e33bee
-  data.tar.gz: 381ebf9600b5465bd465604e53a06d4d49bfe664
+  metadata.gz: 149c7448fa0192374da733d531a7632b04a8679d
+  data.tar.gz: cfaa8998fe6b05516f456f2ccbad511a387581a1
 SHA512:
-  metadata.gz: fee7978538572b4c3eaea1e5bf6e473c26fd21b600e513d8602d07ac1e037de6b44c9192895c0657e765de1cc084d9613a7d788c7ee0ba665c7d24be7ef790e0
-  data.tar.gz: 4e33cf8f4d1f33a2900d58b2c0ea2649aed7364c0618dbe0c91c8df0c546baffd2e34a289b02e30e29ca874dd7b5c169ece7a60787aa44c2a090b2aac9ce9afc
+  metadata.gz: 67a3e846083e93ddadc3bbd20fa284bb41907aa9ac09735e188ce9a7cf94e95e668ac921b0926e0e8c82d293625bb2cccf98a208cff2ff1d8dc85c3ebbedab35
+  data.tar.gz: b5ce4232f7f77ac03d908b98469b22bd4e21d93eee73fab315c9cca0f8dcfe796200698f629634f86b1652e899dd83584406ae55bd422bbef8af067b7125d363

data/lib/router-visualizer.rb

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

data/lib/router-visualizer/mapper.rb

@@ -0,0 +1,25 @@
+require 'router-visualizer/engine'
+
+module ActionDispatch
+  module Routing
+    class Mapper
+      def visualize(options = {})
+        groups = options.delete(:groups) { ['development'] }
+        at = options.delete(:at) { '/routes' }
+
+        if matching_group? groups
+          mount RouterVisualizer::Engine, at: at
+        end
+        self
+      end
+
+      private
+        def matching_group?(groups)
+          groups.each do |group|
+            return true if Rails.env.send("#{group}?")
+          end
+          false
+        end
+    end
+  end
+end

data/lib/router-visualizer/version.rb

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

data/readme.md

@@ -2,7 +2,7 @@
 
 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.
+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 gets mounted by the `visualize` method.
 
 The visualizer also shows a list of all of your application's routes. It doesn't list the REST methods associated with the routes.
 
@@ -31,17 +31,58 @@ $ brew install gprof2dot
 
 Rails.application.routes.draw do
   # ...
+  visualize
+  # ...
+end
+```
 
-  if Rails.env.development?
-    mount RouterVisualizer::Engine, at: "/routes"
-  end
+Then you can navigate to `localhost:3000/routes` to see the visualization.
+
+You can mount the visualizer at whatever route you want:
 
+```ruby
+Rails.application.routes.draw do
+  # ...
+  visualize at: 'nfa_visualization'
   # ...
 end
 ```
 
-Then you can navigate to `localhost:3000/routes` to see the visualization.
+By default, the visualization route will only be defined in development. If for some reason you want the route to be defined in other environments, you can use `groups` option:
+
+```ruby
+Rails.application.routes.draw do
+  # ...
+  visualize groups: ['development', 'staging']
+  # ...
+end
+```
 
 ## What is the point of this?
 
-I want to learn to write gems and rails engines. This is a simple starting point.
+I want to learn to write gems and rails engines. This is a simple starting point.
+
+## License
+
+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/router-visualizer.gemspec

@@ -17,5 +17,5 @@ Gem::Specification.new do |gem|
   gem.files          = `git ls-files`.split($/)
   gem.require_paths  = ['lib']
 
-  gem.add_dependency 'railties', '>= 4.0'
+  gem.add_dependency 'rails', '>= 4.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: router-visualizer
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Joseph Tibbertsma
@@ -11,7 +11,7 @@ cert_chain: []
 date: 2015-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: railties
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -41,6 +41,7 @@ files:
 - config/routes.rb
 - lib/router-visualizer.rb
 - lib/router-visualizer/engine.rb
+- lib/router-visualizer/mapper.rb
 - lib/router-visualizer/version.rb
 - readme.md
 - router-visualizer.gemspec