nauvisian 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e928d3061730068999c84496aec1c8eb57ccc08e143e0fc33bfbd10f5b16c92d
+  data.tar.gz: 5f0a59c8c77bc0d09ac5a34b8661d34f487898183c9e6fe0b5f1f7fb4a5243ba
+SHA512:
+  metadata.gz: 040d1375254e5d5d7d594cb3071c13b28c18ea945b9244c49ca0bb692c7cd4c05199f5be85bb88c67926636e126870d7cd237769b5d1cd56de95c05e758b9e8f
+  data.tar.gz: 61e66892b9b1e54d5a12567b61f205e637c9108fece1c3de80fc08d1140538da67eab97c537810b26f7b547bcface784b7f15d72d5cd01d12164639bbfc17eef

data/.rspec

@@ -0,0 +1,3 @@
+--format progress
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,29 @@
+inherit_from:
+  - .rubocop/bundler.yml
+  - .rubocop/gemspec.yml
+  - .rubocop/layout.yml
+  - .rubocop/lint.yml
+  - .rubocop/metrics.yml
+  - .rubocop/naming.yml
+  - .rubocop/performance.yml
+  - .rubocop/rspec.yml
+  - .rubocop/security.yml
+  - .rubocop/style.yml
+  - .rubocop_todo.yml
+
+require:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  EnabledByDefault: true
+  Exclude:
+    - bin/**/*
+    - vendor/**/*
+  ExtraDetails: true
+  NewCops: enable
+  TargetRubyVersion: 3.2
+  UseCache: true

data/.rubocop_todo.yml

@@ -0,0 +1,26 @@
+Layout/LineLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+RSpec/NestedGroups:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/PendingWithoutReason:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/DocumentationMethod:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-01-13
+
+- Initial release

data/Gemfile

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+group :development do
+  gem "typeprof"
+end
+
+group :development, :test do
+  gem "debug"
+  gem "rake"
+end
+
+group :test do
+  gem "fabrication", require: false
+  gem "faker", require: false
+  gem "rspec", require: false
+  gem "rubocop", require: false
+  gem "rubocop-performance", require: false
+  gem "rubocop-rake", require: false
+  gem "rubocop-rspec", require: false
+  gem "simplecov", require: false
+  gem "webmock", require: false
+end

data/Gemfile.lock

