username_suggester 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [name of plugin creator]
+
+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,30 @@
+= UsernameSuggester
+
+It generates username suggestions for users. 
+It works with MySQL and any DB that supports "RLIKE". If enough people request, I will add the support for not
+using RLIKE for those DB does not support it. (although it will be slower)
+
+==Usage
+
+Assume you have an User model with attributes :username, :firstname, :lastname
+
+  class User < ActiveRecord::Base
+    suggestions_for :username, :num_suggestions => 5,
+      :first_name_attribute => :firstname, :last_name_attribute => lastname
+    
+    ...
+    
+  end
+
+And now you can call the suggestion function like the following:
+
+  user = User.new(:firstname => "Jerry", :lastname => "Luk")
+  user.username_suggestions
+  
+You can also filter the suggestions, let's say you want the username contains at least 4 characters:
+
+  suggestions_for :username, :num_suggestions => 10,
+    :validate => Proc.new { |username| username.length >= 4 }
+
+
+Copyright (c) 2010 Presdo, released under the MIT license

data/Rakefile

@@ -0,0 +1,30 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'spec/rake/spectask'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc 'Run the specs'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ['--colour --format progress --loadby mtime --reverse']
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+desc 'Test the username_suggester plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the username_suggester plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'UsernameSuggester'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/username_suggester/suggester.rb

@@ -0,0 +1,63 @@
+require 'set'
+
+module UsernameSuggester
+  class Suggester
+    attr_reader :first_name
+    attr_reader :last_name
+    
+    # Creates a UsernameSuggester to suggest usernames
+    #
+    # ==== Parameters
+    #
+    # * <tt>:first_name</tt> - Required. 
+    # * <tt>:last_name</tt> - Required. 
+    # * <tt>:options</tt> - There is one option -- :validate. You can pass in a Proc object and the suggestion will
+    #   be returned if involving the Proc with the suggestion returns true
+    #
+    def initialize(first_name, last_name, options = {})
+      @first_name = (first_name || "").downcase
+      @last_name = (last_name || "").downcase
+      @options = options
+    end
+    
+    # Generates the combinations without the knowledge of what names are available
+    def name_combinations
+      @name_combinations ||= [
+        "#{@first_name}",
+        "#{@last_name}",
+        "#{@first_name.first}#{@last_name}",
+        "#{@first_name}#{@last_name.first}",
+        "#{@first_name}#{@last_name}",
+        "#{@last_name.first}#{@first_name}",
+        "#{@last_name}#{@first_name.first}",
+        "#{@last_name}#{@first_name}"
+      ].uniq.reject { |s| s.blank? }
+    end
+    
+    # Generates suggestions and making sure they are not in unavailable_suggestions
+    def suggest(max_num_suggestion, unavailable_suggestions = [])
+      unavailable_set = unavailable_suggestions.to_set
+      results = []
+      candidates = name_combinations.clone
+      while results.size < max_num_suggestion and !candidates.blank?
+        candidate = candidates.shift
+        if @options[:validate] and !@options[:validate].call(candidate)
+          # Do nothing
+        elsif unavailable_set.include? candidate
+          candidates << find_extended_candidate(candidate, unavailable_set)
+        else
+          results << candidate
+        end
+      end
+      results
+    end
+    
+  private
+    # Generates a candidate with "candidate<number>" which is not included in unavailable_set
+    def find_extended_candidate(candidate, unavailable_set)
+      i = 1
+      i+=1 while unavailable_set.include? "#{candidate}#{i}"
+      "#{candidate}#{i}"
+    end
+  end
+end

data/lib/username_suggester/suggestions_for.rb

@@ -0,0 +1,39 @@
+module UsernameSuggester
+  module UsernameSuggestions
+    def self.included(base)
+      base.send :extend, ClassMethods
+    end
+    
+    module ClassMethods
+      # Creates method to generate suggestions for an username attributes. Example:
+      #
+      #   suggestions_for :username, :num_suggestions => 5, 
+      #     :first_name_attribute => :first, :last_name_attribute => last
+      #
+      # will creates a "username_suggestions" method which generates suggestions of usernames based on first name
+      # and last name
+      #
+      # Available options are:
+      # <tt>:attribute</tt>:: The name of the attribute for storing username. Default is <tt>:username</tt>
+      # <tt>:first_name_attribute</tt>:: The attribute which stores the first name. Default is <tt>:first_name</tt>
+      # <tt>:last_name_attribute</tt>:: The attribute which stores the last name. Default is <tt>:last_name</tt>
+      # <tt>:num_suggestions</tt>:: Maximum suggestions generated. Default is <tt>10</tt>
+      # <tt>:validate</tt>: An Proc object which takes in an username and return true if this is an validate username
+      #
+      def suggestions_for(attribute = :username, options = {})        
+        first_name_attribute = options[:first_name_attribute] || :first_name
+        last_name_attribute = options[:last_name_attribute] || :last_name
+        num_suggestions = options[:num_suggestions] || 10
+        
+        send :define_method, "#{attribute}_suggestions".to_sym do
+          suggester = Suggester.new(read_attribute(first_name_attribute), read_attribute(last_name_attribute), options)
+          name_combinations_with_regex = suggester.name_combinations.map { |s| "^#{s}[0-9]*$" }
+          sql_conditions = Array.new(name_combinations_with_regex.size, "#{attribute} RLIKE ?").join(" OR ")
+          unavailable_choices = self.class.all(:select => attribute, 
+            :conditions => [sql_conditions].concat(name_combinations_with_regex)).map{ |c| c.read_attribute(attribute) }
+          suggester.suggest(num_suggestions, unavailable_choices)
+        end
+      end
+    end
+  end
+end

data/lib/username_suggester.rb

@@ -0,0 +1,7 @@
+# UsernameSuggester
+require "username_suggester/suggester"
+
+if defined?(ActiveRecord)
+  require "username_suggester/suggestions_for"
+  ActiveRecord::Base.send :include, UsernameSuggester::UsernameSuggestions
+end

data/spec/db/database.yml

@@ -0,0 +1,10 @@
+sqlite3:
+  :adapter: sqlite3
+  :database: vendor/plugins/username_suggester/spec/db/username_suggester.sqlite3.db
+
+# mysql:
+#   :adapter: mysql
+#   :database: username_suggester_test
+#   :username: root
+#   :password:
+#   :host: localhost

data/spec/db/schema.rb

@@ -0,0 +1,7 @@
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :users, :force => true do |t|
+    t.string :first_name
+    t.string :last_name
+    t.string :username
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+begin
+  require File.dirname(__FILE__) + '/../../../../spec/spec_helper'
+rescue LoadError
+  puts "You need to install rspec in your base app"
+  exit
+end
+
+plugin_spec_dir = File.dirname(__FILE__)
+ActiveRecord::Base.logger = Logger.new(plugin_spec_dir + "/debug.log")
+
+databases = YAML::load(IO.read(plugin_spec_dir + "/db/database.yml"))
+ActiveRecord::Base.establish_connection(databases[ENV["DB"] || "mysql"])
+load(File.join(plugin_spec_dir, "db", "schema.rb"))

data/spec/suggester_spec.rb

@@ -0,0 +1,59 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe UsernameSuggester::Suggester do
+  describe "name combinations" do
+    it "returns combinations of first name and last name" do
+      UsernameSuggester::Suggester.new("Jerry", "Luk").name_combinations.should == [
+        "jerry",
+        "luk",
+        "jluk",
+        "jerryl",
+        "jerryluk",
+        "ljerry",
+        "lukj",
+        "lukjerry"
+      ]
+    end
+
+    it "returns first name and first name initial if last name is blank" do
+      UsernameSuggester::Suggester.new("Jerry", "").name_combinations.should == [
+        "jerry",
+        "j"
+      ]
+    end
+
+    it "returns last name and last name initial if first name is blank" do
+      UsernameSuggester::Suggester.new("", "Luk").name_combinations.should == [
+        "luk",
+        "l"
+      ]
+    end
+
+    it "returns empty array for blank first name and last name" do
+      UsernameSuggester::Suggester.new("", "").name_combinations.should == []
+    end
+  end
+  
+  describe "name suggestions" do
+    before(:each) do
+      @suggester = UsernameSuggester::Suggester.new("Jerry", "Luk")
+    end
+    
+    it "returns suggestions for names that are not in the unavailable suggestions" do
+      @suggester.suggest(5, []).should == ["jerry", "luk", "jluk", "jerryl", "jerryluk"]
+    end
+    
+    it "returns extended suggestions for names that are in the unavailable suggestions" do
+      @suggester.suggest(10, ["jerry"]).should include "jerry1"
+      @suggester.suggest(10, ["jerry", "jerry1"]).should include "jerry2"
+      @suggester.suggest(10, ["jerry", "jerry1031"]).should include "jerry1"
+    end
+    
+    it "should only returns suggestions passing the validate proc" do
+      suggestions = UsernameSuggester::Suggester.new("Jerry", "Luk", 
+        :validate => Proc.new { |s| s.length <= 5 }).suggest(10, [])
+      suggestions.should include "jerry"
+      suggestions.should_not include "jerryl"
+    end
+  end
+end

data/spec/suggestions_for_spec.rb

@@ -0,0 +1,29 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+class User < ActiveRecord::Base
+  attr_accessible :first_name, :last_name, :username
+  suggestions_for :username
+end
+
+describe UsernameSuggester::UsernameSuggestions do
+  before(:each) do
+    @user = User.new(:first_name => "Jerry", :last_name => "Luk")
+  end
+  
+  it "should able to suggest usernames" do
+    suggestions = @user.username_suggestions
+    suggestions.should_not be_blank
+    suggestions.should include "jerry"
+  end
+  
+  it "should able to suggest usernames that are not taken" do
+    User.create!(:username => "jerry")
+    1.upto(10) do |i|
+      User.create!(:username => "jerry#{i}")
+    end
+    suggestions = @user.username_suggestions
+    suggestions.should_not be_blank
+    suggestions.should_not include "jerry"
+    suggestions.should include "jerry11"
+  end
+end

data/username_suggester.gemspec

@@ -0,0 +1,54 @@
+Gem::Specification.new do |s|
+  s.name = %q{username_suggester}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["jerryluk"]
+  s.date = %q{2010-06-30}
+  s.description = %q{Generates username suggestions for users}
+  s.email = %q{jerry@presdo.com}
+  s.extra_rdoc_files = [
+    "MIT-LICENSE",
+    "README.rdoc"
+  ]
+  s.files = [
+     "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "username_suggester.gemspec",
+     "lib/username_suggester.rb",
+     "lib/username_suggester/suggester.rb",
+     "lib/username_suggester/suggestions_for.rb",
+     "spec/suggestions_for_spec.rb",
+     "spec/suggester_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/db/database.yml",
+     "spec/db/schema.rb"
+  ]
+  s.homepage = %q{http://github.com/jerryluk/username_suggester}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Generates username suggestions for users}
+  s.test_files = [
+    "spec/suggestions_for_spec.rb",
+    "spec/suggester_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/db/database.yml",
+    "spec/db/schema.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
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: username_suggester
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- jerryluk
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-30 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: Generates username suggestions for users
+email: jerry@presdo.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- MIT-LICENSE
+- README.rdoc
+files: 
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- username_suggester.gemspec
+- lib/username_suggester.rb
+- lib/username_suggester/suggester.rb
+- lib/username_suggester/suggestions_for.rb
+- spec/suggestions_for_spec.rb
+- spec/suggester_spec.rb
+- spec/spec_helper.rb
+- spec/db/database.yml
+- spec/db/schema.rb
+has_rdoc: true
+homepage: http://github.com/jerryluk/username_suggester
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Generates username suggestions for users
+test_files: 
+- spec/suggestions_for_spec.rb
+- spec/suggester_spec.rb
+- spec/spec_helper.rb
+- spec/db/database.yml
+- spec/db/schema.rb