commit_message 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f8d784157830df75ac21facc4a7cdee165810d9e
+  data.tar.gz: d10774363005b51f9db174e69f00092837b69084
+SHA512:
+  metadata.gz: 1072620e2aa8047b3b699cc2814593be34475e510ce3f6d8281992fe19f4591a7969765a2a15aae6b0e521edd2478a317e736e44c17daa6c345e17208bdb6de8
+  data.tar.gz: 5d3ca5c74e73b0d6ea4c3f1360a9e83a1e43570666c84cde39d3f39eba340e04612678a1d677009d6f1a3d67ad2fff739fe270e7239d38409ee41e60df354b5c

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in commit_message.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ben Olive
+
+MIT License
+
+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,45 @@
+# CommitMessage
+
+Convert a commit message into a reasonable description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'commit_message'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install commit_message
+
+## Usage
+
+For the head of a repository in the working directory:
+
+```ruby
+puts CommitMessage.new
+```
+
+For a specific revision:
+
+```ruby
+puts CommitMessage.new(revision: "master")
+```
+
+For a different repo:
+
+```ruby
+puts CommitMessage.new(repo: "/path/to/repo")
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/sionide21/commit_message/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/commit_message.gemspec

@@ -0,0 +1,19 @@
+# coding: utf-8
+Gem::Specification.new do |spec|
+  spec.name          = "commit_message"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Ben Olive"]
+  spec.email         = ["ben.olive@salesloft.com"]
+  spec.summary       = "Convert a commit message into a reasonable description"
+  spec.homepage      = "https://github.com/sionide21/commit_message"
+  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_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/commit_message.rb

@@ -0,0 +1,53 @@
+class CommitMessage
+  attr_accessor :revision, :repo
+
+  def initialize(revision: "HEAD", repo: nil)
+    @revision = revision
+    @repo = repo || Dir.pwd
+  end
+
+  def to_s
+    if pull_request
+      "Pull Request ##{pull_request}: #{branch}"
+    elsif branch
+      "#{name}: Merge '#{branch}' into '#{local_branch}'"
+    else
+      "#{name}: #{message}"
+    end
+  end
+
+  private
+
+  def name
+    raw_message[/^Author: (.+) (?:<.+>)$/, 1]
+  end
+
+  def pull_request
+    message[/^Merge pull request #(\d+)/, 1]
+  end
+
+  def branch
+    return unless is_merge?
+    message[/from .+\/(.+)$/, 1] or message[/^Merge branch '(.+?)'/, 1]
+  end
+
+  def local_branch
+    message[/into (.+)$/, 1]
+  end
+
+  def message
+    raw_message.lines.last.strip
+  end
+
+  def git_command
+    "git log --pretty=short -1 #{revision}"
+  end
+
+  def is_merge?
+    raw_message.lines[1].start_with?("Merge: ")
+  end
+
+  def raw_message
+    Dir.chdir(repo) { `#{git_command}` }.strip
+  end
+end

data/spec/commit_message_spec.rb

@@ -0,0 +1,51 @@
+require 'commit_message'
+
+describe CommitMessage do
+  let (:commit_message) { CommitMessage.new }
+
+  describe '.new' do
+    it "defaults to HEAD in the CWD" do
+      expect(commit_message.revision).to eq("HEAD")
+      expect(commit_message.repo).to eq(Dir.pwd)
+    end
+
+    it "accepts parameters" do
+      commit_message = CommitMessage.new(revision: "master", repo: "/path/to/repo")
+      expect(commit_message.revision).to eq("master")
+      expect(commit_message.repo).to eq("/path/to/repo")
+    end
+  end
+
+  describe '#to_s' do
+    it "falls back to the author and message" do
+      commit_message.stub(:raw_message) { "commit 06082f66d541e581110406bbac3bc395bace3f86\nAuthor: Ben Olive <ben.olive@example.com>\n\n    Fire ze missiles" }
+      expect(commit_message.to_s).to eq("Ben Olive: Fire ze missiles")
+    end
+
+    it "leaves reverts alone" do
+      commit_message.stub(:raw_message) { "commit 4184d2d2b06eaa81a5a48678956dfd28feb6b118\nAuthor: Ben Olive <ben.olive@example.com>\n\n    Revert \"Merge pull request #95 from SalesLoft/super-secret-project\"" }
+      expect(commit_message.to_s).to eq("Ben Olive: Revert \"Merge pull request #95 from SalesLoft/super-secret-project\"")
+    end
+
+    it "renders the pull request" do
+      commit_message.stub(:raw_message) { "commit fc0b98da0b83329474922a920a6070d370091228\nMerge: f54dd28 4d344bb\nAuthor: Ben Olive <ben.olive@example.com>\n\n    Merge pull request #314 from SalesLoft/super-secret-project" }
+      expect(commit_message.to_s).to eq("Pull Request #314: super-secret-project")
+    end
+
+    it "renders pulls" do
+      commit_message.stub(:raw_message) { "commit 8ff2e3ac2bf32b3c05584e08ab977306d84bc02d\nMerge: d51e937 50464d8\nAuthor: Ben Olive <ben.olive@example.com>\n\n    Merge branch 'pirates' of github.com:SalesLoft/repo into master" }
+      expect(commit_message.to_s).to eq("Ben Olive: Merge 'pirates' into 'master'")
+    end
+
+    it "renders merges" do
+      commit_message.stub(:raw_message) { "commit a8ab66d0bdd40a4612425b0a0fee1417fbfbf940\nMerge: 617b40c 4184d2d\nAuthor: Ben Olive <ben.olive@example.com>\n\n    Merge branch 'master' into test" }
+      expect(commit_message.to_s).to eq("Ben Olive: Merge 'master' into 'test'")
+    end
+  end
+
+  describe '#git_command' do
+    it "returns the expected git command" do
+      expect(commit_message.send(:git_command)).to eq("git log --pretty=short -1 HEAD")
+    end
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: commit_message
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ben Olive
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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'
+- !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: 
+email:
+- ben.olive@salesloft.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- commit_message.gemspec
+- lib/commit_message.rb
+- spec/commit_message_spec.rb
+homepage: https://github.com/sionide21/commit_message
+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: Convert a commit message into a reasonable description
+test_files:
+- spec/commit_message_spec.rb