conventional_commits 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b3eceb0496efd81eb85133073c36d40a4c8ba362b973f03c32ce674e0e09f0b
-  data.tar.gz: 9fcb57b5b6174c4e826db6610ef41eb5e900cc1f45ada3dcd134e2926a6cc1e3
+  metadata.gz: 1cdfa634e8de20bca992561a53e037bb56b0e6cd26e710820c49f0191fb941d6
+  data.tar.gz: 2f6a979054978822a1a6575c0e01f00bff5a1a7b614aa3b88ebd760dcccffcd0
 SHA512:
-  metadata.gz: bbfd3843abc300c550200b8254492c011272ed960e3a17e1b11bffc89a7c606481b430a6bc65bbccd1be8498cfe94834056bba693900538772f9803443500f49
-  data.tar.gz: 8cdb7380b8757ee3dd0b194c9a3d481b1553f73950458be17e680cd61c183b4af9748156b126ada250c5e3fe50a02416a3a630f049cb5d8158422ab29ef5edf4
+  metadata.gz: b92ddc49f4c7dad22d33c3b17b4a1a90ae168aee072e762e66650b5acb81e6b639030abd27bed2f4551a4947e91b10fb8473f491a0b73512d740377a4358b38d
+  data.tar.gz: fab82ec8dbd72ae32a40a6946f7dcd670dde1664548f0c160f2f003b40a782b8b57357d3322994cc8e0e8ce32c366a793cf61069e0182590861d90a2d6ce50b1

data/.conventional_commits/config.yml

@@ -0,0 +1,23 @@
+branch:
+  lowercase: true
+  ticket_prefix: JIRA
+  pattern: <scope>/<type>/<ticket>/<description>
+type:
+  feat: [ feature, feat ]
+  fix: [ bug, bugfix, fix ]
+  ci: [ ci ]
+  refactor: [ ref, refactor, refactoring ]
+  doc: [ doc, doc, documentation ]
+release:
+  rules:
+    - types:
+        - ref
+        - fix
+      version: patch
+    - types:
+        - feature
+      version: patch
+    - type: breaking
+      version: major
+
+

data/Gemfile

@@ -5,8 +5,8 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in conventional_commits.gemspec
 gemspec
 
+gem "gem-release"
 gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
 gem "rubocop", "~> 1.21"
 gem "simplecov"
-

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    conventional_commits (0.1.1)
+    conventional_commits (0.2.0)
       open3
       thor
       yaml
@@ -47,11 +47,12 @@ GEM
     diff-lcs (1.5.1)
     docile (1.4.0)
     ffi (1.16.3)
+    gem-release (2.2.2)
     json (2.7.1)
     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)
@@ -107,6 +108,7 @@ DEPENDENCIES
   aruba
   conventional_commits!
   cucumber
+  gem-release
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.21)

data/README.md

@@ -1,8 +1,8 @@
 # ConventionalCommits
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/conventional_commits`. To experiment with that code, run `bin/console` for an interactive prompt.
+This gem contains several tools to help enforce conventional commits practices.
+It contains CLI as well as Modules that you can you for your own use cases.
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -16,7 +16,48 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-TODO: Write usage instructions here
+Be mindful that this gem is mostly made for a specific set of practices. The idea is a team is agreed on specific branch name practices. This will help automating commits and templates thus helping developer to avoid redundant work.
+
+For easy start you can create a file `.conventional_commits/config.yml` with the next structure 
+run hooks installer by calling:
+
+    $ conventional_commits install_hooks
+
+```yaml
+branch:
+  lowercase: true
+  ticket_prefix: JIRA
+  pattern: <type>/<ticket>/<description>
+type:
+  feat: [ feature, feat ]
+  fix: [ bug, bugfix, fix ]
+  ci: [ ci ]
+  refactor: [ ref, refactor, refactoring ]
+  doc: [ doc, doc, documentation ]
+release:
+  rules:
+    - types:
+        - ref
+        - fix
+      version: patch
+    - types:
+        - feature
+      version: patch
+    - type: breaking
+      version: major
+
+```
+
+### Options 
+- `lowercase` - will make sure that the branch name is in lowercase when cli `conventional_commit branch <NAME>` is called
+to create a new branch
+- `ticket_prefix` - is used to append prefix to the commit message at the footer
+- `pattern` - is used to define the separators between in future it will be used to define the order as well
+- `type` - is used for mapping combination of short names for the type of request. Helps to avoid inconsistency.
+
+### Release
+Not implemented yet. It will contain tools to increment version number based on the rules
+
 
 ## Development
 
@@ -26,4 +67,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/conventional_commits.
+Bug reports and pull requests are welcome on GitHub at https://github.com/Swift-Gurus/conventional_commits.

data/exe/conventional_commits

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+require "cli/branch_name_cli"
+require "branch/branch_name_generator"
+require "configuration/branch_configuration_reader"
+require "configuration/main_configuration_reader"
+require "models/main_configuration"
+require "models/release_configuration"
+require "models/release_rule"
+require "models/branch_configuration"
+require "configuration"
+require "models/type_configuration"
+require "commit/commit_message_generator"
+require "git/git"
+require "conventional_commits"
+require "helpers/file_extension"
+require "commit/commit_message_parser"
+require "commit/commit_message_validator"
+require "hooks/hooks_installer"
+ConventionalCommits::BranchNameCLI.start(ARGV)

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.1.1"
+  VERSION = "0.2.1"
 end

data/lib/hooks/hooks_installer.rb

@@ -54,7 +54,7 @@ module ConventionalCommits
       end
 
       def cli_command(cmd)
-        "bundle exec conventional_commit #{cmd}"
+        "bundle exec conventional_commits #{cmd}"
       end
 
       def ruby_eval

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.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Swift-Gurus
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-21 00:00:00.000000000 Z
+date: 2024-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: open3
@@ -96,10 +96,12 @@ dependencies:
         version: '0'
 description: Enforces conventional commits specs.
 email: alexei.hmelevski@gmail.com
-executables: []
+executables:
+- conventional_commits
 extensions: []
 extra_rdoc_files: []
 files:
+- ".conventional_commits/config.yml"
 - ".rspec"
 - ".rubocop.yml"
 - Gemfile
@@ -107,6 +109,7 @@ files:
 - README.md
 - Rakefile
 - conventional_commits.gemspec
+- exe/conventional_commits
 - lib/branch/branch_name_generator.rb
 - lib/cli/branch_name_cli.rb
 - lib/commit/commit_message_generator.rb