check-ahead 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 31dc9c420a4e762f5127520aea444dfd5e97ccf614cd61379ebe85a789448ca2
+  data.tar.gz: f3a028ea3a805d7f3a98231d19f823dbb16d72d340ccffaeaa6f1e098814e01c
+SHA512:
+  metadata.gz: d26310b43c061cf8c4162a539630119d475abee61036a525819c54d2d7d1ac8b9d11b506ec48131b29ce9426c5cbdd862ea1422a6d8b0c7c3c80edfea27289c0
+  data.tar.gz: f6bc0e25bb49f157b0bad38d9f47fce7db662c73d9e05bf1abda51f2ac38c2afbe9dd087df5ff7233d1ee150d62cff025556bcd7144e2b91d63acc52a7ba84dc

data/.github/workflows/rspec.yml

@@ -0,0 +1,27 @@
+---
+name: RSpec Ruby
+
+on: [push]
+
+jobs:
+  rspec:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.4, 2.5, 2.6, 2.7]
+    steps:
+      - uses: actions/checkout@v1
+      - name: Set up Ruby
+        uses: eregon/use-ruby-action@master
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: install bundler and gems
+        run: |
+          gem install bundler
+          bundle install --jobs 3 --retry 3
+
+      - name: run RSpec
+        run: |
+          bundle exec rspec

data/.github/workflows/rubocop.yml

@@ -0,0 +1,23 @@
+---
+name: Lint Ruby
+
+on: [push]
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - name: Set up Ruby 2.6
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.6.x
+
+      - name: install bundler and gems
+        run: |
+          gem install bundler
+          bundle install --jobs 3 --retry 3
+
+      - name: Rubocop check
+        run: |
+          bundle exec rubocop -D

data/.gitignore

@@ -0,0 +1,11 @@
+# bundler
+.bundle
+Gemfile.local
+
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--format documentation

data/.rubocop.yml

