autocomplete_for 0.1.0

data/.gitignore

@@ -0,0 +1,5 @@
+*.log
+*.swp
+.rvmrc
+tags
+pkg

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Nulogy Corporation
+
+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.markdown

@@ -0,0 +1,40 @@
+AutocompleteFor
+===============
+
+This plugin implements model-side logic for autocompleting belongs_to associations.  It handles validations, autocompleting the same association via different fields (say name or login) and the ability to specify a custom finder block.
+
+It works out-of-the-box with existing front-end autocompletion solutions because all it does is set the value of the belongs_to association based on an attribute that can be set directly or via update_attributes (see examples below.)
+
+### Example
+
+    class Author < ActiveRecord::Base
+      # has a login and open_id column
+    end
+
+    class Post < ActiveRecord::Base
+      belongs_to :author
+
+      # set the author_login field to autocomplete by author login
+      autocomplete_for :author, :login do
+        self.author = Author.find(:first, :conditions => {:login => @author_login})
+      end
+
+      # set the author_open_id field to autocomplete by author open_id
+      autocomplete_for :author, :open_id do
+        self.author = Author.find(:first, :conditions => {:open_id => @author_open_id})
+      end
+    end
+
+Using autocomplete_for in your models to set belongs_to associations:
+
+    author = Author.create! :login => 'baz'
+    post = Post.create! :author_login => 'baz'    # automatically finds the author with the login 'baz'
+    puts post.author.login                        # will output 'baz'
+
+Errors are generated automatically if the given information does not correspond to a valid model:
+
+    author = Author.create! :login => 'baz'
+    post = Post.create :author_login => 'quux'
+    puts post.errors[:author_login]               # will print an error message
+
+Copyright (c) 2010 Nulogy Corporation, released under the MIT license

data/Rakefile

@@ -0,0 +1,41 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "autocomplete_for"
+    s.summary = "Model-side logic for autocompleting belongs_to associations"
+    s.description = "Model-side logic for autocompleting belongs_to associations"
+    s.email = "sskirby@gmail.com"
+    s.homepage = "http://github.com/sskirby/autocomplete_for"
+    s.rubyforge_project = 'autocomplete_for'
+    s.authors = ["Sean Kirby"]
+    s.add_dependency('activerecord', '~> 2.3.4')
+    s.add_development_dependency('pg')
+  end
+
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the autocomplete_for 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 autocomplete_for plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'AutocompleteFor'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.markdown')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/autocomplete_for.gemspec

@@ -0,0 +1,61 @@
+# 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{autocomplete_for}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Sean Kirby"]
+  s.date = %q{2010-09-24}
+  s.description = %q{Model-side logic for autocompleting belongs_to associations}
+  s.email = %q{sskirby@gmail.com}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    ".gitignore",
+     "MIT-LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "autocomplete_for.gemspec",
+     "lib/autocomplete_for.rb",
+     "lib/autocomplete_for/autocomplete_for.rb",
+     "rails/init.rb",
+     "test/autocomplete_for_test.rb",
+     "test/database.yml",
+     "test/schema.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/sskirby/autocomplete_for}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{autocomplete_for}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Model-side logic for autocompleting belongs_to associations}
+  s.test_files = [
+    "test/schema.rb",
+     "test/autocomplete_for_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  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
+      s.add_runtime_dependency(%q<activerecord>, ["~> 2.3.4"])
+      s.add_development_dependency(%q<pg>, [">= 0"])
+    else
+      s.add_dependency(%q<activerecord>, ["~> 2.3.4"])
+      s.add_dependency(%q<pg>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, ["~> 2.3.4"])
+    s.add_dependency(%q<pg>, [">= 0"])
+  end
+end
+

data/lib/autocomplete_for/autocomplete_for.rb

@@ -0,0 +1,101 @@
+module AutocompleteFor
+  def self.included(base)
+    base.send :extend, ClassMethods
+  end
+
+  module ClassMethods
+    def autocomplete_for association, field, options = {}, &block
+      allow_nil = options[:allow_nil] || false
+      validate :"validate_#{association}_by_#{field}"
+      before_validation :"associate_#{association}_by_#{field}"
+      instance_variable_set(:"@#{association}_#{field}_allow_nil", allow_nil)
+
+      # method to set the name of the entity to autocomplete
+      # def customer_name=(name)
+      #   @customer_name = name
+      # end
+      define_method(:"#{association}_#{field}=") do |name|
+        instance_variable_set(:"@#{association}_#{field}", name)
+      end
+
+      # method to retrieve the name of the entity to autocomplete
+      # def customer_name
+      #   self.customer_to.name : @customer_name
+      # end
+      define_method(:"#{association}_#{field}") do 
+        send(association.to_sym) ? send(association.to_sym).send(field.to_sym) : instance_variable_get(:"@#{association}_#{field}")
+      end
+
+      # Validation method to make sure the autocompleted name resolves to an actual entity
+      # def validate_customer_by_name
+      #   return unless @customer_name
+      #   return if self.customer
+      #   return if @@customer_name_allow_nil && @customer_name == "" 
+      #
+      #   self.errors.add :customer_name, "#{@customer_name} does not exist" 
+      # end
+      define_method(:"validate_#{association}_by_#{field}") do 
+        return unless instance_variable_get(:"@#{association}_#{field}") 
+        return if send(association.to_sym)
+        return if self.class.instance_variable_get(:"@#{association}_#{field}_allow_nil") && instance_variable_get(:"@#{association}_#{field}") == ""
+        self.errors.add(:"#{association}_#{field}", "\"#{instance_variable_get(:"@#{association}_#{field}")}\" does not exist")
+      end
+
+      # Resolve the autocompleted name to an actual entity
+      # def autocomplete_find_customer_by_name
+      #   if self.site
+      #     self.customer = self.site.floor_locations.find(:first, :include => :location, :conditions => {:'locations.name' => @customer_name})
+      #   end
+      # end
+      define_method(:"autocomplete_find_#{association}_by_#{field}", block)
+
+      # def associate_customer_by_name
+      #   return unless @customer_name
+      #
+      #   if @customer_name == ''
+      #     self.customer = nil
+      #     return
+      #   end
+      #
+      #   autocomplete_find_customer_by_name
+      # end
+      define_method(:"associate_#{association}_by_#{field}") do
+        return unless instance_variable_get(:"@#{association}_#{field}")
+        if instance_variable_get(:"@#{association}_#{field}") == ''
+          self.send(:"#{association}=", nil)
+          return
+        end
+
+        self.send(:"autocomplete_find_#{association}_by_#{field}")
+      end
+
+      # set up validation on association in case the customer_name isn't set
+      error_fields_name = :"@#{association}_autocomplete_error_fields"
+      error_fields = instance_variable_get(error_fields_name) || []
+      error_fields << :"#{association}_#{field}"
+
+      instance_variable_set(error_fields_name, error_fields)
+
+      unless allow_nil 
+        # we must make sure that the validate_by_customer validation runs
+        # after ALL validations on autocomplete fields
+        # see rails/activesupport/lib/active_support/callbacks.rb line #208
+        # probably won't work in Rails 3
+        @validate_callbacks.delete(:"validate_by_#{association}")
+        validate :"validate_by_#{association}" 
+        
+        unless instance_methods.include?("validate_by_#{association}")
+
+          # def validate_by_customer
+          #   self.errors.add_on_blank(:customer) unless @@customer_autocompolete_error_fields.any? {|ef| self.errors[ef]}
+          # end
+          define_method(:"validate_by_#{association}") do
+            self.errors.add_on_blank(:"#{association}") unless self.class.instance_variable_get(error_fields_name).any? {|ef| self.errors[ef]}
+          end
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, AutocompleteFor

data/lib/autocomplete_for.rb

@@ -0,0 +1 @@
+require 'autocomplete_for/autocomplete_for.rb'

data/rails/init.rb

@@ -0,0 +1 @@
+require 'autocomplete_for'

data/test/autocomplete_for_test.rb

@@ -0,0 +1,149 @@
+require 'test_helper'
+
+class AutocompleteForTest < ActiveSupport::TestCase
+  load_schema
+
+  class Vendor < ActiveRecord::Base; end
+  class Customer < ActiveRecord::Base; end
+
+  class AutoCompleteForCustomerTestModel < ActiveRecord::Base
+    belongs_to :customer
+
+    autocomplete_for :customer, :name, :allow_nil => true do
+      self.customer = Customer.find(:first, :conditions => {:name => @customer_name})
+    end
+    autocomplete_for :customer, :code, :allow_nil => true do
+      self.customer = Customer.find(:first, :conditions => {:code => @customer_code})
+    end
+  end
+
+  class AutoCompleteForVendorTestModel < ActiveRecord::Base
+    belongs_to :vendor
+
+    autocomplete_for :vendor, :name do
+      self.vendor = Vendor.find(:first, :conditions => {:name => @vendor_name})
+    end
+    autocomplete_for :vendor, :code do
+      self.vendor = Vendor.find(:first, :conditions => {:code => @vendor_code})
+    end
+  end
+
+  def setup
+    Vendor.destroy_all
+    Customer.destroy_all
+    @vendor_nil_code = Vendor.create! :name => "Nil Code"
+    @vendor = Vendor.create! :name => "Vendor Name", :code => "Vendor Code"
+    @autocomplete_for_vendor = AutoCompleteForVendorTestModel.new
+
+    @customer = Customer.create! :name => "Customer Name", :code => "Customer Code"
+    @autocomplete_for_customer = AutoCompleteForCustomerTestModel.new
+  end
+
+  test "with valid name" do
+    @autocomplete_for_vendor.update_attributes! :vendor_name => @vendor.name 
+
+    assert_equal @vendor, @autocomplete_for_vendor.vendor
+  end
+  
+  test "with invalid name" do
+    @autocomplete_for_vendor.update_attributes :vendor_name => "Not a Vendor Name"
+
+    assert_nil @autocomplete_for_vendor.vendor
+    assert @autocomplete_for_vendor.errors.on(:vendor_name)
+    assert_nil @autocomplete_for_vendor.errors.on(:vendor_code)
+    assert_nil @autocomplete_for_vendor.errors.on(:vendor)
+  end
+
+  test "with blank name" do
+    @autocomplete_for_vendor.update_attributes :vendor_name => ""
+
+    assert_nil @autocomplete_for_vendor.vendor
+    assert @autocomplete_for_vendor.errors.on(:vendor_name)
+    assert_nil @autocomplete_for_vendor.errors.on(:vendor_code)
+    assert_nil @autocomplete_for_vendor.errors.on(:vendor)
+  end
+
+  test "with nil name" do
+    @autocomplete_for_vendor.update_attributes :vendor_name => nil 
+
+    assert_nil @autocomplete_for_vendor.vendor
+    assert @autocomplete_for_vendor.errors.on(:vendor)
+    assert_nil @autocomplete_for_vendor.errors.on(:vendor_code)
+    assert_nil @autocomplete_for_vendor.errors.on(:vendor_name)
+  end
+
+  test "should clear existing association" do
+    @autocomplete_for_vendor.update_attributes! :vendor => @vendor
+    assert_equal @vendor, @autocomplete_for_vendor.vendor
+
+    @autocomplete_for_vendor.update_attributes :vendor_name => ""
+    assert_nil @autocomplete_for_vendor.vendor
+    assert @autocomplete_for_vendor.errors.on(:vendor_name)
+
+    assert_nil @autocomplete_for_vendor.errors.on(:vendor_code)
+    assert_nil @autocomplete_for_vendor.errors.on(:vendor)
+  end
+
+  test "should not clear existing association" do
+    @autocomplete_for_vendor.update_attributes! :vendor => @vendor
+    assert_equal @vendor, @autocomplete_for_vendor.vendor
+
+    @autocomplete_for_vendor.update_attributes! :vendor_name => nil
+    assert_equal @vendor, @autocomplete_for_vendor.vendor
+  end
+
+  test "should clear existing association using field that can be nil" do
+    @autocomplete_for_vendor.update_attributes! :vendor => @vendor
+    assert_equal @vendor, @autocomplete_for_vendor.vendor
+
+    @autocomplete_for_vendor.update_attributes :vendor_code => ""
+    assert_nil @autocomplete_for_vendor.vendor
+    assert @autocomplete_for_vendor.errors.on(:vendor_code)
+
+    assert_nil @autocomplete_for_vendor.errors.on(:vendor_name)
+    assert_nil @autocomplete_for_vendor.errors.on(:vendor)
+  end
+
+  test "allow_nil with valid name" do
+    @autocomplete_for_customer.update_attributes! :customer_name => @customer.name 
+
+    assert_equal @customer, @autocomplete_for_customer.customer
+  end
+  
+  test "allow_nil with invalid name" do
+    @autocomplete_for_customer.update_attributes :customer_name => "Not A Customer Name" 
+
+    assert_nil @autocomplete_for_customer.customer
+    assert @autocomplete_for_customer.errors.on(:customer_name)
+    assert_nil @autocomplete_for_customer.errors.on(:customer_code)
+    assert_nil @autocomplete_for_customer.errors.on(:customer)
+  end
+
+  test "allow_nil with blank name" do
+    @autocomplete_for_customer.update_attributes! :customer_name => "" 
+
+    assert_nil @autocomplete_for_customer.customer
+  end
+
+  test "allow_nil with nil name" do
+    @autocomplete_for_customer.update_attributes! :customer_name => nil 
+
+    assert_nil @autocomplete_for_customer.customer
+  end
+
+  test "allow_nil should clear existing association" do
+    @autocomplete_for_customer.update_attributes! :customer => @customer
+    assert_equal @customer, @autocomplete_for_customer.customer
+
+    @autocomplete_for_customer.update_attributes! :customer_name => ""
+    assert_nil @autocomplete_for_customer.customer
+  end
+
+  test "allow_nil should not clear existing association" do
+    @autocomplete_for_customer.update_attributes! :customer => @customer
+    assert_equal @customer, @autocomplete_for_customer.customer
+
+    @autocomplete_for_customer.update_attributes! :customer_name => nil
+    assert_equal @customer, @autocomplete_for_customer.customer
+  end
+end

data/test/database.yml

@@ -0,0 +1,6 @@
+postgresql:
+  adapter: postgresql
+  database: autocomplete_for_plugin_test
+  username: test
+  password: pass 
+  host: localhost

data/test/schema.rb

@@ -0,0 +1,16 @@
+ActiveRecord::Schema.define(:version => 0) do  
+  create_table :customers, :force => true do |t| 
+    t.string :name, :unique => true  
+    t.string :code, :unique => true
+  end  
+  create_table :vendors, :force => true do |t| 
+    t.string :name, :unique => true  
+    t.string :code, :unique => true
+  end  
+  create_table :auto_complete_for_customer_test_models, :force => true do |t| 
+    t.integer :customer_id  
+  end  
+  create_table :auto_complete_for_vendor_test_models, :force => true do |t| 
+    t.integer :vendor_id  
+  end  
+end 

data/test/test_helper.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'
+
+require 'test/unit' 
+require 'active_record'
+
+def load_schema 
+  config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))  
+  ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")  
+  db_adapter = ENV['DB'] || 'postgresql'
+  
+  if config[db_adapter].nil? 
+    raise "DB Adapter #{db_adapter} has no entries in database.yml."  
+  end  
+  
+  ActiveRecord::Base.establish_connection(config[db_adapter])  
+  load(File.dirname(__FILE__) + "/schema.rb")  
+  require File.dirname(__FILE__) + '/../rails/init' 
+end 

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification 
+name: autocomplete_for
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Sean Kirby
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-24 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 2
+        - 3
+        - 4
+        version: 2.3.4
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: pg
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Model-side logic for autocompleting belongs_to associations
+email: sskirby@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- .gitignore
+- MIT-LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- autocomplete_for.gemspec
+- lib/autocomplete_for.rb
+- lib/autocomplete_for/autocomplete_for.rb
+- rails/init.rb
+- test/autocomplete_for_test.rb
+- test/database.yml
+- test/schema.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/sskirby/autocomplete_for
+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: autocomplete_for
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Model-side logic for autocompleting belongs_to associations
+test_files: 
+- test/schema.rb
+- test/autocomplete_for_test.rb
+- test/test_helper.rb