lolcommits 0.4.0 → 0.4.1pre1

data/CHANGELOG

@@ -1,3 +1,8 @@
+0.4.1 (in development)
+  * add lolsrv plugin
+  * restructure logging slightly to use Methadone::CLILogging in most places
+  * add a bunch of debugging output, viewable via --debug flag
+
 0.4.0 (13 January 2013)
   * Switch the main ImageMagick wrapper from RMagick to mini_magick
     - fix for RMagick not working with ImageMagick 6.8+ and generally

data/bin/lolcommits

@@ -11,6 +11,9 @@ include Lolcommits
 require "launchy"
 require "choice"
 
+require 'methadone'
+include Methadone::CLILogging
+
 #
 # CHECK FOR FURTHER DEPENDENCIES
 #
@@ -23,26 +26,27 @@ end
 
 if Configuration.is_mac?
   unless File.executable? File.join(Configuration::LOLCOMMITS_ROOT, "vendor", "ext", "imagesnap", "imagesnap")
-    puts "Couldn't properly execute imagesnap for some reason, please file a bug?!"
+    fatal "Couldn't properly execute imagesnap for some reason, please file a bug?!"
     exit 1
   end
 elsif Configuration.is_linux?
   if not command?('mplayer')
-    puts "Couldn't find mplayer in your PATH!"
+    fatal "Couldn't find mplayer in your PATH!"
     exit 1
   end
 end
 unless File.readable? File.join(Configuration::LOLCOMMITS_ROOT, "vendor", "fonts", "Impact.ttf")
-  puts "Couldn't properly read Impact font from gem package, please file a bug?!"
+  fatal "Couldn't properly read Impact font from gem package, please file a bug?!"
   exit 1
 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...
-    puts "Erm? Can't do that since we're not in a valid git repository!"
+    fatal "Erm? Can't do that since we're not in a valid git repository!"
     exit 1
   end
 end
@@ -65,7 +69,7 @@ HOOK_DIR = File.join ".git", "hooks"
 #
 def do_enable
   if not File.directory?(".git")
-    puts "You don't appear to be in the base directory of a git project."
+    fatal "You don't appear to be in the base directory of a git project."
     exit 1
   end
 
@@ -75,7 +79,7 @@ def do_enable
   end
 
   if File.exists? HOOK_PATH
-    puts "A post-commit hook already exists for this project."
+    fatal "A post-commit hook already exists for this project."
     #TODO: disambiguate between OUR post-commit hook and something else
     exit 1
   end
@@ -83,9 +87,9 @@ def do_enable
   doc = "#!/bin/sh\nlolcommits --capture\n"
   File.open(HOOK_PATH, 'w') {|f| f.write(doc) }
   FileUtils.chmod 0755, HOOK_PATH
-  puts "installed lolcommmit hook as:"
-  puts "  -> #{File.expand_path(HOOK_PATH)}"
-  puts "(to remove later, you can use: lolcommits --disable)"
+  info "installed lolcommmit hook as:"
+  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
@@ -97,9 +101,9 @@ def do_disable
   if File.exists? HOOK_PATH
     #TODO: check if hook file has been modified before removing
     FileUtils.rm HOOK_PATH
-    puts "removed #{HOOK_PATH}"
+    info "removed #{HOOK_PATH}"
   else
-    puts "lolcommits is not enabled for this directory, so there is nothing to uninstall."
+    info "lolcommits is not enabled for this directory, so there is nothing to uninstall."
   end
 end
 
@@ -119,7 +123,7 @@ def do_capture
   capture_device = Choice.choices[:device] || ENV['LOLCOMMITS_DEVICE'] || nil
 
   if Choice.choices[:test]
