rake_routes_normalizer 0.1.0

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+.geanyprj
+Gemfile.lock
+files/*
+pkg/*

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,16 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'minitest' do
+  # with Minitest::Unit
+  #watch(%r|^test/test_(.*)\.rb|)
+  #watch(%r|^lib/(.*)([^/]+)\.rb|)     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  #watch(%r|^test/test_helper\.rb|)    { "test" }
+
+  # with Minitest::Spec
+  watch(%r|^rake_routes_normalizer\.gemspec|) { "spec" }
+  watch(%r|^lib/rake_routes_normalizer\.rb|)  { "spec" }
+  watch(%r|^lib/(.*)\.rb|)                    { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r|^spec/spec_helper\.rb|)            { "spec" }
+  watch(%r|^spec/(.*)_spec\.rb|)
+end

data/README.markdown

@@ -0,0 +1,26 @@
+Rake Routes Normalizer
+------------------------
+
+rake_routes_normalizer is a utility for migrating routes from Rails 2 to 3.
+It can normalize the printout of `rake routes` so that it's easier to diff
+Rails 2 to 3 routes.
+
+(Yes, Rails 3 was released last year. But better late than never.)
+
+Usage
+=====
+
+In a rails directory:
+
+    rake routes | rake_routes_normalizer
+
+Or if you saved the `rake routes` printout:
+
+    rake_routes_normalizer rake_routes_printout.txt
+
+Install
+=======
+
+    gem install rake_routes_normalizer
+
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/rake_routes_normalizer

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+require 'rake_routes_normalizer'
+
+case ARGV.length
+when 0
+  if $stdin.tty?
+    # e.g. rake_routes_normalizer
+    RakeRoutesNormalizer::App.start # display the help
+  else
+    # rake routes | rake_routes_normalizer
+    RakeRoutesNormalizer::App.new.normalize(ARGF.read)
+  end
+else
+  # e.g. rake_routes_normalizer rake_routes_printout.txt
+  RakeRoutesNormalizer::App.new.normalize(ARGF.read)
+end

data/lib/rake_routes_normalizer.rb

@@ -0,0 +1,11 @@
+require 'hashery/dictionary'
+require 'hashery/key_hash'
+require 'thor'
+require 'valuable'
+
+require "rake_routes_normalizer/version"
+
+require "rake_routes_normalizer/app"
+require "rake_routes_normalizer/exception_with_default_message"
+require "rake_routes_normalizer/route"
+require "rake_routes_normalizer/route_set"

data/lib/rake_routes_normalizer/app.rb

@@ -0,0 +1,11 @@
+module RakeRoutesNormalizer
+  class App < Thor
+    desc "RAKE_PRINTOUT_FILE", "Print the normalized version of RAKE_PRINTOUT_FILE"
+    def normalize(text)
+      table = RouteSet.parse(text).normalize.routes.map do |route|
+        [route.name, route.http_verb, route.url_pattern, route.params.inspect]
+      end
+      print_table table
+    end
+  end
+end

data/lib/rake_routes_normalizer/exception_with_default_message.rb

@@ -0,0 +1,12 @@
+module RakeRoutesNormalizer
+  class ExceptionWithDefaultMessage < Exception
+    attr_reader :options
+    def initialize(options={})
+      @options = options
+      message = options.is_a?(String) ?
+        options :
+        "#{self.class}. Got #{options.inspect}"
+      super(message)
+    end
+  end
+end

data/lib/rake_routes_normalizer/route.rb

@@ -0,0 +1,39 @@
+module RakeRoutesNormalizer
+  class Route < Valuable
+    LINE_REGEX = %r{ *([abcdefghijklmnopqrstuvwxyz_]*) +([ABCDEFGHIJKLMNOPQRSTUVWXYZ]*) +(\S+) +(.*)}
+
+    has_value :http_verb
+    has_value :name
+    has_value :params
+    has_value :url_pattern
+
+    def self.parse(line)
+      new.tap do |result|
+        tokens = line.match(LINE_REGEX)
+        result.name = tokens[1]
+        result.http_verb = tokens[2]
+        result.url_pattern = tokens[3]
+        result.params = eval(tokens[4])
+      end
+    rescue NoMethodError => e
+      raise CannotParseLine.new(:line => line)
+    end
+
+    def <=>(other)
+      [:url_pattern, :http_verb].inject(0) do |result, attribute|
+        result == 0 ? (self.send(attribute) || '') <=> (other.send(attribute) || '') : result
+      end
+    end
+
+    def normalize(options = {})
+      clone.tap do |result|
+        result.http_verb = 'GET' if result.http_verb.to_s =~ /^\s*$/
+        result.name = options[:previous_route].name if result.name =~ /^\s*$/
+        result.params = Dictionary[KeyHash[params || {}]].order_by_key
+      end
+    end
+
+    class CannotParseLine < ExceptionWithDefaultMessage
+    end
+  end
+end

data/lib/rake_routes_normalizer/route_set.rb

@@ -0,0 +1,20 @@
+module RakeRoutesNormalizer
+  class RouteSet < Valuable
+    has_collection :routes
+
+    def self.parse(text)
+      RouteSet.new.tap do |result|
+        result.routes = text.split("\n").reject{|line| line =~ /^\s*$/}.map{|line| Route.parse(line)}
+      end
+    end
+
+    def normalize
+      result = routes.inject(RouteSet.new) do|route_set, route|
+        route_set.routes << route.normalize(:previous_route => route_set.routes.last)
+        route_set
+      end
+      result.routes.sort!
+      result
+    end
+  end
+end

data/lib/rake_routes_normalizer/version.rb

@@ -0,0 +1,3 @@
+module RakeRoutesNormalizer
+  VERSION = "0.1.0"
+end

data/rake_routes_normalizer.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rake_routes_normalizer/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rake_routes_normalizer"
+  s.version     = RakeRoutesNormalizer::VERSION
+  s.authors     = ["George Mendoza"]
+  s.email       = ["gsmendoza@gmail.com"]
+  s.homepage    = ""
+  s.summary     = "Normalize the printout of rake routes so that it's easier to diff"
+  s.description = %q{
+    rake_routes_normalizer is a utility for migrating routes from Rails 2 to 3. It can
+    normalize the printout of rake routes so that it's easier to diff Rails 2 to 3 routes.
+  }
+
+  s.rubyforge_project = "rake_routes_normalizer"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency 'guard-minitest'
+  s.add_development_dependency "minitest"
+  s.add_development_dependency "ruby-debug"
+
+  s.add_runtime_dependency "hashery"
+  s.add_runtime_dependency "thor"
+  s.add_runtime_dependency "valuable"
+end

data/spec/rake_routes_normalizer/route_set_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe RouteSet do
+  describe "parse(text)" do
+    it "can convert one line of text to a route set" do
+      text = %Q{root  /(.:format) {:action=>"default", :controller=>"pages"}}
+
+      route_set = RouteSet.parse(text)
+      route_set.routes.size.must_equal 1
+    end
+
+    it "should ignore blank lines" do
+      text = %Q|root  /(.:format) {:action=>"default", :controller=>"pages"}\n   |
+
+      route_set = RouteSet.parse(text)
+      route_set.routes.size.must_equal 1
+    end
+  end
+
+  describe "normalize" do
+    it "should be a copy of the route set" do
+      route_set = RouteSet.new.tap do |route_set|
+        route_set.routes << Route.new.tap do |route|
+          route.name = 'root'
+          route.http_verb = 'GET'
+          route.url_pattern = '/(.:format)'
+          route.params = {:action=>"default", :controller=>"pages"}
+        end
+      end
+
+      copy = route_set.normalize
+      copy.must_be_instance_of RouteSet
+      copy.wont_be_same_as route_set
+      copy.routes.size.must_equal 1
+
+      route = copy.routes[0]
+      route.wont_be_same_as route_set.routes[0]
+      route.name.must_equal 'root'
+      route.http_verb.must_equal 'GET'
+      route.url_pattern.must_equal '/(.:format)'
+      route.params.inspect.must_equal %q|{"action"=>"default", "controller"=>"pages"}|
+    end
+
+    it "should normalize its route" do
+      route_set = RouteSet.new.tap do |route_set|
+        route_set.routes << Route.new.tap do |route|
+          route.name = 'root'
+          route.http_verb = ''
+          route.url_pattern = '/(.:format)'
+          route.params = {:action=>"default", :controller=>"pages"}
+        end
+      end
+
+      route_set.normalize.routes[0].http_verb.must_equal "GET"
+    end
+
+    it "should normalize a route based the route's previous route" do
+      route_set = RouteSet.new(
+        :routes => [
+          Route.new(:name => 'account'),
+          Route.new(:name => '')
+        ]
+      )
+      copy = route_set.normalize
+      copy.routes.map(&:name).uniq.must_equal ['account']
+    end
+
+    it "should sort the routes" do
+      route_set = RouteSet.new(
+        :routes => [
+          Route.new(:url_pattern => '/airports(.:format)', :http_verb => 'GET'),
+          Route.new(:url_pattern => '/account(.:format)',  :http_verb => 'GET')
+        ]
+      )
+      copy = route_set.normalize
+      copy.routes.map(&:url_pattern).uniq.must_equal ['/account(.:format)', '/airports(.:format)']
+    end
+  end
+end

data/spec/rake_routes_normalizer/route_spec.rb

@@ -0,0 +1,96 @@
+require 'spec_helper'
+
+describe Route do
+  describe "parse(text)" do
+    it "can convert the text to a route set" do
+      text = %q{root GET /(.:format) {:action=>"default", :controller=>"pages"}}
+
+      route = Route.parse(text)
+      route.name.must_equal 'root'
+      route.http_verb.must_equal 'GET'
+      route.url_pattern.must_equal '/(.:format)'
+      route.params.must_equal({:action => "default", :controller => "pages"})
+    end
+
+    it "can convert the text if the text does not have an http verb" do
+      text = %q{root  /(.:format) {:action=>"default", :controller=>"pages"}}
+
+      route = Route.parse(text)
+      route.name.must_equal 'root'
+      route.http_verb.strip.must_equal ''
+      route.url_pattern.must_equal '/(.:format)'
+      route.params.must_equal({:action => "default", :controller => "pages"})
+    end
+
+    it "can convert the text if the text starts with spaces" do
+      text = %q{  root GET /(.:format) {:controller=>"pages", :action=>"default"}}
+
+      route = Route.parse(text)
+      route.name.must_equal 'root'
+      route.http_verb.must_equal 'GET'
+      route.url_pattern.must_equal '/(.:format)'
+      route.params.must_equal({:action => "default", :controller => "pages"})
+    end
+
+    it "can convert the text if the text does not have an name" do
+      text = %q{  PUT    /account/change_password(.:format)  {:controller=>"users", :action=>"change_password"}}
+
+      route = Route.parse(text)
+      route.name.must_equal ''
+      route.http_verb.must_equal 'PUT'
+      route.url_pattern.must_equal '/account/change_password(.:format)'
+      route.params.must_equal({:controller=>"users", :action=>"change_password"})
+    end
+  end
+
+  describe "normalize(options)" do
+    it "should return a copy of the route" do
+      route = Route.new.tap do |route|
+        route.name = 'root'
+        route.http_verb = 'GET'
+        route.url_pattern = '/(.:format)'
+        route.params = {:action=>"default", :controller=>"pages"}
+      end
+
+      copy = route.normalize
+      copy.must_be_instance_of Route
+      copy.wont_be_same_as route
+    end
+
+    it "should set the http_verb to GET if it is blank" do
+      route = Route.new(:http_verb => '')
+      route.normalize.http_verb.must_equal 'GET'
+    end
+
+    it "should set the name to the options[:previous_route]'s name if it is blank" do
+      previous_route = Route.new(:name => 'account_path')
+      route = Route.new(:name => '')
+      route.normalize(:previous_route => previous_route).name.must_equal 'account_path'
+    end
+
+    it "should sort the route's params by key" do
+      route = Route.new(:params => {:controller=>"users", :action=>"edit_password", :protocol=>nil})
+      route.normalize.params.inspect.must_equal %q|{"action"=>"edit_password", "controller"=>"users", "protocol"=>nil}|
+    end
+  end
+
+  describe "<=>(other)" do
+    it "should sort the route and other's url_pattern" do
+      routes = [
+        Route.new(:url_pattern => '/account(.:format)',  :http_verb => 'GET'),
+        Route.new(:url_pattern => '/airports(.:format)', :http_verb => 'GET')
+      ]
+
+      (routes[0] <=> routes[1]).must_be :<, 0
+    end
+
+    it "should compare the route and other's url_pattern by http_verb, if the url patterns are the same" do
+      routes = [
+        Route.new(:url_pattern => '/account(.:format)', :http_verb => 'GET'),
+        Route.new(:url_pattern => '/account(.:format)', :http_verb => 'PUT')
+      ]
+
+      (routes[0] <=> routes[1]).must_be :<, 0
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'minitest/autorun'
+require 'ruby-debug'
+
+require 'rake_routes_normalizer'
+
+include RakeRoutesNormalizer

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification 
+name: rake_routes_normalizer
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- George Mendoza
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-12-07 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: guard-minitest
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: hashery
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: valuable
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id006
+description: "\n    rake_routes_normalizer is a utility for migrating routes from Rails 2 to 3. It can\n    normalize the printout of rake routes so that it's easier to diff Rails 2 to 3 routes.\n  "
+email: 
+- gsmendoza@gmail.com
+executables: 
+- rake_routes_normalizer
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Guardfile
+- README.markdown
+- Rakefile
+- bin/rake_routes_normalizer
+- lib/rake_routes_normalizer.rb
+- lib/rake_routes_normalizer/app.rb
+- lib/rake_routes_normalizer/exception_with_default_message.rb
+- lib/rake_routes_normalizer/route.rb
+- lib/rake_routes_normalizer/route_set.rb
+- lib/rake_routes_normalizer/version.rb
+- rake_routes_normalizer.gemspec
+- spec/rake_routes_normalizer/route_set_spec.rb
+- spec/rake_routes_normalizer/route_spec.rb
+- spec/spec_helper.rb
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: rake_routes_normalizer
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Normalize the printout of rake routes so that it's easier to diff
+test_files: []
+