poper2 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: df74c70f0039a24891c57d86e219983339ce52d32f69dec68089f9bcc625ad80
+  data.tar.gz: 5d21b8ebb3aa7f19af125f4973447f54b0251cb839711964187604a0c78256e7
+SHA512:
+  metadata.gz: e53dcd176e89f702fe5f0ccd9473fa5c42483a0b99227dd026d060429dac3c642fba65a34fdbd73cf2ccdacb3ea608e7916642c9253cca3e33ccddcdf2f1174e
+  data.tar.gz: 71f5d74143040082f088007b5556e48becd092220a833ddc55e630a5256f4747f303e45ec4511f04a4a94ec4eaa22e328b99664e5535890a0d95a484ae15aa30

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2017 Mindaugas Mozūras
+
+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,76 @@
+# Poper2
+
+> Poper 2 is a fork of the original [poper](https://github.com/mmozuras/poper). The intention of this project is to keep it updated for any version bugs in dependencies that may arise.
+
+Poper makes sure that your git commit messages are well-formed. It's partly
+inspired by [this article][] written by [tpope][]. Rules specified there form
+the basis of [Poper rules][]. But Poper doesn't stop there. It also doesn't
+like generic commit messages like 'oops, fix tests'. Poper was created to be
+used by [Pronto][], but will work perfectly well in whatever scenario you'll
+come up for it!
+
+## Usage
+
+![Poper demo](poper.gif "")
+
+Install Poper like any other gem and then run it from your terminal, specifying
+a commit:
+
+```bash
+  gem install poper
+  cd /repo/which/commits/you/want/to/check
+  poper run HEAD~3
+```
+
+Every commit between current HEAD and specified commit will be checked.
+
+[this article]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+[tpope]: https://twitter.com/tpope
+[Poper rules]: https://github.com/mmozuras/poper/tree/master/lib/poper/rule
+[Pronto]: https://github.com/mmozuras/pronto
+
+## Configuration
+
+The behavior of Poper can be controlled via the `.poper.yml` configuration
+file. It must be placed in your project directory. A sample file, `.poper.sample.yml`, is included for easy setup.
+
+The file has the following format:
+
+```yaml
+disallow_single_word:
+  enabled: true
+
+character_limit:
+  enabled: true
+  number: 72
+
+summary_character_limit:
+  enabled: true
+  number: 50
+
+disallow_generic:
+  enabled: true
+  words:
+    - fix
+    - fixed
+    - fixes
+    - oops
+    - todo
+    - fixme
+    - commit
+    - changes
+    - hm
+    - hmm
+    - hmmm
+    - test
+    - tests
+    - quickfix
+
+enforce_capitalized:
+  enabled: true
+```
+
+All properties that can be specified via `.poper.yml`, can also be specified
+via environment variables. Their names will be the upcased path to the property.
+For example: `POPER_ENFORCE_CAPITALIZED_ENABLED` or `POPER_DISALLOW_GENERIC_WORDS`. (In the case of the latter, since environment variables don't support arrays, use a comma-separated list of words and poper will parse them appropriately.) Environment variables
+will always take precedence over values in configuration file.

data/bin/poper2

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'poper2'
+require 'poper/cli'
+
+Poper::CLI.start

data/lib/poper2/cli.rb

@@ -0,0 +1,34 @@
+require 'thor'
+
+module Poper2
+  class CLI < Thor
+    require 'poper2'
+    require 'poper/version'
+
+    class << self
+      def is_thor_reserved_word?(word, type)
+        return false if word == 'run'
+
+        super
+      end
+    end
+
+    desc 'run COMMIT', 'Run Poper, checking commits from HEAD to it'
+
+    def run(commit)
+      Runner.new(commit).run.each do |message|
+        # message.commit and message.message are Strings
+        # prints first 7 characteres of the commit sha1 hash
+        # followed by the associated message
+        puts "#{message.commit[0..6]}: #{message.message}"
+      end
+    end
+
+    desc 'version', 'Show the Poper version'
+    map %w[-v --version] => :version
+
+    def version
+      puts "Poper version #{::Poper::VERSION}"
+    end
+  end
+end

data/lib/poper2/config.rb

@@ -0,0 +1,20 @@
+module Poper2
+  class Config
+    def initialize(config_hash = ConfigFile.new.to_h)
+      @config_hash = config_hash
+    end
+
+    %w[
+      disallow_single_word
+      character_limit
+      summary_character_limit
+      disallow_generic
+      enforce_capitalized
+    ].each do |rule|
+      ConfigFile::EMPTY[rule].each do |key, _|
+        name = "#{rule}_#{key}"
+        define_method(name) { ENV["POPER_#{name.upcase}"] || @config_hash[rule][key] }
+      end
+    end
+  end
+end

data/lib/poper2/config_file.rb

@@ -0,0 +1,48 @@
+module Poper2
+  class ConfigFile
+    EMPTY = {
+      'disallow_single_word' => {
+        'enabled' => true
+      },
+      'character_limit' => {
+        'enabled' => true,
+        'number' => 72
+      },
+      'summary_character_limit' => {
+        'enabled' => true,
+        'number' => 50
+      },
+      'disallow_generic' => {
+        'enabled' => true,
+        'words' => %w[fix fixed fixes oops todo fixme commit changes hm hmm hmmm
+                      test tests quickfix]
+      },
+      'enforce_capitalized' => {
+        'enabled' => true
+      }
+    }.freeze
+
+    def initialize(path = '.poper.yml')
+      @path = path
+    end
+
+    def to_h
+      hash = File.exist?(@path) ? YAML.load_file(@path) : {}
+      deep_merge(hash)
+    end
+
+    private
+
+    def deep_merge(hash)
+      merger = proc do |_, oldval, newval|
+        if oldval.is_a?(Hash) && newval.is_a?(Hash)
+          oldval.merge(newval, &merger)
+        else
+          oldval.nil? ? newval : oldval
+        end
+      end
+
+      hash.merge(EMPTY, &merger)
+    end
+  end
+end

data/lib/poper2/rule/capitalization.rb

@@ -0,0 +1,19 @@
+module Poper2
+  module Rule
+    class Capitalization < Rule
+      def check(message)
+        error_message unless message[0] == message[0].capitalize
+      end
+
+      def enabled?
+        @config.enforce_capitalized_enabled.to_s == 'true'
+      end
+
+      private
+
+      def error_message
+        'Git commit message should start with a capital letter'
+      end
+    end
+  end
+end

data/lib/poper2/rule/character_limit.rb

@@ -0,0 +1,25 @@
+module Poper2
+  module Rule
+    class CharacterLimit < Rule
+      def check(message)
+        error_message if message.lines.any? do |line|
+          line.chomp.length > character_limit
+        end
+      end
+
+      def enabled?
+        @config.character_limit_enabled.to_s == 'true'
+      end
+
+      private
+
+      def character_limit
+        @config.character_limit_number.to_i
+      end
+
+      def error_message
+        "Every line of git commit message should be #{character_limit} chars or less"
+      end
+    end
+  end
+end

data/lib/poper2/rule/generic.rb

@@ -0,0 +1,32 @@
+module Poper2
+  module Rule
+    class Generic < Rule
+      def check(message)
+        words = message.scan(/[\w-]+/).compact
+        error_message if words.all? { |word| generic?(word) }
+      end
+
+      def enabled?
+        @config.disallow_generic_enabled.to_s == 'true'
+      end
+
+      private
+
+      def generic?(word)
+        disallowed_words.include?(word.downcase)
+      end
+
+      def disallowed_words
+        if @config.disallow_generic_words.is_a? Array
+          @config.disallow_generic_words
+        else
+          @config.disallow_generic_words.split(',').map(&:strip)
+        end
+      end
+
+      def error_message
+        'Consider writing a more detailed, not as generic, commit message'
+      end
+    end
+  end
+end

data/lib/poper2/rule/rule.rb

@@ -0,0 +1,19 @@
+module Poper2
+  module Rule
+    class Rule
+      @all = []
+
+      def self.all
+        @all.clone
+      end
+
+      def self.inherited(subclass)
+        @all << subclass
+      end
+
+      def initialize(config = Config.new)
+        @config = config
+      end
+    end
+  end
+end

data/lib/poper2/rule/single_word.rb

@@ -0,0 +1,19 @@
+module Poper2
+  module Rule
+    class SingleWord < Rule
+      def check(message)
+        error_message if message.split.count < 2
+      end
+
+      def enabled?
+        @config.disallow_single_word_enabled.to_s == 'true'
+      end
+
+      private
+
+      def error_message
+        'Git commit message should consist of more than a single word'
+      end
+    end
+  end
+end

data/lib/poper2/rule/summary_character_limit.rb

@@ -0,0 +1,23 @@
+module Poper2
+  module Rule
+    class SummaryCharacterLimit < Rule
+      def check(message)
+        error_message if message.lines.first.chomp.length > character_limit
+      end
+
+      def enabled?
+        @config.summary_character_limit_enabled.to_s == 'true'
+      end
+
+      private
+
+      def character_limit
+        @config.summary_character_limit_number.to_i
+      end
+
+      def error_message
+        "Git commit message summary (first line) should be #{character_limit} chars or less"
+      end
+    end
+  end
+end

data/lib/poper2/runner.rb

@@ -0,0 +1,44 @@
+require 'ostruct'
+
+module Poper2
+  class Runner
+    def initialize(commit, repo_path = '.')
+      @repo = Rugged::Repository.new(repo_path)
+      oid = @repo.rev_parse_oid(commit)
+      @commit = @repo.lookup(oid)
+    end
+
+    def run
+      commits.flat_map { |c| check(c) }.compact
+    end
+
+    private
+
+    def check(commit)
+      rules.map do |rule|
+        result = rule.check(commit.message)
+        OpenStruct.new(commit: commit.oid, message: result) if result
+      end
+    end
+
+    def rules
+      Rule::Rule.all.map do |rule_klass|
+        rule = rule_klass.new
+
+        rule if rule.enabled?
+      end.compact
+    end
+
+    def commits
+      @commits ||= begin
+        walker.reset
+        walker.push(@repo.last_commit.oid)
+        walker.take_while { |c| c.oid != @commit.oid } << @commit
+      end
+    end
+
+    def walker
+      @walker ||= Rugged::Walker.new(@repo)
+    end
+  end
+end

data/lib/poper2/version.rb

@@ -0,0 +1,3 @@
+module Poper2
+  VERSION = '0.3.0'.freeze
+end

data/lib/poper2.rb

@@ -0,0 +1,12 @@
+require 'rugged'
+require 'yaml'
+require 'poper2/runner'
+require 'poper2/rule/rule'
+require 'poper2/rule/capitalization'
+require 'poper2/rule/single_word'
+require 'poper2/rule/summary_character_limit'
+require 'poper2/rule/character_limit'
+require 'poper2/rule/generic'
+
+require 'poper2/config_file'
+require 'poper2/config'

metadata

@@ -0,0 +1,184 @@
+--- !ruby/object:Gem::Specification
+name: poper2
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Mindaugas Mozūras
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rugged
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.3
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+description:
+email: mindaugas.mozuras@gmail.com
+executables:
+- poper2
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/poper2
+- lib/poper2.rb
+- lib/poper2/cli.rb
+- lib/poper2/config.rb
+- lib/poper2/config_file.rb
+- lib/poper2/rule/capitalization.rb
+- lib/poper2/rule/character_limit.rb
+- lib/poper2/rule/generic.rb
+- lib/poper2/rule/rule.rb
+- lib/poper2/rule/single_word.rb
+- lib/poper2/rule/summary_character_limit.rb
+- lib/poper2/runner.rb
+- lib/poper2/version.rb
+homepage: https://github.com/mmozuras/poper
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Poper makes sure that your git commit messages are well-formed
+test_files: []