has_handle_fallback 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+test/test.sqlite3

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Seamus Abshere
+
+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:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+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.

data/README.rdoc

@@ -0,0 +1,56 @@
+= has_handle_fallback
+
+Make it easy to use handles (callsigns/monikers/usernames) in URLs, even if they might be blank.
+
+== Quickstart
+
+  class Person < ActiveRecord::Base
+    has_handle_fallback :email
+  end
+
+This assumes that <tt>Person</tt> has the fields <tt>handle</tt> and <tt>email</tt>.
+
+  class PeopleController < ActionController::Base
+    def object
+      @object ||= Person.find_by_id_or_handle(params[:id])
+    end
+  end
+
+Then you can safely use <tt>Person#to_param</tt> in URLs, etc. because, when in doubt, the finder will use the numeric ID.
+
+  Long forms:  Person.find_by_id_or_handle('pierrebourdieu'), Person.find_by_id_or_handle(1)
+  Short forms: Person['pierrebourdieu'], Person[1]
+
+== What's going on?
+
+  def test_only_uses_handle_as_param_when_not_changed_from_value_in_database
+    pierre = Person.new :email => 'pierre.bourdieu@example.com'
+    
+    # not saved, so to_param is just blank
+    assert_equal '', pierre.to_param
+    assert_equal nil, Person[pierre.to_param]
+    
+    # no handle set, so to_param is integer primary key
+    pierre.save!
+    assert_equal pierre.id.to_s, pierre.to_param
+    assert_equal pierre, Person[pierre.to_param]
+    
+    # handle is set, but not saved, so STILL use integer primary key
+    pierre.handle = 'pierrebourdieu'
+    assert_equal pierre.id.to_s, pierre.to_param
+    assert_equal pierre, Person[pierre.to_param]
+    
+    # now handle is saved, so we can use it as the param
+    pierre.save!
+    assert_equal 'pierrebourdieu', pierre.to_param
+    assert_equal pierre, Person[pierre.to_param]
+    
+    # handle was changed, so let's use the integer primary key until it's saved again
+    pierre.handle = ''
+    assert_equal pierre.id.to_s, pierre.to_param
+    assert_equal pierre, Person[pierre.to_param]
+  end
+
+== Copyright
+
+Copyright (c) 2010 Seamus Abshere. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "has_handle_fallback"
+    gem.summary = %Q{Make it easy to use handles (callsigns/monikers/usernames) in URLs, even if they might be blank.}
+    gem.description = %Q{Make it easy to use handles (callsigns/monikers/usernames) in URLs, even if they might be blank.}
+    gem.email = "seamus@abshere.net"
+    gem.homepage = "http://github.com/seamusabshere/has_handle_fallback"
+    gem.authors = ["Seamus Abshere"]
+    gem.add_dependency 'activerecord', '~>2.3.4'
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "has_handle_fallback #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/has_handle_fallback.rb

@@ -0,0 +1,106 @@
+module HasHandleFallback
+  SUB_REGEXP = '\_\-a-zA-Z0-9'
+  REGEXP = /\A[#{SUB_REGEXP}]+\z/
+  ANTI_REGEXP = /[^#{SUB_REGEXP}]+/
+  LENGTH_RANGE = 2..32
+  RECORD_ID_REGEXP = /\A\d+\z/
+  
+  def self.str2handle(str)
+    str = str.gsub ANTI_REGEXP, ''
+    str << ('_' * LENGTH_RANGE.min - str.length) unless LENGTH_RANGE.include?(str.length)
+    str
+  end
+  
+  module ActiveRecordBaseMethods
+    def has_handle_fallback(fallback_column, options = {})
+      include InstanceMethods
+      extend ClassMethods
+      
+      class_eval do
+        cattr_accessor :has_handle_fallback_options
+        self.has_handle_fallback_options = {}
+        has_handle_fallback_options[:fallback_column] = fallback_column.to_s
+        has_handle_fallback_options[:handle_column] = options.delete(:handle_column) || 'handle'
+        
+        validate :handle_is_valid
+      end
+    end
+  end
+  
+  module ClassMethods
+    def find_by_id_or_handle(param)
+      return if param.blank?
+      param = param.to_s
+      if param.to_s =~ HasHandleFallback::RECORD_ID_REGEXP
+        find_by_id param
+      else
+        send "find_by_#{has_handle_fallback_options[:handle_column]}", param
+      end
+    end
+    alias :[] :find_by_id_or_handle
+  end
+
+  module InstanceMethods
+    def handle_is_valid
+      raw = read_attribute self.class.has_handle_fallback_options[:handle_column]
+      cooked = handle_fallback
+
+      # inline check to make sure the handle_fallback method works
+      unless cooked =~ HasHandleFallback::REGEXP and HasHandleFallback::LENGTH_RANGE.include?(cooked.length)
+        raise "Dear Developer: your handle_fallback method is not generating valid handles (generated '#{handle_fallback}' for '#{raw}')"
+      end
+      
+      # allow nils but not blanks
+      if !raw.nil? and raw.blank?
+        errors.add self.class.has_handle_fallback_options[:handle_column], "can't be blank if you're presented the opportunity to set it"
+      end
+      
+      # trapdoor for nil handles
+      return if raw.nil?
+      
+      # don't allow all integer handles, because it looks like a database record id
+      if raw =~ HasHandleFallback::RECORD_ID_REGEXP
+        errors.add self.class.has_handle_fallback_options[:handle_column], "can't be entirely composed of integers"
+      end
+      
+      # validates_format_of :handle, :with => HasHandleFallback::REGEXP, :allow_nil => true
+      unless raw =~ HasHandleFallback::REGEXP
+        errors.add self.class.has_handle_fallback_options[:handle_column], "contains invalid characters"
+      end
+      
+      # validates_length_of :handle, :in => HasHandleFallback::LENGTH_RANGE, :allow_nil => true
+      unless HasHandleFallback::LENGTH_RANGE.include? raw.length
+        errors.add self.class.has_handle_fallback_options[:handle_column], "must be #{HasHandleFallback::LENGTH_RANGE} characters in length"
+      end
+      
+      # validates_uniqueness_of :handle, :case_sensitive => false, :allow_nil => true
+      if self.class.exists? [ "LOWER(#{self.class.quoted_table_name}.`#{self.class.has_handle_fallback_options[:handle_column]}`) = ?", raw.downcase ]
+        errors.add self.class.has_handle_fallback_options[:handle_column], "isn't unique"
+      end
+    end
+    
+    def handle
+      raw = read_attribute self.class.has_handle_fallback_options[:handle_column]
+      raw.present? ? raw : handle_fallback
+    end
+
+    def handle_fallback
+      fallback = read_attribute self.class.has_handle_fallback_options[:fallback_column]
+      fallback = fallback.split('@').first if fallback.include? '@'
+      HasHandleFallback.str2handle fallback
+    end
+    
+    def to_param
+      raw = read_attribute self.class.has_handle_fallback_options[:handle_column]
+      if new_record?
+        ''
+      elsif raw.blank? or changes.include?(self.class.has_handle_fallback_options[:handle_column])
+        id.to_s
+      else
+        raw
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.extend HasHandleFallback::ActiveRecordBaseMethods

data/test/helper.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'test/unit'
+require 'active_record'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'has_handle_fallback'
+
+class Test::Unit::TestCase
+end
+
+ActiveRecord::Base.establish_connection(
+  'adapter' => 'sqlite3',
+  'database' => 'test/test.sqlite3'
+)

data/test/test_has_handle_fallback.rb

@@ -0,0 +1,83 @@
+require 'helper'
+
+ActiveRecord::Schema.define(:version => 20090819143429) do
+  create_table 'people', :force => true do |t|
+    t.string :email
+    t.string :handle
+  end
+  
+  create_table 'cats', :force => true do |t|
+    t.string :name
+    t.string :moniker
+  end
+end
+
+class Person < ActiveRecord::Base
+  has_handle_fallback :email
+end
+
+class Cat < ActiveRecord::Base
+  has_handle_fallback :name, :handle_column => 'moniker'
+end
+
+class TestHasHandleFallback < Test::Unit::TestCase
+  def test_has_handle
+    ab = Person.new :email => 'a.b@example.com', :handle => 'AB'
+    assert_equal 'AB', ab.handle
+  end
+  
+  def test_has_fallback_handle_based_on_email
+    ab = Person.new :email => 'a.b@example.com'
+    assert_equal 'ab', ab.handle
+  end
+  
+  def test_can_use_alternate_columns
+    pierre = Cat.new :name => 'Pierre Bourdieu'
+    assert_equal 'PierreBourdieu', pierre.handle
+  end
+  
+  def test_has_validations
+    assert_equal true, Person.new(:email => 'pierre.bourdieu@example.com', :handle => 'Pierre-Bourdieu_99').valid?
+    assert_equal false, Person.new(:email => 'pierre.bourdieu@example.com', :handle => 'Pierre:Bourdieu_99').valid?
+  end
+  
+  def test_can_have_nil_handle
+    assert_equal true, Person.new(:email => 'pierre.bourdieu@example.com', :handle => nil).valid?
+  end
+  
+  def test_cannot_have_blank_handle
+    assert_equal false, Person.new(:email => 'pierre.bourdieu@example.com', :handle => '          ').valid?
+  end
+  
+  def test_is_careful_with_things_that_look_like_emails
+    assert_equal 'pierrebourdieu', Person.new(:email => 'pierre.bourdieu@example.com').handle
+  end
+  
+  def test_only_uses_handle_as_param_when_not_changed_from_value_in_database
+    pierre = Person.new(:email => 'pierre.bourdieu@example.com')
+    
+    # not saved, so to_param is just blank
+    assert_equal '', pierre.to_param
+    assert_equal nil, Person[pierre.to_param]
+    
+    # no handle set, so to_param is integer primary key
+    pierre.save!
+    assert_equal pierre.id.to_s, pierre.to_param
+    assert_equal pierre, Person[pierre.to_param]
+    
+    # handle is set, but not saved, so STILL use integer primary key
+    pierre.handle = 'pierrebourdieu'
+    assert_equal pierre.id.to_s, pierre.to_param
+    assert_equal pierre, Person[pierre.to_param]
+    
+    # now handle is saved, so we can use it as the param
+    pierre.save!
+    assert_equal 'pierrebourdieu', pierre.to_param
+    assert_equal pierre, Person[pierre.to_param]
+    
+    # handle was changed, so let's use the integer primary key until it's saved again
+    pierre.handle = ''
+    assert_equal pierre.id.to_s, pierre.to_param
+    assert_equal pierre, Person[pierre.to_param]
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: has_handle_fallback
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Seamus Abshere
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-15 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.3.4
+    version: 
+description: Make it easy to use handles (callsigns/monikers/usernames) in URLs, even if they might be blank.
+email: seamus@abshere.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/has_handle_fallback.rb
+- test/helper.rb
+- test/test_has_handle_fallback.rb
+has_rdoc: true
+homepage: http://github.com/seamusabshere/has_handle_fallback
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Make it easy to use handles (callsigns/monikers/usernames) in URLs, even if they might be blank.
+test_files: 
+- test/helper.rb
+- test/test_has_handle_fallback.rb