gamerom 0.1.0 → 0.4.0

data/Rakefile

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-require "rubocop/rake_task"
+require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new
 

data/bin/console

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "bundler/setup"
-require "gamerom"
+require 'bundler/setup'
+require 'gamerom'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -11,5 +11,5 @@ require "gamerom"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/entrypoint.sh

@@ -0,0 +1,6 @@
+#!/bin/sh
+delgroup dialout
+addgroup -g "$GROUP_ID" rungroup
+adduser -u $UID -D -s /bin/sh -G rungroup runuser
+command="cd /app && GEM_HOME="/bundle" PATH=$GEM_HOME/bin:$GEM_HOME/gems/bin:$PATH bundle exec ./exe/gamerom ${@}"
+su - runuser -c "$command"

data/exe/gamerom

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "gamerom"
+require 'gamerom'
 
 Gamerom::Cli.start(ARGV)

data/gamerom.gemspec

@@ -1,38 +1,40 @@
 # frozen_string_literal: true
 
-require_relative "lib/gamerom/version"
+require_relative 'lib/gamerom/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "gamerom"
+  spec.name          = 'gamerom'
   spec.version       = Gamerom::VERSION
-  spec.authors       = ["Lucas Mundim"]
-  spec.email         = ["lucas.mundim@gmail.com"]
+  spec.authors       = ['Lucas Mundim']
+  spec.email         = ['lucas.mundim@gmail.com']
 
-  spec.summary       = "The Video Game ROM downloader"
-  spec.description   = "A command-line installer for game ROMs from many repositories."
-  spec.homepage      = "https://github.com/lucasmundim/gamerom"
-  spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
+  spec.summary       = 'The Video Game ROM downloader'
+  spec.description   = 'A command-line installer for game ROMs from many repositories.'
+  spec.homepage      = 'https://github.com/lucasmundim/gamerom'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 3.0.1')
 
-  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = "#{spec.homepage}/CHANGELOG.md"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/master/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_runtime_dependency "mechanize", "~> 2.8.0"
-  spec.add_runtime_dependency "nokogiri", "~> 1.11.3"
-  spec.add_runtime_dependency "rest-client", "~> 2.1.0"
-  spec.add_runtime_dependency "thor", "~> 1.1.0"
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'mechanize', '~> 2.8.0'
+  spec.add_runtime_dependency 'mechanize-progressbar', '~> 0.2.0'
+  spec.add_runtime_dependency 'nokogiri', '~> 1.11.3'
+  spec.add_runtime_dependency 'progressbar', '~> 0.9.0'
+  spec.add_runtime_dependency 'rest-client', '~> 2.1.0'
+  spec.add_runtime_dependency 'thor', '~> 1.1.0'
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

data/lib/gamerom.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
-require_relative "gamerom/config"
-require_relative "gamerom/game"
-require_relative "gamerom/repo"
-require_relative "gamerom/cli"
-require_relative "gamerom/version"
+require_relative 'gamerom/config'
+require_relative 'gamerom/game'
+require_relative 'gamerom/game_info'
+require_relative 'gamerom/repo'
+require_relative 'gamerom/cli'
+require_relative 'gamerom/version'
 
 module Gamerom
   class Error < StandardError; end

data/lib/gamerom/cli.rb

@@ -3,8 +3,9 @@
 require 'thor'
 
 module Gamerom
+  # Cli - Main cli commands
   class Cli < Thor
-    class_option :verbose, :aliases => ['-v'], :type => :boolean, default: false, desc: "Show verbose backtrace"
+    class_option :verbose, aliases: ['-v'], type: :boolean, default: false, desc: 'Show verbose backtrace'
 
     def self.exit_on_failure?
       true
@@ -22,26 +23,27 @@ module Gamerom
     end
 
     desc 'info GAME_IDENTIFIER', 'Info for game GAME_IDENTIFIER (id/name)'
-    option :repo, :aliases => ['-r'], type: :string, required: true, desc: "Which repo to use", enum: Gamerom::Repo.list.map(&:to_s)
-    option :platform, :aliases => ['-p'], type: :string, required: true, desc: "Which platform to use"
+    option :repo, aliases: ['-r'], type: :string, required: true, desc: 'Which repo to use', enum: Gamerom::Repo.list.map(&:to_s)
+    option :platform, aliases: ['-p'], type: :string, required: true, desc: 'Which platform to use'
     def info(game_identifier)
       repo = Repo.new(options[:repo])
       validate_platform repo, options[:platform]
       puts "showing info for game #{game_identifier} on #{options[:platform]} platform on #{options[:repo]} repo..."
       game = repo.find(options[:platform], game_identifier)
-      if game.nil?
+      if !game.nil?
+        puts game
+        puts game.filenames if game.installed?
+      else
         shell.say "Game #{game_identifier} not found", :red
       end
-      puts game
-      puts game.filename if game.installed?
-    rescue => e
+    rescue StandardError => e
       render_error e, options
       exit 1
     end
 
     desc 'install GAME_IDENTIFIER', 'Install game GAME_IDENTIFIER (id/name)'
-    option :repo, :aliases => ['-r'], type: :string, required: true, desc: "Which repo to use", enum: Gamerom::Repo.list.map(&:to_s)
-    option :platform, :aliases => ['-p'], type: :string, required: true, desc: "Which platform to use"
+    option :repo, aliases: ['-r'], type: :string, required: true, desc: 'Which repo to use', enum: Gamerom::Repo.list.map(&:to_s)
+    option :platform, aliases: ['-p'], type: :string, required: true, desc: 'Which platform to use'
     def install(game_identifier)
       repo = Repo.new(options[:repo])
       validate_platform repo, options[:platform]
@@ -52,20 +54,20 @@ module Gamerom
       end
       puts "installing game #{game.id} - #{game.name} - #{game.region} on #{options[:platform]} platform on #{options[:repo]} repo..."
       if game.installed?
-        shell.say "Game already installed", :yellow
+        shell.say 'Game already installed', :yellow
         return
       end
       game.install
-      shell.say "Game installed", :green
-    rescue => e
+      shell.say 'Game installed', :green
+    rescue StandardError => e
       render_error e, options
       exit 1
     end
 
     desc 'install_all', 'Install all games'
-    option :repo, :aliases => ['-r'], type: :string, required: true, desc: "Which repo to use", enum: Gamerom::Repo.list.map(&:to_s)
-    option :platform, :aliases => ['-p'], type: :string, required: true, desc: "Which platform to use"
-    option :region, :aliases => ['-g'], type: :string, required: false, desc: "Only from specified region"
+    option :repo, aliases: ['-r'], type: :string, required: true, desc: 'Which repo to use', enum: Gamerom::Repo.list.map(&:to_s)
+    option :platform, aliases: ['-p'], type: :string, required: true, desc: 'Which platform to use'
+    option :region, aliases: ['-g'], type: :string, required: false, desc: 'Only from specified region'
     def install_all
       repo = Repo.new(options[:repo])
       validate_platform repo, options[:platform]
@@ -73,40 +75,40 @@ module Gamerom
       games.each do |game|
         install(game.id) unless game.installed?
       end
-    rescue => e
+    rescue StandardError => e
       render_error e, options
       exit 1
     end
 
     desc 'list', 'List available games'
-    option :repo, :aliases => ['-r'], type: :string, required: true, desc: "Which repo to use", enum: Gamerom::Repo.list.map(&:to_s)
-    option :platform, :aliases => ['-p'], type: :string, required: true, desc: "Which platform to use"
-    option :region, :aliases => ['-g'], type: :string, required: false, desc: "Only from specified region"
+    option :repo, aliases: ['-r'], type: :string, required: true, desc: 'Which repo to use', enum: Gamerom::Repo.list.map(&:to_s)
+    option :platform, aliases: ['-p'], type: :string, required: true, desc: 'Which platform to use'
+    option :region, aliases: ['-g'], type: :string, required: false, desc: 'Only from specified region'
     def list
       repo = Repo.new(options[:repo])
       validate_platform repo, options[:platform]
       puts "listing available games for #{options[:platform]} platform on #{options[:repo]} repo..."
       games = repo.games options[:platform], region: options[:region]
       print_game_table(games)
-    rescue => e
+    rescue StandardError => e
       render_error e, options
       exit 1
     end
 
     desc 'platforms', 'List available platforms'
-    option :repo, :aliases => ['-r'], type: :string, required: true, desc: "Which repo to use", enum: Gamerom::Repo.list.map(&:to_s)
+    option :repo, aliases: ['-r'], type: :string, required: true, desc: 'Which repo to use', enum: Gamerom::Repo.list.map(&:to_s)
     def platforms
       puts "listing available platforms for #{options[:repo]} repo..."
       platforms = { platforms: Repo.new(options[:repo]).platforms }
       puts platforms.to_yaml
-    rescue => e
+    rescue StandardError => e
       render_error e, options
       exit 1
     end
 
     desc 'recover', 'Try to recover state from already downloaded roms'
-    option :repo, :aliases => ['-r'], type: :string, required: true, desc: "Which repo to use", enum: Gamerom::Repo.list.map(&:to_s)
-    option :platform, :aliases => ['-p'], type: :string, required: true, desc: "Which platform to use"
+    option :repo, aliases: ['-r'], type: :string, required: true, desc: 'Which repo to use', enum: Gamerom::Repo.list.map(&:to_s)
+    option :platform, aliases: ['-p'], type: :string, required: true, desc: 'Which platform to use'
     def recover
       repo = Repo.new(options[:repo])
       validate_platform repo, options[:platform]
@@ -116,10 +118,9 @@ module Gamerom
       games.each do |game|
         filename = nil
         basename = "#{Gamerom::GAME_DIR}/#{repo.name}/#{options[:platform]}/#{game[:region]}/#{game[:name]}"
-        ['zip', '7z', 'rar'].each do |ext|
-          if File.exists? "#{basename}.#{ext}"
-            filename = "#{basename}.#{ext}"
-          end
+        %w[zip 7z rar].each do |ext|
+          fullname = "#{basename}.#{ext}"
+          filename = fullname if File.exist? fullname
         end
 
         if filename
@@ -129,100 +130,107 @@ module Gamerom
           games_not_found << game[:name]
         end
       end
-      if games_not_found.count > 0
-        puts "Games not found:"
+      if games_not_found.count.positive?
+        puts 'Games not found:'
         puts games_not_found
       end
-    rescue => e
+    rescue StandardError => e
       puts e.message
       exit 1
     end
 
     desc 'regions', 'List available regions'
-    option :repo, :aliases => ['-r'], type: :string, required: true, desc: "Which repo to use", enum: Gamerom::Repo.list.map(&:to_s)
-    option :platform, :aliases => ['-p'], type: :string, required: true, desc: "Which platform to use"
+    option :repo, aliases: ['-r'], type: :string, required: true, desc: 'Which repo to use', enum: Gamerom::Repo.list.map(&:to_s)
+    option :platform, aliases: ['-p'], type: :string, required: true, desc: 'Which platform to use'
     def regions
       repo = Repo.new(options[:repo])
       validate_platform repo, options[:platform]
       puts "listing available regions for #{options[:platform]} platform on #{options[:repo]} repo..."
       puts repo.regions options[:platform]
-    rescue => e
+    rescue StandardError => e
       render_error e, options
       exit 1
     end
 
     desc 'repo', 'List available repo'
     def repo
-      puts "listing available repo..."
+      puts 'listing available repo...'
       puts Repo.list
-    rescue => e
+    rescue StandardError => e
       render_error e, options
       exit 1
     end
 
     desc 'search KEYWORD', 'Search games by KEYWORD'
-    option :repo, :aliases => ['-r'], type: :string, required: true, desc: "Which repo to use", enum: Gamerom::Repo.list.map(&:to_s)
-    option :platform, :aliases => ['-p'], type: :string, required: true, desc: "Which platform to use"
-    option :region, :aliases => ['-g'], type: :string, required: false, desc: "Only from specified region"
+    option :repo, aliases: ['-r'], type: :string, required: true, desc: 'Which repo to use', enum: Gamerom::Repo.list.map(&:to_s)
+    option :platform, aliases: ['-p'], type: :string, required: true, desc: 'Which platform to use'
+    option :region, aliases: ['-g'], type: :string, required: false, desc: 'Only from specified region'
+    option :install, aliases: ['-I'], type: :boolean, required: false, desc: 'Install search results'
     def search(keyword)
       repo = Repo.new(options[:repo])
       validate_platform repo, options[:platform]
       puts "searching available games for #{options[:platform]} platform on #{options[:repo]} repo..."
       games = repo.games options[:platform], region: options[:region], keyword: keyword
