routes_page 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '09e9a33baf3700143864498f3511398803f5a959c6547273d67478d11361c79d'
+  data.tar.gz: 3bcfdc805bc2dcafeeebf14dcf2170aba17b3e0647ada0e978491c65947e6cac
+SHA512:
+  metadata.gz: 7ca5106bc32fefa7d0ea813524a22fc4ddc69e620435977fe029a2072ebab7282752df05933c9e83e607eb9d631ef3487446c508e6200d9a02bec31c8550f537
+  data.tar.gz: e06b48de29b7825a67e0aa8276577a9f3ec39661d002f325ccf75dd08dbe2b090203ca0c146f962a0522c14967a175ddc3c612f7a2c049004ba9e32acf7e49c6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Jason Heylon
+
+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,28 @@
+# RoutesPage
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'routes_page'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install routes_page
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,36 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RoutesPage'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/config/routes_page_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/routes_page .js
+//= link_directory ../stylesheets/routes_page .css

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

@@ -0,0 +1,13 @@
+// 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, vendor/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_tree .

data/app/assets/javascripts/routes_page/routes.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

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

@@ -0,0 +1,20 @@
+/*
+ * 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, vendor/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
+ */
+
+body {
+  background-color: #FFF;
+  color:            #333;
+}

data/app/assets/stylesheets/routes_page/routes.css

@@ -0,0 +1,33 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/
+
+h3{
+  text-align: center;
+}
+
+.routes-title{
+  text-align: center;
+  background-color: #333;
+  color: #fff;
+}
+
+.routes-table{
+  border-spacing: 0;
+  width: 100%;
+  line-height: 25px;
+  text-align: left;
+}
+
+.routes-table thead th{
+  border-bottom: 3px solid #e1e1e1;
+}
+
+.routes-table tbody tr:nth-child(even) {
+  background: #DDD
+}
+
+.routes-table tbody tr:nth-child(odd) {
+  background: #FFF
+}

data/app/controllers/routes_page/application_controller.rb

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

data/app/controllers/routes_page/routes_controller.rb

@@ -0,0 +1,9 @@
+require_dependency "routes_page/application_controller"
+
+module RoutesPage
+  class RoutesController < ApplicationController
+    def index
+      @routes = RoutesPage.format_routes
+    end
+  end
+end

data/app/helpers/routes_page/application_helper.rb

@@ -0,0 +1,4 @@
+module RoutesPage
+  module ApplicationHelper
+  end
+end

data/app/helpers/routes_page/routes_helper.rb

@@ -0,0 +1,4 @@
+module RoutesPage
+  module RoutesHelper
+  end
+end

data/app/jobs/routes_page/application_job.rb

@@ -0,0 +1,4 @@
+module RoutesPage
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/routes_page/application_mailer.rb

@@ -0,0 +1,6 @@
+module RoutesPage
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/routes_page/application_record.rb

@@ -0,0 +1,5 @@
+module RoutesPage
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

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

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Routes page</title>
+  <%= stylesheet_link_tag    "routes_page/application", media: "all" %>
+  <%= javascript_include_tag "routes_page/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

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

@@ -0,0 +1,81 @@
+<h3>
+  List of Routes
+</h3>
+
+<div class="routes">
+  <div class="routes-title rails-route">
+    Rails routes
+  </div>
+  <table class="routes-table">
+    <thead>
+      <tr>
+        <th>name</th>
+        <th>verb</th>
+        <th>path</th>
+        <th>controller#actin</th>
+      </tr>
+    </thead>
+    <tobdy>
+      <% @routes[:rails_routes].each do |route| %>
+        <tr class="route">
+          <td>
+            <% if route[:name].present? %>
+              <%= route[:name] %>_path
+            <% end %>
+          </td>
+          <td>
+            <%= route[:verb] %>
+          </td>
+          <td>
+            <%= route[:path] %>
+          </td>
+          <td>
+            <%= route[:reqs] %>
+          </td>
+        </tr>
+      <% end %>
+    </tobdy>
+  </table>
+</div>
+
+<br>
+<% if @routes[:grape_routes].any? %>
+  <div class="routes">
+    <div class="routes-title rails-route">
+      Grape routes
+    </div>
+    <table class="routes-table">
+      <thead>
+        <tr>
+          <th>namespace</th>
+          <th>version</th>
+          <th>verb</th>
+          <th>path</th>
+          <th>params</th>
+        </tr>
+      </thead>
+      <tobdy>
+        <% @routes[:grape_routes].each do |route| %>
+          <tr class="route">
+            <td>
+              <%= route[:namespace] %>
+            </td>
+            <td>
+              <%= route[:version] %>
+            </td>
+            <td>
+              <%= route[:verb] %>
+            </td>
+            <td>
+              <%= route[:path] %>
+            </td>
+            <td>
+              <%= route[:params] %>
+            </td>
+          </tr>
+        <% end %>
+      </tobdy>
+    </table>
+  </div>
+
+<% end %>

