gamerom 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33c71545b14feb811985d98d9e1e4677b7101f7e86676865c50770eb53b99169
-  data.tar.gz: 3388785345996bdb7711c90150ad03cc8bc3cf08afaad281144690ce8da85144
+  metadata.gz: 597dfe815ad760060e224b1320e8c2fe3684ced9f41e722e14470a5861a5a4a1
+  data.tar.gz: 417408b1b42bdc2c01f55a1878e46d63052e3c74d4a829775d8378aaeb024a33
 SHA512:
-  metadata.gz: '0694ea12b96bac2fb769f0176ca0b459804eb1b955c51c44fb57dc60046d63136836a0b206c696fb6cbee9096c211d475cf038a9dc14c4a2ff43b232af3cd87d'
-  data.tar.gz: ff44e316119690d3732f629ff162af18feef6ccb512881063625b899782adf4d95100c9a49829e619f09c82ce4fb944bd793490d0358c0cc3bbbb36158d06603
+  metadata.gz: 1de1c51f9f57a6baeaca2ae3943ab4564e622d5857ca433a322bbc2022de5e9465c26711f4c92a7efeafa6996c82c89618fb165da51c0aed7b7fccd04f52e594
+  data.tar.gz: eaafa9d35704dbc2ebf352cc31d5ae7a20e964f3c07ecdc3a15c3ca914728ecf836948354758e2b000fef9eded8cba00b339f2308aaef2f3d2a1290512e77e22

data/.gitignore

@@ -9,3 +9,6 @@
 
 # rspec failure tracking
 .rspec_status
+
+# built gems
+*.gem

data/CHANGELOG.md

@@ -6,6 +6,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.7.0] - 2026-11-01
+- feat: recover - match files by normalized name and tags, so re-releases such as "Mega Man 2 (Capcom Town)" and editions such as "Jeopardy! Deluxe Edition" no longer end up in the plain game's state
+- feat: edgeemu and vimm repos - multi-region releases that include USA stay under USA, otherwise the alphabetically first region
+- feat: vimm repo - read the game region from the flags shown on the list pages instead of assuming USA
+- fix: vimm repo - list pages gained a media icon before the title link, which made update_database write empty databases
+- fix: update_database refuses to replace a populated database with an empty crawl
+- fix: honor Retry-After on 429 responses and keep updating the other databases when one platform fails
+
 ## [0.6.0] - 2026-11-01
 - feat: add edgeemu repo (https://edgeemu.net), 48 platforms
 - feat: recover - do not claim files that belong to a game with a longer name (e.g. "Kung-Fu" vs "Kung-Fu Master")
@@ -53,7 +61,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [0.1.0] - 2021-05-07
 - Initial release
 
-[Unreleased]: https://github.com/lucasmundim/gamerom/compare/v0.6.0...HEAD
+[Unreleased]: https://github.com/lucasmundim/gamerom/compare/v0.7.0...HEAD
+[0.7.0]: https://github.com/lucasmundim/gamerom/compare/v0.6.0...v0.7.0
 [0.6.0]: https://github.com/lucasmundim/gamerom/compare/v0.5.0...v0.6.0
 [0.5.0]: https://github.com/lucasmundim/gamerom/compare/v0.4.1...v0.5.0
 [0.4.1]: https://github.com/lucasmundim/gamerom/compare/v0.4.0...v0.4.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gamerom (0.6.0)
+    gamerom (0.7.0)
       mechanize (~> 2.14.2)
       mechanize-progressbar (~> 0.2.0)
       nokogiri (~> 1.19.4)

data/README.md

@@ -15,7 +15,7 @@ It currently supports the following repositories:
 Add this to your .bashrc, .bash_aliases, etc:
 
 ```
-alias gamerom="docker run -e UID=$(id -u) -e GROUP_ID=$(id -g) --rm -it -v ~/.gamerom:/home/runuser/.gamerom --platform=linux/amd64 docker.io/lucasmundim/gamerom:0.6.0"
+alias gamerom="docker run -e UID=$(id -u) -e GROUP_ID=$(id -g) --rm -it -v ~/.gamerom:/home/runuser/.gamerom --platform=linux/amd64 docker.io/lucasmundim/gamerom:0.7.0"
 ```
 
 Use it as:
@@ -618,7 +618,7 @@ Print program version
 
 ```
 $ gamerom version
-0.6.0
+0.7.0
 ```
 
 ## Development

data/gamerom.gemspec

@@ -16,7 +16,6 @@ Gem::Specification.new do |spec|
 
   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}/blob/master/CHANGELOG.md"
   spec.metadata['rubygems_mfa_required'] = 'true'

data/lib/gamerom/cli.rb

@@ -124,8 +124,8 @@ module Gamerom
       validate_platform repo, options[:platform]
       puts "recovering state of roms for #{options[:platform]} platform on #{options[:repo]} repo..."
       games = repo.games options[:platform]
-      game_names = games.to_h { |game| [game.id, game.name] }
-      results = games.group_by { |game| recover_game(game, game_names) }
+      parsed_names = games.to_h { |game| [game.id, parse_rom_name(game.name)] }
+      results = games.group_by { |game| recover_game(game, parsed_names) }
 
       print_recover_summary(results.fetch(:found, []), results.fetch(:already_installed, []), results.fetch(:not_found, []))
     rescue StandardError => e
@@ -268,11 +268,19 @@ module Gamerom
     def update_all_databases
       puts "updating all databases on #{options[:repo]} repo..."
       repo = Repo.new(options[:repo])
-      repo.platforms.each_key do |platform|
-        repo = Repo.new(options[:repo])
+      failed = repo.platforms.keys.reject do |platform|
         repo.update_database platform
+        true
+      rescue StandardError => e
+        shell.say "Error updating #{platform}: #{e.message}", :red
+        false
+      end
+      if failed.empty?
+        shell.say 'All game databases updated', :green
+      else
+        shell.say "Failed to update: #{failed.join(", ")}", :red
+        exit 1
       end
-      shell.say 'All game databases updated', :green
     rescue StandardError => e
       render_error e, options
       exit 1
@@ -327,7 +335,7 @@ module Gamerom
 
     # Recover helpers
 
-    def recover_game(game, game_names)
+    def recover_game(game, parsed_names)
       puts
       puts "Checking game #{game}"
       if game.filenames.any?
@@ -335,7 +343,7 @@ module Gamerom
         return :already_installed
       end
 
-      game_files = glob_game_files(game).select { |file| file_belongs_to_game?(file, game, game_names) }.sort
+      game_files = glob_game_files(game).select { |file| file_belongs_to_game?(file, game, parsed_names) }.sort
       if game_files.empty?
         puts "#{shell.set_color("*", :red)} not found"
         return :not_found
@@ -362,56 +370,29 @@ module Gamerom
         .gsub('(', '*\(')
     end
 
-    # A globbed file is kept for a game unless it is a better match for another
-    # game whose name starts with this game's name (e.g. "Kung-Fu" vs "Kung-Fu Master").
-    def file_belongs_to_game?(file, game, game_names)
-      filename = File.basename(file).downcase
-      return true if exact_filename_match?(filename, game.name.downcase)
-
-      number = sequel_number(game.name)
-      return true if number && filename.include?(number)
-      return true if game.name.include?('Limited Run Games') && filename.include?('limited_run')
-
-      !claimed_by_other_game?(filename, game, game_names)
-    end
-
-    # "Game.zip", "Game_Name.zip" or "Game (USA).zip"
-    def exact_filename_match?(filename, name)
-      [name, name.tr(' ', '_')].any? do |variant|
-        filename.match?(/\A#{Regexp.escape(variant)}(\s*\(\w+\))?\.\w+\z/i)
+    # A globbed file belongs to a game when, ignoring case and punctuation, the file name
+    # without its tags equals the game name without its tags, and every tag in the game
+    # name is present in the file. Among games with the same base name the one whose tags
+    # match the file best wins, so "Mega Man 2 (Capcom Town)" takes
+    # "Mega_Man_2_(USA)_(Capcom_Town).zip" and plain "Mega Man 2" leaves it alone.
+    def file_belongs_to_game?(file, game, parsed_names)
+      base, tags = parse_rom_name(File.basename(file).sub(/(\.[a-z0-9]{1,4})+\z/, '')) # strips ".zip", ".nkit.iso"
+      name_base, name_tags = parsed_names[game.id]
+      return false unless base == name_base && (name_tags - tags).empty?
+
+      parsed_names.none? do |other_id, (other_base, other_tags)|
+        other_id != game.id && other_base == base && (other_tags - tags).empty? && other_tags.size > name_tags.size
       end
     end
 
-    # The number that identifies a sequel, e.g. "2" in "Tony Hawk's Pro Skater 2"
-    def sequel_number(name)
-      match = name.match(/(\d+|\s+\d+)[\s':]/) || name.match(/\s(\d+)$/)
-      match && match[1].strip
+    # "Legend of Zelda, The: Ocarina of Time (USA) (GameCube)" => ["legendofzeldatheocarinaoftime", ["usa", "gamecube"]]
+    def parse_rom_name(str)
+      tags = str.scan(/[(\[]([^)\]]+)[)\]]/).flatten.map { |tag| normalize_rom_name(tag) }
+      [normalize_rom_name(str.gsub(/[(\[][^)\]]*[)\]]/, '')), tags]
     end
 
-    def claimed_by_other_game?(filename, game, game_names)
-      name = game.name.downcase
-      game_names.any? do |other_id, other_name|
-        next false if other_id == game.id
-
-        other = other_name.downcase
-        next false unless other.length > name.length && other.start_with?(name)
-
-        filename_matches_other_game?(filename, other_name)
-      end
-    end
-
-    def filename_matches_other_game?(filename, other_name)
-      other = other_name.downcase
-      other_underscored = other.tr(' ', '_')
-      return false unless filename.include?(other_underscored) || filename.include?(other)
-
-      number = sequel_number(other_name)
-      return filename.include?(number) if number
-
-      filename.start_with?(other_underscored) ||
-        filename.start_with?(other) ||
-        filename.include?(other_underscored.tr(':', '_')) ||
-        filename.include?(other.tr(':', '-'))
+    def normalize_rom_name(str)
+      str.downcase.gsub(/[^a-z0-9]/, '')
     end
 
     def print_recovered_files(game_files)

data/lib/gamerom/repo.rb

@@ -77,8 +77,14 @@ module Gamerom
 
     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)
+      database = "#{Gamerom::CACHE_DIR}/#{@name}/#{platform}.yml"
+      # An empty crawl means the site changed or blocked us; never wipe a good database over it.
+      if games.empty? && File.exist?(database) && !YAML.load_file(database).empty?
+        raise Gamerom::Error, "no games found for #{platform} on #{@name}, keeping the existing database"
+      end
+
+      FileUtils.mkdir_p(File.dirname(database))
+      File.write(database, games.to_yaml)
     end
   end
 end

data/lib/gamerom/repo_adapter.rb

@@ -2,12 +2,26 @@
 
 require 'nokogiri'
 require 'rest-client'
+require 'uri'
 
 module Gamerom
   # RepoAdapter - Common adapter methods
   module RepoAdapter
+    MAX_RETRIES = 5
+
+    # Sites rate limit the section crawl; honor the Retry-After of a 429 instead of failing.
     def nokogiri_get(url)
-      Nokogiri::HTML(RestClient.get(url))
+      retries = 0
+      loop do
+        return Nokogiri::HTML(RestClient.get(url))
+      rescue RestClient::TooManyRequests => e
+        retries += 1
+        raise if retries > MAX_RETRIES
+
+        delay = (e.response.headers[:retry_after] || 60).to_i
+        puts "\nrate limited by #{URI.parse(url).host}, retrying in #{delay}s (#{retries}/#{MAX_RETRIES})"
+        sleep delay
+      end
     end
 
     def games(platform)

data/lib/gamerom/repo_adapters/edgeemu.rb

@@ -105,10 +105,15 @@ module Gamerom
         }
       end
 
-      # "Espial (USA)" => "USA", "Game (USA, Europe) (Proto)" => "USA, Europe"
+      # One region per game from the No-Intro tags: "Espial (USA)" => "USA".
+      # Multi-region releases that include USA stay under USA ("Game (USA, Europe)" => "USA"),
+      # otherwise the alphabetically first region ("Game (Japan, Europe)" => "Europe").
       def self.region(name)
-        groups = name.scan(/\(([^)]+)\)/).flatten
-        groups.find { |group| REGIONS.include?(group.split(',').first.strip) } || 'Unknown'
+        groups = name.scan(/\(([^)]+)\)/).flatten.map { |group| group.split(',').map(&:strip) }
+        regions = groups.find { |tokens| REGIONS.include?(tokens.first) }
+        return 'Unknown' unless regions
+
+        regions.include?('USA') ? 'USA' : regions.min
       end
 
       def self.install(game)

data/lib/gamerom/repo_adapters/vimm.rb

@@ -52,21 +52,36 @@ module Gamerom
       def self.extract_games(platform)
         sections.each_with_index do |section, index|
           page = nokogiri_get("https://vimm.net/vault/?p=list&system=#{platform}&section=#{section}")
-          game_links = page.css('table.hovertable td:first-child a:first-child')
-          yield game_links.map { |game_link| game(game_link) }, index
+          rows = page.css('table.hovertable tr').select { |row| row.at_css(TITLE_LINK) }
+          yield rows.map { |row| game(row) }, index
         rescue RestClient::NotFound
           yield [], index
         end
       end
 
-      def self.game(game_link)
+      # Each row: <td><img class="media-icon"><a href="/vault/2640">Mace: The Dark Age</a></td>
+      #           <td><img class="flag" title="USA"></td>...
+      TITLE_LINK = 'td:first-child a[href^="/vault/"]'
+
+      def self.game(row)
+        link = row.at_css(TITLE_LINK)
         {
-          id: game_link['href'].split('/').last.to_i,
-          name: game_link.text,
-          region: 'USA',
+          id: link['href'].split('/').last.to_i,
+          name: link.text,
+          region: region(row),
         }
       end
 
+      # One region per game, taken from the flag icons. Multi-region releases that include
+      # USA stay under USA, so the vault keeps its US-centric layout; otherwise the
+      # alphabetically first flag.
+      def self.region(row)
+        flags = row.css('img.flag').map { |flag| flag['title'] }.compact
+        return 'USA' if flags.empty? || flags.include?('USA')
+
+        flags.min
+      end
+
       # Vimm's Lair protects game pages with a browser challenge, so games have to be
       # downloaded by hand. Prepare the target directory and tell the user what to do.
       def self.install(game)

data/lib/gamerom/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Gamerom
-  VERSION = '0.6.0'
+  VERSION = '0.7.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gamerom
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Lucas Mundim
@@ -139,7 +139,6 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/lucasmundim/gamerom
   source_code_uri: https://github.com/lucasmundim/gamerom
   changelog_uri: https://github.com/lucasmundim/gamerom/blob/master/CHANGELOG.md
   rubygems_mfa_required: 'true'