snapgit 0.6.4

data/features/support/env.rb

@@ -0,0 +1,61 @@
+# -*- encoding : utf-8 -*-
+require 'aruba/cucumber'
+require 'methadone/cucumber'
+require 'open3'
+require 'ffaker'
+require 'fileutils'
+
+require File.join(File.expand_path(File.dirname(__FILE__)), 'path_helpers')
+include Lolcommits
+
+World(PathHelpers)
+
+Before do
+  # Using "announce" causes massive warnings on 1.9.2
+  @puts = true
+  @aruba_timeout_seconds = 20
+
+  # prevent launchy from opening gifs in tests
+  set_env 'LAUNCHY_DRY_RUN', 'true'
+  set_env 'LOLCOMMITS_CAPTURER', 'CaptureFake'
+
+  author_name  = 'Testy McTesterson'
+  author_email = 'testy@tester.com'
+
+  set_env 'GIT_AUTHOR_NAME',     author_name
+  set_env 'GIT_COMMITTER_NAME',  author_name
+  set_env 'GIT_AUTHOR_EMAIL',    author_email
+  set_env 'GIT_COMMITTER_EMAIL', author_email
+end
+
+# for tasks that may take an insanely long time (e.g. network related)
+# we should strive to not have any of these in our scenarios, naturally.
+Before('@slow_process') do
+  @aruba_io_wait_seconds = 5
+  @aruba_timeout_seconds = 60
+end
+
+# in order to fake an interactive rebase, we replace the editor with a script
+# to simply squash a few random commits. in this case, using lines 3-5.
+Before('@fake-interactive-rebase') do
+  set_env 'GIT_EDITOR', "sed -i -e '3,5 s/pick/squash/g'"
+end
+
+# adjust the path so tests dont see a global imagemagick install
+Before('@fake-no-imagemagick') do
+  reject_paths_with_cmd('mogrify')
+end
+
+# adjust the path so tests dont see a global ffmpeg install
+Before('@fake-no-ffmpeg') do
+  reject_paths_with_cmd('ffmpeg')
+end
+
+# do test in temporary directory so our own git repo-ness doesn't affect it
+Before('@in-tempdir') do
+  @dirs = [Dir.mktmpdir]
+end
+
+After('@in-tempdir') do
+  FileUtils.rm_rf(@dirs.first)
+end

data/features/support/path_helpers.rb

@@ -0,0 +1,39 @@
+# -*- encoding : utf-8 -*-
+require 'fileutils'
+require 'aruba/api'
+require 'lolcommits/platform'
+
+module PathHelpers
+  def reject_paths_with_cmd(cmd)
+    # make a new subdir that still contains cmds
+    tmpbindir = File.expand_path(File.join(@dirs, 'bin'))
+    FileUtils.mkdir_p tmpbindir
+
+    preseve_cmds_in_path(%w(git mplayer), tmpbindir)
+
+    exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+    newpaths = ENV['PATH'].split(File::PATH_SEPARATOR).reject do |path|
+      found_cmd = false
+      exts.each do |ext|
+        exe = "#{path}/#{cmd}#{ext}"
+        found_cmd = true if File.executable? exe
+      end
+      found_cmd
+    end
+
+    # add the temporary directory with git in it back into the path
+    newpaths << tmpbindir
+
+    # use aruba/api set_env to set PATH, which will be automaticaly restored
+    set_env 'PATH', newpaths.join(File::PATH_SEPARATOR)
+  end
+
+  def preseve_cmds_in_path(cmds, tmpbindir)
+    cmds.each do |cmd|
+      whichcmd = Lolcommits::Platform.command_which(cmd)
+      unless whichcmd.nil?
+        FileUtils.ln_s whichcmd, File.join(tmpbindir, File.basename(whichcmd))
+      end
+    end
+  end
+end

data/lib/core_ext/class.rb

@@ -0,0 +1,8 @@
+# -*- encoding : utf-8 -*-
+class Class
+  def subclasses
+    result = []
+    ObjectSpace.each_object(Class) { |klass| result << klass if klass < self }
+    result
+  end
+end

data/lib/core_ext/mini_magick/utilities.rb

