factorix 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 970e619a2c58b6ee5c7502adc6803469accf6ee618e41e580df5f950a8b2ed15
-  data.tar.gz: 6651e0dea495831ede26d577410722d5ea08542c6ee2516772c413ddec1b7b55
+  metadata.gz: 1f669f6ec36e75ef8f9720e7e09337627d56bc84453233484157643f22a55aa9
+  data.tar.gz: 2029ef6d075978429ddd533c7ba5aa68eb0c16bf77e9c1802bcbfd159844f767
 SHA512:
-  metadata.gz: 6d10a143153a82c1d2b969d928ce85dd22c8c9bf95c793fe27e3287cc5f7408a00fcec47d839295d40390655667a3b1b6e1ab8e76947c9ce98eec8455f87438f
-  data.tar.gz: 2feeb57d5fc6835ee674f3c024b7ef5a4710e3b4f496dc7ada5ecc76add61e1b0fc3dcc3c7e95aea2ae57d131b28d124da04c83bb7ca1c04869067cac251e4c7
+  metadata.gz: f9a17f3a9a83fdf498555deac57a3d9d99b0b33d77a36c8242e5d78e8e85923ed535f4457bf5976e2e3f1b7209214c84e4eda1f9bf00425657b1c8eb471f34de
+  data.tar.gz: 0e6c5bfc9e7a09d4ff3529e976b0f7f90cba03d49d2e98ef70ae9eae07031e1c2de90e7f4235dbeb8d68b32d852afa5a674ecc76bcfb048684f9e229454c9c83

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 ## [Unreleased]
 
+## [0.10.0] - 2026-02-21
+
+### Changed
+
+- Refactor `License` to use flyweight pattern for standard licenses with `.for(id)` method
+- Add `.identifiers` class method to `Category`, `License`, and `Tag`
+- Replace `License.identifier_values` with `License.identifiers`
+
+## [0.9.1] - 2026-02-20
+
+### Added
+
+- Add `mod changelog extract` command to extract a specific version's changelog section
+
 ## [0.9.0] - 2026-02-20
 
 ### Added

data/completion/_factorix.bash

@@ -172,7 +172,7 @@ _factorix() {
             ;;
           changelog)
             if [[ $cword -eq 3 ]]; then
-              COMPREPLY=($(compgen -W "add check release" -- "$cur"))
+              COMPREPLY=($(compgen -W "add check extract release" -- "$cur"))
             else
               case "${words[3]}" in
                 add)
@@ -194,6 +194,15 @@ _factorix() {
                     COMPREPLY=($(compgen -W "$global_opts --release --changelog --info-json" -- "$cur"))
                   fi
                   ;;
+                extract)
+                  if [[ "$prev" == "--changelog" ]]; then
+                    COMPREPLY=($(compgen -f -- "$cur"))
+                  elif [[ "$prev" == "--version" ]]; then
+                    COMPREPLY=($(compgen -W "Unreleased" -- "$cur"))
+                  elif [[ "$cur" == -* ]]; then
+                    COMPREPLY=($(compgen -W "$global_opts --version --json --changelog" -- "$cur"))
+                  fi
+                  ;;
                 release)
                   if [[ "$prev" == "--changelog" ]] || [[ "$prev" == "--info-json" ]]; then
                     COMPREPLY=($(compgen -f -- "$cur"))

data/completion/_factorix.fish

@@ -233,6 +233,7 @@ complete -c factorix -n "__factorix_using_subcommand mod sync" -ra '(__fish_comp
 # mod changelog subcommands
 complete -c factorix -n "__factorix_using_subcommand mod changelog" -a add -d 'Add an entry to MOD changelog'
 complete -c factorix -n "__factorix_using_subcommand mod changelog" -a check -d 'Validate MOD changelog structure'
+complete -c factorix -n "__factorix_using_subcommand mod changelog" -a extract -d 'Extract a changelog section for a specific version'
 complete -c factorix -n "__factorix_using_subcommand mod changelog" -a release -d 'Release Unreleased changelog section with a version'
 
 # mod changelog add options
@@ -240,6 +241,11 @@ complete -c factorix -n "__factorix_using_sub_subcommand mod changelog add" -l v
 complete -c factorix -n "__factorix_using_sub_subcommand mod changelog add" -l category -d 'Category name' -xa "'Major Features' Features 'Minor Features' Graphics Sounds Optimizations Balancing 'Combat Balancing' 'Circuit Network' Changes Bugfixes Modding Scripting Gui Control Translation Debug 'Ease of use' Info Locale Compatibility"
 complete -c factorix -n "__factorix_using_sub_subcommand mod changelog add" -l changelog -d 'Path to changelog file' -rF
 
+# mod changelog extract options
+complete -c factorix -n "__factorix_using_sub_subcommand mod changelog extract" -l version -d 'Version (X.Y.Z or Unreleased)' -ra 'Unreleased'
+complete -c factorix -n "__factorix_using_sub_subcommand mod changelog extract" -l json -d 'Output in JSON format'
+complete -c factorix -n "__factorix_using_sub_subcommand mod changelog extract" -l changelog -d 'Path to changelog file' -rF
+
 # mod changelog check options
 complete -c factorix -n "__factorix_using_sub_subcommand mod changelog check" -l release -d 'Disallow Unreleased section'
 complete -c factorix -n "__factorix_using_sub_subcommand mod changelog check" -l changelog -d 'Path to changelog file' -rF

data/completion/_factorix.zsh

@@ -293,6 +293,7 @@ _factorix_mod_changelog() {
       subcommands=(
         'add:Add an entry to MOD changelog'
         'check:Validate MOD changelog structure'
+        'extract:Extract a changelog section for a specific version'
         'release:Release Unreleased changelog section with a version'
       )
       _describe -t subcommands 'changelog subcommand' subcommands
@@ -314,6 +315,13 @@ _factorix_mod_changelog() {
             '--changelog[Path to changelog file]:changelog file:_files' \
             '--info-json[Path to info.json file]:info.json file:_files'
           ;;
+        extract)
+          _arguments \
+            $global_opts \
+            '--version[Version (X.Y.Z or Unreleased)]:version:(Unreleased)' \
+            '--json[Output in JSON format]' \
+            '--changelog[Path to changelog file]:changelog file:_files'
+          ;;
         release)
           _arguments \
             $global_opts \

data/doc/factorix.1

@@ -184,6 +184,53 @@ Skip confirmation prompts.
 .TP
 .BR \-j ", " \-\-jobs =\fIVALUE\fR
 Number of parallel downloads (default: 4).
+.SS factorix mod changelog add ENTRY
+Add an entry to MOD changelog.
+.TP
+.BR \-\-version =\fIVALUE\fR
+Version (X.Y.Z or Unreleased, default: Unreleased).
+.TP
+.BR \-\-category =\fIVALUE\fR
+Category (e.g., Features, Bugfixes). Required.
+.TP
+.BR \-\-changelog =\fIVALUE\fR
+Path to changelog file (default: changelog.txt).
+.SS factorix mod changelog extract
+Extract a changelog section for a specific version.
+.TP
+.BR \-\-version =\fIVALUE\fR
+Version (X.Y.Z or Unreleased). Required.
+.TP
+.B \-\-json
+Output in JSON format.
+.TP
+.BR \-\-changelog =\fIVALUE\fR
+Path to changelog file (default: changelog.txt).
+.SS factorix mod changelog check
+Validate MOD changelog structure.
+.TP
+.B \-\-release
+Disallow Unreleased section.
+.TP
+.BR \-\-changelog =\fIVALUE\fR
+Path to changelog file (default: changelog.txt).
+.TP
+.BR \-\-info\-json =\fIVALUE\fR
+Path to info.json file (default: info.json).
+.SS factorix mod changelog release
+Convert Unreleased changelog section to a versioned section.
+.TP
+.BR \-\-version =\fIVALUE\fR
+Version (X.Y.Z, default: from info.json).
+.TP
+.BR \-\-date =\fIVALUE\fR
+Release date (YYYY-MM-DD, default: today UTC).
+.TP
+.BR \-\-changelog =\fIVALUE\fR
+Path to changelog file (default: changelog.txt).
+.TP
+.BR \-\-info\-json =\fIVALUE\fR
+Path to info.json file (default: info.json).
 .SH MOD PORTAL COMMANDS
 These commands interact with the Factorio MOD Portal and require authentication.
 .SS factorix mod upload FILE