@@ -0,0 +1,141 @@
+PATH
+  remote: .
+  specs:
+    nauvisian (0.1.0)
+      aws-sdk-s3 (~> 1.0)
+      dry-cli (~> 1.0)
+      dry-inflector (~> 1.0)
+      rack (~> 3.0)
+      ruby-progressbar (~> 1.11)
+      rubyzip (~> 2.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.4)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    aws-eventstream (1.2.0)
+    aws-partitions (1.765.0)
+    aws-sdk-core (3.172.0)
+      aws-eventstream (~> 1, >= 1.0.2)
+      aws-partitions (~> 1, >= 1.651.0)
+      aws-sigv4 (~> 1.5)
+      jmespath (~> 1, >= 1.6.1)
+    aws-sdk-kms (1.64.0)
+      aws-sdk-core (~> 3, >= 3.165.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-s3 (1.122.0)
+      aws-sdk-core (~> 3, >= 3.165.0)
+      aws-sdk-kms (~> 1)
+      aws-sigv4 (~> 1.4)
+    aws-sigv4 (1.5.2)
+      aws-eventstream (~> 1, >= 1.0.2)
+    concurrent-ruby (1.2.2)
+    crack (0.4.5)
+      rexml
+    debug (1.8.0)
+      irb (>= 1.5.0)
+      reline (>= 0.3.1)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    dry-cli (1.0.0)
+    dry-inflector (1.0.0)
+    fabrication (2.30.0)
+    faker (3.2.0)
+      i18n (>= 1.8.11, < 2)
+    hashdiff (1.0.1)
+    i18n (1.13.0)
+      concurrent-ruby (~> 1.0)
+    io-console (0.6.0)
+    irb (1.6.4)
+      reline (>= 0.3.0)
+    jmespath (1.6.2)
+    json (2.6.3)
+    parallel (1.23.0)
+    parser (3.2.2.1)
+      ast (~> 2.4.1)
+    public_suffix (5.0.1)
+    rack (3.0.7)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rbs (3.1.0)
+    regexp_parser (2.8.0)
+    reline (0.3.3)
+      io-console (~> 0.5)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.51.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.1)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.18.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.22.0)
+      rubocop (~> 1.33)
+    rubocop-performance (1.17.1)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.22.0)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
+    rubyzip (2.3.2)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    typeprof (0.21.7)
+      rbs (>= 1.8.1)
+    unicode-display_width (2.4.2)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  arm64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  debug
+  fabrication
+  faker
+  nauvisian!
+  rake
+  rspec
+  rubocop
+  rubocop-performance
+  rubocop-rake
+  rubocop-rspec
+  simplecov
+  typeprof
+  webmock
+
+BUNDLED WITH
+   2.4.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 OZAWA Sakuro
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# Nauvisian
+
+A library and CLI tool for the management of [Factorio](https://factorio.com) MODs and saves.
+
+It eases downloading MODs, enabling/disabling locally installed MODs and synchroning MODs and settings with save files.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add nauvisian
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install nauvisian
+
+## CLI Usage
+
+- `nvsn mod disable MOD`
+    Disable an installed MOD
+- `nvsn mod download MOD` 🔐
+    Download a MOD to the current directory
+- `nvsn mod enable MOD`
+    Enable an installed MOD
+- `nvsn mod info MOD` 🖧
+    Show info of MOD
+- `nvsn mod installed`
+    List installed MODs
+- `nvsn mod latest MOD` 🖧
+    Show the latest version of MOD
+- `nvsn mod versions MOD` 🖧
+    List available versions of MOD
+- `nvsn mod settings dump`
+    Dump MOD settings
+- `nvsn save mod list SAVE`
+    List MODs used in the given SAVE
+- `nvsn save mod sync SAVE` 🔐
+    Synchronize MODs and startup settings with the given SAVE
+
+For options recognized by the commands above, try the command with `--help`.
+
+- Commands with 🔐 requires the credenail information generally found in your `player-data.json`
+- Commands with 🖧 accesses MOD portal's public API
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.  It also copies currently installed MODs and saves into the workspace.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sakuro/nauvisian.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/clean"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+CLEAN.add("coverage")
+CLEAN.add(".rspec_status")
+CLOBBER.add("*.zip")
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/exe/nvsn

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "nauvisian/cli"
+
+Zip.warn_invalid_date = false
+Dry::CLI.new(Nauvisian::CLI::Commands).call

data/lib/nauvisian/api.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require "json"
+require "open-uri"
+
+require "rack/utils"
+
+require "nauvisian/error"
+
+module Nauvisian
+  # Mod Portal API
+  # https://wiki.factorio.com/Mod_portal_API
+  class API
+    class Error < Nauvisian::Error; end
+
+    MOD_PORTAL_ENDPOINT_URI = URI("https://mods.factorio.com").freeze
+    private_constant :MOD_PORTAL_ENDPOINT_URI
+
+    def initialize
+      @cache = Nauvisian::Cache::FileSystem.new(name: "api")
+    end
+
+    def detail(mod)
+      with_error_handling(mod) do
+        path = "/api/mods/#{mod.name}/full"
+        raw_data = get(path)
+        data = raw_data.slice(:downloads_count, :name, :owner, :summary, :title, :category, :description)
+        Nauvisian::Mod::Detail[created_at: Time.parse(raw_data[:created_at]), **data]
+      end
+    end
+
+    def releases(mod)
+      with_error_handling(mod) do
+        path = "/api/mods/#{mod.name}"
+        raw_data = get(path)
+        parse_releases(raw_data[:releases], mod:)
+      end
+    end
+
+    private def with_error_handling(mod)
+      yield
+    rescue OpenURI::HTTPError => e
+      case e.io.status
+      in ["404", _]
+        raise Nauvisian::ModNotFound, mod
+      else
+        raise Nauvisian::API::Error, e.io.status
+      end
+    end
+
+    private def parse_releases(raw_releases, mod:)
+      raw_releases.map do |raw_release|
+        data = raw_release.slice(:file_name, :sha1)
+        data[:download_url] = MOD_PORTAL_ENDPOINT_URI + raw_release[:download_url]
+        data[:version] = Nauvisian::Version24[raw_release[:version]]
+        data[:released_at] = Time.parse(raw_release[:released_at])
+        Nauvisian::Mod::Release[mod:, **data]
+      end
+    end
+
+    private def get(path, **params)
+      request_url = MOD_PORTAL_ENDPOINT_URI + path
+      request_url.query = Rack::Utils.build_nested_query(params)
+      data = @cache.fetch(request_url) { request_url.read }
+      JSON.parse(data, symbolize_names: true)
+    end
+  end
+end

data/lib/nauvisian/cache/file_system.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "digest/md5"
+require "pathname"
+
+module Nauvisian
+  module Cache
+    class FileSystem
+      MINIMUM_TTL = 5 * 60 # 5 minutes
+      private_constant :MINIMUM_TTL
+
+      def self.cache_root
+        Pathname(ENV.fetch("XDG_CACHE_HOME", Nauvisian.platform.home_directory / ".cache")) / "nauvisian"
+      end
+
+      def initialize(name:, ttl: MINIMUM_TTL)
+        raise ArgumentError, "ttl is too small (must be >= #{MINIMUM_TTL})" if ttl < MINIMUM_TTL
+
+        @cache_directory = self.class.cache_root / name
+        @ttl = ttl
+      end
+
+      private attr_reader :root
+
+      def fetch(key)
+        path = generate_path(key)
+        return path.binread if path.exist? && !stale?(path, Time.now)
+
+        yield.tap {|content| store(path, content) }
+      end
+
+      private def generate_path(key)
+        digest = Digest::MD5.hexdigest(key.to_s)
+        @cache_directory.join(digest[0..1], digest[2..3], digest[4..])
+      end
+
+      private def stale?(path, time)
+        time - path.mtime > @ttl
+      end
+
+      private def store(path, content)
+        dir = path.dirname
+        dir.mkpath
+
+        # Store into a temporary file
+        tmp = Tempfile.create(".cache-", dir, mode: IO::BINARY | IO::CREAT)
+        tmp.write(content)
+        tmp.close
+
+        # Rename to the desired path
+        File.rename(tmp.path, path)
+      end
+    end
+  end
+end

data/lib/nauvisian/cache.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "cache/file_system"

data/lib/nauvisian/cli/commands/mod/disable.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "../../message_helper"
+
+module Nauvisian
+  module CLI
+    module Commands
+      module Mod
+        class Disable < Dry::CLI::Command
+          include MessageHelper
+
+          desc "Disable an installed MOD"
+          argument :mod, desc: "Target MOD", required: true
+
+          option :mod_directory, desc: "Directory where MODs are installed", required: false, default: Nauvisian.platform.mod_directory.to_s
+
+          def call(mod:, **options)
+            mod_directory = Pathname(options[:mod_directory])
+            mod_list_path = mod_directory / "mod-list.json"
+            list = Nauvisian::ModList.load(mod_list_path)
+            mod = Nauvisian::Mod[name: mod]
+            list.disable(mod)
+            list.save(mod_list_path)
+          rescue Nauvisian::ModNotFound
+            message "❌ You can't disable a MOD which is not in the MOD list (#{mod.name})"
+            exit 1
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nauvisian/cli/commands/mod/download.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "../../download_helper"
+require_relative "../../message_helper"
+
+module Nauvisian
+  module CLI
+    module Commands
+      module Mod
+        class Download < Dry::CLI::Command
+          include DownloadHelper
+          include MessageHelper
+
+          desc "Download a MOD to the current directory"
+          argument :mod, desc: "Target MOD", required: true
+          option :version, desc: "Version to download (default: latest)"
+          option :user, desc: "The user at MOD Portal"
+          option :token, desc: "The token at MOD Portal"
+
+          def call(mod:, **options)
+            credential = find_credential(**options.slice(:user, :token))
+            release = find_release(Nauvisian::Mod[name: mod], version: options.key?(:version) ? Nauvisian::Version24[options[:version]] : nil)
+
+            downloader = Nauvisian::Downloader.new(credential:, progress: Nauvisian::Progress::Bar)
+            downloader.download(release, release.file_name)
+          rescue => e
+            message(e)
+            exit 1
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nauvisian/cli/commands/mod/enable.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "../../message_helper"
+
+module Nauvisian
+  module CLI
+    module Commands
+      module Mod
+        class Enable < Dry::CLI::Command
+          include MessageHelper
+
+          desc "Enable an installed MOD"
+          argument :mod, desc: "Target MOD", required: true
+
+          option :mod_directory, desc: "Directory where MODs are installed", required: false, default: Nauvisian.platform.mod_directory.to_s
+
+          def call(mod:, **options)
+            mod_directory = Pathname(options[:mod_directory])
+            mod_list_path = mod_directory / "mod-list.json"
+            list = Nauvisian::ModList.load(mod_list_path)
+            mod = Nauvisian::Mod[name: mod]
+            list.enable(mod)
+            list.save(mod_list_path)
+          rescue Nauvisian::ModNotFound
+            message "❌ You can't enable a MOD which is not in the MOD list (#{mod.name})"
+            exit 1
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nauvisian/cli/commands/mod/info.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "../../message_helper"
+
+module Nauvisian
+  module CLI
+    module Commands
+      module Mod
+        class Info < Dry::CLI::Command
+          include MessageHelper
+
+          desc "Show info of MOD"
+          argument :mod, desc: "Target MOD", required: true
+
+          def call(mod:, **)
+            api = Nauvisian::API.new
+            mod = Nauvisian::Mod[name: mod]
+            detail = api.detail(mod)
+
+            puts <<~DETAIL
+              Name: #{detail.name}
+              Category: #{detail.category}
+              Downloads: #{detail.downloads_count}
+              URL: #{detail.url}
+              Title: #{detail.title}
+              Summary: #{detail.summary}
+              Owner: #{detail.owner}
+              Created at: #{detail.created_at}
+              Description: #{detail.description}
+            DETAIL
+          rescue => e
+            message(e)
+            exit 1
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nauvisian/cli/commands/mod/installed.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "../../lister"
+require_relative "../../message_helper"
+
+module Nauvisian
+  module CLI
+    module Commands
+      module Mod
+        class Installed < Dry::CLI::Command
+          include MessageHelper
+
+          desc "List installed MODs"
+          option :format, default: "plain", values: Nauvisian::CLI::Lister.all, desc: "Output format"
+          option :mod_directory, desc: "Directory where MODs are installed", required: false, default: Nauvisian.platform.mod_directory.to_s
+
+          def call(*, **options)
+            mod_directory = Pathname(options[:mod_directory])
+            mod_list_path = mod_directory / "mod-list.json"
+            mods = Nauvisian::ModList.load(mod_list_path).sort
+            rows = mods.map {|mod, enabled| {"Name" => mod.name, "Enabled" => enabled} }
+
+            lister = Nauvisian::CLI::Lister.for(options[:format].to_sym).new(%w(Name Enabled))
+            lister.list(rows)
+          rescue => e
+            message(e)
+            exit 1
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nauvisian/cli/commands/mod/latest.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "../../message_helper"
+
+module Nauvisian
+  module CLI
+    module Commands
+      module Mod
+        class Latest < Dry::CLI::Command
+          include MessageHelper
+
+          desc "Show the latest version of MOD"
+          argument :mod, desc: "Target MOD", required: true
+
+          def call(mod:, **)
+            api = Nauvisian::API.new
+            mod = Nauvisian::Mod[name: mod]
+            releases = api.releases(mod)
+            latest = releases.max_by(&:released_at)
+
+            puts latest.version
+          rescue => e
+            message(e)
+            exit 1
+          end
+        end
+      end
+    end
+  end
+end