gamerom 0.3.0 → 0.4.0

data/lib/gamerom/config.rb

@@ -1,4 +1,4 @@
-# 'frozen_string_literal' => true
+# frozen_string_literal: true
 
 require 'fileutils'
 require 'logger'
@@ -6,7 +6,7 @@ require 'rest-client'
 require 'mechanize'
 
 module Gamerom
-  ROM_ROOT = ENV['ROM_ROOT'] || File.expand_path("~/.gamerom")
+  ROM_ROOT = ENV['ROM_ROOT'] || File.expand_path('~/.gamerom')
   CACHE_DIR = ENV['CACHE_DIR'] || "#{ROM_ROOT}/cache"
   GAME_DIR = ENV['GAME_DIR'] || "#{ROM_ROOT}/games"
   LOG_DIR = ENV['LOG_DIR'] || "#{ROM_ROOT}/logs"

data/lib/gamerom/game.rb

@@ -1,54 +1,56 @@
-# 'frozen_string_literal' => true
+# frozen_string_literal: true
 
 require 'fileutils'
 require 'ostruct'
 require 'yaml'
 
 module Gamerom
+  # Game - Represents a game ROM
   class Game < OpenStruct
     def filenames
-      YAML.load_file(self.state_filename).map do |filename|
-        "#{self.filepath}/#{filename}"
+      YAML.load_file(state_filename).map do |filename|
+        "#{filepath}/#{filename}"
       end
     end
 
     def filepath
-      "#{Gamerom::GAME_DIR}/#{self.repo.name}/#{self.platform}/#{self.region}"
+      "#{Gamerom::GAME_DIR}/#{repo.name}/#{platform}/#{region}"
     end
 
     def install
-      self.repo.install self do |filenames|
-        self.update_state filenames
+      repo.install self do |filenames|
+        update_state filenames
       end
     end
 
     def installed?
-      File.exists? self.state_filename
+      File.exist? state_filename
     end
 
     def state_filename
-      "#{Gamerom::STATE_DIR}/#{self.repo.name}/#{self.platform}/#{self.region}/#{self.id}"
+      "#{Gamerom::STATE_DIR}/#{repo.name}/#{platform}/#{region}/#{id}"
     end
 
     def to_s
       install_status = ''
-      install_status = " (#{shell.set_color 'installed', :green})" if self.installed?
+      install_status = " (#{shell.set_color "installed", :green})" if installed?
       tags = ''
-      tags = " - tags: #{self.tags.join(", ")}" if self.respond_to?(:tags) && !self.tags.empty?
-      "#{self.id} - #{self.name} - #{self.region}#{install_status}#{tags}"
+      tags = " - tags: #{tags.join(", ")}" if respond_to?(:tags) && !tags.empty?
+      "#{id} - #{name} - #{region}#{install_status}#{tags}"
     end
 
     def uninstall
-      FileUtils.rm_rf self.filenames
-      FileUtils.rm_rf self.state_filename
+      FileUtils.rm_rf filenames
+      FileUtils.rm_rf state_filename
     end
 
-    def update_state filenames
-      FileUtils.mkdir_p("#{Gamerom::STATE_DIR}/#{self.repo.name}/#{self.platform}/#{self.region}")
-      File.write(self.state_filename, filenames.to_yaml)
+    def update_state(filenames)
+      FileUtils.mkdir_p("#{Gamerom::STATE_DIR}/#{repo.name}/#{platform}/#{region}")
+      File.write(state_filename, filenames.to_yaml)
     end
 
     private
+
     def shell
       @shell ||= Thor::Shell::Color.new
     end

data/lib/gamerom/game_info.rb

@@ -1,6 +1,7 @@
-# 'frozen_string_literal' => true
+# frozen_string_literal: true
 
 module Gamerom
+  # GameInfo - Extracts region and tags from game name
   class GameInfo
     REGIONS = {
       '1' => 'Japan & Korea',
@@ -33,13 +34,13 @@ module Gamerom
       'S' => 'Spain',
       'Sw' => 'Sweden',
       'SW' => 'Sweden',
-      'U' => "USA",
+      'U' => 'USA',
       'UK' => 'England',
       'Unk' => 'Unknown Country',
       'Unl' => 'Unlicensed',
       'PAL' => 'PAL regions (Australia, Europe)',
       'NTSC' => 'NTSC regions (Japan, USA, Latin America)',
-    }
+    }.freeze
 
     TAGS = {
       '!' => :good,
@@ -61,23 +62,21 @@ module Gamerom
       'T+' => :newer_translation,
       'VS' => :vs,
       'x' => :bad_checksum,
-    }
+    }.freeze
+
+    attr_reader :name
 
     def initialize(name)
       @name = name
     end
 
-    def name
-      @name
-    end
-
     def region
       identifiers = @name.scan(/\((?<region>[A-Za-z0-9]+)\)/).flatten
       region_id = identifiers.find { |i| REGIONS.include? i }
       if region_id
         REGIONS[region_id]
       else
-        "USA"
+        'USA'
       end
     end
 
@@ -85,7 +84,7 @@ module Gamerom
       tags = []
       codes = @name.scan(/\[(?<code>[^\]]+)\]/).flatten
       codes.each do |code|
-        code = $1 if code.match /^(?<code>[abcfhop])[0-9]*/
+        code = Regexp.last_match(1) if code.match /^(?<code>[abcfhop])[0-9]*/
         tags << TAGS[code] if TAGS.include?(code)
       end
       tags

data/lib/gamerom/repo.rb

@@ -1,4 +1,4 @@
-# 'frozen_string_literal' => true
+# frozen_string_literal: true
 
 require 'yaml'
 
@@ -6,30 +6,34 @@ REPOSITORIES = Dir["#{File.dirname(__FILE__)}/repo_adapters/*"].map do |file|
   File.basename(file, '.rb')
 end
 
+require_relative 'repo_adapter'
 REPOSITORIES.each do |repo|
   require_relative "repo_adapters/#{repo}"
 end
 
 module Gamerom
+  # Repo - Represents a game ROM repository
   class Repo
+    attr_reader :name
+
     def self.list
       REPOSITORIES.map do |repo|
-        self.new repo
+        new repo
       end
     end
 
-    def initialize name
+    def initialize(name)
       @name = name
       @repo = Gamerom::RepoAdapters.const_get(name.capitalize)
     end
 
-    def install game, &block
+    def install(game, &block)
       @repo.install game, &block
     end
 
-    def find platform, game_identifier
+    def find(platform, game_identifier)
       games(platform).find do |game|
-        if Float(game_identifier, exception: false)
+        if Integer(game_identifier, exception: false)
           game.id == game_identifier.to_i
         else
           game.name.downcase == game_identifier.downcase
@@ -37,45 +41,41 @@ module Gamerom
       end
     end
 
-    def games platform, options={}
+    def games(platform, options = {})
       platform_database = "#{Gamerom::CACHE_DIR}/#{@name}/#{platform}.yml"
-      update_database platform unless File.exists? platform_database
-      games = YAML.load_file(platform_database).map { |game|
+      update_database platform unless File.exist? platform_database
+      games = YAML.load_file(platform_database).map do |game|
         Game.new(game.merge(platform: platform, repo: self))
-      }
+      end
 
-      if !options[:region].nil?
-        games = games.select { |game|
-          options[:region].nil? || game.region == options[:region]
-        }
+      unless options[:region].nil?
+        games.select! do |game|
+          game.region == options[:region]
+        end
       end
 
-      if !options[:keyword].nil?
-        games = games.select { |game|
+      unless options[:keyword].nil?
+        games.select! do |game|
           game.name =~ /#{options[:keyword]}/i
-        }
+        end
       end
 
       games
     end
 
-    def name
-      @name
-    end
-
     def platforms
       @repo.platforms
     end
 
-    def regions platform
-      games(platform).map { |game| game.region }.sort.uniq
+    def regions(platform)
+      games(platform).map(&:region).sort.uniq
     end
 
     def to_s
       @name
     end
 
-    def update_database platform
+    def update_database(platform)
       games = @repo.games platform
       FileUtils.mkdir_p("#{Gamerom::CACHE_DIR}/#{@name}")
       File.write("#{Gamerom::CACHE_DIR}/#{@name}/#{platform}.yml", games.to_yaml)

data/lib/gamerom/repo_adapter.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'nokogiri'
+require 'rest-client'
+
+module Gamerom
+  # RepoAdapter - Common adapter methods
+  module RepoAdapter
+    def nokogiri_get(url)
+      Nokogiri::HTML(RestClient.get(url))
+    end
+
+    def games(platform)
+      games = []
+      progress_bar = ProgressBar.new(platform, sections.count)
+
+      extract_games(platform) do |section_games, section_index|
+        games.append(*section_games)
+        progress_bar.set(section_index + 1)
+      end
+
+      progress_bar.finish
+      games
+    end
+  end
+end

data/lib/gamerom/repo_adapters/coolrom.rb

@@ -3,12 +3,13 @@
 require 'mechanize'
 require 'mechanize/progressbar'
 require 'mechanizeprogress'
-require 'nokogiri'
-require 'rest-client'
 
 module Gamerom
   module RepoAdapters
+    # Coolrom - An adapter for the CoolROM repository website
     class Coolrom
+      extend Gamerom::RepoAdapter
+
       PLATFORM = {
         'atari2600' => 'Atari 2600',
         'atari5200' => 'Atari 5200',
@@ -33,32 +34,33 @@ module Gamerom
         'psx' => 'Sony Playstation',
         'ps2' => 'Sony Playstation 2',
         'psp' => 'Sony Playstation Portable',
-      }
+      }.freeze
 
       def self.platforms
         PLATFORM
       end
 
-      def self.games(platform)
-        games = []
-        sections = ('a'..'z').to_a.unshift("0")
-        progress_bar = ProgressBar.new(platform, sections.count)
+      def self.sections
+        ('a'..'z').to_a.unshift('0')
+      end
+
+      def self.extract_games(platform)
         sections.each_with_index do |section, index|
-          page = Nokogiri::HTML(RestClient.get("https://coolrom.com.au/roms/#{platform}/#{section}/"))
-          regions = page.css('input.region').map { |i| i["name"] }
+          page = nokogiri_get("https://coolrom.com.au/roms/#{platform}/#{section}/")
+          regions = page.css('input.region').map { |i| i['name'] }
           regions.each do |region|
-            games.append *page.css("div.#{region} a").map { |game|
-              {
-                id: game['href'].split('/')[3].to_i,
-                name: game.text,
-                region: region,
-              }
-            }
+            game_links = page.css("div.#{region} a")
+            yield game_links.map { |game_link| game(game_link, region) }, index
           end
-          progress_bar.set(index+1)
         end
-        progress_bar.finish
-        games
+      end
+
+      def self.game(game_link, region)
+        {
+          id: game_link['href'].split('/')[3].to_i,
+          name: game_link.text,
+          region: region,
+        }
       end
 
       def self.install(game)
@@ -67,15 +69,16 @@ module Gamerom
         agent.user_agent = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.4430.93 Safari/537.36'
 
         response = nil
-        agent.progressbar{
+        agent.progressbar do
           response = agent.get("https://coolrom.com.au/downloader.php?id=#{game.id}")
-        }
-        if response.code.to_i == 200
-          filename = response.filename
-          FileUtils.mkdir_p(game.filepath)
-          response.save!("#{game.filepath}/#{filename}")
-          yield [filename]
         end
+
+        return unless response.code.to_i == 200
+
+        filename = response.filename
+        FileUtils.mkdir_p(game.filepath)
+        response.save!("#{game.filepath}/#{filename}")
+        yield [filename]
       end
     end
   end

data/lib/gamerom/repo_adapters/romnation.rb

