autocompletion 0.0.1 → 0.0.2

data/README.markdown

@@ -28,7 +28,7 @@ Usage
       Person.new("Luke", "Skywalker"),
       Person.new("Anakin", "Skywalker"),
     ]
-    auto    = AutoCompletion.map(people) { |person|
+    auto    = AutoCompletion.map_keys(people) { |person|
       [person.first_name, person.last_name]
     }
 

data/autocompletion.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name                      = "autocompletion"
-  s.version                   = "0.0.1"
+  s.version                   = "0.0.2"
   s.authors                   = "Stefan Rusterholz"
   s.email                     = "stefan.rusterholz@gmail.com"
   s.homepage                  = "http://github.com/apeiros/autocompletion"

data/lib/autocompletion.rb

@@ -24,7 +24,7 @@ require 'autocompletion/version'
 #       Person.new("Luke", "Skywalker"),
 #       Person.new("Anakin", "Skywalker"),
 #     ]
-#     auto    = AutoCompletion.map(people) { |person|
+#     auto    = AutoCompletion.map_keys(people) { |person|
 #       [person.first_name, person.last_name]
 #     }
 #
@@ -53,9 +53,9 @@ class AutoCompletion
   end
 
   # @return [AutoCompletion]
-  #   Map a list of entities to their keys. The block should return an array of valid
-  #   prefixes for the yielded entity.
-  def self.map(entities)
+  #   Map a list of entities to many of their attributes.
+  #   The block should return an array of strings which can be prefix-searched.
+  def self.map_keys(entities)
     mapped = entities.flat_map { |entity|
       keys = yield(entity)
       keys.flat_map { |key| [key, entity] }
@@ -64,6 +64,17 @@ class AutoCompletion
     unordered_tuples(mapped.each_slice(2))
   end
 
+  # @return [AutoCompletion]
+  #   Map a list of entities to one its attributes.
+  #   The block should return string which can be prefix-searched.
+  def self.map_key(entities)
+    mapped = entities.flat_map { |entity|
+      [key, yield(entity)]
+    }
+
+    unordered_tuples(mapped)
+  end
+
   # @return [AutoCompletion]
   #   Creates an AutoCompletion for an unordered array of the form [["prefix", value], …].
   def self.unordered_tuples(entities)
@@ -83,16 +94,15 @@ class AutoCompletion
   # @see AutoCompletion::words, AutoCompletion::map
   def initialize(entities, force=false)
     @entities = entities
-    raise InvalidOrder.new unless force || valid?
+    raise InvalidOrder unless force || valid?
   end
 
   # @return [Boolean]
   #   Returns true if the prefixes are in a valid order.
   def valid?
-    @entities.each_slice(2).each_cons(2) do |(a,_),(b,_)|
-      return false unless a <= b
-    end
-    true
+    @entities.each_slice(2).each_cons(2).all? { |(a,_),(b,_)|
+      a <= b
+    }
   end
 
   # @return [Boolean]
@@ -138,8 +148,12 @@ class AutoCompletion
       word < @entities.first[0,word.size] || word > @entities[-2][0,word.size]
     }
 
-    slices = prefixes.map { |word| range_search(word) }
-    return [] if slices.include?(nil) # short-cut
+    slices = prefixes.map { |word|
+      slice = range_search(word)
+      return [] unless slice # short-cut
+
+      slice
+    }
 
     result = @entities[slices.pop].each_slice(2).map(&:last).uniq
     slices.each do |slice|
@@ -168,7 +182,7 @@ class AutoCompletion
     return length..length if @entities[-2][0,prefix_size] < prefix # prefix is bigger than biggest value
 
     # binary search for smallest index
-    # mark biggest right that include prefix, and biggest mark that doesn't include prefix
+    # mark biggest right which includes prefix, and biggest mark that doesn't include prefix
     while(left<right)
       index     = (left+right)>>1
       cmp_value = @entities.at(index<<1)[0,prefix_size]

data/lib/autocompletion/version.rb

@@ -9,5 +9,5 @@ end
 class AutoCompletion
 
   # The version of the gem
-  Version = Gem::Version.new("0.0.1")
+  Version = Gem::Version.new("0.0.2")
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: autocompletion
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-19 00:00:00.000000000Z
+date: 2012-08-08 00:00:00.000000000 Z
 dependencies: []
 description: This gem provides fast prefix-autocompletion in pure ruby.
 email: stefan.rusterholz@gmail.com
@@ -42,8 +42,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Fast prefix-autocompletion in pure ruby.
 test_files: []
+has_rdoc: