lolcommits 0.17.2 → 0.17.3

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,11 +23,11 @@ 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."
 
         MiniMagick.convert do |convert|
           convert.delay 50
@@ -46,7 +44,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 +52,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

data/lib/lolcommits/platform.rb

@@ -1,15 +1,13 @@
-# frozen_string_literal: true
-
-require 'mini_magick'
-require 'rbconfig'
+require "mini_magick"
+require "rbconfig"
 
 module Lolcommits
   class Platform
     # The capturer class constant to use
     # @return Class
     def self.capturer_class(animate: false)
-      if ENV['LOLCOMMITS_CAPTURER']
-        const_get(ENV['LOLCOMMITS_CAPTURER'])
+      if ENV["LOLCOMMITS_CAPTURER"]
+        const_get(ENV["LOLCOMMITS_CAPTURER"])
       elsif platform_mac?
         animate ? CaptureMacVideo : CaptureMac
       elsif platform_linux?
@@ -19,20 +17,20 @@ module Lolcommits
       elsif platform_cygwin?
         CaptureCygwin
       else
-        raise 'Unknown / Unsupported Platform.'
+        raise "Unknown / Unsupported Platform."
       end
     end
 
     # Are we on a Mac platform?
     # @return Boolean
     def self.platform_mac?
-      host_os.include?('darwin')
+      host_os.include?("darwin")
     end
 
     # Are we on a Linux platform?
     # @return Boolean
     def self.platform_linux?
-      host_os.include?('linux')
+      host_os.include?("linux")
     end
 
     # Are we on a Windows platform?
@@ -44,13 +42,13 @@ module Lolcommits
     # Are we on a Cygwin platform?
     # @return Boolean
     def self.platform_cygwin?
-      host_os.include?('cygwin')
+      host_os.include?("cygwin")
     end
 
     # return host_os identifier from the RbConfig::CONFIG constant
     # @return String
     def self.host_os
-      ENV['LOLCOMMITS_FAKE_HOST_OS'] || RbConfig::CONFIG['host_os'].downcase
+      ENV["LOLCOMMITS_FAKE_HOST_OS"] || RbConfig::CONFIG["host_os"].downcase
     end
 
     # Is the platform capable of capturing animated GIFs from webcam?
@@ -62,9 +60,7 @@ module Lolcommits
     # Is a valid install of imagemagick present on the system?
     # @return Boolean
     def self.valid_imagemagick_installed?
-      return false unless command_which('identify')
-
-      return false unless command_which('mogrify')
+      return false unless command_which("magick")
 
       # cli_version check will throw a MiniMagick::Error exception if IM is not
       # installed in PATH, since it attempts to parse output from `identify`
@@ -78,7 +74,7 @@ module Lolcommits
     # @note For now, this just checks for presence, any version should work.
     # @return Boolean
     def self.valid_ffmpeg_installed?
-      command_which('ffmpeg')
+      command_which("ffmpeg")
     end
 
     # Cross-platform way of finding an executable in the $PATH.
@@ -91,8 +87,8 @@ module Lolcommits
     #
     # @return Boolean
     def self.command_which(cmd, only_path: false)
-      exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
-      ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+      exts = ENV["PATHEXT"] ? ENV["PATHEXT"].split(";") : [ "" ]
+      ENV["PATH"].split(File::PATH_SEPARATOR).each do |path|
         exts.each do |ext|
           exe = "#{path}/#{cmd}#{ext}"
           return only_path ? path : exe if File.executable? exe
@@ -123,7 +119,7 @@ module Lolcommits
       # TODO: handle other platforms here (linux/windows) e.g with ffmpeg -list_devices
       return unless Platform.platform_mac?
 
-      videosnap = File.join(Configuration::LOLCOMMITS_ROOT, 'vendor', 'ext', 'videosnap', 'videosnap')
+      videosnap = File.join(Configuration::LOLCOMMITS_ROOT, "vendor", "ext", "videosnap", "videosnap")
       `#{videosnap} -l`
     end
   end

data/lib/lolcommits/plugin/base.rb

@@ -1,6 +1,4 @@
-# frozen_string_literal: true
-
-require 'lolcommits/plugin/configuration_helper'
+require "lolcommits/plugin/configuration_helper"
 
 module Lolcommits
   module Plugin
@@ -13,7 +11,7 @@ module Lolcommits
         self.runner = runner
         self.name = name || self.class.to_s
         self.configuration = config || {}
-        self.options = [:enabled]
+        self.options = [ :enabled ]
       end
 
       def run_pre_capture; end
@@ -51,9 +49,7 @@ module Lolcommits
       #
       # @return [Hash] the configured plugin options
       def configure_options!
-        configure_option_hash(
-          options.map { |option| [option, nil] }.to_h.merge(default_options)
-        )
+        configure_option_hash(options.map { |option| [ option, nil ] }.to_h.merge(default_options))
       end
 
       def default_options
@@ -103,7 +99,7 @@ module Lolcommits
       def configure_option_hash(option_hash, spacing_count = 0)
         option_hash.keys.reduce({}) do |acc, option|
           option_value = option_hash[option]
-          prefix       = '  ' * spacing_count
+          prefix       = "  " * spacing_count
           if option_value.is_a?(Hash)
             puts "#{prefix}#{option}:\n"
             acc.merge(option => configure_option_hash(option_value, (spacing_count + 1)))

data/lib/lolcommits/plugin/configuration_helper.rb

@@ -1,13 +1,11 @@
-# frozen_string_literal: true
-
 module Lolcommits
   module Plugin
     module ConfigurationHelper
       # handle for bools, strings, ints and blanks from user input
       def parse_user_input(str)
-        if 'true'.casecmp(str).zero?
+        if "true".casecmp(str).zero?
           true
-        elsif 'false'.casecmp(str).zero?
+        elsif "false".casecmp(str).zero?
           false
         elsif str =~ /^[0-9]+$/
           str.to_i
@@ -29,7 +27,7 @@ module Lolcommits
       # ]
       # User will be asked for Organization, can tab to autocomplete, and chosen
       # value is returned.
-      def prompt_autocomplete_hash(prompt, items, name: 'name', value: 'value', suggest_words: 5)
+      def prompt_autocomplete_hash(prompt, items, name: "name", value: "value", suggest_words: 5)
         words = items.map { |item| item[name] }.sort
         puts "e.g. #{words.take(suggest_words).join(', ')}" if suggest_words.positive?
         completed_input = gets_autocomplete(prompt, words)
@@ -40,7 +38,7 @@ module Lolcommits
 
       def gets_autocomplete(prompt, words)
         completion_handler = proc { |s| words.grep(/^#{Regexp.escape(s)}/) }
-        Readline.completion_append_character = ''
+        Readline.completion_append_character = ""
         Readline.completion_proc = completion_handler
 
         while (line = Readline.readline(prompt, true).strip)

data/lib/lolcommits/plugin_manager.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Lolcommits
   class PluginManager
     GEM_NAME_PREFIX = /^#{Lolcommits::GEM_NAME}-/
@@ -62,7 +60,7 @@ module Lolcommits
 
     def gem_list
       Gem.refresh
-      Gem::Specification.respond_to?(:each) ? Gem::Specification : Gem.source_index.find_name('')
+      Gem::Specification.respond_to?(:each) ? Gem::Specification : Gem.source_index.find_name("")
     end
   end
 end

data/lib/lolcommits/runner.rb

@@ -1,7 +1,5 @@
-# frozen_string_literal: true
-
-require 'lolcommits/platform'
-require 'lolcommits/animated_gif'
+require "lolcommits/platform"
+require "lolcommits/animated_gif"
 
 module Lolcommits
   class Runner
@@ -30,7 +28,7 @@ module Lolcommits
 
       self.capture_path       = config.capture_path(lolcommit_ext)
       self.lolcommit_path     = config.sha_path(sha, lolcommit_ext)
-      self.lolcommit_gif_path = config.sha_path(sha, 'gif') if capture_gif
+      self.lolcommit_gif_path = config.sha_path(sha, "gif") if capture_gif
     end
 
     def run
@@ -41,7 +39,7 @@ module Lolcommits
 
       # capture must exist to run post capture methods
       unless File.exist?(capture_path)
-        raise 'failed to capture any image or video!'
+        raise "failed to capture any image or video!"
       end
 
       run_post_capture
@@ -50,7 +48,7 @@ module Lolcommits
       debug("#{e.class}: #{e.message}")
       exit 1
     ensure
-      debug 'running cleanup'
+      debug "running cleanup"
       FileUtils.rm_f(capture_path)
     end
 
@@ -63,12 +61,12 @@ module Lolcommits
         end
 
         base = MiniMagick::Image.open(source_path)
-        png_tempfile = MiniMagick::Utilities.tempfile('.png')
+        png_tempfile = MiniMagick::Utilities.tempfile(".png")
         debug("creating a new empty overlay png for lolcommit (#{base.dimensions.join('x')})")
 
         MiniMagick::Tool::Convert.new do |i|
           i.size "#{base.width}x#{base.height}"
-          i.xc 'transparent'
+          i.xc "transparent"
           i << png_tempfile.path
         end
 
@@ -94,7 +92,7 @@ module Lolcommits
     end
 
     def run_capture
-      puts '*** Preserving this moment in history.' unless capture_stealth
+      puts "*** Preserving this moment in history." unless capture_stealth
       capturer = Platform.capturer_class(animate: !capture_image?).new(
         capture_path: capture_path,
         capture_device: capture_device,
@@ -119,10 +117,7 @@ module Lolcommits
       # optionally create animated gif
       return unless capture_gif
 
-      AnimatedGif.new.create(
-        video_path: lolcommit_path,
-        output_path: lolcommit_gif_path
-      )
+      AnimatedGif.new.create(video_path: lolcommit_path, output_path: lolcommit_gif_path)
 
       # done if we are capturing both video and gif
       return if capture_video
@@ -145,9 +140,9 @@ module Lolcommits
         debug "resizing raw image (#{image.dimensions.join('x')}) to #{lolcommit_path} (640x480)"
         # hacky resize to fill bounds
         image.combine_options do |c|
-          c.resize '640x480^'
-          c.gravity 'center'
-          c.extent '640x480'
+          c.resize "640x480^"
+          c.gravity "center"
+          c.extent "640x480"
         end
         image.write(lolcommit_path)
       else
@@ -157,10 +152,10 @@ module Lolcommits
     end
 
     def apply_overlay
-      debug 'applying overlay to lolcommit'
+      debug "applying overlay to lolcommit"
       if capture_image?
         MiniMagick::Image.open(lolcommit_path).composite(overlay) do |c|
-          c.gravity 'center'
+          c.gravity "center"
         end.write(lolcommit_path)
       else
         system_call "ffmpeg -v quiet -nostats -i #{capture_path} -i #{overlay.path} \
@@ -171,9 +166,9 @@ module Lolcommits
 
     def lolcommit_ext
       if capture_image?
-        'jpg'
+        "jpg"
       else
-        'mp4'
+        "mp4"
       end
     end
 

data/lib/lolcommits/test_helpers/fake_io.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Lolcommits
   module TestHelpers
     module FakeIO