conventional_commits 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 773e8500d2a910d271e21c329b6b2341c93929e86b6a35310abe967bb9a701e8
+  data.tar.gz: 34910f2e6067b60c823a2e4f8f1aa6ce6d44472ac47d65ce63de5d22c6119f1a
+SHA512:
+  metadata.gz: d5af3444a122c72e7946064d490393ff4ed774acc8f6e6e8d22adac7852bebabc173fd98da25c0790826a63d156048b6ab93dd36fcce2f5dc2ea1227c849438a
+  data.tar.gz: 291379e49c6ac188ec384987b92a43dbaae811694304b0ac92e9c4994390b5cf452a477fc8e30f46a5d6eb1210550271f06682a71352360eeb1ff10f3dfc14e2

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 3.1
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in conventional_commits.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rubocop", "~> 1.21"
+gem "simplecov"
+

data/Gemfile.lock

@@ -0,0 +1,116 @@
+PATH
+  remote: .
+  specs:
+    conventional_commits (0.1.0)
+      open3
+      thor
+      yaml
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aruba (2.2.0)
+      bundler (>= 1.17, < 3.0)
+      contracts (>= 0.16.0, < 0.18.0)
+      cucumber (>= 8.0, < 10.0)
+      rspec-expectations (~> 3.4)
+      thor (~> 1.0)
+    ast (2.4.2)
+    bigdecimal (3.1.6)
+    builder (3.2.4)
+    contracts (0.17)
+    cucumber (9.1.2)
+      builder (~> 3.2, >= 3.2.4)
+      cucumber-ci-environment (~> 9.2, >= 9.2.0)
+      cucumber-core (~> 12.0)
+      cucumber-cucumber-expressions (~> 17.0)
+      cucumber-gherkin (> 24, < 27)
+      cucumber-html-formatter (> 20.3, < 22)
+      cucumber-messages (> 19, < 25)
+      diff-lcs (~> 1.5)
+      mini_mime (~> 1.1, >= 1.1.5)
+      multi_test (~> 1.1, >= 1.1.0)
+      sys-uname (~> 1.2, >= 1.2.3)
+    cucumber-ci-environment (9.2.0)
+    cucumber-core (12.0.0)
+      cucumber-gherkin (>= 25, < 27)
+      cucumber-messages (>= 20, < 23)
+      cucumber-tag-expressions (~> 5.0, >= 5.0.4)
+    cucumber-cucumber-expressions (17.0.2)
+      bigdecimal
+    cucumber-gherkin (26.2.0)
+      cucumber-messages (>= 19.1.4, < 22.1)
+    cucumber-html-formatter (21.2.0)
+      cucumber-messages (> 19, < 25)
+    cucumber-messages (22.0.0)
+    cucumber-tag-expressions (5.0.6)
+    diff-lcs (1.5.1)
+    docile (1.4.0)
+    ffi (1.16.3)
+    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)
+    parallel (1.24.0)
+    parser (3.3.0.5)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    regexp_parser (2.9.0)
+    rexml (3.2.6)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.62.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.2)
+      parser (>= 3.3.0.4)
+    ruby-progressbar (1.13.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    sys-uname (1.2.3)
+      ffi (~> 1.1)
+    thor (1.3.1)
+    unicode-display_width (2.5.0)
+    yaml (0.3.0)
+
+PLATFORMS
+  arm64-darwin-23
+
+DEPENDENCIES
+  aruba
+  conventional_commits!
+  cucumber
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  simplecov
+
+BUNDLED WITH
+   2.3.14

data/README.md

@@ -0,0 +1,29 @@
+# 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.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add conventional_commits
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install conventional_commits
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/conventional_commits.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/conventional_commits.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "lib/conventional_commits/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "conventional_commits"
+  spec.version = ConventionalCommits::VERSION
+  spec.authors = "Swift-Gurus"
+  spec.email = "alexei.hmelevski@gmail.com"
+
+  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.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/Swift-Gurus/conventional_commits"
+  spec.metadata["changelog_uri"] = "https://github.com/Swift-Gurus/conventional_commits"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "open3"
+  spec.add_dependency "thor"
+  spec.add_dependency "yaml"
+
+  spec.add_development_dependency "aruba"
+  spec.add_development_dependency "cucumber"
+  spec.add_development_dependency "simplecov"
+end

data/lib/branch/branch_name_generator.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module ConventionalCommits
+  class BranchNameGenerator
+    attr_reader :reader
+
+    def initialize(reader: reader = Configuration::BranchConfigurationReader.new)
+      @reader = reader
+    end
+
+    def generate_name_for(_input, path: Configuration::DEFAULT_CONFIGURATION_PATH)
+      configuration = reader.get_configuration(path:)
+      delimiters = find_delimiters_from_pattern(pattern: configuration.pattern)
+      input_order = transform_input_using_delimiters(_input, delimiters)
+
+      name = input_order.each_with_index.reduce("") do |acc, (e, i)|
+        acc + e + (delimiters[i] || (i + 1 == input_order.length ? "" : "-"))
+      end
+
+      name.downcase if configuration.lowercase == true
+    end
+
+    def branch_name_components(_input, path: Configuration::DEFAULT_CONFIGURATION_PATH)
+      configuration = reader.get_configuration(path:)
+      delimiters = find_delimiters_from_pattern(pattern: configuration.pattern)
+      received = _input
+      modified_input = _input
+      out = []
+      delimiters.each do |d|
+        splits = modified_input.split(d, 2)
+        out.push(splits[0]) if splits.length.positive?
+        modified_input = splits[1] || ""
+      end
+      out.push(modified_input) unless modified_input.empty?
+      if delimiters.length + 1 > out.length
+        raise ConventionalCommits::GenericError,
+              "The branch doesnt respect the template, expect #{delimiters.length} delimiters. Received: #{received}".strip
+      end
+
+      out
+    end
+
+    def is_valid_branch(_input, path: Configuration::DEFAULT_CONFIGURATION_PATH)
+      !branch_name_components(_input, path:).empty?
+    end
+
+    private
+
+    def find_delimiters_from_pattern(pattern: string)
+      delimiters = pattern.gsub(/<type>/, "<replace>")
+                          .gsub(/<ticket>/, "<replace>")
+                          .gsub(/<description>/, "<replace>")
+                          .split("<replace>")
+                          .reject { |str| str.empty? == true }
+      raise(GenericError, "Delimiters not found in pattern") if delimiters.empty?
+
+      delimiters
+    end
+
+    def transform_input_using_delimiters(_input, delimiters)
+      splits = _input.gsub(/_/, " ").scan(/\w+/)
+      validate_delimiters(delimiters, splits.length)
+      splits
+    end
+
+    def validate_delimiters(delimiters, number_of_words)
+      return unless number_of_words < delimiters.length + 1
+
+      raise(GenericError,
+            "Doesnt match the pattern expect at least #{delimiters.length + 1} words")
+    end
+  end
+end

data/lib/cli/branch_name_cli.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require "thor"
+
+module ConventionalCommits
+  class BranchNameCLI < Thor
+    def self.exit_on_failure?
+      true
+    end
+
+    desc "branch NAME", "formats the branch name based on the rules"
+    option :cfg_path, type: :string, required: false
+    def branch(_name)
+      cfg_path = options["cfg_path"] || Configuration::DEFAULT_CONFIGURATION_PATH
+      generator = ConventionalCommits::BranchNameGenerator.new
+      generated_name = generator.generate_name_for(_name.strip, path: cfg_path.strip)
+      Kernel.system("git branch #{generated_name}")
+    rescue StandardError => e
+      raise Thor::Error, e.message
+    end
+
+    desc "prepare_commit_msg", "Prepares commit message"
+    option :msg_path, type: :string, required: false
+    option :source, type: :string, required: false
+    option :cfg_path, type: :string, required: false
+    def prepare_commit_msg
+      source = options["source"] || ""
+      puts source
+      msg_path = options["msg_path"] || Configuration::DEFAULT_COMMIT_MSG_PATH
+      cfg_path = options["cfg_path"] || Configuration::DEFAULT_CONFIGURATION_PATH
+
+      generator = ConventionalCommits::CommitMessageGenerator.new
+      name = generator.prepare_message_template_for_type(type: source, cfg_path:, msg_file_path: msg_path)
+      File.write_to_file(msg_path, name)
+    rescue StandardError => e
+      raise Thor::Error, e.message
+    end
+
+    desc "validate_branch", "validates if the branch conforms to the rules"
+    option :cfg_path, type: :string, required: false
+    def validate_branch_name
+      cfg_path = options["cfg_path"] || Configuration::DEFAULT_CONFIGURATION_PATH
+      generator = ConventionalCommits::BranchNameGenerator.new
+      name = ConventionalCommits::Git.new.current_branch_name
+      generator.is_valid_branch(name.strip, path: cfg_path.strip)
+    rescue StandardError => e
+      raise Thor::Error, e.message
+    end
+
+    desc "validate_commit_msg", "validates if the branch conforms to the rules"
+    option :msg_path, type: :string, required: false
+    option :msg, type: :string, required: false
+    option :cfg_path, type: :string, required: false
+    def validate_commit_msg
+      msg_path = options["msg_path"] || Configuration::DEFAULT_COMMIT_MSG_PATH
+      cfg_path = options["cfg_path"] || Configuration::DEFAULT_CONFIGURATION_PATH
+      validator = ConventionalCommits::CommitMessageValidator.new
+      validator.validate_commit_msg_from_file(commit_msg_path: msg_path, cfg_path:)
+    rescue StandardError => e
+      raise Thor::Error, e.message
+    end
+
+    desc "install_hooks", "install all git hooks"
+    def install_hooks
+      installer = ConventionalCommits::Configuration::HooksInstaller.new
+      installer.install_all
+    rescue StandardError => e
+      raise Thor::Error, e.message
+    end
+  end
+end

data/lib/commit/commit_message_generator.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "open3"
+module ConventionalCommits
+  class CommitMessageGenerator
+    def prepare_template_message(custom_body: "", cfg_path: Configuration::DEFAULT_CONFIGURATION_PATH)
+      branch_name = Git.new.current_branch_name
+      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] || ""
+      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
+
+      body = custom_body.strip.empty? ? Configuration::DEFAULT_COMMIT_BODY_TEMPLATE : custom_body.strip
+      footer = "Ref: ##{configuration.ticket_prefix}#{ticket_number}".strip
+      "#{type}\n\n#{body}\n\n#{footer}"
+    end
+
+    def prepare_message_template_for_type(type: "",
+                                          cfg_path: Configuration::DEFAULT_CONFIGURATION_PATH,
+                                          msg_file_path: Configuration::DEFAULT_COMMIT_MSG_PATH)
+      prepare_template_message(cfg_path:) unless should_try_to_parse_msg_from_file(source: type)
+
+      parser = CommitMessageParser.new
+      components = parser.message_components(commit_msg_path: msg_file_path, cfg_path:)
+      prepare_template_message(custom_body: components[:body], cfg_path:)
+    rescue StandardError
+      data = File.read_file(msg_file_path).to_s
+      prepare_template_message(custom_body: data, cfg_path:)
+    end
+
+    private
+
+    def should_try_to_parse_msg_from_file(source: "")
+      skippable_sources.include?(source)
+    end
+
+    def skippable_sources
+      %w[message merge squash]
+    end
+  end
+end

data/lib/commit/commit_message_parser.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module ConventionalCommits
+  class CommitMessageParser
+    def message_components(commit_msg_path: Configuration::DEFAULT_COMMIT_MSG_PATH,
+                           cfg_path: Configuration::DEFAULT_CONFIGURATION_PATH)
+      raise GenericError, "Commit Message File is not created" unless File.exist?(commit_msg_path)
+
+      data = File.read_file(commit_msg_path)
+      message_components_from_string(commit_msg: data.to_s, cfg_path:)
+    end
+
+    def message_components_from_string(commit_msg: "",
+                                       cfg_path: Configuration::DEFAULT_CONFIGURATION_PATH)
+      msg_components = commit_msg.split "\n"
+      if msg_components.length < 5
+        raise GenericError, "Commit Message Doesnt respect the spec, expect to have subject, body and footer"
+      end
+
+      main_config = Configuration::MainConfigurationReader.new.get_configuration(path: cfg_path)
+
+      subject_components = msg_components[0].split(":").map(&:strip)
+      if subject_components.length < 2
+        raise raise GenericError,
+                    "Subject doesnt respect the format"
+      end
+      components = { type: "", title: "", body: "" }
+      components[:type] = subject_components[0]
+      components[:title] = subject_components[1]
+      components[:body] = msg_components[2]
+
+      unless main_config.type.is_allowed(components[:type])
+        raise raise GenericError,
+                    "Commit Type is not in the config yaml"
+      end
+
+      components
+    end
+  end
+end