-      print_game_table(games)
-    rescue => e
+      if options[:install]
+        games.each do |game|
+          install(game.id) unless game.installed?
+        end
+      else
+        print_game_table(games)
+      end
+    rescue StandardError => e
       render_error e, options
       exit 1
     end
 
     desc 'stats', 'Show platform stats'
-    option :repo, :aliases => ['-r'], type: :string, required: true, desc: "Which repo to use", enum: Gamerom::Repo.list.map(&:to_s)
-    option :platform, :aliases => ['-p'], type: :string, required: true, desc: "Which platform to use"
+    option :repo, aliases: ['-r'], type: :string, required: true, desc: 'Which repo to use', enum: Gamerom::Repo.list.map(&:to_s)
+    option :platform, aliases: ['-p'], type: :string, required: true, desc: 'Which platform to use'
     def stats
       repo = Repo.new(options[:repo])
       validate_platform repo, options[:platform]
       puts "stats for #{options[:platform]} platform on #{options[:repo]} repo..."
       games = repo.games options[:platform]
       total = games.count
-      installed = games.select { |game| game.installed? }.count
+      installed = games.select(&:installed?).count
       size = 0
-      if File.exists? "#{Gamerom::GAME_DIR}/#{repo.name}/#{options[:platform]}"
+      if File.exist? "#{Gamerom::GAME_DIR}/#{repo.name}/#{options[:platform]}"
         size = `du -hs "#{Gamerom::GAME_DIR}/#{repo.name}/#{options[:platform]}/"|awk '{ print $1 }'`
       end
       puts "  All: #{installed}/#{total} - size: #{size}"
       repo.regions(options[:platform]).each do |region|
         games = repo.games(options[:platform], region: region)
         total = games.count
-        installed = games.select { |game| game.installed? }.count
+        installed = games.select(&:installed?).count
         size = 0
-        if File.exists? "#{Gamerom::GAME_DIR}/#{repo.name}/#{options[:platform]}/#{region}"
+        if File.exist? "#{Gamerom::GAME_DIR}/#{repo.name}/#{options[:platform]}/#{region}"
           size = `du -hs "#{Gamerom::GAME_DIR}/#{repo.name}/#{options[:platform]}/#{region}/"|awk '{ print $1 }'`
         end
         puts "  #{region}: #{installed}/#{total} - size: #{size}"
       end
       puts
-    rescue => e
+    rescue StandardError => e
       render_error e, options
       exit 1
     end
 
     desc 'stats_all', 'Show stats for all platforms'
-    option :repo, :aliases => ['-r'], type: :string, required: true, desc: "Which repo to use", enum: Gamerom::Repo.list.map(&:to_s)
+    option :repo, aliases: ['-r'], type: :string, required: true, desc: 'Which repo to use', enum: Gamerom::Repo.list.map(&:to_s)
     def stats_all
       repo = Repo.new(options[:repo])
-      repo.platforms.keys.each do |platform|
+      repo.platforms.each_key do |platform|
         a = Gamerom::Cli.new
         a.options = { platform: platform, repo: options[:repo] }
         a.stats
       end
-    rescue => e
+    rescue StandardError => e
       render_error e, options
       exit 1
     end
 
     desc 'uninstall GAME_IDENTIFIER', 'Uninstall game GAME_IDENTIFIER (id/name)'
-    option :repo, :aliases => ['-r'], type: :string, required: true, desc: "Which repo to use", enum: Gamerom::Repo.list.map(&:to_s)
-    option :platform, :aliases => ['-p'], type: :string, required: true, desc: "Which platform to use"
+    option :repo, aliases: ['-r'], type: :string, required: true, desc: 'Which repo to use', enum: Gamerom::Repo.list.map(&:to_s)
+    option :platform, aliases: ['-p'], type: :string, required: true, desc: 'Which platform to use'
     def uninstall(game_identifier)
       repo = Repo.new(options[:repo])
       validate_platform repo, options[:platform]
@@ -232,21 +240,21 @@ module Gamerom
         return
       end
       puts "uninstalling game #{game.id} - #{game.name} - #{game.region} on #{options[:platform]} platform..."
-      if !game.installed?
-        shell.say "Game is not installed", :yellow
+      unless game.installed?
+        shell.say 'Game is not installed', :yellow
         return
       end
       game.uninstall
