picky 4.21.0 → 4.21.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 07e373957d9f7d673d29aa262102788d6947cee8
-  data.tar.gz: 85ef2b296887de1cdceaff60c488e07260eb8358
+  metadata.gz: 6c8689ff998ff025e835e1a5e6661ce766d51246
+  data.tar.gz: ae0fe1a7cfbd7bbf511fd049249d462bb683d955
 SHA512:
-  metadata.gz: a215df05ec60deedab57995a1ab45d241229ef1d9de5758410dc16992bc3ba51f3bd892899947d39730cdf9c189c3a9f3fe7e93b18054470a3e4273f3ac8ec62
-  data.tar.gz: 5b92b5355a5aa033e0e78079b5a5f3cf4c55d14bf6f9eb0806b74cd014a0ad4b35f7168f50f66b27dfb46c438fd2006bcb42fa05f7c7435802099fdd932c92eb
+  metadata.gz: 602df847adb8be592eb798b261d41a22a530b09e8ea8a3b081a438b2153efef6320293a931e705a064e63b88a8b198fae891754999cd24da90d3923728cb2dbf
+  data.tar.gz: 1a98cf615c82128a6a107d4ec38ed747d5fc5a251318e167136cce36fb625ca814bacad6e15f60515e5e78781493378fd3dc53d5dff9e2e830829234b0f1c65d

data/lib/picky/bundle.rb

@@ -43,7 +43,7 @@ module Picky
 
     forward :[], :[]=,        :to => :configuration
     forward :index_directory, :to => :category
-    
+
     # TODO Move the strategies into options.
     #
     def initialize name, category, weight_strategy, partial_strategy, similarity_strategy, options = {}
@@ -103,7 +103,7 @@ module Picky
     def empty
       on_all_indexes_call :empty
     end
-    
+
     # Extracted to avoid duplicate code.
     #
     def on_all_indexes_call method_name
@@ -163,7 +163,7 @@ module Picky
     def index_path type = nil
       ::File.join index_directory, "#{category.name}_#{name}#{ "_#{type}" if type }"
     end
-    
+
     def to_tree_s indent = 0, &block
       s = <<-TREE
 #{' ' * indent}#{self.class.name.gsub('Picky::','')}(#{name})

data/lib/picky/category_indexing.rb

@@ -73,7 +73,17 @@ module Picky
     def key_format?
       key_format
     end
-    
+
+    # Return the key format.
+    #
+    # If no key_format is defined on the category
+    # and the source has no key format, ask
+    # the index for one.
+    #
+    def id
+      @id ||= @index.id
+    end
+
     def static?
       @index.static? # || @static
     end
@@ -83,7 +93,7 @@ module Picky
     def from
       @from || name
     end
-    
+
     # Return an appropriate source.
     #
     # If we have no explicit source, we'll check the index for one.

data/lib/picky/category_realtime.rb

@@ -1,7 +1,7 @@
 module Picky
 
   class Category
-    
+
     class Picky::IdNotGivenException < StandardError; end
 
     # Removes an indexed object with the
@@ -20,9 +20,9 @@ module Picky
     #
     def add object, where = :unshift
       if from.respond_to? :call
-        add_text object.id, from.call(object), where
+        add_text object.send(id), from.call(object), where
       else
-        add_text object.id, object.send(from), where
+        add_text object.send(id), object.send(from), where
       end
     end
 
@@ -30,20 +30,20 @@ module Picky
     # adds it again.
     #
     def replace object, where = :unshift
-      remove object.id
+      remove object.send id
       add object, where
     end
-    
+
     # Replaces just part of the indexed data.
     #
     # Note: Takes a hash as opposed to the add/replace method.
     #
     def replace_from hash #, id = (hash[:id] || hash['id'] || raise(IdNotGivenException.new)).send(key_format)
       return unless text = hash[from] || hash[from.to_s]
-      
+
       raise IdNotGivenException.new unless id = hash[:id] || hash['id']
       id = id.send key_format if key_format?
-      
+
       remove id
       add_text id, text
     end
@@ -71,13 +71,13 @@ module Picky
       else
         tokens = text_or_tokens
       end
-      
+
       format = key_format?
       tokens.each { |text| add_tokenized_token id, text, where, format }
     rescue NoMethodError => e
       show_informative_add_text_error_message_for e
     end
-    
+
     def show_informative_add_text_error_message_for e
       if e.name == :each
         raise %Q{#{e.message}. You probably set tokenize: false on category "#{name}". It will need an Enumerator of previously tokenized tokens.}
@@ -90,7 +90,7 @@ module Picky
     #
     def add_tokenized_token id, text, where = :unshift, format = true, static = false
       return unless text
-      
+
       id = id.send key_format if format
       # text = text.to_sym if @symbols # SYMBOLS.
       id.freeze

data/lib/picky/helpers/indexing.rb

@@ -6,14 +6,14 @@ module Picky
     module Indexing
 
       include Measuring
-      
+
       # Runs the block and logs a few infos regarding the time it took.
       #
       def timed_indexing scheduler, &block
         Picky.logger.info "Picky is indexing using #{scheduler.fork? ? 'multiple processes' : 'a single process'}: "
         Picky.logger.info " Done in #{timed(&block).round}s.\n"
       end
-      
+
       # Indexing works the same way, always:
       #  * Prepare the scheduler.
       #  * Cache the scheduler.

data/lib/picky/index.rb

@@ -126,7 +126,7 @@ module Picky
 
       instance_eval(&Proc.new) if block_given?
     end
-    
+
     # TODO Doc.
     #
     def static
@@ -149,7 +149,7 @@ module Picky
         @backend ||= Backends::Memory.new
       end
     end
-    
+
     # The directory used by this index.
     #
     # Note: Used @directory ||=, but needs to be dynamic.
@@ -157,7 +157,7 @@ module Picky
     def directory
       ::File.join(Picky.root, 'index', PICKY_ENVIRONMENT, name.to_s)
     end
-    
+
     # Restrict categories to the given ones.
     #
     # Functionally equivalent as if indexes didn't
@@ -380,7 +380,7 @@ INDEX
       ].compact
       "#{self.class}(#{s.join(', ')})"
     end
-    
+
     # Displays the structure as a tree.
     #
     def to_tree_s indent = 0

data/lib/picky/index_indexing.rb

@@ -89,6 +89,17 @@ module Picky
       @source.respond_to?(:call) ? @source.call : @source
     end
 
+    # API method.
+    #
+    # Defines the name of the ID method to use on the indexed object.
+    #
+    # === Parameters
+    # * name: Method name of the ID.
+    #
+    def id name = nil
+      @id_name = name || @id_name || :id
+    end
+
     # Define a key_format on the index.
     #
     # Parameter is a method name to use on the key (e.g. :to_i, :to_s, :strip, :split).

data/lib/picky/indexers/parallel.rb

@@ -58,15 +58,17 @@ module Picky
       def index_flush objects, file, category, cache, tokenizer
         comma   = ?,
         newline = ?\n
-        
+
         # Optimized, therefore duplicate code.
         #
+        id = category.id
+        from = category.from
         objects.each do |object|
-          tokens = object.send category.from
+          tokens = object.send from
           tokens, _ = tokenizer.tokenize tokens if tokenizer # Note: Originals not needed. TODO Optimize?
           tokens.each do |token_text|
             next unless token_text
-            cache << object.id << comma << token_text << newline
+            cache << object.send(id) << comma << token_text << newline
           end
         end
 

data/spec/functional/id_spec.rb

