poper 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b7153ad540eeef4da3f86fd9a67254ca040bc3eb
+  data.tar.gz: 71a62ce9a84843f339e2a80d5fc925193252626d
+SHA512:
+  metadata.gz: 26e4417bd8841090135832e04e8162c896f7d25e8b92c088dc5843e346d56277af3adba03fbd7f2e797f092cd207953aae65d61e460a6d5b6cf387c93489bea7
+  data.tar.gz: 9fa2595e63b97637797c83f1553270c437f8492946173496b1fd70e7ad76cfdd7b8062dff7625f135832a09b61083fa2540a0682bcf42179b34a302d5e950b9c

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2013 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,24 @@
+# Poper
+
+Poper makes sure that your git commit messages are well-formed
+
+[![Code Climate](https://codeclimate.com/github/mmozuras/poper.png)](https://codeclimate.com/github/mmozuras/poper)
+[![Build Status](https://travis-ci.org/mmozuras/poper.png)](https://travis-ci.org/mmozuras/poper)
+[![Dependency Status](https://gemnasium.com/mmozuras/poper.png)](https://gemnasium.com/mmozuras/poper)
+
+## Usage
+
+Poper is partly inspired by an [article](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) written by [tpope](https://twitter.com/tpope). That's where the name comes from actually. Rules from the article form the basis of [Poper rules](https://github.com/mmozuras/poper/tree/master/lib/poper/rule).
+
+![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 86ae550
+```
+
+Every commit between current HEAD and specified commit will be checked.

data/bin/poper

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

data/lib/poper.rb

@@ -0,0 +1,8 @@
+require 'rugged'
+require 'poper/runner'
+require 'poper/rule/rule'
+require 'poper/rule/capitalization'
+require 'poper/rule/single_word'
+require 'poper/rule/fifty_char_summary'
+require 'poper/rule/seventy_two_char_limit'
+require 'poper/rule/banned'

data/lib/poper/cli.rb

@@ -0,0 +1,30 @@
+require 'thor'
+
+module Poper
+  class CLI < Thor
+    require 'poper'
+    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|
+        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/poper/rule/banned.rb

@@ -0,0 +1,12 @@
+module Poper
+  module Rule
+    class Banned < Rule
+      MSG = 'Consider writing a more detailed commit summary'
+      BANNED = %w(fix fixed oops todo fixme commit changes hmm hmmm quickfix)
+
+      def check(message)
+        MSG if BANNED.include?(message.lines.first.strip.downcase)
+      end
+    end
+  end
+end

data/lib/poper/rule/capitalization.rb

@@ -0,0 +1,11 @@
+module Poper
+  module Rule
+    class Capitalization < Rule
+      MSG = 'Commit message should start with a capital letter'
+
+      def check(message)
+        MSG unless message[0] == message[0].capitalize
+      end
+    end
+  end
+end

data/lib/poper/rule/fifty_char_summary.rb

@@ -0,0 +1,11 @@
+module Poper
+  module Rule
+    class FiftyCharSummary < Rule
+      MSG = 'Summary should be 50 chars or less'
+
+      def check(message)
+        MSG if message.lines.first.length > 50
+      end
+    end
+  end
+end

data/lib/poper/rule/rule.rb

@@ -0,0 +1,15 @@
+module Poper
+  module Rule
+    class Rule
+      @all = []
+
+      def self.all
+        @all.clone
+      end
+
+      def self.inherited(subclass)
+        @all << subclass
+      end
+    end
+  end
+end

data/lib/poper/rule/seventy_two_char_limit.rb

@@ -0,0 +1,11 @@
+module Poper
+  module Rule
+    class SeventyTwoCharLimit < Rule
+      MSG = 'Every line should be 72 chars or less'
+
+      def check(message)
+        MSG if message.lines.any? { |line| line.length > 72 }
+      end
+    end
+  end
+end

data/lib/poper/rule/single_word.rb

@@ -0,0 +1,11 @@
+module Poper
+  module Rule
+    class SingleWord < Rule
+      MSG = 'Commit message should consist of more than a single word'
+
+      def check(message)
+        MSG if message.split.count < 2
+      end
+    end
+  end
+end

data/lib/poper/runner.rb

@@ -0,0 +1,41 @@
+require 'ostruct'
+
+module Poper
+  class Runner
+    def initialize(commit, repo_path = '.')
+      @repo = Rugged::Repository.new(repo_path)
+      @commit = @repo.lookup(commit)
+    end
+
+    def run
+      commits.map { |c| check(c) }
+             .flatten
+             .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 { |rule| rule.new }
+    end
+
+    def commits
+      @commits ||= begin
+        walker.reset
+        walker.push(@repo.last_commit)
+        walker.take_while { |c| c.oid != @commit.oid } << @commit
+      end
+    end
+
+    def walker
+      @walker ||= Rugged::Walker.new(@repo)
+    end
+  end
+end

data/lib/poper/version.rb

@@ -0,0 +1,3 @@
+module Poper
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: poper
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mindaugas Mozūras
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rugged
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+description: 
+email: mindaugas.mozuras@gmail.com
+executables:
+- poper
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/poper/cli.rb
+- lib/poper/rule/banned.rb
+- lib/poper/rule/capitalization.rb
+- lib/poper/rule/fifty_char_summary.rb
+- lib/poper/rule/rule.rb
+- lib/poper/rule/seventy_two_char_limit.rb
+- lib/poper/rule/single_word.rb
+- lib/poper/runner.rb
+- lib/poper/version.rb
+- lib/poper.rb
+- LICENSE
+- README.md
+- bin/poper
+homepage: http://github.org/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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.7
+signing_key: 
+specification_version: 4
+summary: Poper makes sure that your git commit messages are well-formed
+test_files: []
+has_rdoc: