lolcommits 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 94ae90ded5c3704ad9da445343644d55d9abb751
-  data.tar.gz: 953a29473f91750e4a3f20684dbd0d5f49483e1b
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MGUzMzkwYmFhNGQyYjE3ZDY3ZjhjZDlhOGZhZTIzMzYzMGMyYzAxYw==
+  data.tar.gz: !binary |-
+    NzE4NTQ1Y2E3ZDM4NTQzYzIyMjYzNzI0NGViMjQ2ZDU0ZDEwZjcxNg==
 SHA512:
-  metadata.gz: 18726391ce18363965e49b46dfca8a41c721c070b2be1941d38ee0350d49f42ff2f84cab2848652b50f6a3146de6eed7e5f78e55078bd75f7b6d59074b82bff6
-  data.tar.gz: 947127f66fe9ce7a9b2d047c4886ac1344c3cece6db70d951c22e4e20d401170cdc541e06e6fe124d0f2b2e0bf588cf89711b6cc84bc14ac7378bb0d980668ba
+  metadata.gz: !binary |-
+    N2NlZTFiMGJmOGU0NTk3ZTdiMDVlNTI1ZTY4ZWFlNGJjZDIwYzI3MTk4NDVl
+    Y2UxZWM2N2Y0MjE1OGE4YWZmMWMxMjYxNzIxMzVkZTJkNzQ1ZDVmZWExNDM3
+    M2JjZmFjODUyMjU4Y2I5NWM1N2NmNTIzMWIxNWI0ZDJlNGFmNzA=
+  data.tar.gz: !binary |-
+    N2RjMjRhYWQwOWVjZThhNzg5OTMwNmJiNDY0Njk2ZWM0M2M2Y2YyMDQ3MDcz
+    MjU4MzU1OTJlNzEyYjg4ZTdiNmI4NGI1ZGYyYTA5NjRiMzE0OGNmOGY3MmE3
+    ZjMwYmMxMGYxMjgyMjBjMmUzZjViMmMzNmYyYjZmYjNlY2Y2ODc=

data/.editorconfig

@@ -0,0 +1,17 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

data/.gitattributes

@@ -0,0 +1 @@
+* text=auto

data/.rubocop.yml

@@ -0,0 +1,5 @@
+inherit_from: rubocop-todo.yml
+
+# Enforce Ruby 1.8.7 compatible syntax
+HashSyntax:
+  EnforcedStyle: hash_rockets

data/.travis.yml

@@ -4,8 +4,12 @@ rvm:
  - 1.9.2
  - 1.9.3
  - 2.0.0
+ - 2.1.0
 
 before_install:
+ # use earlier version of Rubygems to avoid fatal bundler error on 1.8.7
+ - gem update --system 2.1.11
+ - gem --version
  - sudo apt-get update -qq
  - sudo apt-get install -qq -y mplayer
  - sudo apt-get install ffmpeg

data/CHANGELOG

@@ -1,6 +1,17 @@
 0.x.x (in development)
   * TODO: figure out problems with GUI clients
 
