romloader 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb0581eebe31d910a5866868c6767f86e59f90c1
-  data.tar.gz: b2ba39f821db26cbad47104292155e813a772d03
+  metadata.gz: 87a10ca23bd4fc1e499ef4240027008cc2a4d911
+  data.tar.gz: 953fe06a0b401c28467d65a00acbb7818f84c6ae
 SHA512:
-  metadata.gz: c8fef42a55aff86ac56bf4626c8d442d1d22399068b3ea2e156575c9dcca6a6c1d69e3fd686ab0d61f3b28e3de1e94756242c0ef766290ae9088e991153d991b
-  data.tar.gz: 17d045707749160b27a5c425ed247ef69f75dde87253731bed178d264ff6329f4d21bf61c03e593b55563dd86705a7f6029d29173d9306e338ea872ae587f6ac
+  metadata.gz: 0c3b71b8b3319c7d2f5a8ec434b87981d7307a36c4e968188f373b66ca1543b1b8fcb47012a13cb4ed38f3f5ffdfd48d159aab3800ea524490d4ff8b47571c1d
+  data.tar.gz: ac72b823b59ca07ac9677116f02264ce8343dc03cefc2aa11765be4e936f73bd2900459d4bf21d27eac81fd97344ce4c2a7a228d5fdc4a87ca758a67dc92da22

data/README.md

@@ -27,6 +27,8 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/jinstr
 
 ## Version Changes
 
+v. 1.1: Added basic rom download capability for Windows (requires Powershell v 3.0 or higher)
+
 v. 1.0: Changed the namespacing of classes, added zip/7-zip extraction and rom download directory management. Also, added the ability to open the newly downloaded game from the command line (requires a emulator)
 
 v. 0.0: Basic rom listing from Freeroms.com, and rom download feature

data/lib/romloader.rb

@@ -5,8 +5,10 @@ end
 require 'open-uri'
 require 'nokogiri'
 require 'cgi'
-require 'zip'
-require 'seven_zip_ruby'
+unless /cygwin|mswin|mingw|bccwin|wince|emx/ =~ RUBY_PLATFORM
+  require 'zip'
+  require 'seven_zip_ruby'
+end
 require 'fileutils'
 require_relative 'romloader/game_rom.rb'
 require_relative 'romloader/game_system.rb'

data/lib/romloader/archive_extractor.rb

@@ -3,53 +3,57 @@ class RomLoader::ArchiveExtractor
 
   #Extracts zip or 7-zip rom files, manages the extracted dirs, then deletes archive files
   def self.extract(dir,game_obj)
-    file_or_dir_to_open = ""
-    /(?<=\().+(?=\))/.match(game_obj.system.name) ? system_dir = /(?<=\().+(?=\))/.match(game_obj.system.name)[0] : system_dir = nil
-    system_dir ||= game_obj.system.name
-    system_dir = system_dir.rstrip.gsub(/[[[:space:]]\/]/, "_").downcase
-    Dir.mkdir(File.join(Dir.home,"videogame_roms",system_dir)) unless Dir.exist?(File.join(Dir.home,"videogame_roms",system_dir))
+    file_or_dir_to_open = nil
+    /(?<=\().+(?=\))/.match(game_obj.system.name) ? system_name = /(?<=\().+(?=\))/.match(game_obj.system.name)[0] : system_name = nil
+    system_name ||= game_obj.system.name
+    system_name = system_name.rstrip.gsub(/[[[:space:]]\/]/, "_").downcase
+    dir_w_system = File.join(Dir.home,"videogame_roms",system_name)
+    dir_game_name = game_obj.filename.split(game_obj.file_ext)[0]
+
+    Dir.mkdir(dir_w_system) unless Dir.exist?(dir_w_system)
     
     if game_obj.system.name != "MAME"
       puts "Extracting #{game_obj.filename}"
       if game_obj.file_ext == ".zip"
         Zip::File.open(dir) do |zip_archive|
           zip_archive.glob("*htm").each { |entry| zip_archive.remove(entry) }
