described_routes 0.0.3 → 0.1.0

data/lib/described_routes.rb

@@ -2,7 +2,7 @@ require 'described_routes/resource_template'
 
 module DescribedRoutes
   # rubygem version
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
   
   # Convert an array of ResourceTemplate objects to array of hashes equivalent to their JSON or YAML representations
   def self.to_parsed(resource_templates)

data/lib/described_routes/rails_routes.rb

@@ -81,7 +81,7 @@ module DescribedRoutes
     #
     # Takes the routes from Rails and produces the required tree structure.
     #
-    def self.get_resources
+    def self.get_resources(base_url = nil)
       resources = get_rails_resources
       resources.delete_if{|k, v| v["name"].blank? or v["name"] =~ /^formatted/}
 
@@ -93,6 +93,7 @@ module DescribedRoutes
         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"]
 
         # compare parent and child names, and populate "rel" with either
         # 1) a prefix (probably an action name)

data/lib/described_routes/resource_template.rb

@@ -12,6 +12,9 @@ module DescribedRoutes
     # Collection members generally don't need a rel as they are identified by their params
     attr_reader :rel
     
+    # A template for generating URIs.
+    attr_reader :uri_template
+    
     # A template for generating paths relative to the application's base.
     attr_reader :path_template
     
@@ -28,8 +31,8 @@ module DescribedRoutes
     attr_reader :resource_templates
     
     # Initialize a ResourceTemplate.  See the attribute descriptions above for explanations of the parameters.
-    def initialize(name, rel, path_template, params, optional_params, options, resource_templates)
-      @name, @rel, @path_template = name, rel, path_template
+    def initialize(name, rel, uri_template, path_template, params, optional_params, options, resource_templates)
+      @name, @rel, @uri_template, @path_template = name, rel, uri_template, path_template
       @params = params || []
       @optional_params = optional_params || []
       @options = options || []
@@ -38,7 +41,7 @@ module DescribedRoutes
     
     # Create a ResourceTemplate from its Hash representation
     def self.from_hash(hash)
-      attributes = %w(name rel path_template params optional_params options).map{|k| hash[k]}
+      attributes = %w(name rel uri_template path_template params optional_params options).map{|k| hash[k]}
       if hash["resource_templates"]
         attributes << hash["resource_templates"].map{|h| from_hash(h)} if hash["resource_templates"]
       else
@@ -52,6 +55,7 @@ module DescribedRoutes
       hash = {}
       hash["name"] = name if name && !name.empty?
       hash["rel"] = rel if rel && !rel.empty?
+      hash["uri_template"] = path_template if uri_template && !path_template.empty?
       hash["path_template"] = path_template if path_template && !path_template.empty?
 
       hash["options"] = options if options && !options.empty?

data/lib/tasks/described_routes.rb

@@ -16,7 +16,7 @@ namespace :described_routes do
 
   desc "Describe resource structure in YAML format (basic structure only)"
   task :yaml_short => :environment do
-    puts DescribedRoutes::RailsRoutes.get_resources.to_yaml.grep(/name|rel|path_template|resources/)
+    puts DescribedRoutes::RailsRoutes.get_resources.to_yaml.grep(/(name|rel|path_template|uri_template|resources):|^---/)
   end
 
   desc "Describe resource structure in XML format"

metadata

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