conventional_commits 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6ae6b0c24851cd4187e486f651d0e4d9771976ff141916308d7af9ebdc04dcb
-  data.tar.gz: 89e014f037a44a66af16de22d1ef343f98628e7872e79391fad3b342bc5b23f4
+  metadata.gz: e94ddfbbf30fd22858780223ccc4251e6b6aeeef1935e0bff4f792686b973423
+  data.tar.gz: f1c41daf369141f2af48e6d022661e00177a645a9797cb176693433c4d4579c0
 SHA512:
-  metadata.gz: 20c152762ded992258897e4f7d5a72ea9fa737aea6a47151f43d890f308bb2d193fca2b4bc57d3930b9ef74af04128cecc5fae770c03fe1afc6fe552cdc9574d
-  data.tar.gz: 0eaa4b6db66729c636cd540ca7fdf98a411b0d99016d373556948586bffcb07be6fc7c378139e3e813a7a26c29a82df3cce91942f0e6f986133d3afccd926b92
+  metadata.gz: e711c88f885c94c5e920d89f9f6c3d97c3faa35b21df2af332a5016623aa4df2759d5ad73d1456452262f3005489f8ba0bbb2813f36a743c623e95630581cc4d
+  data.tar.gz: 6a314e124e6a37b296624fcceda4b3b0a4a0a72e729018535fcf7fa8752e7ab148aba23cd9771f6f8156820c37a96efc02b83bfbcf34da04caad9be970c459d3

data/.conventional_commits/config.yml

@@ -1,7 +1,7 @@
 branch:
   lowercase: true
   ticket_prefix: JIRA
-  pattern: <type>/<ticket>/<description>
+  pattern: <scope>/<type>/<ticket>/<description>
 type:
   feat: [ feature, feat ]
   fix: [ bug, bugfix, fix ]

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    conventional_commits (0.1.1)
+    conventional_commits (0.2.1)
       open3
       thor
       yaml
@@ -52,7 +52,7 @@ GEM
     language_server-protocol (3.17.0.3)
     mini_mime (1.1.5)
     multi_test (1.1.0)
-    open3 (0.1.1)
+    open3 (0.2.1)
     parallel (1.24.0)
     parser (3.3.0.5)
       ast (~> 2.4.1)

data/conventional_commits.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.summary = "Make your commit unified."
   spec.description = "Enforces conventional commits specs."
   spec.homepage = "https://github.com/Swift-Gurus/conventional_commits"
-  spec.required_ruby_version = ">= 3.1.0"
+  spec.required_ruby_version = ">= 3.1"
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
 

data/lib/branch/branch_name_generator.rb

@@ -32,12 +32,19 @@ module ConventionalCommits
         modified_input = splits[1] || ""
       end
       out.push(modified_input) unless modified_input.empty?
-      if delimiters.length + 1 > out.length
+      if delimiters.length > out.length
         raise ConventionalCommits::GenericError,
               "The branch doesnt respect the template, expect #{delimiters.length} delimiters. Received: #{received}".strip
       end
 
-      out
+      scope_is_included = out.length == Configuration::MAX_ELEMENTS_IN_PATTERN
+      idx_adj = scope_is_included ? 1 : 0
+      components = { scope: nil, type: nil, ticket_number: nil, description: nil }
+      components[:scope] = out.length == Configuration::MAX_ELEMENTS_IN_PATTERN ? out[0] : nil
+      components[:type] = out[0 + idx_adj]
+      components[:ticket_number] = out[1 + idx_adj]
+      components[:description] = out[2 + idx_adj]
+      components
     end
 
     def is_valid_branch(_input, path: Configuration::DEFAULT_CONFIGURATION_PATH)
@@ -47,7 +54,8 @@ module ConventionalCommits
     private
 
     def find_delimiters_from_pattern(pattern: string)
-      delimiters = pattern.gsub(/<type>/, "<replace>")
+      delimiters = pattern.gsub(/<scope>/, "<replace>")
+                          .gsub(/<type>/, "<replace>")
                           .gsub(/<ticket>/, "<replace>")
                           .gsub(/<description>/, "<replace>")
                           .split("<replace>")

data/lib/commit/commit_message_generator.rb

@@ -8,19 +8,22 @@ module ConventionalCommits
       main_config = Configuration::MainConfigurationReader.new.get_configuration(path: cfg_path)
       configuration = main_config.branch
       components = BranchNameGenerator.new.branch_name_components(branch_name, path: cfg_path)
-      type = (components[0] || "").downcase
-      ticket_number = components[1] || ""
-      description = components[2] || ""
+      scope = (components[:scope] || "").downcase
+      type = (components[:type] || "").downcase
+      ticket_number = components[:ticket_number] || ""
+      description = components[:description] || ""
       description = description.gsub(/-/, " ").gsub(/_/, " ")
 
       unless main_config.type.is_allowed(type)
         raise ConventionalCommits::GenericError,
               "The type #{type} is not allowed. Allowed types #{main_config.type.all_types}"
       end
-      type = "#{main_config.type.main_type(type)}: #{description}".strip
 
+      type = "#{main_config.type.main_type(type)}(#{scope}): #{description}".strip
+
+      ticket_ref = "#{configuration.ticket_prefix}#{configuration.ticket}#{configuration.ticket_separator}#{ticket_number}"
       body = custom_body.strip.empty? ? Configuration::DEFAULT_COMMIT_BODY_TEMPLATE : custom_body.strip
-      footer = "Ref: ##{configuration.ticket_prefix}#{ticket_number}".strip
+      footer = "Ref: #{ticket_ref}".strip
       "#{type}\n\n#{body}\n\n#{footer}"
     end
 

data/lib/commit/commit_message_parser.rb

@@ -24,8 +24,10 @@ module ConventionalCommits
         raise raise GenericError,
                     "Subject doesnt respect the format"
       end
-      components = { type: "", title: "", body: "" }
-      components[:type] = subject_components[0]
+      scope_split = subject_components[0].split(/\(([^)]+)\)/)
+      components = { scope: nil, type: "", title: "", body: "" }
+      components[:scope] = scope_split.length > 1 ? scope_split[1] : nil
+      components[:type] = scope_split[0]
       components[:title] = subject_components[1]
       components[:body] = msg_components[2]
 

data/lib/configuration.rb

@@ -5,5 +5,6 @@ module ConventionalCommits
     DEFAULT_CONFIGURATION_PATH = ".conventional_commits/config.yml"
     DEFAULT_COMMIT_MSG_PATH = ".git/COMMIT_EDITMSG"
     DEFAULT_COMMIT_BODY_TEMPLATE = "[Describe your work, and put an empty string after]"
+    MAX_ELEMENTS_IN_PATTERN = 4
   end
 end

data/lib/conventional_commits/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ConventionalCommits
-  VERSION = "0.2.0"
+  VERSION = "0.2.2"
 end

data/lib/models/branch_configuration.rb

@@ -4,12 +4,14 @@ module ConventionalCommits
   module Configuration
     # Configuration for branch name policies
     class BranchConfiguration
-      attr_reader :ticket_prefix, :lowercase, :pattern
+      attr_reader :ticket_prefix, :lowercase, :pattern, :ticket, :ticket_separator
 
       def initialize(options = {})
         @ticket_prefix = options["ticket_prefix"] || ""
+        @ticket = options["ticket"] || ""
+        @ticket_separator = options["ticket_separator"] || "-"
         @lowercase = options["lowercase"] || true
-        @pattern = options["pattern"] || "<type>/<ticket>/<description>"
+        @pattern = options["pattern"] || "<scope>/<type>/<ticket>/<description>"
       end
     end
   end

data/sig/conventional_commits/configuration/branch_configuration.rbs

@@ -6,11 +6,16 @@ module ConventionalCommits
     class BranchConfiguration
       @lowercase: bool
       @pattern: string
+      @ticket: string
       @ticket_prefix: string
 
+      @ticket_separator: string
+
       attr_reader pattern: bool
       attr_reader lowercase: bool
+      attr_reader ticket: string
       attr_reader ticket_prefix: string
+      attr_reader ticket_separator: string
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: conventional_commits
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Swift-Gurus
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-22 00:00:00.000000000 Z
+date: 2024-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: open3
@@ -162,7 +162,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="