textacular 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53d7c937b144d66969445fd4dfeca06cf295ef44
-  data.tar.gz: 2c7b41331400ed32398a4e8f21c39c9c46513c30
+  metadata.gz: 3370755c291011043272f5b45c44d4c9d9ad8445
+  data.tar.gz: b0c0b7c22dd7c79b7a343af679ba5ab9cee2e817
 SHA512:
-  metadata.gz: 709e443eb8c73f0658b5b76418b08e59a9c1caa23f358b6782910554e44a899693aeb57735dc0180e8b08b92fae77c81cbf4ca2565bfcd537914e47be7633082
-  data.tar.gz: 53351eed3f6f8177aee50c80f2c596722f546d12e2cbbe4e92942c4f27cbbc28147cddd926bbdaf33b32d2be2c95031110474d7c0140aef789711b1ca672b1f7
+  metadata.gz: 9d426b395d05e45de9ac1341f7b19ae3cf35533801e2c62dba488c221c15e0a78602e4ee349f720186701dc39586899671508068f837bfdf0852a7012c9475dc
+  data.tar.gz: 031698a4ae0185a3e73fd4a191f04e1a497258958378056469228e826f28b138d0aaa5b182b209841322c47fa803f31824d2751a2b13feebb86f1e361c1f76c5

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## 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.

data/README.md

@@ -1,3 +1,4 @@
+[![Build Status](https://travis-ci.org/textacular/textacular.png)](https://travis-ci.org/textacular/textacular) [![Code Climate](https://codeclimate.com/github/textacular/textacular.png)](https://codeclimate.com/github/textacular/textacular)
 # textacular
 
 Further documentation available at http://textacular.github.com/textacular.
@@ -48,9 +49,12 @@ 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. Check [the
-Postgres
-docs](http://www.postgresql.org/docs/9.2/static/datatype-textsearch.html) for more:
+'&' 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')
@@ -58,29 +62,31 @@ Game.advanced_search(system: '!PS2')
 ```
 
 Finally, the `#fuzzy_search` method lets you use Postgres's trigram search
-funcionality.
+functionality.
 
 In order to use this, you'll need to make sure your database has the `pg_trgm`
-module installed. On your development machine, you can `require textacular/tasks` and run
+module installed. Create and run a migration to install the module:
 
 ```
-rake textacular:install_trigram
+rake textacular:create_trigram_migration
+rake db:migrate
 ```
 
-Depending on your production environment, you might be able to use the rake
-task, or you might have to manually run a command. For Postgres 9.1 and above,
-you'll want to run
+Once that's installed, you can use it like this:
 
-```sql
-CREATE EXTENSION pg_trgm;
+```ruby
+Comic.fuzzy_search(title: 'Questio') # matches Questionable Content
 ```
 
-Once that's installed, you can use it like this:
+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: 'Questio') # matches Questionable Content
+Comic.fuzzy_search(title: 'Pearls') # matches Pearls Before Swine
+Comic.fuzzy_search(title: 'Pear') # does not match Pearls Before Swine
 ```
 
+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

data/Rakefile

@@ -1,3 +1,5 @@
+require "bundler/gem_tasks"
+
 require 'active_record'
 require 'rake/testtask'
 require 'pry'

data/lib/textacular.rb

@@ -5,6 +5,8 @@ require 'textacular/version'
 module Textacular
   autoload :FullTextIndexer,         'textacular/full_text_indexer'
   autoload :PostgresModuleInstaller, 'textacular/postgres_module_installer'
+  autoload :TrigramInstaller,        'textacular/trigram_installer'
+  autoload :MigrationGenerator,      'textacular/migration_generator'
 
   def self.searchable_language
     'english'

data/lib/textacular/full_text_indexer.rb

@@ -1,9 +1,6 @@
-require 'fileutils'
-
 class Textacular::FullTextIndexer
   def generate_migration(model_name)
-    stream_output do |io|
-      io.puts(<<-MIGRATION)
+    content = <<-MIGRATION
 class #{model_name}FullTextSearch < ActiveRecord::Migration
   def self.up
     execute(<<-SQL.strip)
@@ -18,26 +15,13 @@ class #{model_name}FullTextSearch < ActiveRecord::Migration
   end
 end
 MIGRATION
-    end
-  end
-
-  def stream_output(now = Time.now.utc, &block)
-    if !@output_stream && defined?(Rails)
-      FileUtils.mkdir_p(File.dirname(migration_file_name(now)))
-      File.open(migration_file_name(now), 'w', &block)
-    else
-      @output_stream ||= $stdout
-
-      yield @output_stream
-    end
+    filename = "#{model_name.underscore}_full_text_search"
+    generator = Textacular::MigrationGenerator.new(content, filename)
+    generator.generate_migration
   end
 
   private
 
-  def migration_file_name(now = Time.now.utc)
-    File.join(Rails.root, 'db', 'migrate',"#{now.strftime('%Y%m%d%H%M%S')}_full_text_search.rb")
-  end
-
   def up_migration(model_name)
     migration_with_type(model_name, :up)
   end

data/lib/textacular/migration_generator.rb

@@ -0,0 +1,31 @@
+require 'fileutils'
+
+class Textacular::MigrationGenerator
+  def initialize(filename, content)
+    @filename = filename
+    @content = content
+  end
+
+  def generate_migration
+    stream_output do |io|
+      io.puts(@content)
+    end
+  end
+
+  def stream_output(now = Time.now.utc, &block)
+    if !@output_stream && defined?(Rails)
+      FileUtils.mkdir_p(File.dirname(migration_file_name(now)))
+      File.open(migration_file_name(now), 'w', &block)
+    else
+      @output_stream ||= $stdout
+
+      yield @output_stream
+    end
+  end
+
+  private
+
+  def migration_file_name(now = Time.now.utc)
+    File.join(Rails.root, 'db', 'migrate',"#{now.strftime('%Y%m%d%H%M%S')}_#{@filename}.rb")
+  end
+end

data/lib/textacular/tasks.rb

@@ -15,4 +15,9 @@ namespace :textacular do
 
     puts "Trigram text search module successfully installed into '#{installer.db_name}' database."
   end
+
+  desc "Create trigram installer migration"
+  task :create_trigram_migration => [:environment] do
+    installer = Textacular::TrigramInstaller.new.generate_migration
+  end
 end

data/lib/textacular/trigram_installer.rb

@@ -0,0 +1,18 @@
+class Textacular::TrigramInstaller
+  def generate_migration
+    content = <<-MIGRATION
+class InstallTrigram < ActiveRecord::Migration
+  def self.up
+    ActiveRecord::Base.connection.execute("CREATE EXTENSION pg_trgm;")
+  end
+
+  def self.down
+    ActiveRecord::Base.connection.execute("DROP EXTENSION pg_trgm;")
+  end
+end
+MIGRATION
+    filename = "install_trigram"
+    generator = Textacular::MigrationGenerator.new(content, filename)
+    generator.generate_migration
+  end
+end

data/lib/textacular/version.rb

@@ -1,5 +1,5 @@
 module Textacular
-  VERSION = '3.1.0'
+  VERSION = '3.2.0'
 
   def self.version
     VERSION

data/spec/spec_helper.rb

@@ -6,6 +6,7 @@ require 'pry'
 require 'active_record'
 require 'textacular'
 require 'textacular/searchable'
+require 'flexmock/test_unit'
 
 config = YAML.load_file File.expand_path(File.dirname(__FILE__) + '/config.yml')
 ActiveRecord::Base.establish_connection config.merge(:adapter => :postgresql)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: textacular
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Ben Hamill
@@ -10,98 +10,126 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-06 00:00:00.000000000 Z
+date: 2014-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.x
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.x
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.11.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.11.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-doc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: flexmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '4.2'
 description: |-
   Textacular exposes full text search capabilities from PostgreSQL, extending
       ActiveRecord with scopes making search easy and fun!
@@ -118,10 +146,12 @@ files:
 - Rakefile
 - lib/textacular.rb
 - lib/textacular/full_text_indexer.rb
+- lib/textacular/migration_generator.rb
 - lib/textacular/postgres_module_installer.rb
 - lib/textacular/rails.rb
 - lib/textacular/searchable.rb
 - lib/textacular/tasks.rb
+- lib/textacular/trigram_installer.rb
 - lib/textacular/version.rb
 - spec/config.yml.example
 - spec/fixtures/character.rb
@@ -140,17 +170,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Textacular exposes full text search capabilities from PostgreSQL