game_words 0.1.0

data/game_words.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'game_words/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'game_words'
+  spec.version       = GameWords::VERSION
+  spec.authors       = ['Nick Aschenbach']
+  spec.email         = ['nick.aschenbach@gmail.com']
+  spec.summary       = %q{Find words for pictionary, catchphrase, charades and holidays}
+  spec.homepage      = 'https://github.com/nick-aschenbach/game-words'
+  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.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '>= 3.0'
+end

data/lib/game_words/version.rb

@@ -0,0 +1,3 @@
+module GameWords
+  VERSION = '0.1.0'
+end

data/lib/game_words.rb

@@ -0,0 +1,51 @@
+require 'game_words/version'
+require 'yaml'
+
+module GameWords
+  WORDS_PATH = File.join(File.dirname(__dir__), 'assets', 'game_words', 'game_words.yaml')
+
+  class Generator
+    def initialize
+      @game_words = YAML.load_file(WORDS_PATH)
+    end
+
+    def games
+      @game_words.keys
+    end
+
+    def game_categories(game)
+      return [] unless is_a_valid_game?(game)
+
+      game_words = @game_words[game]
+      game_words.keys
+    end
+
+    def words(game, category = nil)
+      return [] unless is_a_valid_game?(game)
+      return [] unless category.nil? || is_a_valid_game_category?(game, category)
+
+      words = @game_words[game][category]
+      return words if words
+
+      all_words = []
+      @game_words[game].keys.each do |category|
+        all_words += @game_words[game][category]
+      end
+      all_words
+    end
+
+    private
+
+    def is_a_valid_game?(game)
+      return true if @game_words[game]
+
+      false
+    end
+
+    def is_a_valid_game_category?(game, category)
+      return true if @game_words[game][category]
+
+      false
+    end
+  end
+end

data/spec/lib/generator_spec.rb

@@ -0,0 +1,167 @@
+require 'spec_helper'
+
+describe GameWords::Generator do
+  describe 'WORDS_PATH' do
+    it 'defines a root path for the game words' do
+      expect { GameWords::WORDS_PATH }.not_to raise_error
+    end
+  end
+
+  describe '.new' do
+    subject { GameWords::Generator.new }
+
+    it 'loads the words YAML file' do
+      expect(YAML).to receive(:load_file).with(GameWords::WORDS_PATH)
+
+      subject
+    end
+  end
+
+  describe '#games' do
+    subject { GameWords::Generator.new.games }
+
+    it 'lists the available games' do
+      expect(subject).to match_array(['catchphrase',
+                                      'holidays',
+                                      'pictionary',
+                                      'charades'])
+    end
+  end
+
+  describe '#game_categories' do
+    subject { GameWords::Generator.new.game_categories(game) }
+
+    context 'catchphrase' do
+      let(:game) { 'catchphrase' }
+
+      it 'lists catchphrase categories' do
+        expect(subject).to match_array(['easy',
+                                        'medium',
+                                        'hard',
+                                        'animals',
+                                        'food',
+                                        'travel',
+                                        'people',
+                                        'household'])
+      end
+    end
+    context 'holidays' do
+      let(:game) { 'holidays' }
+
+      it 'lists the holiday categories' do
+        expect(subject).to match_array(['halloween',
+                                        'christmas',
+                                        'independence',
+                                        'thanksgiving',
+                                        'christmassong',
+                                        'valentinesaying',
+                                        'valentinesong',
+                                        'valentineword',
+                                        'newyears',
+                                        'spring'])
+      end
+    end
+    context 'pictionary' do
+      let(:game) { 'pictionary' }
+
+      it 'lists the pictionary categories' do
+        expect(subject).to match_array(['easy',
+                                        'medium',
+                                        'difficult',
+                                        'hard',
+                                        'idioms',
+                                        'characters',
+                                        'movies'])
+      end
+    end
+    context 'charades' do
+      let(:game) { 'charades' }
+
+      it 'lists the charades categories' do
+        expect(subject).to match_array(['easy',
+                                        'medium',
+                                        'difficult',
+                                        'hard',
+                                        'actions'])
+      end
+    end
+    context 'undefined game category' do
+      let(:game) { 'foosball' }
+
+      it 'returns an empty array' do
+        expect(subject).to match_array([])
+      end
+    end
+  end
+
+  describe '#words' do
+    subject { GameWords::Generator.new.words(game, category) }
+
+    let(:words) {
+      {
+        'game1' => {
+          'cat1' => %w[word1 word2],
+          'cat2' => %w[word3]
+        },
+        'game2' => {
+          'cat3' => %w[word4]
+        }
+      }
+    }
+
+    before do
+      allow(YAML).to receive(:load_file).and_return(words)
+    end
+
+    context 'when the category is specified' do
+      let(:game) { 'game2' }
+
+      context 'when the category exists' do
+        let(:category) { 'cat3' }
+
+        it 'only shows the words for that category' do
+          expect(subject).to match_array(%w[word4])
+        end
+      end
+
+      context 'when the category does not exist' do
+        let(:category) { 'blah' }
+
+        it 'returns an empty array' do
+          expect(subject).to eq([])
+        end
+      end
+    end
+
+    context 'when the category is not specified' do
+      let(:game) { 'game1' }
+      let(:category) { nil }
+
+      it 'shows all of the words for all categories for that game' do
+        expect(subject).to match_array(%w[word1 word2 word3])
+      end
+    end
+
+    context 'unhappy paths' do
+      context 'when the game does not exist' do
+        let(:game) { 'foo' }
+        let(:category) { 'cat1' }
+
+        it 'returns an empty array' do
+          expect(subject).to eq([])
+        end
+      end
+
+      context 'when the game exists' do
+        let(:game) { 'game1' }
+
+        context 'but the category does not exist' do
+          let(:category) { 'bar' }
+          it 'returns an empty array' do
+            expect(subject).to eq([])
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'game_words'

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: game_words
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nick Aschenbach
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- nick.aschenbach@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- assets/game_words/game_words.yaml
+- game_words.gemspec
+- lib/game_words.rb
+- lib/game_words/version.rb
+- spec/lib/generator_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/nick-aschenbach/game-words
+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.2
+signing_key: 
+specification_version: 4
+summary: Find words for pictionary, catchphrase, charades and holidays
+test_files:
+- spec/lib/generator_spec.rb
+- spec/spec_helper.rb