mmi 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 542fe675b42d32312f06e4953aa52b44a2a3e7ff906d25f797aedffb35624576
-  data.tar.gz: 5bba31fccf041f7745cc66cf2069b6a86baf3fe5a35a3fbba49ad447689dd6a6
+  metadata.gz: b06278de132f8f2d3579987335931bdafe56470aef8641b7157b78922d12bd99
+  data.tar.gz: 046a5c00f73f2ae5151411572978ef1af74662136d72a82ad30e2570e12c0523
 SHA512:
-  metadata.gz: b9d50f19d7272034f6786a15349809993659cf5f7298cf968c7f267f0ca599839d1be2e136807e22b1656e34218574321a2265325e81af1ec094034cd873e421
-  data.tar.gz: 8ce3dfe58ea7884529f7692aaf86eb30f1d31d9813b123e4362f4e61397b679ffe3a718ecef14e7a8851d14ac019155fed7b50cfd54cacf0c15a7de484d52c4b
+  metadata.gz: 252ff8dcf6dfc7ece06c47300903e4bd3cf50ede5c7b82b8bcaf8ef7bdbd63b35f72a9a02d553c050e2a81fd17941523d7814435eb3c34e55f0071e6a073d1c5
+  data.tar.gz: 57127da3df65211b4b4b1afa2899f404f95da5a9c14ba4067da24749ae5261ec6d0003d60e66d7f9eafcf3ad7b577b19b89600ef174e3d35276e64c79c5eb960

data/README.adoc

@@ -13,14 +13,29 @@ The application is currently CLI-only, but should work on Linux, MacOS and Windo
 
 toc::[]
 
-= Installation
+== Installation
 
-== Prerequisites
+=== Prerequisites
 
-To run the application, Ruby version 2.5+ has to be installed.
-For maximum compatibility, use version 3.0+.
+It is recommended to use MMI with Ruby 3.0 or higher.
+While lower versions might work, further development is expected to ignore any specifics that may render those versions unusable.
 
-== Steps
+=== Steps
+
+==== Installation through rubygems.org
+
+[example]
+====
+*Disclaimer:* While MMI releases are published on rubygems.org, they might not reflect current development.
+If something does not work, try the manual installation.
+====
+
+[source,bash]
+----
+$ gem install mmi
+----
+
+==== Manual installation
 
 Clone the repository and navigate into its root directory.
 
@@ -33,27 +48,32 @@ $ hg clone https://github.com/expeehaa/mmi.git
 $ cd mmi
 ----
 
-Install gem dependencies.
+Install gem dependencies using bundler
 
 [source,bash]
 ----
 $ bundle install
 ----
 
-If you get an error that the lockfile requires `bundler` version 2.0+, install it first.
+If you get an error saying the lockfile requires `bundler` version 2.0+, install it first.
 
 [source,bash]
 ----
 $ gem install bundler
 ----
 
-= Basic usage
+Install the gem.
 
-In the repository root directory, run `exe/mmi`.
+[source,bash]
+----
+$ rake install
+----
+
+== Basic usage
 
 [source,text]
 ----
-Syntax: exe/mmi <config file> [action=install]
+Syntax: mmi <config file> [action=install]
 
 	where action is one of
 		install  - Install the modloader and assets as specified in the config file.
@@ -62,30 +82,48 @@ Syntax: exe/mmi <config file> [action=install]
 ----
 
 The script currently does not support any arguments besides the ones listed above.
-Trying to get help by running `exe/mmi --help` or similar will not work.
+Trying to get help by running `mmi --help` or similar will not work.
 
-= Example configs
+== Example configs
 
 Example configuration files can be found in `examples/`.
-They are completely working and download and install files into `tmp/` so that your `.minecraft` folder will stay unharmed.
+They can be parsed by the MMI version they come with.
+Example configurations download and install files into `tmp/` so that your `.minecraft` folder will stay unharmed.
 
+The files are intended to provide an overview of the different features of MMI.
+They are not intended to create a working modded Minecraft environment and will therefore not be updated for each new Minecraft version.
 
-= TODOs
+== TODOs
 
 * Improve argument parsing.
 * Write tests.
 * Add command to interactively create a config file.
 * Be able to update/change modloader interactively.
 * Be able to remove assets interactively.
-* Think about advising everyone to use another file extension than `.yaml` (e.g. `.mmi`, `.mmiconf`).
+* Think about advising users to use another file extension than `.yaml` (e.g. `.mmi`, `.mmiconf`).
 * Try to make a Java-executable `.jar` file using `warbler` and `JRuby`.
 
-= Contributing
+== Versioning
+
+MMI uses semantic versioning with major, minor and patch versions.
+
+Versions are coupled to the configuration file specification.
+This means, within the same major version, every release must be backwards-compatible regarding config file interpreting and MMI releases with a lower minor version must still be able to interpret a config file with a higher minor version (although they are allowed and expected to not support some configurations).
+
+An exception to this rule are all releases with the major version `0`.
+There, within the same minor version, backwards compatibility can be expected, but different minor versions will (most likely) not be compatible.
+
+== 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.
 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.
-Other code style rules may have to be exactly specified in the future.
-When in doubt, take a look at the existing code.
+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.

data/exe/mmi

@@ -19,25 +19,25 @@ def processor(file)
 	end
 end
 
-if ARGV.length>0
+if !ARGV.empty?
 	file         = ARGV.shift
 	action_param = ARGV.shift
 	action       = action_param.nil? ? :install : action_param.to_sym
 	
 	case action
-	when :install
-		processor(file).install
-	when :validate
-		processor(file)
-		
-		puts 'File is valid.'
-	when :update
-		Mmi::Interactive.update(processor(file), file)
-	else
-		STDERR.puts "Unknown action: #{action_param.inspect}."
-		Kernel.exit 1
+		when :install
+			processor(file).install
+		when :validate
+			processor(file)
+			
+			puts 'File is valid.'
+		when :update
+			Mmi::Interactive.update(processor(file), file)
+		else
+			warn "Unknown action: #{action_param.inspect}."
+			Kernel.exit 1
 	end
 else
 	puts 'No file given.'
 	Kernel.exit 1
-end
+end

data/lib/mmi/assets_processor.rb

@@ -1,41 +1,54 @@
+require 'mmi/option_attributes'
 require 'mmi/source/github'
+require 'mmi/source/modrinth'
+require 'mmi/source/url'
 
 module Mmi
 	class AssetsProcessor
-		attr_reader :profile_dir
-		attr_reader :assets
+		include OptionAttributes
 		
-		def initialize(profile_dir, assets)
-			@profile_dir = profile_dir
-			
-			assets ||= []
+		opt_accessor(:profile_dir) { Mmi.minecraft_dir }
+		opt_accessor(:items      ) { []                }
+		
+		attr_reader :parsed_items
+		
+		def initialize(options)
+			@options = options
 			
-			if assets.is_a?(Array)
-				@assets = assets.map.with_index do |asset, index|
+			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)
-						else
-							raise Mmi::InvalidAttributeError, %Q{Invalid "source.type" in asset #{index.inspect}: #{type.inspect}}
+							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}.}
+						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.assets.inspect}.}
+				raise Mmi::InvalidAttributeError, %Q(Invalid "assets": expected Array or nothing, got #{self.items.inspect}.)
 			end
 		end
 		
 		def install
-			assets.each do |asset|
+			self.parsed_items.each do |asset|
 				asset.install(self.profile_dir)
 			end
 		end
 	end
-end
+end

data/lib/mmi/cached_download.rb

@@ -0,0 +1,59 @@
+require 'digest'
+require 'fileutils'
+require 'open-uri'
+
+module Mmi
+	module CachedDownload
+		class << self
+			def open_cached(path, sha512: nil)
+				if File.exist?(path)
+					File.open(path).tap do |f|
+						if !sha512 || sha512 == Digest::SHA512.hexdigest(f.read)
+							f.seek(0)
+							f
+						else
+							nil
+						end
+					end
+				else
+					nil
+				end
+			end
+			
+			def download(uri, sha512: nil)
+				URI.parse(uri).open.tap do |stream|
+					if sha512
+						actual_sha512 = Digest::SHA512.hexdigest(stream.read)
+						
+						if sha512 == actual_sha512
+							stream.seek(0)
+						else
+							Mmi.fail! "Expected download to have SHA512 sum #{expected_hexdigest.inspect} but received #{actual_sha512.inspect}."
+						end
+					end
+				end
+			end
+			
+			def download_cached(uri, download_path, sha512_uri: nil)
+				ensure_cache_dir_exists!
+				
+				expected_hexdigest = URI.parse(sha512_uri).open.read
+				cached_file        = open_cached(download_path, sha512: expected_hexdigest)
+				
+				if !cached_file
+					stream = download(uri, sha512: expected_hexdigest)
+					
+					IO.copy_stream(stream, download_path)
+				else
+					Mmi.info "Using cached version of #{uri.inspect} from #{download_path.inspect}."
+				end
+			end
+			
+			private
+			
+			def ensure_cache_dir_exists!
+				FileUtils.mkdir_p(Mmi.cache_dir)
+			end
+		end
+	end
+end

data/lib/mmi/github_api.rb

@@ -0,0 +1,11 @@
+require 'octokit'
+
+module Mmi
+	module GithubApi
+		class << self
+			def client
+				@client ||= Octokit::Client.new
+			end
+		end
+	end
+end

data/lib/mmi/interactive/assets.rb

@@ -0,0 +1,208 @@
+require 'cli/ui'
+
+require 'mmi/github_api'
+require 'mmi/source/github'
+
+module Mmi
+	module Interactive
+		module Assets
+			def update_assets
+				loop do
+					assets = processor.parsed_assets.parsed_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
+							end
+						end
+						
+						handler.option('add',  &:to_sym)
+						handler.option('quit', &:to_sym)
+					end
+					
+					case choice
+						when :quit
+							break
+						when :add
+							add_asset
+						else
+							update_asset_version(choice)
+					end
+				end
+			end
+			
+			def add_asset
+				source_type = CLI::UI::Prompt.ask('Choose a source type.') do |handler|
+					%w[
+						github
+						modrinth
+						url
+					].each do |type|
+						handler.option(type, &:to_sym)
+					end
+					
+					handler.option('quit', &:to_sym)
+				end
+				
+				opts, source =
+					case source_type
+						when :quit
+							return false
+						when :github
+							options = {
+								'source' => {
+									'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|
+								filename == '' ? nil : filename
+							end
+							
+							options['source'].compact!
+							
+							[options, Mmi::Source::Github.new(options['source'])]
+						when :modrinth
+							options = {
+								'source' => {
+									'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|
+								filename == '' ? nil : filename
+							end
+							
+							options['source'].compact!
+							
+							[options, Mmi::Source::Modrinth.new(options['source'])]
+						when :url
+							options = {
+								'source' => {
+									'type' => 'url',
+									'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|
+								filename == '' ? nil : filename
+							end
+							
+							options['source'].compact!
+							
+							[options, Mmi::Source::Url.new(options['source'])]
+					end
+				
+				if update_asset_version(source)
+					self.processor.parsed_assets.items.push(opts)
+					self.processor.parsed_assets.parsed_items.push(source)
+					
+					true
+				else
+					CLI::UI.puts('Aborting asset addition. No change will be made.', color: CLI::UI::Color::RED)
+					
+					false
+				end
+			end
+			
+			def update_asset_version(asset)
+				case asset
+					when Mmi::Source::Github
+						github_releases = Mmi::GithubApi.client.releases("#{asset.owner}/#{asset.repo}")
+						
+						github_release = CLI::UI::Prompt.ask('Choose a release.') do |handler|
+							github_releases.select do |release|
+								release.assets.any?
+							end.each do |release|
+								handler.option(release.name) do
+									release
+								end
+							end
+							
+							handler.option('quit', &:to_sym)
+						end
+						
+						case github_release
+							when :quit
+								false
+							else
+								release_asset = CLI::UI::Prompt.ask('Choose an asset.') do |handler|
+									github_release.assets.each do |a|
+										handler.option(a.name) do
+											a
+										end
+									end
+									
+									handler.option('quit', &:to_sym)
+								end
+								
+								case release_asset
+									when :quit
+										false
+									else
+										asset.release = nil
+										asset.file    = nil
+										
+										asset.asset_id = release_asset.id
+										
+										true
+								end
+						end
+					when Mmi::Source::Modrinth
+						mod_version = CLI::UI::Prompt.ask('Choose a version.') do |handler|
+							asset.cached_mod_versions.select do |version|
+								version['files'].any?
+							end.each do |version|
+								handler.option("#{version['name']} (for game versions #{version['game_versions'].join('/')})") do
+									version
+								end
+							end
+							
+							handler.option('quit', &:to_sym)
+						end
+						
+						case mod_version
+							when :quit
+								false
+							else
+								version_file = CLI::UI::Prompt.ask('Choose a version file.') do |handler|
+									mod_version['files'].each do |file|
+										handler.option(file['filename']) do
+											file
+										end
+									end
+									
+									handler.option('quit', &:to_sym)
+								end
+								
+								case version_file
+									when :quit
+										false
+									else
+										asset.version      = mod_version['name']
+										asset.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
+					else
+						CLI::UI.puts('This asset cannot be updated.', color: CLI::UI::Color::RED)
+						
+						false
+				end
+			end
+		end
+	end
+end

data/lib/mmi/interactive/modloader.rb

@@ -0,0 +1,139 @@
+require 'cli/ui'
+
+require 'mmi/modloader/fabric'
+require 'mmi/modloader/none'
+
+module Mmi
+	module Interactive
+		module Modloader
+			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)),
+						['quit',                                                          :quit          ],
+					].each do |name, result|
+						handler.option(name) do
+							result
+						end
+					end
+				end
+				
+				case choice
+					when :update_current
+						update_modloader_current
+					when :quit
+						# Pass.
+					else
+						raise 'Consider yourself lucky, you found a bug.'
+				end
+			end
+			
+			def update_modloader_current
+				ml = self.processor.parsed_modloader
+				
+				case ml
+					when Mmi::Modloader::None
+						CLI::UI.puts('There is currently no modloader set, please choose one first.', color: CLI::UI::Color::RED)
+					when Mmi::Modloader::Fabric
+						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        ],
+								].each do |name, result|
+									handler.option(name) do
+										result
+									end
+								end
+							end
+							
+							case choice
+								when :version
+									choice2 = CLI::UI::Prompt.ask('Choose a fabric installer version') do |handler|
+										ml.available_versions.sort.reverse.each do |v|
+											handler.option(v, &:itself)
+										end
+										
+										handler.option('quit', &:to_sym)
+									end
+									
+									case choice2
+										when :quit
+											# Pass.
+										else
+											ml.version = choice2
+									end
+								when :mc_version
+									choice2 =
+										begin
+											CLI::UI::Prompt.ask('Which Minecraft version do you need?')
+										rescue Interrupt
+											:quit
+										end
+									
+									case choice2
+										when :quit
+											# Pass.
+										else
+											ml.mcversion = choice2
+									end
+								when :download_mc
+									choice2 =
+										begin
+											CLI::UI::Prompt.confirm('Download minecraft when installing the modloader? (Ctrl+C for no change)', default: ml.download_mc)
+										rescue Interrupt
+											:quit
+										end
+									
+									case choice2
+										when :quit
+											# Pass.
+										else
+											ml.download_mc = choice2
+									end
+								when :install_dir
+									choice2 =
+										begin
+											CLI::UI::Prompt.ask('In which directory should the modloader be installed? ', is_file: true)
+										rescue Interrupt
+											:quit
+										end
+									
+									case choice2
+										when :quit
+											# Pass.
+										else
+											ml.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|
+										ml.allowed_install_types.each do |type|
+											handler.option(type, &:itself)
+										end
+										
+										handler.option('quit', &:to_sym)
+									end
+									
+									case choice2
+										when :quit
+											# Pass.
+										else
+											ml.install_type = choice2
+									end
+								when :quit
+									break
+								else
+									raise 'Consider yourself lucky, you found a bug.'
+							end
+						end
+					else
+						CLI::UI.puts("Modloader #{self.processor.modloader['name']} is not supported.", color: CLI::UI::Color::RED)
+				end
+			end
+		end
+	end
+end