described_routes 0.3.5 → 0.3.6

data/History.txt

@@ -1,6 +1,6 @@
+== 0.3.6 2009-05-12
 
-* Framework-neutral metadata describing Rails routes in JSON, YAML, XML and plain text formats.
-* Please comment on the roadmap at http://positiveincline.com/?p=213
+* add ResourceTemplate#positional_params
 
 == 0.3.5 2009-05-06
 

data/README.rdoc

@@ -1,8 +1,8 @@
 = described_routes README
 
-Framework-neutral descriptions of Rails routes in JSON, YAML, XML and plain text formats.
+Framework-neutral descriptions of Rails routes in JSON, YAML, XML and plain text formats.  Also the home (for now at least) of the ResourceTemplate class.
 
-Please comment on the roadmap at http://positiveincline.com/?p=213
+Note to reader: you are invited to comment on the roadmap at http://positiveincline.com/?p=213
 
 == DESCRIPTION:
 
@@ -56,8 +56,7 @@ The text output looks like this:
         edit             edit_user_profile      GET                    /users/{user_id}/profile/edit{-prefix|.|format}
         new              new_user_profile       GET                    /users/{user_id}/profile/new{-prefix|.|format}
 
-You can specify the base URL of your application by appending the following 
-parameter "BASE=http://..." to the rake command line.  The output will then 
+You can specify the base URL of your application by appending "BASE=http://..." to the rake command line.  The output will then 
 include full URI templates.
 
 The JSON, XML and YAML formats (of which the YAML is the most readable) are designed for program consumption. 

data/lib/described_routes.rb

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

data/lib/described_routes/resource_template.rb

@@ -171,6 +171,7 @@ module DescribedRoutes
       h
     end
     
+    # for #to_text
     def self.to_table(resource_templates, parent_template = nil, t = [], indent = '')
       resource_templates.inject(t) do |table, resource_template|
         if parent_template
@@ -192,6 +193,7 @@ module DescribedRoutes
       t
     end
     
+    # text report
     def self.to_text(resource_templates)
       table = self.to_table(resource_templates)
       
@@ -204,6 +206,16 @@ module DescribedRoutes
       
       table.map{|row| row.join(' ')}.join("\n") + "\n"
     end
+    
+    # returns params and any optional_params in order, removing the parent's params
+    def positional_params(parent)
+      all_params = params + optional_params
+      if parent
+        all_params - parent.params
+      else
+        all_params
+      end
+    end
   end
 end
 

data/test/test_resource_template.rb

@@ -4,7 +4,6 @@ require 'described_routes/resource_template'
 class TestResourceTemplate < Test::Unit::TestCase
   attr_reader :json, :resource_templates, :resource_templates_by_name, :user_articles, :user_article, :edit_user_article
   
-  
   def setup
     @json ||= File.read(File.dirname(__FILE__) + "/fixtures/described_routes_test.json")
     @resource_templates = DescribedRoutes::ResourceTemplate.parse_json(json)
@@ -45,4 +44,9 @@ class TestResourceTemplate < Test::Unit::TestCase
         JSON.parse(json),
         YAML.load(DescribedRoutes::ResourceTemplate.to_yaml(resource_templates)))
   end
+  
+  def test_positional_params
+    assert_equal(["user_id", "article_id", "format"], user_article.positional_params(nil))
+    assert_equal(["article_id", "format"], user_article.positional_params(user_articles))
+  end
 end

metadata

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