scrabble_score 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e50682c71668ab9bfd50b6385b6aa79acbe8ab3d
+  data.tar.gz: 7d56df83c91e4d0f4244f789eeb385404c921c40
+SHA512:
+  metadata.gz: 0cff454cf66d6b5143319526257e16ae613fa0ae161502d22c947f784f85d42a07535e12cd049af832a2f65df545f562a575292a451042639a9b3b766321ab9e
+  data.tar.gz: 72ca303fd12ea911f60d44fb546cf80f8f6ed680bdb2e94cb8b195a4e9d9394435923e8b68c265112e9f922bc7d65f0baa7a8db0e86d1cd44dfb8b8959e4d6b9

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea/
+coverage/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nick Aschenbach
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,67 @@
+# ScrabbleScore
+
+A simple Scrabble cheating library that estimates word score. Given a set of letters, one can search for all
+permutation against the SOWPODS dictionary. For example:
+
+```
+ScrabbleScore::WordFinder.new.search_with_score('uiqza')
+```
+
+Which returns:
+
+```
+{"qi"=>11, "za"=>11, "ai"=>2, "qua"=>12, "quiz"=>22, "quai"=>13}
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'scrabble_score'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install scrabble_score
+
+## Usage
+
+One can search for words in the dictionary without score via:
+
+```
+ScrabbleScore::WordFinder.new.search('foobar')
+```
+
+While the WordFinder uses the SOWPODS dictionary, it's possible to replace it with your own:
+
+```
+dictionary = ScrabbleScore::Dictionary.new(%w[apple pear banana])
+ScrabbleScore::WordFinder.new(dictionary)
+```
+
+The dictionary can be searched directly:
+
+```
+dictionary = ScrabbleScore::Dictionary.new
+dictionary.contains('vermilion') # returns true
+```
+
+In addition the letter permutation can be used independently from the other components:
+
+```
+letters = ScrabbleScore::Letters.new('xyz')
+letters.permutations # returns ["xy", "xz", "yx", "yz", "zx", "zy", "xyz", "xzy", "yxz", "yzx", "zxy", "zyx"]
+```
+
+Note that this will only show permutations from two letters up to the size of the input string.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/scrabble_score/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request