blurrily 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27ce94ccac1210a5ee4da5ad3e3d63b2a168c196
-  data.tar.gz: b6cb53523c464a470a97a6e6d776322f88d899a9
+  metadata.gz: 10d0da3c08622113e1580e66c8dce70c440e5c84
+  data.tar.gz: ca80fdcd586ba8b9723799523e5eaef766116a0e
 SHA512:
-  metadata.gz: 9785056cf139725e62a1cb4041cb78d1b3160d1ae050cc97085f6233ec442aa530088d60b6c13881aaf1b5546d950f056cf040af221dbb19851b870d21845264
-  data.tar.gz: cb50cd6063d0d53c402af3014a52af3be8729f9bef698fbd324c8e707f97bb060842486d227f0b422a7faa6a7ccb6ccd2d46fc93976e666491deacfc84bd689b
+  metadata.gz: d563833faf1eb740600d6f628e378de3b4252a512a03758b8dc1e7dfd604837818ea7f53d8a6fef67522eabd355cd8d556e429406d09856a4151d48b232f8a5f
+  data.tar.gz: f46114e88375943a7423f094fe0b4c9a8fa2d28e22165434456b0b5d46758b175bb6106569738a3d118cd43fddcf174e04c51161287c3ce7683fb8583349e88a

data/lib/blurrily/client.rb

@@ -8,64 +8,71 @@ module Blurrily
   class Client
     Error = Class.new(RuntimeError)
 
-    # Public: Initialize a new Blurrily::Client connection to Blurrily::Server.
+    # Initialize a new {Blurrily::Client} connection to {Blurrily::Server}.
     #
-    # host    - IP Address or FQDN of the Blurrily::Server.
+    # @param host IP Address or FQDN of the Blurrily::Server.
     #           Defaults to Blurrily::DEFAULT_HOST.
-    # port    - Port Blurrily::Server is listening on.
+    # @param port Port Blurrily::Server is listening on.
     #           Defaults to Blurrily::DEFAULT_PORT.
-    # db_name - Name of the data store being targeted.
+    # @param db_name Name of the data store being targeted.
     #           Defaults to Blurrily::DEFAULT_DATABASE.
     #
     # Examples
     #
-    #  Blurrily::Client.new('127.0.0.1', 12021, 'location_en')
-    #  # => #<Blurrily::Client:0x007fcd0d33e708 @host="127.0.0.1", @port=12021, @db_name="location_en">
+    # ```
+    # Blurrily::Client.new('127.0.0.1', 12021, 'location_en')
+    # # => #<Blurrily::Client:0x007fcd0d33e708 @host="127.0.0.1", @port=12021, @db_name="location_en">
+    # ```
     #
-    # Returns the instance of Blurrily::Client
+    # @returns the instance of {Blurrily::Client}
     def initialize(options = {})
       @host    = options.fetch(:host,     DEFAULT_HOST)
       @port    = options.fetch(:port,     DEFAULT_PORT)
       @db_name = options.fetch(:db_name,  DEFAULT_DATABASE)
     end
 
-    # Public: Find record references based on a given string (needle)
+    # Find record references based on a given string (needle)
     #
-    # needle - The string you're searching for matches on.
+    # @param needle The string you're searching for matches on.
     #          Must not contain tabs.
     #          Required
-    # limit  - Limit the number of results retruned (default: 10).
-    #          MUST be numeric.
+    # @param limit  Limit the number of results retruned (default: 10).
+    #          Must be numeric.
     #          Optional
     #
     # Examples
     #
-    #  @client.find('London')
-    #  # => [[123,6,3],[124,5,3]...]
+    # ```
+    # @client.find('London')
+    # # => [[123,6,3],[124,5,3]...]
+    # ```
     #
-    # Returns an Array of matching [REF,SCORE,WEIGHT] ordered by score. REF is the identifying value of the original record.
+    # @returns an Array of matching [`ref`,`score`,`weight`] ordered by score. `ref` is the identifying value of the original record.
+    # Note that unless modified, `weight` is simply the string length.
     def find(needle, limit = nil)
       limit ||= LIMIT_DEFAULT
       check_valid_needle(needle)
       raise(ArgumentError, "LIMIT value must be in #{LIMIT_RANGE}") unless LIMIT_RANGE.include?(limit)
 
       cmd = ["FIND", @db_name, needle, limit]
-      send_cmd_and_get_results(cmd).map(&:to_i)
+      send_cmd_and_get_results(cmd).map(&:to_i).each_slice(3).to_a
     end
 
-    # Public: Index a given record.
+    # Index a given record.
     #
-    # db_name - The name of the data store being targeted. Required
-    # needle  - The string you wish to index. Must not contain tabs. Required
-    # ref     - The indentifying value of the record being indexed. Must be numeric. Required
-    # weight  - Weight of this particular reference. Default 0. Don't change unless you know what you're doing. Optional.
+    # @param db_name The name of the data store being targeted. Required
+    # @param needle The string you wish to index. Must not contain tabs. Required
+    # @param ref The indentifying value of the record being indexed. Must be numeric. Required
+    # @param weight Weight of this particular reference. Default 0. Don't change unless you know what you're doing. Optional.
     #
     # Examples
     #
-    #  @client.put('location_en', 'London', 123, 0)
-    #  # => OK
+    # ```
+    # @client.put('location_en', 'London', 123, 0)
+    # # => OK
+    # ```
     #
-    # Returns something to let you know that all is well.
+    # @returns something to let you know that all is well.
     def put(needle, ref, weight = 0)
       check_valid_needle(needle)
       check_valid_ref(ref)
@@ -126,4 +133,4 @@ module Blurrily
     end
 
   end
-end
+end

data/lib/blurrily/command_processor.rb

@@ -42,8 +42,7 @@ module Blurrily
       raise ProtocolError, 'Limit must be a number' if limit && !LIMIT_RANGE.include?(limit.to_i)
 
       results = @map_group.map(map_name).find(*[needle, limit && limit.to_i].compact)
-      refs = results.map{ |result| result.first }
-      return refs
+      return results.flatten
     end
 
     def on_CLEAR(map_name)

data/lib/blurrily/version.rb

@@ -1,3 +1,3 @@
 module Blurrily
-  VERSION = "0.3.0"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blurrily
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Julien Letessier