lolcommits 0.5.4 → 0.5.5

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OTgyMzJkN2VlNzkyODQ1NDdkMWQwM2U3ZjY3NTdmZGNhNDQxNDY1OQ==
+    MWEyZjJjMzUxNGE1N2M3ZTI0ZTc5N2ExZmI1OWQwYTRjZGNiZjliZg==
   data.tar.gz: !binary |-
-    ZmM0OTJjZmY5MDY2OGNjNzYxNDZjYTM0NzFlZmY4NjkwN2Y4ZGI3MA==
+    NDlkNDQyNDk3NmQzOTRmNTRkMjQ4ZmQ1YmNmMDQ2MDRhMmUzNjkzZg==
 SHA512:
   metadata.gz: !binary |-
-    YTVhNDFhYTE5NzZlMTM1ZGNmNmM2YzI1NTY0Nzk5NWI1ZjU1NGE3MTRjZmVm
-    NTdhMmQyYzI2NTQ0NzIwMGU4ODc3YjMxOGQ4MTA0MTYzYzZmOThmMTljMDcx
-    OTE2ZThlZWQ3ZjExMmVlNmIzNWE1OWQ5MjNiZTdhNjIyZTY3ZDU=
+    ZmQ1ZTQ3ZDZlNDE1NDNjMzc0YjU4NTQzMDdhNzJjZGUzMDExMTBmNDVlNmM2
+    MTUwNzIzOTgzNjUyMDhmOTQ4Nzk4MGU1NzA4NWM5ZjdmMzc0ZTdmYTA1YjZh
+    ODExYTUxNDJjOTZjMDQ0MWZiNmU5OTNjZTA1ZDA5YmEwMTA1NzU=
   data.tar.gz: !binary |-
-    MjVhZDM2ZGU3OGE3MzdkNzE0NmMyNzJmZWVkYTRhMjNjNGYyM2JiNDQ3YjUy
-    NzljMmQ0NDE3MGI2ZmVmMDdkZDE4MWViZTljODczZTU3YjlhMGQ2ODNiNjU3
-    YzFkNGQxMzJhMzRhMTBhYjMyMDE4NjM3ZTE0ZjVhYmNiMGU5Mjc=
+    OTk0NGNlY2Y4MTZiNDhiNTNhODRhOTRhODNmNjRmMDAyNjI4NmNjYTY1N2Ez
+    NTdjZTE3ZjJhZDQ1NTAwMThiYTY4MDJiMTQ2N2EyYjA2NWY3ZjVjNWFhZDgw
+    OWVlZjQ5ZjdjNDdlOGJkZTE0N2M4ODgyNjk3Nzc0YmM4NzkzOWY=

data/.gitignore

@@ -11,3 +11,4 @@ html
 tmp
 *.swp
 *.swo
+vendor/bundle

data/.travis.yml

@@ -5,6 +5,7 @@ rvm:
  - 1.9.3
  - 2.0.0
  - 2.1.0
+ - 2.1.2
 
 before_install:
  # use earlier version of Rubygems to avoid fatal bundler error on 1.8.7
@@ -34,4 +35,5 @@ deploy:
   gem: lolcommits
   on:
     tags: true
+    all_branches: true
     repo: mroth/lolcommits

data/CHANGELOG

@@ -1,5 +1,16 @@
-0.x.x (in development)
-  * TODO: figure out problems with GUI clients
+0.5.6 (in development)
+  * update gems!
+  * prepare plugins for extraction
+
+0.5.5 (29 September 2014)
+  * Animated gif capture support (@theY4Kman #226)
+  * Fix plugin config issues with user input (@matthutchinson #225 #223)
+  * Fix Linux FPS timing issues (@matthutchinson #215)
+  * Fix hook enable/disable issue (@matthutchinson #206)
+  * Fix Git GUI issues (@matthutchinson #196 #168 #193 #188 #159 #133 #123 #119 #104 #83)
+  * Mention Boxen script in README (@matthutchinson #208)
+  * Explain global Git hooks how-to in README (@matthutchinson #212 #112)
+  * Minor improvments to Linux Capturer (@matthutchinson)
 
 0.5.4 (13 April 2014)
   * Excluded vendor/bundle from rubocop cops (@matthutchinson)

data/README.md

@@ -1,72 +1,114 @@
 # lolcommits (git + webcam = lol)
 
-lolcommits takes a snapshot with your webcam every time you git commit code, and archives a lolcat style image with it.
-Git blame has never been so much fun.
+lolcommits takes a snapshot with your webcam every time you git commit code, and
+archives a lolcat style image with it.  Git blame has never been so much fun.
 
-By default, the lolimages are stored by a Github style short SHA in a `~/.lolcommits` directory created for you.
+By default, the lol images are stored by a Github style short SHA in a
+`~/.lolcommits` directory created for you.
 
-[![Gem Version](https://badge.fury.io/rb/lolcommits.png)](http://badge.fury.io/rb/lolcommits)
-[![Build Status](https://secure.travis-ci.org/mroth/lolcommits.png?branch=master)](http://travis-ci.org/mroth/lolcommits)
-[![Dependency Status](https://gemnasium.com/mroth/lolcommits.png)](https://gemnasium.com/mroth/lolcommits)
-[![Coverage Status](https://coveralls.io/repos/mroth/lolcommits/badge.png)](https://coveralls.io/r/mroth/lolcommits)
+[![Gem Version](http://img.shields.io/gem/v/lolcommits.svg?style=flat)](https://rubygems.org/gems/lolcommits)
+[![Build Status](http://img.shields.io/travis/mroth/lolcommits.svg?style=flat)](https://travis-ci.org/mroth/lolcommits)
+[![Dependency Status](http://img.shields.io/gemnasium/mroth/lolcommits.svg?style=flat)](https://gemnasium.com/mroth/lolcommits)
+[![CodeClimate Status](http://img.shields.io/codeclimate/github/mroth/lolcommits.svg?style=flat)](https://codeclimate.com/github/mroth/lolcommits)
+[![Coverage Status](http://img.shields.io/coveralls/mroth/lolcommits.svg?style=flat)](https://coveralls.io/r/mroth/lolcommits)
 
 ## Sample images
+
 <img src="http://blog.mroth.info/images/postcontent/yearinsideprojects/lolcommits_users2.jpg" />
 
-Please add your own lolcommit! Add to the [People Using Lolcommits](https://github.com/mroth/lolcommits/wiki/Lolcommits-from-around-the-world%21) page on the Wiki.
+Please add your own lolcommit! Add to the [People Using
+Lolcommits](https://github.com/mroth/lolcommits/wiki/Lolcommits-from-around-the-world%21)
+page on our wiki.
 
 ## Installation
+
 ### Mac OS X
-You'll need ImageMagick installed.  [Homebrew](http://mxcl.github.com/homebrew/) makes this easy.  Simply do:
+
+You'll need ImageMagick installed. [Homebrew](http://mxcl.github.com/homebrew/)
+makes this easy. Simply do:
 
 	brew install imagemagick
 
-Then simply do:
+Then install the gem with:
 
 	[sudo] gem install lolcommits
 
-(If you're using RVM, you can/should probably omit the sudo, but the default MacOSX Ruby install is dumb and requires it.)
+If you're using RVM (or rbenv), you can/should probably omit the sudo, but the
+default MacOSX Ruby install is dumb and requires it.
+
+If [Boxen](https://boxen.github.com) is your thing, [try
+this](https://github.com/AssuredLabor/puppet-lolcommits).
 
 ### Linux
-Install dependencies using your package manager of choice, for example in Ubuntu:
+
+Install dependencies using your package manager of choice, for example in
+Ubuntu:
 
     sudo apt-get install mplayer imagemagick libmagickwand-dev
 
-Then install the lolcommits gem:
+Then install the gem with:
 
     gem install lolcommits
 
-For more details, see [Installing on Linux](https://github.com/mroth/lolcommits/wiki/Installing-on-Linux).
+For more details, see [Installing on
+Linux](https://github.com/mroth/lolcommits/wiki/Installing-on-Linux).
+
+### Windows - here be dragons!
 
-### Windows
-Here be dragons! It all works but you'll need some more detailed instructions to get the dependencies installed.  See the wiki page for [Installing on Windows](https://github.com/mroth/lolcommits/wiki/Installing-on-Windows).
+It all works but you'll need some more detailed instructions to get the
+dependencies installed.  See the wiki page for [Installing on
+Windows](https://github.com/mroth/lolcommits/wiki/Installing-on-Windows).
 
 ## Usage
+
 ### Enabling and basic usage
-From within any git repository, simply do a `lolcommits --enable`. From that point on, any git commit will automatically trigger a lolcommit capture! All lolcommits are stored in `~/.lolcommits` by default, placed in a subdirectory by project name, and with a filename matching the commit hash.
 
-Don't worry about it too much, half the fun of lolcommits is forgetting it's installed!
+From within any git repository, simply do a `lolcommits --enable`. From that
+point on, any git commit will automatically trigger a lolcommit capture! All
+lolcommits are stored in `~/.lolcommits` by default, placed in a subdirectory by
+project name, and with a filename matching the commit hash.
+
+You can also enable lolcommits across all your local git repos. Follow [these
+steps](https://github.com/mroth/lolcommits/wiki/Enabling-Lolcommits-for-all-your-Git-Repositories)
+to achieve this using `git init` and the `init.templatedir` setting.
+
+Don't worry about it too much, half the fun of lolcommits is forgetting it's
+installed!
 
 ### Other commands
-Ok, if you insist... Since you know about `--enable`, common sense suggests there is also a repository specific `--disable`, hopefully you can guess what that does. Other handy common commands include `--last`, which will open for display your most recent lolcommit image, or `--browse`, which pops open the directory containing all the lolcommit images for your current repository. You can always do `--help` for a full list of available commands.
 
-**NOTE**: Any extra arguments you pass with the --enable command are auto-appended to the git-commit capture command.  For example;
+Ok, if you insist... Since you know about `--enable`, common sense suggests
+there is also a repository specific `--disable`, hopefully you can guess what
+that does. Other handy common commands include `--last`, which will open for
+display your most recent lolcommit image, or `--browse`, which pops open the
+directory containing all the lolcommit images for your current repository. You
+can always do `--help` for a full list of available commands.
+
+**NOTE**: Any extra arguments you pass with the --enable command are
+auto-appended to the git-commit capture command.  For example;
 
     lolcommits --enable --delay=5 --animate=4 --fork
 
-Will configure capturing of an animated gif (4 secs) after a 5 sec delay in a forked process. See the section below for more capture configuration variables.
+Will configure capturing of an animated gif (4 secs) after a 5 sec delay in a
+forked process. See the section below for more capture configuration variables.
 
 ### Capture configuration variables
-lolcommits has some capture options for additional lulz. You can enable these via environment variables like so;
+
+lolcommits has some capture options for additional lulz. You can enable these
+via environment variables like so;
 
 * `LOLCOMMITS_DEVICE` set a webcam device - **mac and linux only**
-* `LOLCOMMITS_ANIMATE` (in seconds) set time for capturing an animated gif - **mac only & requires ffmpeg**
-* `LOLCOMMITS_DELAY` (in seconds) set delay persistently (for slow webcams to warmup)
+* `LOLCOMMITS_ANIMATE` (in seconds) set time for capturing an animated gif -
+  **requires ffmpeg**
+* `LOLCOMMITS_DELAY` (in seconds) set delay persistently (for slow webcams to
+  warmup)
 * `LOLCOMMITS_FONT` set font file location for lolcommit text
-* `LOLCOMMITS_FORK` fork lolcommit runner (capture command forks to a new process, speedily returning you to your terminal)
+* `LOLCOMMITS_FORK` fork lolcommit runner (capture command forks to a new
+  process, speedily returning you to your terminal)
 * `LOLCOMMITS_STEALTH` disable notification messages at commit time
 
-Or they can be set via the following arguments in the capture command (located in your repository's `.git/hooks/post-commit` file).
+Or they can be set via the following arguments in the capture command (located
+in your repository's `.git/hooks/post-commit` file).
 
 * `--device=DEVICE` or `-d DEVICE`
 * `--animate=SECONDS` or `-a SECONDS`
@@ -75,26 +117,54 @@ Or they can be set via the following arguments in the capture command (located i
 * `--fork`
 * `--stealth`
 
-Use `lolcommits --devices` to list all attached video devices available for capturing. Read how to [configure commit capturing](https://github.com/mroth/lolcommits/wiki/Configure-Commit-Capturing) for more details.
+Use `lolcommits --devices` to list all attached video devices available for
+capturing. Read how to [configure commit
+capturing](https://github.com/mroth/lolcommits/wiki/Configure-Commit-Capturing)
+for more details.
 
 ### Animated Gif Capturing
-Animated gifs (Mac/OSX only) can take a while to generate (depending on the number of seconds you capture and the capabilities of your machine). `ffmpeg` is required and can be installed with brew like so;
 
-    brew install ffmpeg
+Animated gifs can take a while to generate (depending on the number of seconds
+you capture and the capabilities of your machine).
+[ffmpeg](https://www.ffmpeg.org) is required and can be installed like so;
+
+* Linux - [follow this guide](https://www.ffmpeg.org/download.html#build-linux)
+* OSX - `brew install ffmpeg`
 
-To enable, just set the `LOLCOMMITS_ANIMATE` environment variable with the number of seconds to capture.
-And like regular image captures you can use the env variables `LOLCOMMITS_DEVICE` and `LOLCOMMITS_DELAY` to change the capture device or delay time (seconds) before capturing.
-If you find capturing an animated gif takes too long, try setting the `LOLCOMMITS_FORK=true` env variable.
+To enable, just set the `LOLCOMMITS_ANIMATE` environment variable with the
+number of seconds to capture. Like regular image captures you can use the env
+variables `LOLCOMMITS_DEVICE` and `LOLCOMMITS_DELAY` to change the capture
+device or delay time (seconds) before capturing.
 
-![Example animated lolcommit gif](http://cdn2.usa.bugleblogs.com/blogs/000/000/003/de0eb9aa695.gif "Example animated lolcommit gif")
+If you find capturing an animated gif takes too long, try setting the
+`LOLCOMMITS_FORK=true` env variable. Animated gif captures are currently NOT
+supported on Windows.
+
+![Example animated lolcommit
+gif](http://cdn2.usa.bugleblogs.com/blogs/000/000/003/de0eb9aa695.gif "Example
+animated lolcommit gif")
 
 ### Plugins
-There are a growing amount of plugins for lolcommits to enable things like Twitter upload, translating your commit messages to lolspeak, etc.  Check them out on the [plugins page](https://github.com/mroth/lolcommits/wiki/Configuring-Plugins).
+
+There are a growing amount of plugins for lolcommits to enable things like
+Twitter upload, translating your commit messages to lolspeak, etc.  Check them
+out on the [plugins
+page](https://github.com/mroth/lolcommits/wiki/Configuring-Plugins).
 
 ## Troubles?
-Started a [FAQ](https://github.com/mroth/lolcommits/wiki/FAQ). Or take a read through the the [wiki](https://github.com/mroth/lolcommits/wiki)
+
+Try our trouble-shooting [FAQ](https://github.com/mroth/lolcommits/wiki/FAQ), or
+take a read through our [wiki](https://github.com/mroth/lolcommits/wiki) for
+more information. If you think something is broken or missing, raise a [GitHub
+issue](https://github.com/mroth/lolcommits/issues) (and please take a little
+time to check if we haven't [already
+addressed](https://github.com/mroth/lolcommits/issues?q=is%3Aissue+is%3Aclosed)
+it).
 
 ## Timelapse?
-To watch your face as it decays while you program, you can create a quick mpeg of all your lolcommits snapshots (if you have `imagemagick` and `ffmpeg` installed):
+
+To watch your face as it decays while you program, you can create a quick mpeg
+of all your lolcommits snapshots (if you have `imagemagick` and `ffmpeg`
+installed):
 
     convert `find . -type f -name "*.jpg" -print0 | xargs -0 ls -tlr | awk '{print $9}'` timelapse.mpeg

data/bin/lolcommits

@@ -170,10 +170,10 @@ def do_gif
 
   case Choice.choices[:gif]
     when 'today'
-      lolimages = configuration.images_today
+      lolimages = configuration.jpg_images_today
       filename  = "#{Date.today.to_s}.gif"
     else
-      lolimages = configuration.images
+      lolimages = configuration.jpg_images
       filename  = 'archive.gif'
   end
 

data/features/lolcommits.feature

@@ -12,8 +12,8 @@ Feature: Basic UI functionality
       |--animate|which is optional|
       |-a       |which is optional|
 
-  Scenario: Help should not show the animate option on a Linux plaftorm
-    Given I am using a "Linux" platform
+  Scenario: Help should not show the animate option on a Windows plaftorm
+    Given I am using a "Windows" platform
     When I get help for "lolcommits"
     Then the output should not match /\-a\, \-\-animate\=SECONDS/
 
@@ -45,7 +45,7 @@ Feature: Basic UI functionality
       And the "loltest" repository "post-commit" hook has content "#!/bin/ruby"
     When I cd to "loltest"
     And I run `lolcommits --enable`
-    Then the output should contain "doesn't start with with a good shebang"
+    Then the output should contain "doesn't start with a good shebang"
       And the file ".git/hooks/post-commit" should not contain "lolcommits --capture"
       And the exit status should be 1
 

data/lib/lolcommits.rb

@@ -6,23 +6,24 @@ require 'mini_magick'
 require 'fileutils'
 require 'git'
 require 'open3'
-require 'active_support/inflector'
-require 'active_support/concern'
-require 'active_support/callbacks'
 require 'methadone'
 require 'date'
 
 require 'lolcommits/version'
 require 'lolcommits/configuration'
+
 require 'lolcommits/capturer'
-require 'lolcommits/capture_mac'
-require 'lolcommits/capture_mac_animated'
-require 'lolcommits/capture_linux'
-require 'lolcommits/capture_windows'
-require 'lolcommits/capture_cygwin'
-require 'lolcommits/capture_fake'
+require 'lolcommits/capturer/capture_mac'
+require 'lolcommits/capturer/capture_mac_animated'
+require 'lolcommits/capturer/capture_linux'
+require 'lolcommits/capturer/capture_linux_animated'
+require 'lolcommits/capturer/capture_windows'
+require 'lolcommits/capturer/capture_cygwin'
+require 'lolcommits/capturer/capture_fake'
+
 require 'lolcommits/git_info'
 require 'lolcommits/installation'
+
 require 'lolcommits/plugin'
 require 'lolcommits/plugins/loltext'
 require 'lolcommits/plugins/dot_com'

data/lib/lolcommits/{capture_linux.rb → capturer/capture_linux.rb}

@@ -1,6 +1,8 @@
 # -*- encoding : utf-8 -*-
 module Lolcommits
   class CaptureLinux < Capturer
+    MPLAYER_FPS = 25
+
     def capture_device_string
       @capture_device.nil? ? nil : "-tv device=\"#{@capture_device}\""
     end
@@ -13,27 +15,31 @@ module Lolcommits
       delay = if capture_delay != 0 then capture_delay else 1 end
 
       # There's no way to give a capture delay in mplayer, but a number of frame
-      # mplayer's "delay" is actually a number of frames at 25fps
+      # mplayer's "delay" is actually a number of frames at 25 fps
       # multiply the set value (in seconds) by 25
-      frames = delay.to_i * 25
+      frames = delay.to_i * MPLAYER_FPS
 
       debug 'LinuxCapturer: calling out to mplayer to capture image'
       # mplayer's output is ugly and useless, let's throw it away
-      _, r, _ = Open3.popen3("#{executable_path} -vo jpeg:outdir=#{tmpdir} #{capture_device_string} -frames #{frames} tv://")
+      _, r, _ = Open3.popen3("mplayer -vo jpeg:outdir=#{tmpdir} #{capture_device_string} -frames #{frames} -fps #{MPLAYER_FPS} tv://")
       # looks like we still need to read the output for something to happen
       r.read
 
-      # the below SHOULD tell FileUtils actions to post their output if we are in debug mode
-      include FileUtils::Verbose if logger.level == 0
-
       debug 'LinuxCapturer: calling out to mplayer to capture image'
-      FileUtils.mv(tmpdir + '/%08d.jpg' % frames, snapshot_location)
-      debug 'LinuxCapturer: cleaning up'
-      FileUtils.rm_rf(tmpdir)
-    end
 
-    def executable_path
-      'mplayer'
+      # get last frame from tmpdir (regardless of fps)
+      all_frames = Dir.glob("#{tmpdir}/*.jpg").sort_by do |f|
+        File.mtime(f)
+      end
+
+      if all_frames.empty?
+        debug 'LinuxCapturer: failed to capture any image'
+      else
+        FileUtils.mv(all_frames.last, snapshot_location)
+        debug 'LinuxCapturer: cleaning up'
+      end
+
+      FileUtils.rm_rf(tmpdir)
     end
   end
 end

data/lib/lolcommits/capturer/capture_linux_animated.rb

@@ -0,0 +1,71 @@
+# -*- encoding : utf-8 -*-
+module Lolcommits
+  class CaptureLinuxAnimated < Capturer
+    def capture
+      # make a fresh frames directory
+      FileUtils.rm_rf(frames_location)
+      FileUtils.mkdir_p(frames_location)
+
+      # capture the raw video with ffmpeg video4linux2
+      system_call "ffmpeg -v quiet -y -f video4linux2 -video_size 320x240 -i #{capture_device_string} -t #{capture_duration} #{video_location} > /dev/null"
+      if File.exists?(video_location)
+        # convert raw video to png frames with ffmpeg
+        system_call "ffmpeg #{capture_delay_string} -v quiet -i #{video_location} -t #{animated_duration} #{frames_location}/%09d.png > /dev/null"
+
+        # use fps to set delay and number of frames to skip (for lower filesized gifs)
+        fps   = video_fps(video_location)
+        skip  = frame_skip(fps)
+        delay = frame_delay(fps, skip)
+        debug "Capturer: anaimated gif choosing every #{skip} frames with a frame delay of #{delay}"
+
+        # create the looping animated gif from frames (picks nth frame with seq)
+        seq_command = "seq -f #{frames_location}/%09g.png 1 #{skip} #{Dir["#{frames_location}/*"].length}"
+        # convert to animated gif with delay and gif optimisation
+        system_call "convert -layers OptimizeTransparency -delay #{delay} -loop 0 `#{seq_command}` -coalesce #{snapshot_location} > /dev/null"
+      end
+    end
+
+    private
+
+    def system_call(call_str, capture_output = false)
+      debug "Capturer: making system call for \n #{call_str}"
+      capture_output ? `#{call_str}` : system(call_str)
+    end
+
+    def frame_delay(fps, skip)
+      # calculate frame delay
+      delay = ((100.0 * skip) / fps.to_f).to_i
+      delay < 6 ? 6 : delay # hard limit for IE browsers
+    end
+
+    def video_fps(file)
+      # inspect fps of the captured video file (default to 29.97)
+      fps = system_call("ffmpeg -i #{file} 2>&1 | sed -n \"s/.*, \\(.*\\) fp.*/\\1/p\"", true)
+      fps.to_i < 1 ? 29.97 : fps.to_f
+    end
+
+    def frame_skip(fps)
+      # of frames to skip depends on movie fps
+      case (fps)
+      when 0..15
+        2
+      when 16..28
+        3
+      else
+        4
+      end
+    end
+
+    def capture_device_string
+      capture_device || '/dev/video0'
+    end
+
+    def capture_delay_string
+      " -ss #{capture_delay}" if capture_delay.to_i > 0
+    end
+
+    def capture_duration
+      animated_duration.to_i + capture_delay.to_i
+    end
+  end
+end

data/lib/lolcommits/{capture_mac.rb → capturer/capture_mac.rb}

@@ -6,6 +6,11 @@ module Lolcommits
     end
 
     def capture
+      # TODO: check we have a webcam we can capture from first. See issue #219
+      # operating laptop in clamshell (lid closed) from 2nd desktop screen,
+      # needs to better handle  the capturer (imagesnap, videosnap
+      # CommandCam, mplayer) return code or check with an option before
+      # attempting capture. Alt solution is puttin in prompt mode option :(
       call_str = "#{executable_path} -q \"#{snapshot_location}\" -w #{capture_delay} #{capture_device_string}"
       debug "Capturer: making system call for #{call_str}"
       system(call_str)

data/lib/lolcommits/configuration.rb

@@ -1,7 +1,7 @@
 # -*- encoding : utf-8 -*-
 module Lolcommits
   class Configuration
-    LOLBASEDIR = ENV['LOLCOMMITS_DIR'] || File.join(ENV['HOME'], '.lolcommits')
+    LOLCOMMITS_BASE = ENV['LOLCOMMITS_DIR'] || File.join(ENV['HOME'], '.lolcommits')
     LOLCOMMITS_ROOT = File.join(File.dirname(__FILE__), '../..')
     attr_writer :loldir
 
@@ -25,10 +25,8 @@ module Lolcommits
 
     def loldir
       return @loldir if @loldir
-
       basename ||= File.basename(Git.open('.').dir.to_s).sub(/^\./, 'dot')
       basename.sub!(/ /, '-')
-
       @loldir = Configuration.loldir_for(basename)
     end
 
@@ -41,15 +39,15 @@ module Lolcommits
     end
 
     def most_recent
-      Dir.glob(File.join self.loldir, '*.jpg').max_by { |f| File.mtime(f) }
+      Dir.glob(File.join self.loldir, '*.{jpg,gif}').max_by { |f| File.mtime(f) }
     end
 
-    def images
+    def jpg_images
       Dir.glob(File.join self.loldir, '*.jpg').sort_by { |f| File.mtime(f) }
     end
 
-    def images_today
-      images.select { |f| Date.parse(File.mtime(f).to_s) === Date.today }
+    def jpg_images_today
+      jpg_images.select { |f| Date.parse(File.mtime(f).to_s) === Date.today }
     end
 
     def raw_image(image_file_type = 'jpg')
@@ -152,9 +150,19 @@ module Lolcommits
     end
 
     def self.loldir_for(basename)
-      loldir = File.join(LOLBASEDIR, basename)
-
-      if not File.directory? loldir
+      loldir = File.join(LOLCOMMITS_BASE, basename)
+
+      if File.directory? loldir
+        begin
+          # ensure 755 permissions for loldir
+          File.chmod(0755, loldir)
+        rescue Errno::EPERM
+          # abort if permissions cannot be met
+          puts "FATAL: directory '#{loldir}' should be present and writeable by user '#{ENV['USER']}'"
+          puts 'Try changing the directory permissions to 755'
+          exit 1
+        end
+      else
         FileUtils.mkdir_p loldir
       end
       loldir
@@ -201,19 +209,22 @@ module Lolcommits
     end
 
     def self.can_animate?
-      platform == 'Mac'
+      ['Mac', 'Linux'].include? platform
     end
 
     # Cross-platform way of finding an executable in the $PATH.
-    # idea taken from http://bit.ly/qDaTbY
+    # idea taken from http://bit.ly/qDaTbY, if only_path is true, only the path
+    # is returned (not the path and command)
     #
     #   which('ruby') #=> /usr/bin/ruby
-    def self.command_which(cmd)
+    def self.command_which(cmd, only_path = false)
       exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
       ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
         exts.each do |ext|
           exe = "#{path}/#{cmd}#{ext}"
-          return exe if File.executable? exe
+          if File.executable? exe
+            return only_path ? path : exe
+          end
         end
       end
       nil

data/lib/lolcommits/installation.rb

@@ -21,19 +21,29 @@ module Lolcommits
         Dir.mkdir(HOOK_DIR)
       end
 
-      # clear away any existing lolcommits hook
+      # should add a shebang (or not) adding will rewrite hook file
+      add_shebang = false
       if hook_file_exists?
+        # clear away any existing lolcommits hook
         remove_existing_hook! if lolcommits_hook_exists?
 
-        # check for a good shebang line in the existing hook
-        unless good_shebang?
-          warn "the existing hook (at #{HOOK_PATH}) doesn't start with with a good shebang; like #!/bin/sh"
+        # if file is empty we should add a shebang (and rewrite hook)
+        if File.read(HOOK_PATH).strip.empty?
+          add_shebang = true
+        elsif !good_shebang?
+          # look for good shebang in existing hook, abort if none found
+          warn "the existing hook (at #{HOOK_PATH}) doesn't start with a good shebang; like #!/bin/sh"
           exit 1
         end
+      else
+        add_shebang = true
       end
 
-      File.open(HOOK_PATH, hook_file_exists? ? 'a' : 'w') do |f|
-        f.write(hook_script(!hook_file_exists?))
+      File.open(HOOK_PATH, add_shebang ? 'w' : 'a') do |f|
+        if add_shebang
+          f.write("#!/bin/sh\n")
+        end
+        f.write(hook_script)
       end
 
       FileUtils.chmod 0755, HOOK_PATH
@@ -65,17 +75,17 @@ module Lolcommits
     protected
 
     def self.hook_script(add_shebang = true)
-      shebang      = add_shebang ? "#!/bin/sh\n\n" : ''
-      ruby_path    = Lolcommits::Configuration.command_which('ruby')
-      hook_export  = "export PATH=\"#{ruby_path}:$PATH\"\n" if ruby_path
+      ruby_path    = Lolcommits::Configuration.command_which('ruby', true)
+      imagick_path = Lolcommits::Configuration.command_which('identify', true)
+      hook_export  = "export PATH=\"#{ruby_path}:#{imagick_path}:$PATH\"\n"
       capture_cmd  = 'lolcommits --capture'
       capture_args = " #{ARGV[1..-1].join(' ')}" if ARGV.length > 1
 
       <<-EOS
-    #{shebang}### lolcommits hook (begin) ###
-    #{hook_export}#{capture_cmd}#{capture_args}
-    ###  lolcommits hook (end)  ###
-    EOS
+### lolcommits hook (begin) ###
+#{hook_export}#{capture_cmd}#{capture_args}
+###  lolcommits hook (end)  ###
+EOS
     end
 
     # does a git hook exist at all?

data/lib/lolcommits/plugin.rb

@@ -11,16 +11,29 @@ module Lolcommits
       self.options = ['enabled']
     end
 
-    def execute
+    def execute_precapture
       if enabled?
-        debug 'I am enabled, about to run'
-        run
+        debug 'I am enabled, about to run precapture'
+        run_precapture
       else
-        debug 'Disabled, doing nothing for execution'
+        debug 'Disabled, doing nothing for precapture execution'
       end
     end
 
-    def run
+    def execute_postcapture
+      if enabled?
+        debug 'I am enabled, about to run postcapture'
+        run_postcapture
+      else
+        debug 'Disabled, doing nothing for postcapture execution'
+      end
+    end
+
+    def run_precapture
+      debug 'base plugin, does nothing to anything'
+    end
+
+    def run_postcapture
       debug 'base plugin, does nothing to anything'
     end
 
@@ -35,13 +48,24 @@ module Lolcommits
       puts "Configuring plugin: #{self.class.name}\n"
       options.reduce(Hash.new) do |acc, option|
         print "#{option}: "
-        val = STDIN.gets.strip.downcase
-        if %w(true yes).include?(val)
-          val = true
-        elsif %(false no).include?(val)
-          val = false
+        val = parse_user_input(STDIN.gets.strip)
+        # check enabled option isn't a String
+        if (option == 'enabled') && val.is_a?(String)
+          puts "Aborting - please enable with 'true' or 'false'"
+          exit 1
+        else
+          acc.merge(option => val)
         end
-        acc.merge(option => val)
+      end
+    end
+
+    def parse_user_input(str)
+      if 'true'.casecmp(str) == 0
+        true
+      elsif 'false'.casecmp(str) == 0
+        false
+      else
+        str
       end
     end
 
@@ -71,6 +95,12 @@ module Lolcommits
       super(args)
     end
 
+    # helper to log errors with a message via debug
+    def log_error(e, message)
+      debug message
+      debug e.backtrace.join("\n")
+    end
+
     # uniform debug logging for plugins
     def debug(msg)
       super("Plugin: #{self.class.to_s}: " + msg)
@@ -80,5 +110,11 @@ module Lolcommits
     def self.name
       'plugin'
     end
+
+    # a plugin requests to be run by the runner in one of the possible positions.
+    # valid options are [:precapture, :postcapture]
+    def self.runner_order
+      nil
+    end
   end
 end

data/lib/lolcommits/plugins/dot_com.rb

@@ -3,16 +3,18 @@ require 'httmultiparty'
 
 module Lolcommits
   class DotCom < Plugin
+    BASE_URL = 'http://lolcommits-dot-com.herokuapp.com'
+
     def initialize(runner)
       super
       self.options.concat(['api_key', 'api_secret', 'repo_id'])
     end
 
-    def run
+    def run_postcapture
       return unless valid_configuration?
 
       t = Time.now.to_i.to_s
-      resp = HTTMultiParty.post('http://www.lolcommits.com/git_commits.json',
+      resp = HTTMultiParty.post("#{BASE_URL}/git_commits.json",
                                 :body => {
                                   :git_commit => {
                                     :sha              => self.runner.sha,
@@ -26,6 +28,8 @@ module Lolcommits
                                   :token =>  Digest::SHA1.hexdigest(configuration['api_secret'] + t)
                                 }
       )
+    rescue => e
+      log_error(e, "ERROR: HTTMultiParty POST FAILED #{e.class} - #{e.message}")
     end
 
     def configured?
@@ -38,5 +42,9 @@ module Lolcommits
     def self.name
       'dot_com'
     end
+
+    def self.runner_order
+      :postcapture
+    end
   end
 end

data/lib/lolcommits/plugins/lol_twitter.rb

@@ -14,7 +14,7 @@ module Lolcommits
     TWITTER_RETRIES         = 2
     TWITTER_PIN_REGEX       = /^\d{4,}$/ # 4 or more digits
 
-    def run
+    def run_postcapture
       return unless valid_configuration?
 
       attempts = 0
@@ -47,7 +47,7 @@ module Lolcommits
     def configure_options!
       options = super
       # ask user to configure tokens if enabling
-      if options['enabled'] == true
+      if enabled?
         auth_config = configure_auth!
         if auth_config
           options.merge!(auth_config)
@@ -121,5 +121,9 @@ module Lolcommits
     def self.name
       'twitter'
     end
+
+    def self.runner_order
+      :postcapture
+    end
   end
 end

data/lib/lolcommits/plugins/lol_yammer.rb

@@ -14,6 +14,10 @@ module Lolcommits
       'yammer'
     end
 
+    def self.runner_order
+      :postcapture
+    end
+
     def configured?
       !configuration['access_token'].nil?
     end
@@ -40,7 +44,7 @@ module Lolcommits
 
     def configure_options!
       options = super
-      if options['enabled'] == true
+      if enabled?
         auth_config = configure_access_token
         if auth_config
           options.merge!(auth_config)
@@ -51,7 +55,7 @@ module Lolcommits
       options
     end
 
-    def run
+    def run_postcapture
       return unless valid_configuration?
 
       commit_msg = self.runner.message

data/lib/lolcommits/plugins/lolsrv.rb

@@ -10,7 +10,7 @@ module Lolcommits
       self.options << 'server'
     end
 
-    def run
+    def run_postcapture
       return unless valid_configuration?
       fork { sync }
     end
@@ -32,38 +32,31 @@ module Lolcommits
     end
 
     def existing_lols
-      begin
-        lols = JSON.parse(
-        RestClient.get(configuration['server'] + '/lols'))
-        lols.map { |lol| lol['sha'] }
-      rescue => e
-        log_error(e, "ERROR: existing lols could not be retrieved #{e.class} - #{e.message}")
-        return nil
-      end
+      lols = JSON.parse(
+      RestClient.get(configuration['server'] + '/lols'))
+      lols.map { |lol| lol['sha'] }
+    rescue => e
+      log_error(e, "ERROR: existing lols could not be retrieved #{e.class} - #{e.message}")
+      return nil
     end
 
     def upload(file, sha)
-      begin
-        RestClient.post(
-          configuration['server'] + '/uplol',
-          :lol => File.new(file),
-          :url => self.runner.url + sha,
-          :repo => self.runner.repo,
-          :date => File.ctime(file),
-          :sha => sha)
-      rescue => e
-        log_error(e, "ERROR: Upload of lol #{sha} FAILED #{e.class} - #{e.message}")
-        return
-      end
-    end
-
-    def log_error(e, message)
-      debug message
-      debug e.backtrace
+      RestClient.post(configuration['server'] + '/uplol',
+                      :lol => File.new(file),
+                      :url => self.runner.url + sha,
+                      :repo => self.runner.repo,
+                      :date => File.ctime(file),
+                      :sha => sha)
+    rescue => e
+      log_error(e, "ERROR: Upload of lol #{sha} FAILED #{e.class} - #{e.message}")
     end
 
     def self.name
       'lolsrv'
     end
+
+    def self.runner_order
+      :postcapture
+    end
   end
 end

data/lib/lolcommits/plugins/loltext.rb

@@ -11,7 +11,7 @@ module Lolcommits
       !configured? || super
     end
 
-    def run
+    def run_postcapture
       font_location = @font_location || File.join(Configuration::LOLCOMMITS_ROOT,
                                                   'vendor',
                                                   'fonts',
@@ -54,6 +54,7 @@ module Lolcommits
     def clean_msg(text)
       wrapped_text = word_wrap text
       escape_quotes wrapped_text
+      escape_ats wrapped_text
     end
 
     # conversion for quotation marks to avoid shell interpretation
@@ -62,6 +63,10 @@ module Lolcommits
       text.gsub(/"/, "''")
     end
 
+    def escape_ats(text)
+      text.gsub(/@/, '\@')
+    end
+
     # convenience method for word wrapping
     # based on https://github.com/cmdrkeene/memegen/blob/master/lib/meme_generator.rb
     def word_wrap(text, col = 27)

data/lib/lolcommits/plugins/tranzlate.rb

@@ -99,7 +99,7 @@ module Lolcommits
   class Tranzlate < Plugin
     extend Lolspeak
 
-    def run
+    def run_precapture
       debug "Commit message before: #{self.runner.message}"
       self.runner.message = self.class.tranzlate(self.runner.message)
       debug "Commit message after: #{self.runner.message}"
@@ -108,5 +108,9 @@ module Lolcommits
     def self.name
       'tranzlate'
     end
+
+    def self.runner_order
+      :precapture
+    end
   end
 end

data/lib/lolcommits/plugins/uploldz.rb

@@ -10,7 +10,7 @@ module Lolcommits
       self.options.concat(['endpoint', 'optional_key'])
     end
 
-    def run
+    def run_postcapture
       return unless valid_configuration?
 
       repo = self.runner.repo.to_s
@@ -23,6 +23,8 @@ module Lolcommits
                         :repo => repo,
                         :key => configuration['optional_key'])
       end
+    rescue => e
+      log_error(e, "ERROR: RestClient POST FAILED #{e.class} - #{e.message}")
     end
 
     def configured?
@@ -32,5 +34,9 @@ module Lolcommits
     def self.name
       'uploldz'
     end
+
+    def self.runner_order
+      :postcapture
+    end
   end
 end

data/lib/lolcommits/runner.rb

@@ -8,19 +8,6 @@ module Lolcommits
                   :font, :capture_animate, :url
 
     include Methadone::CLILogging
-    include ActiveSupport::Callbacks
-    define_callbacks :run
-    set_callback :run, :before, :execute_lolcommits_tranzlate
-
-    # Executed Last
-    set_callback :run, :after,  :cleanup!
-    set_callback :run, :after,  :execute_lolcommits_uploldz
-    set_callback :run, :after,  :execute_lolcommits_lolsrv
-    set_callback :run, :after,  :execute_lolcommits_lol_twitter
-    set_callback :run, :after,  :execute_lolcommits_dot_com
-    set_callback :run, :after,  :execute_lolcommits_lol_yammer
-    set_callback :run, :after,  :execute_lolcommits_loltext
-    # Executed First
 
     def initialize(attributes = {})
       attributes.each do |attr, val|
@@ -37,25 +24,61 @@ module Lolcommits
       end
     end
 
+    # wrap run to handle things that should happen before and after
+    # this used to be handled with ActiveSupport::Callbacks, but
+    # now we're just using a simple procedural list
     def run
-      die_if_rebasing!
+      # do things that need to happen before capture and plugins
 
-      run_callbacks :run do
-        puts '*** Preserving this moment in history.' unless capture_stealth
-        self.snapshot_loc = self.config.raw_image(image_file_type)
-        self.main_image   = self.config.main_image(self.sha, image_file_type)
-        capturer = capturer_class.new(
-          :capture_device    => self.capture_device,
-          :capture_delay     => self.capture_delay,
-          :snapshot_location => self.snapshot_loc,
-          :font              => self.font,
-          :video_location    => self.config.video_loc,
-          :frames_location   => self.config.frames_loc,
-          :animated_duration => self.capture_animate
-        )
-        capturer.capture
-        resize_snapshot!
+      # do native plugins that need to happen before capture
+      plugins_for(:precapture).each do |plugin|
+        debug "precapture: about to execute #{plugin}"
+        plugin.new(self).execute_precapture
       end
+
+      # do gem plugins that need to happen before capture?
+
+      # **** do the main capture ****
+      run_capture_and_resize
+
+      # do native plugins that need to happen immediately after capture
+      # this is effectively the "image processing" phase
+      # for now, reserve just for us and handle manually...?
+      Lolcommits::Loltext.new(self).execute_postcapture
+
+      # do native plugins that need to happen after capture
+      plugins_for(:postcapture).each do |plugin|
+        plugin.new(self).execute_postcapture
+      end
+
+      # do gem plugins that need to happen after capture?
+
+      # do things that should happen last
+      cleanup!
+    end
+
+    def plugins_for(position)
+      Lolcommits::PLUGINS.select { |p| p.runner_order == position }
+    end
+
+    # the main capture and resize operation, critical
+    def run_capture_and_resize
+      die_if_rebasing!
+
+      puts '*** Preserving this moment in history.' unless capture_stealth
+      self.snapshot_loc = self.config.raw_image(image_file_type)
+      self.main_image   = self.config.main_image(self.sha, image_file_type)
+      capturer = capturer_class.new(
+        :capture_device    => self.capture_device,
+        :capture_delay     => self.capture_delay,
+        :snapshot_location => self.snapshot_loc,
+        :font              => self.font,
+        :video_location    => self.config.video_loc,
+        :frames_location   => self.config.frames_loc,
+        :animated_duration => self.capture_animate
+      )
+      capturer.capture
+      resize_snapshot!
     end
 
     def animate?
@@ -65,7 +88,9 @@ module Lolcommits
     private
 
     def capturer_class
-      "Lolcommits::Capture#{Configuration.platform}#{animate? ? 'Animated' : nil}".constantize
+      capturer_module = 'Lolcommits'
+      capturer_class  = "Capture#{Configuration.platform}#{animate? ? 'Animated' : nil}"
+      Object.const_get(capturer_module).const_get(capturer_class)
     end
 
     def image_file_type
@@ -110,13 +135,4 @@ module Lolcommits
     FileUtils.rm_f(self.config.video_loc)
     FileUtils.rm_rf(self.config.frames_loc)
   end
-
-  # register a method called "execute_lolcommits_#{plugin_name}"
-  # for each subclass of plugin.  these methods should be used as
-  # callbacks to the run method.
-  Lolcommits::PLUGINS.each do |plugin|
-    define_method "execute_#{plugin.to_s.underscore.gsub('/', '_')}" do
-      plugin.new(self).execute
-    end
-  end
 end

data/lib/lolcommits/version.rb

@@ -1,4 +1,4 @@
 # -*- encoding : utf-8 -*-
 module Lolcommits
-  VERSION = '0.5.4'
+  VERSION = '0.5.5'
 end

data/lolcommits.gemspec

@@ -25,7 +25,6 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency('launchy', '~> 2.2.0')
   s.add_runtime_dependency('methadone', '~> 1.2.4')
   s.add_runtime_dependency('open4', '~> 1.3.0')
-  s.add_runtime_dependency('activesupport', '~> 3.2.12')
 
   # development dependencies
   s.add_development_dependency('rdoc')

data/rubocop-todo.yml

@@ -63,10 +63,10 @@ UselessAssignment:
 Documentation:
   Enabled: false
 
-# Offence count: 1
+# Offence count: 3
 # Configuration parameters: CountComments.
 ClassLength:
-  Max: 169
+  Max: 179
 
 # Offence count: 73
 LineLength:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lolcommits
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.5.5
 platform: ruby
 authors:
 - Matthew Rothenberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-13 00:00:00.000000000 Z
+date: 2014-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mini_magick
@@ -94,20 +94,6 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.3.0
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 3.2.12
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 3.2.12
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -365,7 +351,6 @@ files:
 - CONTRIBUTING
 - Gemfile
 - LICENSE
-- NOTES
 - README.md
 - Rakefile
 - bin/lolcommits
@@ -378,13 +363,14 @@ files:
 - features/support/path_helpers.rb
 - lib/core_ext/class.rb
 - lib/lolcommits.rb
-- lib/lolcommits/capture_cygwin.rb
-- lib/lolcommits/capture_fake.rb
-- lib/lolcommits/capture_linux.rb
-- lib/lolcommits/capture_mac.rb
-- lib/lolcommits/capture_mac_animated.rb
-- lib/lolcommits/capture_windows.rb
 - lib/lolcommits/capturer.rb
+- lib/lolcommits/capturer/capture_cygwin.rb
+- lib/lolcommits/capturer/capture_fake.rb
+- lib/lolcommits/capturer/capture_linux.rb
+- lib/lolcommits/capturer/capture_linux_animated.rb
+- lib/lolcommits/capturer/capture_mac.rb
+- lib/lolcommits/capturer/capture_mac_animated.rb
+- lib/lolcommits/capturer/capture_windows.rb
 - lib/lolcommits/configuration.rb
 - lib/lolcommits/git_info.rb
 - lib/lolcommits/installation.rb
@@ -429,7 +415,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: lolcommits
-rubygems_version: 2.2.2
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: Capture webcam image on git commit for lulz.

data/NOTES

@@ -1,17 +0,0 @@
-
-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
-