@@ -0,0 +1,19 @@
+---
+require:
+  - rubocop-rspec
+  - rubocop-performance
+
+Metrics/MethodLength:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Style/RescueModifier:
+  Enabled: false
+Layout/LineLength:
+  Max: 120
+Naming/FileName:
+  Enabled: false

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at gheorghe.popescu@puppet.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in check-ahead.gemspec
+gemspec
+
+group :developmen, :test do
+  gem 'pry-byebug'
+  gem 'rubocop', require: false
+  gem 'rubocop-performance', require: false
+  gem 'rubocop-rspec', require: false
+end
+
+local_gemfile = File.expand_path('Gemfile.local', __dir__)
+eval_gemfile local_gemfile if File.exist?(local_gemfile)

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    check-ahead (0.1.0)
+      dry-cli (~> 0.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    byebug (11.0.1)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    dry-cli (0.5.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    method_source (0.9.2)
+    parallel (1.19.1)
+    parser (2.7.0.2)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.7.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rubocop (0.79.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-performance (1.5.2)
+      rubocop (>= 0.71.0)
+    rubocop-rspec (1.37.1)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+  x86_64-darwin-18
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  check-ahead!
+  pry-byebug
+  rake (~> 10.0)
+  rspec (~> 3.7)
+  rubocop
+  rubocop-performance
+  rubocop-rspec
+
+BUNDLED WITH
+   2.1.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 gimmy
+
+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,125 @@
+# check-ahead ![badge](https://action-badges.now.sh/gimmyxd/check-ahead)
+
+Helps you create consistent and transparent rules for checking commit messages.
+
+## Rake Tasks
+
+`check-ahead:commits` - checks the commits against defined rules
+
+`check-ahead:generate_rules` - generate rules from input
+
+**check-ahead** uses your **CONTRIBUTING.md** file
+
+```
+### Commit Message
+Accepted commits messages:
+<commits>
+
+* PA-\<digits>
+* maint
+* docs
+</commits>
+```
+
+The accepted content is defined between `<commits></commits>` tag and `<digits>` will be translated to the correspunding regex: `d+`.
+
+Check [example CONTRIBUTING.md](spec/fixtures/CONTRIBUTING.md)
+
+This will be used by `check-ahead:commits` which allows only commit messages that match `(PA-\d+|maint|docs)`
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'check-ahead'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install check-ahead
+
+## Usage
+### CLI
+```ruby
+CLI - based on dry-cli
+ - check-ahead --help # available commands
+ - check-ahead command --help # help for specicif commands
+
+Implemented commands:
+ - check-ahead check_commits
+ - check-ahead generate_rules TAGS
+```
+### Tasks
+```ruby
+# usually in your Rakefile
+
+require 'check-ahead'
+CheckAhead.load_tasks # loads rake task on demand
+
+# alternative loading
+require 'check-ahead'
+include CheckAhead # loads rake task on project initialization
+```
+
+## Configuration
+
+The gem supports configuration for: commit\_range, CONTRIBUTING.md path, base_tags
+
+Example:
+
+```ruby
+# inside your ruby project
+
+CheckAhead.configure do |config|
+  config.commit_range = 'master..HEAD'
+  config.contributing_md = "/docs/CONTRIBUTING.md"
+  config.base_tags = [revert]
+  config.max_length = 100
+  config.checking_max_length = true
+end
+```
+
+or **ENVIRONMENT** variables:
+
+```ruby
+ENV['BASE_TAGS']
+ENV['CONTRIBUTING_MD']
+ENV['COMMIT_RANGE']
+ENV['MAX_LENGTH']
+ENV['CHECK_MAX_LENGTH']
+```
+
+Defaults:
+
+```ruby
+base_tags = %w[revert merge]
+contributing_md = File.join('project_root/CONTRIBUTING.md')
+commit_range = 'master..HEAD'
+max_length = 50
+check_max_length = false
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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`.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gimmyxd/check-ahead. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the CheckAhead project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/gimmyxd/check-ahead/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'check-ahead'
+
+require 'bundler/gem_tasks'
+task default: :spec
+
+CheckAhead.load_tasks

data/bin/check-ahead

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'check-ahead'
+require 'check-ahead/cli'
+
+CheckAhead::CLI::Application.start

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'check-ahead'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/check-ahead.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'check-ahead/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'check-ahead'
+  spec.version       = CheckAhead::VERSION
+  spec.authors       = ['gimmy']
+  spec.email         = ['gheorghe.popescu@puppet.com']
+
+  spec.summary       = 'Guard against unwanted commits'
+  spec.description   = 'CheckAhead let you define rules to guard against unwanted commits'
+  spec.homepage      = 'https://github.com/gimmyxd/check-ahead'
+  spec.license       = 'MIT'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/gimmyxd/check-ahead'
+  spec.metadata['changelog_uri'] = 'https://github.com/gimmyxd/check-ahead/blob/master/CHANGELONG.md'
+
+  spec.bindir = 'bin'
+  spec.executables << 'check-ahead'
+
+  # 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(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '~> 2.3'
+
+  spec.add_runtime_dependency 'dry-cli', ' ~> 0.4'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.7'
+end

data/lib/actions/check_commits.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'validators/commit_summary_validator'
+require 'validators/commit_length_validator'
+
+module Actions
+  class CheckCommits
+    def initialize
+      @config = CheckAhead.configuration
+    end
+
+    def execute
+      check_commits
+    end
+
+    private
+
+    def check_commits
+      git_log.each_line do |commit_summary|
+        commit = Commit.new(commit_summary)
+        CommitSummaryValidator.call(commit) if @config.check_commit_message?
+        CommitLengthValidator.call(commit) if @config.check_max_length?
+        error_message = commit.errors.values.join
+
+        if error_message.empty?
+          STDOUT.puts "PASSED: #{commit_summary}"
+        else
+          error_message = error_message_header(commit_summary) + error_message
+          warn error_message
+          exit(false)
+        end
+      end
+    end
+
+    def git_log
+      `git log --no-merges --pretty=%s #{@config.commit_range}`
+    end
+
+    def error_message_header(commit_summary)
+      "\n\tCommit summary: #{commit_summary}\n".bold
+    end
+  end
+end

data/lib/actions/generate_rules.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Actions
+  class GenerateRules
+    def initialize(input)
+      @input = input
+    end
+
+    def execute
+      generate_output.green
+    end
+
+    private
+
+    def generate_output
+      "#{header}" \
+      "<commits>\n\n" \
+        "#{split_input}\n" \
+        "</commits>\n"
+    end
+
+    def split_input
+      @input.gsub('<digits>', '\\<digits>')
+            .split(',').map { |node| "* #{node}" }.join("\n")
+    end
+
+    def header
+      "### Commit Message\n" \
+      "Accepted commits messages:\n"
+    end
+  end
+end

data/lib/check-ahead.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'pry-byebug'
+
+require 'core_extensions/string'
+require 'check-ahead/version'
+require 'check-ahead/configuration'
+require 'data/commit'
+require 'data/contributing_md'
+
+module CheckAhead
+  class << self
+    def load_tasks
+      Dir["#{File.dirname(__dir__)}/lib/tasks/**/*.rake"].each { |file| load file }
+    end
+
+    def included(_base)
+      load_tasks
+    end
+  end
+end

data/lib/check-ahead/cli.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'dry/cli'
+require 'cli/commands'
+
+module CheckAhead
+  module CLI
+    class Application < Dry::CLI
+      def self.start
+        new.call
+      end
+
+      def self.new(commands = CLI::Commands)
+        super
+      end
+    end
+  end
+end

data/lib/check-ahead/configuration.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module CheckAhead
+  class Configuration
+    DEFAULT_ATTRS = {
+      base_tags: %w[revert merge],
+      contributing_md: File.join(Dir.pwd, 'CONTRIBUTING.md'),
+      commit_range: 'HEAD~1..HEAD',
+      max_length: 50,
+      check_max_length: false,
+      check_commit_message: true
+    }.freeze
+
+    ATTRS = DEFAULT_ATTRS.keys
+
+    attr_accessor(*ATTRS)
+
+    def initialize
+      DEFAULT_ATTRS.each do |attribute, value|
+        send("#{attribute}=", ENV[attribute.to_s.upcase] || value)
+      end
+    end
+
+    ATTRS.select { |attribute| attribute.to_s.start_with?('check') }.each do |attribute|
+      define_method("#{attribute}?") do
+        ['true', true].include?(send(attribute))
+      end
+    end
+  end
+
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield configuration
+    end
+  end
+end

data/lib/check-ahead/version.rb

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

data/lib/cli/commands.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'dry/cli'
+require 'actions/check_commits'
+require 'actions/generate_rules'
+
+module CheckAhead
+  module CLI
+    module Commands
+      extend Dry::CLI::Registry
+
+      class CheckCommits < Dry::CLI::Command
+        desc 'verify that commit messages match CONTRIBUTING.md requirements'
+
+        def call(*)
+          Actions::CheckCommits.new.execute
+        end
+      end
+
+      class GenerateRules < Dry::CLI::Command
+        desc 'generate the commits requirements to be added in CONTRIBUTING.md'
+        argument :tags,
+                 required: true,
+                 desc: 'tags separated by ",", used to generate rules, Example: PA-<digits>,maint,bump'
+
+        def call(tags:, **)
+          STDOUT.puts("\n\nGenerated output - please add it to CONTRIBUTING.md \n\n")
+          STDOUT.puts Actions::GenerateRules.new(tags).execute
+        end
+      end
+
+      register 'check_commits', CheckCommits
+      register 'generate_rules', GenerateRules
+    end
+  end
+end

data/lib/core_extensions/string.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+class String
+  def black
+    "\e[30m#{self}\e[0m"
+  end
+
+  def red
+    "\e[31m#{self}\e[0m"
+  end
+
+  def green
+    "\e[32m#{self}\e[0m"
+  end
+
+  def cyan
+    "\e[36m#{self}\e[0m"
+  end
+
+  def bold
+    "\e[1m#{self}\e[22m"
+  end
+
+  def italic
+    "\e[3m#{self}\e[23m"
+  end
+
+  def blink
+    "\e[5m#{self}\e[25m"
+  end
+
+  def no_colors
+    gsub(/\e\[\d+m/, '')
+  end
+end

data/lib/data/commit.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class Commit
+  attr_accessor :summary, :errors
+
+  def initialize(summary, errors = {})
+    @summary = summary
+    @errors = errors
+  end
+end

data/lib/data/contributing_md.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+class ContributingMd
+  class << self
+    def accepted_tags
+      @accepted_tags ||= accepted_commits_section
+                         .delete("\n*")
+                         .gsub("\<digits>", 'd+')
+                         .split
+                         .join('|')
+    end
+
+    def accepted_commits_section
+      accepted_commits_section = contributing_file.match(%r{<commits>(.*)</commits>}m)
+      if accepted_commits_section
+        accepted_commits_section[1].chomp.strip
+      else
+        raise 'information not found in CONTRIBUTING.md, ' \
+              'please run check-ahead:generate_rules'
+      end
+    end
+
+    private
+
+    def contributing_file
+      @contributing_file ||= begin
+        path = CheckAhead.configuration.contributing_md
+        raise IOError, "CONTRIBUTING.md not found in #{path}" unless File.exist?(path)
+
+        @contributing_file = File.read(path)
+      end
+    end
+  end
+end

data/lib/tasks/check-ahead.rake

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'actions/check_commits'
+require 'actions/generate_rules'
+
+namespace :'check-ahead' do
+  desc 'verify that commit messages match CONTRIBUTING.md requirements'
+  task :commits do
+    Actions::CheckCommits.new.execute
+  end
+
+  desc 'generate the commits requirements to be added in CONTRIBUTING.md'
+  task :generate_rules do
+    STDOUT.puts("Enter the tags separated by \",\" \nExample: PA-<digits>,maint,bump")
+
+    input = STDIN.gets.strip
+
+    abort('Bad input'.bold.red) if input.empty?
+
+    STDOUT.puts("\n\nGenerated output - please add it to CONTRIBUTING.md \n\n")
+    STDOUT.puts Actions::GenerateRules.new(input).execute
+  end
+end

data/lib/validators/commit_length_validator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class CommitLengthValidator
+  class << self
+    def call(record)
+      return if record.summary.length < CheckAhead.configuration.max_length
+
+      record.errors[:length] = error_message(record.summary.length)
+    end
+
+    private
+
+    def error_message(length)
+      "\n\tThis commit summary is too long: #{length}/#{CheckAhead.configuration.max_length}\n\n"
+    end
+  end
+end

data/lib/validators/commit_summary_validator.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+class CommitSummaryValidator
+  class << self
+    def call(record)
+      return if record.summary =~ rules
+
+      record.errors[:summary] = error_message
+    end
+
+    private
+
+    def rules
+      /^\((#{ContributingMd.accepted_tags})\)|#{CheckAhead.configuration.base_tags.join('|')}/i
+    end
+
+    def error_message
+      "\tThe commit summary (i.e. the first line of the commit message) must start with one of:\n\n"  \
+      "#{ContributingMd.accepted_commits_section.delete('\\').split('*').join("\t\t")}\n" \
+      "\t\t #{CheckAhead.configuration.base_tags.join("\n\t\t ")}\n" \
+      "\n\tThis test for the commit summary is case-insensitive.\n"
+    end
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: check-ahead
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- gimmy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-01-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+description: CheckAhead let you define rules to guard against unwanted commits
+email:
+- gheorghe.popescu@puppet.com
+executables:
+- check-ahead
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/rspec.yml"
+- ".github/workflows/rubocop.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/check-ahead
+- bin/console
+- bin/setup
+- check-ahead.gemspec
+- lib/actions/check_commits.rb
+- lib/actions/generate_rules.rb
+- lib/check-ahead.rb
+- lib/check-ahead/cli.rb
+- lib/check-ahead/configuration.rb
+- lib/check-ahead/version.rb
+- lib/cli/commands.rb
+- lib/core_extensions/string.rb
+- lib/data/commit.rb
+- lib/data/contributing_md.rb
+- lib/tasks/check-ahead.rake
+- lib/validators/commit_length_validator.rb
+- lib/validators/commit_summary_validator.rb
+homepage: https://github.com/gimmyxd/check-ahead
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/gimmyxd/check-ahead
+  source_code_uri: https://github.com/gimmyxd/check-ahead
+  changelog_uri: https://github.com/gimmyxd/check-ahead/blob/master/CHANGELONG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Guard against unwanted commits
+test_files: []