improvise 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4d23a1bbb23c53484630f7e37c9eaf98aefffef7
-  data.tar.gz: 8017aec4d0fa52f0dcda9a65fc8ea17e1dbb573d
+  metadata.gz: 20e2150a56f14065cefb3d37dfb58694a4f39d9f
+  data.tar.gz: 1aefacfe9d5a94cc298e405f4f88f0725714621a
 SHA512:
-  metadata.gz: b9e9f8471cd08b819667c12dcfe45ef24ca94d2ba9f1ec9180cca1d8e3d8f4c83e6071333c2ca01c3a1b9eeaeb368d8a24a864eef9cf566c11c0bdb08121b88f
-  data.tar.gz: b8d199c5a1f6465e713ae5fadc6ec813cf0527ba7027c13758ce00ae6241c9631f42357b59b6aaec652543beae552a99a57cc7dd47ccd89a02acfd27dbc491db
+  metadata.gz: afa09f4a97bd02eaff58a966769026eda56625f3b27241fbf49035c87771e106f0dd826f186290a771f7bd56b85124cfdbb957f9b5c019845c0f074249214bae
+  data.tar.gz: e66451c405c93f8285ae65b649bda0fd4301d583676c20732fa0b6fe06dc79b859901df38647184061e7819b1a9ae094a12f939a403a837dde97d86ac671f870

data/README.md

@@ -27,10 +27,21 @@ require 'improvise'
 ```
 
 ### Learn
-Create a new dictionary with depth 3 and learn from a list of existing words:
+Create a new dictionary with depth 3:
 
 ```ruby
 dict = Improvise::ForwardDictionary.new(3)
