conventional_commits 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b3eceb0496efd81eb85133073c36d40a4c8ba362b973f03c32ce674e0e09f0b
-  data.tar.gz: 9fcb57b5b6174c4e826db6610ef41eb5e900cc1f45ada3dcd134e2926a6cc1e3
+  metadata.gz: e6ae6b0c24851cd4187e486f651d0e4d9771976ff141916308d7af9ebdc04dcb
+  data.tar.gz: 89e014f037a44a66af16de22d1ef343f98628e7872e79391fad3b342bc5b23f4
 SHA512:
-  metadata.gz: bbfd3843abc300c550200b8254492c011272ed960e3a17e1b11bffc89a7c606481b430a6bc65bbccd1be8498cfe94834056bba693900538772f9803443500f49
-  data.tar.gz: 8cdb7380b8757ee3dd0b194c9a3d481b1553f73950458be17e680cd61c183b4af9748156b126ada250c5e3fe50a02416a3a630f049cb5d8158422ab29ef5edf4
+  metadata.gz: 20c152762ded992258897e4f7d5a72ea9fa737aea6a47151f43d890f308bb2d193fca2b4bc57d3930b9ef74af04128cecc5fae770c03fe1afc6fe552cdc9574d
+  data.tar.gz: 0eaa4b6db66729c636cd540ca7fdf98a411b0d99016d373556948586bffcb07be6fc7c378139e3e813a7a26c29a82df3cce91942f0e6f986133d3afccd926b92

data/.conventional_commits/config.yml

@@ -0,0 +1,23 @@
+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
+
+

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

@@ -47,6 +47,7 @@ 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)
@@ -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/conventional_commits/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ConventionalCommits
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: conventional_commits
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Swift-Gurus
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-21 00:00:00.000000000 Z
+date: 2024-03-22 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