pretty_routes 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f84cfbb4b6608a21ae01c2d4c57d87f18d119006
+  data.tar.gz: 2223f52b9d7df19ecab2e7017ec630feae9f0c47
+SHA512:
+  metadata.gz: 04a137881e22b96dcefbef7b49424c8bb27cefaee5ca15e363d7983387280adcaf3aa3636070dcd743f08fd00f9b93851dc460124c48fb2bc526cdc9eb0fda84
+  data.tar.gz: bd8e17d021988bc6744423defb5d8e8d200bd136734ad4ed1790d458708f638991c7b7973b9ff645d9c316b5d5294dacaf6758350bc5b3723e2c3b95373a3542

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Schneems
+
+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

@@ -0,0 +1,25 @@
+# PrettyRoutes [![Build Status](https://travis-ci.org/Angelmmiguel/pretty_routes.svg?branch=master)](https://travis-ci.org/Angelmmiguel/pretty_routes)
+
+Working with Rails routes won't be a nightmare. This is PrettyRoutes.
+
+## Install
+
+Add this to the development group in your Gemfile:
+
+```ruby
+group :development do
+  gem 'pretty_routes'
+end
+```
+
+Then run `bundle install` and you're ready to start
+
+## Use
+
+Visit `/rails/routes` in your app and you'll see your routes. It's that simple.
+
+## About
+
+PrettyRoutes is based on [Sextant v0.2.4](https://github.com/schneems/sextant).
+
+PrettyRoutes gem is released under the MIT license. By [@irbrocks](https://twitter.com/irbrocks) ;)

data/Rakefile

@@ -0,0 +1,33 @@
+# encoding: UTF-8
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development, :test)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+
+require 'rake'
+require 'rdoc/task'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PrettyRoutes'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

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

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

data/app/assets/javascripts/pretty_routes/pretty_routes.js

@@ -0,0 +1,28 @@
+function each(elems, func) {
+  if (!elems instanceof Array) { elems = [elems]; }
+  for (var i = elems.length; i--; ) {
+    func(elems[i]);
+  }
+}
+
+function setValOn(elems, val) {
+  each(elems, function(elem) {
+    elem.innerHTML = val;
+  });
+}
+
+function onClick(elems, func) {
+  each(elems, function(elem) {
+    elem.onclick = func;
+  });
+}
+
+// Enables functionality to toggle between `_path` and `_url` helper suffixes
+function setupRouteToggleHelperLinks() {
+  var toggleLinks = document.querySelectorAll('#route_table [data-route-helper]');
+  onClick(toggleLinks, function(){
+    var helperTxt   = this.getAttribute("data-route-helper");
+    var helperElems = document.querySelectorAll('[data-route-name] span.helper');
+    setValOn(helperElems, helperTxt);
+  });
+}

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

@@ -0,0 +1,54 @@
+/*
+ * $fg_color:       #333;
+ * $bg_color:       #FFF;
+ * $fg_color_hover: $bg_color;
+ * $bg_color_hover: $fg_color;
+ * $table_color:    #999;
+ */
+
+body {
+  background-color: #FFF;
+  color:            #333;
+}
+
+body, p, ol, ul, td {
+  font-family:  helvetica, verdana, arial, sans-serif;
+  font-size:    13px;
+  line-height:  18px;
+}
+
+a,
+a:visited {
+  color: #333;
+}
+a:hover {
+  background-color: #333;
+  color:            #FFF;
+}
+
+table.route_table {
+  border: 1px solid #999;
+  border-spacing:   0;
+  border-collapse:  collapse;
+}
+table.route_table th {
+  border-bottom: 1px solid #999;
+  border: 1px solid #999;
+}
+table.route_table tbody tr:nth-child(even) {
+  background: #EEE
+}
+table.route_table tbody tr:nth-child(odd) {
+  background: #FFF
+}
+table.route_table tbody tr:hover {
+      background-color: #333;
+      color:            #FFF;
+}
+table.route_table td {
+    padding: 3px 10px;
+}
+table.route_table td+td {
+  border-left: 1px solid #DDD;
+}
+

data/app/controllers/pretty_routes/application_controller.rb

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

data/app/controllers/pretty_routes/routes_controller.rb

@@ -0,0 +1,24 @@
+module PrettyRoutes
+  class RoutesController < PrettyRoutes::ApplicationController
+    layout 'pretty_routes/application'
+
+    before_filter :require_local!
+
+    def index
+      @routes = PrettyRoutes.format_routes
+    end
+
+    private
+
+    def require_local!
+      return if local_request?
+      render text: '<p>For security purposes, this information is only' \
+                   'available to local requests.</p>',
+             status: :forbidden
+    end
+
+    def local_request?
+      Rails.application.config.consider_all_requests_local || request.local?
+    end
+  end
+end

data/app/views/layouts/pretty_routes/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8" />
+  <title>Routes</title>
+  <%= stylesheet_link_tag "pretty_routes/application" %>
+  <%= javascript_include_tag "pretty_routes/application" %>
+  <%= csrf_meta_tags %>
+  </head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/pretty_routes/routes/_route.html.erb

@@ -0,0 +1,16 @@
+<tr class='route_row' data-helper='path'>
+  <td data-route-name='<%= route[:name] %>'>
+    <% if route[:name].present? %>
+      <%= route[:name] %><span class='helper'>_path</span>
+    <% end %>
+  </td>
+  <td data-route-verb='<%= route[:verb] %>'>
+    <%= route[:verb] %>
+  </td>
+  <td data-route-path='<%= route[:path] %>'>
+    <%= route[:path] %>
+  </td>
+  <td data-route-reqs='<%= route[:reqs] %>'>
+    <%= route[:reqs] %>
+  </td>
+</tr>

data/app/views/pretty_routes/routes/_route_wrapper.html.erb

@@ -0,0 +1,25 @@
+<table id='route_table' class='route_table'>
+  <thead>
+    <tr>
+      <th>
+        Helper (
+        <%= link_to "Path", "#", 'data-route-helper' => '_path',
+                    title: "Returns a relative path (without the http or domain)" %>
+        /
+        <%= link_to "Url", "#", 'data-route-helper' => '_url',
+                    title: "Returns an absolute url (with the http and domain)" %>
+        )
+      </th>
+      <th>HTTP Verb</th>
+      <th>Path</th>
+      <th>Controller#Action</th>
+    </tr>
+  </thead>
+  <tbody>
+    <%= yield %>
+  </tbody>
+</table>
+
+<script type='text/javascript'>
+  setupRouteToggleHelperLinks();
+</script>

data/app/views/pretty_routes/routes/index.html.erb

@@ -0,0 +1,11 @@
+<h2>
+  Routes by PrettyRoutes!
+</h2>
+
+<p>
+  Routes match in priority from top to bottom
+</p>
+
+<%= render layout: "route_wrapper" do %>
+  <%= render partial: "route", collection: @routes %>
+<% end %>

data/lib/pretty_routes/engine.rb

@@ -0,0 +1,8 @@
+module PrettyRoutes
+  #
+  # Create an isloated space for PrettyRoutes
+  #
+  class Engine < Rails::Engine
+    isolate_namespace PrettyRoutes
+  end
+end

data/lib/pretty_routes/version.rb

@@ -0,0 +1,6 @@
+#
+# Version of the Gem.
+#
+module PrettyRoutes
+  VERSION = '0.0.1'
+end

data/lib/pretty_routes.rb

@@ -0,0 +1,24 @@
+require 'pretty_routes/engine'
+
+#
+# Base module of pretty routes
+#
+module PrettyRoutes
+  begin
+    require 'rails/application/route_inspector'
+    ROUTE_INSPECTOR = Rails::Application::RouteInspector.new
+  rescue LoadError
+    require 'action_dispatch/routing/inspector'
+    ROUTE_INSPECTOR = ActionDispatch::Routing::RoutesInspector.new([])
+  end
+
+  def self.format_routes(routes = all_routes)
+    # ActionDispatch::Routing::RoutesInspector.new.collect_routes(_routes.routes)
+    ROUTE_INSPECTOR.send :collect_routes, routes
+  end
+
+  def self.all_routes
+    Rails.application.reload_routes!
+    Rails.application.routes.routes
+  end
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: pretty_routes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Angel M de Miguel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: poltergeist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: PrettyRoutes is a Rails engine to display and interact with routes of
+  your application
+email:
+- angel@laux.es
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/pretty_routes/application.js
+- app/assets/javascripts/pretty_routes/pretty_routes.js
+- app/assets/stylesheets/pretty_routes/application.css
+- app/controllers/pretty_routes/application_controller.rb
+- app/controllers/pretty_routes/routes_controller.rb
+- app/views/layouts/pretty_routes/application.html.erb
+- app/views/pretty_routes/routes/_route.html.erb
+- app/views/pretty_routes/routes/_route_wrapper.html.erb
+- app/views/pretty_routes/routes/index.html.erb
+- lib/pretty_routes.rb
+- lib/pretty_routes/engine.rb
+- lib/pretty_routes/version.rb
+homepage: http://irb.rocks
+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.8
+signing_key: 
+specification_version: 4
+summary: PrettyRoutes is a Rails engine to display and interact with routes of your
+  application
+test_files: []