word_zoo 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b980d97658ef99270d8a6437d0d5667e8adaa73631ef967a0c8c0efae39fea9
-  data.tar.gz: 752981d6044403098267c03bf7d27d7b6abd13d915969fec1daca3cea081f4ca
+  metadata.gz: e22906f1b1f5f3a9121307632b7857145577c0562a6149b62f141c82d39cb039
+  data.tar.gz: 6962d2b35d85effefa1e81cf1f86d6cca8f03851b8a067410bf1681d3e23710d
 SHA512:
-  metadata.gz: 7dab2eeb0da21dd5d2c290f42aed3c8f7865d4b4f0f439e66291fa326b5d57282425657e63642bf8aaf45b66a675db691fdde8501e89fb67cef048204983e7a4
-  data.tar.gz: ff577d0eb3a96ea0b0eb51b16ad68860fe6310bce046593493124b323b1a86adf9bb2fff9d20eaab22a7cf91b8b349d34d7cf3148f5883196d86cae52f0689a1
+  metadata.gz: 63986a14d6daedfc8ee2018c319bcd8c0785e7d3ca10453546ede0d4efc9726a8d2877e32d5b20ef0e5d1d08ae6d20a21818a7ffbc6ea50499cb529ddfc512ae
+  data.tar.gz: c4269c8c7f8063c1739105f090dd5ee32c69d1d12a1ce3c2f84367e6a904e37eabef2f87845f6fae8abde007e071f73e85d9a5e7a1c883cfec49a05b04e5db9d

data/README.md

@@ -1,8 +1,8 @@
 # WordZoo
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/word_zoo`. To experiment with that code, run `bin/console` for an interactive prompt.
+This gem is about saving space and time.  There is a near infinite amount of words in the english language, and many word lists can reac row counts in the millions.
 
-TODO: Delete this and the text above, and describe your gem
+Using dictionary trees with letter nodes, the largest a dictionary may get is 26 to the 26th power, which is large, but manageable.  In this way words like 'cat', 'catepillar' and category may consolidate thier shared prefixes.
 
 ## Installation
 
@@ -32,22 +32,75 @@ Or install it yourself as:
            t.string :name
 
 
+## Instance methods:
 
+  # Input a word into a word tree
+      input_word(word)
+        eg:
+            > example_list.input_word("lao")
+                 => true
+            > example_list.input_word("lao")
+                 => true
 
-## Development
+      # list all words
+      list_words
+        eg:
+            > example_list.list_words
+                => ["matt", "lao"]
+
+
+  # Remove a word from a tree
+      def remove_word(word)
+        eg:
+            > example_list.remove_word("matt")
+             => true
+            > example_list.list_words
+             => ["lao"]
+
+  # get a hash whether or not certain lengths are in the tree
+      word_lengths_data
+        eg:
+            > example_list.word_lengths_data
+            => {"4"=>1, "3"=>1, "6"=>1}
+
+            in this example the list_words method would return: ["matt", "matter", "lao"]: there are words of lengths 4, 3 and 6 present in the example dictionary tree.
+
+
+  # see if the input word exists in this list
+      is_word?(word)
+          eg:
+            > example_list.is_word?("matt")
+             => true
+            > example_list.is_word?("pee")
+             => false
+
+  # find a random word
+            > example_list.find_word
+             => "matt"
+
+  # view the tree as it exists as a tree object
+      eg:
+          > examplelist.tree
+              => {"m"=>{"is_word"=>false, "a"=>{"is_word"=>false, "t"=>{"is_word"=>false, "t"=>{"is_word"=>true}}}}, "l"=>{"is_word"=>false, "a"=>{"is_word"=>false, "o"=>{"is_word"=>true}}}}
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+
+
+## Development
+
+After pulling down the source code from github, use this in any local active record app.
+```ruby
+gem 'word_zoo', '0.1.1', path: "../word_zoo"
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/word_zoo. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/word_zoo/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/laomatt/word_zoo. This project is intended to be a safe, welcoming space for collaboration.
+
+Please create PRs and tag the authors.
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
-## Code of Conduct
-
-Everyone interacting in the WordZoo project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/word_zoo/blob/master/CODE_OF_CONDUCT.md).

data/lib/word_zoo/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WordZoo
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/word_zoo.rb

@@ -65,8 +65,35 @@ module WordZoo
   end
 
   def remove_word(word)
-    # travel the word tree to the last letter
-    # make 'is_word' false on the last node
+    return if word.nil?
+    init_tree = self.tree
+    word_letters = word.downcase.split('')
+
+    find_letter_in_level = lambda do |word_letters_left, lvl_tree|
+      letter = word_letters_left.shift
+
+      if letter.nil?
+        lvl_tree['is_word'] = false
+        return lvl_tree
+      end
+
+      if !lvl_tree[letter]
+        lvl_tree[letter] = { 'is_word' => false }
+      end
+
+      lvl_tree[letter] = lvl_tree[letter].merge(find_letter_in_level.call(word_letters_left, lvl_tree[letter]))
+
+      lvl_tree
+    end
+
+    self.letters = find_letter_in_level.call(word_letters, init_tree).to_json
+
+    # update the lengths
+    lengths = self.word_lengths_data
+    lengths[word.length] = 1
+    self.word_lengths = lengths.to_json
+
+    self.save!
   end
 
   # get a hash of how many words of each length exists

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: word_zoo
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Matt Lao
+- Malika Kassen-Lao
 autorequire:
 bindir: exe
 cert_chain: []
 date: 2022-04-17 00:00:00.000000000 Z
 dependencies: []
-description:
+description: To use this, please include WordZoo as a module in your model.
 email:
 - laomatt1@gmail.com
 executables: []