pg_search 0.6.4 → 0.7.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cdc3e1fa91903e87b5f1a6dfb0ac0318061e7646
+  data.tar.gz: 16186ed72bc2e8bbc57c0c7949a6b051756db408
+SHA512:
+  metadata.gz: 58ded3351aca03cc89d6c23815845a4f8835b981f68755bae65ba202360e4afb5273e11683d6de1896d21f52f4c81fb921ed6b37c544113aa4bde01cc8c28018
+  data.tar.gz: 7603d827a286170f0a69a7e77b452ba7919f5e858a0ed0ee2eea196108d25654070417386ccdee7a377d7221c0a06091bd6e4608ea5627697716b5f55988af73

data/.travis.yml

@@ -1,45 +1,24 @@
 language: ruby
 
 rvm:
-  - 1.8.7
   - 1.9.3
   - 2.0.0
-  - jruby-18mode
   - jruby-19mode
-  - rbx-18mode
   - rbx-19mode
-  - ree
 
 env:
   - ACTIVE_RECORD_BRANCH="master"
   - ACTIVE_RECORD_BRANCH="4-0-stable"
+  - ACTIVE_RECORD_VERSION="~> 4.0.0"
   - ACTIVE_RECORD_VERSION="~> 3.2.0"
   - ACTIVE_RECORD_VERSION="~> 3.1.0"
 
 matrix:
   allow_failures:
-    - rvm: rbx-18mode
     - rvm: rbx-19mode
     - rvm: jruby-19mode
     - env: ACTIVE_RECORD_BRANCH="master"
     - env: ACTIVE_RECORD_BRANCH="4-0-stable"
-  exclude:
-    - rvm: 1.8.7
-      env: ACTIVE_RECORD_BRANCH="master"
-    - rvm: 1.8.7
-      env: ACTIVE_RECORD_BRANCH="4-0-stable"
-    - rvm: jruby-18mode
-      env: ACTIVE_RECORD_BRANCH="master"
-    - rvm: jruby-18mode
-      env: ACTIVE_RECORD_BRANCH="4-0-stable"
-    - rvm: rbx-18mode
-      env: ACTIVE_RECORD_BRANCH="master"
-    - rvm: rbx-18mode
-      env: ACTIVE_RECORD_BRANCH="4-0-stable"
-    - rvm: ree
-      env: ACTIVE_RECORD_BRANCH="master"
-    - rvm: ree
-      env: ACTIVE_RECORD_BRANCH="4-0-stable"
 
 before_script:
   - "psql -c 'create database pg_search_test;' -U postgres >/dev/null"

data/CHANGELOG.rdoc

@@ -1,5 +1,9 @@
 = PgSearch
 
+== 0.7.0
+
+* Start requiring Ruby 1.9.2 or later
+
 == 0.6.4
 
 * Fix issue with using more than two features in the same scope

data/Gemfile

@@ -8,7 +8,9 @@ gem "activerecord-jdbcpostgresql-adapter", :platform => :jruby
 gem "activerecord", ENV["ACTIVE_RECORD_VERSION"] if ENV["ACTIVE_RECORD_VERSION"]
 gem "activerecord", :github => "rails", :branch => ENV["ACTIVE_RECORD_BRANCH"] if ENV["ACTIVE_RECORD_BRANCH"]
 
-gem 'coveralls', :require => false, :platform => :mri_20
+if ENV["TRAVIS"]
+  gem 'coveralls', :require => false, :platform => :mri_20
+end
 
 group :development do
   gem 'guard-rspec', :require => false

data/README.rdoc

@@ -16,6 +16,7 @@ Read the blog post introducing PgSearch at http://pivotallabs.com/pg-search/
 
 == REQUIREMENTS
 
+* Ruby 1.9.2 or later
 * Active Record 3.1 or later
 * PostgreSQL
 * {PostgreSQL contrib packages for certain features}[https://github.com/Casecommons/pg_search/wiki/Installing-Postgres-Contrib-Modules]
@@ -24,7 +25,7 @@ Read the blog post introducing PgSearch at http://pivotallabs.com/pg-search/
 
  gem install pg_search
 
-=== Rails 3.1 or later
+=== Rails 3.1 or later, Ruby 1.9.2 or later
 
 In Gemfile
 
@@ -52,6 +53,14 @@ In addition to installing and requiring the gem, you may want to include the PgS
 
  load "pg_search/tasks.rb"
 
+=== Ruby 1.8.7 or earlier
+
+The newest versions of PgSearch no longer support Ruby 1.8.7. However, the 0.6 series still works. It's not actively maintained, but submissions are welcome for backports and bugfixes.
+
+ gem 'pg_search', "~> 0.6.4"
+
+The 0.6 branch lives at https://github.com/Casecommons/pg_search/tree/0.6-stable
+
 == USAGE
 
 To add PgSearch to an Active Record model, simply include the PgSearch module.
@@ -598,6 +607,51 @@ To use this functionality you'll need to do a few things:
 
 Please note that the :against column is only used when the tsvector_column is not present for the search type.
 
+=== Configuring ranking and ordering
+
+==== :ranked_by (Choosing a ranking algorithm)
+
+By default, pg_search ranks results based on the :tsearch similarity between the searchable text and the query. To use a different ranking algorithm, you can pass a :ranked_by option to pg_search_scope.
+
+    pg_search_scope :search_by_tsearch_but_rank_by_trigram,
+                    :against => :title,
+                    :using => [:tsearch],
+                    :ranked_by => ":trigram"
+
+Note that :ranked_by using a String to represent the ranking expression. This allows for more complex possibilities. Strings like ":tsearch", ":trigram", and ":dmetaphone" are automatically expanded into the appropriate SQL expressions.
+
+    # Weighted ranking to balance multiple approaches
+    :ranked_by => ":dmetaphone + (0.25 * :trigram)"
+
+    # A more complex example, where books.num_pages is an integer column in the table itself
+    :ranked_by => "(books.num_pages * :trigram) + (:tsearch / 2.0)"
+
+==== :order_within_rank (Breaking ties)
+
+PostgreSQL does not guarantee a consistent order when multiple records have the same value in the ORDER BY clause. This can cause trouble with pagination. 
+
+Imagine a case where 12 records all have the same ranking value. If you use a pagination library such as {kaminari}[https://github.com/amatsuda/kaminari] or {will_paginate}[https://github.com/mislav/will_paginate] to return results in pages of 10, then you would expect to see 10 of the records on page 1, and the remaining 2 records at the top of the next page, ahead of lower-ranked results.
+
+But since there is no consistent ordering, PostgreSQL might choose to rearrange the order of those 12 records between different SQL statements. You might end up getting some of the same records from page 1 on page 2 as well, and likewise there may be records that don't show up at all.
+
+pg_search fixes this problem by adding a second expression to the ORDER BY clause, after the :ranked_by expression explained above. By default, the tiebreaker order is ascending by id.
+
+    ORDER BY [complicated :ranked_by expression...], id ASC
+
+This might not be desirable for your application, especially if you do not want old records to outrank new records. By passing an :order_within_rank, you can specify an alternate tiebreaker expression. A common example would be descending by updated_at, to rank the most recently updated records first.
+
+    pg_search_scope :search_and_break_ties_by_latest_update,
+                    :against => [:title, :content],
+                    :order_within_rank => "blog_posts.updated_at DESC"
+
+==== PgSearch#pg_search_rank (Reading a record's rank as a Float)
+
+It may be useful or interesting to see the rank of a particular record. This can be helpful for debugging why one record outranks another. You could also use it to show some sort of relevancy value to end users of an application. Just call .pg_search_rank on a record returned by a pg_search_scope.
+
+    shirt_brands = ShirtBrand.search_by_name("Penguin")
+    shirt_brands[0].pg_search_rank #=> 0.0759909
+    shirt_brands[1].pg_search_rank #=> 0.0607927
+
 == ATTRIBUTIONS
 
 PgSearch would not have been possible without inspiration from

data/lib/pg_search/version.rb

@@ -1,3 +1,3 @@
 module PgSearch
-  VERSION = "0.6.4"
+  VERSION = "0.7.0"
 end

data/pg_search.gemspec

@@ -28,4 +28,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'with_model'
   s.add_development_dependency 'will_paginate'
+
+  s.required_ruby_version = ">= 1.9.2"
 end

data/spec/spec_helper.rb

@@ -1,10 +1,12 @@
 require "bundler/setup"
 require "pg_search"
 
-begin
-  require 'coveralls'
-  Coveralls.wear!
-rescue LoadError
+if ENV["TRAVIS"]
+  begin
+    require 'coveralls'
+    Coveralls.wear!
+  rescue LoadError
+  end
 end
 
 begin

metadata

@@ -1,162 +1,151 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: pg_search
-version: !ruby/object:Gem::Version 
-  hash: 15
-  prerelease: 
-  segments: 
-  - 0
-  - 6
-  - 4
-  version: 0.6.4
+version: !ruby/object:Gem::Version
+  version: 0.7.0
 platform: ruby
-authors: 
+authors:
 - Grant Hutchins
 - Case Commons, LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-05-26 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activerecord
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 3
-        - 1
-        version: "3.1"
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: activesupport
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 5
-        segments: 
-        - 3
-        - 1
-        version: "3.1"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: arel
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: arel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: rdoc
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: pry
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id006
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: with_model
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: with_model
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id008
-- !ruby/object:Gem::Dependency 
-  name: will_paginate
   prerelease: false
-  requirement: &id009 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: will_paginate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id009
-description: PgSearch builds Active Record named scopes that take advantage of PostgreSQL's full text search
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: PgSearch builds Active Record named scopes that take advantage of PostgreSQL's
+  full text search
+email:
 - gems@nertzy.com
 - casecommons-dev@googlegroups.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .autotest
 - .gitignore
 - .rspec
@@ -214,39 +203,31 @@ files:
 - sql/uninstall_unnest.sql
 - sql/unnest.sql
 homepage: https://github.com/Casecommons/pg_search
-licenses: 
+licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+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"
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
-summary: PgSearch builds Active Record named scopes that take advantage of PostgreSQL's full text search
-test_files: 
+specification_version: 4
+summary: PgSearch builds Active Record named scopes that take advantage of PostgreSQL's
+  full text search
+test_files:
 - spec/integration/associations_spec.rb
 - spec/integration/pagination_spec.rb
 - spec/integration/pg_search_spec.rb