lolcommits 0.5.7 → 0.5.8.pre1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MWE3MGEwZGZkZDk1ZGVhMzgyOGUzODdhMjY4OGQ5OWNjYjc4YWYwZQ==
+    N2MyN2VjMGMzZDE5NjFlODNjOTQ1OWI4YmE4NjNiMWVlOGU3ZTBjYw==
   data.tar.gz: !binary |-
-    ODczNTk4MGFlODMwODg5OTdjMGJkNWJhOTk1N2QwMzMyZjkwZWE1Mw==
+    ZjY5ZWYwYjVlZTY0OGU3OWVjMDBmYjNiOTc1Y2U0MjkxN2U0YzExNw==
 SHA512:
   metadata.gz: !binary |-
-    NjJhYTc0YTVmY2E2ZGU4MmU3ODBkYjQyYTUyYjg2ODM1NjY5YTdiY2E0Mzli
-    NjRhOTVlODNhMDdjNzI2NjM1MjcxN2VjN2EzYzJjNmYxMTQ4ZTU1NWQyNTk5
-    ZDljZTc1MTQ0ODY4NzhmMjQyYjYxNTVmYTVhY2M0OTA2OGM0MDU=
+    NGZjN2RhNGRhM2RkMDQ4ZWE1YTM0ZDY5ZmRiNzQxYzgzMjk3ZTJlZmJkNTdi
+    ZWFlOTM0NmE5OGFhM2QwZTE3Y2E0ZTVlMDU3YjkwMDc3NmVkNmQ4NGI5NThk
+    ODg4NjYwNTQyYWI0NmIzYmY4ZGIyOGFiNDJiMWE4YWI5NGM1MDg=
   data.tar.gz: !binary |-
-    OGY4Zjg5OGU3Mzc1MGZlODg1YzQzODE0NTQ3Y2FhMGQ1ODU1YTQwODhhY2Nk
-    ODVmOWM3ZGM5MDYyNTM2YTkzMDA5ZDhlYTE3YzQ1Y2IzNmMwM2ZjYTliNmJl
-    NTkwZmFlYTI5ZjNlODUyM2FkODc0ZTVhNzUxMjk4YTBkN2YyMjE=
+    NmU3NjU0YWIwYzAzNDRjYjQzYzAxZmM1ZmQ2ODBlOTMwN2Q1M2MxNDZhMGUx
+    MzhkYTZlNjE5MjZhNWM5ZjQ3NGFjMzYxZGMwOTljZjI4OGI0NGE5YWM2OWQ1
+    ZGJlYjlkNDU0MjhmNmE1NDliODA3ODM1OWQzMTQ5YWJkZTdlZTE=

data/.rubocop.yml

@@ -1,6 +1,7 @@
 AllCops:
   Exclude:
     - vendor/bundle/**/*
+    - .bundle/**/*
 
 inherit_from: .rubocop_todo.yml
 

data/.rubocop_todo.yml

@@ -1,202 +1,57 @@
 # This configuration was generated by `rubocop --auto-gen-config`
-# on 2014-12-09 17:12:22 +0000 using RuboCop version 0.27.1.
+# on 2015-04-12 19:24:55 +0200 using RuboCop version 0.30.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 22
-Lint/AmbiguousRegexpLiteral:
-  Enabled: false
-
-# Offense count: 8
-# Cop supports --auto-correct.
-Lint/DeprecatedClassMethods:
-  Enabled: false
-
-# Offense count: 2
-# Cop supports --auto-correct.
-Lint/StringConversionInInterpolation:
-  Enabled: false
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Lint/UnusedMethodArgument:
-  Enabled: false
-
-# Offense count: 1
-Lint/UselessAccessModifier:
-  Enabled: false
-
-# Offense count: 2
-Lint/UselessAssignment:
-  Enabled: false
-
 # Offense count: 23
 Metrics/AbcSize:
-  Max: 59
+  Max: 38
 
 # Offense count: 2
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 184
+  Max: 127
 
-# Offense count: 6
+# Offense count: 5
 Metrics/CyclomaticComplexity:
-  Max: 10
+  Max: 9
 
-# Offense count: 101
+# Offense count: 92
 # Configuration parameters: AllowURI, URISchemes.
 Metrics/LineLength:
   Max: 157
 
-# Offense count: 26
+# Offense count: 24
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 32
+  Max: 31
 
-# Offense count: 5
+# Offense count: 4
 Metrics/PerceivedComplexity:
   Max: 11
 
-# Offense count: 3
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/BarePercentLiterals:
-  Enabled: false
-
-# Offense count: 1
-Style/CaseEquality:
-  Enabled: false
-
-# Offense count: 1
-# Configuration parameters: IndentWhenRelativeTo, SupportedStyles, IndentOneStep.
-Style/CaseIndentation:
-  Enabled: false
-
-# Offense count: 25
-Style/Documentation:
-  Enabled: false
-
-# Offense count: 1
-Style/DoubleNegation:
-  Enabled: false
-
 # Offense count: 1
 # Cop supports --auto-correct.
-Style/EmptyLines:
-  Enabled: false
-
-# Offense count: 1
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/FormatString:
-  Enabled: false
-
-# Offense count: 4
-# Configuration parameters: AllowedVariables.
-Style/GlobalVars:
-  Enabled: false
-
-# Offense count: 10
-# Configuration parameters: MinBodyLength.
-Style/GuardClause:
+Performance/Sample:
   Enabled: false
 
 # Offense count: 12
-# Configuration parameters: MaxLineLength.
-Style/IfUnlessModifier:
-  Enabled: false
-
-# Offense count: 1
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/IndentHash:
-  Enabled: true
-
-# Offense count: 13
-# Cop supports --auto-correct.
-Style/LeadingCommentSpace:
-  Enabled: false
-
-# Offense count: 7
-# Cop supports --auto-correct.
-Style/NegatedIf:
-  Enabled: false
-
-# Offense count: 7
-# Cop supports --auto-correct.
-Style/Not:
-  Enabled: false
-
-# Offense count: 1
-Style/OneLineConditional:
-  Enabled: false
-
-# Offense count: 79
-# Cop supports --auto-correct.
-# Configuration parameters: PreferredDelimiters.
-Style/PercentLiteralDelimiters:
-  Enabled: false
-
-# Offense count: 3
-# Cop supports --auto-correct.
-Style/Proc:
-  Enabled: false
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/RedundantBegin:
-  Enabled: false
-
-# Offense count: 76
-# Cop supports --auto-correct.
-Style/RedundantSelf:
-  Enabled: false
-
-# Offense count: 1
-Style/RegexpLiteral:
-  MaxSlashes: 2
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/SingleSpaceBeforeFirstArg:
-  Enabled: false
-
-# Offense count: 2
-# Cop supports --auto-correct.
-Style/SpaceAfterComma:
+Style/BarePercentLiterals:
   Enabled: false
 
 # Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/SpaceBeforeBlockBraces:
-  Enabled: false
-
-# Offense count: 5
-# Cop supports --auto-correct.
-Style/SpaceInsideParens:
+Style/CaseEquality:
   Enabled: false
 
 # Offense count: 1
-# Cop supports --auto-correct.
-Style/SpecialGlobalVars:
-  Enabled: false
-
-# Offense count: 15
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/StringLiterals:
+# Configuration parameters: IndentWhenRelativeTo, SupportedStyles, IndentOneStep.
+Style/CaseIndentation:
   Enabled: false
 
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/StringLiteralsInInterpolation:
+# Offense count: 28
+Style/Documentation:
   Enabled: false
-
-# Offense count: 4
-# Cop supports --auto-correct.
-# Configuration parameters: WordRegex.
-Style/WordArray:
-  MinSize: 3

data/.travis.yml

@@ -1,16 +1,21 @@
+sudo: false
 language: ruby
+cache: bundler
 rvm:
  - 1.8.7
  - 1.9.2
  - 1.9.3
  - 2.0.0
  - 2.1.5
- - 2.2.0
+ - 2.2.1
  - ruby-head
 
 before_install:
- - sudo apt-get update -qq
- - sudo apt-get install -qq -y mplayer ffmpeg
+ # stub mplayer/ffmpeg so it looks like they are installed
+ - mkdir ~/bin
+ - touch ~/bin/mplayer ~/bin/ffmpeg
+ - chmod +x ~/bin/mplayer ~/bin/ffmpeg
+ - export PATH=~/bin:$PATH
 
 matrix:
   allow_failures:
@@ -21,7 +26,9 @@ branches:
     - gh-pages
 
 notifications:
-  irc: "chat.freenode.net#lolcommits"
+  irc: chat.freenode.net#lolcommits
+  slack:
+    secure: BkGsQOYMJqW55j94S1QwmR17BkwuTIULKVhwzRdnv37BvVcC17y9KLMo8NH+bcao36XZx9DukXcTyaDQc6tCSlFEbG/FcPUJM8bx9EWjHUoGVg1KdpVu/nVHu+GKosrB41lM3nfJWCnF0TOSnmTXU+bV8Pwkij+L5X+gNyAT2Ns=
 
 deploy:
   provider: rubygems

data/Gemfile

@@ -1,4 +1,4 @@
-source "http://rubygems.org"
+source 'https://rubygems.org'
 
-# Specify your gem's dependencies in lolcommits.gemspec
+# Specify gem dependencies in lolcommits.gemspec
 gemspec

data/Rakefile

@@ -28,7 +28,7 @@ end
 Rake::Task[:build].prerequisites.unshift :fix_permissions
 
 Rake::TestTask.new do |t|
-  t.pattern = 'test/test_*.rb'
+  t.pattern = 'test/*_test.rb'
 end
 
 Rake::FileUtilsExt.verbose(false)
@@ -36,15 +36,15 @@ CUKE_RESULTS = 'results.html'
 CLEAN << CUKE_RESULTS
 Cucumber::Rake::Task.new(:features) do |t|
   optstr = "features --format html -o #{CUKE_RESULTS} --format Fivemat -x"
-  optstr << " --tags @#{ENV["tag"]}" unless ENV["tag"].nil?
-  optstr << " --tags ~@unstable" if ENV["tag"].nil? #ignore unstable tests unless specifying something at CLI
+  optstr << " --tags @#{ENV['tag']}" unless ENV['tag'].nil?
+  optstr << ' --tags ~@unstable' if ENV['tag'].nil? # ignore unstable tests unless specifying something at CLI
   t.cucumber_opts = optstr
   t.fork = false
 end
 
 Rake::RDocTask.new do |rd|
-  rd.main = "README.rdoc"
-  rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
+  rd.main = 'README.rdoc'
+  rd.rdoc_files.include('README.rdoc', 'lib/**/*.rb', 'bin/**/*')
 end
 
 # only run rubocop on platforms where it is supported, sigh
@@ -56,32 +56,24 @@ else
   task :default => [:test, :features]
 end
 
-
-desc "Migrate an existing local .lolcommits directory to Dropbox"
+desc 'Migrate an existing local .lolcommits directory to Dropbox'
 task :dropboxify do
-  $home = ENV['HOME']
-  dropbox_loldir = "#{$home}/Dropbox/lolcommits"
-  loldir = "#{$home}/.lolcommits"
-  backup_loldir = "#{$home}/.lolcommits.old"
-
-  #check whether we've done this already
-  if File.symlink? loldir
-    abort "already dropboxified!"
-  end
-
-  #create dropbox folder
-  if not File.directory? dropbox_loldir
-    FileUtils.mkdir_p dropbox_loldir
-  end
-
-  #backup existing loldir
-  if File.directory? loldir
-    FileUtils.mv( loldir, backup_loldir )
-  end
-
-  #symlink dropbox to local
-  FileUtils.ln_s( dropbox_loldir, loldir )
-
-  #copy over existing files
-  FileUtils.cp_r( "#{backup_loldir}/.", loldir)
+  dropbox_loldir = "#{ENV['HOME']}/Dropbox/lolcommits"
+  loldir = "#{ENV['HOME']}/.lolcommits"
+  backup_loldir = "#{ENV['HOME']}/.lolcommits.old"
+
+  # check whether we've done this already
+  abort 'already dropboxified!' if File.symlink? loldir
+
+  # create dropbox folder
+  FileUtils.mkdir_p dropbox_loldir unless File.directory? dropbox_loldir
+
+  # backup existing loldir
+  FileUtils.mv(loldir, backup_loldir) if File.directory? loldir
+
+  # symlink dropbox to local
+  FileUtils.ln_s(dropbox_loldir, loldir)
+
+  # copy over existing files
+  FileUtils.cp_r("#{backup_loldir}/.", loldir)
 end

data/bin/lolcommits

@@ -8,71 +8,32 @@ rescue LoadError
   require 'lolcommits'
 end
 
+require 'lolcommits/cli/fatals'
+require 'lolcommits/cli/launcher'
+require 'lolcommits/cli/process_runner'
+require 'lolcommits/cli/timelapse_gif'
+
 include Lolcommits
-require 'launchy'
-require 'choice'
+include Lolcommits::CLI
 
+require 'choice'
 require 'methadone'
 include Methadone::CLILogging
 
-#
-# CHECK FOR FURTHER DEPENDENCIES
-#
-
-def die_on_fatal_conditions!
-  if Configuration.platform_mac?
-    %w(imagesnap videosnap).each do |executable|
-      unless File.executable? File.join(Configuration::LOLCOMMITS_ROOT, 'vendor', 'ext', executable, executable)
-        fatal "Couldn't properly execute #{executable} for some reason, please file a bug?!"
-        exit 1
-      end
-    end
-  elsif Configuration.platform_linux?
-    if not Configuration.command_which('mplayer')
-      fatal "Couldn't find mplayer in your PATH!"
-      exit 1
-    end
-  end
-  unless File.readable? File.join(Configuration::LOLCOMMITS_ROOT, 'vendor', 'fonts', 'Impact.ttf')
-    fatal "Couldn't properly read Impact font from gem package, please file a bug?!"
-    exit 1
-  end
-  if !Configuration.valid_ffmpeg_installed? && capture_animate
-    fatal 'FATAL: ffmpeg does not appear to be properly installed!'
-    exit 1
-  end
-  unless Configuration.valid_imagemagick_installed?
-    fatal 'FATAL: ImageMagick does not appear to be properly installed!'
-    exit 1
-  end
-  if Configuration.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 "Try setting it to 'auto' instead!"
-    exit 1
-  end
-end
-
-def die_if_not_git_repo!
-  begin
-    debug 'Checking for valid git repo'
-    g = Git.open('.')
-  rescue ArgumentError
-    # ruby-git throws an argument error if path isnt for a valid git repo...
-    fatal "Erm? Can't do that since we're not in a valid git repository!"
-    exit 1
-  end
-end
-
 #
 # NO ARGUMENTS SPECIFIED, HELP THE USER OUT
 #
 def do_noargs
-  # TODO: make this a contextual helper to know status of whether lolcommits is enabled
+  # TODO: make this a contextual helper to know whether lolcommits is enabled
   puts 'Do what exactly?'
   puts 'Try: lolcommits --enable   (when in a git repository)'
   puts 'Or:  lolcommits --help'
 end
 
+# Gets a configuration object.  If running in test mode will override the
+# LOLDIR for the configuration.
+#
+# @return [Lolcommits::Configuration]
 def configuration
   if Choice.choices[:test]
     Configuration.new(:loldir => Configuration.loldir_for('test'))
@@ -81,18 +42,26 @@ def configuration
   end
 end
 
+# Duration for animated capture.
+#
+# If animation is enabled, returns an integer representing seconds OR a string
+# containing the char representation of an integer.
+# If animation is disabled, or if the platform doesn't support animated capture,
+# returns nil instead.
+#
+# FIXME: we really should standardize this to always return integer, and remove
+#   all the to_i calls elsewhere.
+#
+# @return [Integer, String, nil]
 def capture_animate
-  if Configuration.can_animate?
-    Choice.choices[:animate] || ENV['LOLCOMMITS_ANIMATE'] || nil
-  end
+  return unless Platform.can_animate?
+  Choice.choices[:animate] || ENV['LOLCOMMITS_ANIMATE'] || nil
 end
 
 def default_device
   result = Choice.choices[:device] || ENV['LOLCOMMITS_DEVICE']
 
-  if Configuration.platform_linux?
-    result ||= Dir.glob('/dev/video*').first
-  end
+  result ||= Dir.glob('/dev/video*').first if Platform.platform_linux?
 
   result
 end
@@ -101,10 +70,10 @@ end
 # IF --CAPTURE, DO CAPTURE
 #
 def do_capture
-  capture_delay   = Choice.choices[:delay]    || ENV['LOLCOMMITS_DELAY']    || 0
-  capture_stealth = Choice.choices[:stealth]  || ENV['LOLCOMMITS_STEALTH']  || nil
+  capture_delay   = Choice.choices[:delay] || ENV['LOLCOMMITS_DELAY'] || 0
+  capture_stealth = Choice.choices[:stealth] || ENV['LOLCOMMITS_STEALTH'] || nil
+  capture_font    = Choice.choices[:font] || ENV['LOLCOMMITS_FONT'] || nil
   capture_device  = default_device
-  capture_font    = Choice.choices[:font]     || ENV['LOLCOMMITS_FONT']     || nil
 
   capture_options = {
     :capture_delay   => capture_delay,
@@ -115,7 +84,9 @@ def do_capture
     :config          => configuration
   }
 
-  fork_me? do
+  process_runner = ProcessRunner.new(configuration)
+  should_we_fork = Choice.choices[:fork] || ENV['LOLCOMMITS_FORK']
+  process_runner.fork_me?(should_we_fork) do
     if Choice.choices[:test]
       info '*** Capturing in test mode.'
 
@@ -125,11 +96,12 @@ def do_capture
         :sha     => Choice.choices[:sha]
       }
 
+      # fire off runner with the overriden fake commit metadata
       runner = Lolcommits::Runner.new(capture_options.merge override_text)
       runner.run
 
-      # automatically open so the user can see the test image results immediately
-      Launchy.open(runner.main_image)
+      # automatically open so user can see the test image results immediately
+      Launcher.open_image(runner.main_image)
     else
       runner = Lolcommits::Runner.new(capture_options)
       runner.run
@@ -137,69 +109,19 @@ def do_capture
   end
 end
 
-def fork_me?(&block)
-  if Choice.choices[:fork] || ENV['LOLCOMMITS_FORK']
-    $stdout.sync = true
-    write_pid fork {
-      yield block
-      delete_pid
-    }
-  else
-    yield block
-  end
-end
-
-def write_pid(pid)
-  File.open(pid_file, 'w') { |f| f.write(pid) }
-end
-
-def delete_pid
-  File.delete(pid_file) if File.exist?(pid_file)
-end
-
-def pid_file
-  File.join(configuration.loldir, 'lolcommits.pid')
-end
-
 def do_configure
+  $stdout.sync = true
   configuration.do_configure! Choice.choices[:plugin]
 end
 
 def do_last
-  die_if_not_git_repo!
+  Fatals.die_if_not_git_repo!
   lolimage = configuration.most_recent
   if lolimage.nil?
     warn 'No lolcommits have been captured for this repository yet.'
     exit 1
   end
-  Launchy.open lolimage
-end
-
-def do_gif
-  die_if_not_git_repo!
-
-  case Choice.choices[:gif]
-    when 'today'
-      lolimages = configuration.jpg_images_today
-      filename  = "#{Date.today.to_s}.gif"
-    else
-      lolimages = configuration.jpg_images
-      filename  = 'archive.gif'
-  end
-
-  if lolimages.empty?
-    warn 'No lolcommits have been captured for this time yet.'
-    exit 1
-  end
-
-  puts '*** Generating animated gif.'
-
-  gif = MiniMagick::Image.new File.join configuration.archivedir, filename
-
-  # This is for ruby 1.8.7, *lolimages just doesn't work with ruby 187
-  gif.run_command('convert', *['-delay', '50', '-loop', '0', lolimages, "#{gif.path}"].flatten)
-
-  puts "*** #{gif.path} generated."
+  Launcher.open_image(lolimage)
 end
 
 def print_version_and_exit
@@ -219,11 +141,18 @@ def change_dir_to_root_or_repo!
   end
 end
 
+# FIXME: this should be moved out of the CLI, but to where?
+def load_local_plugins!
+  plugins_dir = Configuration.loldir_for('.plugins')
+  Dir.glob("#{plugins_dir}/*.rb").each do |plugin|
+    load plugin
+  end
+end
+
 #
 # Command line parsing fun
 #
 Choice.options do
-
   option :version do
     long '--version'
     short '-v'
@@ -270,7 +199,7 @@ Choice.options do
 
   option :show_config do
     short '-sc'
-    long  '--show-config'
+    long '--show-config'
     desc 'display configuration file'
   end
 
@@ -344,7 +273,7 @@ Choice.options do
     desc 'generate animated timeline gif from captured images'
   end
 
-  if Configuration.can_animate?
+  if Platform.can_animate?
     option :animate do
       long '--animate=SECONDS'
       short '-a'
@@ -369,17 +298,23 @@ end
 #
 # check for fatal conditions before execution
 #
-die_on_fatal_conditions!
+Fatals.die_if_no_valid_ffmpeg_installed! if capture_animate
+Fatals.die_on_fatal_platform_conditions!
 
 #
 # change working dir to either a repo or the fs root
 #
 change_dir_to_root_or_repo!
 
+#
+# load system local plugins
+#
+load_local_plugins!
+
 #
 # Handle actions manually since choice seems weird
 #
-if not (Choice.choices[:enable] || Choice.choices[:disable])
+if !Choice.choices[:enable] || !Choice.choices[:disable]
   if Choice.choices[:capture]
     do_capture
   elsif Choice.choices[:configure]
@@ -389,14 +324,16 @@ if not (Choice.choices[:enable] || Choice.choices[:disable])
   elsif Choice.choices[:plugins]
     configuration.puts_plugins
   elsif Choice.choices[:devices]
-    configuration.puts_devices
+    puts Platform.device_list
+    puts "Specify a device with --device=\"{device name}\" "\
+         'or set the LOLCOMMITS_DEVICE env variable'
   elsif Choice.choices[:last]
     do_last
   elsif Choice.choices[:browse]
-    die_if_not_git_repo!
-    Launchy.open configuration.loldir
+    Fatals.die_if_not_git_repo!
+    Launcher.open_folder(configuration.loldir)
   elsif Choice.choices[:gif]
-    do_gif
+    TimelapseGif.new(configuration).run(Choice.choices[:gif])
   else
     do_noargs
   end