rtopia 0.1.0 → 0.1.1

data/README.rdoc

@@ -1,6 +1,30 @@
-= rtopia
+= Rtopia
+
+A very simple, but useful route generation helper for use anytime, anywhere.
+
+== 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
+
+    include Rtopia
+
+    R(:items) # => /items
+
+    # this appears to be redundant, take it with a grain of salt
+    # although it would probably be used for consistency's sake
+    R('/') # => '/'
+    
+    @person = Person.new # has a to_param of john-doe
+    R(@person) # => '/john-doe'
+    R(@person, :posts) # => '/john-doe/posts'
+    R(@person, :posts, :replied) # => '/john-doe/posts/replied'
+
+    @entry = Entry.create # has an id of 1001 for example
+    R(@entry) # => '/1001'
+    R(:entry, @entry) # => '/entry/1001'
 
-Description goes here.
 
 == Note on Patches/Pull Requests
  

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/rtopia.rb

@@ -5,10 +5,31 @@ module Rtopia
     @rtopia.R(*args)
   end
 
+  # Pass any collection of objects
+  # R will use it's :to_param, then :id (if ruby19), then :to_s
+  #
+  # Examples:
+  #
+  #    R(:items) # => /items
+  #    
+  #    @person = Person.new # has a to_param of john-doe
+  #    R(@person) # => '/john-doe'
+  #    R(@person, :posts) # => '/john-doe/posts'
+  #    R(@person, :posts, :replied) # => '/john-doe/posts/replied'
+  #
+  #    @entry = Entry.create # has an id of 1001 for example
+  #    R(@entry) # => '/1001'
+  #    R(:entry, @entry) # => '/entry/1001'
+  #   
   def R(*args)
     args.unshift('/').map { |arg| to_param(arg) }.join('/').squeeze('/')
   end
 
+private
+  # Primary difference of this method is that it checks if
+  # the passed object has an :id method
+  # after checking for a :to_param
+  #
   def to_param_ruby19(object)
     if object.respond_to?(:to_param)
       object.to_param
@@ -18,7 +39,10 @@ module Rtopia
       object.to_s
     end
   end
-
+  
+  # Since ruby 1.8 Objects all have a deprecated :id
+  # method which is also the same as its :object_id
+  # we can't just blindly check for an :id method
   def to_param_ruby18(object)
     if object.respond_to?(:to_param)
       object.to_param

data/rtopia.gemspec

@@ -0,0 +1,51 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rtopia}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Sinefunc"]
+  s.date = %q{2010-04-21}
+  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"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/rtopia.rb",
+     "rtopia.gemspec",
+     "test/helper.rb",
+     "test/test_rtopia.rb"
+  ]
+  s.homepage = %q{http://github.com/sinefunc/rtopia}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{A cute helper for route generation}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_rtopia.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Sinefunc
@@ -35,6 +35,7 @@ files:
 - Rakefile
 - VERSION
 - lib/rtopia.rb
+- rtopia.gemspec
 - test/helper.rb
 - test/test_rtopia.rb
 has_rdoc: true