data/lib/factorix/api/category.rb

@@ -53,6 +53,9 @@ module Factorix
       }.freeze
       private_constant :CATEGORIES
 
+      # @return [Array<String>] all category identifiers
+      def self.identifiers = CATEGORIES.keys
+
       # Get Category instance for the given value
       #
       # Returns predefined instance for known categories (flyweight pattern).

data/lib/factorix/api/license.rb

@@ -9,10 +9,11 @@ module Factorix
     # License object from MOD Portal API
     #
     # Represents a MOD license information.
+    # Uses flyweight pattern for standard licenses.
     # Also provides valid license identifiers for edit_details API.
     #
     # @see https://wiki.factorio.com/Mod_portal_API
-    # @see https://wiki.factorio.com/Mod_details_API
+    # @see https://wiki.factorio.com/Mod_details_API#License
     class License
       # @!attribute [r] id
       #   @return [String] license ID
@@ -25,37 +26,92 @@ module Factorix
       # @!attribute [r] url
       #   @return [URI::HTTPS] license URL
 
-      # Valid license identifiers for edit_details API
-      # Custom licenses (custom_$ID) are not included
-      IDENTIFIERS = {
-        "default_mit" => "MIT",
-        "default_gnugplv3" => "GNU GPLv3",
-        "default_gnulgplv3" => "GNU LGPLv3",
-        "default_mozilla2" => "Mozilla Public License 2.0",
-        "default_apache2" => "Apache License 2.0",
-        "default_unlicense" => "The Unlicense"
+      # Predefined standard license instances
+      DEFAULT_MIT = new(
+        id: "default_mit",
+        name: "MIT",
+        title: "MIT License",
+        description: "A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty.",
+        url: "https://raw.githubusercontent.com/spdx/license-list-data/main/text/MIT.txt"
+      )
+      private_constant :DEFAULT_MIT
+      DEFAULT_GNUGPLV3 = new(
+        id: "default_gnugplv3",
+        name: "GNU GPLv3",
+        title: "GNU General Public License v3.0",
+        description: "The GNU GPL is the most widely used free software license and has a strong copyleft requirement.",
+        url: "https://raw.githubusercontent.com/spdx/license-list-data/main/text/GPL-3.0-or-later.txt"
+      )
+      private_constant :DEFAULT_GNUGPLV3
+      DEFAULT_GNULGPLV3 = new(
+        id: "default_gnulgplv3",
+        name: "GNU LGPLv3",
+        title: "GNU Lesser General Public License v3.0",
+        description: "Version 3 of the GNU LGPL is an additional set of permissions to the GNU GPLv3 license that requires derived works use the same license.",
+        url: "https://raw.githubusercontent.com/spdx/license-list-data/main/text/LGPL-3.0-or-later.txt"
+      )
+      private_constant :DEFAULT_GNULGPLV3
+      DEFAULT_MOZILLA2 = new(
+        id: "default_mozilla2",
+        name: "Mozilla Public License 2.0",
+        title: "Mozilla Public License Version 2.0",
+        description: "The Mozilla Public License (MPL 2.0) attempts to be a compromise between the permissive BSD license and the reciprocal GPL license.",
+        url: "https://raw.githubusercontent.com/spdx/license-list-data/main/text/MPL-2.0.txt"
+      )
+      private_constant :DEFAULT_MOZILLA2
+      DEFAULT_APACHE2 = new(
+        id: "default_apache2",
+        name: "Apache License 2.0",
+        title: "Apache License, Version 2.0",
+        description: "A permissive license that also provides an express grant of patent rights from contributors to users.",
+        url: "https://raw.githubusercontent.com/spdx/license-list-data/main/text/Apache-2.0.txt"
+      )
+      private_constant :DEFAULT_APACHE2
+      DEFAULT_UNLICENSE = new(
+        id: "default_unlicense",
+        name: "The Unlicense",
+        title: "The Unlicense",
+        description: "The Unlicense is a template to waive copyright interest in software and dedicate it to the public domain.",
+        url: "https://raw.githubusercontent.com/spdx/license-list-data/main/text/Unlicense.txt"
+      )
+      private_constant :DEFAULT_UNLICENSE
+
+      # Lookup table for flyweight pattern
+      LICENSES = {
+        "default_mit" => DEFAULT_MIT,
+        "default_gnugplv3" => DEFAULT_GNUGPLV3,
+        "default_gnulgplv3" => DEFAULT_GNULGPLV3,
+        "default_mozilla2" => DEFAULT_MOZILLA2,
+        "default_apache2" => DEFAULT_APACHE2,
+        "default_unlicense" => DEFAULT_UNLICENSE
       }.freeze
-      private_constant :IDENTIFIERS
+      private_constant :LICENSES
 
       # Pattern for custom license identifiers (custom_ + 24 lowercase hex chars)
       CUSTOM_LICENSE_PATTERN = /\Acustom_[0-9a-f]{24}\z/
       private_constant :CUSTOM_LICENSE_PATTERN
 
+      # @return [Array<String>] all license identifiers
+      def self.identifiers = LICENSES.keys
+
+      # Get License instance for the given identifier
+      #
+      # Returns predefined instance for known licenses (flyweight pattern).
+      # Raises an error for unknown license identifiers.
+      #
+      # @param id [String] license identifier
+      # @return [License] License instance
+      # @raise [KeyError] if license identifier is unknown
+      def self.for(id) = LICENSES.fetch(id.to_s)
+
       # Check if the given value is a valid license identifier
       #
       # @param value [String] license identifier
       # @return [Boolean] true if valid (standard or custom license)
       def self.valid_identifier?(value)
-        IDENTIFIERS.key?(value) || CUSTOM_LICENSE_PATTERN.match?(value)
+        LICENSES.key?(value) || CUSTOM_LICENSE_PATTERN.match?(value)
       end
 
-      # List all valid license identifier values
-      #
-      # @return [Array<String>] array of license identifiers
-      def self.identifier_values = IDENTIFIERS.keys
-
-      # Create License from API response hash
-      #
       # @param id [String] license ID
       # @param name [String] license name
       # @param title [String] license title

data/lib/factorix/api/tag.rb

@@ -79,6 +79,9 @@ module Factorix
       }.freeze
       private_constant :TAGS
 
+      # @return [Array<String>] all tag identifiers
+      def self.identifiers = TAGS.keys
+
       # Get Tag instance for the given value
       #
       # Returns predefined instance for known tags (flyweight pattern).

data/lib/factorix/changelog.rb

@@ -89,21 +89,24 @@ module Factorix
     #
     # @return [String]
     def to_s
-      @sections.map {|section| format_section(section) }.join("\n") + "\n"
+      @sections.map {|section| "#{SEPARATOR}\n#{format_section(section)}" }.join("\n") + "\n"
     end
 
-    private def find_or_create_section(version)
-      @sections.find {|s| s.version == version } || create_section(version)
-    end
-
-    private def create_section(version)
-      section = Section[version:, date: nil, categories: {}]
-      @sections.unshift(section)
-      section
+    # Find a section by version
+    #
+    # @param version [MODVersion, String] target version (or Changelog::UNRELEASED)
+    # @return [Section]
+    # @raise [InvalidArgumentError] if the version is not found
+    def find_section(version)
+      @sections.find {|s| s.version == version } or raise InvalidArgumentError, "version not found: #{version}"
     end
 
-    private def format_section(section)
-      lines = [SEPARATOR]
+    # Format a section as plain text (without separator line)
+    #
+    # @param section [Section] changelog section
+    # @return [String]
+    def format_section(section)
+      lines = []
       lines << "Version: #{section.version}"
       lines << "Date: #{section.date}" if section.date
       section.categories.each do |cat, entries|
@@ -117,6 +120,16 @@ module Factorix
       lines.join("\n")
     end
 
