described_routes 0.3.4 → 0.3.5

data/History.txt

@@ -1,52 +1,48 @@
+
+* 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
+
+== 0.3.5 2009-05-06
+
+* make it possible to customise the data collected from Rails
+
 == 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
+* 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 !
-* 1 minor fix:
-  * fix controller for YAML output
+* fix controller for YAML output
 
 == 0.3.0 2009-05-03
 
-* 1 major enhancement:
-  * text output:
-    * rake described_routes:text
-    * curl <app>/described_routes.txt
+* text output:
+  * rake described_routes:text
+  * curl <app>/described_routes.txt
 
 == 0.2.1 2009-04-29
 
-* 1 minor fix:
-  * fix uri_template export, update test fixiture
+* fix uri_template export, update test fixiture
 
 == 0.2.1 2009-04-29
 
-* 1 minor fix:
-  * reinstate params in json and yaml formats
+* reinstate params in json and yaml formats
 
 == 0.2.0 2009-04-29
 
-* 1 minor enhancement:
-  * add show method to controller
-* other:
-  * add tests
-  * refactoring
+* add show method to controller
+* add tests
+* refactoring
 
 == 0.1.1 2009-04-28
 
-* 1 minor enhancement:
-  * include uri_template elements in XML
+* include uri_template elements in XML
 
 == 0.1.0 2009-04-24
 
-* 1 major enhancement:
-  * added Rails controller
+* added Rails controller
 
 == 0.0.1 2009-04-24
 
-* 1 major enhancement:
-  * Initial release
+* Initial release

data/Manifest.txt

@@ -39,6 +39,7 @@ 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/build_time/described_routes.yaml_short_no_admin
 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

data/README.rdoc

@@ -1,6 +1,8 @@
 = described_routes README
 
-Note to reader: Please comment on the roadmap at http://positiveincline.com/?p=213
+Framework-neutral descriptions of Rails routes in JSON, YAML, XML and plain text formats.
+
+Please comment on the roadmap at http://positiveincline.com/?p=213
 
 == DESCRIPTION:
 
@@ -25,8 +27,7 @@ Then:
 
 The text output looks like this:
 
-  $ rake described_routes:text
-  (in /Users/asplake/railsapps/testapp)
+  $ rake --silent described_routes:text
   root                   root                                          /
   admin_products         admin_products         GET, POST              /admin/products{-prefix|.|format}
     new_admin_product    new_admin_product      GET                    /admin/products/new{-prefix|.|format}
@@ -136,6 +137,14 @@ This follows the natural structure but with the following modifications:
 
 Calls to parse_xml will at present result in NoMethodError exceptions being raised.
 
+== CUSTOMISATION
+
+It is possible to customise the data collected from Rails, for example to hide sensitive routes:
+
+  DescribedRoutes::RailsRoutes.parsed_hook = lambda {|a| a.reject{|h| h["name"] =~ /^admin/}}
+
+This hook operates on the raw "parsed" (Array/Hash) data before conversion to ResourceTemplate objects. 
+
 == REQUIREMENTS:
 
 Rails, for the Rake tasks and Rails controller.  The ResourceTemplate class and its formats are however Rails-independent.

data/Rakefile

@@ -36,5 +36,6 @@ task :test do
 end
 
 task :clean do
-  Dir.chdir("test_rails_app"){ sh "rake log:clear tmp:clear" }
+  rubyopt = "-I#{File.dirname(__FILE__) + '/lib'} #{ENV['RUBYOPT']}"
+  Dir.chdir("test_rails_app"){ sh "RUBYOPT=\"#{rubyopt}\" rake log:clear tmp:clear" }
 end

data/lib/described_routes/rails_routes.rb

@@ -2,11 +2,21 @@ require 'described_routes/resource_template'
 
 module DescribedRoutes
   module RailsRoutes
+    
+    #
+    # Hook to customise the "parsed" (Array/Hash) data.  For example, to remove certain sensitive routes:
+    #
+    #   DescribedRoutes::RailsRoutes.parsed_hook = lambda {|a| a.reject{|h| h["name"] =~ /^admin/}}
+    #
+    mattr_accessor :parsed_hook
+    
     #
     # Process Rails routes and return an array of DescribedRoutes::ResourceTemplate objects
     #
     def self.get_resource_templates(base_url = nil)
-      DescribedRoutes::ResourceTemplate.from_parsed(get_parsed_rails_resources(base_url))
+      parsed = get_parsed_rails_resources(base_url)
+      parsed = parsed_hook.call(parsed) if parsed_hook
+      DescribedRoutes::ResourceTemplate.from_parsed(parsed)
     end
 
     #

data/lib/described_routes.rb

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

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

@@ -0,0 +1,62 @@
+--- 
+- name: root
+  path_template: /
+- name: described_routes
+  - name: new_described_route
+    path_template: /described_routes/new{-prefix|.|format}
+    rel: new_described_route
+  - name: described_route
+    - name: edit_described_route
+      path_template: /described_routes/{route_name}/edit{-prefix|.|format}
+      rel: edit
+    path_template: /described_routes/{route_name}{-prefix|.|format}
+  path_template: /described_routes{-prefix|.|format}
+- name: pages
+  - name: new_page
+    path_template: /pages/new{-prefix|.|format}
+    rel: new_page
+  - name: page
+    - name: edit_page
+      path_template: /pages/{page_id}/edit{-prefix|.|format}
+      rel: edit
+    - name: summary_page
+      path_template: /pages/{page_id}/summary{-prefix|.|format}
+      rel: summary
+    - name: toggle_visibility_page
+      path_template: /pages/{page_id}/toggle_visibility{-prefix|.|format}
+      rel: toggle_visibility
+    path_template: /pages/{page_id}{-prefix|.|format}
+  path_template: /pages{-prefix|.|format}
+- name: users
+  - name: new_user
+    path_template: /users/new{-prefix|.|format}
+    rel: new_user
+  - name: user
+    - name: edit_user
+      path_template: /users/{user_id}/edit{-prefix|.|format}
+      rel: edit
+    - name: user_articles
+      - name: new_user_article
+        path_template: /users/{user_id}/articles/new{-prefix|.|format}
+        rel: new_user_article
+      - name: recent_user_articles
+        path_template: /users/{user_id}/articles/recent{-prefix|.|format}
+        rel: recent
+      - name: user_article
+        - name: edit_user_article
+          path_template: /users/{user_id}/articles/{article_id}/edit{-prefix|.|format}
+          rel: edit
+        path_template: /users/{user_id}/articles/{article_id}{-prefix|.|format}
+      path_template: /users/{user_id}/articles{-prefix|.|format}
+      rel: articles
+    - name: user_profile
+      - name: edit_user_profile
+        path_template: /users/{user_id}/profile/edit{-prefix|.|format}
+        rel: edit
+      - name: new_user_profile
+        path_template: /users/{user_id}/profile/new{-prefix|.|format}
+        rel: new
+      path_template: /users/{user_id}/profile{-prefix|.|format}
+      rel: profile
+    path_template: /users/{user_id}{-prefix|.|format}
+  path_template: /users{-prefix|.|format}

data/test_rails_app/test/integration/rake_tasks_test.rb

@@ -3,6 +3,14 @@ require 'test/test_helper'
 require 'described_routes/rake_task_methods'
 
 class RakeTasksTest < Test::Unit::TestCase
+  def setup
+    DescribedRoutes::RailsRoutes.parsed_hook = nil
+  end
+  
+  def teardown
+    DescribedRoutes::RailsRoutes.parsed_hook = nil
+  end
+  
   def read_fixture(extension)
     File.read(File.dirname(__FILE__) + '/../fixtures/build_time/described_routes.' + extension)
   end
@@ -26,4 +34,9 @@ class RakeTasksTest < Test::Unit::TestCase
   def test_xml
     assert_equal(read_fixture("xml"), DescribedRoutes::RakeTaskMethods.xml)
   end
+  
+  def test_parsed_hook
+    DescribedRoutes::RailsRoutes.parsed_hook = lambda {|a| a.reject{|h| h["name"] =~ /^admin/}}
+    assert_equal(read_fixture("yaml_short_no_admin"), DescribedRoutes::RakeTaskMethods.yaml_short)
+  end  
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: described_routes
 version: !ruby/object:Gem::Version 
-  version: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors: 
 - Mike Burrows
@@ -86,6 +86,7 @@ files:
 - 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/build_time/described_routes.yaml_short_no_admin
 - 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