mmi 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac664a5f071c4eeb437b6e1f501130373baa722e3e97277bd627de91db6340b0
-  data.tar.gz: ec0937a098b99dd02302ee3c0256ad1d6e3e3e6f14e7ef72e76dfb7924e52beb
+  metadata.gz: 84c944c267d13afff856179fd1a089d1ff6213a865e256f6c2678ed7f24e09ee
+  data.tar.gz: 3da84073781c7e7a185e3e9f03fba104649c1b695b25bc4aa74e90b6cdc8e6da
 SHA512:
-  metadata.gz: 7eac5b99470ab80d174bdac020fd0f2872907d2bc2fc117ac102806d5dc6a2a58e410b6f96811376a0d8c32d8970c155b119ecf1d6620436211769b011676b4b
-  data.tar.gz: 600c32a227d7458a3f034e00c40347fd35bf11a4699f76ebd35521d9ee5a366e55740b70cfe8122ab96b468c9b985131cfc7218468231ed0c5c9edb8a04ce7ad
+  metadata.gz: 1bf673321a3ccdef9c310af18e841b0a74278154ee83f5cc37c777a56ba1a370edf77b9f2d589f62b153ed0f12884f527e0ce6ba7045711be17fcaf77e1874ea
+  data.tar.gz: 3fdd21c1b7f0e002e12d4851f7369697fb2d5b61685ef26b44a54643ef48ffb87b2a7297c639def93c5e30972da147ecca10918235d2d63bb625768dc04ef23e

data/README.adoc

@@ -115,15 +115,11 @@ There, within the same minor version, backwards compatibility can be expected, b
 
 == Contributing
 
-Contributions are very welcome, as well as feature/bug requests.
-
-In case you want to implement a feature, it would be best to create an issue beforehand so that we can discuss it.
-This reduces the chance of a pull request being rejected.
+Contributions are very welcome, including feature/bug requests.
+Before implementing a (larger) feature, consider opening a ticket to discuss the implementation or feature.
 
 If you intend to create a pull request, please choose a branch name describing its changes (i.e. not some generic term like `master` or `fix`, but e.g. `fix_typo` or `add_interactive_update_command`).
 
-Please be aware that I have a very specific code style and am interested in keeping it in this repository.
-Some basic rules are specified in the `.editorconfig` file, which your editor should support.
-Additionally, Rubocop has been configured using the existing code and every commit should pass Rubocop’s inspection.
-There most likely are a lot of Rubocop rules that are currently not triggered and therefore not configured.
-In such a case, either try to derive a style from existing code or feel free to ask.
+Please try to follow the existing coding style as close as possible.
+Some basic rules are specified in the `.editorconfig` file, and Rubocop is also available to help.
+Every commit should pass Rubocop’s inspection.

data/exe/mmi

@@ -12,7 +12,7 @@ def processor(file)
 	content = Psych.load_file(file)
 	
 	begin
-		Mmi::ModFileProcessor.new(content)
+		Mmi::ModFileProcessor.parse(content)
 	rescue Mmi::ValidationError => e
 		puts e
 		Kernel.exit 1

data/lib/mmi/asset.rb

@@ -0,0 +1,16 @@
+require 'mmi/property_attributes'
+require 'mmi/source/github'
+require 'mmi/source/modrinth'
+require 'mmi/source/url'
+
+module Mmi
+	class Asset
+		prepend Mmi::PropertyAttributes
+		
+		property :source, type: {field: 'type', types: {'github' => Source::Github, 'modrinth' => Source::Modrinth, 'url' => Source::Url}}
+		
+		def install(install_record)
+			source.install(install_record)
+		end
+	end
+end

data/lib/mmi/assets_processor.rb

@@ -1,53 +1,22 @@
-require 'mmi/option_attributes'
-require 'mmi/source/github'
-require 'mmi/source/modrinth'
-require 'mmi/source/url'
+require 'mmi/constants'
+require 'mmi/property_attributes'
+require 'mmi/asset'
+require 'mmi/install_record'
 
 module Mmi
 	class AssetsProcessor
-		include OptionAttributes
+		prepend PropertyAttributes
 		
-		opt_accessor(:profile_dir) { Mmi.minecraft_dir }
-		opt_accessor(:items      ) { []                }
-		
-		attr_reader :parsed_items
-		
-		def initialize(options)
-			@options = options
-			
-			parse!
-		end
-		
-		def parse!
-			if self.items.is_a?(Array)
-				@parsed_items = self.items.map.with_index do |asset, index|
-					source = asset['source']
-					
-					if source
-						type = source['type']
-						
-						case type
-							when 'github'
-								Source::Github.new(source)
-							when 'modrinth'
-								Source::Modrinth.new(source)
-							when 'url'
-								Source::Url.new(source)
-							else
-								raise Mmi::InvalidAttributeError, %Q(Invalid "source.type" in asset #{index.inspect}: #{type.inspect})
-						end
-					else
-						raise Mmi::MissingAttributeError, %Q(Missing "source" in asset #{index.inspect}.)
-					end
-				end
-			else
-				raise Mmi::InvalidAttributeError, %Q(Invalid "assets": expected Array or nothing, got #{self.items.inspect}.)
-			end
-		end
+		property :profile_dir,              default: Mmi::Constants.minecraft_dir
+		property :items,       type: Asset, default: []
 		
 		def install
-			self.parsed_items.each do |asset|
-				asset.install(self.profile_dir)
+			InstallRecord.new.tap do |install_record|
+				self.items.each do |asset|
+					asset.install(install_record)
+				end
+				
+				install_record.install(self.profile_dir)
 			end
 		end
 	end

data/lib/mmi/constants.rb

@@ -0,0 +1,14 @@
+module Mmi
+	module Constants
+		MMI_CACHE_DIR = File.join(Dir.home, '.cache', 'mmi')
+		MINECRAFT_DIR = File.join(Dir.home, '.minecraft')
+		
+		def self.cache_dir
+			MMI_CACHE_DIR
+		end
+		
+		def self.minecraft_dir
+			MINECRAFT_DIR
+		end
+	end
+end

data/lib/mmi/content_hash/base.rb

@@ -0,0 +1,9 @@
+module Mmi
+	module ContentHash
+		class Base
+			def match_file?(file_path)
+				raise NotImplementedError
+			end
+		end
+	end
+end

data/lib/mmi/content_hash/sha512.rb

@@ -0,0 +1,25 @@
+require 'digest'
+
+require 'mmi/content_hash/base'
+
+module Mmi
+	module ContentHash
+		class Sha512 < Base
+			attr_accessor :hex_digest
+			
+			def initialize(hex_digest)
+				super()
+				
+				self.hex_digest = hex_digest
+			end
+			
+			def match_file?(file_path)
+				Digest::SHA512.hexdigest(File.read(file_path)) == self.hex_digest
+			end
+			
+			def ==(other)
+				self.class == other.class && self.hex_digest == other.hex_digest
+			end
+		end
+	end
+end

data/lib/mmi/install_record.rb

@@ -0,0 +1,72 @@
+require 'psych'
+
+require 'mmi/content_hash/base'
+
+module Mmi
+	class InstallRecord
+		RecordEntry = Struct.new(:url, :content_hash)
+		
+		RECORD_FILE = '.mmi_install_record'.freeze
+		
+		def initialize
+			@record = {}
+		end
+		
+		def add(url, relative_path, content_hash:)
+			raise 'content_hash must be nil or an instance of Mmi::ContentHash::Base' unless content_hash.nil? || content_hash.is_a?(Mmi::ContentHash::Base)
+			
+			@record[relative_path] = RecordEntry.new(url, content_hash)
+		end
+		
+		def install(dir)
+			old_record = self.class.parse_record_file(dir) || {}
+			
+			@record.each do |relative_path, entry|
+				target_file = File.expand_path(relative_path, dir)
+				
+				if old_record[relative_path] != entry || (File.exist?(target_file) && !entry.content_hash&.match_file?(target_file))
+					Mmi.info "Downloading #{entry.url.inspect} into #{target_file.inspect}."
+					
+					begin
+						Mmi::InstallUtils.download_to_file(entry.url, target_file, entry.content_hash)
+					rescue OpenURI::HTTPError => e
+						Mmi.fail! "Error when requesting asset.\n#{e.inspect}"
+					end
+				else
+					Mmi.info "Skipping #{entry.url.inspect} because it is already present at #{target_file.inspect}."
+				end
+				
+				old_record.delete(relative_path)
+			end
+			
+			old_record.each do |relative_path, _|
+				target_file = File.expand_path(relative_path, dir)
+				
+				File.delete(target_file) if File.exist?(target_file)
+			end
+			
+			File.write(File.expand_path(RECORD_FILE, dir), to_yaml)
+		end
+		
+		def to_yaml
+			Psych.dump(@record)
+		end
+		
+		def self.parse_record_file(dir)
+			record_file = File.expand_path(RECORD_FILE, dir)
+			
+			if File.exist?(record_file)
+				parsed_record = Psych.unsafe_load_file(record_file)
+				
+				unless !parsed_record.is_a?(Hash) || parsed_record.keys.any?{|k| !k.is_a?(String)} && parsed_record.values.any?{|v| !v.is_a?(Record)}
+					parsed_record
+				else
+					Mmi.warn("Found invalid install record at #{record_file}. The file will be ignored.")
+					nil
+				end
+			else
+				nil
+			end
+		end
+	end
+end

data/lib/mmi/install_utils.rb

@@ -0,0 +1,24 @@
+require 'digest'
+require 'fileutils'
+require 'open-uri'
+
+require 'mmi/constants'
+require 'mmi/content_hash/base'
+
+module Mmi
+	module InstallUtils
+		class << self
+			def download_to_file(url, target_file, content_hash=nil)
+				raise 'content_hash must be nil or an instance of Mmi::ContentHash::Base' unless content_hash.nil? || content_hash.is_a?(Mmi::ContentHash::Base)
+				
+				FileUtils.mkdir_p(File.dirname(target_file))
+				
+				stream = URI.parse(url).open
+				
+				IO.copy_stream(stream, target_file)
+				
+				raise "Failed to match #{target_file} with #{content_hash.inspect}!" if content_hash && !content_hash.match_file?(target_file)
+			end
+		end
+	end
+end

data/lib/mmi/interactive/assets.rb

@@ -8,12 +8,12 @@ module Mmi
 		module Assets
 			def update_assets
 				loop do
-					assets = processor.parsed_assets.parsed_items
+					assets = processor.assets.items
 					
 					choice = CLI::UI::Prompt.ask('Which asset do you want to change?') do |handler|
 						assets.each do |asset|
-							handler.option(asset.display_name) do
-								asset
+							handler.option(asset.source.display_name) do
+								asset.source
 							end
 						end
 						
@@ -27,12 +27,27 @@ module Mmi
 						when :add
 							add_asset
 						else
-							update_asset_version(choice)
+							update_asset_source_version(choice)
 					end
 				end
 			end
 			
 			def add_asset
+				if (source = create_source)
+					asset = Mmi::Asset.parse({
+						'source' => source.to_h,
+					})
+					
+					self.processor.assets['items'].push(asset.to_h)
+					self.processor.assets.parse!
+				else
+					CLI::UI.puts('Aborting asset addition. No change will be made.')
+					
+					false
+				end
+			end
+			
+			def create_source
 				source_type = CLI::UI::Prompt.ask('Choose a source type.') do |handler|
 					%w[
 						github
@@ -45,80 +60,68 @@ module Mmi
 					handler.option('quit', &:to_sym)
 				end
 				
-				opts, source =
+				source =
 					case source_type
 						when :quit
 							return false
 						when :github
 							options = {
-								'source' => {
-									'type'     => 'github',
-									'asset_id' => 0,
-								},
+								'type'     => 'github',
+								'asset_id' => 0,
 							}
 							
-							options['source']['owner'      ] = CLI::UI::Prompt.ask('Who is the owner of the source repository?').strip
-							options['source']['repo'       ] = CLI::UI::Prompt.ask('What is the name of the source repository?').strip
-							options['source']['install_dir'] = CLI::UI::Prompt.ask('In which directory should the asset be placed?', default: 'mods').strip
-							options['source']['filename'   ] = CLI::UI::Prompt.ask('Under which filename should the asset be saved? (leave empty for release asset name)', allow_empty: true).strip.then do |filename|
+							options['owner'      ] = CLI::UI::Prompt.ask('Who is the owner of the source repository?').strip
+							options['repo'       ] = CLI::UI::Prompt.ask('What is the name of the source repository?').strip
+							options['install_dir'] = CLI::UI::Prompt.ask('In which directory should the asset be placed?', default: 'mods').strip
+							options['filename'   ] = CLI::UI::Prompt.ask('Under which filename should the asset be saved? (leave empty for release asset name)', allow_empty: true).strip.then do |filename|
 								filename == '' ? nil : filename
 							end
 							
-							options['source'].compact!
+							options.compact!
 							
-							[options, Mmi::Source::Github.new(options['source'])]
+							Mmi::Source::Github.parse(options)
 						when :modrinth
 							options = {
-								'source' => {
-									'type'         => 'modrinth',
-									'version'      => '0',
-									'version_file' => '0',
-								},
+								'type'         => 'modrinth',
+								'version'      => '0',
+								'version_file' => '0',
 							}
 							
-							options['source']['name'       ] = CLI::UI::Prompt.ask('What is the name of the mod in the Modrinth URL?').strip
-							options['source']['install_dir'] = CLI::UI::Prompt.ask('In which directory should the asset be placed?', default: 'mods').strip
-							options['source']['filename'   ] = CLI::UI::Prompt.ask('Under which filename should the asset be saved? (leave empty for release asset name)', allow_empty: true).strip.then do |filename|
+							options['name'       ] = CLI::UI::Prompt.ask('What is the name of the mod in the Modrinth URL?').strip
+							options['install_dir'] = CLI::UI::Prompt.ask('In which directory should the asset be placed?', default: 'mods').strip
+							options['filename'   ] = CLI::UI::Prompt.ask('Under which filename should the asset be saved? (leave empty for release asset name)', allow_empty: true).strip.then do |filename|
 								filename == '' ? nil : filename
 							end
 							
-							options['source'].compact!
+							options.compact!
 							
-							[options, Mmi::Source::Modrinth.new(options['source'])]
+							Mmi::Source::Modrinth.parse(options)
 						when :url
 							options = {
-								'source' => {
-									'type' => 'url',
-									'url'  => '',
-								},
+								'type' => 'url',
 							}
 							
-							options['source']['install_dir'] = CLI::UI::Prompt.ask('In which directory should the asset be placed?', default: 'mods').strip
-							options['source']['filename'   ] = CLI::UI::Prompt.ask('Under which filename should the asset be saved? (leave empty for release asset name)', allow_empty: true).strip.then do |filename|
+							options['install_dir'] = CLI::UI::Prompt.ask('In which directory should the asset be placed?', default: 'mods').strip
+							options['filename'   ] = CLI::UI::Prompt.ask('Under which filename should the asset be saved? (leave empty for release asset name)', allow_empty: true).strip.then do |filename|
 								filename == '' ? nil : filename
 							end
 							
-							options['source'].compact!
+							options.compact!
 							
-							[options, Mmi::Source::Url.new(options['source'])]
+							Mmi::Source::Url.parse(options)
 					end
 				
-				if update_asset_version(source)
-					self.processor.parsed_assets.items.push(opts)
-					self.processor.parsed_assets.parsed_items.push(source)
-					
-					true
+				if update_asset_source_version(source)
+					source
 				else
-					CLI::UI.puts('Aborting asset addition. No change will be made.', color: CLI::UI::Color::RED)
-					
-					false
+					nil
 				end
 			end
 			
-			def update_asset_version(asset)
-				case asset
+			def update_asset_source_version(source)
+				case source
 					when Mmi::Source::Github
-						github_releases = Mmi::GithubApi.client.releases("#{asset.owner}/#{asset.repo}")
+						github_releases = Mmi::GithubApi.client.releases("#{source.owner}/#{source.repo}")
 						
 						github_release = CLI::UI::Prompt.ask('Choose a release.') do |handler|
 							github_releases.select do |release|
@@ -150,10 +153,11 @@ module Mmi
 									when :quit
 										false
 									else
-										asset.release = nil
-										asset.file    = nil
-										
-										asset.asset_id = release_asset.id
+										source.update_properties!({
+											release:  nil,
+											file:     nil,
+											asset_id: release_asset.id,
+										})
 										
 										true
 								end
@@ -161,17 +165,17 @@ module Mmi
 					when Mmi::Source::Modrinth
 						mod_version = CLI::UI::Prompt.ask('Choose a version.') do |handler|
 							version_filter_parameters =
-								case processor.parsed_modloader
+								case processor.modloader
 									when Mmi::Modloader::Fabric
 										{
 											loader:       'fabric',
-											game_version: processor.parsed_modloader.mcversion,
+											game_version: processor.modloader.minecraft_version,
 										}
 									else
 										{}
 								end
 							
-							asset.cached_mod_versions(**version_filter_parameters).select do |version|
+							source.cached_mod_versions(**version_filter_parameters).select do |version|
 								version['files'].any?
 							end.each do |version|
 								handler.option("#{version['name']} (for game versions #{version['game_versions'].join('/')})") do
@@ -200,14 +204,18 @@ module Mmi
 									when :quit
 										false
 									else
-										asset.version      = mod_version['name']
-										asset.version_file = version_file['filename']
+										source.update_properties!({
+											version:      mod_version['name'],
+											version_file: version_file['filename'],
+										})
 										
 										true
 								end
 						end
 					when Mmi::Source::Url
-						asset.url = CLI::UI::Prompt.ask('What is the URL of the file that should be downloaded?', default: asset.url).strip
+						url = CLI::UI::Prompt.ask('What is the URL of the file that should be downloaded?', default: source.url).strip
+						
+						source.update_properties!({url: url})
 					else
 						CLI::UI.puts('This asset cannot be updated.', color: CLI::UI::Color::RED)
 						

data/lib/mmi/interactive/modloader.rb

@@ -9,7 +9,7 @@ module Mmi
 			def update_modloader
 				choice = CLI::UI::Prompt.ask('What do you want to do?') do |handler|
 					[
-						(["Update current modloader #{self.processor.modloader['name']}", :update_current] unless self.processor.parsed_modloader.is_a?(Mmi::Modloader::None)),
+						(["Update current modloader #{self.processor.modloader['name']}", :update_current] unless self.processor.modloader.is_a?(Mmi::Modloader::None)),
 						['quit',                                                          :quit          ],
 					].each do |name, result|
 						handler.option(name) do
@@ -29,7 +29,7 @@ module Mmi
 			end
 			
 			def update_modloader_current
-				ml = self.processor.parsed_modloader
+				ml = self.processor.modloader
 				
 				case ml
 					when Mmi::Modloader::None
@@ -38,12 +38,12 @@ module Mmi
 						loop do
 							choice = CLI::UI::Prompt.ask('What do you want to update?') do |handler|
 								[
-									['Installer version',   :version     ],
-									['Minecraft version',   :mc_version  ],
-									['Download Minecraft?', :download_mc ],
-									['Install directory',   :install_dir ],
-									['Install type',        :install_type],
-									['quit',                :quit        ],
+									['Installer version',   :version           ],
+									['Minecraft version',   :minecraft_version ],
+									['Download Minecraft?', :download_minecraft],
+									['Install directory',   :install_dir       ],
+									['Install type',        :install_type      ],
+									['quit',                :quit              ],
 								].each do |name, result|
 									handler.option(name) do
 										result
@@ -65,9 +65,9 @@ module Mmi
 										when :quit
 											# Pass.
 										else
-											ml.version = choice2
+											ml.update_properties!({version: choice2})
 									end
-								when :mc_version
+								when :minecraft_version
 									choice2 =
 										begin
 											CLI::UI::Prompt.ask('Which Minecraft version do you need?')
@@ -79,12 +79,12 @@ module Mmi
 										when :quit
 											# Pass.
 										else
-											ml.mcversion = choice2
+											ml.update_properties!({minecraft_version: choice2})
 									end
-								when :download_mc
+								when :download_minecraft
 									choice2 =
 										begin
-											CLI::UI::Prompt.confirm('Download minecraft when installing the modloader? (Ctrl+C for no change)', default: ml.download_mc)
+											CLI::UI::Prompt.confirm('Download minecraft when installing the modloader? (Ctrl+C for no change)', default: ml.download_minecraft)
 										rescue Interrupt
 											:quit
 										end
@@ -93,7 +93,7 @@ module Mmi
 										when :quit
 											# Pass.
 										else
-											ml.download_mc = choice2
+											ml.update_properties!({download_minecraft: choice2})
 									end
 								when :install_dir
 									choice2 =
@@ -107,7 +107,7 @@ module Mmi
 										when :quit
 											# Pass.
 										else
-											ml.install_dir = choice2.strip.empty? ? nil : choice2
+											ml.update_properties!({install_dir: choice2.strip.empty? ? nil : choice2})
 									end
 								when :install_type
 									choice2 = CLI::UI::Prompt.ask('What type of installation do you want?') do |handler|
@@ -122,7 +122,7 @@ module Mmi
 										when :quit
 											# Pass.
 										else
-											ml.install_type = choice2
+											ml.update_properties!({install_type: choice2})
 									end
 								when :quit
 									break

data/lib/mmi/interactive/updater.rb

@@ -39,7 +39,7 @@ module Mmi
 							update_assets
 						when :quit_save
 							file_path = CLI::UI::Prompt.ask('Filename', default: self.file_path, is_file: true)
-							yaml      = self.processor.options.to_yaml
+							yaml      = self.processor.to_h.to_yaml
 							
 							File.write(File.expand_path(file_path, Dir.pwd), yaml)
 							break

data/lib/mmi/mod_file_processor.rb

@@ -1,72 +1,20 @@
 require 'mmi/assets_processor'
 require 'mmi/modloader/none'
 require 'mmi/modloader/fabric'
-require 'mmi/option_attributes'
+require 'mmi/property_attributes'
 require 'mmi/semver'
 
 module Mmi
 	class ModFileProcessor
-		include OptionAttributes
+		prepend PropertyAttributes
 		
-		opt_accessor :version
-		opt_accessor :modloader
-		opt_accessor :assets
-		
-		attr_reader :parsed_modloader
-		attr_reader :parsed_assets
-		
-		def initialize(options)
-			@options = options
-			
-			parse!
-		end
-		
-		def parse!
-			version     = Semver.parse(self.version)
-			lib_version = Semver.parse(Mmi::VERSION)
-			
-			if self.version
-				if version.major <= lib_version.major
-					if version.minor > lib_version.minor
-						Mmi.warn %Q(Config file specified "version" #{version}, but MMI is at #{lib_version}. Some features might not be supported.)
-					end
-					
-					ml = self.modloader
-					@parsed_modloader =
-						if ml
-							case ml['name']
-								when 'none'
-									Modloader::None.new(ml)
-								when 'fabric'
-									Modloader::Fabric.new(ml)
-								else
-									raise Mmi::InvalidAttributeError, "Unkown modloader #{ml['name'].inspect}."
-							end
-						else
-							Modloader::None.new
-						end
-					
-					
-					if self.assets
-						if self.assets.is_a?(Hash)
-							@parsed_assets = AssetsProcessor.new(self.assets)
-						else
-							raise Mmi::InvalidAttributeError, %Q(Invalid "assets": expected Hash but received #{self.assets.inspect})
-						end
-					else
-						raise Mmi::MissingAttributeError, 'Missing "assets".'
-					end
-				else
-					raise Mmi::InvalidAttributeError, %Q(Config file specified "version" #{version}, but MMI is at #{lib_version}.)
-				end
-			else
-				raise Mmi::MissingAttributeError, 'Missing "version".'
-			end
-		end
+		property :version,   type: Semver
+		property :modloader, type: {field: 'name', types: {'none' => Modloader::None, 'fabric' => Modloader::Fabric}}
+		property :assets,    type: AssetsProcessor
 		
 		def install
-			self.parsed_modloader.install
-			self.parsed_assets.install
+			self.modloader.install
+			self.assets.install
 		end
 	end
 end