+    private def find_or_create_section(version)
+      @sections.find {|s| s.version == version } || create_section(version)
+    end
+
+    private def create_section(version)
+      section = Section[version:, date: nil, categories: {}]
+      @sections.unshift(section)
+      section
+    end
+
     # Parslet grammar for Factorio changelog.txt
     class Grammar < Parslet::Parser
       rule(:newline) { str("\r\n") | str("\n") }

data/lib/factorix/cli/commands/mod/changelog/extract.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Factorix
+  class CLI
+    module Commands
+      module MOD
+        module Changelog
+          # Extract a specific version's changelog section
+          class Extract < Base
+            desc "Extract a changelog section for a specific version"
+
+            option :version, required: true, desc: "Version (X.Y.Z or Unreleased)"
+            option :json, type: :flag, default: false, desc: "Output in JSON format"
+            option :changelog, default: "changelog.txt", desc: "Path to changelog file"
+
+            # @param version [String] version string (X.Y.Z or Unreleased)
+            # @param json [Boolean] output in JSON format
+            # @param changelog [String] path to changelog file
+            # @return [void]
+            def call(version:, json: false, changelog: "changelog.txt", **)
+              target_version = version.casecmp("unreleased").zero? ? Factorix::Changelog::UNRELEASED : MODVersion.from_string(version)
+              log = Factorix::Changelog.load(Pathname(changelog))
+              section = log.find_section(target_version)
+
+              if json
+                out.puts JSON.pretty_generate(version: section.version.to_s, date: section.date, entries: section.categories)
+              else
+                out.puts log.format_section(section)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/factorix/cli/commands/mod/edit.rb

@@ -100,7 +100,7 @@ module Factorix
             return if API::License.valid_identifier?(license)
 
             say "Invalid license identifier: #{license}", prefix: :error
-            say "Valid identifiers: #{API::License.identifier_values.join(", ")}"
+            say "Valid identifiers: #{API::License.identifiers.join(", ")}"
             say "Custom licenses: custom_<24 hex chars> (e.g., custom_0123456789abcdef01234567)"
             raise InvalidArgumentError, "Invalid license identifier"
           end

data/lib/factorix/cli.rb

@@ -21,6 +21,7 @@ module Factorix
     register "completion", Commands::Completion
     register "mod changelog add", Commands::MOD::Changelog::Add
     register "mod changelog check", Commands::MOD::Changelog::Check
+    register "mod changelog extract", Commands::MOD::Changelog::Extract
     register "mod changelog release", Commands::MOD::Changelog::Release
     register "mod check", Commands::MOD::Check
     register "mod list", Commands::MOD::List

data/lib/factorix/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Factorix
-  VERSION = "0.9.0"
+  VERSION = "0.10.0"
   public_constant :VERSION
 end

data/sig/factorix/api/category.rbs

@@ -9,6 +9,7 @@ module Factorix
       attr_reader name: String
       attr_reader description: String
 
+      def self.identifiers: () -> Array[String]
       def self.for: (String value) -> Category
     end
   end

data/sig/factorix/api/license.rbs

@@ -11,8 +11,9 @@ module Factorix
       attr_reader description: String
       attr_reader url: URI::HTTPS
 
+      def self.identifiers: () -> Array[String]
+      def self.for: (String id) -> License
       def self.valid_identifier?: (String value) -> bool
-      def self.identifier_values: () -> Array[String]
 
       def initialize: (id: String, name: String, title: String, description: String, url: String) -> void
     end

data/sig/factorix/api/tag.rbs

@@ -9,6 +9,7 @@ module Factorix
       attr_reader name: String
       attr_reader description: String
 
+      def self.identifiers: () -> Array[String]
       def self.for: (String value) -> Tag
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: factorix
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - OZAWA Sakuro
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-02-20 00:00:00.000000000 Z
+date: 2026-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -270,6 +270,7 @@ files:
 - lib/factorix/cli/commands/man.rb
 - lib/factorix/cli/commands/mod/changelog/add.rb
 - lib/factorix/cli/commands/mod/changelog/check.rb
+- lib/factorix/cli/commands/mod/changelog/extract.rb
 - lib/factorix/cli/commands/mod/changelog/release.rb
 - lib/factorix/cli/commands/mod/check.rb
 - lib/factorix/cli/commands/mod/disable.rb