Merge pull request #5 from jsomers/PureSin-master

Add help and ability to pass in other log options

Author: James Somers

README.md

@@ -13,6 +13,7 @@ The goal is to get the longest streak! (It's harder than you think...)
 - [Download the `git-game` executable](https://github.com/jsomers/git-game/releases/tag/1.0)
 - Put it somewhere on your PATH (like /usr/local/bin)
 - Then, in any git repository, run `git game`
+- (If you'd like, you can select a subset of commits, for example, `git game --after={2014-08-08}`. For more options, see [http://gitref.org/inspect/](http://gitref.org/inspect/).)
 
 ## Requirements
 

git-game

@@ -6,13 +6,38 @@ Signal.trap("INT") {
   exit 0
 }
 
+def print_header
+  puts "----------------------------------------------------------"
+  puts "                      THE GIT GAME                        "
+  puts "----------------------------------------------------------"
+  puts "Welcome! The goal of the git game is to guess committers"
+  puts "based on their commit messages.\n\n"
+end
+
+def print_help
+  puts "----------------------------------------------------------"
+  puts "                          USAGE                           "
+  puts "----------------------------------------------------------"
+  puts "git game [extra git log options]"
+  puts "EX: git game --after={2014-08-08}"
+  puts "(This script already uses --no-merges and --pretty."
+  puts "For more valid options see: http://gitref.org/inspect/)"
+end
+
+# -- Usage Text --
+if ARGV.count > 0 && (input = ARGV.shift) == 'help'
+  print_header
+  print_help
+  exit 0
+end
+
 # -- Parse commits --
 COMMIT_DELIMITER = "XXXCOMMITXXX"
 FIELD_DELIMITER = "|||"
 
 commit_format = ["%an", "%ar", "%B"].join(FIELD_DELIMITER)
-raw_commits = `git log --no-merges --pretty="#{COMMIT_DELIMITER}#{commit_format}"`.split("#{COMMIT_DELIMITER}")
 
+raw_commits = `git log --no-merges --pretty="#{COMMIT_DELIMITER}#{commit_format}" #{input if input}`.split("#{COMMIT_DELIMITER}")
 commits = []
 raw_commits.each do |c|
   next if c.strip.empty?
@@ -26,12 +51,7 @@ committers = commits.map { |c| c[:author] }.compact.uniq
 # -- Show welcome message --
 system('clear')
 
-puts "----------------------------------------------------------"
-puts "                      THE GIT GAME                        "
-puts "----------------------------------------------------------"
-puts "Welcome! The goal of the git game is to guess committers"
-puts "based on their commit messages.\n\n"
-
+print_header
 puts "You're playing in a repo with #{commits.size} commits and #{committers.size}"
 puts "distinct committers.\n\n"