gfsm 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70aaff4098b16dd514bf52ca1ae4991702935d45dbc32d8049d3eb73f6268aab
-  data.tar.gz: e72643fcbcac5675f2ad65b0a2af8b9034c289fa923c1da1ce24fcb09629a2d5
+  metadata.gz: bcc64afb8b73256994f18c36d2a639a046e0590ec702860b6cc60346cb764752
+  data.tar.gz: '048ff158cca74ebd96952424b7c8246bcae31f99d75a94d679e713411bf7aa51'
 SHA512:
-  metadata.gz: 1aed0209eb39ccda368a53e7660d5a722e40753fddadfd046e10ecbdf5bd5695de4e54af07fc77c24945090ed978a6c400870b291579c59152854e6cdc6c4d1a
-  data.tar.gz: f2953fecd33c22b9cfafaff19ec94cd56b9c8d77fe7f26058979410dd3e30c8ce396330f8d6657d564682dcfe1448a04b0a3627e23b9950db5ab542575304a5c
+  metadata.gz: 0b3283af8114728bc505d00af6e12fe6b7ebc0011e9f3fdddf0fb254752a78e98dc67283ae294c4acf3660ba2a5856c673f53786c6fb1899252df8db52058d42
+  data.tar.gz: 0d739d31c958f5802b595521ec7ed0ad573220a7930d5c79272628fc0172cbf71fc0129ea29ed7fd8a74036ce1f869824eb6af16e251fc6116631ab6421cf9c2

data/.version

@@ -1 +1 @@
-0.4.0
+0.5.0

data/Dockerfile

@@ -1,5 +1,6 @@
 FROM ruby:3.2.4-alpine3.20
 
+RUN apk add git
 RUN gem install gfsm
 
 COPY ./gfsmrc.yml ./gfsmrc.yml

data/lib/commands/changelog.rb

@@ -11,22 +11,27 @@ module GFSM
 
         <<~HELP
         Usage:
-        gfsm changelog [help|generate] [--output-file <path>] [--no-incremental] #{cli_info[:usage]}
+        gfsm changelog [help|generate|extract] [--output-file <path>] [--input-file <path>] [--no-incremental] [--only-new-entries] [--extract-version <version>] #{cli_info[:usage]}
 
         Commands:
         help                                  # Prints this help
         generate                              # Generate the changelog for the current version
+        extract                               # Extract the changelog for the latest or specified version
 
         Options:
         --output-file <path>                  # Path to the output changelog file. Defaults to 'CHANGELOG.md'. If not specified, the generate changelog content will be written to stdout
         --no-incremental                      # When provided, the generated changelog won't look for an existing changelog file. When outputting to stdout the changelog will never be incremental
         --only-new-entries                    # When provided, the generated changelog won't look for an existing changelog file and will contain only the new entries for the current version, without the Changelog or version headings
+        --input-file <path>                   # Path to the input changelog file. Defaults to 'CHANGELOG.md'
+        --extract-version <version>           # Version from which to extract the changelog. Defaults to the latest one on the changelog file
         #{cli_info[:options]}
 
         Environment variables:
         OUTPUT_FILE                           # Equivalent to --output-file
         NO_INCREMENTAL                        # Equivalent to --no-incremental
-        ONLY_ENTRIES                          # Equivalent to --only-new-entries
+        ONLY_NEW_ENTRIES                      # Equivalent to --only-new-entries
+        INPUT_FILE                            # Equivalent to --input-file
+        EXTRACT_VERSION                       # Equivalent to --extract-version
         #{cli_info[:environment_variables]}
         HELP
       end
@@ -64,8 +69,23 @@ module GFSM
               end
             end
           end
+        when 'extract'
+          input_file_path = get_input_file_path(args)
+          version_to_extract = get_version_to_extract(args)
+
+          unless File.file?(input_file_path)
+            GFSM::Output.error "No changelog file found at #{input_file_path}"
+          else
+            section = extract_version_section(input_file_path, version_to_extract)
+
+            if section.nil?
+              GFSM::Output.error "No changelog section found for version #{version_to_extract}"
+            else
+              GFSM::Output.puts section
+            end
+          end
         else
-          GFSM::Output.warn(GFSM::Commands::Version.help)
+          GFSM::Output.warn GFSM::Commands::Version.help
         end
 
         true
@@ -106,6 +126,44 @@ module GFSM
         "#{section}\n\n#{changelog_entries}"
       end
 
+      def extract_version_section(input_file_path, version_to_extract)
+        file_content = File.read(input_file_path)
+
+        # Parse the file contect to subdivide the changelog sections based on the version
+        version_sections = file_content.split(/^## /)
+
+        # Remove the initial empty section
+        version_sections.shift
+
+        version_to_extract_index =  if version_to_extract.nil? || version_to_extract == "latest"
+                                      0
+                                    else
+                                      version_sections.find_index { |section| section.start_with?("#{version_to_extract}\n") }
+                                    end
+        return nil if version_to_extract_index.nil? || version_to_extract_index > version_sections.length
+
+        version_section = version_sections[version_to_extract_index]
+
+        # Remove the first line that contains version heading
+        version_section = version_section[version_section.index("\n")..-1]
+
+        # Remove the empty lines at the start and at the end of version_section
+        version_section = version_section.strip
+
+        return version_section
+      end
+
+      def extract_switch_value(args, switch, default_value, env_name = nil)
+        return ENV.fetch(env_name) if ENV.has_key?(env_name)
+
+        switch_index = args.find_index(switch)
+        
+        return default_value unless switch_index &&
+                                    (switch_index + 1) < args.length
+
+        args[switch_index + 1]
+      end
+
       def extract_switch_value_if_present(args, switch, default_value, env_name)
         return ENV.fetch(env_name) if ENV.has_key?(env_name)
 
@@ -120,6 +178,14 @@ module GFSM
       def get_output_file_path(args)
         extract_switch_value_if_present(args, "--output-file", "./CHANGELOG.md", "OUTPUT_FILE")
       end
+
+      def get_input_file_path(args)
+        extract_switch_value(args, "--input-file", "./CHANGELOG.md", "INPUT_FILE")
+      end
+
+      def get_version_to_extract(args)
+        extract_switch_value(args, "--extract-version", nil, "EXTRACT_VERSION")
+      end
     end
   end
 end

data/lib/tools/git_utilities.rb

@@ -15,14 +15,13 @@ module GFSM
         begin
           repo.fetch(nil, {tags: true})
           repo.describe(nil, {tags: true, abbrev: 0})
-        rescue => error
-          GFSM::Output.error(error.message)
+        rescue
         end
       end
 
       def self.extract_commits_with_changelog_trailer(repo, from, to = "HEAD")
         begin
-          commits = repo.log.between(from, to)
+          commits = from.nil? ? repo.log : repo.log.between(from, to)
           commits.each_with_object([]) do |commit, memo|
             trailer = commit.message.match(CHANGELOG_TRAILER_REGEX)
             memo << GFSM::Data::Commit.new(commit, trailer[:name], trailer[:category]) if trailer

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gfsm
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Zille Marco
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-24 00:00:00.000000000 Z
+date: 2024-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yaml