grog 0.0.0

data/.document

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

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+features/tmp

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Tom ten Thij
+
+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,18 @@
+= grog
+
+A wrapper script for git-log - shows subject, time and author of each commit plus branches and tags
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Tom ten Thij. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "grog"
+    gem.summary = %Q{A wrapper script for git-log - shows subject, time and author of each commit plus branches and tags}
+    gem.description = %Q{A wrapper script for git-log}
+    gem.email = "git@tomtenthij.nl"
+    gem.homepage = "http://github.com/tomtt/grog"
+    gem.authors = ["Tom ten Thij"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "cucumber", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features)
+
+  task :features => :check_dependencies
+rescue LoadError
+  task :features do
+    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+  end
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "grog #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/bin/grog

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require 'grog'
+
+# puts `git log --pretty=format:"%x1b[33m%h%Creset %s %Cgreen(%an)%Creset"`
+options = Grog::Options.parse(ARGV)
+Grog::GitLog.print(:number_of_commits_to_show => options.number_of_commits_to_show,
+                   :show_datetimes => options.show_datetimes)

data/features/grog.feature

@@ -0,0 +1,19 @@
+Feature: default output of grog
+  In order to find out the state of my git repository
+  As a developer
+  I want to see an overview of my recent commits
+
+  Scenario: running grog with no options
+    Given a test git repo
+    And the test git repo has a file called "file_a" containing "I am A"
+    And a commit of all changes to the test git repo with message "Commit A"
+    And a checkout in the git repo with new branch called "branch_a"
+    And the test git repo has a file called "file_b" containing "I am B"
+    And a commit of all changes to the test git repo with message "Commit B"
+    When I run grog on the test git repo
+    Then the output should be
+      """
+Commit B
+Commit A
+
+      """

data/features/step_definitions/common_steps.rb

@@ -0,0 +1,3 @@
+Then /^debugger$/ do
+  debugger
+end

data/features/step_definitions/git_steps.rb

@@ -0,0 +1,27 @@
+Given /^a test git repo$/ do
+  features_dir = File.expand_path(File.dirname(__FILE__) + '/..')
+  @root_dir = File.expand_path(File.dirname(__FILE__) + '/../..')
+  @tmp_git_repo_dir = File.join(features_dir, 'tmp', 'git_repo')
+  if File.exists?(@tmp_git_repo_dir)
+    `rm -rf #{@tmp_git_repo_dir}`
+  end
+  `mkdir #{@tmp_git_repo_dir}`
+  `git init #{@tmp_git_repo_dir}`
+end
+
+Given /^the test git repo has a file called "([^\"]*)" containing "([^\"]*)"$/ do |filename, content|
+  File.open(File.join(@tmp_git_repo_dir, filename), 'w') do |file|
+    file.puts content
+  end
+end
+
+Given /^a commit of all changes to the test git repo with message "([^\"]*)"$/ do |message|
+  Dir.chdir(@tmp_git_repo_dir)
+  `git add -A .`
+  `git commit -m "#{message}"`
+end
+
+Given /^a checkout in the git repo with new branch called "([^\"]*)"$/ do |branch_name|
+  Dir.chdir(@tmp_git_repo_dir)
+  `git checkout -b #{branch_name} 2> /dev/null`
+end

data/features/step_definitions/grog_steps.rb

@@ -0,0 +1,9 @@
+When /^I run grog on the test git repo$/ do
+  Dir.chdir(@tmp_git_repo_dir)
+  grog_bin = File.join(@root_dir, 'bin', 'grog')
+  @grog_output = `#{grog_bin}`
+end
+
+Then /^the output should be$/ do |expected_output|
+  @grog_output.should == expected_output
+end

data/features/support/env.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'grog'
+
+require 'spec/expectations'
+require 'ruby-debug'

