lolcommits 0.17.2 → 0.18.0

data/lib/lolcommits/backends/installation_mercurial.rb

@@ -1,17 +1,15 @@
-# frozen_string_literal: true
-
 module Lolcommits
   #
   # Methods to handle enabling and disabling of lolcommits
   #
   class InstallationMercurial
-    HOOK_SECTION = 'hooks'
-    HOOK_OPERATIONS = %w(commit record crecord).freeze
+    HOOK_SECTION = "hooks"
+    HOOK_OPERATIONS = %w[commit record crecord].freeze
 
     #
     # IF --ENABLE, DO ENABLE
     #
-    def self.do_enable(capture_args = '')
+    def self.do_enable(capture_args = "")
       if lolcommits_hook_exists?
         # clear away any existing lolcommits hook
         remove_existing_hook!
@@ -39,9 +37,9 @@ module Lolcommits
       end
     end
 
-    def self.hook_script(capture_args = '')
-      ruby_path     = Lolcommits::Platform.command_which('ruby', only_path: true)
-      imagick_path  = Lolcommits::Platform.command_which('identify', only_path: true)
+    def self.hook_script(capture_args = "")
+      ruby_path     = Lolcommits::Platform.command_which("ruby", only_path: true)
+      imagick_path  = Lolcommits::Platform.command_which("identify", only_path: true)
       capture_cmd   = "if [ \"$LOLCOMMITS_CAPTURE_DISABLED\" != \"true\" ]; then lolcommits --capture #{capture_args}; fi"
       exports       = "LANG=\"#{ENV.fetch('LANG', nil)}\" && PATH=\"$PATH:#{ruby_path}:#{imagick_path}\""
 
@@ -53,13 +51,13 @@ module Lolcommits
     end
 
     def self.repository
-      Mercurial::Repository.open('.')
+      Mercurial::Repository.open(".")
     end
 
     # does a mercurial hook exist with lolcommits commands?
     def self.lolcommits_hook_exists?
       config = repository.config
-      config.exists? && config.setting_exists?(HOOK_SECTION, 'post-crecord.lolcommits')
+      config.exists? && config.setting_exists?(HOOK_SECTION, "post-crecord.lolcommits")
     end
 
     # can we load the hgrc?

data/lib/lolcommits/backends/mercurial_info.rb

@@ -1,26 +1,24 @@
-# frozen_string_literal: true
-
 module Lolcommits
   class MercurialInfo
-    def self.repo_root?(path = '.')
-      File.directory?(File.join(path, '.hg'))
+    def self.repo_root?(path = ".")
+      File.directory?(File.join(path, ".hg"))
     end
 
-    def self.local_name(path = '.')
+    def self.local_name(path = ".")
       File.basename(File.dirname(Mercurial::Repository.open(path).dothg_path))
     end
 
     def initialize
       # mercurial sets HG_RESULT for post- hooks
-      if ENV.key?('HG_RESULT') && ENV['HG_RESULT'] != '0'
-        debug 'Aborting lolcommits hook from failed operation'
+      if ENV.key?("HG_RESULT") && ENV["HG_RESULT"] != "0"
+        debug "Aborting lolcommits hook from failed operation"
         exit 1
       end
 
       Mercurial.configure do |conf|
-        conf.hg_binary_path = 'hg'
+        conf.hg_binary_path = "hg"
       end
-      debug 'parsed the following values from commit:'
+      debug "parsed the following values from commit:"
       debug "\t#{message}"
       debug "\t#{sha}"
       debug "\t#{repo_internal_path}"
@@ -37,7 +35,7 @@ module Lolcommits
 
     def message
       @message ||= begin
-        message = last_commit.message || ''
+        message = last_commit.message || ""
         message.split("\n").first
       end
     end
@@ -76,7 +74,7 @@ module Lolcommits
       super("#{self.class}: #{message}")
     end
 
-    def repository(path = '.')
+    def repository(path = ".")
       @repository ||= Mercurial::Repository.open(path)
     end
 

data/lib/lolcommits/capturer/capture_cygwin.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Lolcommits
   class CaptureCygwin < CaptureWindows
     def capture

data/lib/lolcommits/capturer/capture_fake.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Lolcommits
   class CaptureFake < Capturer
     def capture
@@ -9,8 +7,8 @@ module Lolcommits
     private
 
     def test_file
-      filename = capture_duration.zero? ? 'test_image.jpg' : 'test_video.mp4'
-      File.join(Configuration::LOLCOMMITS_ROOT, 'test', 'assets', filename)
+      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

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Lolcommits
   class CaptureLinux < Capturer
     MPLAYER_FPS = 25
@@ -15,13 +13,13 @@ module Lolcommits
       # multiply the set value (in seconds) by 25
       frames = delay.to_i * MPLAYER_FPS
 
-      debug '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 '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|
@@ -29,10 +27,10 @@ module Lolcommits
       end
 
       if all_frames.empty?
-        debug 'failed to capture any image'
+        debug "failed to capture any image"
       else
         FileUtils.mv(all_frames.last, capture_path)
-        debug 'cleaning up'
+        debug "cleaning up"
       end
 
       FileUtils.rm_rf(tmpdir)

data/lib/lolcommits/capturer/capture_linux_video.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Lolcommits
   class CaptureLinuxVideo < Capturer
     def capture
@@ -9,7 +7,7 @@ module Lolcommits
     private
 
     def capture_device_string
-      capture_device || Dir.glob('/dev/video*').first
+      capture_device || Dir.glob("/dev/video*").first
     end
   end
 end

data/lib/lolcommits/capturer/capture_mac.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Lolcommits
   class CaptureMac < Capturer
     def capture
@@ -9,11 +7,11 @@ module Lolcommits
     private
 
     def capture_device_string
-      capture_device.nil? ? '' : "-d \"#{capture_device}\""
+      capture_device.nil? ? "" : "-d \"#{capture_device}\""
     end
 
     def executable_path
-      File.join(Configuration::LOLCOMMITS_ROOT, 'vendor', 'ext', 'imagesnap', 'imagesnap')
+      File.join(Configuration::LOLCOMMITS_ROOT, "vendor", "ext", "imagesnap", "imagesnap")
     end
   end
 end

data/lib/lolcommits/capturer/capture_mac_video.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Lolcommits
   class CaptureMacVideo < Capturer
     def capture
@@ -17,7 +15,7 @@ module Lolcommits
     end
 
     def executable_path
-      File.join(Configuration::LOLCOMMITS_ROOT, 'vendor', 'ext', 'videosnap', 'videosnap')
+      File.join(Configuration::LOLCOMMITS_ROOT, "vendor", "ext", "videosnap", "videosnap")
     end
   end
 end

data/lib/lolcommits/capturer/capture_windows.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Lolcommits
   class CaptureWindows < Capturer
     def capture
@@ -17,12 +15,12 @@ module Lolcommits
         " /delay #{capture_delay * 1000}"
       else
         # DirectShow takes a while to show, default to 3 sec delay
-        ' /delay 3000'
+        " /delay 3000"
       end
     end
 
     def executable_path
-      File.join(Configuration::LOLCOMMITS_ROOT, 'vendor', 'ext', 'CommandCam', 'CommandCam.exe')
+      File.join(Configuration::LOLCOMMITS_ROOT, "vendor", "ext", "CommandCam", "CommandCam.exe")
     end
   end
 end

data/lib/lolcommits/capturer/capture_windows_video.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Lolcommits
   class CaptureWindowsVideo < Capturer
     def capture
@@ -15,24 +13,24 @@ module Lolcommits
     end
 
     def ffpmeg_list_devices_cmd
-      'ffmpeg -list_devices true -f dshow -i dummy 2>&1'
+      "ffmpeg -list_devices true -f dshow -i dummy 2>&1"
     end
 
     # inspired by this code from @rdp http://tinyurl.com/y7t276bh
     def device_names
       @device_names ||= begin
         names      = []
-        cmd_output = ''
+        cmd_output = ""
         count      = 0
-        while cmd_output.empty? || !cmd_output.split('DirectShow')[2]
+        while cmd_output.empty? || !cmd_output.split("DirectShow")[2]
           cmd_output = system_call(ffpmeg_list_devices_cmd, capture_output: true)
           count += 1
-          raise 'failed to find a video capture device with ffmpeg -list_devices' if count == 5
+          raise "failed to find a video capture device with ffmpeg -list_devices" if count == 5
 
           sleep 0.1
         end
         cmd_output.gsub!("\r\n", "\n")
-        video = cmd_output.split('DirectShow')[1]
+        video = cmd_output.split("DirectShow")[1]
 
         video.lines.map do |line|
           names << Regexp.last_match(1) if line =~ /"(.+)"\n/

data/lib/lolcommits/capturer.rb

@@ -1,9 +1,6 @@
-# frozen_string_literal: true
-
 module Lolcommits
   class Capturer
