slingshot-rb 0.0.8 → 0.0.9

data/lib/slingshot/search/highlight.rb

@@ -18,9 +18,7 @@ module Slingshot
       end
 
       def to_hash
-        h = { :fields => @fields }
-        h.update @options
-        return h
+        { :fields => @fields }.update @options
       end
 
       private

data/lib/slingshot/search/query.rb

@@ -28,6 +28,10 @@ module Slingshot
         @value
       end
 
+      def ids(values, type)
+        @value = { :ids => { :values => values, :type => type }  }
+      end
+
       def to_json
         @value.to_json
       end

data/lib/slingshot/search/sort.rb

@@ -7,6 +7,11 @@ module Slingshot
         self.instance_eval(&block) if block_given?
       end
 
+      def field(name, direction=nil)
+        @value << ( direction ? { name => direction } : name )
+        self
+      end
+
       def method_missing(id, *args, &block)
         case arg = args.shift
           when String, Symbol, Hash then @value << { id => arg }

data/lib/slingshot/tasks.rb

@@ -0,0 +1,88 @@
+require 'rake'
+require 'benchmark'
+
+namespace :slingshot do
+
+  usage = <<-DESC
+          Import data from your model using paginate: rake environment slingshot:import CLASS='MyModel'
+
+          Pass params for the `paginate` method:
+            $ rake environment slingshot:import CLASS='Article' PARAMS='{:page => 1}'
+
+          Force rebuilding the index (delete and create):
+            $ rake environment slingshot:import CLASS='Article' PARAMS='{:page => 1}' FORCE=1
+
+          Set target index name:
+            $ rake environment slingshot:import CLASS='Article' INDEX='articles-new'
+    
+  DESC
+
+  desc usage.split("\n").first.to_s
+  task :import do
+
+    def elapsed_to_human(elapsed)
+      hour = 60*60
+      day  = hour*24
+
+      case elapsed
+      when 0..59
+        "#{sprintf("%1.5f", elapsed)} seconds"
+      when 60..hour-1
+        "#{elapsed/60} minutes and #{elapsed % 60} seconds"
+      when hour..day
+        "#{elapsed/hour} hours and #{elapsed % hour} minutes"
+      else
+        "#{elapsed/hour} hours"
+      end
+    end
+
+    if ENV['CLASS'].to_s == ''
+      puts '='*80, 'USAGE', '='*80, usage.gsub(/          /, '')
+      exit(1)
+    end
+
+    klass  = eval(ENV['CLASS'].to_s)
+    params = eval(ENV['PARAMS'].to_s) || {}
+
+    index = Slingshot::Index.new( ENV['INDEX'] || klass.index.name )
+
+    if ENV['FORCE']
+      puts "[IMPORT] Deleting index '#{index.name}'"
+      index.delete
+    end
+
+    unless index.exists?
+      puts "[IMPORT] Creating index '#{index.name}' with mapping:",
+           Yajl::Encoder.encode(klass.mapping_to_hash, :pretty => true)
+      index.create :mappings => klass.mapping_to_hash
+    end
+
+    STDOUT.sync = true
+    puts "[IMPORT] Starting import for the '#{ENV['CLASS']}' class"
+    tty_cols = 80
+    total    = klass.count rescue nil
+    offset   = (total.to_s.size*2)+8
+    done     = 0
+
+    STDOUT.puts '-'*tty_cols
+    elapsed = Benchmark.realtime do
+      index.import(klass, 'paginate', params) do |documents|
+
+        if total
+          done += documents.size
+          # I CAN HAZ PROGREZ BAR LIEK HOMEBRU!
+          percent  = ( (done.to_f / total) * 100 ).to_i
+          glyphs   = ( percent * ( (tty_cols-offset).to_f/100 ) ).to_i
+          STDOUT.print( "#" * glyphs )
+          STDOUT.print( "\r"*tty_cols+"#{done}/#{total} | \e[1m#{percent}%\e[0m " )
+        end
+
+        # Don't forget to return the documents collection back!
+        documents
+      end
+    end
+
+    puts "", '='*80, "Import finished in #{elapsed_to_human(elapsed)}"
+
+  end
+end

data/lib/slingshot/version.rb

@@ -1,3 +1,3 @@
 module Slingshot
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

data/slingshot.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |s|
   s.name        = "slingshot-rb"
   s.version     = Slingshot::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.summary       = "Ruby API for ElasticSearch"
+  s.summary       = "Ruby client for ElasticSearch"
   s.homepage      = "http://github.com/karmi/slingshot"
   s.authors       = [ 'Karel Minarik' ]
   s.email         = 'karmi@karmi.cz'
@@ -24,18 +24,31 @@ Gem::Specification.new do |s|
 
   s.required_rubygems_version = ">= 1.3.6"
 
+  s.add_dependency "rake",        "~> 0.8.0"
   s.add_dependency "bundler",     "~> 1.0.0"
   s.add_dependency "rest-client", "~> 1.6.0"
-  s.add_dependency "yajl-ruby",   "> 0.7.9"
+  s.add_dependency "yajl-ruby",   "> 0.8.0"
+  s.add_dependency "activemodel", "> 3.0.0"
 
   s.add_development_dependency "turn"
   s.add_development_dependency "shoulda"
   s.add_development_dependency "mocha"
   s.add_development_dependency "sdoc"
   s.add_development_dependency "rcov"
+  s.add_development_dependency "activerecord"
+  s.add_development_dependency "supermodel"
 
   s.description = <<-DESC
-   Ruby API for the ElasticSearch search engine/database.
-   A work in progress, currently.
+   Slingshot is a Ruby client for the ElasticSearch search engine/database.
+
+   It provides Ruby-like API for fluent communication with the ElasticSearch server
+   and blends with ActiveModel class for convenient usage in Rails applications.
+
+   It allows to delete and create indices, define mapping for them, supports
+   the bulk API, and presents an easy-to-use DSL for constructing your queries.
+
+   It has full ActiveRecord/ActiveModel compatibility, allowing you to index
+   your models (incrementally upon saving, or in bulk), searching and
+   paginating the results.
   DESC
 end

data/test/integration/active_model_searchable_test.rb

@@ -0,0 +1,80 @@
+require 'test_helper'
+
+module Slingshot
+
+  class ActiveModelSearchableIntegrationTest < Test::Unit::TestCase
+    include Test::Integration
+
+    def setup
+      super
+      SupermodelArticle.delete_all
+      @model = SupermodelArticle.new :title => 'Test'
+    end
+
+    def teardown
+      super
+      SupermodelArticle.delete_all
+    end
+
+    context "ActiveModel" do
+
+      setup    do
+        Slingshot.index('supermodel_articles').delete
+        load File.expand_path('../../models/supermodel_article.rb', __FILE__)
+      end
+      teardown { Slingshot.index('supermodel_articles').delete }
+
+      should "configure mapping" do
+        assert_equal 'czech', SupermodelArticle.mapping[:title][:analyzer]
+        assert_equal 15,      SupermodelArticle.mapping[:title][:boost]
+
+        assert_equal 'czech', SupermodelArticle.index.mapping['supermodel_article']['properties']['title']['analyzer']
+      end
+
+      should "save document into index on save and find it with score" do
+        a = SupermodelArticle.new :title => 'Test'
+        a.save
+        id = a.id
+
+        a.index.refresh
+        sleep(1.5)
+
+        results = SupermodelArticle.search 'test'
+
+        assert_equal 1, results.count
+        assert_instance_of SupermodelArticle, results.first
+        assert_equal       'Test', results.first.title
+        assert_not_nil     results.first.score
+        assert_equal       id, results.first.id
+      end
+
+      should "remove document from index on destroy" do
+        a = SupermodelArticle.new :title => 'Test'
+        a.save
+        a.destroy
+
+        a.index.refresh
+        sleep(1.25)
+
+        results = SupermodelArticle.search 'test'
+        
+        assert_equal 0, results.count
+      end
+
+      should "retrieve sorted documents by IDs returned from search" do
+        SupermodelArticle.create! :title => 'foo'
+        SupermodelArticle.create! :title => 'bar'
+
+        SupermodelArticle.index.refresh
+        results = SupermodelArticle.search 'foo OR bar^100'
+
+        assert_equal 2, results.count
+
+        assert_equal 'bar', results.first.title
+      end
+
+    end
+
+  end
+
+end

data/test/integration/active_record_searchable_test.rb

