pollyanna 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Henning Koch
+
+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/README.rdoc

@@ -0,0 +1,15 @@
+= Pollyanna - very simple search
+
+== Make a model searchable
+
+- Add a text column "search_text" to a model
+- Have the model include Pollyanna::Searchable
+- Overwrite #search_text to define which text is indexed upon saving
+- Get a scope for your match with Model.search("query words here")
+- There's some more goodness I don't care to document. Use the code, Luke!
+
+== Credits
+
+Henning Koch
+
+{www.makandra.de}[http://www.makandra.de/]

data/Rakefile

@@ -0,0 +1,37 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the pollyanna gem.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the pollyanna gem.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'pollyanna'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "pollyanna"
+    gemspec.summary = "Very simple search for your ActiveRecord models."
+    gemspec.email = "github@makandra.de"
+    gemspec.homepage = "http://github.com/makandra/pollyanna"
+    gemspec.description = "Very simple search for your ActiveRecord models."
+    gemspec.authors = ["Henning Koch"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+

data/lib/pollyanna/search.rb

@@ -0,0 +1,39 @@
+module Pollyanna
+  class Search
+
+    def initialize(query, table_name)
+      @words = (query || "").strip.downcase.split(/[\ \,\;]+/)
+      @table_name = table_name
+    end
+    
+    def scope_options(options = {})
+      by = options && options.delete(:by)
+      { :conditions => conditions_for_find(by) }
+    end
+  
+  #  # Run the search on a Ruby collection
+  #  def select(objects, &content_method)
+  #    content_method ||= &:search_text
+  #    objects.select do |object|
+  #      content = content_method.call(object).andand.downcase || ""
+  #      @words.all? { |word| content.include? word }
+  #    end
+  #  end
+
+    private
+    
+    def conditions_for_find(by = nil)
+      unless @words.empty?
+        by ||= :search_text
+        patterns = @words.collect { |word| "%#{escape_query_word word}%" }
+        likes = ["#{@table_name}.#{by} LIKE ?"] * patterns.count
+        [likes.join(" AND "), *patterns]
+      end
+    end
+    
+    def escape_query_word(word)
+      word.gsub("%", "\\%").gsub("_", "\\_")
+    end
+    
+  end
+end

data/lib/pollyanna/searchable.rb

@@ -0,0 +1,17 @@
+module Pollyanna
+  module Searchable
+
+    def self.included(klass)
+      klass.class_eval do
+        before_save :set_search_text
+        # Use Proc.new so the number of arguments does not matter
+        named_scope :search, Proc.new { |query, options| Search.new(query, table_name).scope_options(options) }
+      end
+    end
+    
+    def set_search_text
+      self.search_text = search_text if respond_to?(:"search_text=")
+    end
+
+  end
+end

data/spec/app_root/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/spec/app_root/app/models/movie.rb

@@ -0,0 +1,12 @@
+class Movie < ActiveRecord::Base
+  include Pollyanna::Searchable
+  
+  def search_text
+    "#{title} #{year}"
+  end
+  
+  def <=>(other)
+    title.downcase <=> other.downcase
+  end
+
+end

data/spec/app_root/config/boot.rb

@@ -0,0 +1,114 @@
+# Allow customization of the rails framework path
+RAILS_FRAMEWORK_ROOT = (ENV['RAILS_FRAMEWORK_ROOT'] || "#{File.dirname(__FILE__)}/../../../../../../vendor/rails") unless defined?(RAILS_FRAMEWORK_ROOT) 
+
+# Don't change this file!
+# Configure your app in config/environment.rb and config/environments/*.rb
+
+RAILS_ROOT = "#{File.dirname(__FILE__)}/.." unless defined?(RAILS_ROOT)
+
+module Rails
+  class << self
+    def boot!
+      unless booted?
+        preinitialize
+        pick_boot.run
+      end
+    end
+
+    def booted?
+      defined? Rails::Initializer
+    end
+
+    def pick_boot
+      (vendor_rails? ? VendorBoot : GemBoot).new
+    end
+
+    def vendor_rails?
+      File.exist?(RAILS_FRAMEWORK_ROOT)
+    end
+
+    def preinitialize
+      load(preinitializer_path) if File.exist?(preinitializer_path)
+    end
+
+    def preinitializer_path
+      "#{RAILS_ROOT}/config/preinitializer.rb"
+    end
+  end
+
+  class Boot
+    def run
+      load_initializer
+      Rails::Initializer.run(:set_load_path)
+    end
+  end
+
+  class VendorBoot < Boot
+    def load_initializer
+      require "#{RAILS_FRAMEWORK_ROOT}/railties/lib/initializer"
+      Rails::Initializer.run(:install_gem_spec_stubs)
+    end
+  end
+
+  class GemBoot < Boot
+    def load_initializer
+      self.class.load_rubygems
+      load_rails_gem
+      require 'initializer'
+    end
+
+    def load_rails_gem
+      if version = self.class.gem_version
+        gem 'rails', version
+      else
+        gem 'rails'
+      end
+    rescue Gem::LoadError => load_error
+      $stderr.puts %(Missing the Rails #{version} gem. Please `gem install -v=#{version} rails`, update your RAILS_GEM_VERSION setting in config/environment.rb for the Rails version you do have installed, or comment out RAILS_GEM_VERSION to use the latest version installed.)
+      exit 1
+    end
+
+    class << self
+      def rubygems_version
+        Gem::RubyGemsVersion rescue nil
+      end
+
+      def gem_version
+        if defined? RAILS_GEM_VERSION
+          RAILS_GEM_VERSION
+        elsif ENV.include?('RAILS_GEM_VERSION')
+          ENV['RAILS_GEM_VERSION']
+        else
+          parse_gem_version(read_environment_rb)
+        end
+      end
+
+      def load_rubygems
+        require 'rubygems'
+        min_version = '1.1.1'
+        unless rubygems_version >= min_version
+          $stderr.puts %Q(Rails requires RubyGems >= #{min_version} (you have #{rubygems_version}). Please `gem update --system` and try again.)
+          exit 1
+        end
+ 
+      rescue LoadError
+        $stderr.puts %Q(Rails requires RubyGems >= #{min_version}. Please install RubyGems and try again: http://rubygems.rubyforge.org)
+        exit 1
+      end
+
+      def parse_gem_version(text)
+        $1 if text =~ /^[^#]*RAILS_GEM_VERSION\s*=\s*["']([!~<>=]*\s*[\d.]+)["']/
+      end
+
+      private
+        def read_environment_rb
+          environment_rb = "#{RAILS_ROOT}/config/environment.rb"
+          environment_rb = "#{HELPER_RAILS_ROOT}/config/environment.rb" unless File.exists?(environment_rb)
+          File.read(environment_rb)
+        end
+    end
+  end
+end
+
+# All that for this:
+Rails.boot!

data/spec/app_root/config/database.yml

@@ -0,0 +1,21 @@
+in_memory:
+  adapter: sqlite3
+  database: ":memory:"
+  verbosity: quiet
+sqlite:
+  adapter: sqlite
+  dbfile: plugin_test.sqlite.db
+sqlite3:
+  adapter: sqlite3
+  dbfile: plugin_test.sqlite3.db
+postgresql:
+  adapter: postgresql
+  username: postgres
+  password: postgres
+  database: plugin_test
+mysql:
+  adapter: mysql
+  host: localhost
+  username: root
+  password:
+  database: plugin_test

data/spec/app_root/config/environment.rb

@@ -0,0 +1,14 @@
+require File.join(File.dirname(__FILE__), 'boot')
+
+Rails::Initializer.run do |config|
+  config.cache_classes = false
+  config.whiny_nils = true
+  config.action_controller.session = { :key => "_myapp_session", :secret => "gwirofjweroijger8924rt2zfwehfuiwehb1378rifowenfoqwphf23" }
+  config.plugin_locators.unshift(
+    Class.new(Rails::Plugin::Locator) do
+      def plugins
+        [Rails::Plugin.new(File.expand_path('.'))]
+      end
+    end
+  ) unless defined?(PluginTestHelper::PluginLocator)
+end

data/spec/app_root/config/routes.rb

@@ -0,0 +1,4 @@
+ActionController::Routing::Routes.draw do |map|
+  map.connect ':controller/:action/:id'
+  map.connect ':controller/:action/:id.:format'
+end

data/spec/app_root/db/migrate/001_create_movies.rb

@@ -0,0 +1,16 @@
+class CreateMovies < ActiveRecord::Migration
+
+  def self.up
+    create_table :movies do |t|
+      t.string :title
+      t.integer :year
+      t.text :search_text
+      t.string :director
+    end
+  end
+
+  def self.down
+    drop_table :movies
+  end
+  
+end

data/spec/app_root/lib/console_with_fixtures.rb

@@ -0,0 +1,4 @@
+# Loads fixtures into the database when running the test app via the console
+(ENV['FIXTURES'] ? ENV['FIXTURES'].split(/,/) : Dir.glob(File.join(Rails.root, '../fixtures/*.{yml,csv}'))).each do |fixture_file|
+  Fixtures.create_fixtures(File.join(Rails.root, '../fixtures'), File.basename(fixture_file, '.*'))
+end

data/spec/app_root/log/.gitignore

@@ -0,0 +1 @@
+*.log

data/spec/app_root/script/console

@@ -0,0 +1,7 @@
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+libs =  " -r irb/completion"
+libs << " -r test/test_helper"
+libs << " -r console_app"
+libs << " -r console_with_helpers"
+libs << " -r console_with_fixtures"
+exec "#{irb} #{libs} --simple-prompt"

data/spec/rcov.opts

@@ -0,0 +1,2 @@
+--exclude "spec/*,gems/*"
+--rails

data/spec/search_spec.rb

@@ -0,0 +1,50 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Pollyanna::Search do
+
+  describe 'scope_options' do
+  
+    it "should hand a :by option to conditions_for_find" do
+      search = Pollyanna::Search.new("foo", "movies")
+      search.should_receive(:conditions_for_find).with(:title)
+      search.scope_options(:by => :title)
+    end
+    
+    it "should return an options hash for a Rails scope" do
+      search = Pollyanna::Search.new("foo", "movies")
+      search.should_receive(:conditions_for_find).and_return("sql query")
+      search.scope_options.should == { :conditions => "sql query" }
+    end
+    
+  end
+  
+  describe 'conditions_for_find' do
+  
+    it "should return a LIKE query for the given query, looking in the search_text column by default and using the table name to disambiguate things" do
+      search = Pollyanna::Search.new("word", "movies")
+      search.send(:conditions_for_find).should == ['movies.search_text LIKE ?', "%word%"]
+    end
+    
+    it "should look in another column if the #by argument is given" do
+      search = Pollyanna::Search.new("word", "movies")
+      search.send(:conditions_for_find, "words").should == ['movies.words LIKE ?', "%word%"]
+    end
+    
+    it "should return a conjunction of LIKE queries for queries with multiple words" do
+      search = Pollyanna::Search.new("foo bar", "movies")
+      search.send(:conditions_for_find).should == ['movies.search_text LIKE ? AND movies.search_text LIKE ?', '%foo%', '%bar%']
+    end
+    
+    it "should escape underscores in the query" do
+      search = Pollyanna::Search.new("foo_bar", "movies")
+      search.send(:conditions_for_find).should == ['movies.search_text LIKE ?', "%foo\\_bar%"]
+    end
+    
+    it "should escape percent signs in the query" do
+      search = Pollyanna::Search.new("foo%bar", "movies")
+      search.send(:conditions_for_find).should == ['movies.search_text LIKE ?', "%foo\\%bar%"]
+    end
+  
+  end
+
+end

data/spec/searchable_spec.rb

@@ -0,0 +1,33 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Pollyanna::Searchable do
+
+  before(:each) do
+    @starship_troopers = Movie.create!(:title => "Starship Troopers", :year => 1997, :director => "Paul Verhoeven")
+    @fifth_element = Movie.create!(:title => "The Fifth Element", :year => 1997, :director => "Luc Besson")
+    @matrix = Movie.create!(:title => "The Matrix", :year => 1999, :director => "Wachowski brothers")
+  end
+
+  it 'should index its search_text upon save' do
+    @starship_troopers.should_receive("search_text=")
+    @starship_troopers.save
+  end
+  
+  it "use the search_text column to find matches" do
+    Movie.search("1997").all.should == [@starship_troopers, @fifth_element]
+  end
+  
+  it "should find single words" do
+    Movie.search("The").all.should == [@fifth_element, @matrix]
+  end
+  
+  it "should find multiple words using AND" do
+    Movie.search("Matrix the").all.should == [@matrix]
+  end
+  
+  it "should find records by another column than search_text" do
+    Movie.search("Paul").should be_empty
+    Movie.search("Paul", :by => :director).should == [@starship_troopers]
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+$: << File.join(File.dirname(__FILE__), "/../lib" )
+
+# Set the default environment to sqlite3's in_memory database
+ENV['RAILS_ENV'] ||= 'in_memory'
+
+# Load the Rails environment and testing framework
+require "#{File.dirname(__FILE__)}/app_root/config/environment"
+require "#{File.dirname(__FILE__)}/../init"
+require 'spec/rails'
+
+# Undo changes to RAILS_ENV
+silence_warnings {RAILS_ENV = ENV['RAILS_ENV']}
+
+# Run the migrations
+ActiveRecord::Migrator.migrate("#{Rails.root}/db/migrate")
+
+Spec::Runner.configure do |config|
+  config.use_transactional_fixtures = true
+  config.use_instantiated_fixtures  = false
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: pollyanna
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Henning Koch
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-13 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Very simple search for your ActiveRecord models.
+email: github@makandra.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- lib/pollyanna/search.rb
+- lib/pollyanna/searchable.rb
+- spec/app_root/app/controllers/application_controller.rb
+- spec/app_root/app/models/movie.rb
+- spec/app_root/config/boot.rb
+- spec/app_root/config/database.yml
+- spec/app_root/config/environment.rb
+- spec/app_root/config/environments/in_memory.rb
+- spec/app_root/config/environments/mysql.rb
+- spec/app_root/config/environments/postgresql.rb
+- spec/app_root/config/environments/sqlite.rb
+- spec/app_root/config/environments/sqlite3.rb
+- spec/app_root/config/routes.rb
+- spec/app_root/db/migrate/001_create_movies.rb
+- spec/app_root/lib/console_with_fixtures.rb
+- spec/app_root/log/.gitignore
+- spec/app_root/script/console
+- spec/rcov.opts
+- spec/search_spec.rb
+- spec/searchable_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/makandra/pollyanna
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Very simple search for your ActiveRecord models.
+test_files: 
+- spec/search_spec.rb
+- spec/app_root/app/models/movie.rb
+- spec/app_root/app/controllers/application_controller.rb
+- spec/app_root/config/environment.rb
+- spec/app_root/config/environments/mysql.rb
+- spec/app_root/config/environments/postgresql.rb
+- spec/app_root/config/environments/sqlite3.rb
+- spec/app_root/config/environments/in_memory.rb
+- spec/app_root/config/environments/sqlite.rb
+- spec/app_root/config/boot.rb
+- spec/app_root/config/routes.rb
+- spec/app_root/db/migrate/001_create_movies.rb
+- spec/app_root/lib/console_with_fixtures.rb
+- spec/searchable_spec.rb
+- spec/spec_helper.rb