@@ -0,0 +1,15 @@
+# -*- encoding : utf-8 -*-
+# To maintain MiniMagick compatibility on Windows for v3.8.1 we need this patch
+# If/when we upgrade MiniMagick to 4.2+ this patch can be removed
+# We are locked at v3.8.1 since MiniMagick 4+ dropped support for Ruby 1.8.7
+module MiniMagick
+  module Utilities
+    class << self
+      # fixes issue introduced in this commit
+      # https://github.com/minimagick/minimagick/commit/65b6427395cbfe6
+      def windows_escape(cmdline)
+        '"' + cmdline.gsub(/\\(?=\\*\")/, '\\\\\\').gsub(/\"/, '\\"').gsub(/\\$/, '\\\\\\').gsub('%', '%%') + '"'
+      end
+    end
+  end
+end

data/lib/lolcommits.rb

@@ -0,0 +1,34 @@
+# -*- encoding : utf-8 -*-
+$LOAD_PATH.unshift File.expand_path('.')
+
+require 'core_ext/class'
+require 'mini_magick'
+require 'core_ext/mini_magick/utilities'
+require 'fileutils'
+require 'git'
+require 'open3'
+require 'methadone'
+require 'date'
+
+require 'lolcommits/version'
+require 'lolcommits/configuration'
+require 'lolcommits/capturer'
+require 'lolcommits/git_info'
+require 'lolcommits/installation'
+require 'lolcommits/plugin'
+require 'lolcommits/platform'
+
+require 'lolcommits/plugins/loltext'
+require 'lolcommits/plugins/dot_com'
+require 'lolcommits/plugins/tranzlate'
+require 'lolcommits/plugins/lol_twitter'
+require 'lolcommits/plugins/uploldz'
+require 'lolcommits/plugins/lolsrv'
+require 'lolcommits/plugins/lol_yammer'
+require 'lolcommits/plugins/lol_protonet'
+require 'lolcommits/plugins/lol_tumblr'
+require 'lolcommits/plugins/lol_slack'
+require 'lolcommits/plugins/snapgit'
+
+# require runner after all the plugins have been required
+require 'lolcommits/runner'

data/lib/lolcommits/capturer.rb

@@ -0,0 +1,24 @@
+# -*- encoding : utf-8 -*-
+module Lolcommits
+  class Capturer
+    include Methadone::CLILogging
+
+    attr_accessor :capture_device, :capture_delay, :snapshot_location,
+                  :video_location, :frames_location, :animated_duration
+
+    def initialize(attributes = {})
+      attributes.each do |attr, val|
+        send("#{attr}=", val)
+      end
+      debug 'Capturer: initializing new instance ' + to_s
+    end
+  end
+end
+
+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'

data/lib/lolcommits/capturer/capture_cygwin.rb

@@ -0,0 +1,22 @@
+# -*- encoding : utf-8 -*-
+module Lolcommits
+  class CaptureCygwin < Capturer
+    def capture
+      # DirectShow takes a while to show... at least for me anyway
+      delaycmd = ' /delay 3000'
+      if capture_delay > 0
+        # CommandCam delay is in milliseconds
+        delaycmd = " /delay #{capture_delay * 1000}"
+      end
+
+      _stdin, stdout, _stderr = Open3.popen3("#{executable_path} /filename `cygpath -w #{snapshot_location}`#{delaycmd}")
+
+      # looks like we still need to read the output for something to happen
+      stdout.read
+    end
+
+    def executable_path
+      File.join(Configuration::LOLCOMMITS_ROOT, 'vendor', 'ext', 'CommandCam', 'CommandCam.exe')
+    end
+  end
+end

data/lib/lolcommits/capturer/capture_fake.rb

@@ -0,0 +1,9 @@
+# -*- encoding : utf-8 -*-
+module Lolcommits
+  class CaptureFake < Capturer
+    def capture
+      test_image = File.join Configuration::LOLCOMMITS_ROOT, 'test', 'images', 'test_image.jpg'
+      FileUtils.cp test_image, snapshot_location
+    end
+  end
+end

data/lib/lolcommits/capturer/capture_linux.rb

@@ -0,0 +1,45 @@
+# -*- encoding : utf-8 -*-
+module Lolcommits
+  class CaptureLinux < Capturer
+    MPLAYER_FPS = 25
+
+    def capture_device_string
+      @capture_device.nil? ? nil : "-tv device=\"#{@capture_device}\""
+    end
+
+    def capture
+      debug 'LinuxCapturer: making tmp directory'
+      tmpdir = Dir.mktmpdir
+
+      # Default delay is 1s
+      delay = capture_delay != 0 ? capture_delay : 1
+
+      # 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 25 fps
+      # multiply the set value (in seconds) by 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
+      _stdin, stdout, _stderr = 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
+      stdout.read
+
+      debug 'LinuxCapturer: calling out to mplayer to capture image'
+
+      # 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,72 @@
+# -*- 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"
+      return unless File.exist?(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,
+      # quotes output and concats to a single line with tr)
+      seq_command = "seq -f \"\\\"#{frames_location}/%09g.png\\\"\" 1 #{skip} #{Dir["#{frames_location}/*"].length} | tr '\\n' ' '"
+      seq_frame_files = system_call(seq_command, true)
+      # convert to animated gif with delay and gif optimisation
+      system_call "convert -layers OptimizeTransparency -delay #{delay} -loop 0 #{seq_frame_files} -coalesce \"#{snapshot_location}\""
+    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/capturer/capture_mac.rb

@@ -0,0 +1,23 @@
+# -*- encoding : utf-8 -*-
+module Lolcommits
+  class CaptureMac < Capturer
+    def capture_device_string
+      @capture_device.nil? ? nil : "-d \"#{@capture_device}\""
+    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)
+    end
+
+    def executable_path
+      File.join(Configuration::LOLCOMMITS_ROOT, 'vendor', 'ext', 'imagesnap', 'imagesnap')
+    end
+  end
+end

data/lib/lolcommits/capturer/capture_mac_animated.rb

@@ -0,0 +1,73 @@
+# -*- encoding : utf-8 -*-
+module Lolcommits
+  class CaptureMacAnimated < Capturer
+    def capture
+      # make a fresh frames directory
+      FileUtils.rm_rf(frames_location)
+      FileUtils.mkdir_p(frames_location)
+
+      # capture the raw video with videosnap
+      system_call "#{executable_path} -s 240 #{capture_device_string}#{capture_delay_string}-t #{animated_duration} --no-audio \"#{video_location}\" > /dev/null"
+      return unless File.exist?(video_location)
+      # get fps for ffmpeg output stream configuration
+      fps = video_fps(video_location)
+      # convert raw video to png frames with ffmpeg
+      system_call "ffmpeg -v quiet -i \"#{video_location}\" -t #{animated_duration} -r #{fps} \"#{frames_location}/%09d.png\""
+
+      # use fps to set delay and number of frames to skip (for lower filesized gifs)
+      skip  = frame_skip(fps)
+      delay = frame_delay(fps, skip)
+      debug "Capturer: animated gif choosing every #{skip} frames with a frame delay of #{delay}"
+
+      # create the looping animated gif from frames (picks nth frame with seq,
+      # quotes output and concats to a single line with tr)
+      seq_command = "seq -f \"\\\"#{frames_location}/%09g.png\\\"\" 1 #{skip} #{Dir["#{frames_location}/*"].length} | tr '\\n' ' '"
+      seq_frame_files = system_call(seq_command, true)
+      # convert to animated gif with delay and gif optimisation
+      system_call "convert -layers OptimizeTransparency -delay #{delay} -loop 0 #{seq_frame_files} -coalesce \"#{snapshot_location}\" > /dev/null"
+    end
+
+    def executable_path
+      File.join(Configuration::LOLCOMMITS_ROOT, 'vendor', 'ext', 'videosnap', 'videosnap')
+    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
+      "-d \"#{capture_device}\" " if capture_device
+    end
+
+    def capture_delay_string
+      "-w \"#{capture_delay}\" " if capture_delay.to_i > 0
+    end
+  end
+end

data/lib/lolcommits/capturer/capture_windows.rb

@@ -0,0 +1,22 @@
+# -*- encoding : utf-8 -*-
+module Lolcommits
+  class CaptureWindows < Capturer
+    def capture
+      # DirectShow takes a while to show... at least for me anyway
+      delaycmd = ' /delay 3000'
+      if capture_delay > 0
+        # CommandCam delay is in milliseconds
+        delaycmd = " /delay #{capture_delay * 1000}"
+      end
+
+      _stdin, stdout, _stderr = Open3.popen3("#{executable_path} /filename #{snapshot_location}#{delaycmd}")
+
+      # looks like we still need to read the output for something to happen
+      stdout.read
+    end
+
+    def executable_path
+      File.join(Configuration::LOLCOMMITS_ROOT, 'vendor', 'ext', 'CommandCam', 'CommandCam.exe')
+    end
+  end
+end