gfsm 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3daf635392e3b39f025cb94e1a4d73b6d28be9a763e2772b125926414197a81
-  data.tar.gz: 417a58de2b92bdefd1328ea4ebd812dcc9d2576456e69ad5076eb8ec0eb9ae69
+  metadata.gz: 70aaff4098b16dd514bf52ca1ae4991702935d45dbc32d8049d3eb73f6268aab
+  data.tar.gz: e72643fcbcac5675f2ad65b0a2af8b9034c289fa923c1da1ce24fcb09629a2d5
 SHA512:
-  metadata.gz: bb531a7d063939b9aa8da7b00ae64f9050c5da0000540e9b8284415006608ff33d7e528e1f02a2e5ab7150879c807272690fb1394e9f8e7da8e36596fa57af26
-  data.tar.gz: 04da15d2f22e288c0caa21d52788807364762ff8ce88edcabe5677ff4c2c29ed3fbc56a553424d246560eec9ccd25704a1d9750e8244ada5c35e7d5f23fbc8c4
+  metadata.gz: 1aed0209eb39ccda368a53e7660d5a722e40753fddadfd046e10ecbdf5bd5695de4e54af07fc77c24945090ed978a6c400870b291579c59152854e6cdc6c4d1a
+  data.tar.gz: f2953fecd33c22b9cfafaff19ec94cd56b9c8d77fe7f26058979410dd3e30c8ce396330f8d6657d564682dcfe1448a04b0a3627e23b9950db5ab542575304a5c

data/.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

data/.gitignore

@@ -0,0 +1,113 @@
+# Created by https://www.toptal.com/developers/gitignore/api/macos,visualstudiocode,ruby
+# Edit at https://www.toptal.com/developers/gitignore?templates=macos,visualstudiocode,ruby
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### macOS Patch ###
+# iCloud generated files
+*.icloud
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+
+### VisualStudioCode ###
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+!.vscode/*.code-snippets
+
+# Local History for Visual Studio Code
+.history/
+
+# Built Visual Studio Code Extensions
+*.vsix
+
+### VisualStudioCode Patch ###
+# Ignore all local history of files
+.history
+.ionide
+
+# End of https://www.toptal.com/developers/gitignore/api/macos,visualstudiocode,ruby

data/.gitlab-ci.yml

@@ -7,34 +7,44 @@ stages:
 workflow:
   rules:
     # For merge requests, create a pipeline.
-    - if: '$CI_MERGE_REQUEST_IID'
+    - if: "$CI_MERGE_REQUEST_IID"
     # For default branch, create a pipeline.
-    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
+    - if: "$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH"
     # For tags, never create pipeline.
-    - if: '$CI_COMMIT_TAG'
+    - if: "$CI_COMMIT_TAG"
       when: never
 
 Update version:
   stage: version
-  image: ruby:2.7.5
-  before_script:
-    - gem install gfsm
+  image: ruby:3.2.4
   script:
-    - gfsm version bump --force > .version
-    - gfsm changelog --force --output-file CHANGELOG.md
+    - bundle install
+    - chmod +x bin/gfsm
+    - bin/gfsm version bump > .version
+    - bin/gfsm changelog generate
     - echo "RELEASE_VERSION=$(<.version)" >> variables.env
+    - cat CHANGELOG.md
   artifacts:
     reports:
       dotenv: variables.env
     paths:
       - .version
       - CHANGELOG.md
-    
+  variables:
+    FORCE_BUMP: true
+    OUTPUT_FILE: CHANGELOG.md
+  rules:
+    - if: "$CI_MERGE_REQUEST_IID"
+      variables:
+        PRERELEASE: true
+        PRERELEASE_NAME: $CI_COMMIT_REF_SLUG
+    - if: "$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH"
+
 # Publish gem:
 # - GEM_HOST_API_KEY: A valid RubyGems API key.
 Publish gem:
   stage: deploy
-  image: ruby:2.7.5
+  image: ruby:3.2.4
   variables:
     GEMSPEC_FILE: "gfsm.gemspec"
     GEM_FILE: "gfsm-${RELEASE_VERSION}.gem"
@@ -51,11 +61,9 @@ Publish gem:
     paths:
       - "*.gem"
   rules:
-    - if: '$GEM_HOST_API_KEY == null'
+    - if: "$GEM_HOST_API_KEY == null"
       when: never
-    - if: '$CI_COMMIT_BRANCH != $CI_DEFAULT_BRANCH'
-      when: never
-    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
+    - if: "$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH"
 
 Upload docker image:
   stage: docker
@@ -64,12 +72,10 @@ Upload docker image:
     - docker:20.10.16-dind
   script:
     - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
-    - docker build -t $CI_REGISTRY/zille_marco/gitlab-flavored-semantic-versioning:latest -t $CI_REGISTRY/zille_marco/gitlab-flavored-semantic-versioning:v$RELEASE_VERSION .
-    - docker push --all-tags $CI_REGISTRY/zille_marco/gitlab-flavored-semantic-versioning
+    - docker build -t $CI_REGISTRY_IMAGE:latest -t $CI_REGISTRY_IMAGE:v$RELEASE_VERSION .
+    - docker push --all-tags $CI_REGISTRY_IMAGE
   rules:
-    - if: '$CI_COMMIT_BRANCH != $CI_DEFAULT_BRANCH'
-      when: never
-    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
+    - if: "$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH"
 
 Create release:
   stage: release
@@ -85,8 +91,6 @@ Create release:
     - job: "Upload docker image"
       artifacts: false
   rules:
-    - if: '$GEM_HOST_API_KEY == null'
-      when: never
-    - if: '$CI_COMMIT_BRANCH != $CI_DEFAULT_BRANCH'
+    - if: "$GEM_HOST_API_KEY == null"
       when: never
-    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
+    - if: "$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH"

data/.tool-versions

@@ -1 +1 @@
-ruby 2.7.5
+ruby 3.2.4

data/.version

@@ -0,0 +1 @@
+0.4.0

data/.vscode/launch.json

@@ -1,15 +1,14 @@
 {
-    // Use IntelliSense to learn about possible attributes.
-    // Hover to view descriptions of existing attributes.
-    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-    "version": "0.2.0",
-    "configurations": [
-        {
-            "name": "Debug Local File",
-            "type": "Ruby",
-            "request": "launch",
-            "program": "${workspaceRoot}/bin/gfsm",
-            "args": ["version", "bump"]
-        }
-    ]
-}
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "ruby_lsp",
+      "request": "launch",
+      "name": "Debug program",
+      "program": "${workspaceRoot}/bin/gfsm version current"
+    }
+  ]
+}

data/Dockerfile

@@ -1,4 +1,4 @@
-FROM ruby:2.7.5-alpine3.15
+FROM ruby:3.2.4-alpine3.20
 
 RUN gem install gfsm
 

data/Gemfile

@@ -2,6 +2,11 @@
 
 source "https://rubygems.org"
 
-gem "yaml"
-gem "sem_version"
-gem "git"
+gem "yaml", "~> 0.3.0"
+gem "sem_version", "~> 2.0"
+gem "git", "~> 2.1"
+
+group :development do
+  gem "solargraph"
+  gem "debug"
+end

data/Gemfile.lock

@@ -1,20 +1,130 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    git (1.11.0)
+    activesupport (7.1.3.4)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    ast (2.4.2)
+    backport (1.2.0)
+    base64 (0.2.0)
+    benchmark (0.3.0)
+    bigdecimal (3.1.8)
+    concurrent-ruby (1.3.3)
+    connection_pool (2.4.1)
+    debug (1.9.2)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
+    diff-lcs (1.5.1)
+    drb (2.2.1)
+    e2mmap (0.1.0)
+    git (2.1.1)
+      activesupport (>= 5.0)
+      addressable (~> 2.8)
+      process_executer (~> 1.1)
       rchardet (~> 1.8)
+    i18n (1.14.5)
+      concurrent-ruby (~> 1.0)
+    io-console (0.7.2)
+    irb (1.13.2)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    jaro_winkler (1.6.0)
+    json (2.7.2)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    language_server-protocol (3.17.0.3)
+    minitest (5.24.0)
+    mutex_m (0.2.0)
+    nokogiri (1.16.6-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.16.6-x64-mingw-ucrt)
+      racc (~> 1.4)
+    nokogiri (1.16.6-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.25.1)
+    parser (3.3.3.0)
+      ast (~> 2.4.1)
+      racc
+    process_executer (1.1.0)
+    psych (5.1.2)
+      stringio
+    public_suffix (6.0.0)
+    racc (1.8.0)
+    rainbow (3.1.1)
+    rbs (2.8.4)
     rchardet (1.8.0)
+    rdoc (6.7.0)
+      psych (>= 4.0.0)
+    regexp_parser (2.9.2)
+    reline (0.5.9)
+      io-console (~> 0.5)
+    reverse_markdown (2.1.1)
+      nokogiri
+    rexml (3.3.0)
+      strscan
+    rubocop (1.64.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    ruby-progressbar (1.13.0)
     sem_version (2.0.1)
-    yaml (0.2.0)
+    solargraph (0.50.0)
+      backport (~> 1.2)
+      benchmark
+      bundler (~> 2.0)
+      diff-lcs (~> 1.4)
+      e2mmap
+      jaro_winkler (~> 1.5)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.1)
+      parser (~> 3.0)
+      rbs (~> 2.0)
+      reverse_markdown (~> 2.0)
+      rubocop (~> 1.38)
+      thor (~> 1.0)
+      tilt (~> 2.0)
+      yard (~> 0.9, >= 0.9.24)
+    stringio (3.1.1)
+    strscan (3.1.0)
+    thor (1.3.1)
+    tilt (2.3.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
+    yaml (0.3.0)
+    yard (0.9.36)
 
 PLATFORMS
   arm64-darwin-21
+  x64-mingw-ucrt
   x86_64-linux
 
 DEPENDENCIES
-  git
-  sem_version
-  yaml
+  debug
+  git (~> 2.1)
+  sem_version (~> 2.0)
+  solargraph
+  yaml (~> 0.3.0)
 
 BUNDLED WITH
    2.3.17

data/README.md

@@ -78,7 +78,7 @@ stages:
 
 update-version:
   stage: version
-  image: ruby:2.7.5
+  image: ruby:3.2.4
   before_script:
     - gem install gfsm
   script:

data/gfsm.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.description = %q{This gem adds support to bump the semantic version bump and generate changelog file based on the commits trailer.}
   spec.homepage = "https://gitlab.com/zillemarco/gitlab-flavored-semantic-versioning"
   spec.license = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
 
@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.executables = ["gfsm"]
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "yaml"
-  spec.add_dependency "sem_version"
-  spec.add_dependency "git"
+  spec.add_dependency "yaml", "~> 0.3.0"
+  spec.add_dependency "sem_version", "~> 2.0"
+  spec.add_dependency "git", "~> 2.1"
 end

data/lib/commands/changelog.rb

@@ -7,44 +7,49 @@ module GFSM
       NEXT_ENTRY_MARKER = "<!--- next entry here -->"
 
       def self.help
+        cli_info = GFSM::Tools::VersionBumperSettings.cli_info
+
         <<~HELP
-        Usage: gfsm changelog [help] [--output-file [<path>]] [--no-incremental] [--force] [--prerelease] [--prerelease-name <prerelease_name>] [--configuration <configuration_file_path>] [--path <repository_path]
-
-        Arguments:
-            help                                  # Prints this help
-            --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
-            --force                               # When there are no commits with a changelog trailer
-                                                  # the version won't get bumped. Use this flag to force
-                                                  # the version bump (will increase the patch version)
-            --prerelease                          # Use this switch to also include a prerelease in the version.
-                                                  # By default will add 'pre' and increment it like 'pre.1',
-                                                  # 'pre.2' and so on
-            --prerelease-name <name>              # Name of the prerelease that will get added when the
-                                                  # switch is enabled
-            --configuration <path>                # Path to the configuration YAML file
-            --path <path>                         # Path to the repository. By default will use the current directory
+        Usage:
+        gfsm changelog [help|generate] [--output-file <path>] [--no-incremental] #{cli_info[:usage]}
+
+        Commands:
+        help                                  # Prints this help
+        generate                              # Generate the changelog for the current 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
+        #{cli_info[:options]}
+
+        Environment variables:
+        OUTPUT_FILE                           # Equivalent to --output-file
+        NO_INCREMENTAL                        # Equivalent to --no-incremental
+        ONLY_ENTRIES                          # Equivalent to --only-new-entries
+        #{cli_info[:environment_variables]}
         HELP
       end
 
       def run(args = [])
-        if !args.empty? && args[0] == "help"
+        case args.shift
+        when 'help'
           GFSM::Output.puts(GFSM::Commands::Changelog.help)
-        else
-          no_incremental = args.include?("--no-incremental")
+        when 'generate'
+          no_incremental = ENV.has_key?("NO_INCREMENTAL") || args.include?("--no-incremental")
+          only_new_entries = ENV.has_key?("ONLY_NEW_ENTRIES") || args.include?("--only-new-entries")
           output_file_path = get_output_file_path(args)
-          changelog_section = compute_this_version_section(args)
+          changelog_section = compute_this_version_section(args, only_new_entries)
 
-          if !output_file_path
+          if only_new_entries
+            GFSM::Output.puts changelog_section
+          elsif !output_file_path
             GFSM::Output.puts <<~CHANGELOG
               # Changelog
-
               #{changelog_section}
               CHANGELOG
           else
-            if File.exists?(output_file_path) && !no_incremental
+            if File.file?(output_file_path) && !no_incremental
               existing_content = File.read(output_file_path)
 
               file_content = existing_content.gsub(/#{Regexp.quote(NEXT_ENTRY_MARKER)}/i, changelog_section)
@@ -54,12 +59,13 @@ module GFSM
               File.open(output_file_path, 'w') do |file|
                 file.write <<~CHANGELOG
                 # Changelog
-
                 #{changelog_section}
                 CHANGELOG
               end
             end
           end
+        else
+          GFSM::Output.warn(GFSM::Commands::Version.help)
         end
 
         true
@@ -67,15 +73,10 @@ module GFSM
 
       private
 
-      def compute_this_version_section(args)
-        force = args.include?("--force")
-        prerelease = args.include?("--prerelease")
-        prerelease_name = get_prerelease_name(args)
-        repository_path = get_repository_path(args)
-        configuration_file_path = get_configuration_file_path(args)
-
-        version_bumper = GFSM::Tools::VersionBumper.new()
-        version = version_bumper.compute_version!(force, prerelease, prerelease_name, repository_path, configuration_file_path)
+      def compute_this_version_section(args, only_new_entries)
+        settings = GFSM::Tools::VersionBumperSettings.new(args)
+        version_bumper = GFSM::Tools::VersionBumper.new(settings)
+        version = version_bumper.execute
         subdivisions = version_bumper.subdivisions.to_a
         subdivisions.sort_by! { |subdivision_data| subdivision_data[0].priority }.reverse!
 
@@ -85,30 +86,29 @@ module GFSM
           change_type = subdivision_data[0]
           commits = subdivision_data[1]
           
-          changelog_entries += "\n#{change_type.to_changelog_entry}\n\n"
+          changelog_entries += "#{change_type.to_changelog_entry}\n\n"
 
           commits.each do |commit|
             changelog_entries += "- #{commit.to_changelog_entry}\n"
           end
-        end
 
-        if !subdivisions || subdivisions.empty?
-          changelog_section = "#{NEXT_ENTRY_MARKER}\n\n## #{version}\n\n"
-        else
-          changelog_section = "#{NEXT_ENTRY_MARKER}\n\n## #{version}\n#{changelog_entries}"
+          changelog_entries += "\n"
         end
-      end
 
-      def extract_switch_value(args, switch, default_value)
-        switch_index = args.find_index(switch)
-        
-        return default_value unless switch_index &&
-                                    (switch_index + 1) < args.length
+        changelog_entries = changelog_entries[0...-1] unless changelog_entries.empty?
 
-        args[switch_index + 1]
+        return changelog_entries if only_new_entries
+
+        section = "#{NEXT_ENTRY_MARKER}\n## #{version}"
+
+        return section if !subdivisions || subdivisions.empty?
+
+        "#{section}\n\n#{changelog_entries}"
       end
 
-      def extract_switch_value_if_present(args, switch, default_value)
+      def extract_switch_value_if_present(args, switch, default_value, env_name)
+        return ENV.fetch(env_name) if ENV.has_key?(env_name)
+
         switch_index = args.find_index(switch)
 
         return nil unless switch_index
@@ -118,19 +118,7 @@ module GFSM
       end
 
       def get_output_file_path(args)
-        extract_switch_value_if_present(args, "--output-file", "./CHANGELOG.md")
-      end
-
-      def get_configuration_file_path(args)
-        extract_switch_value(args, "--configuration", "./gfsmrc.yml")
-      end
-
-      def get_prerelease_name(args)
-        extract_switch_value(args, "--prerelease-name", "pre")
-      end
-      
-      def get_repository_path(args)
-        extract_switch_value(args, "--path", ".")
+        extract_switch_value_if_present(args, "--output-file", "./CHANGELOG.md", "OUTPUT_FILE")
       end
     end
   end

data/lib/commands/help.rb

@@ -7,22 +7,20 @@ module GFSM
         GFSM::Output.puts <<~HELP
         # GitLab Flavored Semantic Versioning
 
-        Usage: gfsm <command> [<args>]
+        Usage:
+        
+        gfsm <command> [<args>]
 
         Available commands:
+        gfsm help               # Print this help text
+        gfsm version            # Command used to print the current version or bump it based on the configuration
+        gfsm changelog          # Command used to generate a changelog based on the commits since the latest release
 
-          gfsm help               # Print this help text
-          gfsm version            # Command used to print the current version or bump it based on the configuration
-          gfsm changelog          # Command used to generate a changelog based on the commits since the latest release
-
-        # Version command
 
+        Version command
         #{GFSM::Commands::Version.help}
-
-        # Changelog command
-
+        Changelog command
         #{GFSM::Commands::Changelog.help}
-
         HELP
 
         true

data/lib/commands/version.rb

@@ -5,44 +5,38 @@ module GFSM
     class Version < BaseCommand
 
       def self.help
+        cli_info = GFSM::Tools::VersionBumperSettings.cli_info
+
         <<~HELP
-        Usage: gfsm version [help] [bump [--force] [--prerelease] [--prerelease-name <prerelease_name>] [--configuration <configuration_file_path>] [--path <repository_path]]
+        Usage:
+        gfsm version [help|bump|current] #{cli_info[:usage]}
+
+        Commands:
+        help                                  # Prints this help
+        bump                                  # Bump the current version based on the commits changelog trailer and the configuration file
+        current                               # Print the current version, without bumping it
+
+        Options: \n#{cli_info[:options]}
 
-        Arguments:
-            help                                  # Prints this help
-            bump                                  # Bump the current version based on the commits
-                                                  # changelog trailer and the configuration file
-            --force                               # When there are no commits with a changelog trailer
-                                                  # the version won't get bumped. Use this flag to force
-                                                  # the version bump (will increase the patch version)
-            --prerelease                          # Use this switch to also include a prerelease in the version.
-                                                  # By default will add 'pre' and increment it like 'pre.1',
-                                                  # 'pre.2' and so on
-            --prerelease-name <name>              # Name of the prerelease that will get added when the
-                                                  # switch is enabled
-            --configuration <path>                # Path to the configuration YAML file
-            --path <path>                         # Path to the repository. By default will use the current directory
+        Environment variables: \n#{cli_info[:environment_variables]}
         HELP
       end
 
       def run(args = [])
-        if args.empty? || (args.length == 2 && args[0] != "bump")
-          repository_path = get_repository_path(args)
-
-          GFSM::Output.puts GFSM::Tools::CurrentVersionLoader.load_current_version(repository_path)
-          return true
-        end
-
         case args.shift
         when 'bump'
-          force = args.include?("--force")
-          prerelease = args.include?("--prerelease")
-          prerelease_name = get_prerelease_name(args)
-          repository_path = get_repository_path(args)
-          configuration_file_path = get_configuration_file_path(args)
+          settings = GFSM::Tools::VersionBumperSettings.new(args)
+          version_bumper = GFSM::Tools::VersionBumper.new(settings)
+          version = version_bumper.execute
+
+          GFSM::Output.puts(version)
+        when 'current'
+          settings = GFSM::Tools::VersionBumperSettings.new(args)
+          version = GFSM::Tools::CurrentVersionLoader.load_current_version(settings.repository)
 
-          version_bumper = GFSM::Tools::VersionBumper.new()
-          version = version_bumper.compute_version!(force, prerelease, prerelease_name, repository_path, configuration_file_path)
+          if settings.prerelease
+            version.add_prerelease_suffix!(settings.prerelease_name)
+          end
 
           GFSM::Output.puts(version)
         when 'help'
@@ -53,29 +47,6 @@ module GFSM
 
         true
       end
-
-      private
-
-      def extract_switch_value(args, switch, default_value)
-        switch_index = args.find_index(switch)
-        
-        return default_value unless switch_index &&
-                                    (switch_index + 1) < args.length
-
-        args[switch_index + 1]
-      end
-
-      def get_configuration_file_path(args)
-        extract_switch_value(args, "--configuration", "./gfsmrc.yml")
-      end
-
-      def get_prerelease_name(args)
-        extract_switch_value(args, "--prerelease-name", "pre")
-      end
-      
-      def get_repository_path(args)
-        extract_switch_value(args, "--path", ".")
-      end
     end
   end
 end

data/lib/data/version.rb

@@ -7,7 +7,7 @@ module GFSM
     class Version < SemVersion
       PRERELEASE_BUILD_VERSION = /^(?<prerelease_name>[a-zA-Z\-]+)(\.?)(?<prerelease_version>[0-9]*)$/i
 
-      def bump!(major = false, minor = false, patch = true, pre = false, prerelease_name = "pre")
+      def bump!(major = false, minor = false, patch = true, pre = false, prerelease_name)
         if major
           self.major = self.major + 1
           self.minor = 0
@@ -20,12 +20,16 @@ module GFSM
         end
 
         if pre
-          preselease_match = self.pre.match(PRERELEASE_BUILD_VERSION) if self.pre
-          if preselease_match
-            self.pre = preselease_match[:prerelease_name] + "." + (preselease_match[:prerelease_version].to_i + 1).to_s
-          else
-            self.pre = prerelease_name
-          end
+          self.add_prerelease_suffix!(prerelease_name)
+        end
+      end
+
+      def add_prerelease_suffix!(prerelease_name)
+        preselease_match = self.pre.match(PRERELEASE_BUILD_VERSION) if self.pre
+        if preselease_match
+          self.pre = preselease_match[:prerelease_name] + "." + (preselease_match[:prerelease_version].to_i + 1).to_s
+        else
+          self.pre = prerelease_name
         end
       end
     end

data/lib/tools/current_version_loader.rb

@@ -6,10 +6,8 @@ require_relative '../data/version'
 module GFSM
   module Tools
     class CurrentVersionLoader
-      def self.load_current_version(repo_path = ".")
-        last_tag_name = GFSM::Tools::GitUtilities.extract_last_tag_name(
-          GFSM::Tools::GitUtilities.load_repo(repo_path)
-        )
+      def self.load_current_version(repo)
+        last_tag_name = GFSM::Tools::GitUtilities.extract_last_tag_name(repo)
 
         return GFSM::Data::Version.new("0.0.0") unless last_tag_name
 

data/lib/tools/git_utilities.rb

@@ -13,23 +13,16 @@ module GFSM
 
       def self.extract_last_tag_name(repo)
         begin
-          current_sort_order = repo.config("tag.sort")
-          repo.fetch(tags: true)
-
-          repo.config("tag.sort", "-v:refname")
-          tags = repo.tags
-          repo.config("tag.sort", current_sort_order)
-
-          tags[0].name if !tags.empty?
-        rescue
+          repo.fetch(nil, {tags: true})
+          repo.describe(nil, {tags: true, abbrev: 0})
+        rescue => error
+          GFSM::Output.error(error.message)
         end
       end
 
-      def self.extract_commits_with_changelog_trailer(repo)
-        last_tag_name = self.extract_last_tag_name(repo)
-
+      def self.extract_commits_with_changelog_trailer(repo, from, to = "HEAD")
         begin
-          commits = last_tag_name ? repo.log.between(last_tag_name, 'HEAD') : repo.log
+          commits = 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

data/lib/tools/version_bumper.rb

@@ -5,25 +5,111 @@ require_relative '../data/version'
 
 module GFSM
   module Tools
+
+    class VersionBumperSettings
+      attr_reader :repository, :configuration, :force, :force_version, :prerelease, :prerelease_name, :from, :to
+
+      def initialize(cli_args)
+        @repository = GFSM::Tools::GitUtilities.load_repo(get_repository_path(cli_args))
+        @configuration = GFSM::Data::Configuration.new(get_configuration_file_path(cli_args))
+        @force = ENV.has_key?("FORCE_BUMP") || cli_args.include?("--force")
+        @force_version = get_force_version(cli_args)
+        @prerelease = ENV.has_key?("PRERELEASE") || cli_args.include?("--prerelease")
+        @prerelease_name = get_prerelease_name(cli_args)
+        @from = get_from(cli_args)
+        @to = get_to(cli_args)
+        @from = GFSM::Tools::GitUtilities.extract_last_tag_name(@repository) if @from.nil?
+      end
+
+      def self.cli_info
+        options = <<~OPTIONS
+          --force                               # When there are no commits with a changelog trailer the version won't get bumped. Use this flag to force the version bump. Unless specified, it will increase the patch
+          --force-version <major|minor|match>   # What section of the version to bump if the changelog trailer is not found.
+          --prerelease                          # Use this switch to also include a prerelease in the version. By default will add 'pre' and increment it like 'pre.1', 'pre.2' and so on
+          --prerelease-name <name>              # Name of the prerelease that will get added when the switch is enabled
+          --configuration <path>                # Path to the configuration YAML file
+          --from <hash or tag>                  # The commit hash or tag to start from when extracting the commits. By default will use the latest tag
+          --to <hash, tag or HEAD>              # The commit hash or tag to stop at when extracting the commits. By default will use HEAD to get to the latest commit on the current branch
+          --configuration <path>                # Path to the configuration YAML file
+          --path <path>                         # Path to the repository. By default will use the current directory
+        OPTIONS
+
+        environment_variables = <<~ENVVARS
+          FORCE_BUMP                            # Equivalent to --force
+          FORCE_BUMP_VERSION                    # Equivalent to --force-version
+          PRERELEASE                            # Equivalent to --prerelease
+          PRERELEASE_NAME                       # Equivalent to --prerelease-name
+          CONFIGURATION_FILE                    # Equivalent to --configuration
+          REPOSITORY_PATH                       # Equivalent to --path
+          FROM_COMMIT                           # Equivalent to --from
+          TO_COMMIT                             # Equivalent to --to
+        ENVVARS
+
+        return {
+          usage: "[--force] [--force-version <major|minor|patch>] [--configuration <configuration_file_path>] [--prerelease] [--prerelease-name <prerelease_name>] [--from <hash or tag>] [--to <hash, tag or HEAD>] [--path <repository_path]",
+          options: options,
+          environment_variables: environment_variables
+        }
+      end
+
+      private
+
+      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 get_configuration_file_path(args)
+        extract_switch_value(args, "--configuration", "./gfsmrc.yml", "CONFIGURATION_FILE")
+      end
+
+      def get_prerelease_name(args)
+        extract_switch_value(args, "--prerelease-name", "pre", "PRERELEASE_NAME")
+      end
+      
+      def get_repository_path(args)
+        extract_switch_value(args, "--path", ".", "REPOSITORY_PATH")
+      end
+      
+      def get_force_version(args)
+        extract_switch_value(args, "--force-version", "patch", "FORCE_BUMP_VERSION")
+      end
+      
+      def get_from(args)
+        extract_switch_value(args, "--from", nil, "FROM_COMMIT")
+      end
+      
+      def get_to(args)
+        extract_switch_value(args, "--to", "HEAD", "TO_COMMIT")
+      end
+    end
+
     class VersionBumper
       attr_reader :version, :subdivisions
 
-      def compute_version!(force, prerelease, prerelease_name, repository_path, configuration_file_path)
-        configuration = GFSM::Data::Configuration.new(configuration_file_path)
-        changelog_commits = GFSM::Tools::GitUtilities.extract_commits_with_changelog_trailer(
-          GFSM::Tools::GitUtilities.load_repo(repository_path)
-        )
+      def initialize(settings)
+        @settings = settings
+      end
+
+      def execute
+        changelog_commits = GFSM::Tools::GitUtilities.extract_commits_with_changelog_trailer(@settings.repository, @settings.from, @settings.to)
 
-        @version = GFSM::Tools::CurrentVersionLoader.load_current_version(repository_path)
-        @subdivisions = GFSM::Tools::CommitsSubdivider.subdivide_commits(configuration, changelog_commits)
+        @version = GFSM::Tools::CurrentVersionLoader.load_current_version(@settings.repository)
+        @subdivisions = GFSM::Tools::CommitsSubdivider.subdivide_commits(@settings.configuration, changelog_commits)
 
-        if !subdivisions || subdivisions.empty?
-          if force
-            @version.bump!(false, false, true, prerelease, prerelease_name)
+        if !@subdivisions || @subdivisions.empty?
+          if @settings.force
+            @version.bump!(@settings.force_version == "major", @settings.force_version == "minor", @settings.force_version == "patch", @settings.prerelease, @settings.prerelease_name)
           end
         else
-          highest_bump = GFSM::Data::ChangeType.find_highest_bump(subdivisions.keys)
-          @version.bump!(highest_bump == :major, highest_bump == :minor, highest_bump == :patch, prerelease, prerelease_name)
+          highest_bump = GFSM::Data::ChangeType.find_highest_bump(@subdivisions.keys)
+          @version.bump!(highest_bump == :major, highest_bump == :minor, highest_bump == :patch, @settings.prerelease, @settings.prerelease_name)
         end
 
         return @version

metadata

@@ -1,69 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: gfsm
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Zille Marco
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-29 00:00:00.000000000 Z
+date: 2024-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yaml
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: sem_version
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: git
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
 description: This gem adds support to bump the semantic version bump and generate
   changelog file based on the commits trailer.
-email: 
+email:
 executables:
 - gfsm
 extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
+- ".gitattributes"
 - ".gitignore"
 - ".gitlab-ci.yml"
 - ".tool-versions"
+- ".version"
 - ".vscode/launch.json"
 - Dockerfile
 - Gemfile
@@ -94,7 +96,7 @@ metadata:
   homepage_uri: https://gitlab.com/zillemarco/gitlab-flavored-semantic-versioning
   source_code_uri: https://gitlab.com/zillemarco/gitlab-flavored-semantic-versioning
   changelog_uri: https://gitlab.com/zillemarco/gitlab-flavored-semantic-versioning/-/releases
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -102,15 +104,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.4.19
+signing_key:
 specification_version: 4
 summary: This gem adds support to bump the semantic version bump and generate changelog
   file based on the commits trailer.