described_routes 0.2.2 → 0.3.0

data/History.txt

@@ -1,3 +1,10 @@
+== 0.3.0 2009-05-03
+
+* 1 major enhancement:
+  * text output:
+    * rake described_routes:text
+    * curl <app>/described_routes.txt
+
 == 0.2.1 2009-04-29
 
 * 1 minor fix:

data/lib/described_routes.rb

@@ -2,5 +2,5 @@ require 'described_routes/resource_template'
 
 module DescribedRoutes
   # rubygem version
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

data/lib/described_routes/rails_controller.rb

@@ -10,6 +10,7 @@ module DescribedRoutes
       respond_to do |format|
         format.html # index.html.erb
         format.json { render :json => ResourceTemplate.to_json(resource_templates) }
+        format.text { render :text => ResourceTemplate.to_text(resource_templates) }
         format.yaml do
           yaml = resource_templates.to_yaml(resource_templates)
           yaml = yaml.grep(/(name|rel|path_template|uri_template|resources):|^---/).to_s if ['true', '1'].member?(params["short"])
@@ -31,14 +32,15 @@ module DescribedRoutes
       respond_to do |format|
         format.html # show.html.erb
         format.json { render :json => resource_template.to_json }
+        format.text { render :text => resource_template.to_text }
+        format.xml do
+          render :xml => resource_template.to_xml(Builder::XmlMarkup.new(:indent => 2)).target!
+        end
         format.yaml do
           yaml = resource_template.to_yaml
           yaml = yaml.grep(/(name|rel|path_template|uri_template|resources):|^---/).to_s if ['true', '1'].member?(params["short"])
           render :text => yaml
         end
-        format.xml do
-          render :xml => resource_template.to_xml(Builder::XmlMarkup.new(:indent => 2)).target!
-        end
       end
     end
   end

data/lib/described_routes/rails_routes.rb

@@ -27,7 +27,7 @@ module DescribedRoutes
         segs.gsub!(/:[a-zA-Z0-9_]+/) do |match|
           if match == ":id" && controller
             if controller == "described_routes/rails"
-              "{route_name}"
+              ":route_name"
             else
               ":#{controller.singularize.sub(/.*\//, "")}_id"
             end
@@ -69,12 +69,14 @@ module DescribedRoutes
           #   optional_params   #=> ["format"]
           #   action            #=> "edit"
           #   options           #=> ["GET"]
-          #   name              #=>  "edit_user"
+          #   name              #=> "edit_user"
+          #   controller        #=> "rails"
 
           # create a new route hash
           resource = {
             "path_template" => template,
-            "options" => options,
+            "options"       => options,
+            "controller"    => controller
           }
           resource["params"] = params unless params.empty?
           resource["optional_params"] = optional_params unless optional_params.empty?
@@ -104,7 +106,7 @@ module DescribedRoutes
 
       tree = map_key_tree(key_tree) do |key, children|
         resource = resources[key]
-        resource["resource_templates"] = children unless children.empty?
+        
         resource.delete("options") if resource["options"] == [""]
         resource["uri_template"] = base_url + resource["path_template"] if base_url && resource["path_template"]
 
@@ -127,6 +129,17 @@ module DescribedRoutes
           end
         end
     
+        controller = resource["controller"]
+        unless children.empty?
+          resource["resource_templates"] = children.sort_by{|c|
+            [
+              (c["controller"] == controller) ? "" : c["controller"],  # group by controller, parent controller first
+              (c["params"] || []).length,                              # fewer params first
+              c["name"]                                                # make determininistic 
+            ]
+          }
+        end
+
         resource
       end
     end

data/lib/described_routes/resource_template.rb

@@ -170,6 +170,40 @@ module DescribedRoutes
       end
       h
     end
+    
+    def self.to_table(resource_templates, parent_template = nil, t = [], indent = '')
+      resource_templates.inject(t) do |table, resource_template|
+        if parent_template
+          link = (resource_template.rel || '')
+          new_params = resource_template.params - parent_template.params
+        else
+          link = resource_template.name
+          new_params = resource_template.params
+        end
+        link += new_params.map{|p| "{#{p}}"}.join(', ')
+        table << [
+          indent + link,
+          resource_template.name || '',
+          resource_template.options.join(', '),
+          resource_template.uri_template || resource_template.path_template
+        ] 
+        to_table(resource_template.resource_templates, resource_template, t, indent + '  ')
+      end
+      t
+    end
+    
+    def self.to_text(resource_templates)
+      table = self.to_table(resource_templates)
+      
+      0.upto(2) do |i|
+        width = table.map{|row| row[i].length}.max
+        table.each do |row|
+          row[i] = row[i].ljust(width)
+        end
+      end
+      
+      table.map{|row| row.join(' ')}.join("\n") + "\n"
+    end
   end
 end
 

data/lib/tasks/described_routes.rb

@@ -30,6 +30,12 @@ namespace :described_routes do
              DescribedRoutes::RailsRoutes.get_resource_templates
            ).target!
   end
+
+  desc "Describe resource structure in text format"
+  task :text => :environment do
+    puts DescribedRoutes::ResourceTemplate.to_text(
+            DescribedRoutes::RailsRoutes.get_resource_templates)
+  end
   
   # unsupported, for testing
   task :ruby => :environment do

data/test/test_resource_template.rb

@@ -26,6 +26,9 @@ class TestResourceTemplate < Test::Unit::TestCase
     assert_equal("articles", user_articles.rel)
     assert_nil(user_article.rel)
     assert_equal("edit", edit_user_article.rel)
+    
+    assert_equal("/users/{user_id}/articles{-prefix|.|format}", user_articles.path_template)
+    assert_equal("http://localhost:3000/users/{user_id}/articles{-prefix|.|format}", user_articles.uri_template)
 
     assert(user_articles.resource_templates.member?(user_article))
     assert(user_article.resource_templates.member?(edit_user_article))

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: described_routes
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors: 
 - Mike Burrows
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-29 00:00:00 +01:00
+date: 2009-05-03 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency