pimpmychangelog 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,7 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch('^spec/(.*)_spec.rb')
+  watch('^lib/pimpmychangelog/(.*)\.rb') { |m| "spec/#{m[1]}_spec.rb" }
+end

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/pimpmychangelog

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require File.expand_path('../../lib/pimpmychangelog.rb', __FILE__)
+
+PimpMyChangelog::CLI.run!(ARGV)

data/lib/pimpmychangelog/cli.rb

@@ -0,0 +1,24 @@
+module PimpMyChangelog
+  class CLI
+    def self.run!(args)
+      unless args.size == 3
+        puts "Usage: pimpmychangelog github_user github_project CHANGELOG.md"
+        exit 1
+      end
+
+      new(*args).run
+    end
+
+    attr_reader :user, :project, :changelog_path
+
+    def initialize(user, project, changelog_path)
+      @user = user
+      @project = project
+      @changelog_path = changelog_path
+    end
+
+    def run
+      puts Pimper.new(user, project, File.read(changelog_path)).better_changelog
+    end
+  end
+end

data/lib/pimpmychangelog/parser.rb

@@ -0,0 +1,27 @@
+module PimpMyChangelog
+  class Parser
+    attr_reader :changelog
+
+    # @param [String] changelog
+    def initialize(changelog)
+      @changelog = changelog
+    end
+
+    # @return [String] the changelog content without the link definitions
+    def content
+      @changelog.split(Pimper::SEPARATOR).first
+    end
+
+    # @return [Array] ordered array of issue numbers found in the changelog
+    #   Example: ['12', '223', '470']
+    def issues
+      changelog.scan(/#(\d+)/).flatten.uniq.sort_by(&:to_i)
+    end
+
+    # @return [Array] ordered array of contributors found in the changelog
+    #   Example: ['gregbell', 'pcreux', 'samvincent']
+    def contributors
+      changelog.scan(/@(\w+)/).flatten.uniq.sort
+    end
+  end
+end

data/lib/pimpmychangelog/pimper.rb

@@ -0,0 +1,61 @@
+module PimpMyChangelog
+
+  class Pimper
+    SEPARATOR = "<!--- The following link definition list is generated by PimpMyChangelog --->"
+
+    attr_reader :user, :project, :changelog
+
+    # @param user [String] Github user of this changelog
+    # @param project [String] Github project of this changelog
+    # @param changelog [String] The changelog
+    def initialize(user, project, changelog)
+      @user = user
+      @project = project
+      @changelog = changelog
+    end
+
+    # @return [String] The changelog with contributors and issues as link
+    def better_changelog
+      parsed_changelog = Parser.new(changelog)
+
+      linkify_changelog(parsed_changelog.content) +
+        links_definitions(parsed_changelog.issues, parsed_changelog.contributors)
+    end
+
+    protected
+
+    # @param [String] changelog
+    # @return [String] The changelog with users and issues linkified.
+    #
+    #   Example: "@pcreux closes issue #123"
+    #   # => "[@pcreux][] closes issue [#123][]"
+    def linkify_changelog(changelog)
+      changelog.
+        gsub(ISSUE_NUMBER_REGEXP, '\1[#\2][]\3').
+        gsub(CONTRIBUTOR_REGEXP, '\1[@\2][]\3')
+    end
+
+    # The following regexp ensure that the issue or contributor is
+    # not wrapped between brackets (aka: is a link)
+    ISSUE_NUMBER_REGEXP = /(^|[^\[])#(\d+)($|[^\]])/
+    CONTRIBUTOR_REGEXP = /(^|[^\[])@(\w+)($|[^\]])/
+
+    # @param [Array] issues An array of issue numbers
+    # @param [Array] contributors An array of contributors github ids
+    #
+    # @return [String] A list of link definitions
+    def links_definitions(issues, contributors)
+      return '' if issues.empty? && contributors.empty?
+
+      issues_list = issues.map do |issue|
+        "[##{issue}]: https://github.com/#{user}/#{project}/issues/#{issue}"
+      end
+
+      contributors_list = contributors.map do |contributor|
+        "[@#{contributor}]: https://github.com/#{contributor}"
+      end
+
+      ([SEPARATOR] + issues_list + contributors_list).join("\n")
+    end
+  end
+end

data/lib/pimpmychangelog/version.rb

@@ -0,0 +1,3 @@
+module PimpMyChangelog
+  VERSION = "0.0.1"
+end

data/lib/pimpmychangelog.rb

@@ -0,0 +1,3 @@
+%w(pimper parser cli version).each do |file|
+  require File.expand_path("../pimpmychangelog/#{file}.rb", __FILE__)
+end

data/pimpmychangelog.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "pimpmychangelog/version"
+
+Gem::Specification.new do |s|
+  s.name        = "pimpmychangelog"
+  s.version     = PimpMyChangelog::VERSION
+  s.authors     = ["Philippe Creux"]
+  s.email       = ["pcreux@gmail.com"]
+  s.homepage    = "https://github.com/pcreux/pimpmychangelog"
+  s.summary     = %q{Pimp your CHANGELOG.md}
+  s.description = %q{Linkify issue numbers (#123) and github users (@gregbell) in markdown changelogs.}
+
+  s.default_executable = %q{pimpmychangelog}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "guard-rspec"
+end

data/spec/parser_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe Parser do
+
+  describe "#initialize" do
+    it "should take a changelog" do
+      p = Parser.new('CHANGELOG')
+      p.changelog.should == 'CHANGELOG'
+    end
+  end
+
+  describe "#content" do
+    context "when the changelog has link definitions" do
+      let(:changelog) { <<-EOS
+# My Awesome ChangeLog
+
+This my awesome changelog.
+
+<!--- The following link definition list is generated by PimpMyChangelog --->
+#123: https://whatever
+@pcreux: https://github.com/pcreux
+EOS
+      }
+
+      it "should return the ChangeLog without the link definitions" do
+        Parser.new(changelog).content.should == <<-EOS
+# My Awesome ChangeLog
+
+This my awesome changelog.
+
+EOS
+      end
+    end # context "when the changelog has link definitions"
+
+    context "when the changelog does not have link definitions" do
+      let(:changelog) { "# My Awesome ChangeLog" }
+
+      it "should return the ChangeLog without the link definitions" do
+        Parser.new(changelog).content.should == changelog
+      end
+    end # context "when the changelog has link definitions"
+  end # describe "#content"
+
+  describe "#issues" do
+    it "should return a sorted list of unique issue numbers" do
+      Parser.new("#20 #100 #300 #20").issues.should == ['20', '100', '300']
+    end
+  end
+
+  describe "#contributors" do
+    it "should return a sorted list of unique contributors" do
+      Parser.new("@samvincent @pcreux @gregbell @pcreux").contributors.
+        should == ['gregbell', 'pcreux', 'samvincent']
+    end
+  end
+end

data/spec/pimper_spec.rb

@@ -0,0 +1,97 @@
+require 'spec_helper'
+
+describe Pimper do
+  describe "#initialize" do
+    it "should take a github user, a github project and a changelog" do
+      g = Pimper.new('gregbell', 'activeadmin', 'ChangeLog')
+      g.user.should == 'gregbell'
+      g.project.should == 'activeadmin'
+      g.changelog.should == 'ChangeLog'
+    end
+  end
+
+  describe "#better_changelog" do
+    let(:user) { 'gregbell' }
+    let(:project) { 'activeadmin' }
+
+    let(:better_changelog) { Pimper.new(user, project, changelog).better_changelog }
+
+    subject { better_changelog }
+
+    context "when the changelog does not contain any reference to issues or users" do
+      let(:changelog) { 'ChangeLog' }
+
+      it "should return the original changelog" do
+        better_changelog.should == changelog
+      end
+    end
+
+    context "when the changelog contains an issue number" do
+      let(:changelog) { 'Pull Request #123: Add I18n.' }
+
+      it "should wrap the issue number to make a link" do
+        better_changelog.should include("[#123][]")
+      end
+
+      it "should append the link definition at the end of the changelog" do
+        better_changelog.split("\n").last.should == "[#123]: https://github.com/gregbell/activeadmin/issues/123"
+      end
+    end
+
+    context "when the changelog contains a contributor" do
+      let(:changelog) { 'New feature by @pcreux' }
+
+      it "should wrap the issue number to make a link" do
+        better_changelog.should include("[@pcreux][]")
+      end
+
+      it "should append the link definition at the end of the changelog" do
+        better_changelog.split("\n").last.should == "[@pcreux]: https://github.com/pcreux"
+      end
+    end
+
+    context "when the changelog contains issue numbers or contributors which are links" do
+      let(:changelog) { '[@pcreux][] closes [#123][]' }
+
+      it "should leave them alone" do
+        better_changelog.should include("[@pcreux][] closes [#123][]")
+      end
+    end
+
+    context "when the changelog already contains issue numbers, link definitions and custom links" do
+      let(:changelog) { <<-EOS
+# New entry
+You know what? @pcreux closed issue #300!
+
+# Previous entries
+You know what? [@pcreux][] closed issue [#123][].
+And this is my link, don't touch it: [Adequate][http://adequatehq.com]
+
+<!--- The following link definitions are generated by PimpMyChangelog --->
+[#123]: https://github.com/gregbell/activeadmin/issues/123
+[@pcreux]: https://github.com/pcreux
+EOS
+      }
+
+      let(:better_changelog) { Pimper.new('gregbell', 'activeadmin', changelog).better_changelog }
+
+      it "should regenerate the link definition but leave the existing links alone" do
+        (better_changelog + "\n").should == <<-EOS
+# New entry
+You know what? [@pcreux][] closed issue [#300][]!
+
+# Previous entries
+You know what? [@pcreux][] closed issue [#123][].
+And this is my link, don't touch it: [Adequate][http://adequatehq.com]
+
+<!--- The following link definitions are generated by PimpMyChangelog --->
+[#123]: https://github.com/gregbell/activeadmin/issues/123
+[#300]: https://github.com/gregbell/activeadmin/issues/300
+[@pcreux]: https://github.com/pcreux
+EOS
+      end
+    end
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require File.expand_path('../../lib/pimpmychangelog', __FILE__)
+
+include PimpMyChangelog

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: pimpmychangelog
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Philippe Creux
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-25 00:00:00 -07:00
+default_executable: pimpmychangelog
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: guard-rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Linkify issue numbers (#123) and github users (@gregbell) in markdown changelogs.
+email: 
+- pcreux@gmail.com
+executables: 
+- pimpmychangelog
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Guardfile
+- Rakefile
+- bin/pimpmychangelog
+- lib/pimpmychangelog.rb
+- lib/pimpmychangelog/cli.rb
+- lib/pimpmychangelog/parser.rb
+- lib/pimpmychangelog/pimper.rb
+- lib/pimpmychangelog/version.rb
+- pimpmychangelog.gemspec
+- spec/parser_spec.rb
+- spec/pimper_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: https://github.com/pcreux/pimpmychangelog
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Pimp your CHANGELOG.md
+test_files: []
+