vanities 0.1.1

data/Manifest

@@ -0,0 +1,9 @@
+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

data/README.rdoc

@@ -0,0 +1,92 @@
+= Vanities
+
+Vanities is a gem for use with a Rails 3 project that will transform
+URLs like this:
+
+  http://example.com/users/1
+
+Into something cool, like this:
+
+  http://example.com/foo
+
+== The Vanity URL Explained
+
+Vanities implements the concept of the "vanity URL".  Similar to a vanity
+license plate, it's a unique name or ID chosen by the user that is specific to them.
+However, this doesn't necessarily have to be for a user - in theory, any model in your
+Rails 3 application can use a vanity URL.
+
+This gem works by redirecting requests for a vanity name - say "foo" - to the object
+that owns it.  So for example, visiting example.com/foo would perform a redirect to
+example.com/users/1 (assuming a user object with an ID of 1 owned the "foo" vanity).
+
+== Common Use Cases
+
+Some common use cases for something like vanities would be:
+* user profiles (www.example.com/users/22829 => www.example.com/leeroy)
+* specific products in an e-commerce system (www.exampleshop.com/products/19920 => www.exampleshop.com/buythis)
+
+== How To Install
+
+Vanities is pretty simple to install.  First, a few requirements and caveats:
+
+=== Requirements
+
+<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
+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.
+
+<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:
+
+  gem 'vanities'
+
+Then in your console/terminal, do:
+
+  bundle install
+
+Next, while still in your terminal/console:
+
+  rails g vanities
+
+You'll see a list of instructions that it'll print out.  Next you'll want to
+open up your model that you want to have a vanity URL (say a User model) and add this
+line to it to substitute the polymorphic association that does all the magic:
+
+  has_vanity
+
+Finally, do:
+
+  rake db:migrate
+
+And you're all set!
+
+== Using vanities
+
+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
+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")
+
+Finally, you can go to http://localhost:3000/leeroy to be automatically redirected
+to the user's 'show' action.

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('vanities', '0.1.1') 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"
+  x.email                     = "jaustinhughey@gmail.com"
+  x.ignore_pattern            = ["tmp/*", "script/*"]
+  x.development_dependencies  = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/lib/generators/vanities/templates/create_vanities.rb

@@ -0,0 +1,20 @@
+class CreateVanities < ActiveRecord::Migration
+  def self.up
+    # Create the vanities table
+    create_table :vanities do |t|
+      t.string      :name
+      t.integer     :vain_id
+      t.string      :vain_type
+    end
+    
+    # Add some indexes
+    add_index :vanities, :name, :unique => true
+    add_index :vanities, :vain_id
+    add_index :vanities, :vain_type
+    
+  end
+
+  def self.down
+    drop_table :vanities
+  end
+end

data/lib/generators/vanities/templates/vanities_controller.rb

@@ -0,0 +1,8 @@
+class VanitiesController < ApplicationController
+  def show
+    v = Vanity.find_by_name params[:vname]
+    redirect_to v.vain
+    # Note that in this case, any model using the vanities system
+    # MUST be set up via REST.
+  end
+end

data/lib/generators/vanities/templates/vanity.rb

@@ -0,0 +1,16 @@
+class Vanity < ActiveRecord::Base
+  # The "Vanity" class has a polymorphic association called "vain".
+  # In any model that has a vanity entry, you can reference this association like so:
+  #
+  # has_one :vanity, :as => :vain
+  #
+  # For your convenience, there's a simpler method called 'has_vanity'.  Just call it inside
+  # any model that should have a vanity:
+  #
+  # has_vanity
+  #
+  # And that's it!  See the vanities README file for more information.
+
+  belongs_to :vain, :polymorphic => true
+  validates :name, :presence => true, :uniqueness => true
+end

data/lib/generators/vanities/vanities_generator.rb

@@ -0,0 +1,51 @@
+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"
+  end
+
+  # This method prints some basic setup instructions for the user.
+  def talk_to_user
+    puts "****************************************"
+    puts "  Thanks for installing vanities!"
+    puts "****************************************"
+    puts "Now that you've run the generator, all you have left to do are the following tasks:"
+    puts "1) rake db:migrate"
+    puts "2) In any model you want to have a vanity URL, add the line:"
+    puts "      has_vanity"
+    puts "   Inside the model, just like you would an association (this is in fact what it does)"
+    puts "3) Make sure that the model in question is set up as a RESTful resource in your"
+    puts "   project's routes file.  If it isn't, this won't work."
+    puts ""
+    puts "Check out this project's GitHub page or README.rdoc for more information."
+    puts ""
+  end
+
+private
+  def timestamp
+    Time.now.strftime("%Y%m%d%H%M%S")
+  end
+end

data/lib/vanities.rb

@@ -0,0 +1,17 @@
+module Vanities
+  def self.included(base)
+    base.extend ClassMethods
+  end
+  
+  module ClassMethods
+    def has_vanity
+      has_one :vanity, :as => :vain
+    end
+  end
+  
+  
+end
+
+class ActiveRecord::Base
+  include Vanities
+end

data/vanities.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{vanities}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["J. Austin Hughey"]
+  s.date = %q{2010-11-07}
+  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.homepage = %q{https://github.com/jaustinhughey/vanities}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Vanities", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{vanities}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Give each of your models a simple 'vanity' URL.   Makes example.com/users/1 into something like example.com/foobar}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: vanities
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- J. Austin Hughey
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-07 01:00:00 -06:00
+default_executable: 
+dependencies: []
+
+description: |-
+  Give each of your models a simple 'vanity' URL.  
+                                  Makes example.com/users/1 into something like example.com/foobar
+email: jaustinhughey@gmail.com
+executables: []
+
+extensions: []
+
+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
+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
+has_rdoc: true
+homepage: https://github.com/jaustinhughey/vanities
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Vanities
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 11
+      segments: 
+      - 1
+      - 2
+      version: "1.2"
+requirements: []
+
+rubyforge_project: vanities
+rubygems_version: 1.3.7
+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: []
+