enf 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e55d0099cadb7696261d7142c429fab7af91d4a
-  data.tar.gz: 85fd5160859456781784d49ceed188f4b26ed9f0
+  metadata.gz: 0fe4cc422bed7680506a19566446cf892a7a4f2b
+  data.tar.gz: 0032fa20fdc2ef7ac2343bc1587f3f749f8aa764
 SHA512:
-  metadata.gz: 679913e249b668fa54d3da5303a9acb87aaa2e7444c9beaf50c0b35ea4f599b02e428caab10b548d56c0edd393b9901b195f85832f84de12333c975f24255ee0
-  data.tar.gz: fe80390060f3cb8d6af9b843a116780bf8f996bb2f7bc01283d736db29eb37acfe6fc74b0eb684ea32e2c473b0ffe37ce5ce097acd596150a0b428d5397d0f63
+  metadata.gz: ba6d389d65cd195790b14bab10fc01af33e9b147046b38a40b3528bd5aeb44efba50bc2492fdfc010200bf97169f81bfd16874333395aeb4023a9d9823095b55
+  data.tar.gz: 65f92d19a83ff8fc5a46543e7847e5596c10933910a660b0fccf39ae79bdbfe76550d3ca4e0252a8d0b5566d36343c5b5669484e5a18511e258a41bd9f7e9f19

data/README.md

@@ -7,6 +7,7 @@ Memory lightweight implementation of a white/black list
 *Building a dictionnary of all terms used in 'Les misérables'*
 
 ```ruby
+require 'enf'
 require 'open-uri'
 URI = 'https://www.gutenberg.org/ebooks/135.txt.utf-8'
 
@@ -99,6 +100,43 @@ volume of data, it is recommended to use it when memory matters most and
 when words are easily factorizable (example : as a black list for twitter
 spam bots).
 
+## Note on completion suggestions
+
+Enf::Elephant are now able to propose completion candidates from a word
+beginning, thanks to the 'suggest' method:
+
+```ruby
+require 'enf/suggest
+require 'open-uri'
+URI = 'https://www.gutenberg.org/ebooks/135.txt.utf-8'
+
+elephant = Enf::Elephant.new
+
+open(URI) do |file|
+  file.read.scan(/[[:alpha:]]*/).each do |token|
+    elephant.register! token.downcase
+  end
+end
+
+suggestions = elephant.suggest('ele', limit: 5, incompletes: false)
+# => #<Set: {"ven", "venth", "vate", "vated", "vates", "ment",
+#            "ments", "gant", "gance", "gy", "onore", "phant",
+#            "ct", "ctor", "ctric", "cted", "usiac"}>
+
+puts suggestions.map { |ending| 'ele' + ending }.inspect
+# => ["eleven", "eleventh", "elevate", "elevated", "elevates",
+#     "element", "elements", "elegant", "elegance", "elegy",
+#     "eleonore", "elephant", "elect", "elector", "electric",
+#     "elected", "eleusiac"]
+
+```
+
+*Parameters detail:*
+
+* The first non optional parameter is the beginning of the words to search for.
+* The limit optional parameter (default: :none) is the number of characters to allow the elephant to inquire for. That parameter allow 2 kinds of value: the :none symbol, that search deeply in the graph for corresponding completion candidates, or a strictly positive integer. (Example: with the value 2, the previous example would have only returned elegy and elect).
+* The incompletes optional parameter (default: false) is a boolean parameter allowing to add intermediates incompletes words to the result set. (Example: with limit = 2 and incompletes = true, the previous result set would have been: ['ve', 'va', 'me', 'ga', 'gy', 'on', 'ph', 'ct', 'us'])
+
 ## Next ?
 
 I will probably be working on:
@@ -107,6 +145,4 @@ I will probably be working on:
 (example: bar, in the previous example), a hash is created for every
 letter of that specific path. We have to merge theim as a single element
 to avoid useless hash creation.
-2. Completion: With that data structure, it will be quite easy and
-efficient to propose completion candidates from a start of word.
-3. tbd
+2. tbd

data/lib/enf/elephant.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require 'enf/input'
+
 module Enf
   # Represent a node of the graph
   class Elephant
@@ -11,7 +13,7 @@ module Enf
     end
 
     def register!(element, payload = true)
-      fail CannotRegister if frozen? || invalid?(element)
+      fail CannotRegister if frozen? || Input.invalid?(element)
       return (@leave = payload) if element.empty?
       @children[element[0]].register!(element[1..-1])
     end
@@ -31,7 +33,7 @@ module Enf
     end
 
     def include?(element)
-      return @default_leave_value if invalid?(element)
+      return @default_leave_value if Input.invalid?(element)
       include_impl element
     end
 
@@ -39,17 +41,5 @@ module Enf
       return @leave if element.empty?
       @children.fetch(element[0]) { Nope.instance }.include_impl(element[1..-1])
     end
-
-    protected
-
-    require 'set'
-
-    AUTHORIZED_TYPES = Set.new([String, Array]).freeze
-
-    def invalid?(element)
-      return true if element.nil?
-      return true unless AUTHORIZED_TYPES.include? element.class
-      false
-    end
   end
 end

data/lib/enf/input.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+module Enf
+  # Helper class for inputs
+  class Input
+    require 'set'
+
+    AUTHORIZED_TYPES = Set.new([String, Array]).freeze
+
+    def self.invalid?(element)
+      return true if element.nil?
+      return true unless AUTHORIZED_TYPES.include? element.class
+      false
+    end
+  end
+end

data/lib/enf/suggest.rb

@@ -0,0 +1,69 @@
+# encoding: utf-8
+
+require 'enf/elephant'
+
+# Base module
+module Enf
+  # Completion logic
+  module Complete
+    def suggest(start, limit: :none, incompletes: false)
+      once_validated!(start, limit, incompletes) do |s, l, i|
+        suggest_impl(s, l, i)
+      end
+    end
+
+    protected
+
+    # Nil class for suggestions
+    class Silent
+      require 'singleton'
+      include Singleton
+      def suggest_impl(_start, _limit, _incompletes, _prefix, results)
+        results
+      end
+    end
+
+    def suggest_impl(start, limit, incompletes, prefix = '', results = Set.new)
+      if start == ''
+        return results if limit != :none && limit < 0
+        results << prefix if @leave || (incompletes && limit == 0)
+        limit = limit - 1 unless limit == :none
+        if limit == :none || limit >= 0
+          @children.each do |key, child|
+            new_prefix = prefix + key
+            results =
+              child.suggest_impl(start, limit, incompletes, new_prefix, results)
+          end
+        end
+      else
+        child = @children.fetch(start[0]) { Silent.instance }
+        results =
+          child.suggest_impl(start[1..-1], limit, incompletes, prefix, results)
+      end
+      results
+    end
+
+    class SuggestParamError < StandardError; end
+
+    NEG_VAL_ERR = 'Strictly non negative values accepted only'
+
+    def validate_char_limit!(value)
+      return value if value == :none
+      fail SuggestParamError if value.nil?
+      value = Integer(value)
+      fail SuggestParamError, NEG_VAL_ERR if value <= 0
+      value
+    rescue StandardError => error
+      raise SuggestParamError, error.message
+    end
+
+    INVALID_ERR = 'Invalid input "%s"'
+
+    def once_validated!(start, char_limit, return_incompletes)
+      fail SuggestParamError, INVALID_ERR % start if Input.invalid? start
+      char_limit = validate_char_limit!(char_limit)
+      yield start, char_limit, return_incompletes
+    end
+  end
+  Elephant.send(:include, Complete)
+end

data/lib/enf/version.rb

@@ -3,7 +3,7 @@
 module Enf
   # This module holds the Enf version information.
   module Version
-    STRING = '0.0.0'
+    STRING = '0.1.0'
 
     module_function
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enf
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Alexandre Ignjatovic
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-15 00:00:00.000000000 Z
+date: 2015-07-16 00:00:00.000000000 Z
 dependencies: []
 description: Graph based white/black list implementation. Your elephant won't forget.
 email: alexandre.ignjatovic@gmail.com
@@ -21,6 +21,8 @@ files:
 - enf.gemspec
 - lib/enf.rb
 - lib/enf/elephant.rb
+- lib/enf/input.rb
+- lib/enf/suggest.rb
 - lib/enf/version.rb
 homepage: https://github.com/bankair/enf
 licenses: