rake_unused_routes 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d8ccf126f687fa1e50d22d96fb33aea9bd475179
-  data.tar.gz: bdfb2c94efdef7c19f9c06edb2f25e17bce0844c
+  metadata.gz: 1a17210f5e8b7f3da8f29b2a9ad27ad0497a09a8
+  data.tar.gz: 9dca0d92eefe227571d90ddcaa68223f114b248c
 SHA512:
-  metadata.gz: 65cfa2206a7db65743ccdf448a347e267c936b2fda4ccb4ef30777ad01c08fb6a4d8c9c62d05142ca140af2865c2f5cb0f0d1591a70413565a3f966918b49ecf
-  data.tar.gz: 4b8caa70797290cf773ab19fb1853cc8c7ee6d9acfa3420d26d05fae7df96122f155e4727e9538fb0ae413b3b33fe0dbae86a9167acad0d8b3abad8b69025b3f
+  metadata.gz: da5f8d78ce6a174a3e215a4171a9356aa25aafb10497fdf9ba12c5de518d1ea76e1aa70e40c8454f0e7b38f350b80c3cc2494d391b38b79ad0d9f55204aa6797
+  data.tar.gz: 9b322bd612de174665527b188be86b3b1c5b7e5dd0f9e00418224c180d995e5d7373614442514567d8b4900b19d58129566c3c6121da9bceb480b865a46264d6

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in rake_unused_routes.gemspec
 gemspec
+gem "simplecov"
+gem "codeclimate-test-reporter", "~> 1.0.0"

data/README.md

@@ -1,8 +1,12 @@
+[![CircleCI](https://circleci.com/gh/viewthespace/rake_unused_routes.svg?style=svg)](https://circleci.com/gh/viewthespace/rake_unused_routes)
+[![Code Climate](https://codeclimate.com/repos/585f1177508ac60076005e46/badges/bfd930692c43034fec1f/gpa.svg)](https://codeclimate.com/repos/585f1177508ac60076005e46/feed)
+[![Test Coverage](https://codeclimate.com/repos/585f1177508ac60076005e46/badges/bfd930692c43034fec1f/coverage.svg)](https://codeclimate.com/repos/585f1177508ac60076005e46/coverage)
+
 # RakeUnusedRoutes
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rake_unused_routes`. To experiment with that code, run `bin/console` for an interactive prompt.
+Identify unused routes within your rails routes.rb file by reading in a csv file of all controllers hit within a given time period.  The csv file can most easily be generated with New Relic.  
 
-TODO: Delete this and the text above, and describe your gem
+This gem is inspired by [newrelic_route_check](https://github.com/livingsocial/newrelic_route_check)
 
 ## Installation
 
@@ -16,13 +20,62 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
-
-    $ gem install rake_unused_routes
 
 ## Usage
 
-TODO: Write usage instructions here
+In order to see unused routes, we need an export of all controller actions that are still in use.  An easy way of generating the export is with either the basic NewRelic RPM or NewRelic Insights.
+
+### From a NewRelic RPM Web Transactions CSV
+
+#### Generate the CSV
+
+The easiest way to generate a CSV file is by exporting all controllers from the all transactions page within newrelic.  To get there:
+
+1. Navigate to Transactions
+1. Select "Last 7 Days ending now" within time picker
+1. Pick type Web
+1. Click "Show all transactions table"
+1. Click "Export as CSV" 
+
+![New Relic Transactions](https://vts-monosnap.s3.amazonaws.com/Transactions_-_VTS_Production_-_New_Relic_2016-12-22_17-48-43__eprql.png)
+
+Copy exported file to $RAILS_ROOT/tmp/controller_summary.csv
+
+#### Generate unused_routes
+
+Run:
+
+```
+rake unused_routes
+```
+### From a NewRelic Insights export
+
+The advantage of using NewRelic Insights export is that dependening on your retention policies, Insights can generate a report for a much great length of time than 7 days.  Our current NewRelic policies allow for pulling usage data from 9 weeks ago.
+
+#### Generate the CSV
+
+Navigate to Insights and run the following query:
+
+```sql
+SELECT count(*) 
+from Transaction 
+where transactionSubType ='Controller' 
+facet name 
+since 9 weeks ago 
+limit 1000
+```
+
+Export the results to a csv file:
+
+![Insight Export to CSV](https://vts-monosnap.s3.amazonaws.com/Insights_Home_2016-12-26_15-06-52__icat6.png)
+
+Copy the results to $RAILS_ROOT/tmp/insights_controllers.csv .
+
+Then run:
+
+```
+rake unused_routes:from_insights
+```
 
 ## Development
 
@@ -32,7 +85,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rake_unused_routes. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/viewthespace/rake_unused_routes. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License

data/lib/rake_unused_routes.rb

@@ -1,4 +1,5 @@
 require "rake_unused_routes/version"
+require "rake_unused_routes/insights_formatter"
 require 'csv'
 
 class RakeUnusedRoutes
@@ -9,14 +10,14 @@ class RakeUnusedRoutes
     end
   end
 
-  def initialize app, used_routes: []
+  def initialize app, used_actions: []
     @app = app
-    @used_routes = used_routes
+    @used_actions = used_actions
   end
 
   def unused_routes
     routes.reject do |route|
-      @used_routes.include?( newrelic_formatting(route) )
+      @used_actions.include?( newrelic_formatting(route) )
     end
   end
 
@@ -43,7 +44,7 @@ class RakeUnusedRoutes
   end
 
   def routes
-    Rails.application.routes.routes.select{ |route| route.requirements[:controller] }.
+    @app.routes.routes.select{ |route| route.requirements[:controller] }.
         reject {|r| r.requirements[:controller].starts_with? 'rails/' }
   end
 

data/lib/rake_unused_routes/insights_formatter.rb

@@ -0,0 +1,43 @@
+class RakeUnusedRoutes
+
+  class InsightsFormatter
+
+    class << self
+
+      def convert_from_insights!
+        FileUtils.mkdir_p tmp_dir_path
+        File.open("#{tmp_dir_path}/controller_summary.csv", 'w+') do |file|
+          file.write csv_file
+        end
+      end
+
+      private
+
+      def csv_file
+        CSV.generate do |csv|
+          csv << [ 'Action' ]
+          actions_from_insights.each{ |action| csv << [ action ] }
+        end
+      end
+
+      def actions_from_insights
+        CSV.read(insights_csv_file_path).
+          drop(1).map(&:first).reject{|r| r=~/Middleware/ }.
+          map{ |r| r.sub('Controller/', '') }.
+          map{|r| "#{r.split('/')[0..-2].
+          map{|r| r.camelize}.join('::')}Controller##{r.split('/').last}" }.sort
+      end
+
+      def tmp_dir_path
+        './tmp'
+      end
+
+      def insights_csv_file_path
+        ENV.fetch('INSIGHTS_CONTROLLERS', './tmp/insights_controllers.csv')
+      end
+
+    end
+
+  end
+
+end

data/lib/rake_unused_routes/version.rb

@@ -1,3 +1,3 @@
 class RakeUnusedRoutes
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/tasks/unused_routes.rake

@@ -1,7 +1,18 @@
+namespace :unused_routes do
+
+  desc 'Generates unused_routes from insights'
+  task :from_insights do
+    RakeUnusedRoutes::InsightsFormatter.convert_from_insights!
+    Rake::Task['unused_routes'].invoke
+  end
+
+end
+
 desc 'Prints out unused routes and unreachable action methods'
 task :unused_routes => :environment do
-  unused_actions =
+  used_actions =
     RakeUnusedRoutes.actions_from_newrelic ENV.fetch('CONTROLLER_SUMMARY', './tmp/controller_summary.csv')
-  puts RakeUnusedRoutes.new(unused_actions).formatted_unused_routes
+  puts RakeUnusedRoutes.new(Rails.application, used_actions: used_actions).formatted_unused_routes
 end
 
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rake_unused_routes
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Karl Baum
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-22 00:00:00.000000000 Z
+date: 2016-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -99,6 +99,7 @@ files:
 - bin/console
 - bin/setup
 - lib/rake_unused_routes.rb
+- lib/rake_unused_routes/insights_formatter.rb
 - lib/rake_unused_routes/version.rb
 - lib/tasks/unused_routes.rake
 - rake_unused_routes.gemspec