data/config/routes.rb

@@ -0,0 +1,10 @@
+# RoutesPage::Engine.routes.draw do
+#   root to: 'routes#index'
+# end
+#
+#
+
+Rails.application.routes.draw do
+  mount RoutesPage::Engine => "rails/routes_page"
+  get "rails/routes_page" => "routes_page/routes#index"
+end

data/lib/routes_page/engine.rb

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

data/lib/routes_page/version.rb

@@ -0,0 +1,3 @@
+module RoutesPage
+  VERSION = '0.1.0'
+end

data/lib/routes_page.rb

@@ -0,0 +1,53 @@
+require "routes_page/engine"
+
+module RoutesPage
+  require 'action_dispatch/routing/inspector'
+  RAILS_ROUTE_INSPECTOR = ActionDispatch::Routing::RoutesInspector.new([])
+
+  def self.format_routes(routes = all_routes)
+    routes_formated = RAILS_ROUTE_INSPECTOR.send :collect_routes, routes
+
+    grape_routes_formated = format_grape_routes(find_grape_routes(routes))
+    {
+      rails_routes: routes_formated,
+      grape_routes: grape_routes_formated
+    }
+  end
+
+  def self.format_grape_routes(grape_routes)
+    return [] if grape_routes.empty?
+
+    grape_routes_formated = []
+    grape_routes.each do |grape_route|
+      grape_routes_formated += grape_route.routes.collect do |gr|
+        {
+          namespace: gr.namespace,
+          verb: gr.options[:method],
+          path: gr.pattern.path,
+          params: gr.params,
+          version: gr.version
+        }
+      end
+    end
+    grape_routes_formated
+  end
+
+  def self.find_grape_routes(routes)
+    route_wrappers = routes.collect { |route| ActionDispatch::Routing::RouteWrapper.new(route) }
+    # grape rails route in array
+    routes_with_grape = route_wrappers.select {|r| (r.app.app.superclass rescue nil).to_s == 'Grape::API' }
+    return [] if routes_with_grape.empty?
+
+    routes_with_grape.collect { |r| r.app.app }
+  end
+
+  def self.all_routes
+    Rails.application.reload_routes!
+    Rails.application.routes.routes
+  end
+
+  def self.enable_grape_routes!
+    @enable_grape = true
+  end
+
+end

data/lib/tasks/routes_page_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :routes_page do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: routes_page
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jason Heylon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+- !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'
+- !ruby/object:Gem::Dependency
+  name: grape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.1'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.16'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.16'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.16.1
+description: Simple web page for rails routes and grape routes display
+email:
+- jasonheylon@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/routes_page_manifest.js
+- app/assets/javascripts/routes_page/application.js
+- app/assets/javascripts/routes_page/routes.js
+- app/assets/stylesheets/routes_page/application.css
+- app/assets/stylesheets/routes_page/routes.css
+- app/controllers/routes_page/application_controller.rb
+- app/controllers/routes_page/routes_controller.rb
+- app/helpers/routes_page/application_helper.rb
+- app/helpers/routes_page/routes_helper.rb
+- app/jobs/routes_page/application_job.rb
+- app/mailers/routes_page/application_mailer.rb
+- app/models/routes_page/application_record.rb
+- app/views/layouts/routes_page/application.html.erb
+- app/views/routes_page/routes/index.html.erb
+- config/routes.rb
+- lib/routes_page.rb
+- lib/routes_page/engine.rb
+- lib/routes_page/version.rb
+- lib/tasks/routes_page_tasks.rake
+homepage: https://github.com/JasonHeylon/routes_page
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Simple web page for rails routes and grape routes display
+test_files: []