@@ -0,0 +1,66 @@
+# encoding: utf-8
+#
+require 'spec_helper'
+
+describe "id option" do
+
+  it 'can be given a different id (in-ruby based)' do
+    data = Picky::Index.new :id do
+      id :number
+      category :text
+    end
+
+    require 'ostruct'
+
+    thing = OpenStruct.new number: 1, text: "ohai"
+    other = OpenStruct.new number: 2, text: "ohai kthxbye"
+
+    data.add thing
+    data.add other
+
+    try = Picky::Search.new data
+
+    try.search("text:kthxbye").ids.should == [2]
+  end
+
+  it 'can be given a different id (source based)' do
+    require 'ostruct'
+
+    things = []
+    things << OpenStruct.new(number: 1, text: "ohai")
+    things << OpenStruct.new(number: 2, text: "ohai kthxbye")
+
+    data = Picky::Index.new :id do
+      source { things }
+
+      key_format :to_i
+      id :number # TODO :format => :to_i
+      category :text
+    end
+
+    data.index
+
+    try = Picky::Search.new data
+
+    try.search("text:kthxbye").ids.should == [2]
+  end
+
+  it 'default is id' do
+    index = Picky::Index.new :id do
+      category :text
+    end
+
+    require 'ostruct'
+
+    thing = OpenStruct.new id: 1, text: "ohai"
+    other = OpenStruct.new id: 2, text: "ohai kthxbye"
+
+    index.add thing
+    index.add other
+
+    try = Picky::Search.new index
+
+    try.search("text:kthxbye").ids.should == [2]
+  end
+
+end

data/spec/functional/terminate_early_spec.rb

@@ -126,27 +126,23 @@ describe 'Search#terminate_early' do
     try.search('hello', 1, 20).allocations.map(&:count).should == [6, 6, 6, 6]
     try.search('hello', 1, 24).allocations.map(&:count).should == [6, 6, 6, 6]
 
-    try.search('hello', 1, 0).to_hash.should == {
-      :allocations => [
+    result_hash = try.search('hello', 1, 0).to_hash
+    result_hash[:allocations].should == [
         [:terminate_early, 1.792, 6, [[:text1, "hello", "hello"]], [6]],
         [:terminate_early, 1.792, 6, [[:text2, "hello", "hello"]], []]
-      ],
-      :offset => 0,
-      :duration => anything,
-      :total => 12
-    }
-
-    try.search('hello', 1, 12).to_hash.should == {
-      :allocations => [
+      ]
+    result_hash[:offset].should == 0
+    result_hash[:total].should == 12
+
+    result_hash = try.search('hello', 1, 12).to_hash
+    result_hash[:allocations].should == [
         [:terminate_early, 1.792, 6, [[:text1, "hello", "hello"]], []],
         [:terminate_early, 1.792, 6, [[:text2, "hello", "hello"]], []],
         [:terminate_early, 1.792, 6, [[:text3, "hello", "hello"]], [6]],
         [:terminate_early, 1.792, 6, [[:text4, "hello", "hello"]], []]
-      ],
-      :offset => 12,
-      :duration => anything,
-      :total => 24
-    }
+      ]
+    result_hash[:offset].should == 12
+    result_hash[:total].should == 24
 
     GC.start
 

data/spec/tools/picky/cli_spec.rb

@@ -4,7 +4,7 @@ require 'spec_helper'
 
 # We need to load the CLI file explicitly as the CLI is not loaded with the Loader (not needed in the server, only for script runs).
 #
-require_relative '../../../auxiliary/picky/cli'
+require_relative '../../../tools/picky/cli'
 
 describe Picky::CLI do
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: picky
 version: !ruby/object:Gem::Version
-  version: 4.21.0
+  version: 4.21.1
 platform: ruby
 authors:
 - Florian Hanke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-01 00:00:00.000000000 Z
+date: 2014-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -243,6 +243,7 @@ files:
 - spec/functional/exact_first_spec.rb
 - spec/functional/facets_spec.rb
 - spec/functional/from_spec.rb
+- spec/functional/id_spec.rb
 - spec/functional/ignore_allocations_spec.rb
 - spec/functional/ignore_spec.rb
 - spec/functional/max_allocations_spec.rb
@@ -397,7 +398,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: http://rubyforge.org/projects/picky
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: 'Picky: Semantic Search Engine. Clever Interface. Good Tools.'
@@ -421,6 +422,7 @@ test_files:
 - spec/functional/exact_first_spec.rb
 - spec/functional/facets_spec.rb
 - spec/functional/from_spec.rb
+- spec/functional/id_spec.rb
 - spec/functional/ignore_allocations_spec.rb
 - spec/functional/ignore_spec.rb
 - spec/functional/max_allocations_spec.rb
@@ -553,4 +555,3 @@ test_files:
 - spec/lib/tokenizer_spec.rb
 - spec/performant_spec.rb
 - spec/tools/picky/cli_spec.rb
-has_rdoc: