fandom-word 0.3.0 → 0.4.0

data/fandom-word.gemspec

@@ -5,11 +5,11 @@ require 'version'
 Gem::Specification.new do |spec|
   spec.name        = 'fandom-word'
   spec.version     = FandomWord::VERSION
-  spec.date        = '2017-11-09'
+  spec.date        = Date.today.to_s
   spec.summary     = 'Fandom Word'
-  spec.description = 'Fandom Word Generator'
+  spec.description = 'A fandom word generator that returns random words from various fandoms.'
   spec.authors     = ['Ravi Nath', 'Manni Reyes']
-  spec.email       = %w[majindm24@gmail.com manni@email.com]
+  spec.email       = %w[majindm24@gmail.com manni.reies@gmail.com]
   spec.files       = `git ls-files`
                      .split($RS)
                      .reject { |file| file.match(/^(spec|word-lists|build)/) }

data/lib/fandom_word.rb

@@ -1,53 +1,97 @@
-# FandomWord module
+# Holds all classes and methods for Fandom Word
 module FandomWord
   require 'singleton'
 
   class << self
-    def random_word
-      FandomWord::FandomRandomizer.instance.random_word
+    # Returns random word from any fandom in catalog. Fandom category can be specified.
+    #
+    # @param [String, Array] fandom_name_or_names Fandom category or array of categories
+    # @return [String] Random word
+    def random_word(fandom_name_or_names = nil)
+      if fandom_name_or_names
+        FandomRandomizer.instance.random_word fandom_name_or_names
+      else
+        FandomRandomizer.instance.random_word
+      end
     end
 
-    def random_word_from_fandom(fandom_name)
-      FandomWord::FandomRandomizer.instance.random_word_from_fandom(fandom_name)
+    # Returns the list of fandoms (categories)
+    def fandoms
+      FandomRandomizer.instance.available_fandoms
     end
   end
 
-  # FandomRandomizer class - randomly selects Fandom Words
+  # Provides singleton interface with fandom word catalog to allow retrieval of random words, random words based on
+  # fandoms and list of all available fandoms
   class FandomRandomizer
     include Singleton
     require 'pathname'
     require 'securerandom'
     require_relative 'fandom_word_catalog'
 
-    attr_accessor :catalog
-
     DATA_PATH = '../data/words.data'.freeze
+    private_constant :DATA_PATH
 
+    # Caches word catalog into memory for performance
     def initialize
       load_word_catalog
     end
 
-    def random_word
-      fandoms = @catalog.fandoms
-      random_index = SecureRandom.random_number(fandoms.size)
-      random_fandom = @catalog.fetch_fandom(fandoms[random_index])
-      random_fandom[SecureRandom.random_number random_fandom.size]
-    end
+    # Returns random word from any fandom in catalog. Fandom category can be specified.
+    #
+    # @param [String, Array] fandom_name_or_names Fandom category or array of categories
+    # @return [String] Random word
+    def random_word(fandom_name_or_names = random_fandom)
+      fandom_name = case fandom_name_or_names
+                    when Array
+                      validate_fandom_list fandom_name_or_names
+                      random_fandom_name_from fandom_name_or_names
+                    when String
+                      fandom_name_or_names
+                    else
+                      raise ArgumentError, "Argument must be [Array, String] not #{fandom_name_or_names.class}"
+                    end
 
-    def random_word_from_fandom(fandom_name)
-      category = @catalog.get_category fandom_name
-      category[SecureRandom.random_number category.size]
+      fetch_fandom fandom_name
     end
 
+    # Returns the list of fandoms (categories)
     def available_fandoms
       @catalog.fandoms
     end
 
+    private
+
+    def fetch_fandom(fandom_name)
+      validate_fandom fandom_name
+      category = @catalog.fetch_fandom fandom_name
+      category[SecureRandom.random_number category.size]
+    end
+
+    def random_fandom
+      random_fandom_name_from available_fandoms
+    end
+
+    def random_fandom_name_from(fandom_list)
+      fandom_list[SecureRandom.random_number fandom_list.size]
+    end
+
     def load_word_catalog
       file_path = Pathname(File.dirname(__FILE__)) + DATA_PATH
       source = File.read(file_path, mode: 'rb')
       # rubocop:disable Security/MarshalLoad
       @catalog = Marshal.load(source) if @catalog.nil?
     end
+
+    def validate_fandom(fandom_name)
+      return if available_fandoms.include? fandom_name
+      raise ArgumentError, "Invalid #{fandom_name}, Valid fandoms #{available_fandoms}"
+    end
+
+    # Raises if fandom_list is using a fandom not in available fandoms
+    def validate_fandom_list(fandom_list)
+      return if (fandom_list & available_fandoms).size == fandom_list.size
+      raise ArgumentError, "Explicit List: #{fandom_list} \n Available Fandoms: #{available_fandoms}"
+    end
   end
 end

data/lib/fandom_word_catalog.rb

@@ -1,15 +1,17 @@
 module FandomWord
-  # FandomWordCatalog class
+  # FandomWordCatalog is a catalog holding all words in groups of fandoms.
   class FandomWordCatalog
     def initialize
       @fandoms = {}
     end
 
+    # Returns an array of words associated with the specified fandom. Initializes fandom in catalog if not present.
     def fetch_fandom(fandom)
       # grab the category if it exists, if not make it empty array
       @fandoms.keys.include?(fandom) ? @fandoms[fandom] : @fandoms[fandom] = []
     end
 
+    # Adds a word to a fandom
     def add_word(new_word, categories)
       categories.each do |category|
         fandom = fetch_fandom(category)
@@ -17,6 +19,7 @@ module FandomWord
       end
     end
 
+    # Returns the list of fandoms (categories)
     def fandoms
       @fandoms.keys
     end

data/lib/fandoms.rb

@@ -1,30 +1,67 @@
 module FandomWord
+  # Available Fandoms. Categories to choose for your random word.
   module Fandoms
+    # Available fandom category anime
     ANIME = 'anime'.freeze
+    # Available fandom category bigo
     BIGO = 'bigo'.freeze
+    # Available fandom category mech
     MECH = 'mech'.freeze
+    # Available fandom category mecha
     MECHA = 'mecha'.freeze
-    NOIR = 'noir'.freeze
+    # Available fandom category neo-noir
     NEO_NOIR = 'neo-noir'.freeze
+    # Available fandom category noir
+    NOIR = 'noir'.freeze
+    # Available fandom category scifi
     SCIFI = 'scifi'.freeze
-    SUPERNATURAL = 'supernatural'.freeze
+    # Available fandom category martialarts
     MARTIALARTS = 'martialarts'.freeze
+    # Available fandom category supernatural
+    SUPERNATURAL = 'supernatural'.freeze
+    # Available fandom category dbz
     DBZ = 'dbz'.freeze
+    # Available fandom category dragonball
     DRAGONBALL = 'dragonball'.freeze
-    DRAGONBALLZ = 'dragonballz'.freeze
+    # Available fandom category dragonballgt
     DRAGONBALLGT = 'dragonballgt'.freeze
+    # Available fandom category dragonballsuper
     DRAGONBALLSUPER = 'dragonballsuper'.freeze
+    # Available fandom category dragonballz
+    DRAGONBALLZ = 'dragonballz'.freeze
+    # Available fandom category ggundam
+    GGUNDAM = 'ggundam'.freeze
+    # Available fandom category gundam
     GUNDAM = 'gundam'.freeze
+    # Available fandom category gundamwing
     GUNDAMWING = 'gundamwing'.freeze
+    # Available fandom category mobilesuit
     MOBILESUIT = 'mobilesuit'.freeze
+    # Available fandom category zetagundam
     ZETAGUNDAM = 'zetagundam'.freeze
-    GGUNDAM = 'ggundam'.freeze
-    WESTERN = 'western'.freeze
+    # Available fandom category neo-western
     NEO_WESTERN = 'neo-western'.freeze
+    # Available fandom category spacewestern
     SPACEWESTERN = 'spacewestern'.freeze
+    # Available fandom category weirdwest
     WEIRDWEST = 'weirdwest'.freeze
+    # Available fandom category western
+    WESTERN = 'western'.freeze
+    # Available fandom category rick_and_morty
+    RICK_AND_MORTY = 'rick_and_morty'.freeze
+    # Available fandom category games
+    GAMES = 'games'.freeze
+    # Available fandom category metal_gear_solid
+    METAL_GEAR_SOLID = 'metal_gear_solid'.freeze
+    # Available fandom category mgs
+    MGS = 'mgs'.freeze
+    # Available fandom category british
+    BRITISH = 'british'.freeze
+    # Available fandom category drwho
     DRWHO = 'drwho'.freeze
+    # Available fandom category whovian
     WHOVIAN = 'whovian'.freeze
-    BRITISH = 'british'.freeze
+    # Available fandom category firefly
+    FIREFLY = 'firefly'.freeze
   end
 end

data/lib/version.rb

@@ -1,3 +1,4 @@
 module FandomWord
-  VERSION = '0.3.0'.freeze
+  # Version of this gem
+  VERSION = '0.4.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fandom-word
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Ravi Nath
@@ -9,22 +9,48 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-09 00:00:00.000000000 Z
+date: 2017-11-19 00:00:00.000000000 Z
 dependencies: []
-description: Fandom Word Generator
+description: A fandom word generator that returns random words from various fandoms.
 email:
 - majindm24@gmail.com
-- manni@email.com
+- manni.reies@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitattributes"
 - ".gitignore"
+- ".rspec"
 - ".rubocop.yml"
+- ".travis.yml"
+- ".yardoc/checksums"
+- ".yardoc/complete"
+- ".yardoc/object_types"
+- ".yardoc/objects/root.dat"
+- ".yardoc/proxy_types"
 - Gemfile
 - README.md
 - Rakefile
 - data/words.data
+- doc/FandomWord.html
+- doc/FandomWord/FandomRandomizer.html
+- doc/FandomWord/FandomWordCatalog.html
+- doc/FandomWord/Fandoms.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
 - fandom-word.gemspec
 - lib/fandom-word.rb
 - lib/fandom_word.rb