-      shell.say "Game uninstalled", :green
-    rescue => e
+      shell.say 'Game uninstalled', :green
+    rescue StandardError => e
       render_error e, options
       exit 1
     end
 
     desc 'uninstall_all', 'Uninstall all games'
-    option :repo, :aliases => ['-r'], type: :string, required: true, desc: "Which repo to use", enum: Gamerom::Repo.list.map(&:to_s)
-    option :platform, :aliases => ['-p'], type: :string, required: true, desc: "Which platform to use"
-    option :region, :aliases => ['-g'], type: :string, required: false, desc: "Only from specified region"
+    option :repo, aliases: ['-r'], type: :string, required: true, desc: 'Which repo to use', enum: Gamerom::Repo.list.map(&:to_s)
+    option :platform, aliases: ['-p'], type: :string, required: true, desc: 'Which platform to use'
+    option :region, aliases: ['-g'], type: :string, required: false, desc: 'Only from specified region'
     def uninstall_all
       repo = Repo.new(options[:repo])
       validate_platform repo, options[:platform]
@@ -254,36 +262,36 @@ module Gamerom
       games.each do |game|
         uninstall(game.id) if game.installed?
       end
-    rescue => e
+    rescue StandardError => e
       render_error e, options
       exit 1
     end
 
     desc 'update_all_databases', 'Update all local databases'
-    option :repo, :aliases => ['-r'], type: :string, required: true, desc: "Which repo to use", enum: Gamerom::Repo.list.map(&:to_s)
+    option :repo, aliases: ['-r'], type: :string, required: true, desc: 'Which repo to use', enum: Gamerom::Repo.list.map(&:to_s)
     def update_all_databases
+      puts "updating all databases on #{options[:repo]} repo..."
       repo = Repo.new(options[:repo])
-      repo.platforms.keys.each do |platform|
-        a = Gamerom::Cli.new
-        a.options = { platform: platform, repo: options[:repo] }
-        a.update_database
+      repo.platforms.each_key do |platform|
+        repo = Repo.new(options[:repo])
+        repo.update_database platform
       end
       shell.say 'All game databases updated', :green
-    rescue => e
+    rescue StandardError => e
       render_error e, options
       exit 1
     end
 
     desc 'update_database', 'Update local database'
-    option :repo, :aliases => ['-r'], type: :string, required: true, desc: "Which repo to use", enum: Gamerom::Repo.list.map(&:to_s)
-    option :platform, :aliases => ['-p'], type: :string, required: true, desc: "Which platform to use"
+    option :repo, aliases: ['-r'], type: :string, required: true, desc: 'Which repo to use', enum: Gamerom::Repo.list.map(&:to_s)
+    option :platform, aliases: ['-p'], type: :string, required: true, desc: 'Which platform to use'
     def update_database
       repo = Repo.new(options[:repo])
       validate_platform repo, options[:platform]
       puts "updating #{options[:platform]} platform on #{options[:repo]} repo..."
       repo.update_database options[:platform]
       shell.say "Game database updated for platform #{options[:platform]} on #{options[:repo]} repo", :green
-    rescue => e
+    rescue StandardError => e
       render_error e, options
       exit 1
     end
@@ -294,6 +302,7 @@ module Gamerom
     end
 
     private
+
     def print_game_table(games)
       results = []
 
@@ -303,20 +312,23 @@ module Gamerom
           game.name,
           game.region,
           game.installed? ? shell.set_color('installed', :green) : '-',
+          game.respond_to?(:tags) ? game.tags.join(', ') : '-'
         ]
       end
       results.sort_by! { |columns| columns[1] }
-      results.unshift ['ID', 'NAME', 'REGION', 'INSTALLED']
+      results.unshift %w[ID NAME REGION INSTALLED TAGS]
       shell.print_table(results)
     end
 
-    def render_error exception, options
+    def render_error(exception, options)
       shell.say exception.message, :red
       shell.say exception.full_message.force_encoding('utf-8'), :red if options[:verbose]
     end
 
     def validate_platform(repo, platform)
-      raise "Expected '--platform' to be one of #{repo.platforms.keys.join(', ')}; got #{platform}" if !repo.platforms.keys.include? options[:platform]
+      return if repo.platforms.keys.include? options[:platform]
+
+      raise "Expected '--platform' to be one of #{repo.platforms.keys.join(", ")}; got #{platform}"
     end
   end
 end