bgg-hotness-cli 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56be050438c908ba1e6bb22c3f1211e83559b6f423431a0f45d9792fe3061eba
-  data.tar.gz: 020f580b7653eb580ae0001ce02f792614a37cb14e406de6dd6416542cb55a90
+  metadata.gz: bc2de6031f26fec351be1d1edb8f8501b4fd0b21a08049623adb168a9709ad51
+  data.tar.gz: 7944aab38e12d7eb4bb9c7d1bea9281fa754c71ee89402283bd8f907961c179f
 SHA512:
-  metadata.gz: 9540f941f8893b9329c8a4e432e86e191f17347679dece1c0c224e31bb9192c842f21787acbe2db54415b181127c97508a7246d29df7029566736c7f417c5c39
-  data.tar.gz: 6012de1f19fb3926150c581757f0476248cf7c583bb1685164c23a0ae744e72f126b0095ceb32b6402f868df22c4f7510ba81f3ddc658fc004fd8378f136e7d0
+  metadata.gz: b4d8f3d15dc42d93e2be60bd1eb3eff1dc1122f8b9e02f5d83f05046c920d1d7ebd628b385fced9d9cdaadf3a96447bbec358c91433e894db662f9a2a6c54e92
+  data.tar.gz: 0a7956c19df56a732dd735aa793a121a07e5fa580090077d71530ea1bf97c5d5fa28cca441a323c05ab066396aa483c196d998d186147514834c41d160f851ce

data/README.md

@@ -31,14 +31,14 @@ gem install bgg-hotness-cli
 
 Run `bin/bgg-hotness-cli` in your terminal for a quickstart.
 
-Or `require 'bgg-hotness-cli` and create a `BggHotnessCLI` object with `.new.run` methods wherever you want it.
+Or `require 'bgg-hotness-cli` and create run with `BggHotnessCLI::CLI.run`.
 
 For example:
 
 ```ruby
 irb
 require 'bgg-hotness-cli'
-BggHotnessCLI.new.run
+BggHotnessCLI::CLI.run
 ```
 
 Once you're in the interface, use ↑/↓ arrows to navigate between options and press Enter to select your choice.

data/bgg-hotness-cli.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name = "bgg-hotness-cli"
-  spec.version = "0.1.3"
+  spec.version = "0.1.4"
   spec.authors = ["'Josh Ellis'"]
   spec.email = ['joshe523@gmail.com']
 

data/bin/bgg-hotness-cli

@@ -4,4 +4,4 @@ require "bundler/setup"
 require "bgg-hotness-cli"
 
 # Everything happens in a single instance of CommandLineInterface
-BggHotnessCLI.new.run
+BggHotnessCLI::CLI.run

data/lib/bgg-hotness-cli.rb

@@ -1,38 +1,13 @@
-require_relative './bgg-hotness-cli/scraper.rb'
-require_relative './bgg-hotness-cli/game.rb'
-require_relative './bgg-hotness-cli/wrap.rb'
-require_relative './bgg-hotness-cli/page.rb'
+require 'nokogiri'
+require 'open-uri'
 require 'launchy'
 require 'tty-prompt'
 
-class BggHotnessCLI
-     # Displays goodbye and ends program
-  def self.goodbye
-    puts
-    puts "Goodbye!"
-    puts
-    return
-  end
-
-  def self.header
-    puts "\e[H\e[2J"
-    puts 
-    puts "BGG Hotness CLI"
-  end
-
-  # Runs program by creating empty pages,
-  # doing a scrape of the hot list, adding games to pages,
-  # and printing the first 10 items on the list.
-  def run
-    # Create empty pages
-    Page.make_pages
+module BggHotnessCLI
+end
 
-    # Scrape list, which creates game instances
-    # and adds them to their pages in order.
-    Scraper.new("https://www.boardgamegeek.com/xmlapi2/hot?boardgame").game_list
-    
-    Page.all[0].display_page
-  end
-
-  # NOTE: #run must be last so other methods can load.
-end
+require_relative './bgg-hotness-cli/scraper.rb'
+require_relative './bgg-hotness-cli/game.rb'
+require_relative './bgg-hotness-cli/helpers.rb'
+require_relative './bgg-hotness-cli/page.rb'
+require_relative './bgg-hotness-cli/cli.rb'

data/lib/bgg-hotness-cli/cli.rb

