routler 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 97c46f72c4a9cc001d8000f0da27c56183f9c142
+  data.tar.gz: 8e6e8b1a53e8d213362440189c29d3bad3130ec9
+SHA512:
+  metadata.gz: 007151e9ec3438da6e49ca167b95189883525e2259d1678b194e1e4fedae3ac9059d6eea03490a084c5be80d033be6c5e7577b51bf400100e25ee63a58dff4a7
+  data.tar.gz: a6111473d44f5a68a0fc59c3ef6b274864bfed86bbdaf55805dd8ae24770f0dd163437218a56962b73c468a5caaa016868c734a1b7730c7162a8170aebf45032

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in routler.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jason Madsen
+
+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/README.md

@@ -0,0 +1,35 @@
+# routler
+
+Convert your rails routes to a CSV for reporting, processing, etc.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'routler'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install routler
+
+## Usage
+
+```bash
+
+routler -h
+
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/routler/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task :default => :spec
+rescue LoadError
+  # no rspec available
+end

data/bin/routler

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+
+require 'routler'
+require 'commander/import'
+
+program :version, Routler::VERSION
+program :description, 'convert your rails routes to a CSV for reporting, processing, etc'
+
+default_command :build
+
+command :build do |c|
+  c.syntax = 'routler build filename [options]'
+  c.summary = 'build csv from routes'
+  c.description = <<-EOF
+Builds CSV files for your rail routes. 'filename' is assumed to be a file that
+holds the output of a rake routes run.  If no filename is passed, routler will
+run rake routes in your cwd and use the contents out its output.
+
+build is the default command so you can actually drop the build argument in all
+of the following examples
+EOF
+  c.example 'run rake routes in cwd and output csv to stdout', 'routler build'
+  c.example 'process input_file and write csv to stdout', 'routler build input_file'
+  c.example 'process input_file and write csv to a file named routes.csv', 'routler build input_file -o routes.csv'
+  c.option '--output STRING', 'output file path'
+  c.option '--stats BOOL', 'output stats'
+  c.action do |args, options|
+    options.default output: 'stdout', stats: false
+    formatter = Routler::Formatters::Csv.new
+    cs = Routler::Consumer.new
+    parser = Routler::Parser.new
+    content = formatter.format(parser.parse(cs.load_file(args[0])))
+    Routler::Presenter.new.display content, options.output
+    if options.stats
+      puts Routler::StatBuilder.new(parser).display
+    end
+  end
+end
+

data/lib/routler.rb

@@ -0,0 +1,10 @@
+require "routler/version"
+require "routler/parser"
+require "routler/consumer"
+require "routler/controller"
+require "routler/presenter"
+require "routler/formatters/csv"
+require "routler/stat_builder"
+
+module Routler
+end

data/lib/routler/consumer.rb

@@ -0,0 +1,18 @@
+module Routler
+  class Consumer
+
+    def load_file path=nil
+      path ? IO.read(path) : build_routes
+    end
+
+    def build_routes
+      contents = ''
+      pipe = IO.popen("bundle exec rake routes")
+      while (line = pipe.gets)
+        contents += line
+      end
+      contents
+    end
+
+  end
+end

data/lib/routler/controller.rb

@@ -0,0 +1,17 @@
+module Routler
+  class Controller
+
+    attr_accessor :actions
+    attr_accessor :name
+
+    def initialize(name)
+      @name = name
+      @actions = []
+    end
+
+    def add_action(action)
+      actions.push action unless actions.include? action
+    end
+
+  end
+end

data/lib/routler/formatters/csv.rb

@@ -0,0 +1,25 @@
+require 'csv'
+
+module Routler
+  module Formatters
+    class Csv
+
+      def initialize(controllers=[])
+        @controllers = controllers
+      end
+
+      def format(controllers=nil)
+        @controllers = controllers if controllers
+        CSV.generate do |csv|
+          csv << ['Controller', 'Action']
+          @controllers.each do |c|
+            c.actions.each do |a|
+              csv << [c.name, a]
+            end
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/routler/parser.rb

@@ -0,0 +1,56 @@
+module Routler
+  class Parser
+
+    attr_accessor :controllers
+    attr_accessor :lines
+    attr_accessor :error_lines
+
+    def initialize
+      @controllers = Hash.new
+      @error_lines = []
+      @lines = 0
+    end
+
+    def parse(content)
+      content.each_line do |line|
+        @lines += 1
+        add_controller(parse_line line)
+      end
+      all_controllers
+    end
+
+    def parse_line(line)
+      match = line.match(/^(\s{1,})?(\S*\s\S*\s{1,}\/\S*)(?<cont>.*)\#(?<action>\S*)/)
+      controller = Hash.new
+      begin
+        if match[:cont]
+          controller[:name] = match[:cont].strip
+          controller[:action] = match[:action].strip.chomp
+        end
+      rescue
+        controller[:error] = line
+      end
+      controller
+    end
+
+    def add_controller(controller)
+      if controller.fetch :error, nil
+        @error_lines << controller[:error]
+      else
+        name = controller[:name]
+        action = controller[:action]
+        @controllers[name] = Controller.new(name) if !@controllers.fetch name, nil
+        @controllers[name].add_action action
+      end
+    end
+
+    def all_controllers
+      cont = []
+      @controllers.keys.sort.each do |k|
+        cont << @controllers[k]
+      end
+      cont
+    end
+
+  end
+end

data/lib/routler/presenter.rb

@@ -0,0 +1,13 @@
+module Routler
+  class Presenter
+
+    def display content, output
+      if output == 'stdout'
+        puts content
+      else
+        File.open(output, 'w') {|f| f.write(content)}
+      end
+    end
+
+  end
+end

data/lib/routler/stat_builder.rb

@@ -0,0 +1,26 @@
+module Routler
+  class StatBuilder
+
+    attr_accessor :parser
+
+    def initialize(parser)
+      @parser = parser
+    end
+
+    def display
+      controllers = @parser.all_controllers
+      num_actions = controllers.inject(0) {|sum, c| sum + c.actions.length}
+      output =  "            Stats:\n"
+      output += "=============================\n"
+      output += "Controllers found: #{controllers.length}\n"
+      output += "    Actions found: #{num_actions}\n"
+      output += "     Lines parsed: #{@parser.lines}\n"
+      output += "   Parsing errors: #{@parser.error_lines.length}\n"
+      output += "=============================\n"
+      output += "Parsing error on the following lines:\n"
+      @parser.error_lines.each {|e| output += "#{e}"}
+      output
+    end
+
+  end
+end

data/lib/routler/version.rb

@@ -0,0 +1,3 @@
+module Routler
+  VERSION = "0.0.2"
+end

data/routler.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'routler/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "routler"
+  spec.version       = Routler::VERSION
+  spec.authors       = ["Jason Madsen"]
+  spec.email         = ["knomedia@gmail.com"]
+  spec.summary       = %q{Convert your rails routes to a CSV for reporting, processing, etc.}
+  spec.description   = %q{Convert your rails routes to a CSV for reporting, processing, etc.}
+  spec.homepage      = "https://github.com/knomedia/routler"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "commander"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/spec/routler/consumer_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Routler::Consumer do
+
+  before :each do
+    @consumer = Routler::Consumer.new
+  end
+
+  describe 'load_file' do
+    it 'load route content from a file' do
+      output = @consumer.load_file 'spec/support/routes.txt'
+      expect(output).to match (/conversations#destroy/)
+    end
+  end
+
+end

data/spec/routler/controller_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Routler::Controller do
+
+  before :each do
+    @controller = Routler::Controller.new('testing')
+  end
+
+  it 'should hold a default name' do
+    expect(@controller.name).to eq('testing')
+  end
+  it 'should start with an emptyp actions array' do
+    expect(@controller.actions).to eq([])
+  end
+
+
+  describe 'add_action' do
+    it 'should add actions' do
+      @controller.add_action('index')
+      expect(@controller.actions).to eq(['index'])
+    end
+
+    it 'should not add the same action more than once' do
+      @controller.add_action('index')
+      @controller.add_action('index')
+      expect(@controller.actions).to eq(['index'])
+    end
+  end
+
+end

data/spec/routler/formatters/csv_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Routler::Formatters::Csv do
+
+  before :each do
+    controllers = []
+    ['users', 'auth'].each do |controller|
+      a = Routler::Controller.new controller
+      a.add_action 'index'
+      a.add_action 'update'
+      a.add_action 'destroy'
+      controllers << a
+    end
+    @formatter = Routler::Formatters::Csv.new(controllers)
+  end
+
+  describe '#format' do
+
+    it 'should return the first line as headers' do
+      csv = @formatter.format
+      expect(csv.lines[0].chomp).to eq('Controller,Action')
+    end
+
+    it 'should return a row for each action' do
+      csv = @formatter.format
+      expect(csv.lines[6].chomp).to eq('auth,destroy')
+    end
+
+  end
+
+end

data/spec/routler/parser_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe Routler::Parser do
+
+  before :each do
+    @p = Routler::Parser.new
+  end
+
+  it 'should have controllers, lines and error_lines attrs' do
+    expect(@p.controllers).to eq({})
+    expect(@p.lines).to eq(0)
+    expect(@p.error_lines).to eq([])
+  end
+
+  describe '#parse_line' do
+    it 'should parse a single line' do
+      line = "registration_confirmation GET   /communications/:id/register(.:format)     communication_channels#confirm"
+      output = @p.parse_line line
+      expect(output[:name]).to eq('communication_channels')
+      expect(output[:action]).to eq('confirm')
+    end
+
+    it 'should flag error when line parsing fails' do
+      line = "registration_confirmation GET/communications/:id/register(.:format)communication_channels#confirm"
+      output = @p.parse_line line
+      expect(output[:error]).to eq(line)
+    end
+  end
+
+  describe '#add_controller' do
+    it 'should add invalid parsed objects to error_lines' do
+      line = "registration_confirmation GET/communications/:id/register(.:format)communication_channels#confirm"
+      output = @p.parse_line line
+      @p.add_controller output
+      expect(@p.error_lines.first).to eq(line)
+    end
+
+    it 'should add valid parsed objects to controllers' do
+      line = "registration_confirmation GET   /communications/:id/register(.:format)     communication_channels#confirm"
+      output = @p.parse_line line
+      @p.add_controller(output)
+      expect(@p.controllers['communication_channels'].actions).to eq(['confirm'])
+    end
+
+    it 'should add additional valid parsed objects to a single controllers' do
+      line = "oauth_success GET  /oauth_success(.:format)  users#oauth_success"
+      line2 = "oauth GET  /oauth(.:format)   users#oauth"
+      @p.add_controller(@p.parse_line line)
+      @p.add_controller(@p.parse_line line2)
+      expect(@p.controllers['users'].actions).to eq(['oauth_success', 'oauth'])
+    end
+  end
+
+  describe '#parse' do
+    it 'should parse multiple lines' do
+      content = "oauth_success GET  /oauth_success(.:format)  users#oauth_success"
+      content = content + "\n"
+      content = content + "oauth GET  /oauth(.:format)   users#oauth"
+      @p.parse content
+      expect(@p.controllers['users'].actions).to eq(['oauth_success', 'oauth'])
+    end
+  end
+
+  describe '#all_controllers' do
+    it 'should return a sorted array of controllers' do
+      content = "oauth_success GET  /oauth_success(.:format)  foo#oauth_success"
+      content = content + "\n"
+      content = content + "oauth GET  /oauth(.:format)   bar#oauth"
+      @p.parse content
+      controller_names = @p.all_controllers.map {|c| c.name}
+      expect(controller_names).to eq(['bar', 'foo'])
+    end
+  end
+
+end

data/spec/routler/stat_builder_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe Routler::StatBuilder do
+
+  def controller_double name
+    actions = double()
+    allow(actions).to receive(:length).and_return(2)
+    ct = double()
+    allow(ct).to receive(:name).and_return(name)
+    allow(ct).to receive(:actions).and_return(actions)
+    ct
+  end
+
+  before :each do
+    controllers = []
+    ['users', 'auth'].each {|c| controllers << controller_double(c)}
+    parser = double()
+    allow(parser).to receive(:lines).and_return(50)
+    allow(parser).to receive(:error_lines).and_return(['errorline', 'another errorline'])
+    allow(parser).to receive(:all_controllers).and_return(controllers)
+    @sb = Routler::StatBuilder.new parser
+  end
+
+  it 'should have a parser' do
+    expect(@sb.parser).to_not eq(nil)
+  end
+
+  describe '#display' do
+
+    it 'should display the number of error lines' do
+      expect(@sb.display).to match(/Parsing errors: 2/)
+    end
+
+    it 'should display the number of lines parsed' do
+      expect(@sb.display).to match(/Lines parsed: 50/)
+    end
+
+    it 'should display the number of controllers found' do
+      expect(@sb.display).to match(/Controllers found: 2/)
+    end
+
+    it 'should display the number of actions found' do
+      expect(@sb.display).to match(/Actions found: 4/)
+    end
+  end
+
+end
+

data/spec/routler/version_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Routler do
+
+  it 'should have a version' do
+    expect(!!Routler::VERSION).to be true
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'routler'
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.color = true
+
+  config.order = 'random'
+end

data/spec/support/routes.txt

@@ -0,0 +1,21 @@
+                                         submission_comment DELETE          /submission_comments/:id(.:format)                                                                                              submission_comments#destroy
+                                                      inbox GET             /inbox(.:format)                                                                                                                context#inbox
+                                       oauth_redirect_proxy GET             /oauth/redirect_proxy(.:format)                                                                                                 oauth_proxy#redirect_proxy
+                                       conversations_unread GET             /conversations/unread(.:format)                                                                                                 conversations#index {:redirect_scope=>"unread"}
+                                      conversations_starred GET             /conversations/starred(.:format)                                                                                                conversations#index {:redirect_scope=>"starred"}
+                                         conversations_sent GET             /conversations/sent(.:format)                                                                                                   conversations#index {:redirect_scope=>"sent"}
+                                     conversations_archived GET             /conversations/archived(.:format)                                                                                               conversations#index {:redirect_scope=>"archived"}
+                              conversations_find_recipients GET             /conversations/find_recipients(.:format)                                                                                        search#recipients
+                                          search_recipients GET             /search/recipients(.:format)                                                                                                    search#recipients
+                             conversations_mark_all_as_read POST            /conversations/mark_all_as_read(.:format)                                                                                       conversations#mark_all_as_read
+                                conversations_watched_intro POST            /conversations/watched_intro(.:format)                                                                                          conversations#watched_intro
+                                       conversation_batches GET             /conversations/batches(.:format)                                                                                                conversations#batches
+                                   toggle_new_conversations POST            /conversations/toggle_new_conversations(.:format)                                                                               conversations#toggle_new_conversations
+                                conversation_add_recipients POST            /conversations/:conversation_id/add_recipients(.:format)                                                                        conversations#add_recipients
+                                   conversation_add_message POST            /conversations/:conversation_id/add_message(.:format)                                                                           conversations#add_message
+                               conversation_remove_messages POST            /conversations/:conversation_id/remove_messages(.:format)                                                                       conversations#remove_messages
+                                              conversations GET             /conversations(.:format)                                                                                                        conversations#index
+                                                            POST            /conversations(.:format)                                                                                                        conversations#create
+                                               conversation GET             /conversations/:id(.:format)                                                                                                    conversations#show
+                                                            PUT             /conversations/:id(.:format)                                                                                                    conversations#update
+                                                            DELETE          /conversations/:id(.:format)                                                                                                    conversations#destroy

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: routler
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Jason Madsen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Convert your rails routes to a CSV for reporting, processing, etc.
+email:
+- knomedia@gmail.com
+executables:
+- routler
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/routler
+- lib/routler.rb
+- lib/routler/consumer.rb
+- lib/routler/controller.rb
+- lib/routler/formatters/csv.rb
+- lib/routler/parser.rb
+- lib/routler/presenter.rb
+- lib/routler/stat_builder.rb
+- lib/routler/version.rb
+- routler.gemspec
+- spec/routler/consumer_spec.rb
+- spec/routler/controller_spec.rb
+- spec/routler/formatters/csv_spec.rb
+- spec/routler/parser_spec.rb
+- spec/routler/stat_builder_spec.rb
+- spec/routler/version_spec.rb
+- spec/spec_helper.rb
+- spec/support/routes.txt
+homepage: https://github.com/knomedia/routler
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Convert your rails routes to a CSV for reporting, processing, etc.
+test_files:
+- spec/routler/consumer_spec.rb
+- spec/routler/controller_spec.rb
+- spec/routler/formatters/csv_spec.rb
+- spec/routler/parser_spec.rb
+- spec/routler/stat_builder_spec.rb
+- spec/routler/version_spec.rb
+- spec/spec_helper.rb
+- spec/support/routes.txt
+has_rdoc: