RubyGems - Bill-route_name_for - Versions diffs - 0.0.1 → 0.0.2 - Mend

Bill-route_name_for 0.0.1 → 0.0.2

Files changed (10) hide show

data/History.txt +5 -0
data/Manifest.txt +3 -0
data/README.txt +60 -26
data/lib/init.rb +1 -0
data/lib/rails/init.rb +7 -0
data/lib/route_name_for/version.rb +1 -1
data/lib/route_name_for.rb +48 -15
data/route_name_for.gemspec +36 -0
data/website/index.html +141 -11
metadata +9 -6

data/History.txt CHANGED Viewed

@@ -1,3 +1,8 @@
+== 0.0.2 2008-08-28
+* 1 major enhancement:
+  * route_name_for now takes request.request_uri and (empty) environment hash, instead of :controller, :action. It was wrong to ever take :controller, :action since that combination is often ambiguous.
 == 0.0.1 2008-08-21
 * 1 major enhancement:

data/Manifest.txt CHANGED Viewed

@@ -6,8 +6,11 @@ README.txt
 Rakefile
 config/hoe.rb
 config/requirements.rb
+lib/init.rb
+lib/rails/init.rb
 lib/route_name_for.rb
 lib/route_name_for/version.rb
+route_name_for.gemspec
 script/console
 script/destroy
 script/generate

data/README.txt CHANGED Viewed

@@ -4,45 +4,79 @@ http://thoughtpropulsion.com
 == DESCRIPTION:
-Ruby Gem to look up Rails route name given url_for parameters. Adds route_name_for method to controllers and views.
+Rails helper to look up (named) route name given current request URI. Adds route_name_for method to controllers and views.
 == FEATURES/PROBLEMS:
-* FIX (list of features or problems)
+It only finds named routes of course, so sometimes it'll return nothing (if you give a path for which there)
+is no named route.
 == SYNOPSIS:
-  FIX (code sample of usage)
+If you have routes like this:
-== REQUIREMENTS:
+map.home '', :controller => 'home'
+map.login 'login', :controller => 'home'
-* FIX (list of requirements)
+You might like to define this helper in your ApplicationController:
-== INSTALL:
+def body_class
+  route_name_for request.request_uri, {}
+end
-* FIX (sudo gem install, anything else)
+And then call it from your application layout like this:
-== LICENSE:
+<body class='<%=body_class%>'>
+So that when you browse to '/login', your page will have:
+<body class='login'>…
+And when you you browse to '' or '/', your page will have:
+<body class='home'>…
+Then you can match that in your CSS rules with a selector like this:
-(The MIT License)
+body.login … { … }
-Copyright (c) 2008 FIXME full name
+== REQUIREMENTS:
+Rails 2.1.0 or later.
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+Also note: this code is highly dependent upon Rails' implementation of the ActionController::Routing::RouteSet implementation. In particular, the optimization to that class found in recognition_optimisation.rb (sic). The upside of this tight coupling is that this add-on performs as well as Rails native routing. The downside is that Rails may (will) change and this RubyGem will have to track those changes.
+== INSTALL:
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+sudo gem install Bill-route_name_for
+See also http://gems.github.com/
+== LICENSE:
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+(The BSD License)
+* Copyright (c) 2008, Thought Propulsion
+* All rights reserved.
+*
+* Redistribution and use in source and binary forms, with or without
+* modification, are permitted provided that the following conditions are met:
+*     * Redistributions of source code must retain the above copyright
+*       notice, this list of conditions and the following disclaimer.
+*     * Redistributions in binary form must reproduce the above copyright
+*       notice, this list of conditions and the following disclaimer in the
+*       documentation and/or other materials provided with the distribution.
+*     * Neither the name of the Thought Propulsion nor the
+*       names of its contributors may be used to endorse or promote products
+*       derived from this software without specific prior written permission.
+*
+* THIS SOFTWARE IS PROVIDED BY Thought Propulsion ''AS IS'' AND ANY
+* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+* DISCLAIMED. IN NO EVENT SHALL Thought Propulsion BE LIABLE FOR ANY
+* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/lib/init.rb ADDED Viewed

	@@ -0,0 +1 @@
1	+ require File.dirname(__FILE__) + "/rails/init"

data/lib/rails/init.rb ADDED Viewed

@@ -0,0 +1,7 @@
+[ActionController::Routing::RouteSet].each do |c|
+  c.send( :include, RouteNameFor::RouteSetMethods)
+end
+# Optional, but recommended for Rails
+ActionController::Base.send(:include, RouteNameFor::Helpers)
+# Include this module into views, too.
+ActionController::Base.helper(RouteNameFor::Helpers)

data/lib/route_name_for/version.rb CHANGED Viewed

@@ -2,7 +2,7 @@ module RouteNameFor
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 0
-    TINY  = 1
+    TINY  = 2
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/route_name_for.rb CHANGED Viewed

@@ -2,22 +2,55 @@ $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 module RouteNameFor
-  def route_name_for( options)
-    # This does a reverse-lookup to find the named route (name) from the current
-    # controller and action. The is preferrable to just munging the controller name since often
-    # your named routes (names) evolve somewhat independently of your controller names over time.
-    routes = ActionController::Routing::Routes.named_routes.routes
-    found = routes.find do |route_name, route|
-      route.generate( options, options) # ignore "recall" issues (see Rails route_set.rb)
+  module RouteSetMethods
+    def recognized_route( path, env)
+      recognized_route_optimized( path, env)
+    end
+    def recognized_route_optimized( path, env)
+      write_recognized_route_optimized( path, env)
+      recognized_route_optimized(path, env)
+    end
+    def write_recognized_route_optimized( path, env)
+      # This does a reverse-lookup to find the named route (name) from the current
+      # controller and action. The is preferrable to just munging the controller name since often
+      # your named routes (names) evolve somewhat independently of your controller names over time.
+      # See write_recognize_optimized in Rails' recognition_optimisation.rb (sic) (that's where I stole)
+      # this code from. It's important to steal this optimized (dynamically-compiled) code lest
+      # we defeat the Rails optimization.
+      tree = segment_tree(routes)
+      body = generate_code(tree)
+      instance_eval %{
+        def recognized_route_optimized(path, env)
+          segments = to_plain_segments(path)
+          index = #{body}
+          return nil unless index
+          while index < routes.size
+            routes[index].recognize(path, env) and return routes[index]
+            index += 1
+          end
+          nil
+        end
+      }, __FILE__, __LINE__
     end
-    (found && found[0]) || ''
   end
+  module Helpers
+    def route_name_for( path, env)
+      r = ActionController::Routing::Routes.recognized_route( path, {})
+      ActionController::Routing::Routes.named_routes.routes.invert[r].to_s
+    end
+  end
 end
-# Properly, we should be extending ActionView::Helpers::UrlHelper, however we are loaded too late
-# to do that. By the time we are loaded ActionView has already extended ActionView::Base with all
-# its helper modules. So we have to just settle for adding ourselves directly to ActionView::Base.
-[ActionController::Base, ActionView::Base].each do |c|
-  c.send( :include, RouteNameFor)
-end
+[ActionController::Routing::RouteSet].each do |c|
+  c.send( :include, RouteNameFor::RouteSetMethods)
+end
+# Optional, but recommended for Rails
+ActionController::Base.send(:include, RouteNameFor::Helpers)
+# Include this module into views, too.
+ActionController::Base.helper(RouteNameFor::Helpers)

data/route_name_for.gemspec ADDED Viewed

