gog 0.0.2pre

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+.rvmrc

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+bundler_args: --without development
+rvm:
+  - 1.9.3
+before_script: git clone git://github.com/goglog/gog_test_repo.git spec/gog_test_repo

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'grit'
+
+group :test do
+  gem 'rake'
+  gem 'guard'
+  gem 'rspec'
+  gem 'guard-rspec'
+  gem 'factory_girl', "~> 3.0"
+end

data/Guardfile

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

data/README.md

@@ -0,0 +1,52 @@
+[![Build Status](https://secure.travis-ci.org/goglog/gog.png?branch=master)](http://travis-ci.org/goglog/gog)
+
+# Gog: The Git Changelog
+
+Gog aims to help developers to insert changelog data inside git commits.
+Gog allows to create changelogs based on commit data and tagged commits.
+
+## This is still alpha software !
+
+# Syntax
+
+They are different ways to create changelog entries:
+
+- One line
+
+```
+%Bug fix: Fixing issue #2012
+```
+
+- One line - one word 
+
+```
+%Feature Adding a function to jobs
+```
+
+- Long
+
+```
+%%Feature: Adding pluck function to ActiveRecord 
+pluck is a function allowing users to select only one column
+of a given model.
+%%
+```
+
+# Tags
+Gog will rely on version tags:
+
+```
+1.0.0
+1.0.1
+1.1.0
+2.0.0
+```
+
+# Changelog creation
+
+To show standard changelog run `gog` in a git repository
+
+```
+gog
+```
+

data/Rakefile

@@ -0,0 +1,11 @@
+require "rake"
+
+require "rspec/core/rake_task"
+
+task :default => [:spec]
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  # Put spec opts in a file named .rspec in root
+end

data/bin/gog

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+# -*- mode: ruby -*-
+
+require 'gog'
+
+class Gog
+  
+  def self.start(args = ARGV)
+    if args.empty?
+      $stdout.puts Gog.help
+    else
+      first_arg = args[0].downcase
+      case first_arg
+      when "version"
+        $stdout.puts Gog.version
+      when "log"
+        $stdout.puts Gog.log
+      end
+    end
+  end
+
+  self.start(ARGV)
+
+end

data/doc/Development.md

@@ -0,0 +1,39 @@
+# General dev help
+You must require the lib folder in order to directly gog binary:
+
+```
+Ruby -Ilib bin/gog version
+alias gogdev='Ruby -Ilib bin/gog'
+
+```
+
+# Todo :
+
+- Give more info with --help
+- Allow one line multiple words
+- Allow multiline changelogs
+
+# Gog test repo
+
+A real git repository is necesary for testing purpose. Git submodule is not sufficient, run :
+
+```
+git clone git://github.com/goglog/gog_test_repo.git spec/gog_test_repo
+```
+
+# irb
+Launch irb
+
+alter load path
+`$LOAD_PATH << "lib"`
+
+require gog
+`require './lib/gog'`
+
+# Rubygem deployment
+
+- Update version in version.rb
+- Update changelog in version.rb
+- Tag Repository in git
+- `gem build gog.gemspec`
+- `gem push gog-1.X.0.gem`

data/gog.gemspec

@@ -0,0 +1,23 @@
+# encoding: utf-8
+require File.expand_path('../lib/gog/version', __FILE__)
+
+
+Gem::Specification.new do |s|
+  s.name = 'gog'
+  s.version = Gog::VERSION
+
+  s.add_dependency 'grit', '~> 2.5'
+  s.add_development_dependency 'bundler', '~> 1.0'
+  s.authors = ['Thomas Darde']
+  s.description = %q{A git changelog utility}
+  s.email = 'gog@rougecardinal.fr'
+  s.executables = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
+  s.extra_rdoc_files = ['README.md']
+  s.files = `git ls-files`.split("\n")
+  s.homepage = 'http://github.com/goglog/gog'
+  s.rdoc_options = ['--charset=UTF-8']
+  s.require_paths = ['lib']
+  s.required_rubygems_version = Gem::Requirement.new('>= 1.3.6')
+  s.summary = s.description
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+end

data/lib/gog.rb

@@ -0,0 +1,21 @@
+require 'grit'
+require 'gog/commit'
+require 'gog/log'
+
+class Gog
+  class << self
+    def version
+      require 'gog/version'
+      "Gog #{Gog::VERSION}"
+    end
+    
+    def log
+      require 'gog/log'
+      Gog::Log.init
+    end
+    
+    def help
+      "to list a full changelog run:\n gog log"
+    end
+  end
+end

data/lib/gog/change.rb

@@ -0,0 +1,40 @@
+class Gog
+  class Change
+
+    attr_accessor :header, :message, :commit
+
+    def initialize(header, message, commit)
+      @header = header
+      @message = message
+      @commit = commit
+    end
+
+    def closest_tag
+      @closest_tag ||= find_closest_tag
+    end
+
+    def to_s
+      "#{@header}: #{message}"
+    end
+
+    private
+
+    def find_closest_tag
+      available_tags = Gog::Log.repo_tags
+      return if available_tags.empty?
+
+      available_tags_by_sha = {}
+      available_tags.each do |tag|
+        available_tags_by_sha[tag.commit.sha] = tag
+      end
+
+      Change.find_tag_in_self_or_parents(self, available_tags_by_sha)
+    end
+
+    def self.find_tag_in_self_or_parents(change, tags)
+      tag = tags[change.commit.sha]
+      tag || find_tag_in_self_or_parents(change.parents.first, tags)
+    end
+
+  end
+end

data/lib/gog/commit.rb

@@ -0,0 +1,18 @@
+require 'gog/change'
+
+ONE_LINE_ONE_WORD_REGEX = /^\%([^\s]+)\s(.*)$/
+
+class Gog
+  module Commit
+
+    def self.extract_changes(commit)
+      message = commit.message
+      matched = message.scan(ONE_LINE_ONE_WORD_REGEX)
+      return [] if matched.empty?
+      matched.map do |match|
+        Gog::Change.new match[0], match[1], commit
+      end
+    end
+
+  end
+end

data/lib/gog/log.rb

@@ -0,0 +1,50 @@
+require 'grit'
+
+class Gog
+  module Log
+    include Grit
+
+    @@repo
+
+    class << self
+
+
+      def init(repo = Grit::Repo.new("."))
+        @@repo = repo
+        @@changes = @@repo.commits.map do |commit|
+          Gog::Commit.extract_changes commit
+        end
+        @@changes.select! { |change| !change.empty? }
+        @@changes.flatten!
+        self
+      end
+
+      def changes
+        @@changes
+      end
+
+      def changes_by_tag
+        tags = Hash.new()
+        @@changes.each do |change|
+          tag_name = change.closest_tag.name
+          tags[tag_name] = [] unless tags[tag_name]
+          tags[tag_name] << change
+        end
+        tags
+      end
+
+      def to_s
+        if @@changes.empty?
+          'No changes found. Read https://github.com/goglog/gog for instructions.'
+        else
+          @@changes.join("\n")
+        end
+      end
+
+      def repo_tags
+        @@tags ||= @@repo.tags.sort {|a,b| a.name <=> b.name }
+      end
+
+    end
+  end
+end

data/lib/gog/version.rb

@@ -0,0 +1,3 @@
+class Gog
+  VERSION = "0.0.2pre"
+end

data/spec/factories/commit.rb

@@ -0,0 +1,37 @@
+FactoryGirl.define do
+
+  factory :commit, class: Grit::Commit do
+    ignore do
+      repo { stubbed_repo }
+      id "2"
+      parents ["3"]
+      tree "4"
+      author "Thomeas"
+      authored_date Time.now
+      committer "Thomas"
+      committed_date Time.now
+      message ["HEllog "]
+    end
+
+    initialize_with { new(repo, id, parents, tree, author, authored_date, committer, committed_date, message) }
+
+    factory :commit_with_one_line_change do
+      message ["Hello\n%Feature yes"]
+    end
+
+    factory :commit_with_two_one_line_changes do
+      message ["Hello\n%Feature yes\n%Feature also yes"]
+    end
+  end
+
+
+end
+
+def stubbed_repo
+  repo = RSpec::Mocks::Mock.new('repo')
+  repo.stub(:tags) { [] }
+  repo.stub(:commits) { [] }
+  Gog::Log.init repo
+  repo
+end
+

data/spec/factories/repo.rb

@@ -0,0 +1,10 @@
+FactoryGirl.define do
+
+  factory :repo, class: Grit::Repo do
+    ignore do
+      path (File.dirname(__FILE__) + '/../gog_test_repo')
+    end
+
+    initialize_with { new(path) }
+  end
+end

data/spec/lib/gog/commit_spec.rb

@@ -0,0 +1,39 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Gog::Commit do
+
+  describe "extract_changes" do
+    context "one line" do
+      context "no change" do
+        let(:commit) { FactoryGirl.build(:commit) }
+        it "finds a change" do
+          changes = Gog::Commit.extract_changes(commit)
+          changes.should be_empty
+        end
+      end
+
+      context "one change" do
+        let(:commit_with_one_line_change) { FactoryGirl.build(:commit_with_one_line_change) }
+        it "finds a change" do
+          changes = Gog::Commit.extract_changes(commit_with_one_line_change)
+          change = changes.first
+          change.header.should eq('Feature')
+          change.message.should eq('yes')
+          change.commit.sha.should eq('2')
+        end
+      end
+
+      context "two changes" do
+        let(:commit_with_two_one_line_changes) { FactoryGirl.build(:commit_with_two_one_line_changes) }
+        it "finds two changes" do
+          changes = Gog::Commit.extract_changes(commit_with_two_one_line_changes)
+          changes.size.should eq(2)
+          change = changes.last
+          change.header.should eq('Feature')
+          change.message.should eq('also yes')
+        end
+      end
+    end
+  end
+
+end

data/spec/lib/gog/log_spec.rb

@@ -0,0 +1,67 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Gog::Log do
+
+  describe "Showing log" do
+    context "stubbed_repos" do
+      context "no change" do
+        let(:repo) { stubbed_empty_repo }
+
+        it "shows empty changelog" do
+          log = Gog::Log.init repo
+          log.to_s.should eq("No changes found. Read https://github.com/goglog/gog for instructions.")
+        end
+      end
+
+      context "changes" do
+        let(:repo) { stubbed_repo }
+
+        it "shows empty changelog" do
+          log = Gog::Log.init repo
+          log.to_s.should eq("Feature: yes\nFeature: also yes")
+        end
+
+      end
+    end
+
+    context "real test repo" do
+      context "tags" do
+        let(:repo) { FactoryGirl.build(:repo) }
+
+        it "shows first tags" do
+          Gog::Log.init repo
+          Gog::Log.repo_tags.first.name.should eq('0.0.1'), "Are you sure you cloned the sub repo (see developemnt.md)?"
+          Gog::Log.repo_tags[1].name.should eq('0.0.2')
+        end
+
+        it 'finds closest tag for first change' do
+          Gog::Log.init repo
+          change = Gog::Log.changes.first
+          change.closest_tag.name.should eq('0.0.2')
+        end
+
+        it "show changes by tag" do
+          changes = %Q%{\"0.0.2\"=>[Enhancement: Readme in md format], \"0.0.1\"=>[Explaining: this repo]}%
+          Gog::Log.init repo
+          Gog::Log.changes_by_tag.inspect.should eq(changes)
+        end
+      end
+
+    end
+  end
+
+  private
+
+  def stubbed_empty_repo
+    repo = double('repo')
+    repo.stub(:commits){ [FactoryGirl.build(:commit)] }
+    repo
+  end
+
+  def stubbed_repo
+    repo = double('repo')
+    repo.stub(:commits){ [FactoryGirl.build(:commit_with_two_one_line_changes)] }
+    repo
+  end
+
+end

data/spec/lib/gog_spec.rb

@@ -0,0 +1,11 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Gog do
+
+  describe "version" do
+    it "shows version" do
+      Gog.version.should eq("Gog #{Gog::VERSION}")
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$TESTING=true
+
+$:.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+require 'gog'
+
+require 'factory_girl'
+FactoryGirl.find_definitions
+
+require 'rspec'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: gog
+version: !ruby/object:Gem::Version
+  version: 0.0.2pre
+  prerelease: 5
+platform: ruby
+authors:
+- Thomas Darde
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: A git changelog utility
+email: gog@rougecardinal.fr
+executables:
+- gog
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- bin/gog
+- doc/Development.md
+- gog.gemspec
+- lib/gog.rb
+- lib/gog/change.rb
+- lib/gog/commit.rb
+- lib/gog/log.rb
+- lib/gog/version.rb
+- spec/factories/commit.rb
+- spec/factories/repo.rb
+- spec/lib/gog/commit_spec.rb
+- spec/lib/gog/log_spec.rb
+- spec/lib/gog_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/goglog/gog
+licenses: []
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+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.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A git changelog utility
+test_files:
+- spec/factories/commit.rb
+- spec/factories/repo.rb
+- spec/lib/gog/commit_spec.rb
+- spec/lib/gog/log_spec.rb
+- spec/lib/gog_spec.rb
+- spec/spec_helper.rb