scrabble_score 0.1.0

data/lib/scrabble_score/dictionary.rb

@@ -0,0 +1,29 @@
+require 'set'
+
+module ScrabbleScore
+  class Dictionary
+    attr_reader :words
+
+    def initialize(words = nil)
+      @words = words.to_set and return unless words.nil?
+
+      load_words_from_dictionary
+    end
+
+    def contains(word)
+      @words.include?(word.downcase)
+    end
+
+    private
+
+    def load_words_from_dictionary
+      @words = Set.new
+      path = File.join(ScrabbleScore::ROOT, 'assets', 'dictionary.txt')
+      file = File.open(path, 'r')
+      file.each_line do |line|
+        @words.add(line.chomp)
+      end
+      file.close
+    end
+  end
+end

data/lib/scrabble_score/letters.rb

@@ -0,0 +1,39 @@
+module ScrabbleScore
+  class Letters
+    TILE_VALUES = {
+      'a' => 1, 'b' => 3, 'c' => 3, 'd' => 2, 'e' => 1, 'f' => 4,
+      'g' => 2, 'h' => 4, 'i' => 1, 'j' => 8, 'k' => 5, 'l' => 1,
+      'm' => 3, 'n' => 1, 'o' => 1, 'p' => 3, 'q' => 10, 'r' => 1,
+      's' => 1, 't' => 1, 'u' => 1, 'v' => 4, 'w' => 4, 'x' => 8,
+      'y' => 4, 'z' => 10
+    }
+
+    attr_reader :word
+
+    def initialize(word)
+      @word = Letters.cleanse(word)
+    end
+
+    def permutations
+      permutation_array = []
+      letter_array = @word.split(//)
+
+      (2..letter_array.size).each do |length|
+        letter_array.permutation(length).each do |perm|
+          permutation_array << perm.join
+        end
+      end
+      permutation_array.uniq
+    end
+
+    def score
+      score = 0
+      @word.downcase.each_char { |ch| score += TILE_VALUES[ch] }
+      score
+    end
+
+    def self.cleanse(word)
+      word.downcase.gsub(/[^a-z]/, '')
+    end
+  end
+end

data/lib/scrabble_score/version.rb

@@ -0,0 +1,3 @@
+module ScrabbleScore
+  VERSION = "0.1.0"
+end

data/lib/scrabble_score/word_finder.rb

@@ -0,0 +1,23 @@
+module ScrabbleScore
+  class WordFinder
+    def initialize(dictionary = ScrabbleScore::Dictionary.new)
+      @dictionary = dictionary
+    end
+
+    def search(letters)
+      permutations = ScrabbleScore::Letters.new(letters).permutations
+      permutations.select! { |perm| @dictionary.contains(perm) }
+    end
+
+    def search_with_score(letters)
+      found_words = search(letters)
+
+      hash = {}
+      found_words.each do |word|
+        hash[word] = ScrabbleScore::Letters.new(word).score
+      end
+
+      hash
+    end
+  end
+end

data/lib/scrabble_score.rb

@@ -0,0 +1,8 @@
+require 'scrabble_score/version'
+require 'scrabble_score/letters'
+require 'scrabble_score/dictionary'
+require 'scrabble_score/word_finder'
+
+module ScrabbleScore
+  ROOT = File.dirname(__dir__)
+end

data/scrabble_score.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'scrabble_score/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'scrabble_score'
+  spec.version       = ScrabbleScore::VERSION
+  spec.authors       = ['Nick Aschenbach']
+  spec.email         = ['nick.aschenbach@gmail.com']
+  spec.summary       = %q{A scrabble cheater scoring library}
+  spec.description   = %q{An engine that finds words from a set of letters and calculates the scrabble score}
+  spec.homepage      = 'https://github.com/nick-aschenbach/scrabble-score'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rspec', '3.0.0'
+  spec.add_development_dependency 'simplecov', '0.9.1'
+end

data/spec/assets/dictionary.txt

@@ -0,0 +1,8 @@
+aardvark
+beetle
+cringe
+dirge
+effort
+dirth
+fade
+ghast

data/spec/lib/scrabble_score/dictionary_spec.rb

@@ -0,0 +1,130 @@
+require 'spec_helper'
+
+describe ScrabbleScore::Dictionary do
+  describe '#initialize' do
+    context 'when not specifying the dictionary' do
+      it 'loads the default dictionary' do
+        stub_const('ScrabbleScore::ROOT', File.join(File.dirname(__FILE__), '..', '..'))
+
+        dictionary = ScrabbleScore::Dictionary.new
+
+        expected_words = %w[aardvark beetle cringe dirge effort dirth fade ghast]
+        expect(dictionary.words).to match_array(expected_words)
+      end
+    end
+
+    context 'when specifying the dictionary' do
+      it 'uses the specified dictionary' do
+        seed_words = %w[apple pear banana]
+        dictionary = ScrabbleScore::Dictionary.new(seed_words)
+
+        expect(dictionary.words).to match_array(seed_words)
+      end
+    end
+  end
+
+  describe '#contains' do
+    let(:seed_words) { %w[gas coal uranium wind solar] }
+    let(:dictionary) { ScrabbleScore::Dictionary.new(seed_words) }
+
+    it 'finds words in the dictionary' do
+      seed_words.each do |word|
+        expect(dictionary.contains(word)).to be_truthy
+      end
+    end
+
+    it 'does not find words not in the dictionary' do
+      expect(dictionary.contains('foobar')).to be_falsey
+    end
+
+    it 'has the important two letter words' do
+      words = %w[
+        aa ab ad ae ag ah ai al am an ar as at aw ax ay ba be bi bo
+        by de do ed ef eh el em en er es et ex fa fe go ha he hi hm
+        ho id if in is it jo ka ki la li lo ma me mi mm mo mu my na
+        ne no nu od oe of oh oi om on op or os ow ox oy pa pe pi qi
+        re sh si so ta ti to uh um un up us ut we wo xi xu ya ye yo
+        za
+      ]
+      dictionary = ScrabbleScore::Dictionary.new
+
+      words.each { |word| expect(dictionary.contains(word)).to be_truthy }
+    end
+
+    it 'has the important three letter words' do
+      words = %w[
+        aah aal aas aba abo abs aby ace act add ado ads adz aff aft
+        aga age ago ags aha ahi ahs aid ail aim ain air ais ait ala
+        alb ale all alp als alt ama ami amp amu ana and ane ani ant
+        any ape apo app apt arb arc are arf ark arm ars art ash ask
+        asp ass ate att auk ava ave avo awa awe awl awn axe aye ays
+        azo baa bad bag bah bal bam ban bap bar bas bat bay bed bee
+        beg bel ben bes bet bey bib bid big bin bio bis bit biz boa
+        bob bod bog boo bop bos bot bow box boy bra bro brr bub bud
+        bug bum bun bur bus but buy bye bys cab cad cam can cap car
+        cat caw cay cee cel cep chi cig cis cob cod cog col con coo
+        cop cor cos cot cow cox coy coz cru cry cub cud cue cum cup
+        cur cut cwm dab dad dag dah dak dal dam dan dap daw day deb
+        dee def del den dev dew dex dey dib did die dif dig dim din
+        dip dis dit doc doe dog dol dom don dor dos dot dow dry dub
+        dud due dug duh dui dun duo dup dye ear eat eau ebb ecu edh
+        eds eek eel eff efs eft egg ego eke eld elf elk ell elm els
+        eme ems emu end eng ens eon era ere erg ern err ers ess eta
+        eth eve ewe eye fab fad fag fan far fas fat fax fay fed fee
+        feh fem fen fer fes fet feu few fey fez fib fid fie fig fil
+        fin fir fit fix fiz flu fly fob foe fog foh fon fop for fou
+        fox foy fro fry fub fud fug fun fur gab gad gae gag gal gam
+        gan gap gar gas gat gay ged gee gel gem gen get gey ghi gib
+        gid gie gig gin gip git gnu goa gob god goo gor gos got gox
+        goy gul gum gun gut guv guy gym gyp had hae hag hah haj ham
+        hao hap has hat haw hay heh hem hen hep her hes het hew hex
+        hey hic hid hie him hin hip his hit hmm hob hod hoe hog hon
+        hop hos hot how hoy hub hue hug huh hum hun hup hut hyp ice
+        ich ick icy ids iff ifs igg ilk ill imp ink inn ins ion ire
+        irk ism its ivy jab jag jam jar jaw jay jee jet jeu jew jib
+        jig jin job joe jog jot jow joy jug jun jus jut kab kae kaf
+        kas kat kay kea kef keg ken kep kex key khi kid kif kin kip
+        kir kis kit koa kob koi kop kor kos kue kye lab lac lad lag
+        lam lap lar las lat lav law lax lay lea led lee leg lei lek
+        les let leu lev lex ley lez lib lid lie lin lip lis lit lob
+        log loo lop lot low lox lug lum luv lux lye mac mad mae mag
+        man map mar mas mat maw max may med meg mel mem men met mew
+        mho mib mic mid mig mil mim mir mis mix moa mob moc mod mog
+        mol mom mon moo mop mor mos mot mow mud mug mum mun mus mut
+        myc nab nae nag nah nam nan nap naw nay neb nee neg net new
+        nib nil nim nip nit nix nob nod nog noh nom noo nor nos not
+        now nth nub nun nus nut oaf oak oar oat oba obe obi oca oda
+        odd ode ods oes off oft ohm oho ohs oil oka oke old ole oms
+        one ono ons ooh oot ope ops opt ora orb orc ore ors ort ose
+        oud our out ova owe owl own oxo oxy pac pad pah pal pam pan
+        pap par pas pat paw pax pay pea pec ped pee peg peh pen pep
+        per pes pet pew phi pht pia pic pie pig pin pip pis pit piu
+        pix ply pod poh poi pol pom poo pop pot pow pox pro pry psi
+        pst pub pud pug pul pun pup pur pus put pya pye pyx qat qis
+        qua rad rag rah rai raj ram ran rap ras rat raw rax ray reb
+        rec red ree ref reg rei rem rep res ret rev rex rho ria rib
+        rid rif rig rim rin rip rob roc rod roe rom rot row rub rue
+        rug rum run rut rya rye sab sac sad sae sag sal sap sat sau
+        saw sax say sea sec see seg sei sel sen ser set sew sex sha
+        she shh shy sib sic sim sin sip sir sis sit six ska ski sky
+        sly sob sod sol som son sop sos sot sou sow sox soy spa spy
+        sri sty sub sue suk sum sun sup suq syn tab tad tae tag taj
+        tam tan tao tap tar tas tat tau tav taw tax tea ted tee teg
+        tel ten tet tew the tho thy tic tie til tin tip tis tit tod
+        toe tog tom ton too top tor tot tow toy try tsk tub tug tui
+        tun tup tut tux twa two tye udo ugh uke ulu umm ump uns upo
+        ups urb urd urn urp use uta ute uts vac van var vas vat vau
+        vav vaw vee veg vet vex via vid vie vig vim vis voe vow vox
+        vug vum wab wad wae wag wan wap war was wat waw wax way web
+        wed wee wen wet wha who why wig win wis wit wiz woe wog wok
+        won woo wop wos wot wow wry wud wye wyn xis yag yah yak yam
+        yap yar yaw yay yea yeh yen yep yes yet yew yid yin yip yob
+        yod yok yom yon you yow yuk yum yup zag zap zas zax zed zee
+        zek zep zig zin zip zit zoa zoo zuz zzz
+      ]
+      dictionary = ScrabbleScore::Dictionary.new
+
+      words.each { |word| expect(dictionary.contains(word)).to be_truthy }
+    end
+  end
+end

data/spec/lib/scrabble_score/letters_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe ScrabbleScore::Letters do
+  describe '.TILE_VALUES' do
+    def check_tile_values(array, expected_value)
+      array.each { |letter| expect(ScrabbleScore::Letters::TILE_VALUES[letter]).to be(expected_value) }
+    end
+
+    it 'has expected values' do
+      check_tile_values(%w[a e i l n o r s t u], 1)
+      check_tile_values(%w[d g], 2)
+      check_tile_values(%w[b c m p], 3)
+      check_tile_values(%w[f h v w y], 4)
+      check_tile_values(%w[k], 5)
+      check_tile_values(%w[j x], 8)
+      check_tile_values(%w[q z], 10)
+    end
+  end
+
+  describe '#word' do
+    it 'returns the initialized word' do
+      word = ScrabbleScore::Letters.new('apple')
+      expect(word.word).to eq('apple')
+    end
+  end
+
+  describe '#score' do
+    it 'calculates the scrabble value for a word' do
+      expect(ScrabbleScore::Letters.new('test').score).to be(4)
+      expect(ScrabbleScore::Letters.new('quiz').score).to be(22)
+      expect(ScrabbleScore::Letters.new('jester').score).to be(13)
+    end
+  end
+
+  describe '#permutations' do
+    it 'calculates all possible permutations of the letters' do
+      letters = ScrabbleScore::Letters.new('abc')
+      expect(letters.permutations).to match_array(['ab', 'ba', 'ac', 'ca', 'bc', 'cb', 'abc', 'acb', 'bac', 'bca', 'cab', 'cba'])
+    end
+
+    it 'generates only unique permutations' do
+      letters = ScrabbleScore::Letters.new('foo')
+      expect(letters.permutations).to match_array(['fo', 'of', 'oo', 'foo', 'ofo', 'oof'])
+    end
+  end
+
+  describe '.cleanse' do
+    it 'only saves lower case characters' do
+      expect(ScrabbleScore::Letters.cleanse('AbIGwOrD')).to eq('abigword')
+    end
+
+    it 'only saves a-z characters' do
+      expect(ScrabbleScore::Letters.cleanse('a!@#$%^&*()_+z')).to eq('az')
+    end
+  end
+end

data/spec/lib/scrabble_score/word_finder_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe ScrabbleScore::WordFinder do
+  describe '#search' do
+    let(:empty_dictionary) { ScrabbleScore::Dictionary.new([]) }
+    it 'permutates the input' do
+      expect_any_instance_of(ScrabbleScore::Letters).to receive(:permutations).and_call_original
+
+      ScrabbleScore::WordFinder.new(empty_dictionary).search('foo')
+    end
+
+    it 'searches its dictionary for permutations' do
+      expect_any_instance_of(ScrabbleScore::Letters).to receive(:permutations).and_return(['bar'])
+      expect_any_instance_of(ScrabbleScore::Dictionary).to receive(:contains).with('bar')
+
+      ScrabbleScore::WordFinder.new(empty_dictionary).search('anything')
+    end
+
+    it 'returns permutations that are words in the dictionary' do
+      dictionary = %w[stop pot top sop to]
+      word_finder = ScrabbleScore::WordFinder.new(ScrabbleScore::Dictionary.new(dictionary))
+
+      expect(word_finder.search('opt')).to match_array(%w[pot top to])
+    end
+  end
+
+  describe '#search_with_score' do
+    it 'returns a hash of (word, score) pairs' do
+      dictionary = %w[flavor or fav rat trap]
+      word_finder = ScrabbleScore::WordFinder.new(ScrabbleScore::Dictionary.new(dictionary))
+
+      expected_hash = {'flavor' => 12, 'or' => 2, 'fav' => 9}
+      expect(word_finder.search_with_score('lovrfa')).to eq(expected_hash)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'simplecov'
+SimpleCov.start if ENV["COVERAGE"]
+
+require 'scrabble_score'
+

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: scrabble_score
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nick Aschenbach
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+description: An engine that finds words from a set of letters and calculates the scrabble
+  score
+email:
+- nick.aschenbach@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- assets/dictionary.txt
+- lib/scrabble_score.rb
+- lib/scrabble_score/dictionary.rb
+- lib/scrabble_score/letters.rb
+- lib/scrabble_score/version.rb
+- lib/scrabble_score/word_finder.rb
+- scrabble_score.gemspec
+- spec/assets/dictionary.txt
+- spec/lib/scrabble_score/dictionary_spec.rb
+- spec/lib/scrabble_score/letters_spec.rb
+- spec/lib/scrabble_score/word_finder_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/nick-aschenbach/scrabble-score
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.1
+signing_key: 
+specification_version: 4
+summary: A scrabble cheater scoring library
+test_files:
+- spec/assets/dictionary.txt
+- spec/lib/scrabble_score/dictionary_spec.rb
+- spec/lib/scrabble_score/letters_spec.rb
+- spec/lib/scrabble_score/word_finder_spec.rb
+- spec/spec_helper.rb
+has_rdoc: