globalize3-jquery-autocomplete 0.1.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+gemfiles/*.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - ree
+script: "bundle exec rake spec"
+gemfile:
+  - gemfiles/rails_3.0.gemfile
+  - gemfiles/rails_3.1.gemfile
+  - gemfiles/rails_3.2.gemfile

data/Appraisals

@@ -0,0 +1,11 @@
+appraise 'rails-3.0' do
+  gem 'rails',      '~> 3.0.0'
+end
+
+appraise 'rails-3.1' do
+  gem 'rails',      '~> 3.1.0'
+end
+
+appraise 'rails-3.2' do
+  gem 'rails',      '~> 3.2.0'
+end

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in globalize3-jquery-autocomplete.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 emjot GmbH & Co. KG
+
+MIT License
+
+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.md

@@ -0,0 +1,44 @@
+# globalize3-jquery-autocomplete
+
+[![Build Status](https://travis-ci.org/emjot/globalize3-jquery-autocomplete.png?branch=master)](https://travis-ci.org/emjot/globalize3-jquery-autocomplete)
+
+Use JQuery autocomplete (via [rails3-jquery-autocomplete](https://github.com/crowdint/rails3-jquery-autocomplete)) with [globalize3](https://github.com/svenfuchs/globalize3) translated ActiveRecord models.
+
+Internals: This gem patches the `get_autocomplete_items` method (provided by rails3-jquery-autocomplete) so it works with translated model columns.
+
+## Compatibility
+
+rails3-jquery-autocomplete 1.0 and globalize3 0.3 are supported.
+
+## Installation
+
+This gem is not yet available via rubygems.
+
+Add this line to your application's Gemfile:
+
+    gem 'globalize3-jquery-autocomplete', :git => 'https://github.com/emjot/globalize3-jquery-autocomplete.git'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Simply follow the documentation at [globalize3](https://github.com/svenfuchs/globalize3) for how to translate your models
+and [rails3-jquery-autocomplete](https://github.com/crowdint/rails3-jquery-autocomplete) for how to set up autocomplete.
+
+You don't need any additional configuration. As soon as a column is translated, autocomplete will automatically be in context of the current locale.
+
+Example (in your controller):
+
+    # query for matches in the current locale (given the 'name' column of your Brand model is translated):
+    autocomplete :brand, :name
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler/setup'
+require 'appraisal'
+require 'rspec/core/rake_task'
+
+require 'bundler/gem_tasks'
+
+desc 'Default: run all tests with all supported Rails versions'
+task :default => :all
+
+desc 'Run tests with all supported Rails versions.'
+task :all => ["appraisal:install"] do
+  exec('rake appraisal spec')
+end
+
+desc 'Run all tests'
+RSpec::Core::RakeTask.new('spec') do |t|
+  t.pattern = FileList['spec/**/*_spec.rb']
+end

data/gemfiles/rails_3.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 3.0.0"
+
+gemspec :path=>"../"

data/gemfiles/rails_3.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 3.1.0"
+
+gemspec :path=>"../"

data/gemfiles/rails_3.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 3.2.0"
+
+gemspec :path=>"../"

data/globalize3-jquery-autocomplete.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'globalize3_jquery_autocomplete/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "globalize3-jquery-autocomplete"
+  spec.version       = Globalize3JqueryAutocomplete::VERSION
+  spec.authors       = ["Maximilian Herold"]
+  spec.email         = ["herold@emjot.de"]
+  spec.description   = %q{Use jQuery's autocomplete plugin with Rails 3 and globalize3 translated models.}
+  spec.summary       = %q{Use jQuery's autocomplete plugin with Rails 3 and globalize3 translated models.}
+  spec.homepage      = "https://github.com/emjot/globalize3-jquery-autocomplete"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "rails", "~> 3.0"
+  spec.add_runtime_dependency "globalize3", "~> 0.3"
+  spec.add_runtime_dependency "rails3-jquery-autocomplete", "~> 1.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "appraisal", "~> 0.5.1"
+  spec.add_development_dependency "rspec-rails", "~> 2.8.0"
+  spec.add_development_dependency "database_cleaner", "~> 0.6"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "rake"
+end

data/lib/globalize3-jquery-autocomplete.rb

@@ -0,0 +1,16 @@
+require "globalize3_jquery_autocomplete/version"
+require "globalize3_jquery_autocomplete/orm/active_record"
+
+require "rails/all"
+require "globalize3"
+require "rails3-jquery-autocomplete"
+
+ActiveSupport.on_load :action_controller do
+  if defined?(Mongoid::Document) || defined?(MongoMapper::Document)
+    if Rails.logger.try(:error?)
+      Rails.logger.error("globalize3-jquery-autocomplete only supports ActiveRecord (not Mongoid / MongoMapper)")
+    end
+  else
+    ActionController::Base.send(:include, Globalize3JQueryAutocomplete::Orm::ActiveRecord)
+  end
+end

data/lib/globalize3_jquery_autocomplete/orm/active_record.rb

@@ -0,0 +1,69 @@
+# Patch for rails3-jquery-autocomplete to work with globalize3.
+# (based on rails3-jquery-autocomplete 1.0.11)
+module Globalize3JQueryAutocomplete
+  module Orm
+    module ActiveRecord
+
+      def self.included(base)
+        base.send :include, InstanceMethods
+        base.send :alias_method_chain, :get_autocomplete_items, :globalize3
+        base.send :alias_method_chain, :get_autocomplete_select_clause, :globalize3
+      end
+
+      module InstanceMethods
+
+        def get_autocomplete_items_with_globalize3(parameters)
+          model             = parameters[:model]
+          translated_model  = find_globalized_column_class_for(model, parameters[:method])
+          model_with_method = translated_model || model
+          term    = parameters[:term]
+          method  = parameters[:method]
+          options = parameters[:options]
+          scopes  = Array(options[:scopes])
+          where   = options[:where]
+          limit   = get_autocomplete_limit(options)
+          order   = get_autocomplete_order(method, options, model_with_method)
+
+          items = model.scoped
+
+          if scopes.present?
+            scopes.each { |scope| items = items.send(scope) }
+          end
+
+          unless options[:full_model]
+            items = items.select(get_autocomplete_select_clause(model, model_with_method, method, options))
+          end
+
+          if translated_model.present?
+            items = items.with_translations(Globalize.locale)
+          end
+
+          items = items.where(get_autocomplete_where_clause(model_with_method, term, method, options)).
+              limit(limit).order(order)
+
+          items = items.where(where) if where.present?
+
+          items.all.uniq
+        end
+
+        def get_autocomplete_select_clause_with_globalize3(model_with_pk, model_with_method, method, options)
+          pk_table_name = model_with_pk.table_name
+          m_table_name  = model_with_method.table_name
+
+          (["#{pk_table_name}.#{model_with_pk.primary_key}", "#{m_table_name}.#{method}"] +
+              (options[:extra_data].presence || []))
+        end
+
+        # If the attribute of the record is globalized, returns the translation class; otherwise, returns nil.
+        def find_globalized_column_class_for(record, attribute)
+          if record.respond_to?(:translation_class) && record.translated_attribute_names.include?(attribute)
+            record.translation_class
+          else
+            nil
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/globalize3_jquery_autocomplete/version.rb

@@ -0,0 +1,3 @@
+module Globalize3JqueryAutocomplete
+  VERSION = "0.1.0"
+end

data/spec/data/models.rb

@@ -0,0 +1,7 @@
+class Post < ActiveRecord::Base
+  translates :title, :content, :published, :published_at
+end
+
+class Untranslated < ActiveRecord::Base
+end
+

data/spec/data/schema.rb

@@ -0,0 +1,23 @@
+ActiveRecord::Migration.verbose = false
+
+ActiveRecord::Schema.define do
+  create_table :posts, :force => true do |t|
+    t.string     :untranslated
+    t.integer    :rating
+  end
+
+  create_table :post_translations, :force => true do |t|
+    t.string     :locale
+    t.references :post
+    t.string     :title
+    t.text       :content
+    t.boolean    :published
+    t.datetime   :published_at
+  end
+
+  create_table :untranslateds, :force => true do |t|
+    t.string :name
+    t.integer :rating
+  end
+
+end

data/spec/orm/active_record_spec.rb

@@ -0,0 +1,161 @@
+# coding: utf-8
+require 'spec_helper'
+
+describe 'Globalize3JQueryAutocomplete::Orm::ActiveRecord' do
+  let(:helper) do
+    Rails3JQueryAutocomplete::Orm::ActiveRecordTestHelper.new()
+  end
+
+  describe "#get_autocomplete_order" do
+    describe 'order is specified' do
+      it 'should returns that order option' do
+        helper.get_autocomplete_order(:field, {:order => 'field ASC'}).should == "field ASC"
+      end
+    end
+  
+    describe 'no order is specified' do
+      it 'should return the order clause by the field ASC' do
+        helper.get_autocomplete_order(:field, {}).should == "field ASC"
+      end
+  
+      describe 'a different model is specified' do
+        it 'should return the order clause by the table_name.field ASC' do
+          model = double("model")
+          model.stub(:table_name => 'table_name')
+          helper.get_autocomplete_order(:field, {}, model).should == "table_name.field ASC"
+        end
+      end
+    end
+  end
+  
+  describe '#get_autocomplete_items' do
+    before(:each) do
+      # create 'en' posts
+      @matching_en_posts = %w(query3 QUERY query2).collect { |title| Post.create!(:title => title, :untranslated => title) }
+      other_en_posts = %w(myquery Foo bar).collect { |title| Post.create!(:title => title, :untranslated => title) }
+      Globalize.with_locale(:de) do
+        # add a 'de' translation to the first 'en' post
+        @matching_en_de_posts = [@matching_en_posts.first]
+        @matching_en_de_posts.first.update_attributes!(:title => 'query_de')
+
+        @matching_de_posts = @matching_en_de_posts.dup
+
+        # create 'de' posts
+        @matching_de_posts += %w(queryde QUERYde2).collect { |title| Post.create!(:title => title, :untranslated => title) }
+        other_de_posts = %w(myqueryde DE).collect { |title| Post.create!(:title => title, :untranslated => title) }
+      end
+
+      @matching_posts = (@matching_de_posts + @matching_en_posts).uniq
+
+      @options = {
+        :model => Post,
+        :term => 'query',
+        :options => {}
+      }
+    end
+
+    it 'should work with an untranslated column (untranslated model)' do
+      matching = Untranslated.create!(:name => 'queryme')
+      Untranslated.create!(:name => 'foo')
+      @options.merge!(:model => Untranslated, :method => :name)
+
+      helper.get_autocomplete_items(@options).should == [matching]
+    end
+
+    it 'should work with an untranslated column (translated model)' do
+      @options.merge!(:method => :untranslated)
+      helper.get_autocomplete_items(@options).should == @matching_posts.sort_by(&:untranslated)
+    end
+
+    it 'should work with a translated column' do
+      @options.merge!(:method => :title)
+      helper.get_autocomplete_items(@options).should == @matching_en_posts.sort_by(&:title)
+    end
+
+  end
+  
+  describe '#get_autocomplete_select_clause' do
+    before(:each) do
+      @model = double("model")
+      @model.stub(:table_name => 'table_name', :primary_key => 'id')
+    end
+  
+    it 'should create a select clause' do
+      helper.get_autocomplete_select_clause(@model, @model, :method, {}).should ==
+          ["table_name.id", "table_name.method"]
+    end
+  
+    describe 'with extra options' do
+      it 'should return those extra fields on the clause' do
+        options = {:extra_data => ['table_name.created_at']}
+  
+        helper.get_autocomplete_select_clause(@model, @model, :method, options).should ==
+            ["table_name.id", "table_name.method", "table_name.created_at"]
+      end
+    end
+  end
+  
+  describe '#get_autocomplete_where_clause' do
+    before(:each) do
+      @model = double("model")
+      @model.stub(:table_name => 'table_name')
+  
+      @term = 'query'
+      @options = {}
+      @method = :method
+    end
+  
+    describe 'Not Postgres' do
+      it 'should return options for where' do
+        helper.stub(:postgres?).with(@model).and_return(false)
+        helper.get_autocomplete_where_clause(@model, @term, @method, @options).should ==
+            ["LOWER(table_name.method) LIKE ?", "query%"]
+      end
+    end
+  
+    describe 'Postgres' do
+      it 'should return options for where with ILIKE' do
+        helper.stub(:postgres?).with(@model).and_return(true)
+        helper.get_autocomplete_where_clause(@model, @term, @method, @options).should ==
+            ["LOWER(table_name.method) ILIKE ?", "query%"]
+      end
+    end
+  
+    describe 'full search' do
+      it 'should return options for where with the term sourrounded by %%' do
+        helper.stub(:postgres?).with(@model).and_return(false)
+        @options[:full] = true
+        helper.get_autocomplete_where_clause(@model, @term, @method, @options).should ==
+            ["LOWER(table_name.method) LIKE ?", "%query%"]
+      end
+    end
+  end
+  
+  describe '#postgres?' do
+    before(:each) do
+      @model = double("model")
+    end
+  
+    describe 'the connection class is not postgres' do
+      before(:each) do
+        @model.stub(:connection).and_return { double("something") }
+      end
+  
+      it 'should return nil if the connection class matches PostgreSQLAdapter' do
+        helper.postgres?(@model).should be_nil
+      end
+    end
+  
+    describe 'the connection class matches PostgreSQLAdapter' do
+      before(:each) do
+        class PostgreSQLAdapter; end
+        @model.stub(:connection => PostgreSQLAdapter.new)
+      end
+  
+      it 'should return true' do
+        helper.postgres?(@model).should be_true
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,42 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '../lib/globalize3-jquery-autocomplete'))
+
+require 'fileutils'
+require 'logger'
+require 'database_cleaner'
+
+RSpec.configure do |config|
+
+  config.mock_with :rspec
+
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :truncation
+
+    tmpdir = File.join(File.dirname(__FILE__), "../tmp")
+    FileUtils.mkdir(tmpdir) unless File.exist?(tmpdir)
+    log = File.expand_path(File.join(tmpdir, "globalize3_test.log"))
+    FileUtils.touch(log) unless File.exists?(log)
+    ActiveRecord::Base.logger = Logger.new(log)
+    ActiveRecord::LogSubscriber.attach_to(:active_record)
+
+    ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
+    require File.expand_path('../data/schema', __FILE__)
+    require File.expand_path('../data/models', __FILE__)
+
+    I18n.locale = I18n.default_locale = :en
+    Globalize.locale = nil
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+
+end
+
+class Rails3JQueryAutocomplete::Orm::ActiveRecordTestHelper
+  include Rails3JQueryAutocomplete::Autocomplete
+  include Globalize3JQueryAutocomplete::Orm::ActiveRecord
+end

metadata

@@ -0,0 +1,222 @@
+--- !ruby/object:Gem::Specification 
+name: globalize3-jquery-autocomplete
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Maximilian Herold
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-03-27 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: globalize3
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 0
+        - 3
+        version: "0.3"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rails3-jquery-autocomplete
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 1
+        - 3
+        version: "1.3"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: appraisal
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 0
+        - 5
+        - 1
+        version: 0.5.1
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rspec-rails
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 47
+        segments: 
+        - 2
+        - 8
+        - 0
+        version: 2.8.0
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: database_cleaner
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 6
+        version: "0.6"
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id009
+description: Use jQuery's autocomplete plugin with Rails 3 and globalize3 translated models.
+email: 
+- herold@emjot.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- .travis.yml
+- Appraisals
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemfiles/rails_3.0.gemfile
+- gemfiles/rails_3.1.gemfile
+- gemfiles/rails_3.2.gemfile
+- globalize3-jquery-autocomplete.gemspec
+- lib/globalize3-jquery-autocomplete.rb
+- lib/globalize3_jquery_autocomplete/orm/active_record.rb
+- lib/globalize3_jquery_autocomplete/version.rb
+- spec/data/models.rb
+- spec/data/schema.rb
+- spec/orm/active_record_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/emjot/globalize3-jquery-autocomplete
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+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.8.15
+signing_key: 
+specification_version: 3
+summary: Use jQuery's autocomplete plugin with Rails 3 and globalize3 translated models.
+test_files: 
+- spec/data/models.rb
+- spec/data/schema.rb
+- spec/orm/active_record_spec.rb
+- spec/spec_helper.rb
+has_rdoc: