acmcommits 0.0.1

data/bin/lolcommits

@@ -0,0 +1,309 @@
+#!/usr/bin/env ruby
+
+begin
+  require 'lolcommits'
+rescue LoadError
+  require 'rubygems'
+  require 'lolcommits'
+end
+
+include Lolcommits
+require "launchy"
+require "choice"
+
+require 'methadone'
+include Methadone::CLILogging
+
+#
+# CHECK FOR FURTHER DEPENDENCIES
+#
+
+# which replacement http://stackoverflow.com/q/2108727
+def command?(name)
+  `which #{name}`
+  $?.success?
+end
+
+def die_on_fatal_conditions!
+  if Configuration.is_mac?
+    unless File.executable? File.join(Configuration::LOLCOMMITS_ROOT, "vendor", "ext", "imagesnap", "imagesnap")
+      fatal "Couldn't properly execute imagesnap for some reason, please file a bug?!"
+      exit 1
+    end
+  elsif Configuration.is_linux?
+    if not command?('mplayer')
+      fatal "Couldn't find mplayer in your PATH!"
+      exit 1
+    end
+  end
+  unless File.readable? File.join(Configuration::LOLCOMMITS_ROOT, "vendor", "fonts", "Impact.ttf")
+    fatal "Couldn't properly read Impact font from gem package, please file a bug?!"
+    exit 1
+  end
+  unless Configuration.valid_imagemagick_installed?
+    fatal "FATAL: ImageMagick does not appear to be properly installed!"
+    exit 1
+  end
+  if Configuration.git_config_color_always?
+    fatal "Due to a bug in the ruby-git library, git config for color.ui cannot be set to 'always'."
+    fatal "Try setting it to 'auto' instead!"
+    exit 1
+  end
+end
+
+def die_if_not_git_repo!
+  begin
+    debug "Checking for valid git repo"
+    g=Git.open('.')
+  rescue ArgumentError
+    # ruby-git throws an argument error if path isnt for a valid git repo...
+    fatal "Erm? Can't do that since we're not in a valid git repository!"
+    exit 1
+  end
+end
+
+#
+# NO ARGUMENTS SPECIFIED, HELP THE USER OUT
+#
+def do_noargs
+  #TODO: make this a contextual helper to know status of whether lolcommits is enabled
+  puts "Do what exactly?"
+  puts "Try: lolcommits --enable   (when in a git repository)"
+  puts "Or:  lolcommits --help"
+end
+
+HOOK_PATH = File.join ".git", "hooks", "post-commit"
+HOOK_DIR = File.join ".git", "hooks"
+
+#
+# IF --ENABLE, DO ENABLE
+#
+def do_enable
+  if not File.directory?(".git")
+    fatal "You don't appear to be in the base directory of a git project."
+    exit 1
+  end
+
+  #its possible a hooks dir doesnt exist, so create it if so
+  if not File.directory?(HOOK_DIR)
+    Dir.mkdir(HOOK_DIR)
+  end
+
+  if File.exists? HOOK_PATH
+    fatal "A post-commit hook already exists for this project."
+    #TODO: disambiguate between OUR post-commit hook and something else
+    exit 1
+  end
+
+  doc = "#!/bin/sh\nlolcommits --capture\n"
+  File.open(HOOK_PATH, 'w') {|f| f.write(doc) }
+  FileUtils.chmod 0755, HOOK_PATH
+  info "installed lolcommmit hook as:"
+  info "  -> #{File.expand_path(HOOK_PATH)}"
+  info "(to remove later, you can use: lolcommits --disable)"
+  # we dont symlink, but rather install a small stub that calls the one from path
+  # that way, as gem version changes, script updates even if new file thus breaking symlink
+end
+
+#
+# IF --DISABLE, DO DISABLE
+#
+def do_disable
+  if File.exists? HOOK_PATH
+    #TODO: check if hook file has been modified before removing
+    FileUtils.rm HOOK_PATH
+    info "removed #{HOOK_PATH}"
+  else
+    info "lolcommits is not enabled for this directory, so there is nothing to uninstall."
+  end
+end
+
+def configuration
+  if Choice.choices[:test]
+    Configuration.new(:loldir => Configuration.loldir_for('test'))
+  else
+    Configuration.new
+  end
+end
+
+#
+# IF --CAPTURE, DO CAPTURE
+#
+def do_capture
+  capture_delay = Choice.choices[:delay] || ENV['LOLCOMMITS_DELAY'] || 0
+  capture_device = Choice.choices[:device] || ENV['LOLCOMMITS_DEVICE'] || nil
+  capture_font = Choice.choices[:font] || ENV['LOLCOMMITS_FONT'] || nil
+
+  if Choice.choices[:test]
+    info "*** Capturing in test mode."
+    runner = Lolcommits::Runner.new(:capture_delay => capture_delay,
+      :capture_device => capture_device,
+      :message        => Choice.choices[:msg],
+      :sha            => Choice.choices[:sha],
+      :config         => configuration,
+      :font           => capture_font
+   )
+    runner.run
+
+    Launchy.open(runner.main_image)
+  else
+    runner = Lolcommits::Runner.new(:capture_delay => capture_delay,
+      :capture_device => capture_device,
+      :config         => configuration,
+      :font           => capture_font
+    )
+    runner.run
+  end
+end
+
+def do_configure
+  configuration.do_configure! Choice.choices[:plugin]
+end
+
+def do_last
+  die_if_not_git_repo!
+  lolimage = configuration.most_recent
+  if lolimage.nil?
+    warn "No lolcommits have been captured for this repository yet."
+    exit 1
+  end
+  Launchy.open lolimage
+end
+
+#
+# Command line parsing fun
+#
+Choice.options do
+
+  option :enable do
+    long "--enable"
+    short '-e'
+    action { do_enable }
+    desc "install lolcommits for this repo"
+  end
+
+  option :disable do
+    long "--disable"
+    short '-d'
+    action { do_disable }
+    desc "uninstall lolcommits for this repo"
+  end
+
+  option :capture do
+    long "--capture"
+    short '-c'
+    desc "capture lolcommit based on last git commit"
+  end
+
+  option :last do
+    long "--last"
+    short "-l"
+    desc "view the most recent lolcommit"
+  end
+
+  option :browse do
+    long "--browse"
+    short "-b"
+    desc "browse this repo's lolcommits"
+  end
+
+  option :configure do
+    long "--config"
+    desc "configure a plugin"
+  end
+
+  option :show_config do
+    short "-sc"
+    long  "--show-config"
+    desc "display configuration file"
+  end
+
+  option :plugin do
+    desc "pass plugin name for --config"
+    long "--plugin"
+    short "-p"
+    default nil
+  end
+
+  option :plugins do
+    desc "list all available plugins"
+    long "--plugins"
+  end
+
+  option :test do
+    long "--test"
+    desc "Run in test mode"
+  end
+
+  option :sha do
+    desc "pass SHA manually [TEST-MODE]"
+    long "--sha"
+    short '-s'
+    default "test-#{rand(10 ** 10)}"
+  end
+
+  option :msg do
+    desc "pass commit msg manually [TEST-MODE]"
+    long "--msg"
+    short '-m'
+    default "this is a test message i didnt really commit something"
+  end
+
+  option :delay do
+    long "--delay=SECONDS"
+    desc "delay taking of the snapshot by n seconds"
+    cast Integer
+    short '-w'
+  end
+
+  option :device do
+    long "--device=DEVICE"
+    desc "the device name used to take the snapshot (only mac)"
+  end
+
+  option :debug do
+    long "--debug"
+    desc "Output debugging information"
+  end
+
+  option :font do
+    long "--font=FONT_PATH"
+    short "-f"
+    desc "pass font file location"
+  end
+
+end
+
+# Set debug level if needed
+debug_mode = Choice.choices[:debug] || ENV['LOLCOMMITS_DEBUG'] || nil
+if debug_mode
+  logger.level = Logger::DEBUG
+  debug "Outputting at DEBUG verbosity"
+end
+
+#
+# check for fatal conditions before execution
+#
+die_on_fatal_conditions!
+
+#
+# Handle actions manually since choice seems weird
+#
+if not (Choice.choices[:enable] || Choice.choices[:disable])
+  if Choice.choices[:capture]
+    do_capture()
+  elsif Choice.choices[:configure]
+    do_configure()
+  elsif Choice.choices[:show_config]
+    puts configuration.user_configuration.to_yaml
+  elsif Choice.choices[:plugins]
+    configuration.puts_plugins()
+  elsif Choice.choices[:last]
+    do_last()
+  elsif Choice.choices[:browse]
+    die_if_not_git_repo!
+    Launchy.open configuration.loldir
+  else
+    do_noargs()
+  end
+end

data/features/bugs.feature

@@ -0,0 +1,58 @@
+Feature: Bug regression testing
+  As a developer
+  I want to ensure fixed bugs stay fixed
+  So that I don't have to fix them again!
+
+  #
+  # issue #58, https://github.com/mroth/lolcommits/issues/58
+  #
+  Scenario: handle git repos with spaces in directory name
+    Given I am in a git repository named "test lolol" with lolcommits enabled
+    And I successfully run `git commit --allow-empty -m 'can haz commit'`
+    Then the output should contain "*** Preserving this moment in history."
+    And a directory named "../.lolcommits/test-lolol" should exist
+
+  #
+  # issue #68, https://github.com/mroth/lolcommits/issues/68
+  #
+  @fake-interactive-rebase @slow_process @unstable
+  Scenario: Don't trigger capture during a git rebase
+    Given I am in a git repository named "yuh8history" with lolcommits enabled
+      And I do 6 git commits
+    When I successfully run `git rebase -i HEAD~5`
+    # Then there should be 4 commit entries in the git log
+    Then there should be exactly 6 jpgs in "../.lolcommits/yuh8history"
+
+  #
+  # issue #80, https://github.com/mroth/lolcommits/issues/80
+  #
+  Scenario: don't warn about system_timer (on MRI 1.8.7)
+    When I successfully run `lolcommits`
+    Then the output should not contain "Faraday: you may want to install system_timer for reliable timeouts"
+
+  #
+  # issue #81, https://github.com/mroth/lolcommits/issues/81
+  #
+  Scenario: don't want to see initialized constant warning from Faraday on CLI (on MRI 1.8.7)
+    When I successfully run `lolcommits`
+    Then the output should not contain "warning: already initialized constant DEFAULT_BOUNDARY"
+  
+  #
+  # issue #87, https://github.com/mroth/lolcommits/issues/87
+  #
+  @fake-no-imagemagick
+  Scenario: gracefully fail when imagemagick is not installed
+    When I run `lolcommits`
+    Then the output should contain "ImageMagick does not appear to be properly installed"
+    And the exit status should be 1
+
+  #
+  # issue #50, https://github.com/mroth/lolcommits/issues/50
+  #
+  Scenario: catch upstream bug with ruby-git and color=always
+    Given I am in a git repository named "whatev" with lolcommits enabled
+    And I successfully run `git config color.ui always`
+    When I run `lolcommits`
+    Then the output should contain "Due to a bug in the ruby-git library, git config for color.ui cannot be set to 'always'."
+    And the output should contain "Try setting it to 'auto' instead!"
+    And the exit status should be 1

data/features/lolcommits.feature

@@ -0,0 +1,147 @@
+Feature: Basic UI functionality
+
+  Scenario: App just runs
+    When I get help for "lolcommits"
+    Then the exit status should be 0
+    And the banner should be present
+
+  Scenario: Enable in a naked git repository
+    Given a git repository named "loltest" with no "post-commit" hook
+    When I cd to "loltest"
+    And I successfully run `lolcommits --enable`
+    Then the output should contain "installed lolcommmit hook as:"
+      And the output should contain "(to remove later, you can use: lolcommits --disable)"
+      And a file named ".git/hooks/post-commit" should exist
+      And the exit status should be 0
+
+  Scenario: Disable in a enabled git repository
+    Given I am in a git repository named "lolenabled" with lolcommits enabled
+    When I successfully run `lolcommits --disable`
+    Then the output should contain "removed"
+      And a file named ".git/hooks/post-commit" should not exist
+      And the exit status should be 0
+
+  Scenario: Trying to enable while not in a git repo fails
+    Given I am in a directory named "svnrulez"
+    When I run `lolcommits --enable`
+    Then the output should contain "You don't appear to be in the base directory of a git project."
+      And the exit status should be 1
+
+  Scenario: Commiting in an enabled repo triggers successful capture
+    Given I am in a git repository named "testcapture" with lolcommits enabled
+    When I do a git commit
+    Then the output should contain "*** Preserving this moment in history."
+      And a directory named "../.lolcommits/testcapture" should exist
+      And a file named "../.lolcommits/testcapture/tmp_snapshot.jpg" should not exist
+      And there should be exactly 1 jpg in "../.lolcommits/testcapture"
+
+  Scenario: Commiting in an enabled repo subdirectory triggers successful capture of parent repo
+    Given I am in a git repository named "testcapture" with lolcommits enabled
+      And a directory named "subdir"
+      And an empty file named "subdir/FOOBAR"
+    When I cd to "subdir/"
+      And I do a git commit
+    Then the output should contain "*** Preserving this moment in history."
+      And a directory named "../../.lolcommits/testcapture" should exist
+      And a directory named "../../.lolcommits/subdir" should not exist
+      And there should be exactly 1 jpg in "../../.lolcommits/testcapture"
+
+  Scenario: Show plugins
+    When I successfully run `lolcommits --plugins`
+    Then the output should contain a list of plugins
+
+  #
+  # a stab at recreating ken's scenarios with native aruba steps, not quite there yet in terms
+  # of elegance, but its passing so might as well leave in for now.
+  #
+  Scenario: Configuring plugin (with native aruba steps)
+    Given a git repository named "config-test"
+    When I cd to "config-test"
+    And I run `lolcommits --config` interactively
+    When I type "loltext"
+    When I type "true"
+    Then the output should contain a list of plugins
+    And the output should contain "Name of plugin to configure:"
+    Then the output should contain "enabled:"
+    Then the output should contain "Successfully Configured"
+    And a file named "../.lolcommits/config-test/config.yml" should exist
+    When I successfully run `lolcommits --show-config`
+    Then the output should contain "loltext:"
+    And the output should contain "enabled: true"
+
+  Scenario: Configuring Plugin
+    Given a git repository named "config-test"
+    When I cd to "config-test"
+    And I run `lolcommits --config` and wait for output
+    When I enter "loltext" for "Name of plugin to configure"
+    And I enter "true" for "enabled"
+    Then I should be presented "Successfully Configured"
+    And a file named "../.lolcommits/config-test/config.yml" should exist
+    When I successfully run `lolcommits --show-config`
+    Then the output should contain "loltext:"
+    And the output should contain "enabled: true"
+  
+  Scenario: Configuring Plugin In Test Mode
+    Given a git repository named "testmode-config-test"
+    When I cd to "testmode-config-test"
+    And I run `lolcommits --config --test` and wait for output
+    And I enter "loltext" for "Name of plugin to configure"
+    And I enter "true" for "enabled"
+    Then I should be presented "Successfully Configured"
+    And a file named "../.lolcommits/test/config.yml" should exist
+    When I successfully run `lolcommits --test --show-config`
+    Then the output should contain "loltext:"
+    And the output should contain "enabled: true"
+
+  Scenario: test capture should work regardless of whether in a git repository
+    Given I am in a directory named "nothingtoseehere"
+    When I run `lolcommits --test --capture`
+    Then the output should contain "*** Capturing in test mode."
+      And the output should not contain "path does not exist (ArgumentError)"
+      And the exit status should be 0
+
+  Scenario: test capture should store in its own test directory
+    Given I am in a git repository named "randomgitrepo" with lolcommits enabled
+    When I successfully run `lolcommits --test --capture`
+    Then a directory named "../.lolcommits/test" should exist
+    And a directory named "../.lolcommits/randomgitrepo" should not exist
+
+  Scenario: last command should work properly when in a lolrepo
+    Given a git repository named "randomgitrepo"
+      And a loldir named "randomgitrepo" with 2 lolimages
+      And I cd to "randomgitrepo"
+    When I run `lolcommits --last`
+    Then the exit status should be 0
+
+  Scenario: last command should fail gracefully if not in a lolrepo
+    Given I am in a directory named "gitsuxcvs4eva"
+    When I run `lolcommits --last`
+    Then the output should contain "Can't do that since we're not in a valid git repository!"
+    And the exit status should be 1
+
+  Scenario: last command should fail gracefully if zero lolimages in lolrepo
+    Given a git repository named "randomgitrepo"
+    And a loldir named "randomgitrepo" with 0 lolimages
+    And I cd to "randomgitrepo"
+    When I run `lolcommits --last`
+    Then the output should contain "No lolcommits have been captured for this repository yet."
+    Then the exit status should be 1
+
+  Scenario: browse command should work properly when in a lolrepo
+    Given a git repository named "randomgitrepo"
+      And a loldir named "randomgitrepo" with 2 lolimages
+      And I cd to "randomgitrepo"
+    When I run `lolcommits --browse`
+    Then the exit status should be 0
+
+  Scenario: browse command should fail gracefully when not in a lolrepo
+    Given I am in a directory named "gitsuxcvs4eva"
+    When I run `lolcommits --browse`
+    Then the output should contain "Can't do that since we're not in a valid git repository!"
+      And the exit status should be 1
+
+  Scenario: handle commit messages with quotation marks
+    Given I am in a git repository named "shellz" with lolcommits enabled
+    When I successfully run `git commit --allow-empty -m 'i hate \"air quotes\" dont you'`
+    Then the exit status should be 0
+      And there should be exactly 1 jpg in "../.lolcommits/shellz"

data/features/plugins.feature

@@ -0,0 +1,34 @@
+Feature: Plugins Work
+###
+  #@slow_process
+  #Scenario: Lolcommits.com integration works
+    #Given I am in a git repository named "dot_com" with lolcommits enabled
+    #When I run `lolcommits --config` and wait for output
+    #And I enter "dot_com" for "Plugin Name"
+    #And I enter "true" for "enabled"
+    #And I enter "b2a70ac0b64e012fa61522000a8c42dc" for "api_key"
+    # Then I should be presented "Successfully Configured"
+  #  When I do a git commit
+ #   Then the output should contain "*** Preserving this moment in history."
+#    And there should be exactly 1 jpg in "../.lolcommits/dot_com"
+###
+  Scenario: Disable loltext
+    Given I am in a git repository named "loltext" with lolcommits enabled
+    And I run `lolcommits --config` and wait for output
+    And I enter "loltext" for "Plugin Name"
+    And I enter "false" for "enabled"
+    Then I should be presented "Successfully Configured"
+    When I do a git commit
+    Then the output should contain "*** Preserving this moment in history."
+    And there should be exactly 1 jpg in "../.lolcommits/loltext"
+
+  Scenario: lolsrv integration works
+    Given I am in a git repository named "lolsrv" with lolcommits enabled
+    When I run `lolcommits --config` and wait for output
+    And I enter "lolsrv" for "Plugin Name"
+    And I enter "true" for "enabled"
+    And I enter "http://localhost" for "server"
+    Then I should be presented "Successfully Configured"
+    When I do a git commit
+    Then the output should contain "*** Preserving this moment in history."
+    And there should be exactly 1 jpg in "../.lolcommits/lolsrv"

data/features/step_definitions/lolcommits_steps.rb

@@ -0,0 +1,98 @@
+include FileUtils
+
+Given /^I am in a directory named "(.*?)"$/ do |dir_name|
+  steps %Q{
+    Given a directory named "#{dir_name}"
+    And I cd to "#{dir_name}"
+  }
+end
+
+Given /^a git repository named "(.*?)"$/ do |repo_name|
+  repo_dir = File.join current_dir, repo_name
+  mkdir_p repo_dir
+  Dir.chdir repo_dir do
+    sh "git init --quiet ."
+    sh "git config user.name 'Testy McTesterson'"
+    sh "git config user.email 'testy@tester.com'"
+  end
+end
+
+Given /^the git repository named "(.*?)" has no "(.*?)" hook$/ do |repo_name, hook_name|
+  hook_file = File.join current_dir, repo_name, ".git", "hooks", hook_name
+  delete(hook_file) if File.exists? hook_file
+end
+
+Given /^the git repository named "(.*?)" has a "(.*?)" hook$/ do |repo_name, hook_name|
+  hook_file = File.join current_dir, repo_name, ".git", "hooks", hook_name
+  touch(hook_file) if not File.exists? hook_file
+end
+
+Given /^a git repository named "(.*?)" with (a|no) "(.*?)" hook$/ do |repo_name, yesno_modifier, hook_name|
+  step %{a git repository named "#{repo_name}"}
+  step %{the git repository named "#{repo_name}" has #{yesno_modifier} "#{hook_name}" hook}
+end
+
+Given /^I am in a git repository named "(.*?)" with lolcommits enabled$/ do |repo_name|
+  steps %Q{
+    Given a git repository named "#{repo_name}"
+    And I cd to "#{repo_name}"
+    And I successfully run `lolcommits --enable`
+  }
+end
+
+When /^I run `(.*?)` and wait for output$/ do |command|
+  command = "cd #{current_dir} && #{command}"
+  @stdin, @stdout, @stderr = Open3.popen3(command)
+  @fields = Hash.new
+end
+
+Given /^a loldir named "(.*?)" with (\d+) lolimages$/ do |repo_name, num_images|
+  loldir = "tmp/aruba/.lolcommits/#{repo_name}"
+  mkdir_p loldir
+  num_images.to_i.times do
+    random_hex = "%011x" % (rand * 0xfffffffffff)
+    cp "test/images/test_image.jpg", File.join( loldir, "#{random_hex}.jpg")
+  end
+end
+
+Then /^I should be (prompted for|presented) "(.*?)"$/ do |_, prompt|
+  assert @stdout.read.to_s.include?(prompt)
+end
+
+When /^I enter "(.*?)" for "(.*?)"$/ do |input, field|
+  @fields[field] = input
+  @stdin.puts input
+end
+
+Then /^there should be (?:exactly|only) (.*?) jpg(?:s?) in "(.*?)"$/ do |n, folder|
+  assert_equal n.to_i, Dir["#{current_dir}/#{folder}/*.jpg"].count
+end
+
+Then /^the output should contain a list of plugins$/ do
+  step %{the output should contain "Available plugins: "}
+end
+
+When /^I do a git commit with commit message "(.*?)"$/ do |commit_msg|
+  filename = Faker::Lorem.words(1).first
+  step %{a 98 byte file named "#{filename}"}
+  step %{I successfully run `git add #{filename}`}
+  step %{I successfully run `git commit -m "#{commit_msg}"`}
+end
+
+When /^I do a git commit$/ do
+  commit_msg = Faker::Lorem.sentence
+  step %{I do a git commit with commit message "#{commit_msg}"}
+end
+
+When /^I do (\d+) git commits$/ do |n|
+  n.to_i.times do
+    step %{I do a git commit}
+    sleep 0.1
+  end
+end
+
+Then /^there should be (\d+) commit entries in the git log$/ do |n|
+  sleep 1 #let the file writing catch up
+  assert_equal n.to_i, `git shortlog | grep -E '^[ ]+\w+' | wc -l`.chomp.to_i
+end
+