+0.5.3 (30 March 2014)
+  * Fixed permissions on CommandCam (755) for cygwin (@matthutchinson)
+  * Added `--devices` option, mac only for now (@matthutchinson #183, #174)
+  * Replace http with https in twitter plugin (@kleinschmidt #195)
+  * RuboCop gem added for development (@mroth #194)
+  * Added optional key to uploldz plugin (@Numan1617 #192)
+  * Fixed lolcommmits typo: too much mmm (@penyaskito #189)
+  * Work when in subdirectory of a git repo (@ilkka #186)
+  * Added --version (-v) flag (@bfontaine #184)
+  * Send more VCS details to lolsrv (@drewwells #181)
+
 0.5.2 (5 December 2013)
   * Allow lolsrv plugin to sync/upload gifs (@matthutchinson #180)
   * Plugins refactor, can now configure themselves (@matthutchinson #179)

data/CONTRIBUTING

@@ -8,4 +8,6 @@ GUIDELINES FOR CONTRIBUTING
 
 You can run the existing test-suite via `rake`.  Ensure nothing is broken, but since the test since is far from complete, it'd be awesome if you manually tested for regressions as well.
 
-Please, if at all possible, write a passing test for the functionality you added.
+Please, if at all possible, write a passing test for the functionality you added.
+
+The default rake task uses Rubocop on default settings to ensure Ruby Style Guidelines.  If you want to run tests before conforming to this to verify functionality you can just run `rake test` and `rake features` manually.

data/README.md

@@ -75,7 +75,7 @@ Or they can be set via the following arguments in the capture command (located i
 * `--fork`
 * `--stealth`
 
-Read how to [configure commit capturing](https://github.com/mroth/lolcommits/wiki/Configure-Commit-Capturing) for more details.
+Use `lolcommits --devices` to list all attached video devices available for capturing. Read how to [configure commit capturing](https://github.com/mroth/lolcommits/wiki/Configure-Commit-Capturing) for more details.
 
 ### Animated Gif Capturing
 Animated gifs (Mac/OSX only) can take a while to generate (depending on the number of seconds you capture and the capabilities of your machine). `ffmpeg` is required and can be installed with brew like so;

data/Rakefile

@@ -16,7 +16,13 @@ task :fix_permissions do
   # Reset all permissions.
   system 'bash -c "find . -type f -exec chmod 644 {} \; && find . -type d -exec chmod 755 {} \;"'
   # Executable files.
-  system 'bash -c "chmod +x ./bin/* vendor/ext/imagesnap/imagesnap vendor/ext/videosnap/videosnap"'
+  executables = %w(
+    vendor/ext/imagesnap/imagesnap
+    vendor/ext/videosnap/videosnap
+    vendor/ext/CommandCam/CommandCam.exe
+  )
+
+  system "bash -c \"chmod +x ./bin/* #{executables.join(' ')}\""
 end
 
 Rake::Task[:build].prerequisites.unshift :fix_permissions
@@ -37,14 +43,18 @@ Cucumber::Rake::Task.new(:features) do |t|
 end
 
 Rake::RDocTask.new do |rd|
-  
   rd.main = "README.rdoc"
-  
   rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
 end
 
-task :default => [:test,:features]
-
+# only run rubocop on platforms where it is supported, sigh
+if RUBY_VERSION >= '1.9.2'
+  require 'rubocop/rake_task'
+  Rubocop::RakeTask.new
+  task :default => [:rubocop,:test,:features]
+else
+  task :default => [:test,:features]
+end
 
 
 desc "Migrate an existing local .lolcommits directory to Dropbox"
@@ -53,25 +63,25 @@ task :dropboxify do
   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)
 end

data/bin/lolcommits

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# -*- encoding: utf-8 -*-
 
 begin
   require 'lolcommits'
@@ -8,8 +9,8 @@ rescue LoadError
 end
 
 include Lolcommits
-require "launchy"
-require "choice"
+require 'launchy'
+require 'choice'
 
 require 'methadone'
 include Methadone::CLILogging
@@ -19,29 +20,29 @@ include Methadone::CLILogging
 #
 
 def die_on_fatal_conditions!
-  if Configuration.is_mac?
+  if Configuration.platform_mac?
     %w(imagesnap videosnap).each do |executable|
-      unless File.executable? File.join(Configuration::LOLCOMMITS_ROOT, "vendor", "ext", executable, 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.is_linux?
+  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")
+  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!"
+    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!"
+    fatal 'FATAL: ImageMagick does not appear to be properly installed!'
     exit 1
   end
   if Configuration.git_config_color_always?
@@ -53,8 +54,8 @@ end
 
 def die_if_not_git_repo!
   begin
-    debug "Checking for valid git repo"
-    g=Git.open('.')
+    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!"
@@ -62,115 +63,14 @@ def die_if_not_git_repo!
   end
 end
 
-def good_shebang?
-  File.read(HOOK_PATH).lines.first =~ /^\#\!\/bin\/.*sh/
-end
-
-def lolcommits_hook?
-  File.exists?(HOOK_PATH) &&
-    File.read(HOOK_PATH).to_s =~ /lolcommits.*\(begin\)(.*\n)*.*lolcommits.*\(end\)/
-end
-
-def remove_existing_hook
-  hook = File.read(HOOK_PATH)
-  out  = File.open(HOOK_PATH, 'w')
-  skip = false
-
-  hook.lines.each do |line|
-    if !skip && (line =~ /lolcommits.*\(begin\)/)
-      skip = true
-    end
-
-    out << line unless skip
-
-    if skip && (line =~ /lolcommits.*\(end\)/)
-      skip = false
-    end
-  end
-
-  out.close
-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
-  puts "Do what exactly?"
-  puts "Try: lolcommits --enable   (when in a git repository)"
-  puts "Or:  lolcommits --help"
-end
-
-HOOK_PATH = File.join ".git", "hooks", "post-commit"
-HOOK_DIR = File.join ".git", "hooks"
-
-#
-# IF --ENABLE, DO ENABLE
-#
-def do_enable
-  if not File.directory?(".git")
-    fatal "You don't appear to be in the base directory of a git project."
-    exit 1
-  end
-
-  #its possible a hooks dir doesnt exist, so create it if so
-  if not File.directory?(HOOK_DIR)
-    Dir.mkdir(HOOK_DIR)
-  end
-
-  # clear away any existing lolcommits hook
-  if hook_exists = File.exists?(HOOK_PATH)
-    remove_existing_hook
-
-    # check for a good shebang line in the existing hook
-    unless good_shebang?
-      warn "the existing hook (at #{HOOK_PATH}) doesn't start with with a good shebang; like #!/bin/sh"
-      exit 1
-    end
-  end
-
-  File.open(HOOK_PATH, hook_exists ? 'a' : 'w') do |f|
-    f.write(hook_script(!hook_exists))
-  end
-
-  FileUtils.chmod 0755, HOOK_PATH
-
-  info "installed lolcommmit hook to:"
-  info "  -> #{File.expand_path(HOOK_PATH)}"
-  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
-
-def hook_script(add_shebang = true)
-  shebang      = add_shebang ? "#!/bin/sh\n\n" : ''
-  ruby_path    = Lolcommits::Configuration.command_which('ruby')
-  hook_export  = "export PATH=\"#{ruby_path}:$PATH\"\n" if ruby_path
-  capture_cmd  = 'lolcommits --capture'
-  capture_args = " #{ARGV[1..-1].join(' ')}" if ARGV.length > 1
-
-  <<-EOS
-#{shebang}### lolcommits hook (begin) ###
-#{hook_export}#{capture_cmd}#{capture_args}
-###  lolcommits hook (end)  ###
-EOS
-end
-
-#
-# IF --DISABLE, DO DISABLE
-#
-def do_disable
-  if lolcommits_hook?
-    remove_existing_hook
-    info "uninstalled lolcommits hook (from #{HOOK_PATH})"
-  elsif File.exists?(HOOK_PATH)
-    info "couldn't find an lolcommits hook (at #{HOOK_PATH})"
-    if File.read(HOOK_PATH) =~ /lolcommit/
-      info "warning: an older-style lolcommit hook may still exist, edit #{HOOK_PATH} to remove it manually"
-    end
-  else
-    info "no post commit hook found (at #{HOOK_PATH}), so there is nothing to uninstall"
-  end
+  # TODO: make this a contextual helper to know status of whether lolcommits is enabled
+  puts 'Do what exactly?'
+  puts 'Try: lolcommits --enable   (when in a git repository)'
+  puts 'Or:  lolcommits --help'
 end
 
 def configuration
@@ -191,14 +91,14 @@ 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_device  = Choice.choices[:device] || ENV['LOLCOMMITS_DEVICE'] || nil
-  capture_font    = Choice.choices[:font] || ENV['LOLCOMMITS_FONT'] || nil
+  capture_delay   = Choice.choices[:delay]    || ENV['LOLCOMMITS_DELAY']    || 0
+  capture_stealth = Choice.choices[:stealth]  || ENV['LOLCOMMITS_STEALTH']  || nil
+  capture_device  = Choice.choices[:device]   || ENV['LOLCOMMITS_DEVICE']   || nil
+  capture_font    = Choice.choices[:font]     || ENV['LOLCOMMITS_FONT']     || nil
 
   fork_me? do
     if Choice.choices[:test]
-      info "*** Capturing in test mode."
+      info '*** Capturing in test mode.'
       runner = Lolcommits::Runner.new(
         :capture_delay   => capture_delay,
         :capture_stealth => capture_stealth,
@@ -258,7 +158,7 @@ def do_last
   die_if_not_git_repo!
   lolimage = configuration.most_recent
   if lolimage.nil?
-    warn "No lolcommits have been captured for this repository yet."
+    warn 'No lolcommits have been captured for this repository yet.'
     exit 1
   end
   Launchy.open lolimage
@@ -268,154 +168,183 @@ def do_gif
   die_if_not_git_repo!
 
   case Choice.choices[:gif]
-    when "today"
+    when 'today'
       lolimages = configuration.images_today
       filename  = "#{Date.today.to_s}.gif"
     else
       lolimages = configuration.images
-      filename  = "archive.gif"
+      filename  = 'archive.gif'
   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 gif."
+  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)
+  gif.run_command('convert', *['-delay', '50', '-loop', '0', lolimages, "#{gif.path}"].flatten)
 
   puts "*** #{gif.path} generated."
 end
 
+def print_version_and_exit
+  puts Lolcommits::VERSION
+  exit 0
+end
+
+def change_dir_to_root_or_repo!
+  debug 'Walking up dir tree'
+  loop do
+    cur = File.expand_path('.')
+    nxt = File.expand_path('..', cur)
+    if File.directory?(File.expand_path('.git')) || nxt == cur
+      return # found root or git dir
+    end
+    Dir.chdir(nxt)
+  end
+end
+
 #
 # Command line parsing fun
 #
 Choice.options do
 
+  option :version do
+    long '--version'
+    short '-v'
+    desc 'print version and exit'
+    action { print_version_and_exit }
+  end
+
   option :enable do
-    long "--enable"
+    long '--enable'
     short '-e'
-    action { do_enable }
-    desc "install lolcommits for this repo"
+    action { Installation.do_enable }
+    desc 'install lolcommits for this repo'
   end
 
   option :disable do
-    long "--disable"
+    long '--disable'
     short '-d'
-    action { do_disable }
-    desc "uninstall lolcommits for this repo"
+    action { Installation.do_disable }
+    desc 'uninstall lolcommits for this repo'
   end
 
   option :capture do
-    long "--capture"
+    long '--capture'
     short '-c'
-    desc "capture lolcommit based on last git commit"
+    desc 'capture lolcommit based on last git commit'
   end
 
   option :last do
-    long "--last"
-    short "-l"
-    desc "view the most recent lolcommit"
+    long '--last'
+    short '-l'
+    desc 'view the most recent lolcommit'
   end
 
   option :browse do
-    long "--browse"
-    short "-b"
+    long '--browse'
+    short '-b'
     desc "browse this repo's lolcommits"
   end
 
   option :configure do
-    long "--config"
-    desc "configure a plugin"
+    long '--config'
+    desc 'configure a plugin'
   end
 
   option :show_config do
-    short "-sc"
-    long  "--show-config"
-    desc "display configuration file"
+    short '-sc'
+    long  '--show-config'
+    desc 'display configuration file'
   end
 
   option :plugin do
-    desc "pass plugin name for --config"
-    long "--plugin"
-    short "-p"
+    desc 'pass plugin name for --config'
+    long '--plugin'
+    short '-p'
     default nil
   end
 
   option :plugins do
-    desc "list all available plugins"
-    long "--plugins"
+    desc 'list all available plugins'
+    long '--plugins'
   end
 
   option :test do
-    long "--test"
-    desc "Run in test mode"
+    long '--test'
+    desc 'Run in test mode'
   end
 
   option :sha do
-    desc "pass SHA manually [TEST-MODE]"
-    long "--sha"
+    desc 'pass SHA manually [TEST-MODE]'
+    long '--sha'
     short '-s'
-    default "test-#{rand(10 ** 10)}"
+    default "test-#{rand(10**10)}"
   end
 
   option :msg do
-    desc "pass commit msg manually [TEST-MODE]"
-    long "--msg"
+    desc 'pass commit msg manually [TEST-MODE]'
+    long '--msg'
     short '-m'
-    default "this is a test message i didnt really commit something"
+    default 'this is a test message i didnt really commit something'
   end
 
   option :delay do
-    long "--delay=SECONDS"
-    desc "delay taking of the snapshot by n seconds"
+    long '--delay=SECONDS'
+    desc 'delay taking of the snapshot by n seconds'
     cast Integer
     short '-w'
   end
 
   option :stealth do
-    long "--stealth"
-    desc "capture image in stealth mode"
+    long '--stealth'
+    desc 'capture image in stealth mode'
   end
 
   option :device do
-    long "--device=DEVICE"
-    desc "the device name used to take the snapshot (only mac/linux)"
+    long '--device=DEVICE'
+    desc 'the device name used to take the snapshot (mac/linux only)'
+  end
+
+  option :devices do
+    long '--devices'
+    desc 'list all video devices available (mac only)'
   end
 
   option :debug do
-    long "--debug"
-    desc "Output debugging information"
+    long '--debug'
+    desc 'output debugging information'
   end
 
   option :font do
-    long "--font=FONT_PATH"
-    short "-f"
-    desc "pass font file location"
+    long '--font=FONT_PATH'
+    short '-f'
+    desc 'pass font file location'
   end
 
   option :gif do
-    long "--gif"
-    short "-g"
-    desc "generate animated timeline gif from captured images"
+    long '--gif'
+    short '-g'
+    desc 'generate animated timeline gif from captured images'
   end
 
   if Configuration.can_animate?
     option :animate do
-      long "--animate=SECONDS"
-      short "-a"
+      long '--animate=SECONDS'
+      short '-a'
       cast Integer
-      desc "enable animated gif captures with duration (seconds)"
+      desc 'enable animated gif captures with duration (seconds)'
     end
   end
 
   option :fork do
-    long "--fork"
-    desc "fork the lolcommits runner to the background"
+    long '--fork'
+    desc 'fork the lolcommits runner to the background'
   end
 end
 
@@ -423,7 +352,7 @@ end
 debug_mode = Choice.choices[:debug] || ENV['LOLCOMMITS_DEBUG'] || nil
 if debug_mode
   logger.level = Logger::DEBUG
-  debug "Outputting at DEBUG verbosity"
+  debug 'Outputting at DEBUG verbosity'
 end
 
 #
@@ -431,26 +360,33 @@ end
 #
 die_on_fatal_conditions!
 
+#
+# change working dir to either a repo or the fs root
+#
+change_dir_to_root_or_repo!
+
 #
 # Handle actions manually since choice seems weird
 #
 if not (Choice.choices[:enable] || Choice.choices[:disable])
   if Choice.choices[:capture]
-    do_capture()
+    do_capture
   elsif Choice.choices[:configure]
-    do_configure()
+    do_configure
   elsif Choice.choices[:show_config]
     puts configuration
   elsif Choice.choices[:plugins]
-    configuration.puts_plugins()
+    configuration.puts_plugins
+  elsif Choice.choices[:devices]
+    configuration.puts_devices
   elsif Choice.choices[:last]
-    do_last()
+    do_last
   elsif Choice.choices[:browse]
     die_if_not_git_repo!
     Launchy.open configuration.loldir
   elsif Choice.choices[:gif]
-    do_gif()
+    do_gif
   else
-    do_noargs()
+    do_noargs
   end
 end