danno_scrabble 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a977d1c3be79bfd76a20c3c1eb67cd26cffb6298
-  data.tar.gz: 3cc2674fa6281b70fa241ea92c8d388bc6d98af6
+  metadata.gz: aad2e25a1fd3c5295fa464c471d8ac753fe3a7a0
+  data.tar.gz: 0e2075abfe6b35de78abf23a7bd3b1ac4b999837
 SHA512:
-  metadata.gz: 21a67dec5227d9e187495a9dda9bb8da8987a73c87b3feb8d2a42b2e0a9c5c025cd3b1c7f9e56a8360db4ba12fb906caadc4f74bf342ebe0ac56f689865a97c1
-  data.tar.gz: 60708fa90a391a410b38717a44fafe2d0bdb71903a786f60159dab108438c0e0bf7f7d2c39a9864e5a47fd7506f87280a2ffdf15c9c863288b048b32110370c6
+  metadata.gz: 56cc7404a427024aec7c30669a2acdaa8964e54728fa753255c45dc62f5400b8afc5b96229f9daea670763fc661ed1d08ad0d89c423d8a7e3d44b67bf32ec510
+  data.tar.gz: 39ea0f3ba1bf4188928b61a5d5d4f467215b6f653c58f24474ff8a6f319bbdf9e34d9da628ca995631faabfb4564c51f7f4d32fc854cca218f0b8982f7d995b3

data/README.md

@@ -0,0 +1,27 @@
+ ____       ___  
+|  _ \    /  _  \
+| | | |  |  | |  |
+| |_| |  |  |_|  |
+|____/[]  \ ___ /[]
+
+Scrabble has long been used to play on words. For example, you have a set of letters, these letters then make various
+combinations of words. In the rules of scrabble those various combinations of words are compared against a valid scrabble
+dictionary to see if it is a valid answer. This provides a list of all possible valid answers based on the set of letters.
+
+# Requirements
+
+* Ruby -v 2.2.0+ # Use Rvm where possible `rvm install "version_number"`
+* Install the clock `gem install danno_scrabble` or clone it from this repo.
+
+# INFO
+
+Sample Input
+"asd"
+
+Output for the Sample Input
+["ad", "ads", "as", "da", "sad"]
+
+# Using the Gem!
+
+* `ruby -Ilib ./bin/scrabble {'scrabble'}` or `ruby -Ilib ./bin/scrabble {'asdfjkl'}` # if cloned
+* `ruby -Ilib ~/.rvm/gems/ruby-2.2.3/gems/danno_scrabble_0.0.3/bin/scrabble {'scrabble'}` # if installed via `gem install`

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/bin/scrabble

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
-
-require 'scrabble'
-puts Scrabble.run_scrabble(ARGV[0])
+#!/usr/bin/env ruby
+
+require 'scrabble'
+puts Scrabble.run_scrabble(ARGV[0])

data/lib/scrabble.rb

@@ -1,18 +1,19 @@
-# encoding: utf-8
-###
-# @author Dan Oberg <dan@cs1.com>
-# @licence MIT
-# @class Scrabble
-# Useage: `ruby -Ilib ./bin/scrabble {'asdfjkl'}` or `ruby -Ilib ./bin/scrabble {'peodfor'}`
-###
-class Scrabble
-  ###
-  # @param [String] run a list of letters against a text dictionary file for valid scrabble answers.
-  # @return [Array] return possible valid results.
-  ###
-  def self.run_scrabble(letters)
-    dictionary = File.readlines('word_list.txt').map(&:chomp)
-    possible = (2..letters.length).map{|n| letters.chars.to_a.permutation(n).to_a.map(&:join)}.flatten
-    dictionary & possible
-  end
-end
+# encoding: utf-8
+###
+# @author Dan Oberg <dan@cs1.com>
+# @licence MIT
+# @class Scrabble
+# Useage: `ruby -Ilib ./bin/scrabble {'asdfjkl'}` or `ruby -Ilib ./bin/scrabble {'peodfor'}`
+###
+class Scrabble
+  ###
+  # @param [String] run a list of letters against a text dictionary file for valid scrabble answers.
+  # @return [Array] returns possible valid results.
+  ###
+  def self.run_scrabble(letters)
+    dictionary_path = File.join( File.dirname(__FILE__), 'word_list.txt' )
+    dictionary = File.readlines(dictionary_path).map(&:chomp)
+    possible = (2..letters.length).map{|n| letters.chars.to_a.permutation(n).to_a.map(&:join)}.flatten
+    dictionary & possible
+  end
+end