vanities 0.1.2 → 0.1.3

data/Manifest

@@ -6,4 +6,7 @@ lib/generators/vanities/templates/vanities_controller.rb
 lib/generators/vanities/templates/vanity.rb
 lib/generators/vanities/vanities_generator.rb
 lib/vanities.rb
+test/unit/vanities_test.rb
+test/unit/vanities_test.sqlite3
+vanities_test.sqlite3
 Manifest

data/README.rdoc

@@ -1,6 +1,6 @@
 = Vanities
 
-Vanities is a gem for use with a Rails 3 project that will transform
+Vanities is a gem for use with a Rails 3/3.1 project that will transform
 URLs like this:
 
   http://example.com/users/1
@@ -23,7 +23,7 @@ example.com/users/1 (assuming a user object with an ID of 1 owned the "foo" vani
 == Common Use Cases
 
 Some common use cases for something like vanities would be:
-* user profiles (www.example.com/users/22829 => www.example.com/leeroy)
+* user profiles (www.example.com/users/22829 => www.example.com/bob)
 * specific products in an e-commerce system (www.exampleshop.com/products/19920 => www.exampleshop.com/buythis)
 
 == How To Install
@@ -35,19 +35,15 @@ Vanities is pretty simple to install.  First, a few requirements and caveats:
 <b>REST-based models</b> - every model with which you want to use vanities MUST be made
 a RESTful resource in your routes file (config/routes.rb).  This is absolutely required.
 
-<b>Rails 3</b> - vanities is built on Rails 3.  It might work with older versions of Rails, but
+<b>Rails 3</b> - vanities is built on Rails 3 or 3.1.  It might work with older versions of Rails, but
 only if you go back and reverse engineer some of the routing stuff, and possibly other things
-if using versions of Rails prior to the 2.3.x series.
+if using versions of Rails prior to the 2.3.x series. No other versions are supported.
 
 <b>ActiveRecord</b> - vanities needs a table in the database to keep track of the individual
 vanity names.  Datamapper and/or -otherorm- isn't/aren't supported out of the box, but the
 setup itself is so simple that you could probably reverse-engineer this to use another ORM
 if you wanted to.
 
-<b>Letters-Only for Vanity URLs</b> - Vanity URLs can contain letters only - no numbers.  If you
-don't like this functionality, you can manually remove the regular expression call in the
-route for the vanities controller.
-
 === Installation
 
 In your application's Gemfile, add the following line:
@@ -89,21 +85,49 @@ last route in your system.
 
 Every model that has a call to 'has_vanity' will have a vanity object associated with it.
 Each instance of your model will have one - and only one - vanity.  Vanities CANNOT be repeated
-across different models.  For example, let's say you have a user with a vanity called "leeroy", and
-a product; you cannot call the product's vanity "leeroy" as well, as that's already taken by
+across different models.  For example, let's say you have a user with a vanity called "bob", and
+a product; you cannot call the product's vanity "bob" as well, as that's already taken by
 the aforementioned user.
 
 To set up a vanity for a model, all you need to do is create a vanity.  Say you're in the Rails
 console.  This would be as simple as:
 
   u = User.first
-  u.vanity = Vanity.new(:name => "leeroy")
+  u.vanity = Vanity.new(:name => "bob")
 
-Finally, you can go to http://localhost:3000/leeroy to be automatically redirected
+Finally, you can go to http://localhost:3000/bob to be automatically redirected
 to the user's 'show' action.
 
+== About the Tests
+
+Vanities is mostly a convenience gem, nothing more.  It makes use of code already tested by Rails, and
+as such, is pretty light on its own tests.  As of version 0.1.3, Vanities includes a test to ensure that
+the 'has_vanity' method does work correctly.  <b>I fully welcome any well written tests for Vanities.</b>
+Just fork, do your work, and submit a pull request.
+
+=== Running the tests
+
+Download this gem then cd to the right directory:
+
+  cd /path/to/your/gem/install/vanities
+
+Then just use ruby to run the tests:
+
+  ruby test/unit/vanities_test.rb
+
+== What version of ActiveRecord can I use this with?
+
+Vanities should work with ActiveRecord 3.0 and 3.1 just fine.  It *probably* works with older
+versions, too. In theory, any version fo ActiveRecord that provides polymorphic associations should work,
+as long as the API stays the same. If you have doubts or questions, feel free to run the tests.
+
 == Changelog
 
-20 March 2011: Slight refactor to make the vanities controller render a 404 if it can't
+*0.1.3* 17 September 2011: Slight refactor based on suggestions from Marc Gayle (@marcgayle) to
+allow for + and - characters in routes. Also added basic test to ensure 'has_vanity' is loaded into
+ActiveRecord as an available method, and that it works to provide the polymorphic association
+necessary to make everything work.
+
+*0.1.2* 20 March 2011: Slight refactor to make the vanities controller render a 404 if it can't
 find a vanity object.  Small documentation update about routes (make sure vanities is
 the LAST route in your routes.rb file).

data/Rakefile

@@ -1,9 +1,10 @@
 require 'rubygems'
+require 'psych'
 require 'rake'
 require 'echoe'
 
-Echoe.new('vanities', '0.1.2') do |x|
-  x.description               = "Give each of your models a simple 'vanity' URL.  
+Echoe.new('vanities', '0.1.3') do |x|
+  x.description               = "Give each of your models a simple 'vanity' URL.
                                 Makes example.com/users/1 into something like example.com/foobar"
   x.url                       = "https://github.com/jaustinhughey/vanities"
   x.author                    = "J. Austin Hughey"

data/lib/generators/vanities/vanities_generator.rb

@@ -1,30 +1,31 @@
 class VanitiesGenerator < Rails::Generators::Base
   source_root File.expand_path('../templates', __FILE__)
-  
+
   # Copy over the database migration template
   def generate_vanities_migration
     copy_file "create_vanities.rb", "db/migrate/#{timestamp}_create_vanities.rb"
   end
-  
+
   # Copy over the vanity model
   def generate_vanity_model
     copy_file "vanity.rb", "app/models/vanity.rb"
   end
-  
+
   # This method actually copies over the vanities controller code
   # into app/controllers/vanities_controller.rb
   def generate_vanities_controller
     copy_file "vanities_controller.rb", "app/controllers/vanities_controller.rb"
   end
-  
+
   # Add the route to wire up the vanities controller
   # Indentation looks a little funky here because I'd strongly prefer
   # to keep the indentation in the target routes.rb file as it is
   def inject_new_route
-    route "
-  controller :vanities do 
-    match ':vname' => :show, :via => :get, :constraints => {:vname => /[A-Za-z]+/}
-  end"
+    # It seems that the 'route' method has some...strange ways of having
+    # some one escape characters...
+    route 'controller :vanities do
+    match \':vname\' => :show, :via => :get, :constraints => { :vname => /[A-Za-z0-9\-\\\\+]+/ }
+  end'
   end
 
   # This method prints some basic setup instructions for the user.
@@ -48,4 +49,4 @@ private
   def timestamp
     Time.now.strftime("%Y%m%d%H%M%S")
   end
-end
+end

data/test/unit/vanities_test.rb

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'test/unit'
+require 'active_record'
+require 'sqlite3'
+require File.expand_path("../../../lib/vanities", __FILE__)
+require File.expand_path("../../../lib/generators/vanities/templates/vanity.rb", __FILE__)
+
+# Clean up any existing sqlite3 db if it exists
+old_db_file = "vanities_test.sqlite3"
+if File.exists?(old_db_file)
+  File.delete(old_db_file)
+end
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => "vanities_test.sqlite3")
+ActiveRecord::Schema.define :version => 1 do
+  create_table :posts do |t|
+    t.string :title
+  end
+end
+
+ActiveRecord::Schema.define :version => 2 do
+  create_table :vanities do |t|
+    t.string      :name
+    t.integer     :vain_id
+    t.string      :vain_type
+  end
+end
+
+class Post < ActiveRecord::Base
+  has_vanity
+end
+
+class VanitiesTest < Test::Unit::TestCase
+  def test_has_vanity_loaded_in_new_ar_object
+    # Attempt to create (and thereby save) a new post
+    assert (@post = Post.create(:title => "blah"))
+
+    # Right now the number of vanities that exist should be zero.
+    assert Vanity.count == 0
+
+    # See if that post responds to the "vanity" getter
+    assert @post.respond_to?(:vanity)
+
+    # And see if we can set it to a new vanity
+    assert (@post.vanity = Vanity.new(:name => "foo"))
+
+    # And now that a vanity has been created, we should have exactly 1 vanity.
+    assert Vanity.count == 1
+
+    # Now if we call @post.vanity we should get the one we just created
+    assert @post.vanity == Vanity.first
+  end
+end

data/vanities.gemspec

@@ -2,22 +2,23 @@
 
 Gem::Specification.new do |s|
   s.name = %q{vanities}
-  s.version = "0.1.2"
+  s.version = "0.1.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
-  s.authors = ["J. Austin Hughey"]
-  s.date = %q{2011-03-20}
-  s.description = %q{Give each of your models a simple 'vanity' URL.  
+  s.authors = [%q{J. Austin Hughey}]
+  s.date = %q{2011-09-18}
+  s.description = %q{Give each of your models a simple 'vanity' URL.
                                 Makes example.com/users/1 into something like example.com/foobar}
   s.email = %q{jaustinhughey@gmail.com}
-  s.extra_rdoc_files = ["README.rdoc", "lib/generators/vanities/USAGE", "lib/generators/vanities/templates/create_vanities.rb", "lib/generators/vanities/templates/vanities_controller.rb", "lib/generators/vanities/templates/vanity.rb", "lib/generators/vanities/vanities_generator.rb", "lib/vanities.rb"]
-  s.files = ["README.rdoc", "Rakefile", "lib/generators/vanities/USAGE", "lib/generators/vanities/templates/create_vanities.rb", "lib/generators/vanities/templates/vanities_controller.rb", "lib/generators/vanities/templates/vanity.rb", "lib/generators/vanities/vanities_generator.rb", "lib/vanities.rb", "Manifest", "vanities.gemspec"]
+  s.extra_rdoc_files = [%q{README.rdoc}, %q{lib/generators/vanities/USAGE}, %q{lib/generators/vanities/templates/create_vanities.rb}, %q{lib/generators/vanities/templates/vanities_controller.rb}, %q{lib/generators/vanities/templates/vanity.rb}, %q{lib/generators/vanities/vanities_generator.rb}, %q{lib/vanities.rb}]
+  s.files = [%q{README.rdoc}, %q{Rakefile}, %q{lib/generators/vanities/USAGE}, %q{lib/generators/vanities/templates/create_vanities.rb}, %q{lib/generators/vanities/templates/vanities_controller.rb}, %q{lib/generators/vanities/templates/vanity.rb}, %q{lib/generators/vanities/vanities_generator.rb}, %q{lib/vanities.rb}, %q{test/unit/vanities_test.rb}, %q{test/unit/vanities_test.sqlite3}, %q{vanities_test.sqlite3}, %q{Manifest}, %q{vanities.gemspec}]
   s.homepage = %q{https://github.com/jaustinhughey/vanities}
-  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Vanities", "--main", "README.rdoc"]
-  s.require_paths = ["lib"]
+  s.rdoc_options = [%q{--line-numbers}, %q{--inline-source}, %q{--title}, %q{Vanities}, %q{--main}, %q{README.rdoc}]
+  s.require_paths = [%q{lib}]
   s.rubyforge_project = %q{vanities}
-  s.rubygems_version = %q{1.6.0}
-  s.summary = %q{Give each of your models a simple 'vanity' URL.   Makes example.com/users/1 into something like example.com/foobar}
+  s.rubygems_version = %q{1.8.9}
+  s.summary = %q{Give each of your models a simple 'vanity' URL. Makes example.com/users/1 into something like example.com/foobar}
+  s.test_files = [%q{test/unit/vanities_test.rb}]
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

metadata

@@ -1,28 +1,22 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: vanities
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.1.3
   prerelease: 
-  version: 0.1.2
 platform: ruby
-authors: 
+authors:
 - J. Austin Hughey
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-03-20 00:00:00 -06:00
-default_executable: 
+date: 2011-09-18 00:00:00.000000000Z
 dependencies: []
-
-description: |-
-  Give each of your models a simple 'vanity' URL.  
-                                  Makes example.com/users/1 into something like example.com/foobar
+description: ! "Give each of your models a simple 'vanity' URL.\n                                Makes
+  example.com/users/1 into something like example.com/foobar"
 email: jaustinhughey@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.rdoc
 - lib/generators/vanities/USAGE
 - lib/generators/vanities/templates/create_vanities.rb
@@ -30,7 +24,7 @@ extra_rdoc_files:
 - lib/generators/vanities/templates/vanity.rb
 - lib/generators/vanities/vanities_generator.rb
 - lib/vanities.rb
-files: 
+files:
 - README.rdoc
 - Rakefile
 - lib/generators/vanities/USAGE
@@ -39,40 +33,41 @@ files:
 - lib/generators/vanities/templates/vanity.rb
 - lib/generators/vanities/vanities_generator.rb
 - lib/vanities.rb
+- test/unit/vanities_test.rb
+- test/unit/vanities_test.sqlite3
+- vanities_test.sqlite3
 - Manifest
 - vanities.gemspec
-has_rdoc: true
 homepage: https://github.com/jaustinhughey/vanities
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --line-numbers
 - --inline-source
 - --title
 - Vanities
 - --main
 - README.rdoc
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "1.2"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.2'
 requirements: []
-
 rubyforge_project: vanities
-rubygems_version: 1.6.0
+rubygems_version: 1.8.9
 signing_key: 
 specification_version: 3
-summary: Give each of your models a simple 'vanity' URL.   Makes example.com/users/1 into something like example.com/foobar
-test_files: []
-
+summary: Give each of your models a simple 'vanity' URL. Makes example.com/users/1
+  into something like example.com/foobar
+test_files:
+- test/unit/vanities_test.rb