texticle 2.1.0 → 2.1.1

data/{CHANGELOG.rdoc → CHANGELOG.md}

@@ -1,162 +1,151 @@
-== 2.1.0
+# Change Log
+
+## 2.1.1
+
+* 1 bugfix
+  * Include `lib/texticle/version.rb` in the gemspec so the gem will load. Sorry!
 
-* 1 DEPRECATION
 
+## 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
+## 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 Texticle 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
+## 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
+## 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
+## 2.0.pre4
 
+* 1 new feature
   * Searchable is now available to specify which columns you want searched:
 
+      ```ruby
       require 'texticle/searchable'
       class Game
         extend Searchable(:title)
       end
+      ```
 
-    This also allows Texticle use in Rails without having #search available to all models:
+      This also allows Texticle use in Rails without having #search available to all models:
 
+      ```
       gem 'texticle', '~> 2.0.pre4', :require => 'texticle/searchable'
-
+      ```
 * 1 bugfix
-
   * ActiveRecord::Base.extend(Texticle) doesn't break #method_missing and #respond_to? anymore
 
 
-== 2.0.pre3
+## 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
+## 2.0.pre2
 
+* 1 bugfix
   * #respond_to? wasn't overwritten correctly
 
-=== 2.0.pre
+## 2.0.pre
 
 * Complete refactoring of Texticle
-
   * For users:
-
     * Texticle 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).
+    * `#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
+## HEAD (unreleased)
 
+* 1 minor bugfix
   * Multiple named indices are now supported.
 
-=== 1.0.4 / 2010-08-19
 
-* 2 major enhancements
+## 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
+## 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
+## 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
+## 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
+## 1.0.0 / 2009-04-14
 
+* 1 major enhancement
   * Birthday!
-

data/{README.rdoc → README.md}

@@ -1,64 +1,97 @@
-= texticle
+# texticle
 
-Further documentation available at:
+Further documentation available at http://texticle.github.com/texticle.
 
-* http://tenderlove.github.com/texticle
 
-== DESCRIPTION:
+## DESCRIPTION:
 
 Texticle exposes full text search capabilities from PostgreSQL,
 extending ActiveRecord with scopes making search easy and fun!
 
-== FEATURES/PROBLEMS:
+
+## FEATURES/PROBLEMS:
 
 * Only works with PostgreSQL
 
-== SYNOPSIS:
 
-=== Quick Start
+## SYNOPSIS:
+
+### Quick Start
 
-* Rails 3
+#### Rails 3
 
 In the project's Gemfile add
 
-    gem 'texticle', '~> 2.0', :require => 'texticle/rails'
+    gem 'texticle', '~> 2.0', require: 'texticle/rails'
+
+
+#### ActiveRecord outside of Rails 3
+
+```ruby
+require 'texticle'
+
+ActiveRecord::Base.extend(Texticle)
+```
+
+
+### Usage
 
-* ActiveRecord outside of Rails 3
+Your models now have access to search methods:
 
-    require 'texticle'
-    ActiveRecord::Base.extend(Texticle)
+The `#basic_search` method is what you might expect: it looks literally for what
+you send to it, doing nothing fancy with the input:
 
-=== Usage
+```ruby
+Game.basic_search('Sonic') # will search through the model's :string columns
+Game.basic_search(title: 'Mario', system: 'Nintendo')
+```
 
-Your models now have access to the search method:
+The `#advanced_search` method lets you use Postgres's search syntax like '|',
+'&' and '!' ('or', 'and', and 'not') as well as some other craziness. Check [the
+Postgres
+docs](http://www.postgresql.org/docs/9.2/static/datatype-textsearch.html) for more:
 
-  Game.search('Sonic') # will search through the model's :string columns
-  Game.search(:title => 'Mario')
-  Game.search_by_title('Street Fighter').search_by_system('PS3')
-  Game.search_by_title_and_system('Final Fantasy', 'PS2')
-  Game.search_by_title_or_system('Final Fantasy, 'PS3')
+```ruby
+Game.advanced_search(title: 'Street|Fantasy')
+Game.advanced_search(system: '!PS2')
+```
 
-You can use '|' and '&' for logical conditions.
+Finally, the `#fuzzy_search` method lets you use Postgres's trigram search
+funcionality:
 
-  Game.search_by_title_or_system('Final Fantasy', 'PS3|Xbox')
+```ruby
+Comic.fuzzy_search(title: 'Questio') # matches Questionable Content
+```
 
-=== Setting Language
+Searches are also chainable:
+
+```ruby
+Game.fuzzy_search(title: 'tree').basic_search(system: 'SNES')
+```
+
+
+### Setting Language
 
 To set proper searching dictionary just override class method on your model:
 
-  def self.searchable_language
-    'russian'
-  end
+```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
+
+### 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:
 
-  execute "
-      create index on email_logs using gin(to_tsvector('english', subject));
-      create index on email_logs using gin(to_tsvector('english', email_address));"
+```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
@@ -66,18 +99,25 @@ 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`:
 
-  config.active_record.schema_format = :sql
+```ruby
+config.active_record.schema_format = :sql
+```
 
-== REQUIREMENTS:
+
+## REQUIREMENTS:
 
 * ActiveRecord
 * Ruby 1.9.2
 
-== INSTALL:
 
-* gem install texticle
+## INSTALL:
+
+```
+$ gem install texticle
+```
+
 
-== LICENSE:
+## LICENSE:
 
 (The MIT License)
 

data/lib/texticle/version.rb

@@ -0,0 +1,7 @@
+module Texticle
+  VERSION = '2.1.1'
+
+  def self.version
+    VERSION
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: texticle
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -116,22 +116,20 @@ email:
 - ecin@copypastel.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- Manifest.txt
-- CHANGELOG.rdoc
-- README.rdoc
+extra_rdoc_files: []
 files:
-- CHANGELOG.rdoc
+- CHANGELOG.md
 - Gemfile
 - Manifest.txt
-- README.rdoc
+- README.md
 - Rakefile
 - lib/texticle.rb
 - lib/texticle/full_text_indexer.rb
+- lib/texticle/postgres_module_installer.rb
 - lib/texticle/rails.rb
 - lib/texticle/searchable.rb
 - lib/texticle/tasks.rb
-- lib/texticle/postgres_module_installer.rb
+- lib/texticle/version.rb
 - spec/config.yml.example
 - spec/fixtures/character.rb
 - spec/fixtures/game.rb
@@ -143,9 +141,7 @@ homepage: http://texticle.github.com/texticle
 licenses:
 - MIT
 post_install_message: 
-rdoc_options:
-- --main
-- README.rdoc
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement