rom-distillery 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c93dc6ca08201ccc0ba94c522c397149ee26b5ce2419755c5411d008d62df25c
+  data.tar.gz: 3bc0071cf61768f4bfe946f3cb53e07919a81b7f1c73fdd68e102bd62b4705bc
+SHA512:
+  metadata.gz: 9ccca87474a1cdb94e11f12b1898aa624b7d289880ff11fc732f0ba8cde4324ea899012c96783f820a155139ed433b75388766b975e1ba234f0a9ea5b33eb00f
+  data.tar.gz: 508208b41b94c7e4c1aadb6a132bc43e4a54de063a7ea88e3fe5e39c6541af9479b03c78341bc0d0607739d8db9c99bd891a7523059829152b74ae9600276092

data/Gemfile

@@ -0,0 +1,6 @@
+# -*- ruby -*-
+
+source 'https://rubygems.org'
+
+gemspec
+

data/LICENSE

@@ -0,0 +1,287 @@
+                      EUROPEAN UNION PUBLIC LICENCE v. 1.2
+                      EUPL © the European Union 2007, 2016
+
+This European Union Public Licence (the ‘EUPL’) applies to the Work (as defined
+below) which is provided under the terms of this Licence. Any use of the Work,
+other than as authorised under this Licence is prohibited (to the extent such
+use is covered by a right of the copyright holder of the Work).
+
+The Work is provided under the terms of this Licence when the Licensor (as
+defined below) has placed the following notice immediately following the
+copyright notice for the Work:
+
+        Licensed under the EUPL
+
+or has expressed by any other means his willingness to license under the EUPL.
+
+1. Definitions
+
+In this Licence, the following terms have the following meaning:
+
+- ‘The Licence’: this Licence.
+
+- ‘The Original Work’: the work or software distributed or communicated by the
+  Licensor under this Licence, available as Source Code and also as Executable
+  Code as the case may be.
+
+- ‘Derivative Works’: the works or software that could be created by the
+  Licensee, based upon the Original Work or modifications thereof. This Licence
+  does not define the extent of modification or dependence on the Original Work
+  required in order to classify a work as a Derivative Work; this extent is
+  determined by copyright law applicable in the country mentioned in Article 15.
+
+- ‘The Work’: the Original Work or its Derivative Works.
+
+- ‘The Source Code’: the human-readable form of the Work which is the most
+  convenient for people to study and modify.
+
+- ‘The Executable Code’: any code which has generally been compiled and which is
+  meant to be interpreted by a computer as a program.
+
+- ‘The Licensor’: the natural or legal person that distributes or communicates
+  the Work under the Licence.
+
+- ‘Contributor(s)’: any natural or legal person who modifies the Work under the
+  Licence, or otherwise contributes to the creation of a Derivative Work.
+
+- ‘The Licensee’ or ‘You’: any natural or legal person who makes any usage of
+  the Work under the terms of the Licence.
+
+- ‘Distribution’ or ‘Communication’: any act of selling, giving, lending,
+  renting, distributing, communicating, transmitting, or otherwise making
+  available, online or offline, copies of the Work or providing access to its
+  essential functionalities at the disposal of any other natural or legal
+  person.
+
+2. Scope of the rights granted by the Licence
+
+The Licensor hereby grants You a worldwide, royalty-free, non-exclusive,
+sublicensable licence to do the following, for the duration of copyright vested
+in the Original Work:
+
+- use the Work in any circumstance and for all usage,
+- reproduce the Work,
+- modify the Work, and make Derivative Works based upon the Work,
+- communicate to the public, including the right to make available or display
+  the Work or copies thereof to the public and perform publicly, as the case may
+  be, the Work,
+- distribute the Work or copies thereof,
+- lend and rent the Work or copies thereof,
+- sublicense rights in the Work or copies thereof.
+
+Those rights can be exercised on any media, supports and formats, whether now
+known or later invented, as far as the applicable law permits so.
+
+In the countries where moral rights apply, the Licensor waives his right to
+exercise his moral right to the extent allowed by law in order to make effective
+the licence of the economic rights here above listed.
+
+The Licensor grants to the Licensee royalty-free, non-exclusive usage rights to
+any patents held by the Licensor, to the extent necessary to make use of the
+rights granted on the Work under this Licence.
+
+3. Communication of the Source Code
+
+The Licensor may provide the Work either in its Source Code form, or as
+Executable Code. If the Work is provided as Executable Code, the Licensor
+provides in addition a machine-readable copy of the Source Code of the Work
+along with each copy of the Work that the Licensor distributes or indicates, in
+a notice following the copyright notice attached to the Work, a repository where
+the Source Code is easily and freely accessible for as long as the Licensor
+continues to distribute or communicate the Work.
+
+4. Limitations on copyright
+
+Nothing in this Licence is intended to deprive the Licensee of the benefits from
+any exception or limitation to the exclusive rights of the rights owners in the
+Work, of the exhaustion of those rights or of other applicable limitations
+thereto.
+
+5. Obligations of the Licensee
+
+The grant of the rights mentioned above is subject to some restrictions and
+obligations imposed on the Licensee. Those obligations are the following:
+
+Attribution right: The Licensee shall keep intact all copyright, patent or
+trademarks notices and all notices that refer to the Licence and to the
+disclaimer of warranties. The Licensee must include a copy of such notices and a
+copy of the Licence with every copy of the Work he/she distributes or
+communicates. The Licensee must cause any Derivative Work to carry prominent
+notices stating that the Work has been modified and the date of modification.
+
+Copyleft clause: If the Licensee distributes or communicates copies of the
+Original Works or Derivative Works, this Distribution or Communication will be
+done under the terms of this Licence or of a later version of this Licence
+unless the Original Work is expressly distributed only under this version of the
+Licence — for example by communicating ‘EUPL v. 1.2 only’. The Licensee
+(becoming Licensor) cannot offer or impose any additional terms or conditions on
+the Work or Derivative Work that alter or restrict the terms of the Licence.
+
+Compatibility clause: If the Licensee Distributes or Communicates Derivative
+Works or copies thereof based upon both the Work and another work licensed under
+a Compatible Licence, this Distribution or Communication can be done under the
+terms of this Compatible Licence. For the sake of this clause, ‘Compatible
+Licence’ refers to the licences listed in the appendix attached to this Licence.
+Should the Licensee's obligations under the Compatible Licence conflict with
+his/her obligations under this Licence, the obligations of the Compatible
+Licence shall prevail.
+
+Provision of Source Code: When distributing or communicating copies of the Work,
+the Licensee will provide a machine-readable copy of the Source Code or indicate
+a repository where this Source will be easily and freely available for as long
+as the Licensee continues to distribute or communicate the Work.
+
+Legal Protection: This Licence does not grant permission to use the trade names,
+trademarks, service marks, or names of the Licensor, except as required for
+reasonable and customary use in describing the origin of the Work and
+reproducing the content of the copyright notice.
+
+6. Chain of Authorship
+
+The original Licensor warrants that the copyright in the Original Work granted
+hereunder is owned by him/her or licensed to him/her and that he/she has the
+power and authority to grant the Licence.
+
+Each Contributor warrants that the copyright in the modifications he/she brings
+to the Work are owned by him/her or licensed to him/her and that he/she has the
+power and authority to grant the Licence.
+
+Each time You accept the Licence, the original Licensor and subsequent
+Contributors grant You a licence to their contributions to the Work, under the
+terms of this Licence.
+
+7. Disclaimer of Warranty
+
+The Work is a work in progress, which is continuously improved by numerous
+Contributors. It is not a finished work and may therefore contain defects or
+‘bugs’ inherent to this type of development.
+
+For the above reason, the Work is provided under the Licence on an ‘as is’ basis
+and without warranties of any kind concerning the Work, including without
+limitation merchantability, fitness for a particular purpose, absence of defects
+or errors, accuracy, non-infringement of intellectual property rights other than
+copyright as stated in Article 6 of this Licence.
+
+This disclaimer of warranty is an essential part of the Licence and a condition
+for the grant of any rights to the Work.
+
+8. Disclaimer of Liability
+
+Except in the cases of wilful misconduct or damages directly caused to natural
+persons, the Licensor will in no event be liable for any direct or indirect,
+material or moral, damages of any kind, arising out of the Licence or of the use
+of the Work, including without limitation, damages for loss of goodwill, work
+stoppage, computer failure or malfunction, loss of data or any commercial
+damage, even if the Licensor has been advised of the possibility of such damage.
+However, the Licensor will be liable under statutory product liability laws as
+far such laws apply to the Work.
+
+9. Additional agreements
+
+While distributing the Work, You may choose to conclude an additional agreement,
+defining obligations or services consistent with this Licence. However, if
+accepting obligations, You may act only on your own behalf and on your sole
+responsibility, not on behalf of the original Licensor or any other Contributor,
+and only if You agree to indemnify, defend, and hold each Contributor harmless
+for any liability incurred by, or claims asserted against such Contributor by
+the fact You have accepted any warranty or additional liability.
+
+10. Acceptance of the Licence
+
+The provisions of this Licence can be accepted by clicking on an icon ‘I agree’
+placed under the bottom of a window displaying the text of this Licence or by
+affirming consent in any other similar way, in accordance with the rules of
+applicable law. Clicking on that icon indicates your clear and irrevocable
+acceptance of this Licence and all of its terms and conditions.
+
+Similarly, you irrevocably accept this Licence and all of its terms and
+conditions by exercising any rights granted to You by Article 2 of this Licence,
+such as the use of the Work, the creation by You of a Derivative Work or the
+Distribution or Communication by You of the Work or copies thereof.
+
+11. Information to the public
+
+In case of any Distribution or Communication of the Work by means of electronic
+communication by You (for example, by offering to download the Work from a
+remote location) the distribution channel or media (for example, a website) must
+at least provide to the public the information requested by the applicable law
+regarding the Licensor, the Licence and the way it may be accessible, concluded,
+stored and reproduced by the Licensee.
+
+12. Termination of the Licence
+
+The Licence and the rights granted hereunder will terminate automatically upon
+any breach by the Licensee of the terms of the Licence.
+
+Such a termination will not terminate the licences of any person who has
+received the Work from the Licensee under the Licence, provided such persons
+remain in full compliance with the Licence.
+
+13. Miscellaneous
+
+Without prejudice of Article 9 above, the Licence represents the complete
+agreement between the Parties as to the Work.
+
+If any provision of the Licence is invalid or unenforceable under applicable
+law, this will not affect the validity or enforceability of the Licence as a
+whole. Such provision will be construed or reformed so as necessary to make it
+valid and enforceable.
+
+The European Commission may publish other linguistic versions or new versions of
+this Licence or updated versions of the Appendix, so far this is required and
+reasonable, without reducing the scope of the rights granted by the Licence. New
+versions of the Licence will be published with a unique version number.
+
+All linguistic versions of this Licence, approved by the European Commission,
+have identical value. Parties can take advantage of the linguistic version of
+their choice.
+
+14. Jurisdiction
+
+Without prejudice to specific agreement between parties,
+
+- any litigation resulting from the interpretation of this License, arising
+  between the European Union institutions, bodies, offices or agencies, as a
+  Licensor, and any Licensee, will be subject to the jurisdiction of the Court
+  of Justice of the European Union, as laid down in article 272 of the Treaty on
+  the Functioning of the European Union,
+
+- any litigation arising between other parties and resulting from the
+  interpretation of this License, will be subject to the exclusive jurisdiction
+  of the competent court where the Licensor resides or conducts its primary
+  business.
+
+15. Applicable Law
+
+Without prejudice to specific agreement between parties,
+
+- this Licence shall be governed by the law of the European Union Member State
+  where the Licensor has his seat, resides or has his registered office,
+
+- this licence shall be governed by Belgian law if the Licensor has no seat,
+  residence or registered office inside a European Union Member State.
+
+Appendix
+
+‘Compatible Licences’ according to Article 5 EUPL are:
+
+- GNU General Public License (GPL) v. 2, v. 3
+- GNU Affero General Public License (AGPL) v. 3
+- Open Software License (OSL) v. 2.1, v. 3.0
+- Eclipse Public License (EPL) v. 1.0
+- CeCILL v. 2.0, v. 2.1
+- Mozilla Public Licence (MPL) v. 2
+- GNU Lesser General Public Licence (LGPL) v. 2.1, v. 3
+- Creative Commons Attribution-ShareAlike v. 3.0 Unported (CC BY-SA 3.0) for
+  works other than software
+- European Union Public Licence (EUPL) v. 1.1, v. 1.2
+- Québec Free and Open-Source Licence — Reciprocity (LiLiQ-R) or Strong
+  Reciprocity (LiLiQ-R+).
+
+The European Commission may update this Appendix to later versions of the above
+licences without producing a new version of the EUPL, as long as they provide
+the rights granted in Article 2 of this Licence and protect the covered Source
+Code from exclusive appropriation.
+
+All other changes or additions to this Appendix require the production of a new
+EUPL version.

data/README.md

@@ -0,0 +1,24 @@
+Requirements
+============
+* The 7z, zip, unzip programs
+
+
+Usage
+=====
+
+~~~sh
+# Get help
+rhum --help
+
+# Validat ROMs against DAT file
+rhum -D ${datfile} validate ${rom_directory}
+
+# Repack archive using 7z format
+rhum repack -F 7z ${rom_directory}
+
+# Generate checksum index
+rhum index ${rom_directory}
+
+# Save ROM header to the specified directory
+rhum -D ${header_dir} header ${rom_directory}
+~~~

data/bin/rhum

@@ -0,0 +1,6 @@
+#!/usr/local/bin/ruby
+
+require 'distillery'
+require 'distillery/cli'
+
+Distillery::CLI.run

data/distillery.gemspec

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+$:.unshift File.expand_path("../lib", __FILE__)
+require "distillery/version"
+
+# NOTE: 'distillery' name is taken but not used since 2012
+#       https://rubygems.org/gems/distillery
+
+Gem::Specification.new do |s|
+  s.name          = "rom-distillery"	
+  s.version       = Distillery::VERSION
+  s.platform      = Gem::Platform::RUBY
+  s.licenses      = [ 'EUPL-1.2' ]
+  s.summary       = "ROM manager"
+  s.description   = "Help organise emulation ROM using DAT file"
+
+  s.required_ruby_version = '>= 2.5'
+  
+  s.authors       = ["Stephane D'Alu"]
+  s.email         = ["sdalu@sdalu.com"]
+  s.homepage      = "http://github.com/sdalu/distillery"
+
+  s.add_dependency 'nokogiri'
+  s.add_dependency 'rubyzip'
+  s.add_dependency 'tty-screen'
+  s.add_dependency 'tty-logger'
+  s.add_dependency 'tty-spinner'
+  s.add_dependency 'tty-progressbar'
+  
+  s.add_development_dependency "yard"
+  s.add_development_dependency "rake"
+
+  s.executables   = [ 'rhum' ]
+  s.files         =  %w[ LICENSE README.md Gemfile distillery.gemspec ] +
+		     Dir['lib/**/*.rb'  ] +
+                     Dir['lib/**/*.yaml']
+  
+end
+

data/lib/distillery.rb

@@ -0,0 +1,10 @@
+# SPDX-License-Identifier: EUPL-1.2
+
+# ROM Manager
+#
+module Distillery
+end
+
+require_relative 'distillery/version'
+require_relative 'distillery/datfile'
+require_relative 'distillery/storage'

data/lib/distillery/archiver.rb

@@ -0,0 +1,372 @@
+# coding: utf-8
+# SPDX-License-Identifier: EUPL-1.2
+
+require 'set'
+
+require_relative 'archiver/archive'
+
+module Distillery
+
+    
+# @abstract
+# Allow processing of archives
+#
+class Archiver
+    include Enumerable
+
+    # Standard error for Archiver class and subclasses
+    class Error           < StandardError
+    end
+
+    # Notification of not archiver found
+    class ArchiverNotFound < Error
+    end
+
+    # Excution error for external process
+    class ExecError       < Error
+    end
+
+    # Processing error when dealing with archive
+    class ProcessingError < Error
+    end
+
+    # InputStream used by Archiver#reader
+    class InputStream
+        def initialize(io)
+            @io = io
+        end
+
+        # Read data
+        #
+        # @param length [Integer, nil]	number of bytes to read,
+        #				whole data if nil
+        #
+        # @return [String, nil]		data or nil if end of stream
+        #
+        def read(length=nil)
+            @io.read(length)
+        end
+    end
+
+    # OutputStream used by Archiver#writer
+    class OutputStream
+        def initialize(io)
+            @io = io
+        end
+
+        # Write data
+        #
+        # @param data [String]			date to write
+        #
+        # @return [Integer]			number of bytes written
+        #
+        def write(data)
+            @io.write(data)
+        end
+    end
+
+
+    # @!visibility private
+    @@logger     = nil
+
+    # @!visibility private
+    @@providers  = []
+
+    # @!visibility private
+    @@archivers  = Set.new
+
+    # @!visibility private
+    @@mimetypes  = {}
+
+    # @!visibility private
+    @@extensions = {}
+
+
+    
+    # Register a logger
+    #
+    # @param logger [Logger,nil]	logger
+    #
+    # @return logger
+    #
+    def self.logger=(logger)
+        @@logger = logger
+    end
+
+
+    # Get the regisered logger
+    #
+    # @return [Logger,nil]
+    #
+    def self.logger
+        @@logger
+    end
+    
+    
+    # Add an archiver provider class
+    #
+    # @param provider [Class]		archiver provider
+    #
+    # @return [self]
+    #
+    def self.add(provider)
+        @@providers << provider
+        self
+    end
+
+
+    # List of archivers' providers in loading order.
+    #
+    # @return [Array<Class>]			Archiver class
+    #
+    def self.providers
+        # Could be done by looking at constants
+        #   constants.lazy.map {|c| const_get(c) }.select {|k| k < self }.to_a
+        # But we want to keep loading order
+        @@providers
+    end
+
+    
+    # Perform automatic registration of all the archive providers
+    #
+    # @return [self]
+    #
+    def self.registering
+        self.providers.each do |p|
+            p.registering
+        end
+        self
+    end
+
+
+
+    # Register an archiver.
+    #
+    # @param [Archiver] archiver		Archiver to register
+    # @param [Boolean] warnings			Emit warning when overriding
+    #
+    def self.register(archiver, warnings: true)
+        # Notifier
+        notify = if warnings
+                     ->(type, key, old, new) {
+                         oname = old.class.name.split('::').last
+                         nname = new.class.name.split('::').last
+                         Archiver.logger&.warn {
+                             "#{self} overriding #{type} for #{key}" \
+                             " [#{oname} -> #{nname}]"
+                         }
+                     }
+                 end
+
+        # Add archiver
+        @@archivers.add(archiver)
+
+        # Register mimetypes
+        Array(archiver.mimetypes).each {|mt|
+            @@mimetypes.merge!(mt => archiver) {|key, old, new|
+                notify&.call("mimetype", key, old, new)
+                new
+            }
+        }
+        # Register extensions
+        Array(archiver.extensions).each {|ext|
+            @@extensions.merge!(ext.downcase => archiver) {|key, old, new|
+                notify&.call("extension", key, old, new)
+                new
+            }
+        }
+        # Return archiver
+        archiver
+    end
+
+    
+    # List of registered archivers
+    #
+    # @return [Array<Archiver>]
+    #
+    def self.archivers
+        @@archivers.to_a
+    end
+
+    
+    # Archiver able to process the selected mimetype
+    #
+    def self.for_mimetype(mimetype)
+        @@mimetypes[mimetype]
+    end
+
+    
+    # Archiver able to process the selected extension
+    #
+    def self.for_extension(extension)
+        extension = extension[1..-1] if extension[0] == '.'
+        @@extensions[extension.downcase]
+    end
+
+    
+    # Archiver able to process the selected file.
+    #
+    # @param [String] file	archive file tpo consider
+    #
+    # @return [Archiver]	archiver to use for processing file
+    # @return [nil]		no matching archiver found
+    #
+    def self.for_file(file)
+        # Find by extension
+        parts      = File.basename(file).split('.')
+        extlist    = 1.upto(parts.size-1).map {|i| parts[i..-1].join('.') }
+        archiver   = extlist.lazy.map  {|ext| self.for_extension(ext) }
+                                 .find {|arc| ! arc.nil?              }
+
+        # Find by mimetype if previously failed
+        archiver ||= if defined?(MimeMagic)
+                         begin
+                             File.open(file) {|io|
+                                 self.for_mimetype(MimeMagic.by_magic(io))
+                             }
+                         rescue Errno::ENOENT
+                         end
+                     end
+
+        # Return found archiver (or nil)
+        archiver
+    end
+
+
+    # Return an archive instance of the specified file, or invokes the block
+    # with the archive instance passed as parameter.
+    #
+    # @overload for(file)
+    #  @param file [String]		archive file
+    #
+    #  @raise [ArchiverNotFound]	an archiver able to process this file
+    #					has not been found
+    #
+    #  @return [Archive]		archive instance
+    #
+    # @overload for(file)
+    #  @param file [String]		archive file
+    #
+    #  @yieldparam archive [Archive]	archive instance
+    #
+    #  @raise [ArchiverNotFound]	an archiver able to process this file
+    #					has not been found
+    #
+    #  @return [self]    
+    #
+    def self.for(file)
+        archive = Archive.new(file)
+        if block_given?
+            yield(archive)
+            self
+        else
+            archive
+        end
+    end
+
+
+
+
+    
+    def initialize
+        raise "abstract class"
+    end
+
+    
+    # List of supported extensions
+    #
+    # @return [Array<String>]
+    #
+    def extensions
+        [ 'zip' ]
+    end
+
+    
+    # List of supported mimetypes
+    #
+    # @return [Array<String>]
+    #
+    def mimetypes
+        [ 'application/zip' ]
+    end
+    
+    
+    # Iterate over each archive entry
+    #
+    # @param file [String]		archive file
+    #
+    # @yieldparam entry [String]
+    # @yieldparam io    [InputStream]
+    #
+    # @return [self,Enumerator]
+    #
+    def each(file, &block)
+        raise "abstract method"
+    end
+
+
+    # Check if the archive contains no entry
+    #
+    # @param file [String]		archive file
+    #
+    # @return [Boolean]
+    #
+    def empty?(file)
+        ! each(file).any?
+    end
+
+    
+    # List archive entries
+    #
+    # @param file [String]		archive file
+    #
+    # @return [Array<String>]
+    #
+    def entries(file)
+        each(file).map {|a_entry, _| a_entry }
+    end
+
+    
+    # Allow to perform read operation on an archive entry
+    #
+    # @param file  [String]		archive file
+    # @param entry [String]		entry name
+    #
+    # @yieldparam io [InputStream]	input stream for reading
+    #
+    # @return 				block value
+    #
+    def reader(file, entry, &block)
+        each(file) {|a_entry, a_io|
+            next unless a_entry == entry
+            return block.call(a_io)
+        }
+    end
+
+
+    # Allow to perform write operation on an archive entry
+    #
+    # @param file  [String]		archive file
+    # @param entry [String]		entry name
+    #
+    # @yieldparam io [OutputStream]	output stream for writing
+    #
+    # @return 				block value
+    #
+    def writer(file, entry, &block)
+        nil
+    end
+
+    
+    # Delete the entry from the archive
+    #
+    # @param file  [String]		archive file
+    # @param entry [String]		entry name
+    #
+    # @return [Boolean]		operation status
+    #
+    def delete!(file, entry)
+        false
+    end
+end
+end