searcher 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+pkg/*
+*.gem
+.bundle
+tmp/*.log

data/Gemfile

@@ -0,0 +1,9 @@
+source :gemcutter
+
+group(:test) do
+  gem 'sqlite3-ruby'
+  gem 'rspec'
+end
+
+# Specify your gem's dependencies in searcher.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    searcher (0.0.1)
+      activerecord (~> 3.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      arel (~> 1.0.0)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.0)
+    arel (1.0.1)
+      activesupport (~> 3.0.0)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    i18n (0.4.1)
+    rspec (2.0.0.beta.22)
+      rspec-core (= 2.0.0.beta.22)
+      rspec-expectations (= 2.0.0.beta.22)
+      rspec-mocks (= 2.0.0.beta.22)
+    rspec-core (2.0.0.beta.22)
+    rspec-expectations (2.0.0.beta.22)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.0.beta.22)
+      rspec-core (= 2.0.0.beta.22)
+      rspec-expectations (= 2.0.0.beta.22)
+    sqlite3-ruby (1.3.1)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 3.0.0)
+  bundler (>= 1.0.0)
+  rspec
+  searcher!
+  sqlite3-ruby

data/README.md

@@ -0,0 +1,38 @@
+# Searcher
+
+Searcher is a pure SQL implementation which lets you find by pre-defined labels, as well as wildcard matching queries. It should be used as a lo-fi precursor to a proper full-text search platform, such as the built-in one to PostgreSQL.
+
+The idea of this gem came from Joost Schuur.
+
+This gem is used in Chapter 10 of Rails 3 in Action and was crafted specifically for it. YMMV.
+
+## Installation
+
+This gem is only compatible with versions of Active Record that are greater than or equal to 3.0. You *are* using Active Record 3, right?
+
+Add this gem to your _Gemfile_ (You *are* using Bundler, right?):
+
+    gem 'searcher'
+    
+## Usage
+
+To define labels for your field, use the `searcher` method inside your model like this:
+
+    class Ticket < ActiveRecord::Base
+      has_and_belongs_to_many :tags
+      
+      searcher do
+        external :tag, :from => :tags, :field => "name"
+        external :state, :from => :state, :field => "name"
+      end
+    end
+    
+To query for these labels, use the `search` class method on your model:
+
+    Ticket.search("tag:v3.0.0 state:open")
+    
+Boom! There's all your tickets that have the tag v3.0.0 and are marked (state-wise) as being open.
+        
+## Caveats
+
+Currently Searcher works only with `has_and_belongs_to_many` and `belongs_to` associations, as that is all that is needed in the book.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/searcher/class_methods.rb

@@ -0,0 +1,25 @@
+require 'searcher/config'
+
+module Searcher
+  module ClassMethods
+    def searcher(&block)
+      Searcher.classes << self unless Searcher.classes.include?(self)
+      @config ||= Searcher::Config.new.instance_exec(&block)
+    end
+    
+    def search(query)
+      klass = self
+
+      result = query.split(" ").inject(klass) do |k, piece|
+        if piece.include?(":")
+          name, q = piece.split(":")
+          external = @config[:externals][name.to_sym]
+          next unless external
+          send("by_#{name}", q, external[:field])
+        end
+      end
+      
+      result
+    end
+  end
+end

data/lib/searcher/config.rb

@@ -0,0 +1,18 @@
+module Searcher
+  class Config
+    def initialize
+      @config = {}
+    end
+    
+    def default(field)
+      @config[:default] = field
+      @config
+    end
+    
+    def external(field, options)
+      @config[:externals] ||= {}
+      @config[:externals][field.to_sym] = options
+      @config
+    end
+  end
+end

data/lib/searcher/version.rb

@@ -0,0 +1,3 @@
+module Searcher
+  VERSION = "0.0.1"
+end

data/lib/searcher.rb

@@ -0,0 +1,25 @@
+require 'active_record'
+require 'searcher/class_methods'
+
+module Searcher
+  mattr_accessor :classes
+  def self.classes
+    @classes ||= []
+  end
+end
+
+ActiveRecord::Base.extend(Searcher::ClassMethods)
+
+ActiveSupport.on_load(:after_initialize) do
+  Searcher.classes.each do |klass|
+    table = Table(klass.table_name)
+    klass.searcher[:externals].each do |name, config|
+      association = klass.reflect_on_association(config[:from])
+      association_table = Table(association.klass.table_name)
+      if [:has_and_belongs_to_many, :belongs_to].include?(association.macro)
+        scope = lambda { |q, field| klass.joins(config[:from]).where(association_table[field].eq(q)) }
+        klass.scope "by_#{name}", scope
+      end
+    end
+  end
+end

data/searcher.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/searcher/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "searcher"
+  s.version     = Searcher::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = []
+  s.email       = []
+  s.homepage    = "http://rubygems.org/gems/searcher"
+  s.summary     = "Label-based straight-SQL searcher"
+  s.description = "Label-based straight-SQL searcher"
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "searcher"
+
+  s.add_development_dependency "bundler", ">= 1.0.0"
+  
+  s.add_dependency "activerecord", "~> 3.0.0"
+
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path = 'lib'
+end

data/spec/fixtures/models.rb

@@ -0,0 +1,28 @@
+class Ticket < ActiveRecord::Base
+  has_and_belongs_to_many :tags
+  belongs_to :state
+  
+  searcher do
+    external :tag, :from => :tags, :field => "name"
+    external :state, :from => :state, :field => "name"
+  end
+end
+
+class Tag < ActiveRecord::Base
+  has_and_belongs_to_many :tickets
+end
+
+class State < ActiveRecord::Base
+  has_many :tickets
+end
+
+#############
+### SEEDS ###
+#############
+
+# Ticket with a description, tag and state.
+ticket = Ticket.create(:description => "Hello world! You are awesome.")
+ticket.tags << Tag.create(:name => "bug")
+ticket.state = State.create(:name => "Open")
+ticket.save!
+

data/spec/fixtures/schema.rb

@@ -0,0 +1,22 @@
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :tickets, :force => true do |t|
+    t.string :description
+    t.integer :state_id
+    t.timestamps
+  end
+
+  create_table :tags_tickets, :force => true, :id => false do |t|
+    t.integer :ticket_id, :tag_id
+  end
+
+  create_table :tags, :force => true do |t|
+    t.string :name
+  end
+
+  create_table :states, :force => true do |t|
+    t.string :name
+  end
+
+end

data/spec/searcher_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Searcher do
+  let(:search_results) { subject }
+  let(:first_result) { subject.first }
+  
+  context "habtm label search" do  
+    subject { Ticket.search("tag:bug") }
+    it "finds a ticket" do
+      first_result.description.should eql("Hello world! You are awesome.")
+    end
+  end
+  
+  context "belongs_to label search" do
+    subject { Ticket.search("state:Open") }
+    it "finds a ticket" do
+      first_result.description.should eql("Hello world! You are awesome.")
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'searcher'
+
+here = File.dirname(__FILE__)
+
+
+require 'logger'
+ActiveRecord::Base.logger = Logger.new("tmp/activerecord.log")
+
+# Connect to the test database
+ActiveRecord::Base.establish_connection(:database => "searcher.sqlite3", :adapter => "sqlite3")
+
+# Load the schema into the test database
+load here + '/fixtures/schema.rb'
+
+# Load the models
+require here + '/fixtures/models'
+
+# Call the after_initialize hook defined in lib/searcher.rb
+ActiveSupport.run_load_hooks(:after_initialize)

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification 
+name: searcher
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: []
+
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-04 00:00:00 +11:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id002
+description: Label-based straight-SQL searcher
+email: []
+
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/searcher.rb
+- lib/searcher/class_methods.rb
+- lib/searcher/config.rb
+- lib/searcher/version.rb
+- searcher.gemspec
+- searcher.sqlite3
+- spec/fixtures/models.rb
+- spec/fixtures/schema.rb
+- spec/searcher_spec.rb
+- spec/spec_helper.rb
+- tmp/.gitkeep
+has_rdoc: true
+homepage: http://rubygems.org/gems/searcher
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: searcher
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Label-based straight-SQL searcher
+test_files: []
+