-          Dir.mkdir(File.join(Dir.home,"videogame_roms",system_dir,game_obj.filename.split(game_obj.file_ext)[0])) if zip_archive.size > 1 && !Dir.exist?(File.join(Dir.home,"videogame_roms",system_dir,game_obj.filename.split(game_obj.file_ext)[0]))
+          Dir.mkdir(File.join(dir_w_system,dir_game_name)) if zip_archive.size > 1 && !Dir.exist?(File.join(dir_w_system,dir_game_name))
           zip_archive.each_entry do |rom|
-            if Dir.exist?(File.join(Dir.home,"videogame_roms",system_dir,game_obj.filename.split(game_obj.file_ext)[0]))
-              rom.extract(File.join(Dir.home,"videogame_roms",system_dir,game_obj.filename.split(game_obj.file_ext)[0],rom.name)) unless File.exist?(File.join(Dir.home,"videogame_roms",system_dir,game_obj.filename.split(game_obj.file_ext)[0],rom.name))
+            if Dir.exist?(File.join(dir_w_system,dir_game_name))
+              rom.extract(File.join(dir_w_system,dir_game_name,rom.name)) unless File.exist?(File.join(dir_w_system,dir_game_name,rom.name))
             else
-              rom.extract(File.join(Dir.home,"videogame_roms",system_dir,rom.name)) unless File.exist?(File.join(Dir.home,"videogame_roms",system_dir,rom.name))
+              rom.extract(File.join(dir_w_system,rom.name)) unless File.exist?(File.join(dir_w_system,rom.name))
             end
-            zip_archive.size == 1 ? file_or_dir_to_open = File.join(Dir.home,"videogame_roms",system_dir,"\"#{rom.name}\"") : file_or_dir_to_open = File.join(Dir.home,"videogame_roms",system_dir,game_obj.filename.split(game_obj.file_ext)[0])
+            zip_archive.size == 1 ? file_or_dir_to_open = File.join(dir_w_system,"\"#{rom.name}\"") : file_or_dir_to_open = File.join(dir_w_system,dir_game_name)
           end
         end
-      else
+      elsif game_obj.file_ext == ".7z"
         File.open(dir, "rb") do |seven_zip_archive|
-          Dir.mkdir(File.join(Dir.home,"videogame_roms",system_dir,game_obj.filename.split(game_obj.file_ext)[0])) unless Dir.exist?(File.join(Dir.home,"videogame_roms",system_dir,game_obj.filename.split(game_obj.file_ext)[0]))
           SevenZipRuby::Reader.open(seven_zip_archive) do |szr|
-            files_already_in_dir = Dir.entries(File.join(Dir.home,"videogame_roms",system_dir,game_obj.filename.split(game_obj.file_ext)[0]))
-            if files_already_in_dir.size > 0
-              files_to_be_extracted = szr.entries.select do |entry|
-                file_match = /(file, |dir, |anti, )[.[^\.]]+\..+(?=>)/.match(entry.inspect)
-                file_match ? file_name = file_match[0].split(file_match[1])[1] : file_name = nil
-                !files_already_in_dir.any? { |file|  file == file_name || file_name =~ /\.htm/}
-              end
-              szr.extract(files_to_be_extracted, File.join(Dir.home,"videogame_roms",system_dir,game_obj.filename.split(game_obj.file_ext)[0]))
+            if szr.entries.size > 2
+              Dir.mkdir(File.join(dir_w_system,dir_game_name)) unless Dir.exist?(File.join(dir_w_system,dir_game_name))
+              szr.extract_if(File.join(dir_w_system,dir_game_name)) { |entry| !/\.htm/.match(entry.inspect) }
+              file_or_dir_to_open = File.join(dir_w_system,dir_game_name)
             else
-              szr.extract_all(File.join(Dir.home,"videogame_roms",system_dir,game_obj.filename.split(game_obj.file_ext)[0]))
+              szr.extract_if(dir_w_system) do |entry|
+                game_name = /(?<=file, |dir, |anti, )[.[^\.]]+\..+(?=>)/.match(entry.inspect)[0] unless /\.htm/.match(entry.inspect)
+                !/\.htm/.match(entry.inspect)
+              end
+              file_or_dir_to_open = File.join(dir_w_system,"\"#{game_name}\"")
             end
           end
-          Dir.chdir(File.join(Dir.home,"videogame_roms",system_dir,game_obj.filename.split(game_obj.file_ext)[0])) do
-            Dir.entries(".").size == 1 ? file_or_dir_to_open = File.join(Dir.pwd,"\"#{Dir.entries(".").first}\"") : file_or_dir_to_open = Dir.pwd
-          end
         end
       end
       File.delete(dir)
       file_or_dir_to_open
     else
-      FileUtils.move "#{dir}", "#{File.join(Dir.home,"videogame_roms",system_dir)}"
-      file_or_dir_to_open = File.join(Dir.home,"videogame_roms",system_dir)
+      if game_obj.system.name == "MAME"
+        puts "NOTE: No archive extraction. MAME roms must remain zipped to play."
+      else
+        puts "NOTE: No archive extraction. Only Zip and 7-Zip extraction is supported."
+      end
+      FileUtils.move dir, dir_w_system
+      file_or_dir_to_open = dir_w_system
     end
   end
   

data/lib/romloader/freeroms_scraper.rb

@@ -12,7 +12,7 @@ class RomLoader::FreeromsScraper
           begin
             system_rom_url = system_info.attribute("href").value
           rescue NoMethodError
-            #Do Nothing, catch the error and move on. This is fine, because the hash will not be added to the array being compiled.
+            
           else
             game_system << {name: system_name, rom_index_url: system_rom_url}
           end
@@ -21,7 +21,8 @@ class RomLoader::FreeromsScraper
     end
   end
   
-  # To retrieve the names and main rom urls of the individual games currently begin served by freeroms.com.  Returns this information in the form of an array of hashes
+  # To retrieve the names and main rom urls of the individual games currently begin served by freeroms.com.
+  # Returns this information in the form of an array of hashes
   def self.rom_scrape(url)
     
     game_list = Nokogiri::HTML(open(url)).css("tr[class^=\"game\"] > td[align=\"left\"]")
@@ -30,7 +31,7 @@ class RomLoader::FreeromsScraper
         begin
           download_link = game_info.css("a").attribute("href").value
         rescue NoMethodError
-          #Do Nothing, catch the error and move on. This is fine, because the hash will not be added to the array being compiled. 
+          
         else
           game_name = game_info.css("span").text
           unless game_name == ""
@@ -43,7 +44,8 @@ class RomLoader::FreeromsScraper
     end
   end
 
-  # To retrieve the detailed information of individual games currently begin served by freeroms.com.  Returns this information in the form of a hash
+  # To retrieve the detailed information of individual games currently begin served by freeroms.com.
+  # Returns this information in the form of a hash
   def self.rom_details(url)
     
     direct_download = Nokogiri::HTML(open(url))
@@ -53,7 +55,7 @@ class RomLoader::FreeromsScraper
         begin
           game_url = /http:\/\/.+(\.zip|\.7z)/.match(direct_download.css("td#romss > script").first.children.first.text)
         rescue NoMethodError
-          #Do Nothing, catch the error and move on. This is fine, because the hash will be empty, which can be handled by GameRom#set_rom_details
+          
         else
           if game_url
             game[:download_url] = game_url[0]
@@ -70,7 +72,8 @@ class RomLoader::FreeromsScraper
     end
   end
 
-  # Purpose: To retrieve the letter indices for the roms of the game systems currently begin served by freeroms.com.  Returns this information in the form of a hash
+  # To retrieve the letter indices for the roms of the game systems currently begin served by freeroms.com.
+  # Returns this information in the form of a hash
   def self.rom_index_scrape(url)
     
     rom_letter_list = Nokogiri::HTML(open(url)).css("tr.letters > td[align=\"center\"] > font > a")