data/lib/commit/commit_message_validator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module ConventionalCommits
+  class CommitMessageValidator
+    def validate_commit_msg_from_file(commit_msg_path: Configuration::DEFAULT_COMMIT_MSG_PATH,
+                                      cfg_path: Configuration::DEFAULT_CONFIGURATION_PATH)
+      parser = CommitMessageParser.new
+      components = parser.message_components(commit_msg_path:, cfg_path:)
+
+      raise GenericError, "The Message is Invalid" if components.empty?
+
+      if components[:body].include?(Configuration::DEFAULT_COMMIT_BODY_TEMPLATE)
+        raise GenericError,
+              "Body contains template"
+      end
+
+      puts "Commit message is valid"
+      true
+    end
+  end
+end

data/lib/configuration/branch_configuration_reader.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ConventionalCommits
+  module Configuration
+    class BranchConfigurationReader
+      def get_configuration(path: Configuration::DEFAULT_CONFIGURATION_PATH)
+        reader = MainConfigurationReader.new
+        config = reader.get_configuration(path:)
+        config.branch
+      end
+    end
+  end
+end

data/lib/configuration/main_configuration_reader.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "yaml"
+module ConventionalCommits
+  module Configuration
+    class MainConfigurationReader
+      def get_configuration(path: Configuration::DEFAULT_CONFIGURATION_PATH)
+        raise GenericError, "Path is empty" if path.empty?
+        raise GenericError, "File not found" unless File.exist?(path)
+
+        file = File.open(path)
+        config = YAML.load(file)
+        MainConfiguration.new(config)
+      end
+    end
+  end
+end
+
+module ConventionalCommits
+  class GenericError < StandardError
+    def initialize(msg = "This is a custom exception", exception_type = "custom")
+      @exception_type = exception_type
+      super(msg)
+    end
+  end
+end

data/lib/configuration.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ConventionalCommits
+  module Configuration
+    DEFAULT_CONFIGURATION_PATH = ".conventional_commit/config.yaml"
+    DEFAULT_COMMIT_MSG_PATH = ".git/COMMIT_EDITMSG"
+    DEFAULT_COMMIT_BODY_TEMPLATE = "[Describe your work, and put an empty string after]"
+  end
+end

data/lib/conventional_commits/version.rb

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

data/lib/conventional_commits.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "conventional_commits/version"
+
+module Conventional§Commits
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/git/git.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ConventionalCommits
+  class Git
+    def current_branch_name
+      run_system_command "git symbolic-ref --short HEAD"
+    end
+
+    def set_commit_msg(_msg)
+      run_system_command "git symbolic-ref --short HEAD"
+    end
+
+    def run_system_command(_cmd)
+      Open3.popen3(_cmd) { |_stdin, stdout, _stderr, _wait_thr| stdout.read }
+    end
+  end
+end

data/lib/helpers/file_extension.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "fileutils"
+class File
+  def self.write_to_file(path, data)
+    open_file_with_data(path, data)
+  end
+
+  def self.delete_directory(path: string)
+    return unless Dir.exist?(path)
+
+    FileUtils.rm_r(path)
+  end
+
+  def self.delete_file(path: string)
+    return unless exist?(path)
+
+    delete(path)
+  end
+
+  def self.create_directory(path: string)
+    FileUtils.mkdir_p(path) unless Dir.exist?(path)
+  end
+
+  def self.create_new_file_with_data(path, data)
+    File.open(path, "w") do |f|
+      f.write(data)
+    end
+  end
+
+  def self.read_file(path)
+    File.open(path, "r") do |f|
+      data = f.read.to_s
+      return data || ""
+    end
+  end
+
+  def self.open_file_with_data(path, data)
+    File.open(path, "w") do |f|
+      f.write(data)
+    end
+  end
+end

data/lib/hooks/hooks_installer.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "fileutils"
+
+module ConventionalCommits
+  module Configuration
+    class HooksInstaller
+      def install_prepare_commit_msg
+        cmd = (common_hooks + [
+          cli_command(prepare_commit_cli)
+        ])
+              .join("\n")
+        create_file_and_make_executable(path: "prepare-commit-msg", data: cmd)
+      end
+
+      def install_pre_commit
+        cmd = common_hooks
+              .join("\n")
+        create_file_and_make_executable(path: "pre-commit", data: cmd)
+      end
+
+      def install_commit_msg
+        cmd = (common_hooks + [cli_command(validate_commit_msg)]).join("\n")
+        create_file_and_make_executable(path: "commit-msg", data: cmd)
+      end
+
+      def install_all
+        install_pre_commit
+        install_commit_msg
+        install_prepare_commit_msg
+      end
+
+      def create_file_and_make_executable(path:, data:)
+        File.create_directory(path: hook_directory)
+        full_path = "#{hook_directory}/#{path}"
+        File.create_new_file_with_data(full_path, data)
+        FileUtils.chmod("+x", full_path)
+      end
+
+      def initial_lines
+        [start_line,
+         ruby_eval]
+      end
+
+      def hook_directory
+        ".git/hooks"
+      end
+
+      def common_hooks
+        initial_lines +
+          [
+            cli_command("validate_branch_name")
+          ]
+      end
+
+      def cli_command(cmd)
+        "bundle exec bin/conventional_commit #{cmd}"
+      end
+
+      def ruby_eval
+        "eval \"$(rbenv init -)\""
+      end
+
+      def start_line
+        "#!/bin/sh"
+      end
+
+      def prepare_commit_cli
+        "prepare_commit_msg --msg_path $1"
+      end
+
+      def validate_commit_msg
+        "validate_commit_msg --msg_path $1"
+      end
+    end
+  end
+end

data/lib/models/branch_configuration.rb

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

data/lib/models/commit_configuration.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ConventionalCommits
+  module Configuration
+    # Configuration for branch name policies
+    class CommitConfiguration
+      attr_reader :ticket_prefix, :lowercase, :include_ticket_number
+
+      def initialize(ticket:, lowercase:, include_ticket_number:)
+        @ticket_prefix = ticket
+        @lowercase = lowercase
+        @include_ticket_number = include_ticket_number
+      end
+    end
+  end
+end

data/lib/models/main_configuration.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ConventionalCommits
+  module Configuration
+    # Configuration for branch name policies
+    class MainConfiguration
+      attr_reader :release,
+                  :branch,
+                  :type
+
+      def initialize(options = {})
+        @release = ReleaseConfiguration.new(options["release"] || {})
+        @branch = BranchConfiguration.new(options["branch"] || {})
+        @type = TypeConfiguration.new(options["type"] || {})
+      end
+    end
+  end
+end

data/lib/models/release_configuration.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ConventionalCommits
+  module Configuration
+    # Configuration for branch name policies
+    class ReleaseConfiguration
+      attr_reader :rules
+
+      def initialize(options = {})
+        @rules = (options["rules"] || []).map { |options| ReleaseRule.new(options) }
+      end
+    end
+  end
+end

data/lib/models/release_rule.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ConventionalCommits
+  module Configuration
+    # Configuration for branch name policies
+    class ReleaseRule
+      attr_reader :types, :version
+
+      def initialize(options = {})
+        @types = options["types"] || []
+        @version = options["version"] || "none"
+      end
+    end
+  end
+end

data/lib/models/type_configuration.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module ConventionalCommits
+  module Configuration
+    # Configuration for branch name policies
+    class TypeConfiguration
+      attr_reader :options
+
+      def initialize(o = {})
+        @options = o
+      end
+
+      def is_allowed(type)
+        all_types.include?(type)
+      end
+
+      def main_type(_type)
+        match = ""
+
+        options.each do |key, array|
+          match = key if array.include?(_type)
+        end
+        match
+      end
+
+      def all_types
+        options.keys + options.values.flat_map { |e| e }
+      end
+    end
+  end
+end

data/sig/conventional_commit/branch_name_generator.rbs

@@ -0,0 +1,10 @@
+module ConventionalCommit
+  class BranchNameGenerator
+    include  ConventionalCommits::Configuration
+    @reader: ConventionalCommits::Configuration::BranchConfigurationReader
+
+    attr_reader reader: ConventionalCommits::Configuration::BranchConfigurationReader
+
+    def generate_name_for: -> string
+  end
+end

data/sig/conventional_commits/branch_name_cli.rbs

@@ -0,0 +1,8 @@
+module ConventionalCommits
+  class BranchNameCLI
+    def self.exit_on_failure?: -> bool
+    def branch: -> void
+
+    def prepare_commit_msg: -> void
+  end
+end

data/sig/conventional_commits/branch_name_generator.rbs

@@ -0,0 +1,7 @@
+module ConventionalCommits
+  class BranchNameGenerator
+    @reader: Configuration::BranchConfigurationReader
+
+    attr_reader reader: Configuration::BranchConfigurationReader
+  end
+end

data/sig/conventional_commits/commit_message.rbs

@@ -0,0 +1,5 @@
+module ConventionalCommits
+  class CommitMessage
+    def prepare_template_message: -> String
+  end
+end

data/sig/conventional_commits/configuration/branch_configuration.rbs

@@ -0,0 +1,16 @@
+module ConventionalCommits
+  module Configuration
+    DEFAULT_CONFIGURATION_PATH: string
+    DEFAULT_COMMIT_MSG_PATH: string
+    DEFAULT_COMMIT_BODY_TEMPLATE: string
+    class BranchConfiguration
+      @lowercase: bool
+      @pattern: string
+      @ticket_prefix: string
+
+      attr_reader pattern: bool
+      attr_reader lowercase: bool
+      attr_reader ticket_prefix: string
+    end
+  end
+end

data/sig/conventional_commits/configuration/branch_configuration_reader.rbs

@@ -0,0 +1,7 @@
+module ConventionalCommits
+  module Configuration
+    class BranchConfigurationReader
+      def get_configuration: -> BranchConfiguration
+    end
+  end
+end

data/sig/conventional_commits/configuration/main_configuration.rbs

@@ -0,0 +1,14 @@
+module ConventionalCommits
+  module Configuration
+
+    class MainConfiguration
+      @release: ReleaseConfiguration
+      @branch: BranchConfiguration
+      @type: TypeConfiguration
+
+      attr_reader branch: BranchConfiguration
+      attr_reader release: ReleaseConfiguration
+      attr_reader type: TypeConfiguration
+    end
+  end
+end

data/sig/conventional_commits/configuration/main_configuration_reader.rbs

@@ -0,0 +1,7 @@
+module ConventionalCommits
+  module Configuration
+    class MainConfigurationReader
+      def get_configuration: -> MainConfiguration
+    end
+  end
+end

data/sig/conventional_commits/configuration/release_configuration.rbs

@@ -0,0 +1,9 @@
+module ConventionalCommits
+  module Configuration
+    class ReleaseConfiguration
+      @rules: [ReleaseRule]
+
+      attr_reader rules: [ReleaseRule]
+    end
+  end
+end

data/sig/conventional_commits/configuration/release_rule.rbs

@@ -0,0 +1,8 @@
+module ConventionalCommits
+  module Configuration
+    class ReleaseRule
+      attr_reader types: [string]
+      attr_reader version: string
+    end
+  end
+end

data/sig/conventional_commits/configuration/type_configuration.rbs

@@ -0,0 +1,11 @@
+module ConventionalCommits
+  module Configuration
+    class TypeConfiguration
+      attr_reader options: {}
+
+      def is_allowed: -> bool
+
+      def main_type: -> string
+    end
+  end
+end

data/sig/conventional_commits/git.rbs

@@ -0,0 +1,7 @@
+module ConventionalCommits
+  class Git
+    def current_branch_name: -> string
+
+    def run_system_command: -> string
+  end
+end

data/sig/conventional_commits/system_caller.rbs

@@ -0,0 +1,5 @@
+module ConventionalCommits
+  class SystemCaller
+    def run_command: -> void
+  end
+end

data/sig/conventional_commits.rbs

@@ -0,0 +1,4 @@
+module ConventionalCommits
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/sig/file.rbs

@@ -0,0 +1,7 @@
+class File
+  def self.create_directory: -> void
+
+  def self.delete_directory: -> void
+
+  def self.write_to_file: -> void
+end

data/sig/generic_error.rbs

@@ -0,0 +1,3 @@
+class GenericError
+  @exception_type: string
+end

data/sig/support/mocks/file_mock_operations.rbs

@@ -0,0 +1,9 @@
+module Support
+  module Mocks
+    class FileMockOperations
+      def self.update_pattern_in_config: -> void
+
+      attr_reader mocks: MockData
+    end
+  end
+end

data/sig/support/mocks/mock_data.rbs

@@ -0,0 +1,12 @@
+module Support
+  module Mocks
+    class MockData
+      attr_accessor working_directory: string
+
+      attr_accessor branch_name: string
+      attr_accessor configuration: string
+      attr_accessor directory: string
+      attr_accessor file: string
+    end
+  end
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: conventional_commits
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Swift-Gurus
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: open3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yaml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Enforces conventional commits specs.
+email: alexei.hmelevski@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- conventional_commits.gemspec
+- lib/branch/branch_name_generator.rb
+- lib/cli/branch_name_cli.rb
+- lib/commit/commit_message_generator.rb
+- lib/commit/commit_message_parser.rb
+- lib/commit/commit_message_validator.rb
+- lib/configuration.rb
+- lib/configuration/branch_configuration_reader.rb
+- lib/configuration/main_configuration_reader.rb
+- lib/conventional_commits.rb
+- lib/conventional_commits/version.rb
+- lib/git/git.rb
+- lib/helpers/file_extension.rb
+- lib/hooks/hooks_installer.rb
+- lib/models/branch_configuration.rb
+- lib/models/commit_configuration.rb
+- lib/models/main_configuration.rb
+- lib/models/release_configuration.rb
+- lib/models/release_rule.rb
+- lib/models/type_configuration.rb
+- sig/conventional_commit/branch_name_generator.rbs
+- sig/conventional_commits.rbs
+- sig/conventional_commits/branch_name_cli.rbs
+- sig/conventional_commits/branch_name_generator.rbs
+- sig/conventional_commits/commit_message.rbs
+- sig/conventional_commits/configuration/branch_configuration.rbs
+- sig/conventional_commits/configuration/branch_configuration_reader.rbs
+- sig/conventional_commits/configuration/main_configuration.rbs
+- sig/conventional_commits/configuration/main_configuration_reader.rbs
+- sig/conventional_commits/configuration/release_configuration.rbs
+- sig/conventional_commits/configuration/release_rule.rbs
+- sig/conventional_commits/configuration/type_configuration.rbs
+- sig/conventional_commits/git.rbs
+- sig/conventional_commits/system_caller.rbs
+- sig/file.rbs
+- sig/generic_error.rbs
+- sig/support/mocks/file_mock_operations.rbs
+- sig/support/mocks/mock_data.rbs
+homepage: https://github.com/Swift-Gurus/conventional_commits
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/Swift-Gurus/conventional_commits
+  source_code_uri: https://github.com/Swift-Gurus/conventional_commits
+  changelog_uri: https://github.com/Swift-Gurus/conventional_commits
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Make your commit unified.
+test_files: []