rtopia 0.2.1 → 0.2.3

data/.gitignore

@@ -20,3 +20,4 @@ pkg
 
 ## PROJECT::SPECIFIC
 /doc
+/.yardoc

data/{README.rdoc → README.markdown}

@@ -1,12 +1,16 @@
-= Rtopia
+Rtopia
+======
 
-A very simple, but useful route generation helper for use anytime, anywhere.
+A very simple, but useful route generation helper for use anytime, anywhere. 
+See documentation at [http://labs.sinefunc.com/rtopia/doc](http://labs.sinefunc.com/rtopia/doc).
 
-== Assumptions
+Assumptions
+-----------
 
 It checks for a `to_param`, and if Ruby1.9 or greater is used, checks for an `id`. Last fallback uses `to_s`.
 
-== Examples
+Examples
+--------
 
     include Rtopia
 
@@ -24,18 +28,3 @@ It checks for a `to_param`, and if Ruby1.9 or greater is used, checks for an `id
     @entry = Entry.create # has an id of 1001 for example
     R(@entry) # => '/1001'
     R(:entry, @entry) # => '/entry/1001'
-
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2010 Sinefunc. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.2.3

data/lib/rtopia.rb

@@ -2,10 +2,12 @@ require 'uri'
 require 'cgi'
 
 module Rtopia
+  VERSION = "0.2.3"
+
   # In order to be able to do `Rtopia::R`, Rtopia needs to extend itself
   extend self
 
-  # Usage:
+  # @example
   #
   #    R(:items) # => /items
   #    
@@ -24,19 +26,39 @@ module Rtopia
   #    R(:user => { :lname => 'Doe', :fname => 'John' })
   #    => '?user[lname]=Doe&user[fname]=John'
   #
+  #    R("http://google.com/search", :q => "Robots")
+  #    => 'http://google.com/search?q=Robots'
+  #
+  # @overload R()
+  #   @return [String] returns the root '/'
+  # @overload R(:arg1, :arg2, ..., :argN)
+  #   @return [String] all args joined on '/' prefixed with '/'
+  # @overload R(:arg1, :arg2, ..., :argN, hash)
+  #   @param [#to_param] arg1 any object checked for #to_param, #id, and #to_s
+  #   @param [#to_param] arg2 any object checked for #to_param, #id, and #to_s
+  #   @param [#to_param] argN any object checked for #to_param, #id, and #to_s
+  #   @param [Hash] hash to be represented as a query string.
+  #   @return [String] all args joined on '/' with the hash represented
+  #     as a query string.
+  # @overload R(hash)
+  #   @param [Hash] hash to be represented as a query string.
+  #   @return [String] the hash represented as a query string, prefix with a `?`
   def R(*args)
     hash = args.last.is_a?(Hash) ? args.pop : {}
 
-    # No args, so we opt to make ?q=Ruby&page=1 style URIs
-    if hash.any? and args.empty?
-      '?' + query_string(hash)
-    else
-      r = args.unshift('/').map { |arg| to_param(arg) }.join('/').squeeze('/')
+    return '?' + query_string(hash)  if hash.any? and args.empty?
+
+    host_with_port = args.shift  if args.first =~ /^(https?|ftp)/
+
+    path = args.unshift('/').map { |arg| to_param(arg) }.join('/').squeeze('/')
+
+    path.tap do |ret|
       if hash.any?
-        r << '?'
-        r << query_string(hash)
+        ret.gsub!(/^\//, '')  if ret == '/'
+        ret << '?'
+        ret << query_string(hash)
       end
-      r
+      ret.insert(0, host_with_port.gsub(/\/$/, ''))  if host_with_port
     end
   end
 

data/rtopia.gemspec

@@ -5,22 +5,22 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rtopia}
-  s.version = "0.2.1"
+  s.version = "0.2.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Sinefunc"]
-  s.date = %q{2010-04-25}
+  s.date = %q{2010-05-25}
   s.description = %q{For use anywhere you have objects with to_params, ids, or just to_s's}
   s.email = %q{sinefunc@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+     "README.markdown"
   ]
   s.files = [
     ".document",
      ".gitignore",
      "LICENSE",
-     "README.rdoc",
+     "README.markdown",
      "Rakefile",
      "VERSION",
      "lib/rtopia.rb",

data/test/test_rtopia.rb

@@ -78,4 +78,28 @@ class TestRtopia < Test::Unit::TestCase
     assert_equal '/users?user%5Blname%5D=Doe&user%5Bfname%5D=John', 
       R(:users, :user => { :lname => 'Doe', :fname => 'John' })
   end
+
+  def test_Rtopia_R_of_string_prefixed_with_slash
+    assert_equal '/the-right-path', R('/the-right-path') 
+  end
+
+  def test_Rtopia_R_of_string_prefix_with_http
+    assert_equal 'http://test.host/arg1/arg2', 
+      R('http://test.host', :arg1, :arg2)
+  end
+
+  def test_Rtopia_R_of_string_prefix_with_http_and_hash
+    assert_equal 'http://test.host/arg1/arg2?key1=value1&key2=value2', 
+      R('http://test.host', :arg1, :arg2, :key1 => :value1, :key2 => :value2)
+  end
+
+  def test_Rtopia_R_of_string_prefix_with_http_and_hash_and_suffixed
+    assert_equal 'http://test.host/arg1/arg2?key1=value1&key2=value2', 
+      R('http://test.host/', :arg1, :arg2, :key1 => :value1, :key2 => :value2)
+  end
+  
+  def test_facebook_oauth_example
+    assert_equal "https://graph.facebook.com/oauth/authorize?client_id=123",
+      R('https://graph.facebook.com/oauth/authorize', :client_id => '123')
+  end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 1
-  version: 0.2.1
+  - 3
+  version: 0.2.3
 platform: ruby
 authors: 
 - Sinefunc
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-25 00:00:00 +08:00
+date: 2010-05-25 00:00:00 +08:00
 default_executable: 
 dependencies: []
 
@@ -26,12 +26,12 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.markdown
 files: 
 - .document
 - .gitignore
 - LICENSE
-- README.rdoc
+- README.markdown
 - Rakefile
 - VERSION
 - lib/rtopia.rb