@@ -0,0 +1,193 @@
+require 'test_helper'
+
+module Slingshot
+
+  class ActiveRecordSearchableIntegrationTest < Test::Unit::TestCase
+    include Test::Integration
+
+    def setup
+      super
+      File.delete fixtures_path.join('articles.db') rescue nil
+
+      ActiveRecord::Base.establish_connection( :adapter => 'sqlite3', :database => fixtures_path.join('articles.db') )
+
+      ActiveRecord::Migration.verbose = false
+      ActiveRecord::Schema.define(:version => 1) do
+        create_table :active_record_articles do |t|
+          t.string   :title
+          t.datetime :created_at, :default => 'NOW()'
+        end
+      end
+    end
+
+    def teardown
+      super
+      File.delete fixtures_path.join('articles.db') rescue nil
+    end
+
+    context "ActiveRecord integration" do
+
+      setup    do
+        Slingshot.index('active_record_articles').delete
+        load File.expand_path('../../models/active_record_article.rb', __FILE__)
+      end
+      teardown { Slingshot.index('active_record_articles').delete }
+
+      should "configure mapping" do
+        assert_equal 'snowball', ActiveRecordArticle.mapping[:title][:analyzer]
+        assert_equal 10, ActiveRecordArticle.mapping[:title][:boost]
+
+        assert_equal 'snowball', ActiveRecordArticle.index.mapping['active_record_article']['properties']['title']['analyzer']
+      end
+
+      should "save document into index on save and find it" do
+        a = ActiveRecordArticle.new :title => 'Test'
+        a.save!
+        id = a.id
+
+        a.index.refresh
+        sleep(1.5) # Leave ES some breathing room here...
+
+        results = ActiveRecordArticle.search 'test'
+
+        assert_equal 1, results.count
+
+        assert_instance_of ActiveRecordArticle, results.first
+        assert_not_nil results.first.id
+        assert_equal   id, results.first.id
+        assert         results.first.persisted?, "Record should be persisted"
+        assert_not_nil results.first._score
+        assert_equal   'Test', results.first.title
+      end
+
+      should "remove document from index on destroy" do
+        a = ActiveRecordArticle.new :title => 'Test'
+        a.save!
+        a.destroy
+
+        a.index.refresh
+        results = ActiveRecordArticle.search 'test'
+        
+        assert_equal 0, results.count
+      end
+
+      should "return documents with scores" do
+        ActiveRecordArticle.create! :title => 'foo'
+        ActiveRecordArticle.create! :title => 'bar'
+
+        ActiveRecordArticle.index.refresh
+        results = ActiveRecordArticle.search 'foo OR bar^100'
+        assert_equal 2, results.count
+
+        assert_equal 'bar', results.first.title
+      end
+
+      context "with pagination" do
+        setup do
+          1.upto(9) { |number| ActiveRecordArticle.create :title => "Test#{number}" }
+          ActiveRecordArticle.index.refresh
+        end
+
+        context "and parameter searches" do
+
+          should "find first page with five results" do
+            results = ActiveRecordArticle.search 'test*', :sort => 'title', :per_page => 5, :page => 1
+            assert_equal 5, results.size
+
+            assert_equal 2, results.total_pages
+            assert_equal 1, results.current_page
+            assert_equal 0, results.previous_page
+            assert_equal 2, results.next_page
+
+            assert_equal 'Test1', results.first.title
+          end
+
+          should "find next page with five results" do
+            results = ActiveRecordArticle.search 'test*', :sort => 'title', :per_page => 5, :page => 2
+            assert_equal 4, results.size
+
+            assert_equal 2, results.total_pages
+            assert_equal 2, results.current_page
+            assert_equal 1, results.previous_page
+            assert_equal 3, results.next_page
+
+            assert_equal 'Test6', results.first.title
+          end
+
+          should "find not find missing page" do
+            results = ActiveRecordArticle.search 'test*', :sort => 'title', :per_page => 5, :page => 3
+            assert_equal 0, results.size
+
+            assert_equal 2, results.total_pages
+            assert_equal 3, results.current_page
+            assert_equal 2, results.previous_page
+            assert_equal 4, results.next_page
+
+            assert_nil results.first
+          end
+
+        end
+
+        context "and block searches" do
+          setup { @q = 'test*' }
+
+          should "find first page with five results" do
+            results = ActiveRecordArticle.search nil, :per_page => 5, :page => 1 do |search|
+              search.query { |query| query.string @q }
+              search.sort  { title }
+              search.from 0
+              search.size 5
+            end
+            assert_equal 5, results.size
+
+            assert_equal 2, results.total_pages
+            assert_equal 1, results.current_page
+            assert_equal 0, results.previous_page
+            assert_equal 2, results.next_page
+
+            assert_equal 'Test1', results.first.title
+          end
+
+          should "find next page with five results" do
+            results = ActiveRecordArticle.search nil, :per_page => 5, :page => 2 do |search|
+              search.query { |query| query.string @q }
+              search.sort  { title }
+              search.from 5
+              search.size 5
+            end
+            assert_equal 4, results.size
+
+            assert_equal 2, results.total_pages
+            assert_equal 2, results.current_page
+            assert_equal 1, results.previous_page
+            assert_equal 3, results.next_page
+
+            assert_equal 'Test6', results.first.title
+          end
+
+          should "find not find missing page" do
+            results = ActiveRecordArticle.search nil, :per_page => 5, :page => 3 do |search|
+              search.query { |query| query.string @q }
+              search.sort  { title }
+              search.from 10
+              search.size 5
+            end
+            assert_equal 0, results.size
+
+            assert_equal 2, results.total_pages
+            assert_equal 3, results.current_page
+            assert_equal 2, results.previous_page
+            assert_equal 4, results.next_page
+
+            assert_nil results.first
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+
+end