-    puts "*** Capturing in test mode."
+    info "*** Capturing in test mode."
     runner = Lolcommits::Runner.new(:capture_delay => capture_delay,
       :capture_device => capture_device,
       :message        => Choice.choices[:msg],
@@ -146,7 +150,7 @@ def do_last
   die_if_not_git_repo!
   lolimage = configuration.most_recent
   if lolimage.nil?
-    puts "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
@@ -242,6 +246,19 @@ Choice.options do
     long "--device=DEVICE"
     desc "the device name used to take the snapshot (only mac)"
   end
+
+  option :debug do
+    long "--debug"
+    desc "Output debugging information"
+  end
+
+end
+
+# Set debug level if needed
+debug_mode = Choice.choices[:debug] || ENV['LOLCOMMITS_DEBUG'] || nil
+if debug_mode
+  logger.level = Logger::DEBUG
+  debug "Outputting at DEBUG verbosity"
 end
 
 #

data/features/plugins.feature

@@ -22,3 +22,15 @@ Feature: Plugins Work
     When I do a git commit
     Then the output should contain "*** Preserving this moment in history."
     And there should be exactly 1 jpg in "../.lolcommits/loltext"
+
+  Scenario: lolsrv integration works
+    Given I am in a git repository named "lolsrv" with lolcommits enabled
+    When I run `lolcommits --config` and wait for output
+    And I enter "lolsrv" for "Plugin Name"
+    And I enter "true" for "enabled"
+    And I enter "http://localhost" for "server"
+    Then I should be presented "Successfully Configured"
+    When I do a git commit
+    Then the output should contain "*** Preserving this moment in history."
+    And there should be exactly 1 jpg in "../.lolcommits/lolsrv"
+    

data/lib/lolcommits.rb

@@ -8,6 +8,7 @@ require 'open3'
 require 'active_support/inflector'
 require 'active_support/concern'
 require 'active_support/callbacks'
+require 'methadone'
 
 require 'lolcommits/version'
 require 'lolcommits/configuration'
@@ -24,6 +25,7 @@ require 'lolcommits/plugins/tranzlate'
 require 'lolcommits/plugins/statsd'
 require 'lolcommits/plugins/lol_twitter'
 require 'lolcommits/plugins/uploldz'
+require 'lolcommits/plugins/lolsrv'
 
 # require runner after all the plugins have been required
 require 'lolcommits/runner'

data/lib/lolcommits/capture_linux.rb

@@ -1,16 +1,25 @@
 module Lolcommits
   class CaptureLinux < Capturer
     def capture
+      debug "LinuxCapturer: making tmp directory"
       tmpdir = Dir.mktmpdir
+
       # There's no way to give a capture delay in mplayer, but a number of frame
       # I've found that 6 is a good value for me.
       frames = if capture_delay != 0 then capture_delay else 6 end
 
+      debug "LinuxCapturer: calling out to mplayer to capture image"
       # mplayer's output is ugly and useless, let's throw it away
       _, r, _ = Open3.popen3("mplayer -vo jpeg:outdir=#{tmpdir} -frames #{frames} tv://")
       # looks like we still need to read the output for something to happen
       r.read
+
+      # the below SHOULD tell FileUtils actions to post their output if we are in debug mode
+      include FileUtils::Verbose if logger.level == 0
+
+      debug "LinuxCapturer: calling out to mplayer to capture image"
       FileUtils.mv(tmpdir + "/%08d.jpg" % frames, snapshot_location)
+      debug "LinuxCapturer: cleaning up"
       FileUtils.rm_rf( tmpdir )
     end
 

data/lib/lolcommits/capture_mac.rb

@@ -5,7 +5,9 @@ module Lolcommits
     end
 
     def capture
-      system("#{imagesnap_bin} -q \"#{snapshot_location}\" -w #{capture_delay} #{capture_device_string}")
+      call_str = "#{imagesnap_bin} -q \"#{snapshot_location}\" -w #{capture_delay} #{capture_device_string}"
+      debug "Capturer: making system call for #{call_str}"
+      system(call_str)
     end
 
     private

data/lib/lolcommits/capturer.rb

@@ -1,10 +1,13 @@
 module Lolcommits
   class Capturer
+    include Methadone::CLILogging
     attr_accessor :capture_device, :capture_delay, :snapshot_location
+
     def initialize(attributes = Hash.new)
       attributes.each do |attr, val|
         self.send("#{attr}=", val)
       end
+      debug "Capturer: initializing new instance " + self.to_s
     end
   end
 end

data/lib/lolcommits/plugin.rb

@@ -1,5 +1,6 @@
 module Lolcommits
   class Plugin
+    include Methadone::CLILogging
     attr_accessor :default, :name, :runner, :options
 
     def configuration
@@ -11,6 +12,8 @@ module Lolcommits
     def initialize(runner)
       self.runner = runner
       self.options = ['enabled']
+
+      plugdebug "Initializing"
     end
 
     def is_enabled?
@@ -22,8 +25,16 @@ module Lolcommits
 
     def execute
       if is_enabled?
+        plugdebug "I am enabled, about to run"
         run
+      else
+        plugdebug "Disabled, doing nothing for execution"
       end
     end
+
+    # uniform debug logging output for plugins
+    def plugdebug(msg)
+      debug("Plugin: #{self.class.to_s}: " + msg)
+    end
   end
 end

data/lib/lolcommits/plugins/lolsrv.rb

@@ -0,0 +1,73 @@
+require "rest_client"
+require "pp"
+require "json"
+require "logger"
+
+module Lolcommits
+
+  class Lolsrv < Plugin
+
+    SERVER = 'server'
+
+    def initialize(runner)
+      super
+      self.name    = 'lolsrv'
+      self.default = false  
+      self.options << SERVER
+
+    end
+
+    def run
+      
+      log_file = File.new(self.runner.config.loldir + "/lolsrv.log", "a+")
+      @logger = Logger.new(log_file)
+      
+      if configuration[SERVER].nil?
+        puts "Missing server configuration. Use lolcommits --config -p lolsrv"
+        return
+      end
+
+      fork do
+        sync()
+      end
+    end
+
+    def sync
+      existing = get_existing_lols
+      unless existing.nil?
+        Dir.glob(self.runner.config.loldir + "/*.jpg") do |item|
+          next if item == '.' or item == '..'
+          # do work on real items
+          sha = File.basename(item, '.*')
+          unless existing.include?(sha) || sha == 'tmp_snapshot' 
+            upload(item, sha)
+          end
+        end
+      end
+    end
+
+    def get_existing_lols
+      begin
+        lols = JSON.parse(
+        RestClient.get(configuration[SERVER] + '/lols'))
+        lols.map { |lol| lol["sha"] }
+      rescue => error
+        @logger.info "Existing lols could not be retrieved with Error " + error.message
+        @logger.info error.backtrace
+        return nil
+      end
+    end
+
+    def upload(file, sha)
+      begin
+        RestClient.post(
+        configuration[SERVER] + '/uplol', 
+        :lol => File.new(file),
+        :sha => sha) 
+      rescue => error
+        @logger.info "Upload of LOL "+ sha + " failed with Error " + error.message
+        return
+      end
+    end
+  end
+end

data/lib/lolcommits/plugins/loltext.rb

@@ -16,6 +16,7 @@ module Lolcommits
     def mm_run
       font_location = File.join(Configuration::LOLCOMMITS_ROOT, "vendor", "fonts", "Impact.ttf")
 
+      plugdebug "Annotating image via MiniMagick"
       image = MiniMagick::Image.open(self.runner.main_image)
       image.combine_options do |c|
         c.gravity 'SouthWest'
@@ -38,6 +39,7 @@ module Lolcommits
         c.annotate '0', self.runner.sha
       end
 
+      plugdebug "Writing changed file to #{self.runner.main_image}"
       image.write self.runner.main_image
     end
 

data/lib/lolcommits/plugins/tranzlate.rb

@@ -10,7 +10,9 @@ module Lolcommits
     end
 
     def run
+      plugdebug "Commit message before: #{self.runner.message}"
       self.runner.message = self.runner.message.tranzlate
+      plugdebug "Commit message after: #{self.runner.message}"
     end
   end
 end

data/lib/lolcommits/runner.rb

@@ -4,7 +4,8 @@ module Lolcommits
   class Runner
     attr_accessor :capture_delay, :capture_device, :message, :sha,
       :snapshot_loc, :main_image, :repo, :config, :repo_internal_path
-
+    
+    include Methadone::CLILogging
     include ActiveSupport::Callbacks
     define_callbacks :run
     set_callback :run, :before, :execute_lolcommits_tranzlate
@@ -12,6 +13,7 @@ module Lolcommits
     # Executed Last
     set_callback :run, :after,  :cleanup!
     set_callback :run, :after,  :execute_lolcommits_uploldz
+    set_callback :run, :after,  :execute_lolcommits_lolsrv
     set_callback :run, :after,  :execute_lolcommits_lol_twitter
     set_callback :run, :after,  :execute_lolcommits_stats_d
     set_callback :run, :after,  :execute_lolcommits_dot_com
@@ -51,15 +53,18 @@ module Lolcommits
 
   protected
   def die_if_rebasing!
+    debug "Runner: Making sure user isn't rebasing"
     if not self.repo_internal_path.nil?
       mergeclue = File.join self.repo_internal_path, "rebase-merge"
       if File.directory? mergeclue
+        debug "Runner: Rebase detected, silently exiting!"
         exit 0
       end
     end
   end
 
   def resize_snapshot!
+    debug "Runner: resizing snapshot"
     image = MiniMagick::Image.open(self.snapshot_loc)
     if (image[:width] > 640 || image[:height] > 480)
       #this is ghetto resize-to-fill
@@ -68,12 +73,15 @@ module Lolcommits
         c.gravity 'center'
         c.extent '640x480'
       end
+      debug "Runner: writing resized image to #{self.snapshot_loc}"
       image.write self.snapshot_loc
     end
+    debug "Runner: copying resized image to #{self.main_image}"
     FileUtils.cp(self.snapshot_loc, self.main_image)
   end
 
   def cleanup!
+    debug "Runner: running cleanup"
     #clean up the captured image
     FileUtils.rm(self.snapshot_loc)
   end

data/lib/lolcommits/version.rb

@@ -1,3 +1,3 @@
 module Lolcommits
-  VERSION = "0.4.0"
+  VERSION = "0.4.1pre1"
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: lolcommits
 version: !ruby/object:Gem::Version
-  version: 0.4.0
-  prerelease: 
+  version: 0.4.1pre1
+  prerelease: 5
 platform: ruby
 authors:
 - Matthew Rothenberg
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-13 00:00:00.000000000 Z
+date: 2013-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mini_magick
@@ -303,6 +303,7 @@ files:
 - lib/lolcommits/plugin.rb
 - lib/lolcommits/plugins/dot_com.rb
 - lib/lolcommits/plugins/lol_twitter.rb
+- lib/lolcommits/plugins/lolsrv.rb
 - lib/lolcommits/plugins/loltext.rb
 - lib/lolcommits/plugins/statsd.rb
 - lib/lolcommits/plugins/tranzlate.rb
@@ -334,16 +335,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3878014605033370511
+      hash: -2108041142645643516
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: 3878014605033370511
+      version: 1.3.1
 requirements: []
 rubyforge_project: lolcommits
 rubygems_version: 1.8.24