commiter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1f27ac7f13dd85771f80df9d7f68a2b70685e7d6c9c913e49cbb70d86bed08af
+  data.tar.gz: 62a4ee1b91656e2c9d7815e5d6ae1444ea8917c733e8babe3809873c3ee24878
+SHA512:
+  metadata.gz: 84e13b8a7e8c7131e5b6a6c60cf1ef4954aba111457e88b560c1e4654f0d47e6dcf888ee9503a9ed4ec46b0d010af8c81eb556852a6cb34cb8a437b85bed53da
+  data.tar.gz: 5fef51fbf8893784a2080384f1d1a6a5eb9e000dd85ddb4eb6b9f4a439a467f7cd2714f83680dce5b0304f72dcd439bcade82abe8976f90ee66e9506c37091a6

data/LICENSE

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright (c) <year> <copyright holders>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,12 @@
+# Commiter
+
+Commiter is a Cli Written in Ruby To Ask some Questions about how you want to write the commit message validation before write any commit and if this commit is not matching the commiter configuration file it will reject the commit and kill the process
+
+# Validations Supported
+1. Ticket Number
+2. Black List Words
+3. Regex Expression
+
+# Installation
+1. Ruby Required
+2. Bundler To Fetch Gem

data/lib/commiter.rb

@@ -0,0 +1,94 @@
+require "bundler/setup"
+require_relative "../lib/commiter/version"
+require_relative 'commiter_generator'
+
+module Commiter
+
+  class CommiterCli
+
+    def self.print_help_messages(should_exit)
+      puts "Command [-q] Generate Quick Git Messages Rules"
+      puts "Command [-g] Generate Git Rules Based On Questions"
+      puts "Command [-c] Generate Config File Without Change Git Rules"
+      puts "Command [-d] Show Debug Messages While Generating Git Config"
+      puts "Command [-r] Restore Git Rules Based On Config File"
+      if should_exit
+        exit
+      end
+    end
+
+    def self.validate_command_args(option, should_show_debug_messages)
+      case option
+      when "-h"
+        print_help_messages(true)
+      when "-help"
+        print_help_messages(true)
+      when "--help"
+        print_help_messages(true)
+      when "-debug"
+        @options[:verbose] = true
+      when "-c"
+        @options[:syntax_highlighting] = true
+      when "-g"
+        if should_show_debug_messages
+          puts "Command [-g] Accepted Will Start Asking Questions Before Update Git Rules"
+        end
+      when "-q"
+        if should_show_debug_messages
+          puts "Command [-q] Accepted Generate Quick Git Messages Rules"
+        end
+      when "-c"
+        if should_show_debug_messages
+          puts "Command [-c] Accepted Generate Config File"
+        end
+      when "-d"
+        if should_show_debug_messages
+          puts "Command [-d] Accepted Will Show Debug Messages"
+        end
+      else
+        puts "Command : [#{option} Rejected Use Cli -h To See The Supported Commands]"
+      end
+
+    end
+
+    def self.start_cli
+      cliParameters = ARGV
+      should_show_debug_messages = false
+      puts "########################### - Commiter Cli Starter -#################################"
+      puts "Welcome To Commiter Version : #{Commiter::VERSION}"
+      puts "This CLI Will Change Your Git Settings Commit Messages"
+      puts "#####################################################################################"
+      puts ""
+
+      # Find Debug Option
+      cliParameters.each do |item|
+        if item == "-d"
+          should_show_debug_messages = true
+        end
+      end
+
+      if should_show_debug_messages
+        puts "Commiter Arguments Validation Started ... With Input : #{cliParameters}"
+      end
+
+      # Start Validate CLI Params
+      cliParameters.each do |item|
+        self.validate_command_args(item, should_show_debug_messages)
+      end
+
+      puts ""
+      # Start Generate If -g Found
+      cliParameters.each do |item|
+        if item == "-g"
+          if should_show_debug_messages
+            puts "Command [-g] Found Will Start The Generator ..."
+          end
+          CommiterGenerator::CommiterCliGenerator::start
+        end
+      end
+
+    end
+
+    start_cli
+  end
+end

