lolcommits 0.2.0 → 0.3.0.pre1

data/.gitignore

@@ -6,3 +6,5 @@ pkg/*
 results.html
 html
 tmp
+*.swp
+*.swo

data/.travis.yml

@@ -3,8 +3,13 @@ rvm:
  - 1.8.7
  - 1.9.2
  - 1.9.3
+ - ruby-head
 
 before_install:
- - sudo apt-get update
- - sudo apt-get install mplayer libmagick9-dev
+ - sudo apt-get -qq update
+ - sudo apt-get -qq -y install mplayer libmagick9-dev
 
+#test against ruby-head as well so we know what's coming down the pipe
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/CHANGELOG

@@ -1,3 +1,7 @@
+0.3.0 (in development)
+  * fix bug involving git repositories with spaces in the name
+  * internal refactoring for modularity (thanks @kenmazaika!)
+
 0.2.0 (6 July 2012)
   * improved build system and testing with cucumber/methadone
     - goal is to get into a better framework to start doing major feature work

data/NOTES

@@ -0,0 +1,17 @@
+
+AFTER:
+ * update version (.pre)
+ * update README
+ * open3 and unit assertions in cuke tests, can remove with aruba ?
+ * better plugin list output, showing enabled status etc
+ * GET RID OF LOLCOMMITS_DIR in TEST ENV and FAKE $HOME instead
+ * clean up bin/lolcommits or refactor or whatever it's a mess
+
+MUCH LATER:
+ * auto version detection? (to encourage people to update)
+ * push stats to statsd or something so i know how many people are using it!
+ * pimp twitter
+   - in readme
+   - in post_install_message from gemspec
+ * a real website
+ 

data/README.md

@@ -10,7 +10,7 @@ By default, the lolimages are stored by a Github style short SHA in a `~/.lolcom
 ## Installation (Mac OS X)
 You'll need ImageMagick installed.  [Homebrew](http://mxcl.github.com/homebrew/) makes this easy.  Simply do:
 
-	brew install imagemagick --from-source
+	brew install imagemagick
 
 Then simply do:
 
@@ -72,8 +72,11 @@ environment variables.
  * Set webcam device on mac - set `LOLCOMMITS_DEVICE` environment variable.
  * Set delay persistently (for slow to warmup webcams) - set
    `LOLCOMMITS_DELAY` var to time in seconds.
- * TRANZLATE YOAR COMMIT_MSG TO LOLSPEKK - set
-   `LOLCOMMITS_TRANZLATE=1`.
+
+## Plugins
+
+ * TRANZLATE YOAR COMMIT_MSG TO LOLSPEKK - do 
+   `lolcommits --config -p tranzlate` and set enabled to `true`.
 
 ## Contributing
 

data/Rakefile

@@ -21,7 +21,9 @@ end
 CUKE_RESULTS = 'results.html'
 CLEAN << CUKE_RESULTS
 Cucumber::Rake::Task.new(:features) do |t|
-  t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format pretty --no-source -x"
+  optstr = "features --format html -o #{CUKE_RESULTS} --format pretty --no-source -x"
+  optstr << " -t @#{ENV["tag"]}" unless ENV["tag"].nil?
+  t.cucumber_opts = optstr
   t.fork = false
 end
 
@@ -38,6 +40,7 @@ task :default => [:test,:features]
 
 desc "Migrate an existing local .lolcommits directory to Dropbox"
 task :dropboxify do
+  $home = ENV['HOME']
   dropbox_loldir = "#{$home}/Dropbox/lolcommits"
   loldir = "#{$home}/.lolcommits"
   backup_loldir = "#{$home}/.lolcommits.old"

data/bin/lolcommits

@@ -8,6 +8,8 @@ rescue LoadError
 end
 
 include Lolcommits
+require "launchy"
+require "choice"
 
 #
 # CHECK FOR FURTHER DEPENDENCIES
@@ -19,28 +21,32 @@ def command?(name)
   $?.success?
 end
 
-if is_mac?
-  # this dependency now satisfied with bundled copy of imagesnap
-  #if not command?('imagesnap')
-  #  puts "Couldn't find imagesnap in your PATH!"
-  #  puts "Easiest way to get it is to install homebrew and do `brew install imagesnap`"
-  #  exit 1
-  #end
-  unless File.executable? File.join(LOLCOMMITS_ROOT, "ext", "imagesnap", "imagesnap")
+if Configuration.is_mac?
+  unless File.executable? File.join(Configuration::LOLCOMMITS_ROOT, "ext", "imagesnap", "imagesnap")
     puts "Couldn't properly execute imagesnap for some reason, please file a bug?!"
     exit 1
   end
-elsif is_linux?
+elsif Configuration.is_linux?
   if not command?('mplayer')
     puts "Couldn't find mplayer in your PATH!"
     exit 1
   end
 end
-unless File.readable? File.join(LOLCOMMITS_ROOT, "fonts", "Impact.ttf")
+unless File.readable? File.join(Configuration::LOLCOMMITS_ROOT, "fonts", "Impact.ttf")
   puts "Couldn't properly read Impact font from gem package, please file a bug?!"
   exit 1
 end
 
+def die_if_not_git_repo!
+  begin
+    g=Git.open('.')
+  rescue ArgumentError
+    # ruby-git throws an argument error if path isnt for a valid git repo...
+    puts "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
 #
@@ -48,6 +54,7 @@ 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"
@@ -96,6 +103,14 @@ def do_disable
   end
 end
 
+def configuration
+  if Choice.choices[:test]
+    Configuration.new(:loldir => Configuration.loldir_for('test'))
+  else
+    Configuration.new
+  end
+end
+
 #
 # IF --CAPTURE, DO CAPTURE
 #
@@ -104,11 +119,37 @@ def do_capture
   capture_device = Choice.choices[:device] || ENV['LOLCOMMITS_DEVICE'] || nil
 
   if Choice.choices[:test]
-    puts "*** capturing in test mode"
-    Lolcommits.capture(capture_delay, capture_device, true, Choice.choices[:msg], Choice.choices[:sha])
+    puts "*** 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 
+   )
+    runner.run
+
+    Launchy.open(runner.main_image)
   else
-    Lolcommits.capture(capture_delay, capture_device)
+    runner = Lolcommits::Runner.new(:capture_delay => capture_delay,
+      :capture_device => capture_device,
+      :config         => configuration 
+    )
+    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?
+    puts "No lolcommits have been captured for this repository yet."
+    exit 1
   end
+  Launchy.open lolimage
 end
 
 #
@@ -140,18 +181,35 @@ Choice.options do
     long "--last"
     short "-l"
     desc "view the most recent lolcommit"
-    action do
-      Launchy.open Lolcommits.most_recent
-    end
   end
 
   option :browse do
     long "--browse"
     short "-b"
     desc "browse this repo's lolcommits"
-    action do
-      Launchy.open Lolcommits.loldir
-    end
+  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
@@ -160,14 +218,14 @@ Choice.options do
   end
 
   option :sha do
-    desc "pass SHA manually (for test only)"
+    desc "pass SHA manually [TEST-MODE]"
     long "--sha"
     short '-s'
     default "test-#{rand(10 ** 10)}"
   end
 
   option :msg do
-    desc "pass commit msg manually (for test only)"
+    desc "pass commit msg manually [TEST-MODE]"
     long "--msg"
     short '-m'
     default "this is a test message i didnt really commit something"
@@ -189,9 +247,20 @@ end
 #
 # Handle actions manually since choice seems weird
 #
-if not (Choice.choices[:enable] || Choice.choices[:disable] || Choice.choices[:last] || Choice.choices[:browse])
+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

data/features/bugs.feature

@@ -0,0 +1,30 @@
+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 a git repository named "test lolol"
+    And an empty file named "test lolol/FOOBAR"
+    
+    When I cd to "test lolol"
+    And I successfully run `lolcommits --enable`
+    And I successfully run `git add .`
+    And I successfully run `git commit -m 'can haz commit'`
+    Then the output should contain "*** Preserving this moment in history."
+    And a directory named "../.lolcommits/test-lolol" should exist
+
+
+  #
+  # issue #53, https://github.com/mroth/lolcommits/issues/53
+  #
+  #@fake-root @simulate-env
+  #Scenario: error if can't read font file
+  #  Given "fonts/Impact.ttf" packaged file is not readable
+  #  When I run `lolcommits --test --capture`
+  #  Then the output should contain "Couldn't properly read Impact font from gem package"
+  #  And the exit status should be 1
+

data/features/lolcommits.feature

@@ -1,4 +1,4 @@
-Feature: Basic functionality
+Feature: Basic UI functionality
 
   Scenario: App just runs
     When I get help for "lolcommits"
@@ -6,36 +6,150 @@ Feature: Basic functionality
     And the banner should be present
 
   Scenario: Enable in a naked git repository
-    Given a git repository named "loltest"
-    And the git repository named "loltest" has no "post-commit" hook
-    
+    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 a git repository named "lolenabled"
-    And the git repository named "lolenabled" has a "post-commit" hook
-
+    Given a git repository named "lolenabled" with a "post-commit" hook
     When I cd to "lolenabled"
     And 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
 
-  @simulate-capture
-  Scenario: Commiting in an enabled repo triggers capture
+  Scenario: Trying to enable while not in a git repo fails
+    Given a directory named "svnrulez"
+    When I cd to "svnrulez"
+    And 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 a git repository named "testcapture"
     And an empty file named "testcapture/FOOBAR"
-    
     When I cd to "testcapture"
     And I successfully run `lolcommits --enable`
     And I successfully run `git add .`
     And I successfully run `git commit -m 'can haz 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 1 jpg in "../.lolcommits/testcapture"
+
+  Scenario: Commiting in an enabled repo subdirectory triggers successful capture of parent repo
+    Given a git repository named "testcapture"
+    And a directory named "testcapture/subdir"
+    And an empty file named "testcapture/subdir/FOOBAR"
+    When I cd to "testcapture/"
+    And I successfully run `lolcommits --enable`
+    Then I cd to "subdir/"
+    And I successfully run `git add .`
+    And I successfully run `git commit -m 'can haz 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 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 a directory named "nothingtoseehere"
+    When I cd to "nothingtoseehere"
+    And 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 a git repository named "randomgitrepo"
+    When I cd to "randomgitrepo"
+    And 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 a directory named "gitsuxcvs4eva"
+    And I cd to "gitsuxcvs4eva"
+    When I run `lolcommits --last`
+    Then the output should contain "Can't do that since we're not in a valid git repository!"
+    Then 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 a directory named "gitsuxcvs4eva"
+    And I cd to "gitsuxcvs4eva"
+    When I run `lolcommits --browse`
+    Then the output should contain "Can't do that since we're not in a valid git repository!"
+    Then the exit status should be 1