@@ -80,7 +83,7 @@ class RomLoader::FreeromsScraper
         begin
           letter_hash[letter] = letter_list.attribute("href").value if letter =~ /\A[A-Z#]\Z/
         rescue NoMethodError
-          #Do Nothing, catch the error and move on. This is fine, because the hash pair will not added.
+
         end
       end
     end

data/lib/romloader/game_rom.rb

@@ -1,11 +1,13 @@
 
-# The class whose instances represent an individual game rom (e.g. Chrono Trigger object)
+# The class whose instances represent an individual game rom
+# (e.g. Chrono Trigger object)
 class RomLoader::GameRom
   
   attr_accessor :name, :system
   attr_reader :rom_detail_url ,:download_url, :size, :file_ext, :filename
 
-  # Create individual game rom objects from information scraped from freeroms.com, and sets the required name and rom_detail_url instance variables
+  # Create individual game rom objects from information scraped from freeroms.com,
+  # then sets the required name and rom_detail_url instance variables
   def initialize(name:, rom_detail_url:)
     @name = name
     @rom_detail_url = rom_detail_url

data/lib/romloader/game_system.rb

@@ -1,5 +1,6 @@
 
-# The class whose instances represent an individual game system (e.g. Sega Genesis object) 
+# The class whose instances represent an individual game system
+# (e.g. Sega Genesis object) 
 class RomLoader::GameSystem
   
   attr_accessor :name, :rom_index_url
@@ -27,22 +28,25 @@ class RomLoader::GameSystem
     @@all    
   end
 
-  # Retrieves an array of all GameRom objects starting which the provided letter index (e.g. [Sonic the Hedgehog, Streets of Rage,...])
+  # Retrieves an array of all GameRom objects starting which the provided letter index
+  # (e.g. [Sonic the Hedgehog, Streets of Rage,...])
   def get_roms_by_letter(letter_index)
     @roms[letter_index]
   end
 
-  # Retrieves an array of the indicies for the roms (i.e. ["A","B","C"...])
+  # Retrieves an array of the indicies for the roms
+  # (i.e. ["A","B","C"...])
   def get_rom_indices
     @rom_indices.keys
   end
 
-  # Retrieves the url for roms of a particular letter index (e.g. "A" => "http://freeroms.com/genesis_games_that_start_with_a.html")
+  # Retrieves the url for roms of a particular letter index
+  # (e.g. "A" => "http://freeroms.com/genesis_games_that_start_with_a.html")
   def get_rom_collection_url(letter_index)
     @rom_indices[letter_index]
   end
 
-  # Add the game collection scraped from http://freeroms.com to the GameSystem object to the roms (Hash)
+  # Add the game collection scraped from http://freeroms.com to the GameSystem object to the roms Hash
   def add_roms_to_collection_by_letter(letter_index, game_obj_array)
 
     game_obj_array.each { |game| game.system = self }

data/lib/romloader/romloader_cli.rb

@@ -12,7 +12,7 @@ class RomLoader::RomLoaderCli
     input_stack = []
     control_flow_level = 1
 
-    puts "Thanks for using RomLoader, powered by freeroms.com!\nNOTE: To play these games, please download an emulator for the desired system.\nConnecting to freeroms.com and retrieving the systems index...\n\n"
+    puts "Thanks for using RomLoader, powered by freeroms.com!\nNOTE: To play the games, please download an emulator for the desired system.\nConnecting to freeroms.com and retrieving the systems index...\n\n"
     sleep 3
     while control_flow_level > 0 
       case control_flow_level
@@ -67,13 +67,15 @@ class RomLoader::RomLoaderCli
           input = input_prompt("Download? (Y/n) [exit]:", /[yn]/, control_flow_level)
           if input == 'y' || input == ""
             file_or_dir_to_open = download_rom(game)
-            if /\".+\"/.match(file_or_dir_to_open)
-              game_file = /\".+\"/.match(file_or_dir_to_open)[0]
-              input = input_prompt("Play #{game_file}? (Y/n) [exit]:", /[yn]/,control_flow_level)
-            else
-              input = input_prompt("Open #{file_or_dir_to_open}? (Y/n) [exit]:", /[yn]/,control_flow_level)
-            end
-            system("open #{file_or_dir_to_open}") if input == 'y' || input == ""
+            if file_or_dir_to_open
+              if /\".+\"/.match(file_or_dir_to_open)
+                game_file = /\".+\"/.match(file_or_dir_to_open)[0]
+                input = input_prompt("Play #{game_file}? (Y/n) [exit]:", /[yn]/,control_flow_level)
+              else
+                input = input_prompt("Open #{file_or_dir_to_open}? (Y/n) [exit]:", /[yn]/,control_flow_level)
+              end
+                system("open #{file_or_dir_to_open}") if input == 'y' || input == ""
+            end 
           end
           input_stack.shift
           input == "exit" ? control_flow_level = 0 : control_flow_level -= 1
@@ -97,7 +99,8 @@ class RomLoader::RomLoaderCli
     end
   end
 
-  # Lists the game systems scraped from http://freeroms.com and saved in Romloader::GameSystem.all (e.g. 1. Amiga, 2. Atari, etc...)
+  # Lists the game systems scraped from http://freeroms.com and saved in Romloader::GameSystem.all
+  # (e.g. 1. Amiga, 2. Atari, etc...)
   def list_systems 
     RomLoader::GameSystem.all.each_with_index { |game_system, index| puts "#{index+1}. #{game_system.name}"}
     print "\n"
@@ -108,7 +111,8 @@ class RomLoader::RomLoaderCli
     RomLoader::GameSystem.all[index-1]
   end
 
-  # List game index for the selected system by letter (e.g. A B C D...)
+  # List game index for the selected system by letter
+  # (e.g. A B C D...)
   def list_system_index(selected_system)
     if selected_system.get_rom_indices.empty?
       selected_system.rom_indices = RomLoader::FreeromsScraper.rom_index_scrape(selected_system.rom_index_url)
@@ -119,14 +123,16 @@ class RomLoader::RomLoaderCli
     puts "\n\n"
   end
 
-  # Retrieves all the games available for the selected system under the selected index (e.g. NES,"G")
+  # Retrieves all the games available for the selected system under the selected index
+  # (e.g. NES,"G")
   def select_game_collection_by_index(system, letter)
     puts "Loading roms...\n"
     games_list = system.get_roms_by_letter(letter)
     games_list ||= system.add_roms_to_collection_by_letter(letter,RomLoader::GameRom.create_collection(RomLoader::FreeromsScraper.rom_scrape(system.get_rom_collection_url(letter))))
   end
 
-  # List all the games available for the selected index (e.g. "S": 1. Super Castlevania, 2. Super Mario World, etc...)
+  # List all the games available for the selected index
+  # (e.g. "S": 1. Super Castlevania, 2. Super Mario World, etc...)
   def list_games(games)
     games.each_with_index {|game,index| puts "#{index+1}. #{game.name}"}
     print "\n"
@@ -138,7 +144,8 @@ class RomLoader::RomLoaderCli
     game_collection[index-1]
   end
 
-  # List the details of the selected game (e.g. Chrono Trigger | 5.38 MB | .zip)
+  # List the details of the selected game
+  # (e.g. Chrono Trigger | SNES | 5.38 MB | .zip)
   def display_rom_details(game)
     puts "Rom details:"
     puts "#{game.name} | System: #{game.system.name} | File size: #{game.size} | File type: #{game.file_ext}"
@@ -167,19 +174,27 @@ class RomLoader::RomLoaderCli
     input
   end
 
+  def isWindows?
+    /cygwin|mswin|mingw|bccwin|wince|emx/ =~ RUBY_PLATFORM
+  end
+
   # Downloads the selected game to the local directory (~/videogame_roms)
   def download_rom(game)
-    file_or_dir_to_open = ""
+    file_or_dir_to_open = nil
     puts "Downloading #{game.name} (#{game.size})..."
-    result = Dir.chdir(File.join(Dir.home,"videogame_roms")) { system("curl -Og# \"#{game.download_url}\"") }
+    if isWindows?
+      result = Dir.chdir(File.join(Dir.home,"videogame_roms")) { system("powershell -command \"& { Invoke-WebRequest '#{game.download_url}' -OutFile '#{game.filename}' }\"") }
+    else
+      result = Dir.chdir(File.join(Dir.home,"videogame_roms")) { system("curl -Og# \"#{game.download_url}\"") }
+    end
+    
     if result == true 
       puts "Finished downloading #{game.filename} to #{File.join(Dir.home,"videogame_roms")}.\n"
-      file_or_dir_to_open = RomLoader::ArchiveExtractor.extract(File.join(Dir.home,"videogame_roms",game.filename),game)
+      file_or_dir_to_open = RomLoader::ArchiveExtractor.extract(File.join(Dir.home,"videogame_roms",game.filename),game) unless isWindows?
     else
       puts "An error occured, the rom couldn't be downloaded.\n"
     end
-    sleep 3
-    puts "\n"
+    sleep 2
     file_or_dir_to_open
   end
   

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: romloader
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Efrain Perez Jr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-07 00:00:00.000000000 Z
+date: 2016-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -52,20 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
-- !ruby/object:Gem::Dependency
-  name: fileutils
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement