nice_commits 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 252f86712702bfe890f593fcf0684746142734db
+  data.tar.gz: 46e005de64f06e2b077423d4b3f4836d9a928761
+SHA512:
+  metadata.gz: 65699cb2f2e4a550b0a505458f17ff35ac0dcbdb5ab438c27a3145fac1bc0629a860b08ac15340070a5fe9f940b72c549ab6d5d1232167004c42864c9d378594
+  data.tar.gz: 739fcaaaa302ea24ff438e0c4681e7e3b4dc13926be177f09f19ac1ec80fdaf238ff454779cbdf70a63e1c30755e145f8182c694216e919bc1176fdd6ca5ecc2

data/.gitignore

@@ -0,0 +1,6 @@
+.bundle/
+pkg/
+Gemfile.lock
+.rspec
+.ruby-gemset
+.ruby-version

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+# Declare your gem's dependencies in apress-test.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec

data/README.md

@@ -0,0 +1,4 @@
+nice_commits
+============
+
+

data/lib/nice_commits.rb

@@ -0,0 +1,11 @@
+require 'git'
+require 'nice_commits/version'
+require 'nice_commits/options'
+require 'nice_commits/validation'
+require 'nice_commits/notification'
+require 'nice_commits/commits'
+require 'nice_commits/invalid_commits'
+require 'nice_commits/message_validator'
+
+module NiceCommits
+end

data/lib/nice_commits/commits.rb

@@ -0,0 +1,18 @@
+module NiceCommits
+  class Commits
+    def initialize(git, options)
+      @git = git
+      @since = options.since
+    end
+
+    def each(&block)
+      log.each(&block)
+    end
+
+    private
+
+    def log
+      @git.log.since(@since)
+    end
+  end
+end

data/lib/nice_commits/invalid_commits.rb

@@ -0,0 +1,16 @@
+module NiceCommits
+  class InvalidCommits
+    def initialize(commits)
+      @commits = commits
+    end
+
+    def each(&block)
+      @commits.each do |commit|
+        validator = MessageValidator.new(commit.message)
+        unless validator.valid?
+          yield commit
+        end
+      end
+    end
+  end
+end

data/lib/nice_commits/message_validator.rb

@@ -0,0 +1,39 @@
+module NiceCommits
+  class MessageValidator
+    # Example:
+    #
+    # refactor(subscriptions): fix feature envy in sender
+    #
+    # Long commit description
+    # with list of changed files
+    # - lib/sender.rb
+    # - lib/strategy/mail.rb
+    #
+    FORMAT = /\A
+      ([a-z]+)                   # type of commit
+      \(([^)\n:]+)\)             # scope of changes
+      :[[:blank:]]+
+      ([^\n]{5,})                # subject
+      (?:\n\n([^\n]+(?:.*\n)+))? # body not necessary
+    \Z/x
+    MERGE = /\AMerge (?:branch|pull request)/
+
+    def initialize(message)
+      @message = message
+    end
+
+    def valid?
+      merge? || well_formed?
+    end
+
+    private
+
+    def merge?
+      !!(@message =~ MERGE)
+    end
+
+    def well_formed?
+      !!(@message =~ FORMAT)
+    end
+  end
+end

data/lib/nice_commits/notification.rb

@@ -0,0 +1,19 @@
+module NiceCommits
+  class Notification
+    def initialize(commit)
+      @commit = commit
+    end
+
+    def deliver
+      puts red(to_s)
+    end
+
+    def to_s
+      "(WARNING) Invalid git commit message\nSHA: %s\n%s\n" % [@commit.sha, @commit.message]
+    end
+
+    def red(string)
+      "\033[31m%s\033[0m" % string
+    end
+  end
+end

data/lib/nice_commits/options.rb

@@ -0,0 +1,7 @@
+module NiceCommits
+	class Options
+    attr_accessor :dir
+    attr_accessor :since
+    attr_accessor :logger
+  end
+end

data/lib/nice_commits/validation.rb

@@ -0,0 +1,36 @@
+module NiceCommits
+  class Validation
+    def initialize(options)
+      @options = options
+    end
+
+    def start
+      invalid_commits.each do |commit|
+        notification = Notification.new(commit)
+        notification.deliver
+      end
+    end
+
+    private
+
+    def commits
+      Commits.new(git, @options)
+    end
+
+    def invalid_commits
+      InvalidCommits.new(commits)
+    end
+
+    def git
+      @git ||= Git.open(work_dir, :log => logger)
+    end
+
+    def work_dir
+      @options.dir
+    end
+
+    def logger
+      @options.logger
+    end
+  end
+end

data/lib/nice_commits/version.rb

@@ -0,0 +1,3 @@
+module NiceCommits
+  VERSION = '0.0.2'
+end

data/nice_commits.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nice_commits/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'nice_commits'
+  spec.version       = NiceCommits::VERSION
+  spec.authors       = ['mender (Alexey Gorbov)']
+  spec.email         = ['main.mender@gmail.com']
+  spec.summary       = 'Git commit messages validator'
+  spec.description   = 'Validates format of git commit messages'
+  spec.homepage      = 'https://github.com/mender/nice_commits'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'git'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rspec'
+end

data/spec/nice_commits/message_validator_spec.rb

@@ -0,0 +1,97 @@
+require File.expand_path("../../spec_helper", __FILE__)
+
+describe NiceCommits::MessageValidator do
+	subject { NiceCommits::MessageValidator.new(message) }
+
+  describe '#valid?' do
+    context 'for merge message' do
+      let(:message) { %q{Merge branch 'master' into develop} }
+      it { expect(subject.valid?).to be true }
+    end
+
+    context 'for pull request message' do
+      let(:message) { %q{Merge pull request #1111 from contributor/master} }
+      it { expect(subject.valid?).to be true }
+    end
+
+    context 'for well formed message' do
+      let(:message) { %q{refactor(subscriptions): fix feature envy in sender} }
+      it { expect(subject.valid?).to be true }
+    end
+
+    context 'for well formed message with body' do
+      let(:message) { <<-MESSAGE }
+refactor(subscriptions): fix feature envy in sender
+
+Long commit description
+with list of changed files
+- lib/sender.rb
+- lib/strategy/mail.rb        
+      MESSAGE
+      it { expect(subject.valid?).to be true }
+    end
+
+    context 'for well formed message with blank lines in body' do
+      let(:message) { <<-MESSAGE }
+refactor(subscriptions): fix feature envy in sender
+
+Long commit description with list of changed files:
+
+- lib/sender.rb
+- lib/strategy/mail.rb        
+      MESSAGE
+      it { expect(subject.valid?).to be true }
+    end
+
+    context 'for emty message' do
+      let(:message) { '' }
+      it { expect(subject.valid?).to be false }
+    end
+
+    context 'for message with glued body' do
+      let(:message) { <<-MESSAGE }
+refactor(subscriptions): fix feature envy in sender
+Commit description
+      MESSAGE
+      it { expect(subject.valid?).to be false }
+    end
+
+    context 'for message with body without ending carriage return' do
+      let(:message) { %Q{refactor(subscriptions): fix feature envy in sender\n\nCommit description} }
+      it { expect(subject.valid?).to be false }
+    end
+
+    context 'for message without type' do
+      let(:message) { '(all): fix a lot of issues' }
+      it { expect(subject.valid?).to be false }
+    end
+
+    context 'for message without scope' do
+      let(:message) { 'all: fix a lot of issues' }
+      it { expect(subject.valid?).to be false }
+    end
+
+    context 'for not formed message' do
+      let(:message) { 'fixes(all) fix a lot of issues' }
+      it { expect(subject.valid?).to be false }
+    end
+
+    context 'for message without subject' do
+      let(:message) { <<-MESSAGE }
+refactor(all):
+
+fix a lot of issues
+      MESSAGE
+      it { expect(subject.valid?).to be false }
+    end
+
+    context 'for message with short subject' do
+      let(:message) { <<-MESSAGE }
+refactor(all): fix
+
+my commit is awesome
+      MESSAGE
+      it { expect(subject.valid?).to be false }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rspec'
+require File.expand_path("../../lib/nice_commits",  __FILE__)
+
+RSpec.configure do |config|
+  config.order = :random
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: nice_commits
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- mender (Alexey Gorbov)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: git
+  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: 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'
+description: Validates format of git commit messages
+email:
+- main.mender@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- lib/nice_commits.rb
+- lib/nice_commits/commits.rb
+- lib/nice_commits/invalid_commits.rb
+- lib/nice_commits/message_validator.rb
+- lib/nice_commits/notification.rb
+- lib/nice_commits/options.rb
+- lib/nice_commits/validation.rb
+- lib/nice_commits/version.rb
+- nice_commits.gemspec
+- spec/nice_commits/message_validator_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mender/nice_commits
+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: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Git commit messages validator
+test_files:
+- spec/nice_commits/message_validator_spec.rb
+- spec/spec_helper.rb