lolcommits 0.13.1 → 0.14.0

data/config/cucumber.yml

@@ -1,2 +1,2 @@
 ---
-default: <%= (RbConfig::CONFIG['host_os'] =~ /darwin/) ? 'features' : '--tags ~@mac-only' %>
+default: <%= ENV['TRAVIS'] == 'true' ? '--tags ~@requires_ffmpeg' : 'features' %>

data/features/bugs.feature

@@ -21,9 +21,9 @@ Feature: Bug regression testing
   @fake-interactive-rebase @slow_process
   Scenario: Don't trigger capture during a git rebase
     Given I am in a git repo named "yuh8history" with lolcommits enabled
-      And I do 3 git commits
+      And I do 2 git commits
     When I run `git rebase -i HEAD~2`
-    Then there should be exactly 3 jpgs in "~/.lolcommits/yuh8history"
+    Then there should be exactly 2 jpgs in "~/.lolcommits/yuh8history"
 
   #
   # issue #87, https://github.com/lolcommits/lolcommits/issues/87

data/features/lolcommits.feature

@@ -8,6 +8,11 @@ Feature: Basic UI functionality
     Then the exit status should be 0
     And the banner should be present
 
+  Scenario: Shows version information
+    When I run `lolcommits --version`
+    Then the output should show the version number
+    And the exit status should be 0
+
   Scenario: Help should show the animate option on a Mac platform
     Given I am using a "darwin" platform
     When I get help for "lolcommits"
@@ -75,7 +80,7 @@ Feature: Basic UI functionality
   #   Then there should be exactly 1 pid in "~/.lolcommits/forked"
   #   When I wait for the child process to exit in "forked"
   #   Then a directory named "~/.lolcommits/forked" should exist
-  #     And a file named "~/.lolcommits/forked/tmp_snapshot.jpg" should not exist
+  #     And a file named "~/.lolcommits/forked/raw_capture.jpg" should not exist
   #     And there should be exactly 1 jpg in "~/.lolcommits/forked"
 
   Scenario: Commiting in an enabled git repo triggers successful capture
@@ -83,7 +88,7 @@ Feature: Basic UI functionality
     When I do a git commit
     Then the output should contain "*** Preserving this moment in history."
       And a directory named "~/.lolcommits/myrepo" should exist
-      And a file named "~/.lolcommits/myrepo/tmp_snapshot.jpg" should not exist
+      And a file named "~/.lolcommits/myrepo/raw_capture.jpg" should not exist
       And there should be exactly 1 jpg in "~/.lolcommits/myrepo"
 
   Scenario: Commiting in enabled git repo subdirectory triggers successful capture
@@ -124,8 +129,8 @@ Feature: Basic UI functionality
     When I run `lolcommits --test --show-config`
     Then the output should match /loltext:\s+:enabled: false/
 
-  Scenario: test capture should work regardless of whether in a lolrepo
-    Given I am in a directory named "nothingtoseehere"
+  Scenario: test capture should work regardless of whether in a vcs repo
+    Given I am in a directory named "not_a_vcs_repo"
     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)"
@@ -216,30 +221,50 @@ Feature: Basic UI functionality
     Then the exit status should be 0
     And there should be exactly 1 jpg in its loldir
 
-  Scenario: generate gif should store in its own archive directory
+  Scenario: generate gif should store in the timelapses directory
     Given I am in a git repo named "giffy" with lolcommits enabled
       And a loldir named "giffy" with 2 lolimages
     When I run `lolcommits --timelapse`
-    Then the output should contain "Generating animated gif."
-      And a directory named "~/.lolcommits/giffy/archive" should exist
-      And a file named "~/.lolcommits/giffy/archive/archive.gif" should exist
+    Then the output should contain "Generating animated timelapse gif."
+      And a directory named "~/.lolcommits/giffy/timelapses" should exist
+      And there should be exactly 1 gif in "~/.lolcommits/giffy/timelapses"
 
   Scenario: generate gif with argument 'today'
     Given I am in a git repo named "sunday" with lolcommits enabled
       And a loldir named "sunday" with 2 lolimages
     When I run `lolcommits --timelapse --period today`
-    Then there should be exactly 1 gif in "~/.lolcommits/sunday/archive"
+    Then there should be exactly 1 gif in "~/.lolcommits/sunday/timelapses"
 
-  @mac-only
-  Scenario: should generate an animated gif on the Mac platform
-    Given I am in a git repo named "animate"
+  @requires_ffmpeg @slow_process
+  Scenario: should generate a lolcommit animated gif
+    Given I am in a git repo named "gif"
       And I do a git commit
     When I run `lolcommits --capture --animate=1`
     Then the output should contain "*** Preserving this moment in history."
-      And a directory named "~/.lolcommits/animate" should exist
-      And a file named "~/.lolcommits/animate/tmp_video.mov" should not exist
-      And a directory named "~/.lolcommits/animate/tmp_frames" should not exist
-      And there should be exactly 1 gif in "~/.lolcommits/animate"
+      And a directory named "~/.lolcommits/gif" should exist
+      And a file named "~/.lolcommits/animate/raw_capture.mp4" should not exist
+      And there should be exactly 1 gif in "~/.lolcommits/gif"
+
+  @requires_ffmpeg @slow_process
+  Scenario: should generate a lolcommit video
+    Given I am in a git repo named "video"
+      And I do a git commit
+    When I run `lolcommits --capture --video=1`
+    Then the output should contain "*** Preserving this moment in history."
+      And a directory named "~/.lolcommits/video" should exist
+      And a file named "~/.lolcommits/animate/raw_capture.mp4" should not exist
+      And there should be exactly 1 mp4 in "~/.lolcommits/video"
+
+  @requires_ffmpeg @slow_process
+  Scenario: should generate a lolcommit video and animated gif
+    Given I am in a git repo named "video-and-gif"
+      And I do a git commit
+    When I run `lolcommits --capture -v1 -a1`
+    Then the output should contain "*** Preserving this moment in history."
+      And a directory named "~/.lolcommits/video-and-gif" should exist
+      And a file named "~/.lolcommits/animate/raw_capture.mp4" should not exist
+      And there should be exactly 1 mp4 in "~/.lolcommits/video-and-gif"
+      And there should be exactly 1 gif in "~/.lolcommits/video-and-gif"
 
   @fake-no-ffmpeg
   Scenario: gracefully fail when ffmpeg not installed and --animate is used
@@ -292,7 +317,7 @@ Feature: Basic UI functionality
     When I do a mercurial commit
     Then the output should contain "*** Preserving this moment in history."
     And a directory named "~/.lolcommits/myrepo" should exist
-    And a file named "~/.lolcommits/myrepo/tmp_snapshot.jpg" should not exist
+    And a file named "~/.lolcommits/myrepo/raw_capture.jpg" should not exist
     And there should be exactly 1 jpg in "~/.lolcommits/myrepo"
 
   Scenario: Commiting in enabled mercurial repo subdirectory triggers successful capture

data/features/step_definitions/lolcommits_steps.rb

@@ -147,17 +147,17 @@ Given(/^a loldir named "(.*?)" with (\d+) lolimages$/) do |repo, num_images|
   FileUtils.mkdir_p loldir
   num_images.to_i.times do
     hex = format('%011x', (rand * 0xfffffffffff)).to_s
-    FileUtils.cp 'test/images/test_image.jpg', File.join(loldir, "#{hex}.jpg")
+    FileUtils.cp 'test/assets/test_image.jpg', File.join(loldir, "#{hex}.jpg")
   end
 end
 
-Then(/^there should be exactly (.*?) (jpg|gif|pid)s? in its loldir$/) do |n, type|
+Then(/^there should be exactly (.*?) (mp4|jpg|gif|pid)s? in its loldir$/) do |n, type|
   steps %(
     Then there should be exactly #{n} #{type} in "#{default_loldir}"
     )
 end
 
-Then(/^there should be exactly (.*?) (jpg|gif|pid)s? in "(.*?)"$/) do |n, type, folder|
+Then(/^there should be exactly (.*?) (mp4|jpg|gif|pid)s? in "(.*?)"$/) do |n, type, folder|
   expect(Dir[expand_path("#{folder}/*.#{type}")].count).to eq(n.to_i)
 end
 
@@ -166,6 +166,10 @@ Then(/^the output should contain a list of plugins$/) do
   step %(the output should contain "[*] loltext")
 end
 
+Then(/^the output should show the version number$/) do
+  step %(the output should match /^#{Lolcommits::VERSION}$/)
+end
+
 When(/^I do a git commit with commit message "(.*?)"$/) do |commit_msg|
   filename = FFaker::Lorem.words(1).first
   steps %(

data/lib/lolcommits/animated_gif.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Lolcommits
+  class AnimatedGif
+    def create(video_path:, output_path:)
+      unless File.exist?(video_path)
+        debug "**warning** unable to create animated gif, no video at #{video_path}"
+        return
+      end
+
+      debug "creating animated gif at #{output_path}"
+      system_call "ffmpeg -nostats -v quiet -i \"#{video_path}\" \"#{frames_dir}/%09d.png\" > #{null_string}"
+
+      # use fps to set delay and number of frames to skip (for lower filesized gifs)
+      fps   = video_fps(video_path)
+      skip  = frame_skip(fps)
+      delay = frame_delay(fps, skip)
+      debug "animated gif choosing every #{skip} frames with a frame delay of #{delay} (video fps: #{fps})"
+
+      # create the looping animated gif from frames (delete frame files except every #{skip} frame)
+      Dir["#{frames_dir}/*.png"].each do |frame_filename|
+        basename = File.basename(frame_filename)
+        frame_number = basename.split('.').first.to_i
+        File.delete(frame_filename) if frame_number % skip != 0
+      end
+
+      # convert to animated gif with delay and gif optimisation
+      system_call "convert -layers OptimizeTransparency -delay #{delay} -loop 0 \"#{frames_dir}/*.png\" -coalesce \"#{output_path}\""
+
+      # remove tmp frames dir
+      FileUtils.rm_rf(frames_dir)
+    end
+
+    private
+
+    def frames_dir
+      @frames_dir ||= Dir.mktmpdir
+    end
+
+    def null_string
+      Lolcommits::Platform.platform_windows? ? 'nul' : '/dev/null'
+    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 -nostats -v quiet -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 video fps
+      case fps
+      when 0..15
+        2
+      when 16..28
+        3
+      else
+        4
+      end
+    end
+
+    def system_call(call_str, capture_output = false)
+      debug "making system call for \n #{call_str}"
+      capture_output ? `#{call_str}` : system(call_str)
+    end
+
+    def debug(message)
+      super("#{self.class}: #{message}")
+    end
+  end
+end

data/lib/lolcommits/backends/git_info.rb

@@ -13,15 +13,15 @@ module Lolcommits
     end
 
     def initialize
-      debug 'GitInfo: parsed the following values from commit:'
-      debug "GitInfo: \t#{message}"
-      debug "GitInfo: \t#{sha}"
-      debug "GitInfo: \t#{repo_internal_path}"
-      debug "GitInfo: \t#{repo}"
-      debug "GitInfo: \t#{branch}"
-      debug "GitInfo: \t#{commit_date}"
-      debug "GitInfo: \t#{author_name}" if author_name
-      debug "GitInfo: \t#{author_email}" if author_email
+      debug 'parsed the following values from commit:'
+      debug "\t#{message}"
+      debug "\t#{sha}"
+      debug "\t#{repo_internal_path}"
+      debug "\t#{repo}"
+      debug "\t#{branch}"
+      debug "\t#{commit_date}"
+      debug "\t#{author_name}" if author_name
+      debug "\t#{author_email}" if author_email
     end
 
     def branch
@@ -44,7 +44,7 @@ module Lolcommits
     end
 
     def url
-      @url ||= remote_repo? ? remote_https_url(repository.remote.url) : nil
+      @url ||= remote_repo? ? remote_https_url(repository.remote&.url) : nil
     end
 
     def repo
@@ -73,6 +73,10 @@ module Lolcommits
 
     private
 
+    def debug(message)
+      super("#{self.class}: #{message}")
+    end
+
     def remote_https_url(url)
       url.tr(':', '/').gsub(/^git@/, 'https://').gsub(/\.git$/, '') + '/commit/'
     end
@@ -86,7 +90,7 @@ module Lolcommits
     end
 
     def remote_repo?
-      repository.remote && repository.remote.url
+      !repository.remote&.url.nil?
     end
   end
 end

data/lib/lolcommits/backends/installation_git.rb

@@ -70,9 +70,10 @@ module Lolcommits
       end
 
       <<-HOOK
-        ### lolcommits hook (begin) ###
-        #{exports} && #{capture_cmd}
-        ###  lolcommits hook (end)  ###
+
+### lolcommits hook (begin) ###
+#{exports} && #{capture_cmd}
+###  lolcommits hook (end)  ###
       HOOK
     end
 

data/lib/lolcommits/backends/installation_mercurial.rb

@@ -5,7 +5,7 @@ module Lolcommits
   # Methods to handle enabling and disabling of lolcommits
   #
   class InstallationMercurial
-    HOOK_SECTION = 'hooks'.freeze
+    HOOK_SECTION = 'hooks'
     HOOK_OPERATIONS = %w(commit record crecord).freeze
 
     #

data/lib/lolcommits/backends/mercurial_info.rb

@@ -20,15 +20,15 @@ module Lolcommits
       Mercurial.configure do |conf|
         conf.hg_binary_path = 'hg'
       end
-      debug 'MercurialInfo: parsed the following values from commit:'
-      debug "MercurialInfo: \t#{message}"
-      debug "MercurialInfo: \t#{sha}"
-      debug "MercurialInfo: \t#{repo_internal_path}"
-      debug "MercurialInfo: \t#{repo}"
-      debug "MercurialInfo: \t#{branch}"
-      debug "MercurialInfo: \t#{commit_date}"
-      debug "MercurialInfo: \t#{author_name}" if author_name
-      debug "MercurialInfo: \t#{author_email}" if author_email
+      debug 'parsed the following values from commit:'
+      debug "\t#{message}"
+      debug "\t#{sha}"
+      debug "\t#{repo_internal_path}"
+      debug "\t#{repo}"
+      debug "\t#{branch}"
+      debug "\t#{commit_date}"
+      debug "\t#{author_name}" if author_name
+      debug "\t#{author_email}" if author_email
     end
 
     def branch
@@ -72,6 +72,10 @@ module Lolcommits
 
     private
 
+    def debug(message)
+      super("#{self.class}: #{message}")
+    end
+
     def repository(path = '.')
       @repository ||= Mercurial::Repository.open(path)
     end

data/lib/lolcommits/capturer.rb

@@ -2,23 +2,31 @@
 
 module Lolcommits
   class Capturer
-    attr_accessor :capture_device, :capture_delay, :snapshot_location,
-                  :video_location, :frames_location, :animated_duration
+    attr_accessor :capture_device, :capture_delay, :capture_duration,
+                  :capture_path
 
     def initialize(attributes = {})
       attributes.each do |attr, val|
         send("#{attr}=", val)
       end
-      debug 'Capturer: initializing new instance ' + to_s
+    end
+
+    def system_call(call_str, capture_output = false)
+      debug "making system call for \n #{call_str}"
+      capture_output ? `#{call_str}` : system(call_str)
+    end
+
+    def debug(message)
+      super("#{self.class}: #{message}")
     end
   end
 end
 
 require 'lolcommits/capturer/capture_mac'
-require 'lolcommits/capturer/capture_mac_animated'
+require 'lolcommits/capturer/capture_mac_video'
 require 'lolcommits/capturer/capture_linux'
-require 'lolcommits/capturer/capture_linux_animated'
+require 'lolcommits/capturer/capture_linux_video'
 require 'lolcommits/capturer/capture_windows'
-require 'lolcommits/capturer/capture_windows_animated'
+require 'lolcommits/capturer/capture_windows_video'
 require 'lolcommits/capturer/capture_cygwin'
 require 'lolcommits/capturer/capture_fake'

data/lib/lolcommits/capturer/capture_cygwin.rb

@@ -1,23 +1,12 @@
 # frozen_string_literal: true
 
 module Lolcommits
-  class CaptureCygwin < Capturer
+  class CaptureCygwin < CaptureWindows
     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 #{capture_path}`#{delay_arg}")
 
-      _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
+      # 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

@@ -3,8 +3,14 @@
 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
+      FileUtils.cp(test_file, capture_path)
+    end
+
+    private
+
+    def test_file
+      filename = capture_duration.zero? ? 'test_image.jpg' : 'test_video.mp4'
+      File.join(Configuration::LOLCOMMITS_ROOT, 'test', 'assets', filename)
     end
   end
 end

data/lib/lolcommits/capturer/capture_linux.rb

@@ -4,12 +4,7 @@ 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
@@ -20,13 +15,13 @@ module Lolcommits
       # multiply the set value (in seconds) by 25
       frames = delay.to_i * MPLAYER_FPS
 
-      debug 'LinuxCapturer: calling out to mplayer to capture image'
+      debug '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'
+      debug '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|
@@ -34,13 +29,19 @@ module Lolcommits
       end
 
       if all_frames.empty?
-        debug 'LinuxCapturer: failed to capture any image'
+        debug 'failed to capture any image'
       else
-        FileUtils.mv(all_frames.last, snapshot_location)
-        debug 'LinuxCapturer: cleaning up'
+        FileUtils.mv(all_frames.last, capture_path)
+        debug 'cleaning up'
       end
 
       FileUtils.rm_rf(tmpdir)
     end
+
+    private
+
+    def capture_device_string
+      "-tv device=\"#{capture_device || Dir.glob('/dev/video*').first}\""
+    end
   end
 end