fandom-word 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc6e3b9fe1ca4b079c06735e8adfb36ddcda87a0
-  data.tar.gz: e39c700480ceb74bef8b65e61ee8897cdfcb4c50
+  metadata.gz: 8292d6e758a0580f52ed94dfa3ddca294ee6f5ed
+  data.tar.gz: f8458d92461eceb480f4b9cef2ab74845ad169f7
 SHA512:
-  metadata.gz: 861407502f7998539124ff0ab5c98558d55a0e187b28622afd270e0a841189a7a49ba49f0c6217f5c062699cbf5e691919b79315669f68930c39168aedd7ee43
-  data.tar.gz: 3c05280ae6b874129b6fe2cb28f38f46b635acffb86fc1d26edfa9c21eefc12b887e6ded35f992ad4645b828f08f768b558f0ff31e73c0474f769056372a8a1f
+  metadata.gz: 3612efa6c64bde71631e39858a7d1bd05c2853309afb9f0a7ccd1eb52b80d1b69e7760a23d8743c041ffa206daf27f04428f568369684fe6268afb4771f3d98b
+  data.tar.gz: edd8859f6b9e4fd2c5218eb13b1ec726896cfb6d01c4f6466fbeb6541dc73e3e0edf800a8313abc9724cdd8c9b0a7d031002e3d1de8e3592f598821797ce54de

data/.gitattributes

@@ -0,0 +1,5 @@
+# Auto detect text files and perform LF normalization
+* text=lf
+
+# Known text files
+*.sh text eol=lf

data/.gitignore

@@ -3,4 +3,6 @@
 
 *.gem
 
-Gemfile.lock
+Gemfile.lock
+
+coverage/

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require ./spec/spec_helper.rb
+--format d

data/.rubocop.yml

@@ -1,3 +1,18 @@
 AllCops:
   Exclude:
-    - lib/fandom-word.rb
+    - lib/fandom-word.rb
+
+Layout/EndOfLine:
+  Exclude:
+    - fandom-word.gemspec
+    - Gemfile
+    - Rakefile
+    - lib/**/*
+    - spec/**/*
+
+Metrics/BlockLength:
+    Exclude:
+      - spec/**/*
+
+Metrics/LineLength:
+  Max: 120

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+sudo: false
+rvm:
+  - 2.1.0
+  - 2.1.2
+  - 2.2.2
+  - ruby-head

data/.yardoc/checksums

@@ -0,0 +1,5 @@
+lib/fandoms.rb 04e6759e58e6b973fe0d3fa0382197356e2f5c93
+lib/version.rb e943b10f8f7edb26682016a692305e251f5481b9
+lib/fandom-word.rb 9e292912f4cce8af8b2ad6b655df6e73931a6cc8
+lib/fandom_word.rb 0d0359cf3ced737a2d9a69b204c348ba5f7cb5d7
+lib/fandom_word_catalog.rb 6a0254bf451a21cf7f94a12caa70133673515856

data/Gemfile

@@ -2,5 +2,21 @@ source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
-gem 'rake'
-gem 'rubocop'
+group :build do
+  gem 'rake', '12.3.0'
+  gem 'yard', '0.9.9'
+end
+
+group :development do
+  gem 'pry', '0.10.4'
+  gem 'pry-nav', '0.2.4'
+  gem 'pry-stack_explorer', '0.4.9.2'
+  gem 'rubocop', '0.51.0'
+end
+
+group :test do
+  gem 'benchmark-ips', '2.7.2'
+  gem 'rspec', '3.7.0'
+  gem 'rspec-benchmark', '0.3.0'
+  gem 'simplecov', '0.15.1'
+end

data/README.md

@@ -1,5 +1,7 @@
 fandom-word
 ====
+[![Gem Version](https://badge.fury.io/rb/fandom-word.svg)](https://badge.fury.io/rb/fandom-word)
+[![Build Status](https://travis-ci.org/RaviN/fandom-word.svg?branch=master)](https://travis-ci.org/RaviN/fandom-word)
 
 A fandom word generator that returns random words from various fandoms.
 
@@ -10,11 +12,13 @@ fandom-word allows you to get a randomized word pertaining to any fandom.
 You can also use it to get a randomized word for a specific fandom.
 
 ```ruby
-FandomWord.get_word # returns a word from any fandom category
-FandomWord.get_word_by_fandom(fandom_name) # returns a word from a specific fandom
+FandomWord.random_word # returns a word from any fandom category
+FandomWord.random_word(fandom_name) # returns a word from a specific fandom
+FandomWord.random_word([fandom_name_1, fandom_name_2]) # returns a word from one of the fandoms
+FandomWord.fandoms # list fandoms
 ```
 
-To get a list of available fandoms use `Fandomword.available_fandoms`
+Available fandoms are defined as constants in `FandomWord::Fandoms`
 
 Adding Fandoms
 ----
@@ -24,14 +28,14 @@ Adding Fandoms
   * When adding your word list use the following format
   ```yaml
   :categories:
-    - list
-    - of
-    - applicable
-    - categories
+  - list
+  - of
+  - applicable
+  - categories
   :words:
-    - list
-    - of
-    - words
+  - list
+  - of
+  - words
   ```
-* Make sure all tests are still passing ( we will have tests, promise )
+* Make sure all tests are still passing and there is 100% code coverage
 * Submit pull request

data/Rakefile

@@ -1,17 +1,18 @@
 require 'ostruct'
-require_relative 'lib/fandom_word'
+
+# Require relative all library files. No require relatives should be necessary below the next couple lines
+source_files_to_require = Dir['lib/**/*.rb']
+source_files_to_require.each { |file_path| require_relative file_path }
 
 task :default do
-  puts "RANDOM MECHA WORD: #{FandomWord.random_word_from_fandom 'mecha'}"
-  puts "RANDOM ANIME WORD: #{FandomWord.random_word_from_fandom 'anime'}"
-  puts "RANDOM CATEGORY WORD: #{FandomWord.random_word}"
+  Rake::Task['pre_flight'].invoke
+  Rake::Task['demo'].invoke
 end
 
+desc 'Collects all word lists and compiles into words.data'
 task :build_data do
   require 'erb'
-
   require 'yaml'
-  require_relative 'lib/fandom_word_catalog'
 
   DATA_FILE = 'data/words.data'.freeze
   WORD_LIST_GLOB = 'word-lists/**/*.yml'.freeze
@@ -21,7 +22,7 @@ task :build_data do
   catalog = FandomWord::FandomWordCatalog.new
 
   Dir.glob(WORD_LIST_GLOB) do |file_path|
-    puts "Processing: #{file_path}"
+    puts "Adding to words.data: #{file_path}"
     word_list = YAML.load_file(file_path)
     word_list[:words].each do |word|
       catalog.add_word(word, word_list[:categories])
@@ -42,3 +43,56 @@ task :build_data do
   erb = Dummy.new(fandoms: catalog.fandoms)
   File.write('lib/fandoms.rb', erb.render(File.read('build/fandoms.rb.erb')))
 end
+
+desc 'Perform a couple demonstrations of FandomWord'
+task :demo do
+  puts "RANDOM MECHA WORD: #{FandomWord.random_word 'mecha'}"
+  puts "RANDOM ANIME WORD: #{FandomWord.random_word 'anime'}"
+  puts "RANDOM ANIME OR MECHA WORD: #{FandomWord.random_word %w[anime mecha]}"
+  puts "RANDOM WORD: #{FandomWord.random_word}"
+end
+
+desc 'Performs common checks / house keeping as a prerequisite before submitting a pull request'
+task :pre_flight do
+  def system_helper(command)
+    raise "One of the pre flight steps failed! #{command}" unless system command
+  end
+
+  # Validate style is up to standards
+  system_helper 'bundle exec rubocop -DES'
+
+  # Validate all tests pass
+  system 'bundle exec rspec'
+
+  # Sort original word list alphabetically
+  Rake::Task['sort_word_lists'].invoke
+
+  # Build word data
+  Rake::Task['build_data'].invoke
+
+  # Document code
+  system 'bundle exec yard'
+end
+
+desc 'Get benchmark'
+task :determine_benchmark_ips do
+  require 'benchmark/ips'
+
+  Benchmark.ips do |x|
+    x.config time: 5, warmup: 2
+    x.report('Get Random Word') { FandomWord.random_word }
+    x.compare!
+  end
+end
+
+desc 'Sort word list fandoms and words in alphabetical order'
+task :sort_word_lists do
+  require 'yaml'
+  WORD_LIST_GLOB = 'word-lists/**/*.yml'.freeze
+  Dir.glob(WORD_LIST_GLOB) do |file_path|
+    puts "Sorting word list alphabetically: #{file_path}"
+    word_list = YAML.load_file file_path
+    word_list.each_value(&:sort!)
+    File.open(file_path, 'w') { |file| file.write word_list.to_yaml }
+  end
+end

data/doc/FandomWord.html

@@ -0,0 +1,347 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Module: FandomWord
+  
+    &mdash; Documentation by YARD 0.9.9
+  
+</title>
+
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  pathId = "FandomWord";
+  relpath = '';
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+  
+    <a href="_index.html">Index (F)</a> &raquo;
+    
+    
+    <span class="title">FandomWord</span>
+  
+</div>
+
+        <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+  
+</div>
+        <div class="clear"></div>
+      </div>
+
+      <div id="content"><h1>Module: FandomWord
+  
+  
+  
+</h1>
+<div class="box_info">
+  
+
+  
+  
+  
+  
+  
+
+  
+
+  
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/fandom_word.rb<span class="defines">,<br />
+  lib/fandoms.rb,<br /> lib/version.rb,<br /> lib/fandom_word_catalog.rb</span>
+</dd>
+  </dl>
+  
+</div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    
+<p>Holds all classes and methods for Fandom Word</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><h2>Defined Under Namespace</h2>
+<p class="children">
+  
+    
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="FandomWord/Fandoms.html" title="FandomWord::Fandoms (module)">Fandoms</a></span>
+    
+  
+    
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="FandomWord/FandomRandomizer.html" title="FandomWord::FandomRandomizer (class)">FandomRandomizer</a></span>, <span class='object_link'><a href="FandomWord/FandomWordCatalog.html" title="FandomWord::FandomWordCatalog (class)">FandomWordCatalog</a></span>
+    
+  
+</p>
+
+  <h2>Constant Summary</h2>
+  <dl class="constants">
+    
+      <dt id="VERSION-constant" class="">VERSION =
+        <div class="docstring">
+  <div class="discussion">
+    
+<p>Version of this gem</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div>
+      </dt>
+      <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>0.4.0</span><span class='tstring_end'>&#39;</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
+    
+  </dl>
+
+
+
+
+
+
+
+  
+    <h2>
+      Class Method Summary
+      <small><a href="#" class="summary_toggle">collapse</a></small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#fandoms-class_method" title="fandoms (class method)">.<strong>fandoms</strong>  &#x21d2; Object </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Returns the list of fandoms (categories).</p>
+</div></span>
+  
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#random_word-class_method" title="random_word (class method)">.<strong>random_word</strong>(fandom_name_or_names = nil)  &#x21d2; String </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Returns random word from any fandom in catalog.</p>
+</div></span>
+  
+</li>
+
+      
+    </ul>
+  
+
+
+
+  <div id="class_method_details" class="method_details_list">
+    <h2>Class Method Details</h2>
+
+    
+      <div class="method_details first">
+  <h3 class="signature first" id="fandoms-class_method">
+  
+    .<strong>fandoms</strong>  &#x21d2; <tt>Object</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Returns the list of fandoms (categories)</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+19
+20
+21</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/fandom_word.rb', line 19</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_fandoms'>fandoms</span>
+  <span class='const'><span class='object_link'><a href="FandomWord/FandomRandomizer.html" title="FandomWord::FandomRandomizer (class)">FandomRandomizer</a></span></span><span class='period'>.</span><span class='id identifier rubyid_instance'>instance</span><span class='period'>.</span><span class='id identifier rubyid_available_fandoms'>available_fandoms</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="random_word-class_method">
+  
+    .<strong>random_word</strong>(fandom_name_or_names = nil)  &#x21d2; <tt>String</tt> 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Returns random word from any fandom in catalog. Fandom category can be
+specified.</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>fandom_name_or_names</span>
+      
+      
+        <span class='type'>(<tt>String</tt>, <tt>Array</tt>)</span>
+      
+      
+        <em class="default">(defaults to: <tt>nil</tt>)</em>
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>Fandom category or array of categories</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+<p class="tag_title">Returns:</p>
+<ul class="return">
+  
+    <li>
+      
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>Random word</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+10
+11
+12
+13
+14
+15
+16</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/fandom_word.rb', line 10</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_random_word'>random_word</span><span class='lparen'>(</span><span class='id identifier rubyid_fandom_name_or_names'>fandom_name_or_names</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
+  <span class='kw'>if</span> <span class='id identifier rubyid_fandom_name_or_names'>fandom_name_or_names</span>
+    <span class='const'><span class='object_link'><a href="FandomWord/FandomRandomizer.html" title="FandomWord::FandomRandomizer (class)">FandomRandomizer</a></span></span><span class='period'>.</span><span class='id identifier rubyid_instance'>instance</span><span class='period'>.</span><span class='id identifier rubyid_random_word'>random_word</span> <span class='id identifier rubyid_fandom_name_or_names'>fandom_name_or_names</span>
+  <span class='kw'>else</span>
+    <span class='const'><span class='object_link'><a href="FandomWord/FandomRandomizer.html" title="FandomWord::FandomRandomizer (class)">FandomRandomizer</a></span></span><span class='period'>.</span><span class='id identifier rubyid_instance'>instance</span><span class='period'>.</span><span class='id identifier rubyid_random_word'>random_word</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+</div>
+
+      <div id="footer">
+  Generated on Sun Nov 19 16:39:22 2017 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.9 (ruby-2.3.3).
+</div>
+
+    </div>
+  </body>
+</html>