data/lib/commiter/version.rb

@@ -0,0 +1,3 @@
+module Commiter
+  VERSION = "0.0.1"
+end

data/lib/commiter_generator.rb

@@ -0,0 +1,181 @@
+require "bundler/setup"
+require_relative "commiter/version"
+require 'json'
+require_relative '../lib/commiter_rules_generator'
+
+module CommiterGenerator
+
+  class CommiterCliGenerator
+
+    def self.validate_command_options(value)
+      case value
+      when "t"
+        puts "Option Selected : Ticket Number Validation ..."
+      when "b"
+        puts "Option Selected : BlackList Validation Validation ..."
+      when "r"
+        puts "Option Selected : Regex Validation ..."
+      else
+        puts "Unknown Option : #{value} Stop Process ..."
+        exit
+      end
+    end
+
+    # Generate Shell File To Execute Commit Message Validation
+    def self.generate_sh_file(save_path)
+      begin
+        # Start Generating Git Rules File
+        CommiterRules::CommiterRulesStarter::start(save_path)
+      rescue => error
+        puts "Something Error : #{error.message}"
+        puts error.backtrace
+      end
+    end
+
+    def self.generate_json_file(
+      save_path,
+      black_list_words,
+      regex_input,
+      ticket_number_example,
+      is_enabled,
+      generated_style,
+      max_length,
+      is_global_configuration_enabled
+    )
+      is_commits_enabled = false
+      if is_enabled == "y"
+        is_commits_enabled = true
+      end
+
+      tempHash = {
+        "black_list_words" => black_list_words.to_s.split(","),
+        "regex_input" => regex_input,
+        "ticket_number_example" => ticket_number_example,
+        "is_enabled" => is_commits_enabled,
+        "generated_style" => generated_style,
+        "max_length" => max_length,
+        "is_global_configuration_enabled" => is_global_configuration_enabled
+      }
+
+      # Save File For History
+      begin
+        File.open("commiterConfig.json","w") do |f|
+          f.write(JSON.pretty_generate(tempHash))
+        end
+      rescue => error
+        puts "Something Error : #{error.message}"
+        puts error.backtrace
+      end
+
+      begin
+        File.open(save_path,"w") do |f|
+          f.write(JSON.pretty_generate(tempHash))
+        end
+      rescue => error
+        puts "Something Error : #{error.message}"
+        puts error.backtrace
+      end
+
+      puts ""
+      puts "Commiter Wrote Json Config File [commiterConfig.json] To Your Project :D"
+      puts "Any One Pull The Project He Can Start Commiter With [-q] Parameter and Will Generate Git Rules Based On This File"
+      puts "Any Update on The File You Should Execute Commiter -q Again To Apply The Changes"
+      puts "Now Enjoy With Your Commit Messages :D"
+      exit
+    end
+
+    def self.start
+      puts ""
+      puts "Commiter Generator Started To Ask Questions Before Generate Config File"
+      black_list_words = []
+      regex_input = ""
+      ticket_number_example = ""
+
+      save_path = ".git/hooks/commiterConfig.json"
+      shell_script_save_path = ".git/hooks/commit-msg"
+
+      # 1. First Question Choose Your Commits Type
+      puts "Please Choose Your Type of Commit Checking From This Types"
+      puts " Option : Write [t] To Check If Commit Has Ticket Number First or Not In Commit Messages"
+      puts " Option : Write [b] To Check If Commit Has Word From Black List Words That Blocked From Messages Like Dummy Messages"
+      puts " Option : Write [r] To Check Commit Messages Based on Regex String"
+      print "Your Answer ? "
+      generated_style = STDIN.gets.chomp
+      validate_command_options(generated_style)
+
+      # 2. If Option is BlackList Ask to Enter BlackList
+      puts ""
+      if generated_style == "b"
+        puts "Based On Your Option You Selected To Block Some Words From Commit Messages Can You Enter Them Like This (Fix,Version,Change) ?"
+        black_list_words = STDIN.gets.chomp
+        puts "Your Options Saved Will Add Them To Config File And You Can Change Them Anytime From Config File"
+        puts "Saved Options : #{black_list_words}"
+      end
+
+      # 3. If Option is Regex Ask to Enter This Regex
+      if generated_style == "r"
+        puts "Based On Your Option You Selected To Validate Commit Message Based on Regex Enter This Regex Please"
+        print "Your Answer ? "
+        regex_input = STDIN.gets.chomp
+        puts "Your Options Saved Will Add Them To Config File And You Can Change Them Anytime From Config File"
+        puts "Saved Option : #{regex_input}"
+      end
+
+      # 4. Check if Option is Ticket Number
+      if generated_style == "t"
+        puts "Based On Your Option You Selected To Validate Commit Message Based on Ticket Number Enter The Key And The Dynamic Number Like [Ticket-{#}] (The {#} Is The Dynamic Number)"
+        print "Your Answer ? "
+        ticket_number_example = STDIN.gets.chomp
+        puts "Your Options Saved Will Add Them To Config File And You Can Change Them Anytime From Config File"
+        puts "Saved Option : #{ticket_number_example}"
+      end
+
+      # 5. Should Enable The Validation Once Commiter Finish The Settings ?
+      puts "Should Enable The Validation Once Commiter Finish The Settings The Available Options [y,n] Default Value [y] ?"
+      print "Your Answer ? "
+      is_enabled = STDIN.gets.chomp
+      puts "Your Options Saved Will Add Them To Config File And You Can Change Them Anytime From Config File"
+      puts "Saved Option : #{is_enabled}"
+
+      # 6. Max Length of Message Line
+      puts "What is the Maximum Length of Commit Message Default [50]"
+      print "Your Answer ? "
+      max_length = STDIN.gets.chomp
+      puts "Your Options Saved Will Add Them To Config File And You Can Change Them Anytime From Config File"
+      puts "Saved Option : #{max_length}"
+
+      # 7. Save Template In Git
+      puts "Do You want To Copy This Files to Git Template Root as a Global Configuration [y,n] Default is [y]"
+      print "Your Answer ? "
+      is_global_configuration_enabled = STDIN.gets.chomp
+      puts "Your Options Saved Will Add Them To Config File And You Can Change Them Anytime From Config File"
+      puts "Saved Option : #{is_global_configuration_enabled}"
+
+      begin
+        max_length = max_length.to_i
+      rescue => error
+        puts "Something Error : #{error}"
+      end
+
+      # 6. Save Items In Config Json File
+      generate_json_file(save_path, black_list_words, regex_input, ticket_number_example, is_enabled, generated_style, max_length, is_global_configuration_enabled)
+      generate_sh_file(shell_script_save_path)
+
+      if is_global_configuration_enabled == "y"
+        sh("cd ..")
+
+        begin
+          sh("mkdir ~/.git_template")
+        rescue => error
+          puts "Something Wrong With Error : #{error.message}"
+        end
+
+        sh("git config --global init.templatedir '~/.git_template'")
+        # Copy Generated Files to Your Root Template Location
+      end
+
+    end
+
+  end
+
+end

