factorix 0.5.0 → 0.6.0

data/lib/factorix.rb

@@ -1,13 +1,86 @@
 # frozen_string_literal: true
 
 require "dry/auto_inject"
+require "dry/configurable"
 require "zeitwerk"
 require_relative "factorix/errors"
 require_relative "factorix/version"
 
 # Factorix provides a CLI for Factorio MOD management, settings synchronization,
 # and MOD Portal integration.
+#
+# @example Configure Factorix
+#   Factorix.configure do |config|
+#     config.log_level = :debug
+#     config.http.connect_timeout = 10
+#   end
 module Factorix
+  extend Dry::Configurable
+
+  # Log level (:debug, :info, :warn, :error, :fatal)
+  setting :log_level, default: :info
+
+  # Runtime settings (optional overrides for auto-detection)
+  setting :runtime do
+    setting :executable_path, constructor: ->(v) { v ? Pathname(v) : nil }
+    setting :user_dir, constructor: ->(v) { v ? Pathname(v) : nil }
+    setting :data_dir, constructor: ->(v) { v ? Pathname(v) : nil }
+  end
+
+  # HTTP timeout settings
+  setting :http do
+    setting :connect_timeout, default: 5
+    setting :read_timeout, default: 30
+    setting :write_timeout, default: 30
+  end
+
+  # Cache settings
+  setting :cache do
+    # Download cache settings (for MOD files)
+    setting :download do
+      setting :dir, constructor: ->(value) { Pathname(value) }
+      setting :ttl, default: nil # nil for unlimited (MOD files are immutable)
+      setting :max_file_size, default: nil # nil for unlimited
+      setting :compression_threshold, default: nil # nil for no compression (binary files)
+    end
+
+    # API cache settings (for API responses)
+    setting :api do
+      setting :dir, constructor: ->(value) { Pathname(value) }
+      setting :ttl, default: 3600 # 1 hour (API responses may change)
+      setting :max_file_size, default: 10 * 1024 * 1024 # 10MiB (JSON responses)
+      setting :compression_threshold, default: 0 # always compress (JSON is highly compressible)
+    end
+
+    # info.json cache settings (for MOD metadata from ZIP files)
+    setting :info_json do
+      setting :dir, constructor: ->(value) { Pathname(value) }
+      setting :ttl, default: nil # nil for unlimited (info.json is immutable within a MOD ZIP)
+      setting :max_file_size, default: nil # nil for unlimited (info.json is small)
+      setting :compression_threshold, default: 0 # always compress (JSON is highly compressible)
+    end
+  end
+
+  # Load configuration from file
+  #
+  # @param path [Pathname, nil] configuration file path
+  # @return [void]
+  # @raise [ConfigurationError] if explicitly specified path does not exist
+  def self.load_config(path=nil)
+    if path
+      # Explicitly specified path must exist
+      raise ConfigurationError, "Configuration file not found: #{path}" unless path.exist?
+
+      config_path = path
+    else
+      # Default path is optional
+      config_path = Container.resolve(:runtime).factorix_config_path
+      return unless config_path.exist?
+    end
+
+    instance_eval(config_path.read, config_path.to_s)
+  end
+
   loader = Zeitwerk::Loader.for_gem
   loader.ignore("#{__dir__}/factorix/version.rb")
   loader.ignore("#{__dir__}/factorix/errors.rb")
@@ -33,6 +106,50 @@ module Factorix
   )
   loader.setup
 
-  Import = Dry::AutoInject(Application)
+  Import = Dry::AutoInject(Container)
   public_constant :Import
+
+  # Initialize cache directory defaults after Container is loaded
+  runtime = Container.resolve(:runtime)
+  config.cache.download.dir = runtime.factorix_cache_dir / "download"
+  config.cache.api.dir = runtime.factorix_cache_dir / "api"
+  config.cache.info_json.dir = runtime.factorix_cache_dir / "info_json"
+
+  # @deprecated Use {Container} for DI and {Factorix} for configuration. Will be removed in v1.0.
+  class Application
+    # @!method [](key)
+    #   @deprecated Use {Container.[]} instead
+    def self.[](key)
+      warn "[factorix] Factorix::Application is deprecated, use Factorix::Container for DI"
+      Container[key]
+    end
+
+    # @!method resolve(key)
+    #   @deprecated Use {Container.resolve} instead
+    def self.resolve(key)
+      warn "[factorix] Factorix::Application is deprecated, use Factorix::Container for DI"
+      Container.resolve(key)
+    end
+
+    # @!method register(...)
+    #   @deprecated Use {Container.register} instead
+    def self.register(...)
+      warn "[factorix] Factorix::Application is deprecated, use Factorix::Container for DI"
+      Container.register(...)
+    end
+
+    # @!method config
+    #   @deprecated Use {Factorix.config} instead
+    def self.config
+      warn "[factorix] Factorix::Application is deprecated, use Factorix.config for configuration"
+      Factorix.config
+    end
+
+    # @!method configure(&block)
+    #   @deprecated Use {Factorix.configure} instead
+    def self.configure(&)
+      warn "[factorix] Factorix::Application is deprecated, use Factorix.configure for configuration"
+      Factorix.configure(&)
+    end
+  end
 end

data/sig/factorix/container.rbs

@@ -0,0 +1,15 @@
+# RBS type signature file
+# NOTE: Do not include private method definitions in RBS files.
+#       Only public interfaces should be documented here.
+
+module Factorix
+  class Container
+    extend Dry::Core::Container::Mixin
+
+    def self.register: (Symbol, ?memoize: bool) { () -> untyped } -> void
+
+    def self.resolve: (Symbol) -> untyped
+
+    def self.[]: (Symbol) -> untyped
+  end
+end

data/sig/factorix.rbs

@@ -6,4 +6,103 @@ module Factorix
   VERSION: String
 
   Import: Dry::AutoInject::_Builder
+
+  extend Dry::Configurable
+
+  def self.config: () -> Config
+
+  def self.configure: () { (Config) -> void } -> void
+
+  def self.load_config: (?Pathname? path) -> void
+
+  class Config
+    def log_level: () -> Symbol
+
+    def log_level=: (Symbol) -> void
+
+    def credential: () -> CredentialConfig
+
+    def runtime: () -> RuntimeConfig
+
+    def http: () -> HttpConfig
+
+    def cache: () -> CacheConfig
+  end
+
+  class CredentialConfig
+    def source: () -> Symbol
+
+    def source=: (Symbol) -> void
+  end
+
+  class RuntimeConfig
+    def executable_path: () -> Pathname?
+
+    def executable_path=: (Pathname | String | nil) -> void
+
+    def user_dir: () -> Pathname?
+
+    def user_dir=: (Pathname | String | nil) -> void
+
+    def data_dir: () -> Pathname?
+
+    def data_dir=: (Pathname | String | nil) -> void
+  end
+
+  class HttpConfig
+    def connect_timeout: () -> Integer
+
+    def connect_timeout=: (Integer) -> void
+
+    def read_timeout: () -> Integer
+
+    def read_timeout=: (Integer) -> void
+
+    def write_timeout: () -> Integer
+
+    def write_timeout=: (Integer) -> void
+  end
+
+  class CacheConfig
+    def download: () -> CacheInstanceConfig
+
+    def api: () -> CacheInstanceConfig
+
+    def info_json: () -> CacheInstanceConfig
+
+    def values: () -> Hash[Symbol, CacheInstanceConfig]
+  end
+
+  class CacheInstanceConfig
+    def dir: () -> Pathname
+
+    def dir=: (Pathname | String) -> void
+
+    def ttl: () -> Integer?
+
+    def ttl=: (Integer?) -> void
+
+    def max_file_size: () -> Integer?
+
+    def max_file_size=: (Integer?) -> void
+
+    def compression_threshold: () -> Integer?
+
+    def compression_threshold=: (Integer?) -> void
+
+    def to_h: () -> Hash[Symbol, untyped]
+  end
+
+  # @deprecated Use Container for DI and Factorix for configuration
+  class Application
+    def self.[]: (Symbol) -> untyped
+
+    def self.resolve: (Symbol) -> untyped
+
+    def self.register: (Symbol, ?memoize: bool) { () -> untyped } -> void
+
+    def self.config: () -> Config
+
+    def self.configure: () { (Config) -> void } -> void
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: factorix
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - OZAWA Sakuro
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-12-26 00:00:00.000000000 Z
+date: 2026-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -221,7 +221,6 @@ files:
 - lib/factorix/api/release.rb
 - lib/factorix/api/tag.rb
 - lib/factorix/api_credential.rb
-- lib/factorix/application.rb
 - lib/factorix/cache/file_system.rb
 - lib/factorix/cli.rb
 - lib/factorix/cli/commands/backup_support.rb
@@ -255,6 +254,7 @@ files:
 - lib/factorix/cli/commands/path.rb
 - lib/factorix/cli/commands/requires_game_stopped.rb
 - lib/factorix/cli/commands/version.rb
+- lib/factorix/container.rb
 - lib/factorix/dependency/edge.rb
 - lib/factorix/dependency/entry.rb
 - lib/factorix/dependency/graph.rb
@@ -322,7 +322,6 @@ files:
 - sig/factorix/api/release.rbs
 - sig/factorix/api/tag.rbs
 - sig/factorix/api_credential.rbs
-- sig/factorix/application.rbs
 - sig/factorix/cache/file_system.rbs
 - sig/factorix/cli.rbs
 - sig/factorix/cli/commands/base.rbs
@@ -353,6 +352,7 @@ files:
 - sig/factorix/cli/commands/path.rbs
 - sig/factorix/cli/commands/requires_game_stopped.rbs
 - sig/factorix/cli/commands/version.rbs
+- sig/factorix/container.rbs
 - sig/factorix/dependency/edge.rbs
 - sig/factorix/dependency/entry.rbs
 - sig/factorix/dependency/graph.rbs

data/sig/factorix/application.rbs

@@ -1,86 +0,0 @@
-# RBS type signature file
-# NOTE: Do not include private method definitions in RBS files.
-#       Only public interfaces should be documented here.
-
-module Factorix
-  class Application
-    extend Dry::Core::Container::Mixin
-    extend Dry::Configurable
-
-    def self.register: (Symbol, ?memoize: bool) { () -> untyped } -> void
-
-    def self.resolve: (Symbol) -> untyped
-
-    def self.[]: (Symbol) -> untyped
-
-    def self.config: () -> Config
-
-    def self.configure: () { (Config) -> void } -> void
-
-    def self.load_config: (?String? path) -> void
-
-    class Config
-      def log_level: () -> Symbol
-
-      def log_level=: (Symbol) -> void
-
-      def credential: () -> CredentialConfig
-
-      def runtime: () -> RuntimeConfig
-
-      def http: () -> HttpConfig
-
-      def cache: () -> CacheConfig
-    end
-
-    class CredentialConfig
-      def source: () -> Symbol
-
-      def source=: (Symbol) -> void
-    end
-
-    class RuntimeConfig
-      def executable_path: () -> Pathname?
-
-      def executable_path=: (Pathname | String | nil) -> void
-
-      def user_dir: () -> Pathname?
-
-      def user_dir=: (Pathname | String | nil) -> void
-    end
-
-    class HttpConfig
-      def connect_timeout: () -> Integer
-
-      def connect_timeout=: (Integer) -> void
-
-      def read_timeout: () -> Integer
-
-      def read_timeout=: (Integer) -> void
-
-      def write_timeout: () -> Integer
-
-      def write_timeout=: (Integer) -> void
-    end
-
-    class CacheConfig
-      def download: () -> CacheInstanceConfig
-
-      def api: () -> CacheInstanceConfig
-    end
-
-    class CacheInstanceConfig
-      def dir: () -> Pathname
-
-      def dir=: (Pathname | String) -> void
-
-      def ttl: () -> Integer?
-
-      def ttl=: (Integer?) -> void
-
-      def max_file_size: () -> Integer?
-
-      def max_file_size=: (Integer?) -> void
-    end
-  end
-end