-    attr_accessor :capture_device, :capture_delay, :capture_duration,
-                  :capture_path
+    attr_accessor :capture_device, :capture_delay, :capture_duration, :capture_path
 
     def initialize(attributes = {})
       attributes.each do |attr, val|
@@ -22,11 +19,11 @@ module Lolcommits
   end
 end
 
-require 'lolcommits/capturer/capture_mac'
-require 'lolcommits/capturer/capture_mac_video'
-require 'lolcommits/capturer/capture_linux'
-require 'lolcommits/capturer/capture_linux_video'
-require 'lolcommits/capturer/capture_windows'
-require 'lolcommits/capturer/capture_windows_video'
-require 'lolcommits/capturer/capture_cygwin'
-require 'lolcommits/capturer/capture_fake'
+require "lolcommits/capturer/capture_mac"
+require "lolcommits/capturer/capture_mac_video"
+require "lolcommits/capturer/capture_linux"
+require "lolcommits/capturer/capture_linux_video"
+require "lolcommits/capturer/capture_windows"
+require "lolcommits/capturer/capture_windows_video"
+require "lolcommits/capturer/capture_cygwin"
+require "lolcommits/capturer/capture_fake"

data/lib/lolcommits/cli/fatals.rb

@@ -1,7 +1,5 @@
-# frozen_string_literal: true
-
-require 'lolcommits/platform'
-require 'optparse_plus'
+require "lolcommits/platform"
+require "optparse_plus"
 
 module Lolcommits
   module CLI
@@ -16,15 +14,14 @@ module Lolcommits
       def self.die_on_fatal_platform_conditions!
         # make sure the capture binaries are in a good state
         if Platform.platform_mac?
-          %w(imagesnap videosnap).each do |executable|
-            next if File.executable? File.join(Configuration::LOLCOMMITS_ROOT, 'vendor', 'ext', executable, executable)
+          %w[imagesnap videosnap].each do |executable|
+            next if File.executable? File.join(Configuration::LOLCOMMITS_ROOT, "vendor", "ext", executable, executable)
 
-            fatal "Couldn't properly execute #{executable} for some reason, " \
-                  'please file a bug?!'
+            fatal "Couldn't properly execute #{executable} for some reason, " + "please file a bug?!"
             exit 1
           end
         elsif Platform.platform_linux?
-          unless Platform.command_which('mplayer')
+          unless Platform.command_which("mplayer")
             fatal "Couldn't find mplayer in your PATH!"
             exit 1
           end
@@ -32,16 +29,14 @@ module Lolcommits
 
         # make sure imagemagick is around and good to go
         unless Platform.valid_imagemagick_installed?
-          fatal 'FATAL: ImageMagick does not appear to be properly installed!' \
-                '(or version is too old)'
+          fatal "FATAL: ImageMagick does not appear to be properly installed!(or version is too old)"
           exit 1
         end
 
         # check for a error condition with git config affecting ruby-git
         return unless Platform.git_config_color_always?
 
-        fatal 'Due to a bug in the ruby-git library, git config for color.ui ' \
-              "cannot be set to 'always'."
+        fatal "Due to a bug in the ruby-git library, git config for color.ui " + "cannot be set to 'always'."
         fatal "Try setting it to 'auto' instead!"
         exit 1
       end
@@ -52,15 +47,15 @@ module Lolcommits
       def self.die_if_no_valid_ffmpeg_installed!
         return if Platform.valid_ffmpeg_installed?
 
-        fatal 'FATAL: ffmpeg does not appear to be properly installed!'
+        fatal "FATAL: ffmpeg does not appear to be properly installed!"
         exit 1
       end
 
       # If we are not in a git repo, we can't do git related things!
       # Die with an informative error message in that case.
       def self.die_if_not_vcs_repo!
-        debug 'Checking for valid VCS repo'
-        current = File.expand_path('.')
+        debug "Checking for valid VCS repo"
+        current = File.expand_path(".")
         parent = File.dirname(current)
         while current != parent
           return if VCSInfo.repo_root?(current)

data/lib/lolcommits/cli/launcher.rb

@@ -1,6 +1,4 @@
-# frozen_string_literal: true
-
-require 'launchy'
+require "launchy"
 
 module Lolcommits
   module CLI

data/lib/lolcommits/cli/process_runner.rb

@@ -1,6 +1,4 @@
-# frozen_string_literal: true
-
-require 'fileutils'
+require "fileutils"
 
 module Lolcommits
   module CLI
@@ -43,7 +41,7 @@ module Lolcommits
       end
 
       def pid_file
-        File.join(@configuration.loldir, 'lolcommits.pid')
+        File.join(@configuration.loldir, "lolcommits.pid")
       end
     end
   end

data/lib/lolcommits/cli/timelapse_gif.rb

@@ -1,7 +1,5 @@
-# frozen_string_literal: true
-
-require 'lolcommits/cli/fatals'
-require 'mini_magick'
+require "lolcommits/cli/fatals"
+require "mini_magick"
 
 module Lolcommits
   module CLI
@@ -16,7 +14,7 @@ module Lolcommits
       # param args [String] the arg passed to the gif command on CLI (optional)
       def run(args = nil)
         case args
-        when 'today'
+        when "today"
           lolimages = jpg_images_today
           filename  = Date.today.to_s
         else
@@ -25,20 +23,22 @@ module Lolcommits
         end
 
         if lolimages.empty?
-          warn 'No lolcommits have been captured for this time yet.'
+          warn "No lolcommits have been captured for this time yet."
           exit 1
         end
 
-        puts '*** Generating animated timelapse gif.'
+        puts "*** Generating animated timelapse gif."
+
+        gif_path = File.join(timelapses_dir_path, "#{filename}.gif")
 
         MiniMagick.convert do |convert|
           convert.delay 50
           convert.loop 0
           lolimages.each { |image| convert << image }
-          convert << File.join(timelapses_dir_path, "#{filename}.gif")
+          convert << gif_path
         end
 
-        puts "*** Done, generated at #{gif.path}"
+        puts "*** Done, generated at #{gif_path}"
       end
 
       private
@@ -46,7 +46,7 @@ module Lolcommits
       attr_accessor :loldir
 
       def jpg_images
-        Dir.glob(File.join(loldir, '*.jpg')).sort_by { |f| File.mtime(f) }
+        Dir.glob(File.join(loldir, "*.jpg")).sort_by { |f| File.mtime(f) }
       end
 
       def jpg_images_today
@@ -54,7 +54,7 @@ module Lolcommits
       end
 
       def timelapses_dir_path
-        dir = File.join(loldir, 'timelapses')
+        dir = File.join(loldir, "timelapses")
         FileUtils.mkdir_p(dir)
         dir
       end

data/lib/lolcommits/cli.rb

@@ -1,6 +1,6 @@
-# frozen_string_literal: true
-
-require 'lolcommits/cli/fatals'
-require 'lolcommits/cli/launcher'
-require 'lolcommits/cli/process_runner'
-require 'lolcommits/cli/timelapse_gif'
+require "optparse"
+require "optparse_plus"
+require "lolcommits/cli/fatals"
+require "lolcommits/cli/launcher"
+require "lolcommits/cli/process_runner"
+require "lolcommits/cli/timelapse_gif"

data/lib/lolcommits/configuration.rb

@@ -1,24 +1,41 @@
-# frozen_string_literal: true
-
 module Lolcommits
   class Configuration
-    LOLCOMMITS_BASE = ENV['LOLCOMMITS_DIR'] || File.join(Dir.home, '.lolcommits')
-    LOLCOMMITS_ROOT = File.join(File.dirname(__FILE__), '../..')
+    LOLCOMMITS_BASE = ENV["LOLCOMMITS_DIR"] || File.join(Dir.home, ".lolcommits")
+    LOLCOMMITS_ROOT = File.join(File.dirname(__FILE__), "../..")
 
     attr_accessor :plugin_manager
     attr_writer :loldir
 
+    def self.loldir_for(basename)
+      loldir = File.join(LOLCOMMITS_BASE, basename)
+
+      if File.directory? loldir
+        begin
+          # ensure 755 permissions for loldir
+          File.chmod(0o755, loldir)
+        rescue Errno::EPERM
+          # abort if permissions cannot be met
+          puts "FATAL: directory '#{loldir}' should be present and writeable by user '#{ENV.fetch('USER', nil)}'"
+          puts "Try changing the directory permissions to 755"
+          exit 1
+        end
+      else
+        FileUtils.mkdir_p loldir
+      end
+      loldir
+    end
+
     def initialize(plugin_manager, test_mode: false)
       @plugin_manager = plugin_manager
-      @loldir         = Configuration.loldir_for('test') if test_mode
+      @loldir         = Configuration.loldir_for("test") if test_mode
     end
 
     def yaml
       @yaml ||= if File.exist?(configuration_file)
-                  YAML.safe_load(File.open(configuration_file), permitted_classes: [Symbol]) || Hash.new({})
-                else
+                  YAML.safe_load(File.open(configuration_file), permitted_classes: [ Symbol ]) || Hash.new({})
+      else
                   Hash.new({})
-                end
+      end
     end
 
     def configuration_file
@@ -30,11 +47,11 @@ module Lolcommits
 
       basename ||= if VCSInfo.repo_root?
                      VCSInfo.local_name
-                   else
+      else
                      File.basename(Dir.getwd)
-                   end
-      basename.sub!(/^\./, 'dot')
-      basename.sub!(/ /, '-')
+      end
+      basename.sub!(/^\./, "dot")
+      basename.sub!(/ /, "-")
       @loldir = Configuration.loldir_for(basename)
     end
 
@@ -42,7 +59,7 @@ module Lolcommits
       File.join loldir, "#{sha}.#{ext}"
     end
 
-    def capture_path(ext = 'jpg')
+    def capture_path(ext = "jpg")
       File.join loldir, "raw_capture.#{ext}"
     end
 
@@ -68,7 +85,7 @@ module Lolcommits
 
     def ask_for_plugin_name
       list_plugins
-      print 'Name of plugin to configure: '
+      print "Name of plugin to configure: "
       gets.strip
     end
 
@@ -94,7 +111,7 @@ module Lolcommits
     ensure
       if plugin
         # clean away legacy enabled key, later we can remove this
-        plugin_config.delete('enabled')
+        plugin_config.delete("enabled")
         # save plugin config (if we have anything in the hash)
         save(plugin.name, plugin_config) unless plugin_config.empty?
 
@@ -114,26 +131,5 @@ module Lolcommits
     def to_s
       yaml.to_yaml.to_s
     end
-
-    # class methods
-
-    def self.loldir_for(basename)
-      loldir = File.join(LOLCOMMITS_BASE, basename)
-
-      if File.directory? loldir
-        begin
-          # ensure 755 permissions for loldir
-          File.chmod(0o755, loldir)
-        rescue Errno::EPERM
-          # abort if permissions cannot be met
-          puts "FATAL: directory '#{loldir}' should be present and writeable by user '#{ENV.fetch('USER', nil)}'"
-          puts 'Try changing the directory permissions to 755'
-          exit 1
-        end
-      else
-        FileUtils.mkdir_p loldir
-      end
-      loldir
-    end
   end
 end

data/lib/lolcommits/gem_plugin.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Lolcommits
   class GemPlugin
     attr_accessor :gem_spec, :required
@@ -51,22 +49,22 @@ module Lolcommits
     end
 
     def name
-      gem_name.split('-', 2).last
+      gem_name.split("-", 2).last
     end
 
     private
 
     def gem_path
-      gem_name.tr('-', '/')
+      gem_name.tr("-", "/")
     end
 
     def plugin_klass_name
       # convert gem paths to plugin classes e.g.
       # lolcommits/loltext --> Lolcommits::Plugin::Loltext
       # lolcommits/term_output --> Lolcommits::Plugin::TermOutput
-      gem_path.split('/').insert(1, 'plugin').collect do |c|
-        c.split('_').collect(&:capitalize).join
-      end.join('::')
+      gem_path.split("/").insert(1, "plugin").collect do |c|
+        c.split("_").collect(&:capitalize).join
+      end.join("::")
     end
   end
 end

data/lib/lolcommits/installation.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Lolcommits
   #
   # Methods to handle enabling and disabling of lolcommits
@@ -23,9 +21,9 @@ module Lolcommits
       capture_args = extract_capture_args(options)
       path         = backend.do_enable(capture_args)
 
-      info 'installed lolcommit hook to:'
+      info "installed lolcommit hook to:"
       info "  -> #{File.expand_path(path)}"
-      info '(to remove later, you can use: lolcommits --disable)'
+      info "(to remove later, you can use: lolcommits --disable)"
       # we dont symlink, but rather install a small stub that calls the one from path
       # that way, as gem version changes, script updates even if new file thus breaking symlink
     end
@@ -43,14 +41,14 @@ module Lolcommits
     # @return [String]
     def self.extract_capture_args(options)
       options.map do |k, v|
-        next unless %w(device animate delay stealth fork).include?(k)
+        next unless %w[device animate delay stealth fork].include?(k)
 
-        if k == 'device'
+        if k == "device"
           "--device '#{v}'"
         else
           "--#{k}#{v == true ? '' : " #{v}"}"
         end
-      end.compact.join(' ')
+      end.compact.join(" ")
     end
   end
 end