@@ -0,0 +1,36 @@
+Gem::Specification.new do |s|
+  s.name = %q{route_name_for}
+  s.version = "0.0.2"
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Bill Burcham"]
+  s.date = %q{2008-08-28}
+  s.description = %q{Rails helper to look up (named) route name given current request URI. Adds route_name_for method to controllers and views.}
+  s.email = ["propeller@thoughtpropulsion.com"]
+  s.extra_rdoc_files = ["History.txt", "License.txt", "Manifest.txt", "PostInstall.txt", "README.txt", "website/index.txt"]
+  s.files = ["History.txt", "License.txt", "Manifest.txt", "PostInstall.txt", "README.txt", "Rakefile", "config/hoe.rb", "config/requirements.rb", "lib/init.rb", "lib/rails/init.rb", "lib/route_name_for.rb", "lib/route_name_for/version.rb", "route_name_for.gemspec", "script/console", "script/destroy", "script/generate", "script/txt2html", "setup.rb", "tasks/deployment.rake", "tasks/environment.rake", "tasks/website.rake", "test/test_helper.rb", "test/test_route_name_for.rb", "website/index.html", "website/index.txt", "website/javascripts/rounded_corners_lite.inc.js", "website/stylesheets/screen.css", "website/template.html.erb"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/Bill/route_name_for/tree/master}
+  s.post_install_message = %q{
+For more information on route_name_for, see http://github.com/Bill/route_name_for/tree/master
+}
+  s.rdoc_options = ["--main", "README.txt"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{route_name_for}
+  s.rubygems_version = %q{1.2.0}
+  s.summary = %q{description of gem}
+  s.test_files = ["test/test_helper.rb", "test/test_route_name_for.rb"]
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+    if current_version >= 3 then
+      s.add_development_dependency(%q<hoe>, [">= 1.7.0"])
+    else
+      s.add_dependency(%q<hoe>, [">= 1.7.0"])
+    end
+  else
+    s.add_dependency(%q<hoe>, [">= 1.7.0"])
+  end
+end

data/website/index.html CHANGED Viewed

@@ -1,11 +1,141 @@
-<html>
-	<head>
-		<meta http-equiv="Content-type" content="text/html; charset=utf-8">
-		<title>route_name_for</title>
-	</head>
-	<body id="body">
-		<p>This page has not yet been created for RubyGem <code>route_name_for</code></p>
-		<p>To the developer: To generate it, update website/index.txt and run the rake task <code>website</code> to generate this <code>index.html</code> file.</p>
-	</body>
-</html>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <link rel="stylesheet" href="stylesheets/screen.css" type="text/css" media="screen" />
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>
+      route_name_for
+  </title>
+  <script src="javascripts/rounded_corners_lite.inc.js" type="text/javascript"></script>
+<style>
+</style>
+  <script type="text/javascript">
+    window.onload = function() {
+      settings = {
+          tl: { radius: 10 },
+          tr: { radius: 10 },
+          bl: { radius: 10 },
+          br: { radius: 10 },
+          antiAlias: true,
+          autoPad: true,
+          validTags: ["div"]
+      }
+      var versionBox = new curvyCorners(settings, document.getElementById("version"));
+      versionBox.applyCornersToAll();
+    }
+  </script>
+</head>
+<body>
+<div id="main">
+    <h1>route_name_for</h1>
+    <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/route_name_for"; return false'>
+      <p>Get Version</p>
+      <a href="http://rubyforge.org/projects/route_name_for" class="numbers">0.0.2</a>
+    </div>
+    <h1>&#x2192; &#8216;route_name_for&#8217;</h1>
+	<h2>What</h2>
+	<h2>Installing</h2>
+	<p><pre class='syntax'><span class="ident">sudo</span> <span class="ident">gem</span> <span class="ident">install</span> <span class="ident">route_name_for</span></pre></p>
+	<h2>The basics</h2>
+	<h2>Demonstration of usage</h2>
+	<h2>Forum</h2>
+	<p><a href="http://groups.google.com/group/route_name_for">http://groups.google.com/group/route_name_for</a></p>
+	<p><span class="caps">TODO</span> &#8211; create Google Group &#8211; route_name_for</p>
+	<h2>How to submit patches</h2>
+	<p>Read the <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/">8 steps for fixing other people&#8217;s code</a> and for section <a href="http://drnicwilliams.com/2007/06/01/8-steps-for-fixing-other-peoples-code/#8b-google-groups">8b: Submit patch to Google Groups</a>, use the Google Group above.</p>
+	<p><span class="caps">TODO</span> &#8211; pick <span class="caps">SVN</span> or Git instructions</p>
+	<p>The trunk repository is <code>svn://rubyforge.org/var/svn/route_name_for/trunk</code> for anonymous access.</p>
+	<p><span class="caps">OOOORRRR</span></p>
+	<p>You can fetch the source from either:</p>
+	<ul>
+	<li>rubyforge: <span class="caps">MISSING IN ACTION</span></li>
+	</ul>
+	<p><span class="caps">TODO</span> &#8211; You can not created a RubyForge project, OR have not run <code>rubyforge config</code>
+yet to refresh your local rubyforge data with this projects&#8217; id information.</p>
+	<p>When you do this, this message will magically disappear!</p>
+	<p>Or you can hack website/index.txt and make it all go away!!</p>
+	<ul>
+	<li>github: <a href="http://github.com/GITHUB_USERNAME/route_name_for/tree/master">http://github.com/GITHUB_USERNAME/route_name_for/tree/master</a></li>
+	</ul>
+<pre>git clone git://github.com/GITHUB_USERNAME/route_name_for.git</pre>
+	<p><span class="caps">TODO</span> &#8211; add &#8220;github_username: username&#8221; to ~/.rubyforge/user-config.yml and newgem will reuse it for future projects.</p>
+	<ul>
+	<li>gitorious: <a href="git://gitorious.org/route_name_for/mainline.git">git://gitorious.org/route_name_for/mainline.git</a></li>
+	</ul>
+<pre>git clone git://gitorious.org/route_name_for/mainline.git</pre>
+	<h3>Build and test instructions</h3>
+<pre>cd route_name_for
+rake test
+rake install_gem</pre>
+	<h2>License</h2>
+	<p>This code is free to use under the terms of the <span class="caps">MIT</span> license.</p>
+	<h2>Contact</h2>
+	<p>Comments are welcome. Send an email to <a href="mailto:FIXME"><span class="caps">FIXME</span> full name</a> email via the <a href="http://groups.google.com/group/route_name_for">forum</a></p>
+    <p class="coda">
+      <a href="FIXME email">FIXME full name</a>, 21st August 2008<br>
+      Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
+    </p>
+</div>
+<!-- insert site tracking codes here, like Google Urchin -->
+</body>
+</html>

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: Bill-route_name_for
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Bill Burcham
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2008-08-22 00:00:00 -07:00
+date: 2008-08-28 00:00:00 -07:00
 default_executable:
 dependencies:
 - !ruby/object:Gem::Dependency
@@ -21,7 +21,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.7.0
     version:
-description: Look up Rails route name given url_for parameters. Adds route_name_for method to controllers and views.
+description: Rails helper to look up (named) route name given current request URI. Adds route_name_for method to controllers and views.
 email:
 - propeller@thoughtpropulsion.com
 executables: []
@@ -44,8 +44,11 @@ files:
 - Rakefile
 - config/hoe.rb
 - config/requirements.rb
+- lib/init.rb
+- lib/rails/init.rb
 - lib/route_name_for.rb
 - lib/route_name_for/version.rb
+- route_name_for.gemspec
 - script/console
 - script/destroy
 - script/generate
@@ -62,10 +65,10 @@ files:
 - website/stylesheets/screen.css
 - website/template.html.erb
 has_rdoc: true
-homepage: http://thoughtpropulsion.com
+homepage: http://github.com/Bill/route_name_for/tree/master
 post_install_message: |
-  For more information on route_name_for, see http://thoughtpropulsion.com
+  For more information on route_name_for, see http://github.com/Bill/route_name_for/tree/master
 rdoc_options:
 - --main
@@ -90,7 +93,7 @@ rubyforge_project: route_name_for
 rubygems_version: 1.2.0
 signing_key:
 specification_version: 2
-summary: Look up Rails route name given url_for parameters. Adds route_name_for method to controllers and views.
+summary: description of gem
 test_files:
 - test/test_helper.rb
 - test/test_route_name_for.rb