@@ -4,12 +4,13 @@ require 'cgi'
 require 'mechanize'
 require 'mechanize/progressbar'
 require 'mechanizeprogress'
-require 'nokogiri'
-require 'rest-client'
 
 module Gamerom
   module RepoAdapters
+    # Romnation - An adapter for the ROMNation repository website
     class Romnation
+      extend Gamerom::RepoAdapter
+
       PLATFORM = {
         'amstrad' => 'Amstrad',
         'atari2600' => 'Atari 2600',
@@ -44,36 +45,46 @@ module Gamerom
         'virtualboy' => 'Virtual Boy',
         'watara' => 'Watara Supervision',
         'wonderswan' => 'WonderSwan',
-      }
+      }.freeze
 
       def self.platforms
         PLATFORM
       end
 
-      def self.games(platform)
-        games = []
-        sections = ('a'..'z').to_a.unshift("0")
-        progress_bar = ProgressBar.new(platform, sections.count)
+      def self.sections
+        ('a'..'z').to_a.unshift('0')
+      end
+
+      def self.extract_games(platform)
         sections.each_with_index do |section, index|
-          page = Nokogiri::HTML(RestClient.get("https://www.romnation.net/srv/roms/#{platform}/#{section}/sort-title.html"))
-          pages = ['1']
-          pages = page.css('.pagination').first.css('a').map(&:text).map(&:strip).reject(&:empty?) unless page.css('.pagination').empty?
-          pages.each do |p|
-            page = Nokogiri::HTML(RestClient.get("https://www.romnation.net/srv/roms/#{platform}/#{section}/page-#{p}_sort-title.html"))
-            games.append *page.css('table.listings td.title a').map { |game|
-              game_info = GameInfo.new(game.text)
-              {
-                id: game['href'].split('/')[3].to_i,
-                name: game.text,
-                region: game_info.region,
-                tags: game_info.tags,
-              }
-            }
-          end
-          progress_bar.set(index+1)
+          pages = extract_pages(platform, section)
+          yield extract_games_from_section_pages(platform, section, pages), index
+        end
+      end
+
+      def self.extract_pages(platform, section)
+        page = nokogiri_get("https://www.romnation.net/srv/roms/#{platform}/#{section}/sort-title.html")
+        pages = ['1']
+        pages = page.css('.pagination').first.css('a').map(&:text).map(&:strip).reject(&:empty?) unless page.css('.pagination').empty?
+        pages
+      end
+
+      def self.extract_games_from_section_pages(platform, section, pages)
+        pages.reduce([]) do |section_games, p|
+          page = nokogiri_get("https://www.romnation.net/srv/roms/#{platform}/#{section}/page-#{p}_sort-title.html")
+          games_links = page.css('table.listings td.title a')
+          section_games.append(*games_links.map { |game_link| game(game_link) })
         end
-        progress_bar.finish
-        games
+      end
+
+      def self.game(game_link)
+        game_info = GameInfo.new(game_link.text)
+        {
+          id: game_link['href'].split('/')[3].to_i,
+          name: game_link.text,
+          region: game_info.region,
+          tags: game_info.tags,
+        }
       end
 
       def self.install(game)
@@ -83,15 +94,16 @@ module Gamerom
         page = agent.get("https://www.romnation.net/download/rom/#{game.id}")
 
         response = nil
-        agent.progressbar{
-          response = page.link_with(:text => 'Download This Rom').click
-        }
-        if response.code.to_i == 200
-          filename = CGI.unescape(response.filename.split('_host=').first)
-          FileUtils.mkdir_p(game.filepath)
-          response.save!("#{game.filepath}/#{filename}")
-          yield [filename]
+        agent.progressbar do
+          response = page.link_with(text: 'Download This Rom').click
         end
+
+        return unless response.code.to_i == 200
+
+        filename = CGI.unescape(response.filename.split('_host=').first)
+        FileUtils.mkdir_p(game.filepath)
+        response.save!("#{game.filepath}/#{filename}")
+        yield [filename]
       end
     end
   end