data/lib/commiter_rules_generator.rb

@@ -0,0 +1,103 @@
+require "bundler/setup"
+require_relative "commiter/version"
+require 'json'
+
+
+module CommiterRules
+
+  class CommiterRulesStarter
+
+    # Start Position To Create The Ruby Executable File
+    def self.start(save_path)
+
+      begin
+        File.open(save_path,"w") do |f|
+          f.write("#!/usr/bin/env ruby")
+          f.write("")
+          f.write("require 'json'")
+          f.write("target_message_line = 0")
+          f.write("target_text_message = \" \"")
+          f.write("current_directory = __dir__")
+          f.write("data_hash = \"\"")
+          f.write("check_type = \"\"")
+          f.write("")
+          f.write("# --------------------- Step Read Commiter Configuration ----------------- #")
+          f.write("text = File.open(ARGV[0]).read")
+          f.write("     text.gsub!(/\r\n?/,\" \\n \")")
+          f.write("     text.each_line do |line|")
+          f.write("     target_text_message = line")
+          f.write("end")
+          f.write("")
+          f.write("file = File.open current_directory + \"/commiterConfig.json\"")
+          f.write("    data = JSON.load file")
+          f.write("file.close")
+          f.write("")
+          f.write("json_from_file = File.read(current_directory + \"/commiterConfig.json\")")
+          f.write("hash = JSON.parse(json_from_file)")
+          f.write("check_type = hash[\"generated_style\"]")
+          f.write("# --------------------- End Step Read Commiter Configuration ----------------- #")
+          f.write("")
+          f.write("")
+          f.write("# --------------------- Step Check Commiter Configuration Enabled ----------------- #")
+          f.write("if hash[\"is_enabled\"]")
+          f.write("  # Hooks Enabled Start Validation")
+          f.write("  # Will Continue To Check Based on Json Config")
+          f.write("else")
+          f.write("  # Hooks Disabled Continue")
+          f.write("  exit 0")
+          f.write("end")
+          f.write("# --------------------- End Step Check Commiter Configuration Enabled ----------------- #")
+          f.write("")
+          f.write("# --------------------- Step Check if Ticket Number Exists ----------------- #")
+          f.write("if check_type == \"t\"")
+          f.write("   validation_message = hash[\"ticket_number_example\"]")
+          f.write("   validation_message[\"{#}\"] = \"\"")
+          f.write("   if target_text_message.include? validation_message")
+          f.write("    puts \"Ticket Number Key Found, Good Commit Based on Configured Rules\"")
+          f.write("    exit 0")
+          f.write("  else")
+          f.write("    puts \"Bad Commit Message (Ticket Number Not Found) Commit Rejected\"")
+          f.write("    exit 1")
+          f.write("  end")
+          f.write("end")
+          f.write("# --------------------- End Step Check if Ticket Number Exists ----------------- #")
+          f.write("")
+          f.write("# --------------------- Step Check if Commit Message Equals Black List Array ----------------- #")
+          f.write("")
+          f.write("if check_type == \"b\"")
+          f.write("  black_list_words = hash[\"black_list_words\"]")
+          f.write("  filtered_message = target_text_message.downcase.strip")
+          f.write("  black_list_words.each { |value|")
+          f.write("    if filtered_message == value.downcase.strip")
+          f.write("      puts \"Bad Commit Message (\" " + value + " Message Not Acceptable) Commit Rejected\"")
+          f.write("      exit 1")
+          f.write("    end")
+          f.write("  }")
+          f.write("end")
+          f.write("# --------------------- End Step Check if Commit Message Equals Black List Array ----------------- #")
+          f.write("")
+          f.write("# --------------------- Step Check Commit Message Equals Regex ----------------- #")
+          f.write("if check_type == \"r\"")
+          f.write("  if target_text_message.match(hash[\"regex_input\"])")
+          f.write("    # Input Regex Matched")
+          f.write("    exit 0")
+          f.write("  else")
+          f.write("    puts \"Bad Commit Message (Message Not Match Regex) Commit Rejected\"")
+          f.write("    exit 1")
+          f.write("  end")
+          f.write("end")
+          f.write("# --------------------- End Step Check Commit Message Equals Regex ----------------- #")
+          f.write("")
+          f.write("")
+        end
+      rescue => error
+        puts "Error While Executing Git Rules : #{error.message}"
+        puts error.backtrace
+      end
+
+    end
+
+  end
+
+end
+

data/lib/generated.rb

@@ -0,0 +1,3 @@
+#!/usr/bin/ruby
+
+puts "Commands : #{ARGV}"

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: commiter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yazan Tarifi
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rspec
+  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: rspec_junit_formatter
+  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: rake
+  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:
+email: yazantarifi98@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/commiter.rb
+- lib/commiter/version.rb
+- lib/commiter_generator.rb
+- lib/commiter_rules_generator.rb
+- lib/generated.rb
+homepage: https://github.com/Yazan98/commiter
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: Command Line Interface to Add Git Hooks On Commits to Block any Commit that
+  does not match the Configuration inside Commiter Config Working on git commit -m
+test_files: []