texticle 1.0.0

data/.autotest

@@ -0,0 +1,23 @@
+# -*- ruby -*-
+
+require 'autotest/restart'
+
+# Autotest.add_hook :initialize do |at|
+#   at.extra_files << "../some/external/dependency.rb"
+#
+#   at.libs << ":../some/external"
+#
+#   at.add_exception 'vendor'
+#
+#   at.add_mapping(/dependency.rb/) do |f, _|
+#     at.files_matching(/test_.*rb$/)
+#   end
+#
+#   %w(TestA TestB).each do |klass|
+#     at.extra_class_map[klass] = "test/test_misc.rb"
+#   end
+# end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/CHANGELOG.rdoc

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2009-04-14
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,12 @@
+.autotest
+CHANGELOG.rdoc
+Manifest.txt
+README.rdoc
+Rakefile
+lib/texticle.rb
+lib/texticle/full_text_index.rb
+lib/texticle/tasks.rb
+rails/init.rb
+test/helper.rb
+test/test_full_text_index.rb
+test/test_texticle.rb

data/README.rdoc

@@ -0,0 +1,78 @@
+= texticle
+
+* http://texticle.rubyforge.org/
+
+== DESCRIPTION:
+
+Texticle exposes full text search capabilities from PostgreSQL, and allows
+you to declare full text indexes.  Texticle will extend ActiveRecord with
+named_scope methods making searching easy and fun!
+
+== FEATURES/PROBLEMS:
+
+* Only works with PostgreSQL
+
+== SYNOPSIS:
+
+  ###
+  # In environment.rb
+
+  config.gem 'texticle'
+
+  ###
+  # Declare your index in your model
+
+  class Product < ActiveRecord::Base
+    index do
+      name
+      description
+    end
+  end
+
+  ###
+  # Use the search method
+
+  Product.search('hello world')
+
+  ###
+  # Full text searches can be sped up by creating indexes.  To create the
+  # indexes, add these lines to your Rakefile:
+  require 'rubygems'
+  require 'texticle/tasks'
+
+  # Then run:
+
+  $ rake texticle:create_indexes
+
+== REQUIREMENTS:
+
+* Texticle may be used outside rails, but works best with rails.
+
+== INSTALL:
+
+* sudo gem install texticle
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 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,16 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+$: << "lib"
+require 'texticle'
+
+Hoe.new('texticle', Texticle::VERSION) do |p|
+  p.developer('Aaron Patterson', 'aaronp@rubyforge.org')
+  p.readme_file   = 'README.rdoc'
+  p.history_file  = 'CHANGELOG.rdoc'
+  p.extra_rdoc_files  = FileList['*.rdoc']
+end
+
+# vim: syntax=Ruby

data/lib/texticle.rb

@@ -0,0 +1,76 @@
+require 'texticle/full_text_index'
+
+####
+# Texticle exposes full text search capabilities from PostgreSQL, and allows
+# you to declare full text indexes.  Texticle will extend ActiveRecord with
+# named_scope methods making searching easy and fun!
+#
+# Texticle.index is automatically added to ActiveRecord::Base.
+#
+# To declare an index on a model, just use the index method:
+#
+#   class Product < ActiveRecord::Base
+#     index do
+#       name
+#       description
+#     end
+#   end
+#
+# This will allow you to do full text search on the name and description
+# columns for the Product model.  It defines a named_scope method called
+# "search", so you can take advantage of the search like this:
+#
+#   Product.search('foo bar')
+#
+# Indexes may also be named.  For example:
+#
+#   class Product < ActiveRecord::Base
+#     index 'author' do
+#       name
+#       author
+#     end
+#   end
+#
+# A named index will add a named_scope with the index name prefixed by
+# "search".  In order to take advantage of the "author" index, just call:
+#
+#   Product.search_author('foo bar')
+#
+# Finally, column names can be ranked.  The ranks are A, B, C, and D.  This
+# lets us declare that matches in the "name" column are more important
+# than matches in the "description" column:
+#
+#   class Product < ActiveRecord::Base
+#     index do
+#       name          'A'
+#       description   'B'
+#     end
+#   end
+module Texticle
+  # The version of Texticle you are using.
+  VERSION = '1.0.0'
+
+  # A list of full text indexes
+  attr_accessor :full_text_indexes
+
+  ###
+  # Create an index with +name+ using +dictionary+
+  def index name = nil, dictionary = 'english', &block
+    search_name = ['search', name].compact.join('_')
+
+    class_eval(<<-eoruby)
+      named_scope :#{search_name}, lambda { |term|
+        {
+          :select => "\#{table_name}.*, ts_rank_cd((\#{full_text_indexes.first.to_s}),
+            plainto_tsquery(\#{connection.quote(term)\})) as rank",
+          :conditions =>
+            ["\#{full_text_indexes.first.to_s} @@ plainto_tsquery(?)", term],
+          :order => 'rank DESC'
+        }
+      }
+    eoruby
+    index_name = [table_name, name, 'fts_idx'].compact.join('_')
+    (self.full_text_indexes ||= []) <<
+      FullTextIndex.new(index_name, dictionary, self, &block)
+  end
+end

data/lib/texticle/full_text_index.rb

@@ -0,0 +1,48 @@
+module Texticle
+  class FullTextIndex # :nodoc:
+    attr_accessor :index_columns
+
+    def initialize name, dictionary, model_class, &block
+      @name           = name
+      @dictionary     = dictionary
+      @model_class    = model_class
+      @index_columns  = {}
+      @string         = nil
+      instance_eval(&block)
+    end
+
+    def create
+      @model_class.connection.execute(<<-eosql)
+        CREATE index #{@name}
+        ON #{@model_class.table_name}
+        USING gin((#{to_s}))
+      eosql
+    end
+
+    def destroy
+      @model_class.connection.execute(<<-eosql)
+        DROP index IF EXISTS #{@name}
+      eosql
+    end
+
+    def to_s
+      return @string if @string
+      vectors = []
+      @index_columns.sort_by { |k,v| k }.each do |weight, columns|
+        c = columns.map { |x| "coalesce(#{@model_class.table_name}.#{x}, '')" }
+        if weight == 'none'
+          vectors << "to_tsvector('#{@dictionary}', #{c.join(" || ' ' || ")})"
+        else
+          vectors <<
+        "setweight(to_tsvector('#{@dictionary}', #{c.join(" || ' ' || ")}), '#{weight}')"
+        end
+      end
+      @string = vectors.join(" || ' ' || ")
+    end
+
+    def method_missing name, *args
+      weight = args.shift || 'none'
+      (index_columns[weight] ||= []) << name.to_s
+    end
+  end
+end

data/lib/texticle/tasks.rb

@@ -0,0 +1,28 @@
+require 'rake'
+require 'texticle'
+
+namespace :texticle do
+  desc "Create full text indexes"
+  task :create_indexes => ['texticle:destroy_indexes'] do
+    Dir[File.join(RAILS_ROOT, 'app', 'models', '*.rb')].each do |f|
+      klass = File.basename(f, '.rb').classify.constantize
+      if klass.respond_to?(:full_text_indexes)
+        (klass.full_text_indexes || []).each do |fti|
+          fti.create
+        end
+      end
+    end
+  end
+
+  desc "Destroy full text indexes"
+  task :destroy_indexes => [:environment] do
+    Dir[File.join(RAILS_ROOT, 'app', 'models', '*.rb')].each do |f|
+      klass = File.basename(f, '.rb').classify.constantize
+      if klass.respond_to?(:full_text_indexes)
+        (klass.full_text_indexes || []).each do |fti|
+          fti.destroy
+        end
+      end
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1,3 @@
+require 'texticle'
+
+ActiveRecord::Base.extend(Texticle)

data/test/helper.rb

@@ -0,0 +1,43 @@
+require "test/unit"
+require "texticle"
+
+class TexticleTestCase < Test::Unit::TestCase
+  unless RUBY_VERSION >= '1.9'
+    undef :default_test
+  end
+
+  def setup
+    warn "#{name}" if ENV['TESTOPTS'] == '-v'
+  end
+
+  def fake_model
+    Class.new do
+      @connected    = false
+      @executed     = []
+      @named_scopes = []
+
+      class << self
+        attr_accessor :connected, :executed, :named_scopes
+
+        def connection
+          @connected = true
+          self
+        end
+
+        def execute sql
+          @executed << sql
+        end
+
+        def table_name; 'fake_model'; end
+
+        def named_scope *args
+          @named_scopes << args
+        end
+
+        def quote thing
+          "'#{thing}'"
+        end
+      end
+    end
+  end
+end

data/test/test_full_text_index.rb

@@ -0,0 +1,74 @@
+require 'helper'
+
+class TestFullTextIndex < TexticleTestCase
+  def setup
+    super
+    @fm = fake_model
+  end
+
+  def test_initialize
+    fti = Texticle::FullTextIndex.new('ft_index', 'english', @fm) do
+      name
+      value 'A'
+    end
+    assert_equal 'name',  fti.index_columns['none'].first
+    assert_equal 'value', fti.index_columns['A'].first
+  end
+
+  def test_destroy
+    fti = Texticle::FullTextIndex.new('ft_index', 'english', @fm) do
+      name
+      value 'A'
+    end
+    fti.destroy
+    assert @fm.connected
+    assert_equal 1, @fm.executed.length
+    executed = @fm.executed.first
+    assert_match "DROP index IF EXISTS #{fti.instance_variable_get(:@name)}", executed
+  end
+
+  def test_create
+    fti = Texticle::FullTextIndex.new('ft_index', 'english', @fm) do
+      name
+      value 'A'
+    end
+    fti.create
+    assert @fm.connected
+    assert_equal 1, @fm.executed.length
+    executed = @fm.executed.first
+    assert_match fti.to_s, executed
+    assert_match "CREATE index #{fti.instance_variable_get(:@name)}", executed
+    assert_match "ON #{@fm.table_name}", executed
+  end
+
+  def test_to_s_no_weight
+    fti = Texticle::FullTextIndex.new('ft_index', 'english', @fm) do
+      name
+    end
+    assert_equal "to_tsvector('english', coalesce(#{@fm.table_name}.name, ''))", fti.to_s
+  end
+
+  def test_to_s_A_weight
+    fti = Texticle::FullTextIndex.new('ft_index', 'english', @fm) do
+      name 'A'
+    end
+    assert_equal "setweight(to_tsvector('english', coalesce(#{@fm.table_name}.name, '')), 'A')", fti.to_s
+  end
+
+  def test_to_s_multi_weight
+    fti = Texticle::FullTextIndex.new('ft_index', 'english', @fm) do
+      name  'A'
+      value 'A'
+      description 'B'
+    end
+    assert_equal "setweight(to_tsvector('english', coalesce(#{@fm.table_name}.name, '') || ' ' || coalesce(#{@fm.table_name}.value, '')), 'A') || ' ' || setweight(to_tsvector('english', coalesce(#{@fm.table_name}.description, '')), 'B')", fti.to_s
+  end
+
+  def test_mixed_weight
+    fti = Texticle::FullTextIndex.new('ft_index', 'english', @fm) do
+      name
+      value 'A'
+    end
+    assert_equal "setweight(to_tsvector('english', coalesce(#{@fm.table_name}.value, '')), 'A') || ' ' || to_tsvector('english', coalesce(#{@fm.table_name}.name, ''))", fti.to_s
+  end
+end

data/test/test_texticle.rb

@@ -0,0 +1,47 @@
+require 'helper'
+
+class TestTexticle < TexticleTestCase
+  def test_index_method
+    x = fake_model
+    x.class_eval do
+      extend Texticle
+      index do
+        name
+      end
+    end
+    assert_equal 1, x.full_text_indexes.length
+    assert_equal 1, x.named_scopes.length
+
+    x.full_text_indexes.first.create
+    assert_match "#{x.table_name}_fts_idx", x.executed.first
+    assert_equal :search, x.named_scopes.first.first
+  end
+
+  def test_named_index
+    x = fake_model
+    x.class_eval do
+      extend Texticle
+      index('awesome') do
+        name
+      end
+    end
+    assert_equal 1, x.full_text_indexes.length
+    assert_equal 1, x.named_scopes.length
+
+    x.full_text_indexes.first.create
+    assert_match "#{x.table_name}_awesome_fts_idx", x.executed.first
+    assert_equal :search_awesome, x.named_scopes.first.first
+  end
+
+  def test_named_scope_select
+    x = fake_model
+    x.class_eval do
+      extend Texticle
+      index('awesome') do
+        name
+      end
+    end
+    ns = x.named_scopes.first[1].call('foo')
+    assert_match(/^#{x.table_name}\.\*/, ns[:select])
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: texticle
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Aaron Patterson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-15 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.12.1
+    version: 
+description: |-
+  Texticle exposes full text search capabilities from PostgreSQL, and allows
+  you to declare full text indexes.  Texticle will extend ActiveRecord with
+  named_scope methods making searching easy and fun!
+email: 
+- aaronp@rubyforge.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- Manifest.txt
+- CHANGELOG.rdoc
+- README.rdoc
+files: 
+- .autotest
+- CHANGELOG.rdoc
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/texticle.rb
+- lib/texticle/full_text_index.rb
+- lib/texticle/tasks.rb
+- rails/init.rb
+- test/helper.rb
+- test/test_full_text_index.rb
+- test/test_texticle.rb
+has_rdoc: true
+homepage: http://texticle.rubyforge.org/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: texticle
+rubygems_version: 1.3.2
+signing_key: 
+specification_version: 3
+summary: Texticle exposes full text search capabilities from PostgreSQL, and allows you to declare full text indexes
+test_files: 
+- test/test_full_text_index.rb
+- test/test_texticle.rb