game_words 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae89c051ee35ded628c9f624865b1247f9dac743
-  data.tar.gz: 45e1a6f171011d0354904acaddda0aacecfed9f9
+  metadata.gz: e2794ee9416078be8100bb1bd39384d2d1fb96fe
+  data.tar.gz: 8894b0b3d386ef138f56f56c05cff8a101207bbd
 SHA512:
-  metadata.gz: 78d8ed1da913518e46984ff40e2b0442f27a6c169f77c5d0a79e4cbeac457246647aa705ad42ad8c98829556bf25652e1a752be8ce5c81fa7f6d3798d8c34851
-  data.tar.gz: bf62576df25df7e876f4e8ecbaa1e61543e5f9c5c267f3e64ab7b541836d4050e80d5bb8279b290546183ced85e76b4f67ffcfcbbfa832c46d22b516f45d6580
+  metadata.gz: 9c4171b73ff26ba065fe84dfecea1321dbab37d3ddb48e0dd12e79e0a989dab9bf21e8a350b72523815e61d3009374cbf00d9ac7516c48281343a4ad9c23775c
+  data.tar.gz: 54ecfa601ea816ecdfb37ac62867d8609957556aed6b4ade2e9aabdeec177439a58f412e26dd70875a578b2bef63c68820c83e65c1b4951758ecf0448d186ff7

data/README.md

@@ -1,9 +1,11 @@
-# Gamewords
+# Game Words
 
 Find words, phrases, songs, movies, characters, actions and sayings for
 Pictionary, Catchphrase, Charades or the holidays. Each game has several
-categories including difficulty levels. This library returns a list for
-some or all categories.
+categories and difficulty levels. This library returns a word list for
+some or all categories (nearly 5,000 in all).
+
+A command line interface is provided in addition to the Ruby library
 
 ## Installation
 
@@ -15,39 +17,75 @@ gem 'game_words'
 
 And then execute:
 
-> bundle
+```bash
+$ bundle
+```
 
 Or install it yourself as:
 
-> gem install game_words
+```bash
+$ gem install game_words
+```
 
-## Usage
+## Command Line Usage
 
-Find a list of games:
+Show all words for a game:
 
-```ruby
-GameWords::Generator.new.games
+```bash
+$ gamewords charades
 ```
 
-Find the categories for a game:
-```ruby
-gen = GameWords::Generator.new
-gen.game_categories 'pictionary'
+Show all words for a specific game category:
+
+```bash
+$ gamewords catchphrase people
+```
+
+Show a list of games:
+
+```bash
+$ gamewords -l
+```
+
+Show a list of categories for a game:
+
+```bash
+$ gamewords -c pictionary
 ```
 
-Get all words for all categories for a game:
+Show a single random word or phrase:
+
+```bash
+$ gamewords -r holidays newyears
+```
+
+## Library Usage
+
+Show all words for a game:
 
 ```ruby
+gen = GameWords::Generator.new
 gen.words 'catchphrase'
 ```
 
-Get the words for a game and category:
+Show the words for a specific game category:
 
 ```ruby
 gen.words 'charades', 'hard'
 ```
 
-Easily generate a random word:
+Show a list of games:
+
+```ruby
+gen.games
+```
+
+Show the categories for a game:
+```ruby
+gen.game_categories 'pictionary'
+```
+
+Easily show a random word:
 
 ```ruby
 gen.words('pictionary', 'easy').sample

data/bin/gamewords

@@ -0,0 +1,65 @@
+#!/usr/bin/env ruby
+
+require 'game_words'
+require 'optparse'
+
+ARGV << '-h' if ARGV.empty?
+
+options = {}
+optparse = OptionParser.new do|opts|
+  opts.banner = 'Usage: gamewords [options] game [category]'
+
+  options[:list_games] = false
+  opts.on( '-l', '--list', 'List games' ) do
+    options[:list_games] = true
+  end
+
+  options[:game_category] = nil
+  opts.on( '-c', '--categories GAME', 'List categories for a GAME' ) do |game|
+    options[:game_category] = game
+  end
+
+  options[:random] = false
+  opts.on('-r', '--random', 'Show one random word or phrase for a GAME [CATEGORY]') do
+    options[:random] = true
+  end
+
+  opts.on('-v', '--version', 'Show the version') do
+    puts "v#{GameWords::VERSION}"
+    exit
+  end
+
+  opts.on_tail('-h', '--help', 'Display help screen') do
+    puts opts
+    exit
+  end
+end
+
+begin
+  optparse.parse!
+rescue OptionParser::ParseError
+  puts 'Error parsing arguments. Please run with the -h option'
+end
+
+generator = GameWords::Generator.new
+
+if options[:list_games]
+  puts generator.games
+  exit
+end
+
+if options[:game_category]
+  puts generator.game_categories(options[:game_category])
+  exit
+end
+
+game = ARGV[0]
+categories = ARGV[1]
+words = generator.words(game, categories)
+
+if options[:random]
+  puts words.sample
+  exit
+end
+
+puts words

data/lib/game_words/version.rb

@@ -1,3 +1,3 @@
 module GameWords
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: game_words
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Nick Aschenbach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-23 00:00:00.000000000 Z
+date: 2014-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -59,7 +59,8 @@ description: |-
   some or all categories.
 email:
 - nick.aschenbach@gmail.com
-executables: []
+executables:
+- gamewords
 extensions: []
 extra_rdoc_files: []
 files:
@@ -71,6 +72,7 @@ files:
 - README.md
 - Rakefile
 - assets/game_words/game_words.yaml
+- bin/gamewords
 - game_words.gemspec
 - lib/game_words.rb
 - lib/game_words/version.rb