data/grog.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{grog}
+  s.version = ""
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tom ten Thij"]
+  s.date = %q{2009-11-01}
+  s.default_executable = %q{grog}
+  s.description = %q{A wrapper script for git-log}
+  s.email = %q{git@tomtenthij.nl}
+  s.executables = ["grog"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "bin/grog",
+     "features/grog.feature",
+     "features/step_definitions/grog_steps.rb",
+     "features/support/env.rb",
+     "grog.gemspec",
+     "lib/grog.rb",
+     "spec/grog_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/tomtt/grog}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A wrapper script for git-log - shows subject, time and author of each commit plus branches and tags}
+  s.test_files = [
+    "spec/grog_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<cucumber>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<cucumber>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<cucumber>, [">= 0"])
+  end
+end
+

data/lib/grog/git_log.rb

@@ -0,0 +1,107 @@
+require 'term/ansicolor'
+
+module Grog
+  class GitLog
+    @@placeholders = %w{H P an ai s}
+    def initialize(options)
+      @options = options
+      fetch_log
+    end
+
+    def self.print(options)
+      puts self.new(options).to_s
+    end
+
+    def to_s
+      @log_lines.map do |line|
+        values = Hash[*@@placeholders.zip(line.split('|||')).flatten]
+
+        sha = GitLog.short_sha1(values['H'])
+        date = GitLog.nice_date_format(values['ai'])
+        subject = values['s']
+        author = values['an']
+        branches = branches(values['H'])
+        tags = tags(values['H'])
+
+        line =
+          Term::ANSIColor.yellow + sha + ' '
+
+        if @options[:show_datetimes]
+          line +=
+            Term::ANSIColor.green + date + ' '
+        end
+
+        line +=
+          Term::ANSIColor.reset + subject + ' ' +
+          Term::ANSIColor.green + "(#{author})" + Term::ANSIColor.reset
+
+        unless branches.empty?
+          line += " B(" + Term::ANSIColor.red + branches.join(' ') + Term::ANSIColor.reset + ")"
+        end
+
+        unless tags.empty?
+          line += " T(" + Term::ANSIColor.cyan + tags.join(' ') + Term::ANSIColor.reset + ")"
+        end
+
+        line
+      end
+    end
+
+    protected
+
+    def branches(sha1)
+      @branches[sha1]
+    end
+
+    def tags(sha1)
+      @tags[sha1]
+    end
+
+    def self.short_sha1(sha1)
+      sha1[0,7]
+    end
+
+    def self.nice_date_format(date)
+      DateTime.parse(date).strftime('%Y-%m-%d %H:%M')
+    end
+
+    def self.lines_of_command(command)
+      `#{command}`.split("\n")
+    end
+
+    def self.first_line_of_command(command)
+      `#{command}`.split("\n").first
+    end
+
+    def git_log_command
+      format = @@placeholders.map{ |p| "%" + p }.join('|||')
+      'git log --pretty=format:"%s" -n %d' % [format, @options[:number_of_commits_to_show]]
+    end
+
+    def self.hash_from_rev_names(rev_names)
+      hash = Hash.new { |hash, key| hash[key] = [] }
+      rev_names.each do |rev_name|
+        sha1 = GitLog.first_line_of_command("git-rev-parse #{rev_name}")
+        hash[sha1] << rev_name
+      end
+      hash
+    end
+
+    def get_all_branches
+      branch_names = GitLog.lines_of_command("git branch -a --no-color --no-track").
+        map { |line| line[2..-1].split(' -> ').first }
+      @branches = GitLog.hash_from_rev_names(branch_names)
+    end
+
+    def get_all_tags
+      tag_names = GitLog.lines_of_command("git-tag")
+      @tags = GitLog.hash_from_rev_names(tag_names)
+    end
+
+    def fetch_log
+      get_all_branches
+      get_all_tags
+      @log_lines = GitLog.lines_of_command(git_log_command)
+    end
+  end
+end

data/lib/grog/options.rb

@@ -0,0 +1,27 @@
+require 'optparse'
+
+module Grog
+  class Options
+    attr_accessor :number_of_commits_to_show, :show_datetimes
+
+    def self.parse(argv)
+      Options.new(argv)
+    end
+
+    def initialize(argv)
+      @opts = OptionParser.new
+
+      @number_of_commits_to_show = 10
+      @opts.on("-n=N", "number of commits to show", Integer) { |val| @number_of_commits_to_show = val }
+
+      @show_datetimes = false
+      @opts.on("-d", "show datetimes") { @show_datetimes = true }
+      @opts.on_tail("-h", "--help", "Show this message") do
+        puts @opts
+        exit
+      end
+
+      @rest = @opts.parse(argv)
+    end
+  end
+end

data/lib/grog.rb

@@ -0,0 +1,5 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'grog/options'
+require 'grog/git_log'

data/spec/grog/git_log_spec.rb

@@ -0,0 +1,6 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'grog/git_log'
+
+describe Grog::GitLog do
+  it "should do stuff"
+end

data/spec/grog/options_spec.rb

@@ -0,0 +1,47 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'grog/options'
+
+describe Grog::Options do
+  describe "number of commits to show" do
+    it "should be set by the -n argument" do
+      options = Grog::Options.parse(%w{-n 34})
+      options.number_of_commits_to_show.should == 34
+    end
+
+    it "should be 10 by default" do
+      Grog::Options.new([]).number_of_commits_to_show.should == 10
+    end
+  end
+
+  describe "show datetimes" do
+    it "should be set if the -d flag is passed" do
+      options = Grog::Options.parse(%w{-d})
+      options.show_datetimes.should be_true
+    end
+
+    it "should be false by default" do
+      Grog::Options.new([]).show_datetimes.should be_false
+    end
+  end
+
+  describe "help" do
+    it "should print help info if the --help flag is passed" do
+      pending "how to ignore exception thrown by exit?"
+      options = Grog::Options.new([])
+      $stdout.should_receive(:write).with(options.instance_variable_get('@opts').to_s)
+      Grog::Options.new(%w{--help})
+    end
+
+    it "should print help info if the -h flag is passed" do
+      pending "how to ignore exception thrown by exit?"
+      options = Grog::Options.new([])
+      $stdout.should_receive(:write).with(options.instance_variable_get('@opts').to_s)
+      Grog::Options.new(%w{-h})
+    end
+
+    it "should exit" do
+      $stdout.stub!(:write)
+      lambda { Grog::Options.new(%w{--help}) }.should raise_error(SystemExit)
+    end
+  end
+end

data/spec/grog_spec.rb

@@ -0,0 +1,8 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Grog" do
+  it "fails" do
+    pending
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'grog'
+require 'spec'
+require 'spec/autorun'
+require 'ruby-debug'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: grog
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Tom ten Thij
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-02 00:00:00 +00:00
+default_executable: grog
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: A wrapper script for git-log
+email: git@tomtenthij.nl
+executables: 
+- grog
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/grog
+- features/grog.feature
+- features/step_definitions/common_steps.rb
+- features/step_definitions/git_steps.rb
+- features/step_definitions/grog_steps.rb
+- features/support/env.rb
+- grog.gemspec
+- lib/grog.rb
+- lib/grog/git_log.rb
+- lib/grog/options.rb
+- spec/grog/git_log_spec.rb
+- spec/grog/options_spec.rb
+- spec/grog_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/tomtt/grog
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A wrapper script for git-log - shows subject, time and author of each commit plus branches and tags
+test_files: 
+- spec/grog/git_log_spec.rb
+- spec/grog/options_spec.rb
+- spec/grog_spec.rb
+- spec/spec_helper.rb