+```
+
+Or create a reversed dictionary with depth 3:
+
+```ruby
+dict = Improvise::ReverseDictionary.new(3)
+```
+
+Learn from a list of existing words:
+
+```ruby
 dict.learn!([
     'ruby', 
     'sapphire', 

data/bin/improvise

@@ -17,6 +17,7 @@ desc 'Create or update a dictionary based on an input file'
 arg_name 'input dictionary'
 command :learn do |c|
     c.flag [:d, :depth], :desc => 'The depth to use when building the dictionary', :default_value => 2, :type => Integer
+    c.switch [:r, :reverse], :desc => 'Build a reverse dictionary', :negatable => false
 
     c.action do |global_options, options, args|
         if args.length < 1
@@ -28,6 +29,7 @@ command :learn do |c|
         input_filename = args[0]
         dictionary_filename = args[1]
         depth = options[:depth]
+        reverse = options[:reverse]
         format = global_options[:format]
         gzip = global_options[:gzip]
 
@@ -38,7 +40,11 @@ command :learn do |c|
         if File.exists?(dictionary_filename)
             dictionary = Improvise::IO::DictionaryReader.read(File.open(dictionary_filename, 'r'), format: format, gzip: gzip)
         else
-            dictionary = Improvise::ForwardDictionary.new(depth)
+            if reverse
+                dictionary = Improvise::ReverseDictionary.new(depth)
+            else
+                dictionary = Improvise::ForwardDictionary.new(depth)
+            end
         end
 
         dictionary.learn!(words)

data/improvise.gemspec

@@ -1,14 +1,12 @@
-require 'improvise/version'
-
 Gem::Specification.new do |s|
     s.specification_version = 2 if s.respond_to? :specification_version=
     s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
     s.rubygems_version = '1.3.5'
 
     s.name = 'improvise'
-    s.version = Improvise::VERSION
+    s.version = '0.2.0'
     s.platform = Gem::Platform::RUBY
-    s.date = '2014-05-20'
+    s.date = '2014-05-21'
     s.authors = ['Sander Kleykens']
     s.email = ['sander@kleykens.com']
     s.homepage = 'http://github.com/SanderKleykens/improvise'
@@ -51,12 +49,15 @@ Gem::Specification.new do |s|
         lib/improvise/io/dictionaryreader.rb
         lib/improvise/io/dictionarywriter.rb
         lib/improvise/io/io.rb
+        lib/improvise/reversedictionary.rb
+        lib/improvise/util/stringutils.rb
         lib/improvise/version.rb
         spec/improvise/dictionary_spec.rb
         spec/improvise/dictionarytree_spec.rb
         spec/improvise/forwarddictionary_spec.rb
         spec/improvise/io/dictionaryreader_spec.rb
         spec/improvise/io/dictionarywriter_spec.rb
+        spec/improvise/reversedictionary_spec.rb
         spec/spec_helper.rb
   ]
     # = MANIFEST =

data/lib/improvise.rb

@@ -1,3 +1,4 @@
 require 'improvise/version'
 require 'improvise/forwarddictionary'
+require 'improvise/reversedictionary'
 require 'improvise/io/io'

data/lib/improvise/dictionarytree.rb

@@ -8,24 +8,24 @@ module Improvise
             @root = root || Tree::TreeNode.new('root')
         end
 
-        def add_entry!(prefix, suffix)
-            prefix_node = DictionaryTree.add_node!(@root, prefix)
-            prefix_node.content += 1
+        def add_entry!(key, value)
+            key_node = DictionaryTree.add_node!(@root, key)
+            key_node.content += 1
 
-            suffix_node = DictionaryTree.add_node!(prefix_node, suffix)
-            suffix_node.content += 1
+            value_node = DictionaryTree.add_node!(key_node, value)
+            value_node.content += 1
         end
 
-        def random_prefix
+        def random_key
             DictionaryTree.new_pickup(@root).pick
         end
 
-        def random_suffix(prefix)
-            if prefix.nil?
+        def random_value(key)
+            if key.nil?
                 return nil
             end
 
-            node = @root[prefix]
+            node = @root[key]
 
             if node.nil?
                 return nil

data/lib/improvise/forwarddictionary.rb

@@ -1,4 +1,5 @@
 require 'improvise/dictionary'
+require 'improvise/util/stringutils'
 
 module Improvise
     class ForwardDictionary < Dictionary
@@ -7,21 +8,20 @@ module Improvise
         end
 
         def generate_word(length, root=nil)
-            word = root || @tree.random_prefix
-            word = word.slice(0..(length - 1))
+            word = root || @tree.random_key
 
             while word.length < length do
-                suffix = @tree.random_suffix(word[[-@depth, 0].max..-1])
-                word += suffix || @tree.random_prefix
-                word = word.slice(0..(length - 1))
+                suffix = @tree.random_value(word[[-@depth, 0].max..-1])
+                word += suffix || @tree.random_key
             end
 
-            word
+            Improvise::Util::StringUtils.truncate(word, length, omission: '')
         end
 
         def learn!(words)
             [*words].each do |word|
-                @tree.add_entry!('', word.slice(0..(@depth - 1)))
+                start_of_word = word.slice(0..(@depth - 1))
+                @tree.add_entry!('', start_of_word)
 
                 word.split('').each_cons(@depth + 1) do |characters|
                     prefix = characters[0..-2].join('')

data/lib/improvise/reversedictionary.rb

@@ -0,0 +1,35 @@
+require 'improvise/dictionary'
+require 'improvise/util/stringutils'
+
+module Improvise
+    class ReverseDictionary < Dictionary
+        def initialize(depth=2, tree=nil)
+            super(depth, tree)
+        end
+
+        def generate_word(length, root=nil)
+            word = root || @tree.random_key
+
+            while word.length < length do
+                prefix = @tree.random_value(word[[-@depth, 0].max..-1])
+                word = (prefix || @tree.random_key) + word
+            end
+
+            Improvise::Util::StringUtils.truncate(word.reverse, length, omission: '').reverse
+        end
+
+        def learn!(words)
+            [*words].each do |word|
+                start_of_word = word.reverse.slice(0..(@depth - 1)).reverse
+                @tree.add_entry!('', start_of_word)
+
+                word.split('').reverse.each_cons(@depth + 1) do |characters|
+                    suffix = characters[0..(@depth - 1)].reverse.join('')
+                    prefix = characters[depth]
+
+                    @tree.add_entry!(suffix, prefix)
+                end
+            end
+        end
+    end
+end

data/lib/improvise/util/stringutils.rb

@@ -0,0 +1,39 @@
+module Improvise
+    module Util
+        module StringUtils
+            # Truncates a given +text+ after a given <tt>length</tt> if +text+ is longer than <tt>length</tt>:
+            #
+            #   truncate('Once upon a time in a world far far away', 27)
+            #   # => "Once upon a time in a wo..."
+            #
+            # Pass a string or regexp <tt>:separator</tt> to truncate +text+ at a natural break:
+            #
+            #   truncate('Once upon a time in a world far far away', 27, separator: ' ')
+            #   # => "Once upon a time in a..."
+            #
+            #   truncate('Once upon a time in a world far far away', 27, separator: /\s/)
+            #   # => "Once upon a time in a..."
+            #
+            # The last characters will be replaced with the <tt>:omission</tt> string (defaults to "...")
+            # for a total length not exceeding <tt>length</tt>:
+            #
+            #   truncate('And they found that many people were sleeping better.', 25, omission: '... (continued)')
+            #   # => "And they f... (continued)"
+            #
+            # Adapted from Ruby on Rails (released under the MIT license)
+            def self.truncate(string, truncate_at, options = {})
+                return string.dup unless string.length > truncate_at
+
+                options[:omission] ||= '...'
+                length_with_room_for_omission = truncate_at - options[:omission].length
+                stop = if options[:separator]
+                           string.rindex(options[:separator], length_with_room_for_omission) || length_with_room_for_omission
+                       else
+                           length_with_room_for_omission
+                       end
+
+                "#{string[0...stop]}#{options[:omission]}"
+            end
+        end
+    end
+end

data/lib/improvise/version.rb

@@ -1,3 +1,3 @@
 module Improvise
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
 end

data/spec/improvise/dictionarytree_spec.rb

@@ -1,37 +1,37 @@
 require 'spec_helper'
 
 describe Improvise::DictionaryTree do
-    PREFIX = 'te'
-    SUFFIX = 's'
+    KEY = 'te'
+    VALUE = 's'
 
     before do
         @empty_tree = Improvise::DictionaryTree.new
     end
 
-    it "should return nil as random prefix if the tree is empty" do
-        expect(@empty_tree.random_prefix).to eq(nil)
+    it "should return nil as random key if the tree is empty" do
+        expect(@empty_tree.random_key).to eq(nil)
     end
 
-    it "should return nil as random suffix if the prefix hasn't been found" do
-        expect(@empty_tree.random_suffix('test')).to eq(nil)
+    it "should return nil as random value if the prefix hasn't been found" do
+        expect(@empty_tree.random_value('test')).to eq(nil)
     end
 
-    it "should return nil as random suffix if the prefix is nil" do
-        expect(@empty_tree.random_suffix(nil)).to eq(nil)
+    it "should return nil as random value if the prefix is nil" do
+        expect(@empty_tree.random_value(nil)).to eq(nil)
     end
 
-    it "should return '#{PREFIX}'" do
+    it "should return '#{KEY}'" do
         tree = Improvise::DictionaryTree.new
-        tree.add_entry!(PREFIX, SUFFIX)
+        tree.add_entry!(KEY, VALUE)
 
-        expect(tree.random_prefix).to eq(PREFIX)
+        expect(tree.random_key).to eq(KEY)
     end
 
-    it "should return '#{SUFFIX}'" do
+    it "should return '#{VALUE}'" do
         tree = Improvise::DictionaryTree.new
-        tree.add_entry!(PREFIX, SUFFIX)
+        tree.add_entry!(KEY, VALUE)
         tree.add_entry!('aa', 's')
 
-        expect(tree.random_suffix(PREFIX)).to eq(SUFFIX)
+        expect(tree.random_value(KEY)).to eq(VALUE)
     end
 end

data/spec/improvise/reversedictionary_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Improvise::ReverseDictionary do
+    before do
+        @dict1 = Improvise::ReverseDictionary.new(1)
+        @dict2 = Improvise::ReverseDictionary.new
+    end
+
+    it "should have depth 1" do
+        expect(@dict1.depth).to eq(1)
+    end
+
+    it "should have depth 2" do
+        expect(@dict2.depth).to eq(2)
+    end
+
+    it "should generate 'te' using depth 1" do
+        @dict1.learn!('te')
+        expect(@dict1.generate_word(2, 'e')).to eq('te')
+    end
+
+    it "should generate 'te' using depth 2" do
+        @dict2.learn!('te')
+        expect(@dict2.generate_word(2)).to eq('te')
+    end
+
+    it "should generate 'tes' using depth 2" do
+        @dict2.learn!('tes')
+        expect(@dict2.generate_word(3, 'es')).to eq('tes')
+    end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: improvise
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Sander Kleykens
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-20 00:00:00.000000000 Z
+date: 2014-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gli
@@ -157,12 +157,15 @@ files:
 - lib/improvise/io/dictionaryreader.rb
 - lib/improvise/io/dictionarywriter.rb
 - lib/improvise/io/io.rb
+- lib/improvise/reversedictionary.rb
+- lib/improvise/util/stringutils.rb
 - lib/improvise/version.rb
 - spec/improvise/dictionary_spec.rb
 - spec/improvise/dictionarytree_spec.rb
 - spec/improvise/forwarddictionary_spec.rb
 - spec/improvise/io/dictionaryreader_spec.rb
 - spec/improvise/io/dictionarywriter_spec.rb
+- spec/improvise/reversedictionary_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/SanderKleykens/improvise
 licenses: