drtom-textacular 4.0.0.alpha.20160302

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 42f77ab66144c7716a06bc4e88e1810752077744
+  data.tar.gz: 892309c1127a3ad16b84661c5b16f597d49950b7
+SHA512:
+  metadata.gz: 96c3abd3b0e03a58450674c632f933df4cde4cf42f4ca38053ddf184c66a846315e322b09568c2f97ef4af3d42b291e4e770b602db0d9619880f54117b2a9f71
+  data.tar.gz: d53292f2c1777ec2322fa6225c715bfdec0ee1aba10d6903647a12aec308dec9e1d0e71099dc05c512125c7c116b93cec24d5f2c6dc3696df2b4068634b48cda

data/CHANGELOG.md

@@ -0,0 +1,199 @@
+# Change Log
+
+## Unreleased
+
+## 3.2.2
+
+* Fallback to zero similarity when trying to match null values
+* Fix search term escaping
+* Trigram installation migration only install extension if not installed yet.
+* Update the README to illustrate how to change the similarity threshold.
+* Remove deprecated dynamic search methods.
+
+## 3.2.1
+
+* Fix trigram installation migration reversed filename and content.
+* Rewrite all tests using RSpec.
+* We're ActiveRecord 4.2+ compatible until tests prove otherwise.
+
+## 3.2.0
+
+* Add generator for trigram installation migration.
+* Expand gemspec to allow newest version of ActiveRecord.
+
+## 3.1.0
+
+* Avoid Deprecation warnings from ActiveRecord 4.0.0.rc2.
+* Fix `method_missing` in ActiveRecord 4.0.0.rc2.
+* Remove unused `Textacular#normalize` method.
+* Add `OR` example to the README.
+* Fix tests for Ruby 2.0.0 & related improvements.
+* Improve Rails integration.
+* Fix dependency loading for textacular rake tasks.
+* Fix ranking failures when rows had `NULL` column values.
+* Clean up Rakefile; should make developing the gem nicer.
+* DEPRECATION: The dynamic search helpers will be removed at the next major
+  release.
+
+## 3.0.0
+
+* All deprecations have been resolved. This breaks backwards compatibility.
+* Rename gem to Textacular.
+
+## 2.2.0
+
+* 1 DEPRECATION
+  * The whole gem is being renamed and will no longer be maintained as Texticle.
+    The new name it Textacular.
+* 1 new feature
+  * Expand gemspec to allow Rails 4.
+
+## 2.1.1
+
+* 1 bugfix
+  * Include `lib/textacular/version.rb` in the gemspec so the gem will load. Sorry!
+
+
+## 2.1.0
+
+* 1 DEPRECATION
+  * `search` aliases new `advanced_search` method (same functionality as before), but will
+    alias `basic_search` in 3.0! Should print warnings.
+* 3 new features
+  * Generate full text search indexes from a rake task (sort of like in 1.x). Supply a specific
+    model name.
+  * New search methods: `basic_search`, `advanced_search` and `fuzzy_search`. Basic allows special
+    characters like &, and % in search terms. Fuzzy is based on Postgres's trigram matching extension
+    pg_trgm. Advanced is the same functionality from `search` previously.
+  * Rake task that installs pg_trgm now works on Postgres 9.1 and up.
+* 2 dev improvements
+  * Test database configuration not automatically generated from a rake task and ignored by git.
+  * New interactive developer console (powered by pry).
+
+
+## 2.0.3
+
+* 1 new feature
+  * Allow searching through relations. Model.join(:relation).search(:relation => {:column => "query"})
+    works, and reduces the need for multi-model tables. Huge thanks to Ben Hamill for the pull request.
+  * Allow searching through all model columns irrespective of the column's type; we cast all columns to text
+    in the search query. Performance may degrade when searching through anything but a string column.
+* 2 bugfixes
+  * Fix exceptions when adding Textacular to a table-less model.
+  * Column names in a search query are now scoped to the current table.
+* 1 dev improvement
+  * Running `rake` from the project root will setup the test environment by creating a test database
+    and running the necessary migrations. `rake` can also be used to run all the project tests.
+
+
+## 2.0.2
+
+* 1 bugfix
+  * Our #respond_to? overwritten method was causing failures when a model didn't have
+    a table (e.g. if migrations hadn't been run yet). Not the case anymore.
+
+
+## 2.0.1
+
+* 1 new feature
+  * Can now define #searchable_language to specify the language used for the query. This changes
+    what's considered a stop word on Postgres' side. 'english' is the default language.
+* 1 bugfix
+  * We were only specifying a language in to_tsvector() and not in to_tsquery(), which could
+    cause queries to fail if the default database language wasn't set to 'english'.
+
+
+## 2.0.pre4
+
+* 1 new feature
+  * Searchable is now available to specify which columns you want searched:
+
+      ```ruby
+      require 'textacular/searchable'
+      class Game
+        extend Searchable(:title)
+      end
+      ```
+
+      This also allows Textacular use in Rails without having #search available to all models:
+
+      ```
+      gem 'textacular', '~> 2.0.pre4', :require => 'textacular/searchable'
+      ```
+* 1 bugfix
+  * ActiveRecord::Base.extend(Textacular) doesn't break #method_missing and #respond_to? anymore
+
+
+## 2.0.pre3
+
+* 1 new feature
+  * #select calls now limit the columns that are searched
+* 1 bugfix
+  * #search calls without an argument assume an empty string as a search term (it errored out previously)
+
+
+## 2.0.pre2
+
+* 1 bugfix
+  * #respond_to? wasn't overwritten correctly
+
+## 2.0.pre
+
+* Complete refactoring of Textacular
+  * For users:
+    * Textacular should only be used for its simplicity; if you need to deeply configure your text search, please give `gem install pg_search` a try.
+    * `#search` method is now included in all ActiveRecord models by default, and searches across a model's :string columns.
+    * `#search_by_<column>` dynamic methods are now available.
+    * `#search` can now be chained; `Game.search_by_title("Street Fighter").search_by_system("PS3")` works.
+    * `#search` now accepts a hash to specify columns to be searched, e.g. `Game.search(:name => "Mario")`
+    * No more access to `#rank` values for results (though they're still ordered by rank).
+    * No way to give different weights to different columns in this release.
+  * For devs:
+    * We now have actual tests to run against; this will make accepting pull requests much more enjoyable.
+
+
+## HEAD (unreleased)
+
+* 1 minor bugfix
+  * Multiple named indices are now supported.
+
+
+## 1.0.4 / 2010-08-19
+
+* 2 major enhancements
+  * use Rails.root instead of RAILS_ROOT
+  * refactored tasks to ease maintainance and patchability
+* 3 minor enhancements
+  * fix timestamp for migrationfile
+  * fixed deprecation warning for rails3 (dropping rails2-support)
+  * prevented warning about defined constant
+
+
+## 1.0.3 / 2010-07-07
+
+* 1 major enhancement
+  * Added Rails 3 support.
+* 1 bugfix
+  * Model names that end in double 's's (like Address) don't choke the rake tasks anymore.
+
+
+## 1.0.2 / 2009-10-17
+
+* 1 bugfix
+  * Generated migration now uses UTC time rather than local time.
+
+
+## 1.0.1 / 2009-04-14
+
+* 1 minor enhancement
+  * Textical adds a rake task to generate FTS index migrations.  Just run:
+
+      ```
+      rake textical:migration
+      ```
+
+
+## 1.0.0 / 2009-04-14
+
+* 1 major enhancement
+  * Birthday!

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,196 @@
+# textacular
+[![Gem Version](http://img.shields.io/gem/v/textacular.svg)][rubygems]
+[![Build Status](https://img.shields.io/travis/textacular/textacular/master.svg)][travis]
+[![Code Climate](https://img.shields.io/codeclimate/github/textacular/textacular.svg)][codeclimate]
+
+[rubygems]: http://rubygems.org/gems/textacular
+[travis]: https://travis-ci.org/textacular/textacular
+[codeclimate]: https://codeclimate.com/github/textacular/textacular
+
+Further documentation available at http://textacular.github.com/textacular.
+
+
+## DESCRIPTION:
+
+Textacular exposes full text search capabilities from PostgreSQL,
+extending ActiveRecord with scopes making search easy and fun!
+
+
+## FEATURES/PROBLEMS:
+
+* Only works with PostgreSQL
+
+
+## SYNOPSIS:
+
+### Quick Start
+
+#### Rails 3 (or 4!)
+
+In the project's Gemfile add
+
+```ruby
+gem 'textacular', '~> 3.0'
+```
+
+#### ActiveRecord outside of Rails
+
+```ruby
+require 'textacular'
+
+ActiveRecord::Base.extend(Textacular)
+```
+
+
+### Usage
+
+Your models now have access to search methods:
+
+The `#basic_search` method is what you might expect: it looks literally for what
+you send to it, doing nothing fancy with the input:
+
+```ruby
+Game.basic_search('Sonic') # will search through the model's :string columns
+Game.basic_search(title: 'Mario', system: 'Nintendo')
+```
+
+The `#advanced_search` method lets you use Postgres's search syntax like '|',
+'&' and '!' ('or', 'and', and 'not') as well as some other craziness. The ideal
+use for advanced_search is to take a search DSL you make up for your users and
+translate it to PG's syntax. If for some reason you want to put user input
+directly into an advanced search, you should be sure to catch exceptions from
+syntax errors. Check [the Postgres docs]
+(http://www.postgresql.org/docs/9.2/static/datatype-textsearch.html) for more:
+
+```ruby
+Game.advanced_search(title: 'Street|Fantasy')
+Game.advanced_search(system: '!PS2')
+```
+
+Finally, the `#fuzzy_search` method lets you use Postgres's trigram search
+functionality.
+
+In order to use this, you'll need to make sure your database has the `pg_trgm`
+module installed. Create and run a migration to install the module:
+
+```
+rake textacular:create_trigram_migration
+rake db:migrate
+```
+
+Once that's installed, you can use it like this:
+
+```ruby
+Comic.fuzzy_search(title: 'Questio') # matches Questionable Content
+```
+
+Note that fuzzy searches are subject to a similarity threshold imposed by the `pg_trgm` module. The default is 0.3, meaning that at least 30% of the total string must match your search content. For example:
+
+```ruby
+Comic.fuzzy_search(title: 'Pearls') # matches Pearls Before Swine
+Comic.fuzzy_search(title: 'Pear') # does not match Pearls Before Swine
+```
+
+The similarity threshold is hardcoded in PostgreSQL and can be modified on a per-connection basis, for example:
+
+```ruby
+ActiveRecord::Base.connection.execute("SELECT set_limit(0.9);")
+```
+
+For more info, view the `pg_trgm` documentation, specifically [F.35.2. Functions and Operators](http://www.postgresql.org/docs/9.1/static/pgtrgm.html).
+
+Searches are also chainable:
+
+```ruby
+Game.fuzzy_search(title: 'tree').basic_search(system: 'SNES')
+```
+
+If you want to search on two or more fields with the OR operator use a hash for
+the conditions and pass false as the second parameter:
+
+```ruby
+Game.basic_search({name: 'Mario', nickname: 'Mario'}, false)
+```
+
+
+### Setting Language
+
+To set proper searching dictionary just override class method on your model:
+
+```ruby
+def self.searchable_language
+  'russian'
+end
+```
+
+And all your queries would go right! And don`t forget to change the migration for indexes, like shown below.
+
+
+### Creating Indexes for Super Speed
+You can have Postgresql use an index for the full-text search.  To declare a full-text index, in a
+migration add code like the following:
+
+```ruby
+execute "
+    create index on email_logs using gin(to_tsvector('english', subject));
+    create index on email_logs using gin(to_tsvector('english', email_address));"
+```
+
+In the above example, the table email_logs has two text columns that we search against, subject and email_address.
+You will need to add an index for every text/string column you query against, or else Postgresql will revert to a
+full table scan instead of using the indexes.
+
+If you create these indexes, you should also switch to sql for your schema_format in `config/application.rb`:
+
+```ruby
+config.active_record.schema_format = :sql
+```
+
+
+## REQUIREMENTS:
+
+* ActiveRecord
+* Ruby 1.9.2
+
+
+## INSTALL:
+
+```
+$ gem install textacular
+```
+
+## Contributing
+
+If you'd like to contribute, please see the [contribution guidelines](CONTRIBUTING.md).
+
+
+## Releasing
+
+Maintainers: Please make sure to follow the [release steps](RELEASING.md) when
+it's time to cut a new release.
+
+
+## LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2011 Aaron Patterson
+
+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/Rakefile

@@ -0,0 +1,61 @@
+require "bundler/gem_tasks"
+
+require 'active_record'
+require 'pry'
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+file 'spec/config.yml' do |t|
+  sh 'erb spec/config.yml.example > spec/config.yml'
+end
+
+desc 'Fire up an interactive terminal to play with'
+task :console => :'db:connect' do
+  Pry.start
+end
+
+namespace :db do
+
+  task :connect => 'spec/config.yml' do |t|
+    ActiveRecord::Base.establish_connection \
+      YAML.load_file 'spec/config.yml'
+  end
+
+  task :disconnect do
+    ActiveRecord::Base.clear_all_connections!
+  end
+
+  desc 'Create the test database'
+  task :create do
+    sh 'createdb textacular'
+  end
+
+  desc 'Drop the test database'
+  task :drop => :disconnect do
+    sh 'dropdb textacular'
+  end
+
+  namespace :migrate do
+
+    desc 'Run the test database migrations'
+    task :up => :'db:connect' do
+      ActiveRecord::Migrator.up 'db/migrate'
+    end
+
+    desc 'Reverse the test database migrations'
+    task :down => :'db:connect' do
+      ActiveRecord::Migrator.down 'db/migrate'
+    end
+  end
+  task :migrate => :'migrate:up'
+
+  desc 'Create and configure the test database'
+  task :setup => [ :create, :migrate ]
+
+  desc 'Drop the test tables and database'
+  task :teardown => [ :'migrate:down', :drop ]
+end