@@ -0,0 +1,31 @@
+class BggHotnessCLI::CLI
+  # Displays goodbye and ends program
+  def self.goodbye
+    puts
+    puts "Goodbye!"
+    puts
+    return
+  end
+
+  def self.header
+    puts "\e[H\e[2J"
+    puts 
+    puts "BGG Hotness CLI"
+  end
+
+  # Runs program by creating empty pages,
+  # doing a scrape of the hot list, adding games to pages,
+  # and printing the first 10 items on the list.
+  def self.run
+    # Create empty pages
+    BggHotnessCLI::Page.make_pages
+
+    # Scrape list, which creates game instances
+    # and adds them to their pages in order.
+    BggHotnessCLI::Scraper.new("https://www.boardgamegeek.com/xmlapi2/hot?boardgame").game_list
+    
+    BggHotnessCLI::Page.all[0].display_page
+  end
+
+  # NOTE: #run must be last so other methods can load.
+end

data/lib/bgg-hotness-cli/game.rb

@@ -1,4 +1,4 @@
-class Game
+class BggHotnessCLI::Game
   attr_accessor :page, :description, :minplayers, :maxplayers, :minplaytime, :maxplaytime, :minage, :category, :mechanic, :publisher, :designer, :url
   attr_reader :name, :id, :year, :rank
 
@@ -12,14 +12,14 @@ class Game
     # Calculate page index of Page.all[]
     page_index = ((@rank.to_i - 1) / 10).floor
     # Put page into its game
-    @page = Page.all[page_index]
+    @page = BggHotnessCLI::Page.all[page_index]
     # Put game into its page
-    Page.all[page_index].games << self
+    BggHotnessCLI::Page.all[page_index].games << self
   end
 
   def header
     # Print header
-    BggHotnessCLI.header
+    BggHotnessCLI::CLI.header
     puts 
     puts "#{@rank}. #{@name} (#{@year})"
   end
@@ -30,7 +30,7 @@ class Game
     # If the description is nil, it needs to be scraped. 
     # Otherwise, all data should be in memory, so skip this.
     if @description.nil? 
-      Scraper.new("https://boardgamegeek.com/xmlapi2/thing?id=#{@id}").get_details(self)
+      BggHotnessCLI::Scraper.new("https://boardgamegeek.com/xmlapi2/thing?id=#{@id}").get_details(self)
     end
   end
 
@@ -65,43 +65,37 @@ class Game
     puts
 
     # Use print_array method to print arrays (with wrap method)
-    print_array("categories", "category", @category) 
-    print_array("mechanics", "mechanic", @mechanic)
+    print_array("categories", "category", @category, @indent) 
+    print_array("mechanics", "mechanic", @mechanic, @indent)
 
     # See what user wants to do next
     details_input
   end
 
-  # Prints array with commas as needed
-  def print_array(plural, single, array)
-  # Sometimes new games have empty fields.
-  # Don't do anything if array is empty.
-  if array.size != 0 
-    puts array.size > 1 ?  "#{plural.upcase}: " : "#{single.upcase}: "
-    
-    # Initialize variable for holding output string
-    output = "" 
-      array.each_with_index do |item,idx| 
-        output += item
-
-        # if there's more than one item and this isn't the last item, add commas
-        if item != array.last && array.size > 1
-
-          # print an & before last item
-          if idx == array.size - 2 
-            output += ", & " 
-
-          # otherwise, just print a comma and space
-          else 
-            output += ", " 
-          end
-        end
-      end
-
-      # print the output with word-wrapping
-      puts wrap(output, @indent)
-      puts
-    end
+  # Displays full description
+  def full_description
+    header
+
+    # Use wrap method to add indentation & word wrap
+    puts "DESCRIPTION:"
+    puts wrap("#{@description}",@indent) 
+    puts 
+
+    # See what user wants to do next
+    details_input
+  end
+
+  # Displays publisher(s) and designer(s)
+  def publisher_designer
+    header
+
+    # Use print_array method to print arrays (with wrap method)
+    print_array("publishers", "publisher", @publisher, @indent)
+    print_array("designers", "designer", @designer, @indent)
+    puts 
+
+    # See what user wants to do next
+    details_input
   end
 
   def details_input
@@ -150,34 +144,8 @@ class Game
       display_details
     elsif @input == choices.last
       # If they quit, run "goodbye" method
-      BggHotnessCLI.goodbye
+      BggHotnessCLI::CLI.goodbye
     end
   end
 
-  # Displays full description
-  def full_description
-    header
-
-    # Use wrap method to add indentation & word wrap
-    puts "DESCRIPTION:"
-    puts wrap("#{@description}",@indent) 
-    puts 
-
-    # See what user wants to do next
-    details_input
-  end
-
-  # Displays publisher(s) and designer(s)
-  def publisher_designer
-    header
-
-    # Use print_array method to print arrays (with wrap method)
-    print_array("publishers", "publisher", @publisher)
-    print_array("designers", "designer", @designer)
-    puts 
-
-    # See what user wants to do next
-    details_input
-  end
-
 end

data/lib/bgg-hotness-cli/helpers.rb

@@ -0,0 +1,37 @@
+# via http://www.java2s.com/Code/Ruby/String/WordwrappingLinesofText.htm
+
+def wrap(s, indent, width=78)
+  s.gsub(/(.{1,#{width}})(\s+|\Z)/, "#{indent}\\1\n")
+end
+
+# Prints array with commas as needed
+def print_array(plural, single, array, indent)
+# Sometimes new games have empty fields.
+# Don't do anything if array is empty.
+if array.size != 0 
+  puts array.size > 1 ? "#{plural.upcase}: " : "#{single.upcase}: "
+  
+  # Initialize variable for holding output string
+  output = "" 
+    array.each_with_index do |item,idx| 
+      output += item
+
+      # if there's more than one item and this isn't the last item, add commas
+      if item != array.last && array.size > 1
+
+        # print an & before last item
+        if idx == array.size - 2 
+          output += ", & " 
+
+        # otherwise, just print a comma and space
+        else 
+          output += ", " 
+        end
+      end
+    end
+
+    # print the output with word-wrapping
+    puts wrap(output, indent)
+    puts
+  end
+end

data/lib/bgg-hotness-cli/page.rb

@@ -1,6 +1,6 @@
 # Each page is a list of 10 games.
 # In total, the app has 5 pages (50 games).
-class Page
+class BggHotnessCLI::Page
   attr_accessor :start_rank, :end_rank, :games, :page_number
   
   @@all = []
@@ -22,7 +22,7 @@ class Page
     # Displays list of games between @start_rank and @end_rank
 
     # Print header
-    BggHotnessCLI.header
+    BggHotnessCLI::CLI.header
     puts "The top #{@start_rank}–#{@end_rank} hot games on BGG."
     puts
 
@@ -59,20 +59,20 @@ class Page
       # If user selects next part of the list...
       if @end_rank == 50
         # ...if at the end of the list (50), display the first page
-        Page.all[0].display_page
+        BggHotnessCLI::Page.all[0].display_page
       else
         # ...otherwise, display the next page
         # this works because the first page is [0] index,
         # but it's page # is 1, meaning this will show
         # the second page (which is at all[1]).
         # TODO: make this less confusing?
-        Page.all[@page_number].display_page
+        BggHotnessCLI::Page.all[@page_number].display_page
       end
     elsif @input == 'quit'
       # If they quit, run "goodbye" method
-      BggHotnessCLI.goodbye
+      BggHotnessCLI::CLI.goodbye
     else
-      # Otherwise, navigate to selected game
+      # Otherwise, @input is a game. Display its details.
       @input.display_details
     end
   
@@ -96,7 +96,7 @@ class Page
     _start_rank = 1   # temp local variable
     _end_rank   = 10  # temp local variable
     5.times do 
-      Page.new(_start_rank, _end_rank)
+      BggHotnessCLI::Page.new(_start_rank, _end_rank)
       _start_rank += 10
       _end_rank   += 10
     end

data/lib/bgg-hotness-cli/scraper.rb

@@ -1,7 +1,4 @@
-require 'nokogiri'
-require 'open-uri'
-
-class Scraper
+class BggHotnessCLI::Scraper
 
   # Initialize with an API path to open
   def initialize(path)
@@ -20,7 +17,7 @@ class Scraper
       year = item.css('yearpublished')[0]['value']
 
       # Create a new instance of Game with item data
-      game = Game.new(name, id, year, rank)
+      game = BggHotnessCLI::Game.new(name, id, year, rank)
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bgg-hotness-cli
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - "'Josh Ellis'"
@@ -101,10 +101,11 @@ files:
 - bin/setup
 - img/start-page.jpg
 - lib/bgg-hotness-cli.rb
+- lib/bgg-hotness-cli/cli.rb
 - lib/bgg-hotness-cli/game.rb
+- lib/bgg-hotness-cli/helpers.rb
 - lib/bgg-hotness-cli/page.rb
 - lib/bgg-hotness-cli/scraper.rb
-- lib/bgg-hotness-cli/wrap.rb
 homepage: https://github.com/imjoshellis/bgg-hotness-cli
 licenses:
 - MIT

data/lib/bgg-hotness-cli/wrap.rb

@@ -1,5 +0,0 @@
-# via http://www.java2s.com/Code/Ruby/String/WordwrappingLinesofText.htm
-
-def wrap(s, indent, width=78)
-  s.gsub(/(.{1,#{width}})(\s+|\Z)/, "#{indent}\\1\n")
-end