changelog_parser 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OWZiZTQ4MTA5YzNmZjJlMTIwNjU5MDI3MDQ1NjdhYjljMjFiNWZiNw==
+  data.tar.gz: !binary |-
+    Y2NjMDM0M2Y0MTdkMGQzOGFkOWE4NThlYmZkMzk5OTM2NDc2MzQ2Yw==
+SHA512:
+  metadata.gz: !binary |-
+    NmI5NDgwOTA2Zjg5ZjU5YTQ1NjY4ZjZiODVlMDBiNjY4YmJkZGJlZTQ1OGI0
+    MDU1MWUxYWM4N2U5NDBhZjVmM2Y3OTViNGJjOTBjODkwNTViMGE3ZmZiZDU1
+    OWM3OTYzMTQ2NWZmYmZlZmQ4MmYwNzEzNmNlYzk4NDY0ZWQ0N2U=
+  data.tar.gz: !binary |-
+    MTMzZGNiNDgwYjE0MDk4NDVmNTY5OGNjNjk1OWI3MTVhZDdmMmNjNGE2NTM1
+    YzEzODQ4NDNjMDhmODkxNWY2MzUyNGUzZTU1ZTNhMTFmOWQyMzQ2NGQzM2U3
+    NDkyNjUyZDlmMWZhZDdiNGIyY2UwMjNjYTI5ZDE5ODA3OTRhNTQ=

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "minitest", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "> 1.0.0"
+  gem "jeweler", "~> 1.8.4"
+end

data/Gemfile.lock

@@ -0,0 +1,53 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.6)
+    builder (3.2.2)
+    faraday (0.8.9)
+      multipart-post (~> 1.2.0)
+    git (1.2.6)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.1.1)
+    highline (1.6.21)
+    jeweler (1.8.8)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (0.1.11)
+      multi_json (>= 1.5)
+    minitest (5.3.3)
+    multi_json (1.9.3)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.3)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 0.1.8)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.3.1)
+    rdoc (3.12.2)
+      json (~> 1.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (> 1.0.0)
+  jeweler (~> 1.8.4)
+  minitest
+  rdoc (~> 3.12)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 David Elbe
+
+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.rdoc

@@ -0,0 +1,27 @@
+= changelog_parser
+
+A ruby gem for creating nice changelogs based on your git commits.
+
+== Installation
+
+`gem install changelog_parser`
+
+== Usage
+
+Just run `changelog` or `changelog true` in your git directory to print
+out a changelog for the last two versions in your gem.
+
+== Contributing to changelog_parser
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2014 David Elbe. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,43 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.name = "changelog_parser"
+  gem.homepage = "http://github.com/davidelbe/changelogparser"
+  gem.license = "MIT"
+  gem.summary = "A changelog parser/generator based on your git commits"
+  gem.description = "Use your git commit messages to create a changelog for your project"
+  gem.email = "david@elbe.me"
+  gem.authors = ["David Elbe"]
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "changelog_parser #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/bin/changelog

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'changelog_parser'
+ChangelogParser.new(*ARGV)
+exit 0

data/lib/changelog_parser.rb

@@ -0,0 +1,61 @@
+class ChangelogParser
+  def initialize(all = false)
+    @all = all
+    read_log
+    parse_lines
+  end
+
+  def commit_parts_divider
+    "__END_OF_PART__"
+  end
+
+  def commit_message_divider
+    "__END_OF_COMMIT__\n"
+  end
+
+  def read_log
+    format = %w(%s %B %an).join(commit_parts_divider)
+    format << commit_message_divider
+    @log = `git log -n 100 --no-merges --format='#{format}'`
+  end
+
+  def log_to_lines
+    @log.split(commit_message_divider).collect{ |l| l.gsub("\n", " ") }
+  end
+
+  def parse_lines
+    self.log_to_lines.each do |line|
+      next if is_merge?(line)
+      if is_version_bump?(line)
+        print_version_bump(line)
+      else
+        print_changelog(line)
+      end
+    end
+  end
+
+  def is_merge?(line)
+    line =~ /Merge/
+  end
+
+  def is_version_bump?(line)
+    line =~ /Version bump to/ ? true : false
+  end
+
+  def print_version_bump(line)
+    puts "=== #{line.split(commit_parts_divider)[0].gsub("Version bump to", "").gsub("  ", " ")}"
+  end
+
+  def print_changelog(line)
+    commit_parts      = line.split(commit_parts_divider)
+    author            = commit_parts[2]
+    commit_message    = commit_parts[1].to_s
+    changelog_message = commit_message.scan(/changelog:\s(.*)/i).flatten.first
+
+    if changelog_message
+      puts "   * #{changelog_message.strip} - #{author}"
+    else
+      puts "   * #{commit_message.strip} - #{author}" if @all
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'bundler'
+require 'minitest'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'minitest/unit'
+require 'minitest/spec'
+require 'minitest/autorun'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'changelog_parser'
+
+class MiniTest::Unit::TestCase
+end
+
+MiniTest.autorun

data/test/test_changelogparser.rb

@@ -0,0 +1,22 @@
+require 'helper'
+
+describe ChangelogParser do
+
+  # TODO: add tests
+  # Just ported a working Rake task to a gem
+
+  describe 'version bumps' do
+    it 'handles version bumps' do
+      text = 'Version bump to 1.2.3'
+      cp = ChangelogParser.new()
+      cp.is_version_bump?(text).must_equal(true)
+    end
+
+    it 'does not return version bump for all lines' do
+      text = 'something else'
+      cp = ChangelogParser.new()
+      cp.is_version_bump?(text).must_equal(false)
+    end
+  end
+
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: changelog_parser
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- David Elbe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+description: Use your git commit messages to create a changelog for your project
+email: david@elbe.me
+executables:
+- changelog
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/changelog
+- lib/changelog_parser.rb
+- test/helper.rb
+- test/test_changelogparser.rb
+homepage: http://github.com/davidelbe/changelogparser
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A changelog parser/generator based on your git commits
+test_files: []