described_routes 0.3.3 → 0.3.4

data/History.txt

@@ -1,6 +1,13 @@
+== 0.3.4 2009-05-06
+
+* Please comment on roadmap at http://positiveincline.com/?p=213 !
+* 2 minor enhancements:
+  * optional BASE parameter: rake described_routes:<format> BASE=http://...
+  * added test_rails_app subproject, included in main project's tests
+
 == 0.3.3 2009-05-05
 
-* Please comment on roadmap at http://positiveincline.com/?p=213
+* Please comment on roadmap at http://positiveincline.com/?p=213 !
 * 1 minor fix:
   * fix controller for YAML output
 

data/Manifest.txt

@@ -7,6 +7,7 @@ Rakefile
 lib/described_routes.rb
 lib/described_routes/rails_controller.rb
 lib/described_routes/rails_routes.rb
+lib/described_routes/rake_task_methods.rb
 lib/described_routes/resource_template.rb
 lib/tasks/described_routes.rb
 script/console
@@ -16,3 +17,33 @@ test/fixtures/described_routes_test.json
 test/test_described_routes.rb
 test/test_helper.rb
 test/test_resource_template.rb
+test_rails_app/Rakefile
+test_rails_app/app/controllers/application_controller.rb
+test_rails_app/app/helpers/application_helper.rb
+test_rails_app/config/boot.rb
+test_rails_app/config/environment.rb
+test_rails_app/config/environments/development.rb
+test_rails_app/config/environments/production.rb
+test_rails_app/config/environments/test.rb
+test_rails_app/config/initializers/described_routes.rb
+test_rails_app/config/initializers/new_rails_defaults.rb
+test_rails_app/config/initializers/session_store.rb
+test_rails_app/config/routes.rb
+test_rails_app/log/development.log
+test_rails_app/log/production.log
+test_rails_app/log/server.log
+test_rails_app/log/test.log
+test_rails_app/script/server
+test_rails_app/test/fixtures/build_time/described_routes.json
+test_rails_app/test/fixtures/build_time/described_routes.text
+test_rails_app/test/fixtures/build_time/described_routes.xml
+test_rails_app/test/fixtures/build_time/described_routes.yaml
+test_rails_app/test/fixtures/build_time/described_routes.yaml_short
+test_rails_app/test/fixtures/run_time/described_routes.json
+test_rails_app/test/fixtures/run_time/described_routes.text
+test_rails_app/test/fixtures/run_time/described_routes.xml
+test_rails_app/test/fixtures/run_time/described_routes.yaml
+test_rails_app/test/fixtures/run_time/described_routes.yaml_short
+test_rails_app/test/integration/described_routes_run_time_test.rb
+test_rails_app/test/integration/rake_tasks_test.rb
+test_rails_app/test/test_helper.rb

data/README.rdoc

@@ -1,6 +1,6 @@
 = described_routes README
 
-* Please comment on roadmap at http://positiveincline.com/?p=213
+Note to reader: Please comment on the roadmap at http://positiveincline.com/?p=213
 
 == DESCRIPTION:
 
@@ -55,6 +55,10 @@ 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 
+include full URI templates.
+
 The JSON, XML and YAML formats (of which the YAML is the most readable) are designed for program consumption. 
 
 === Run time
@@ -105,7 +109,7 @@ Example:
 
 === Natural structure
 
-The YAML and JSON representations appear as simple array and hash structures (which is what they're generated from internally).  Each resource is represented by a hash of attributes (one of which may be a list of child resources); the top level structure is an array of the resources that don't have parents.
+The YAML and JSON representations appear as simple array and hash structures.  Each resource is represented by a hash of attributes (one of which may be a list of child resources); the top level structure is an array of the resources that don't have parents.
 
 Attributes:
 

data/Rakefile

@@ -2,14 +2,6 @@
 $:.push File.dirname(__FILE__) + '/lib'
 require 'described_routes'
 
-# undefined method `empty?' for nil:NilClass
-# /Library/Ruby/Site/1.8/rubygems/specification.rb:886:in `validate'
-class NilClass
-  def empty?
-    true
-  end
-end
-
 # Generate all the Rake tasks
 # Run 'rake -T' to see list of generated tasks (from gem root directory)
 $hoe = Hoe.new('described_routes', DescribedRoutes::VERSION) do |p|
@@ -17,7 +9,7 @@ $hoe = Hoe.new('described_routes', DescribedRoutes::VERSION) do |p|
   p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
   p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
   p.rubyforge_name       = 'describedroutes'
-  p.url = 'http://positiveincline.com/?tag=described_routes'
+  p.url = 'http://positiveincline.com/?p=213'
   # p.extra_deps         = [
   #   ['activesupport','>= 2.0.2'],
   # ]
@@ -34,5 +26,15 @@ end
 require 'newgem/tasks' # load /tasks/*.rake
 Dir['tasks/**/*.rake'].each { |t| load t }
 
-# TODO - want other tests/tasks run by default? Add them to the list
-# task :default => [:spec, :features]
+#
+# These add to existing tasks and execute in the ./test_rails_app/ subproject
+#
+
+task :test do
+  rubyopt = "-I#{File.dirname(__FILE__) + '/lib'} #{ENV['RUBYOPT']}"
+  Dir.chdir("test_rails_app"){ sh "RUBYOPT=\"#{rubyopt}\" rake test:integration" }
+end
+
+task :clean do
+  Dir.chdir("test_rails_app"){ sh "rake log:clear tmp:clear" }
+end

data/lib/described_routes/rake_task_methods.rb

@@ -0,0 +1,38 @@
+require 'described_routes/rails_routes'
+
+module DescribedRoutes
+  module RakeTaskMethods
+    # Describe resource structure in JSON format
+    def self.json
+      DescribedRoutes::ResourceTemplate.to_json(
+              DescribedRoutes::RailsRoutes.get_resource_templates(ENV['BASE']))
+    end
+
+    # "Describe resource structure in YAML format
+    def self.yaml
+      DescribedRoutes::ResourceTemplate.to_yaml(
+              DescribedRoutes::RailsRoutes.get_resource_templates(ENV['BASE']))
+    end
+
+    # Describe resource structure in YAML format (basic structure only)
+    def self.yaml_short
+      DescribedRoutes::ResourceTemplate.to_yaml(
+              DescribedRoutes::RailsRoutes.get_resource_templates(ENV['BASE'])).grep(
+                  /(name|rel|path_template|uri_template|resources):|^---/).join
+    end
+
+    # Describe resource structure in XML format
+    def self.xml
+      DescribedRoutes::ResourceTemplate.to_xml(
+               Builder::XmlMarkup.new(:indent => 2),
+               DescribedRoutes::RailsRoutes.get_resource_templates(ENV['BASE'])
+             ).target!
+    end
+
+    # Describe resource structure in text format
+    def self.text
+      DescribedRoutes::ResourceTemplate.to_text(
+              DescribedRoutes::RailsRoutes.get_resource_templates(ENV['BASE']))
+    end
+  end
+end

data/lib/described_routes.rb

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

data/lib/tasks/described_routes.rb

@@ -1,43 +1,33 @@
 require 'tasks/rails'
-require 'described_routes/rails_routes'
+require 'described_routes/rake_task_methods'
 
 namespace :described_routes do
-  desc "Describe resource structure as a Ruby literal"
-  desc "Describe resource structure in JSON format"
-
+  desc 'Describe resource structure in JSON format (optional: add "BASE=http://...")'
   task :json => :environment do
-    puts DescribedRoutes::ResourceTemplate.to_json(
-            DescribedRoutes::RailsRoutes.get_resource_templates)
+    puts DescribedRoutes::RakeTaskMethods.json
   end
 
-  desc "Describe resource structure in YAML format"
+  desc 'Describe resource structure in YAML format (optional: add "BASE=http://...")'
   task :yaml => :environment do
-    puts DescribedRoutes::ResourceTemplate.to_yaml(
-            DescribedRoutes::RailsRoutes.get_resource_templates)
+    puts DescribedRoutes::RakeTaskMethods.yaml
   end
 
-  desc "Describe resource structure in YAML format (basic structure only)"
+  desc 'Describe resource structure in YAML format (basic structure only) (optional: add "BASE=http://...")'
   task :yaml_short => :environment do
-    puts DescribedRoutes::ResourceTemplate.to_yaml(
-            DescribedRoutes::RailsRoutes.get_resource_templates).grep(
-                /(name|rel|path_template|uri_template|resources):|^---/)
+    puts DescribedRoutes::RakeTaskMethods.yaml_short
   end
 
-  desc "Describe resource structure in XML format"
+  desc 'Describe resource structure in XML format (optional: add "BASE=http://...")'
   task :xml => :environment do
-    puts DescribedRoutes::ResourceTemplate.to_xml(
-             Builder::XmlMarkup.new(:indent => 2),
-             DescribedRoutes::RailsRoutes.get_resource_templates
-           ).target!
+    puts DescribedRoutes::RakeTaskMethods.xml
   end
 
-  desc "Describe resource structure in text format"
+  desc 'Describe resource structure in text format (optional: add "BASE=http://...")'
   task :text => :environment do
-    puts DescribedRoutes::ResourceTemplate.to_text(
-            DescribedRoutes::RailsRoutes.get_resource_templates)
+    puts DescribedRoutes::RakeTaskMethods.text
   end
   
-  # unsupported, for testing
+  # unsupported
   task :ruby => :environment do
     puts DescribedRoutes::ResourceTemplate.to_parsed(
             DescribedRoutes::RailsRoutes.get_resource_templates).inspect

data/test_rails_app/Rakefile

@@ -0,0 +1,12 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require(File.join(File.dirname(__FILE__), 'config', 'boot'))
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+require 'tasks/rails'
+
+require 'tasks/described_routes'

data/test_rails_app/app/controllers/application_controller.rb

@@ -0,0 +1,10 @@
+# Filters added to this controller apply to all controllers in the application.
+# Likewise, all the methods added will be available for all controllers.
+
+class ApplicationController < ActionController::Base
+  helper :all # include all helpers, all the time
+  protect_from_forgery # See ActionController::RequestForgeryProtection for details
+
+  # Scrub sensitive parameters from your log
+  # filter_parameter_logging :password
+end

data/test_rails_app/app/helpers/application_helper.rb

@@ -0,0 +1,3 @@
+# Methods added to this helper will be available to all templates in the application.
+module ApplicationHelper
+end

data/test_rails_app/config/boot.rb

@@ -0,0 +1,110 @@
+# Don't change this file!
+# Configure your app in config/environment.rb and config/environments/*.rb
+
+RAILS_ROOT = "#{File.dirname(__FILE__)}/.." unless defined?(RAILS_ROOT)
+
+module Rails
+  class << self
+    def boot!
+      unless booted?
+        preinitialize
+        pick_boot.run
+      end
+    end
+
+    def booted?
+      defined? Rails::Initializer
+    end
+
+    def pick_boot
+      (vendor_rails? ? VendorBoot : GemBoot).new
+    end
+
+    def vendor_rails?
+      File.exist?("#{RAILS_ROOT}/vendor/rails")
+    end
+
+    def preinitialize
+      load(preinitializer_path) if File.exist?(preinitializer_path)
+    end
+
+    def preinitializer_path
+      "#{RAILS_ROOT}/config/preinitializer.rb"
+    end
+  end
+
+  class Boot
+    def run
+      load_initializer
+      Rails::Initializer.run(:set_load_path)
+    end
+  end
+
+  class VendorBoot < Boot
+    def load_initializer
+      require "#{RAILS_ROOT}/vendor/rails/railties/lib/initializer"
+      Rails::Initializer.run(:install_gem_spec_stubs)
+      Rails::GemDependency.add_frozen_gem_path
+    end
+  end
+
+  class GemBoot < Boot
+    def load_initializer
+      self.class.load_rubygems
+      load_rails_gem
+      require 'initializer'
+    end
+
+    def load_rails_gem
+      if version = self.class.gem_version
+        gem 'rails', version
+      else
+        gem 'rails'
+      end
+    rescue Gem::LoadError => load_error
+      $stderr.puts %(Missing the Rails #{version} gem. Please `gem install -v=#{version} rails`, update your RAILS_GEM_VERSION setting in config/environment.rb for the Rails version you do have installed, or comment out RAILS_GEM_VERSION to use the latest version installed.)
+      exit 1
+    end
+
+    class << self
+      def rubygems_version
+        Gem::RubyGemsVersion rescue nil
+      end
+
+      def gem_version
+        if defined? RAILS_GEM_VERSION
+          RAILS_GEM_VERSION
+        elsif ENV.include?('RAILS_GEM_VERSION')
+          ENV['RAILS_GEM_VERSION']
+        else
+          parse_gem_version(read_environment_rb)
+        end
+      end
+
+      def load_rubygems
+        require 'rubygems'
+        min_version = '1.3.1'
+        unless rubygems_version >= min_version
+          $stderr.puts %Q(Rails requires RubyGems >= #{min_version} (you have #{rubygems_version}). Please `gem update --system` and try again.)
+          exit 1
+        end
+
+      rescue LoadError
+        $stderr.puts %Q(Rails requires RubyGems >= #{min_version}. Please install RubyGems and try again: http://rubygems.rubyforge.org)
+        exit 1
+      end
+
+      def parse_gem_version(text)
+        $1 if text =~ /^[^#]*RAILS_GEM_VERSION\s*=\s*["']([!~<>=]*\s*[\d.]+)["']/
+      end
+
+      private
+        def read_environment_rb
+          File.read("#{RAILS_ROOT}/config/environment.rb")
+        end
+    end
+  end
+end
+
+# All that for this:
+Rails.boot!

data/test_rails_app/config/environment.rb

@@ -0,0 +1,41 @@
+# Be sure to restart your server when you modify this file
+
+# Specifies gem version of Rails to use when vendor/rails is not present
+RAILS_GEM_VERSION = '2.3.2' unless defined? RAILS_GEM_VERSION
+
+# Bootstrap the Rails environment, frameworks, and default configuration
+require File.join(File.dirname(__FILE__), 'boot')
+
+Rails::Initializer.run do |config|
+  # Settings in config/environments/* take precedence over those specified here.
+  # Application configuration should go into files in config/initializers
+  # -- all .rb files in that directory are automatically loaded.
+
+  # Add additional load paths for your own custom dirs
+  # config.load_paths += %W( #{RAILS_ROOT}/extras )
+
+  # Specify gems that this application depends on and have them installed with rake gems:install
+  # config.gem "bj"
+  # config.gem "hpricot", :version => '0.6', :source => "http://code.whytheluckystiff.net"
+  # config.gem "sqlite3-ruby", :lib => "sqlite3"
+  # config.gem "aws-s3", :lib => "aws/s3"
+
+  # Only load the plugins named here, in the order given (default is alphabetical).
+  # :all can be used as a placeholder for all plugins not explicitly named
+  # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+  # Skip frameworks you're not going to use. To use Rails without a database,
+  # you must remove the Active Record framework.
+  config.frameworks -= [ :active_record, :active_resource, :action_mailer ]
+
+  # Activate observers that should always be running
+  # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+  # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+  # Run "rake -D time" for a list of tasks for finding time zone names.
+  config.time_zone = 'UTC'
+
+  # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+  # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}')]
+  # config.i18n.default_locale = :de
+end

data/test_rails_app/config/environments/development.rb

@@ -0,0 +1,17 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# In the development environment your application's code is reloaded on
+# every request.  This slows down response time but is perfect for development
+# since you don't have to restart the webserver when you make code changes.
+config.cache_classes = false
+
+# Log error messages when you accidentally call methods on nil.
+config.whiny_nils = true
+
+# Show full error reports and disable caching
+config.action_controller.consider_all_requests_local = true
+config.action_view.debug_rjs                         = true
+config.action_controller.perform_caching             = false
+
+# Don't care if the mailer can't send
+config.action_mailer.raise_delivery_errors = false

data/test_rails_app/config/environments/production.rb

@@ -0,0 +1,28 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# The production environment is meant for finished, "live" apps.
+# Code is not reloaded between requests
+config.cache_classes = true
+
+# Full error reports are disabled and caching is turned on
+config.action_controller.consider_all_requests_local = false
+config.action_controller.perform_caching             = true
+config.action_view.cache_template_loading            = true
+
+# See everything in the log (default is :info)
+# config.log_level = :debug
+
+# Use a different logger for distributed setups
+# config.logger = SyslogLogger.new
+
+# Use a different cache store in production
+# config.cache_store = :mem_cache_store
+
+# Enable serving of images, stylesheets, and javascripts from an asset server
+# config.action_controller.asset_host = "http://assets.example.com"
+
+# Disable delivery errors, bad email addresses will be ignored
+# config.action_mailer.raise_delivery_errors = false
+
+# Enable threaded mode
+# config.threadsafe!

data/test_rails_app/config/environments/test.rb

@@ -0,0 +1,28 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# The test environment is used exclusively to run your application's
+# test suite.  You never need to work with it otherwise.  Remember that
+# your test database is "scratch space" for the test suite and is wiped
+# and recreated between test runs.  Don't rely on the data there!
+config.cache_classes = true
+
+# Log error messages when you accidentally call methods on nil.
+config.whiny_nils = true
+
+# Show full error reports and disable caching
+config.action_controller.consider_all_requests_local = true
+config.action_controller.perform_caching             = false
+config.action_view.cache_template_loading            = true
+
+# Disable request forgery protection in test environment
+config.action_controller.allow_forgery_protection    = false
+
+# Tell Action Mailer not to deliver emails to the real world.
+# The :test delivery method accumulates sent emails in the
+# ActionMailer::Base.deliveries array.
+config.action_mailer.delivery_method = :test
+
+# Use SQL instead of Active Record's schema dumper when creating the test database.
+# This is necessary if your schema can't be completely dumped by the schema dumper,
+# like if you have constraints or database-specific column types
+# config.active_record.schema_format = :sql

data/test_rails_app/config/initializers/described_routes.rb

@@ -0,0 +1 @@
+require 'described_routes/rails_controller'

data/test_rails_app/config/initializers/new_rails_defaults.rb

@@ -0,0 +1,19 @@
+# Be sure to restart your server when you modify this file.
+
+# These settings change the behavior of Rails 2 apps and will be defaults
+# for Rails 3. You can remove this initializer when Rails 3 is released.
+
+if defined?(ActiveRecord)
+  # Include Active Record class name as root for JSON serialized output.
+  ActiveRecord::Base.include_root_in_json = true
+
+  # Store the full class name (including module namespace) in STI type column.
+  ActiveRecord::Base.store_full_sti_class = true
+end
+
+# Use ISO 8601 format for JSON serialized times and dates.
+ActiveSupport.use_standard_json_time_format = true
+
+# Don't escape HTML entities in JSON, leave that for the #json_escape helper.
+# if you're including raw json in an HTML page.
+ActiveSupport.escape_html_entities_in_json = false

data/test_rails_app/config/initializers/session_store.rb

@@ -0,0 +1,15 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key for verifying cookie session data integrity.
+# If you change this key, all old sessions will become invalid!
+# Make sure the secret is at least 30 characters and all random, 
+# no regular words or you'll be exposed to dictionary attacks.
+ActionController::Base.session = {
+  :key         => '_testapp_session',
+  :secret      => 'dad28f64c968d96b22e305e25488eea6046369e9eb88987ed49877a9fce693f4972691a2fa8b5baad1aa043e95438d3e31ab708486a800399b72e56f2c4428f6'
+}
+
+# Use the database for sessions instead of the cookie-based default,
+# which shouldn't be used to store highly confidential information
+# (create the session table with "rake db:sessions:create")
+# ActionController::Base.session_store = :active_record_store

data/test_rails_app/config/routes.rb

@@ -0,0 +1,28 @@
+ActionController::Routing::Routes.draw do |map|  
+  
+  #
+  # some sample routes taken from the comments in the original boilerplate
+  #
+  
+  map.resources :users do |users|
+    users.resources :articles, :collection => {:recent => :get}
+    users.resource :profile
+  end
+  
+  map.resources :pages, :member => {:summary => :get, :toggle_visibility => :post}
+  
+  map.namespace :admin do |admin|
+      admin.resources :products
+  end
+
+  #
+  # described_routes will use this as the base URI if present, otherwise
+  # it returns only relative paths
+  #
+  map.root :controller => "welcome"
+  
+  #
+  # described_routes at runtime
+  #
+  map.resources :described_routes, :controller => "described_routes/rails"
+end

data/test_rails_app/script/server

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require File.dirname(__FILE__) + '/../config/boot'
+require 'commands/server'

data/test_rails_app/test/fixtures/build_time/described_routes.json

@@ -0,0 +1 @@
+[{"name":"root","path_template":"\/"},{"name":"admin_products","resource_templates":[{"name":"new_admin_product","options":["GET"],"path_template":"\/admin\/products\/new{-prefix|.|format}","rel":"new_admin_product","optional_params":["format"]},{"name":"admin_product","resource_templates":[{"name":"edit_admin_product","options":["GET"],"path_template":"\/admin\/products\/{product_id}\/edit{-prefix|.|format}","rel":"edit","optional_params":["format"],"params":["product_id"]}],"options":["GET","PUT","DELETE"],"path_template":"\/admin\/products\/{product_id}{-prefix|.|format}","optional_params":["format"],"params":["product_id"]}],"options":["GET","POST"],"path_template":"\/admin\/products{-prefix|.|format}","optional_params":["format"]},{"name":"described_routes","resource_templates":[{"name":"new_described_route","options":["GET"],"path_template":"\/described_routes\/new{-prefix|.|format}","rel":"new_described_route","optional_params":["format"]},{"name":"described_route","resource_templates":[{"name":"edit_described_route","options":["GET"],"path_template":"\/described_routes\/{route_name}\/edit{-prefix|.|format}","rel":"edit","optional_params":["format"],"params":["route_name"]}],"options":["GET","PUT","DELETE"],"path_template":"\/described_routes\/{route_name}{-prefix|.|format}","optional_params":["format"],"params":["route_name"]}],"options":["GET","POST"],"path_template":"\/described_routes{-prefix|.|format}","optional_params":["format"]},{"name":"pages","resource_templates":[{"name":"new_page","options":["GET"],"path_template":"\/pages\/new{-prefix|.|format}","rel":"new_page","optional_params":["format"]},{"name":"page","resource_templates":[{"name":"edit_page","options":["GET"],"path_template":"\/pages\/{page_id}\/edit{-prefix|.|format}","rel":"edit","optional_params":["format"],"params":["page_id"]},{"name":"summary_page","options":["GET"],"path_template":"\/pages\/{page_id}\/summary{-prefix|.|format}","rel":"summary","optional_params":["format"],"params":["page_id"]},{"name":"toggle_visibility_page","options":["POST"],"path_template":"\/pages\/{page_id}\/toggle_visibility{-prefix|.|format}","rel":"toggle_visibility","optional_params":["format"],"params":["page_id"]}],"options":["GET","PUT","DELETE"],"path_template":"\/pages\/{page_id}{-prefix|.|format}","optional_params":["format"],"params":["page_id"]}],"options":["GET","POST"],"path_template":"\/pages{-prefix|.|format}","optional_params":["format"]},{"name":"users","resource_templates":[{"name":"new_user","options":["GET"],"path_template":"\/users\/new{-prefix|.|format}","rel":"new_user","optional_params":["format"]},{"name":"user","resource_templates":[{"name":"edit_user","options":["GET"],"path_template":"\/users\/{user_id}\/edit{-prefix|.|format}","rel":"edit","optional_params":["format"],"params":["user_id"]},{"name":"user_articles","resource_templates":[{"name":"new_user_article","options":["GET"],"path_template":"\/users\/{user_id}\/articles\/new{-prefix|.|format}","rel":"new_user_article","optional_params":["format"],"params":["user_id"]},{"name":"recent_user_articles","options":["GET"],"path_template":"\/users\/{user_id}\/articles\/recent{-prefix|.|format}","rel":"recent","optional_params":["format"],"params":["user_id"]},{"name":"user_article","resource_templates":[{"name":"edit_user_article","options":["GET"],"path_template":"\/users\/{user_id}\/articles\/{article_id}\/edit{-prefix|.|format}","rel":"edit","optional_params":["format"],"params":["user_id","article_id"]}],"options":["GET","PUT","DELETE"],"path_template":"\/users\/{user_id}\/articles\/{article_id}{-prefix|.|format}","optional_params":["format"],"params":["user_id","article_id"]}],"options":["GET","POST"],"path_template":"\/users\/{user_id}\/articles{-prefix|.|format}","rel":"articles","optional_params":["format"],"params":["user_id"]},{"name":"user_profile","resource_templates":[{"name":"edit_user_profile","options":["GET"],"path_template":"\/users\/{user_id}\/profile\/edit{-prefix|.|format}","rel":"edit","optional_params":["format"],"params":["user_id"]},{"name":"new_user_profile","options":["GET"],"path_template":"\/users\/{user_id}\/profile\/new{-prefix|.|format}","rel":"new","optional_params":["format"],"params":["user_id"]}],"options":["GET","PUT","DELETE","POST"],"path_template":"\/users\/{user_id}\/profile{-prefix|.|format}","rel":"profile","optional_params":["format"],"params":["user_id"]}],"options":["GET","PUT","DELETE"],"path_template":"\/users\/{user_id}{-prefix|.|format}","optional_params":["format"],"params":["user_id"]}],"options":["GET","POST"],"path_template":"\/users{-prefix|.|format}","optional_params":["format"]}]

data/test_rails_app/test/fixtures/build_time/described_routes.text

@@ -0,0 +1,27 @@
+root                   root                                          /
+admin_products         admin_products         GET, POST              /admin/products{-prefix|.|format}
+  new_admin_product    new_admin_product      GET                    /admin/products/new{-prefix|.|format}
+  {product_id}         admin_product          GET, PUT, DELETE       /admin/products/{product_id}{-prefix|.|format}
+    edit               edit_admin_product     GET                    /admin/products/{product_id}/edit{-prefix|.|format}
+described_routes       described_routes       GET, POST              /described_routes{-prefix|.|format}
+  new_described_route  new_described_route    GET                    /described_routes/new{-prefix|.|format}
+  {route_name}         described_route        GET, PUT, DELETE       /described_routes/{route_name}{-prefix|.|format}
+    edit               edit_described_route   GET                    /described_routes/{route_name}/edit{-prefix|.|format}
+pages                  pages                  GET, POST              /pages{-prefix|.|format}
+  new_page             new_page               GET                    /pages/new{-prefix|.|format}
+  {page_id}            page                   GET, PUT, DELETE       /pages/{page_id}{-prefix|.|format}
+    edit               edit_page              GET                    /pages/{page_id}/edit{-prefix|.|format}
+    summary            summary_page           GET                    /pages/{page_id}/summary{-prefix|.|format}
+    toggle_visibility  toggle_visibility_page POST                   /pages/{page_id}/toggle_visibility{-prefix|.|format}
+users                  users                  GET, POST              /users{-prefix|.|format}
+  new_user             new_user               GET                    /users/new{-prefix|.|format}
+  {user_id}            user                   GET, PUT, DELETE       /users/{user_id}{-prefix|.|format}
+    edit               edit_user              GET                    /users/{user_id}/edit{-prefix|.|format}
+    articles           user_articles          GET, POST              /users/{user_id}/articles{-prefix|.|format}
+      new_user_article new_user_article       GET                    /users/{user_id}/articles/new{-prefix|.|format}
+      recent           recent_user_articles   GET                    /users/{user_id}/articles/recent{-prefix|.|format}
+      {article_id}     user_article           GET, PUT, DELETE       /users/{user_id}/articles/{article_id}{-prefix|.|format}
+        edit           edit_user_article      GET                    /users/{user_id}/articles/{article_id}/edit{-prefix|.|format}
+    profile            user_profile           GET, PUT, DELETE, POST /users/{user_id}/profile{-prefix|.|format}
+      edit             edit_user_profile      GET                    /users/{user_id}/profile/edit{-prefix|.|format}
+      new              new_user_profile       GET                    /users/{user_id}/profile/new{-prefix|.|format}