garaio-changelog 0.0.1.alpha.1

data/.gitignore

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

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create ruby-1.9.3@garaio-changelog

data/Gemfile

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

data/README.md

@@ -0,0 +1,5 @@
+# Garaio Changelog #
+
+## Usage ##
+
+    $ garaio-changelog v1.0.0..v1.1.0

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+
+FileList['tasks/**/*.rake'].each { |task| import task }
+
+task :default => :spec

data/bin/garaio-changelog

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+begin
+  require 'garaio-changelog'
+
+  options = ChangelogOptions.from_arguments(ARGV)
+
+  log = Changelog.new(".", options.log_range)
+  log.write_to(STDOUT, :format => options.format)
+
+rescue LoadError
+  puts "ERROR"
+  $stderr.puts <<-EOS
+  EOS
+  exit(1)
+end

data/garaio-changelog.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "garaio-changelog/version"
+
+Gem::Specification.new do |s|
+  s.name        = "garaio-changelog"
+  s.version     = Changelog::VERSION
+  s.authors     = ['Yves Senn', 'Jonas Baumann', 'Samuel Tonini']
+  s.email       = ['yves.senn@garaio.com', 'j.baumann@jone.ch', 'samuel.tonini@garaio.com']
+  s.homepage    = ""
+  s.summary     = %q{Git Changelog}
+  s.description = %q{Convert the git history into a nice Changelog}
+
+  s.rubyforge_project = "garaio-changelog"
+
+  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"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec"
+  s.add_runtime_dependency "virtus"
+end

data/lib/garaio-changelog.rb

@@ -0,0 +1,3 @@
+require "virtus"
+require "garaio-changelog/changelog"
+require "garaio-changelog/version"

data/lib/garaio-changelog/changelog.rb

@@ -0,0 +1,24 @@
+require 'garaio-changelog/repository'
+require 'garaio-changelog/pipeline'
+require 'garaio-changelog/formatters/plain'
+require 'garaio-changelog/formatters/console'
+require 'garaio-changelog/changelog_options'
+
+class Changelog
+
+  def initialize(path_to_repository, commit_range)
+    @repository = Repository.new(path_to_repository)
+    @commit_range = commit_range
+  end
+
+  def write_to(output, options = {})
+    repository_commits = @repository.commits(@commit_range)
+    @pipeline = Pipeline.default
+    processed_commits = @pipeline.call(repository_commits)
+
+    format = options[:format] || :plain
+    formatter = Formatters.const_get(format.to_s.capitalize).new
+    formatter.write_to(output, processed_commits)
+  end
+
+end

data/lib/garaio-changelog/changelog_options.rb

@@ -0,0 +1,32 @@
+# -*- coding: utf-8 -*-
+require 'optparse'
+require 'ostruct'
+
+class ChangelogOptions
+
+  def self.from_arguments(arguments)
+    options = OpenStruct.new
+
+    opts = OptionParser.new do |opts|
+      opts.banner = "Usage: garaio-changelog [COMMIT|RANGE] [options]"
+
+      opts.separator ""
+      opts.separator "Specific options:"
+
+      opts.on("-f", "--format [plain|console]", "Ausgabe Format.") do |f|
+        options.format = f
+      end
+
+      opts.on_tail("-h", "--help", "Zeige diese Ausgabge.") do
+        puts opts
+        exit
+      end
+    end
+
+    opts.order(arguments) {|argument| options.log_range = argument; break}
+    opts.parse!(arguments)
+
+    options
+  end
+
+end

data/lib/garaio-changelog/commit.rb

@@ -0,0 +1,11 @@
+class Commit
+  include Virtus::ValueObject
+
+  attribute :commit_hash, String
+  attribute :message, String
+  attribute :author, String
+  attribute :author_date, DateTime
+  attribute :committer, String
+  attribute :committer_date, DateTime
+
+end

data/lib/garaio-changelog/commit_parser.rb

@@ -0,0 +1,30 @@
+# -*- coding: utf-8 -*-
+module CommitParser
+
+  def self.format
+    mapping.keys.join(seperator)
+  end
+
+  def self.parse(line)
+    data = line.split(seperator)
+    attributes = Hash[mapping.values.zip(data)]
+
+    Commit.new(attributes)
+  end
+
+  def self.mapping
+    { '%H' => 'commit_hash',
+      '%s' => 'message',
+      '%an' => 'author',
+      '%ai' => 'author_date',
+      '%cn' => 'committer',
+      '%ci' => 'committer_date'}
+  end
+  class << self; private :mapping; end
+
+  def self.seperator
+    '☠'
+  end
+  class << self; private :mapping; end
+
+end

data/lib/garaio-changelog/formatters/console.rb

@@ -0,0 +1,22 @@
+module Formatters
+  class Console
+
+    def write_to(output, commits)
+      commits.each do |commit|
+        output << "%s-%s %s %s[%s]%s\n" %
+          [colors[:yellow], colors[:end], commit.message,
+           colors[:red], commit.author, colors[:end]]
+      end
+    end
+
+    def colors
+      {
+        :red => "\e[31m",
+        :yellow => "\e[33m",
+        :end => "\e[0m"
+      }
+    end
+    private :colors
+
+  end
+end

data/lib/garaio-changelog/formatters/plain.rb

@@ -0,0 +1,11 @@
+module Formatters
+  class Plain
+
+    def write_to(output, commits)
+      commits.each do |commit|
+        output << "- %s [%s]\n" % [commit.message, commit.author]
+      end
+    end
+
+  end
+end

data/lib/garaio-changelog/pipeline.rb

@@ -0,0 +1,17 @@
+class Pipeline
+
+  def initialize(sections)
+    @sections = sections
+  end
+
+  def call(inputs)
+    inputs.map do |input|
+      @sections.inject(input) { |i, section| section.call(i)}
+    end
+  end
+
+  def self.default
+    Pipeline.new([])
+  end
+
+end

data/lib/garaio-changelog/repository.rb

@@ -0,0 +1,20 @@
+# -*- coding: utf-8 -*-
+require 'garaio-changelog/commit'
+require "garaio-changelog/commit_parser"
+
+class Repository
+
+  def initialize(path_to_repository, commit_parser = CommitParser)
+    @path_to_repository = path_to_repository
+    @commit_parser = commit_parser
+  end
+
+  def commits(commit_range)
+    output = `cd #{@path_to_repository} && git log --pretty=#{@commit_parser.format} #{commit_range}`.strip
+
+    output.split("\n").map do |line|
+      @commit_parser.parse(line)
+    end
+  end
+
+end

data/lib/garaio-changelog/version.rb

@@ -0,0 +1,3 @@
+class Changelog
+  VERSION = "0.0.1.alpha.1"
+end

data/spec/integration/.gitignore

@@ -0,0 +1 @@
+example_repo

data/spec/integration/changelog_spec.rb

@@ -0,0 +1,20 @@
+# -*- coding: utf-8 -*-
+require 'integration/spec_helper'
+
+describe "Garaio-Changelog Generator" do
+
+  let(:path_to_repository) { File.join(File.dirname(__FILE__), 'example_repo') }
+
+  it 'Akzeptiert die Argumente von Git-Log' do
+    output = StringIO.new
+    log = Changelog.new(path_to_repository, 'HEAD')
+
+    log.write_to(output, :format => :plain)
+
+    output.rewind
+    output.readlines.should == ["- README hinzugefügt [Yves Senn]\n",
+                                "- Administrator-Benutzer hinzugefügt [Yves Senn]\n",
+                                "- Usability der Benutzermaske optimiert [Yves Senn]\n"]
+  end
+
+end

data/spec/integration/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'garaio-changelog'
+require 'rspec'

data/spec/unit/changelog_options_spec.rb

@@ -0,0 +1,25 @@
+# -*- coding: utf-8 -*-
+require 'unit/spec_helper'
+require 'garaio-changelog/changelog_options'
+
+describe ChangelogOptions do
+
+  it 'Speichert das ausgewählte Format' do
+    argumente = ["-f", "console"]
+
+    options = ChangelogOptions.from_arguments(argumente)
+
+    options.format.should == 'console'
+    options.log_range.should be_nil
+  end
+
+  it 'Speichert die Commit Range' do
+    argumente = ["v1.0.0..v1.1.0", "-f", "console"]
+
+    options = ChangelogOptions.from_arguments(argumente)
+
+    options.format.should == 'console'
+    options.log_range.should == 'v1.0.0..v1.1.0'
+  end
+
+end

data/spec/unit/changelog_spec.rb

@@ -0,0 +1,42 @@
+# -*- coding: utf-8 -*-
+require 'unit/spec_helper'
+require "garaio-changelog/changelog"
+
+describe Changelog do
+
+  let(:ziel_repository) { 'pfad/zu/repo' }
+  let(:commit_range) { 'release..master' }
+  let(:output) { mock }
+  let(:processed_commits) { stub }
+
+  before do
+    commits = stub
+
+    repository = mock
+    pipeline = mock
+
+    Repository.should_receive(:new).with(ziel_repository).and_return(repository)
+    repository.should_receive(:commits).with(commit_range).and_return(commits)
+    Pipeline.should_receive(:default).and_return(pipeline)
+    pipeline.should_receive(:call).with(commits).and_return(processed_commits)
+  end
+
+  subject { Changelog.new(ziel_repository, commit_range) }
+
+  it "Der PlainFormatter wird per Default verwendet" do
+    formatter = mock
+    Formatters::Plain.should_receive(:new).and_return(formatter)
+    formatter.should_receive(:write_to).with(output, processed_commits)
+
+    subject.write_to(output)
+  end
+
+  it 'Der Formatter kann angegeben werden' do
+    formatter = mock
+    Formatters::Console.should_receive(:new).and_return(formatter)
+    formatter.should_receive(:write_to).with(output, processed_commits)
+
+    subject.write_to(output, :format => :console)
+  end
+
+end

data/spec/unit/commit_parser_spec.rb

@@ -0,0 +1,22 @@
+# -*- coding: utf-8 -*-
+require 'unit/spec_helper'
+require 'garaio-changelog/commit_parser'
+require 'garaio-changelog/commit'
+
+describe CommitParser do
+
+  it 'Kennt das Log-Format für den git-log Befehl' do
+    described_class.format.should == '%H☠%s☠%an☠%ai☠%cn☠%ci'
+  end
+
+  it 'erstellt Commits aus einer Zeile' do
+    line = '6a4d545c736c5cb81a53bc9b8ea636cae39b02fe☠README hinzugefügt☠Yves Senn☠2012-03-13 14:15:37 +0100☠Hans Peter☠2013-03-13 14:15:37 +0200'
+    described_class.parse(line).should == Commit.new(:commit_hash => '6a4d545c736c5cb81a53bc9b8ea636cae39b02fe',
+                                                     :message => 'README hinzugefügt',
+                                                     :author => 'Yves Senn',
+                                                     :author_date => DateTime.parse('2012-03-13 14:15:37 +0100'),
+                                                     :committer => 'Hans Peter',
+                                                     :committer_date => DateTime.parse('2013-03-13 14:15:37 +0200'))
+  end
+
+end

data/spec/unit/formatters/console_spec.rb

@@ -0,0 +1,20 @@
+require 'unit/spec_helper'
+require 'garaio-changelog/commit'
+require 'garaio-changelog/formatters/console'
+
+describe Formatters::Console do
+
+  it "Schreibt die Commit Nachrichten auf den Output mit Consolen ANSI Formatierung" do
+    output = stub
+
+    output.should_receive(:<<).with("\e[33m-\e[0m README editiert \e[31m[Yves Senn]\e[0m\n")
+    output.should_receive(:<<).with("\e[33m-\e[0m Benuztermaske angepasst \e[31m[Hans Peter]\e[0m\n")
+
+    subject.write_to(output, [Commit.new(:author => 'Yves Senn',
+                                         :message => 'README editiert'),
+                              Commit.new(:author => 'Hans Peter',
+                                         :message => 'Benuztermaske angepasst')])
+
+  end
+
+end

data/spec/unit/formatters/plain_spec.rb

@@ -0,0 +1,21 @@
+require 'unit/spec_helper'
+require 'garaio-changelog/commit'
+require 'garaio-changelog/formatters/plain'
+
+describe Formatters::Plain do
+
+  it "Schreibt die Commit Nachrichten auf den Output" do
+    output = stub
+
+    output.should_receive(:<<).with("- README editiert [Yves Senn]\n")
+    output.should_receive(:<<).with("- Benuztermaske angepasst [Hans Peter]\n")
+
+    subject.write_to(output, [Commit.new(:author => 'Yves Senn',
+                                         :message => 'README editiert'),
+                              Commit.new(:author => 'Hans Peter',
+                                         :message => 'Benuztermaske angepasst')])
+
+
+  end
+
+end

data/spec/unit/pipeline_spec.rb

@@ -0,0 +1,17 @@
+# -*- coding: utf-8 -*-
+require "garaio-changelog/pipeline"
+
+describe Pipeline do
+
+  let(:erster_abschnitt) { lambda {|i| "Schritt1: #{i}"} }
+  let(:zweiter_abschnitt) { lambda {|i| "Schritt2: #{i}"} }
+
+  subject { described_class.new([erster_abschnitt,
+                                 zweiter_abschnitt]) }
+
+  it "Jeder Abschnitt der Pipeline erhält als Input den Output des vorgängigen Abschnitts" do
+    subject.call(['first', 'second']).should == [ 'Schritt2: Schritt1: first',
+                                                  'Schritt2: Schritt1: second']
+  end
+
+end

data/spec/unit/repository_spec.rb

@@ -0,0 +1,26 @@
+# -*- coding: utf-8 -*-
+require "unit/spec_helper"
+require "garaio-changelog/repository"
+require "garaio-changelog/commit"
+
+describe Repository do
+
+  it "liefert die commits der range" do
+    ziel_repository = 'pfad/zu/repo'
+    commit_range = 'release..master'
+    commit_parser = mock(:format => "'%H☠%an'")
+    repo = Repository.new(ziel_repository, commit_parser)
+    repo.should_receive(:'`').with("cd pfad/zu/repo && git log --pretty='%H☠%an' release..master").and_return(<<-LOG
+6a4d545c736c5cb81a53bc9b8ea636cae39b02fe☠Yves Senn
+2dd1c8412ae4710d20fc5313ccf9e037ec6ca534☠Yves Senn
+ad628eb8365e5339c9c19f557f08192b43d7ca29☠Yves Senn
+LOG
+                                                                                                              )
+    commit_parser.should_receive(:parse).with('6a4d545c736c5cb81a53bc9b8ea636cae39b02fe☠Yves Senn').and_return('commit1')
+    commit_parser.should_receive(:parse).with('2dd1c8412ae4710d20fc5313ccf9e037ec6ca534☠Yves Senn').and_return('commit2')
+    commit_parser.should_receive(:parse).with('ad628eb8365e5339c9c19f557f08192b43d7ca29☠Yves Senn').and_return('commit3')
+
+    repo.commits(commit_range).should == ['commit1', 'commit2', 'commit3']
+  end
+
+end

data/spec/unit/spec_helper.rb

@@ -0,0 +1 @@
+require "virtus"

data/tasks/test.rake

@@ -0,0 +1,15 @@
+require 'rake/testtask'
+
+require 'rspec/core/rake_task'
+
+namespace :spec do
+  RSpec::Core::RakeTask.new(:unit) do |t|
+    t.pattern    = "spec/unit/**/*_spec.rb"
+  end
+
+  RSpec::Core::RakeTask.new(:integration) do |t|
+    t.pattern    = "spec/integration/**/*_spec.rb"
+  end
+end
+
+task :spec => ['spec:unit', 'spec:integration']

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: garaio-changelog
+version: !ruby/object:Gem::Version
+  version: 0.0.1.alpha.1
+  prerelease: 6
+platform: ruby
+authors:
+- Yves Senn
+- Jonas Baumann
+- Samuel Tonini
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2168847600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2168847600
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: &2168847000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2168847000
+description: Convert the git history into a nice Changelog
+email:
+- yves.senn@garaio.com
+- j.baumann@jone.ch
+- samuel.tonini@garaio.com
+executables:
+- garaio-changelog
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- README.md
+- Rakefile
+- bin/garaio-changelog
+- garaio-changelog.gemspec
+- lib/garaio-changelog.rb
+- lib/garaio-changelog/changelog.rb
+- lib/garaio-changelog/changelog_options.rb
+- lib/garaio-changelog/commit.rb
+- lib/garaio-changelog/commit_parser.rb
+- lib/garaio-changelog/formatters/console.rb
+- lib/garaio-changelog/formatters/plain.rb
+- lib/garaio-changelog/pipeline.rb
+- lib/garaio-changelog/repository.rb
+- lib/garaio-changelog/version.rb
+- spec/integration/.gitignore
+- spec/integration/changelog_spec.rb
+- spec/integration/spec_helper.rb
+- spec/unit/changelog_options_spec.rb
+- spec/unit/changelog_spec.rb
+- spec/unit/commit_parser_spec.rb
+- spec/unit/formatters/console_spec.rb
+- spec/unit/formatters/plain_spec.rb
+- spec/unit/pipeline_spec.rb
+- spec/unit/repository_spec.rb
+- spec/unit/spec_helper.rb
+- tasks/test.rake
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: garaio-changelog
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Git Changelog
+test_files:
+- spec/integration/.gitignore
+- spec/integration/changelog_spec.rb
+- spec/integration/spec_helper.rb
+- spec/unit/changelog_options_spec.rb
+- spec/unit/changelog_spec.rb
+- spec/unit/commit_parser_spec.rb
+- spec/unit/formatters/console_spec.rb
+- spec/unit/formatters/plain_spec.rb
+- spec/unit/pipeline_spec.rb
+- spec/unit/repository_spec.rb
+- spec/unit/spec_helper.rb