acmcommits 0.0.1

data/features/support/env.rb

@@ -0,0 +1,94 @@
+require 'aruba/cucumber'
+require 'methadone/cucumber'
+require 'open3'
+require 'test/unit/assertions'
+include Test::Unit::Assertions
+require 'faker'
+require 'lolcommits/configuration'
+include Lolcommits
+
+ENV['PATH'] = "#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+LIB_DIR = File.join(File.expand_path(File.dirname(__FILE__)),'..','..','lib')
+
+Before do
+  # Using "announce" causes massive warnings on 1.9.2
+  @puts = true
+  @aruba_timeout_seconds = 20
+
+  @original_rubylib = ENV['RUBYLIB']
+  ENV['RUBYLIB'] = LIB_DIR + File::PATH_SEPARATOR + ENV['RUBYLIB'].to_s
+
+  @original_fakecapture = ENV['LOLCOMMITS_FAKECAPTURE']
+  ENV['LOLCOMMITS_FAKECAPTURE'] = "1"
+
+  # @original_loldir = ENV['LOLCOMMITS_DIR']
+  # ENV['LOLCOMMITS_DIR'] = File.expand_path( File.join(current_dir, ".lolcommits") )
+
+  @original_home = ENV['HOME']
+  ENV['HOME'] = File.expand_path( current_dir )
+
+  ENV['LAUNCHY_DRY_RUN'] = 'true'
+end
+
+After do
+  ENV['RUBYLIB'] = @original_rubylib
+  ENV['LOLCOMMITS_FAKECAPTURE'] = @original_fakecapture
+  # ENV['LOLCOMMITS_DIR'] = @original_loldir
+  ENV['HOME'] = @original_home
+  ENV['LAUNCHY_DRY_RUN'] = nil
+end
+
+Before('@fake-interactive-rebase') do
+  # in order to fake an interactive rebase, 
+  # we replace the editor with a script that simply squashes a few random commits
+  @original_git_editor = ENV['GIT_EDITOR']
+  # ENV['GIT_EDITOR'] = "sed -i -e 'n;s/pick/squash/g'" #every other commit
+  ENV['GIT_EDITOR'] = "sed -i -e '3,5 s/pick/squash/g'" #lines 3-5
+end
+
+After('@fake-interactive-rebase') do
+  ENV['GIT_EDITOR'] = @original_git_editor
+end
+
+Before('@slow_process') do
+  @aruba_io_wait_seconds = 5
+  @aruba_timeout_seconds = 60
+end
+
+# adjust the path so tests dont see a global imagemagick install
+Before('@fake-no-imagemagick') do
+
+  # make a new subdir that still contains git and mplayer
+  tmpbindir = File.expand_path(File.join @dirs, "bin")
+  FileUtils.mkdir_p tmpbindir
+  ["git","mplayer"].each do |cmd|
+    whichcmd = Lolcommits::Configuration.command_which(cmd)
+    unless whichcmd.nil?
+      FileUtils.ln_s whichcmd, File.join(tmpbindir, File.basename(whichcmd))
+    end
+  end
+
+  # use a modified version of Configuration::command_which to detect where IM is installed
+  # and remove that from the path
+  cmd = 'mogrify'
+  exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+  newpaths = ENV['PATH'].split(File::PATH_SEPARATOR).reject do |path|
+    found_cmd = false
+    exts.each { |ext|
+      exe = "#{path}/#{cmd}#{ext}"
+      found_cmd = true if File.executable? exe
+    }
+    found_cmd
+  end
+
+  # add the temporary directory with git in it back into the path
+  newpaths << tmpbindir 
+
+  @original_path = ENV['PATH']
+  ENV['PATH'] = newpaths.join(File::PATH_SEPARATOR)
+  puts ENV['PATH']
+end
+
+After('@fake-no-imagemagick') do
+  ENV['PATH'] = @original_path
+end

data/lib/core_ext/class.rb

@@ -0,0 +1,7 @@
+class Class
+  def subclasses
+    result = []
+    ObjectSpace.each_object(Class) { |klass| result << klass if klass < self }
+    result
+  end
+end

data/lib/lolcommits/capture_fake.rb

@@ -0,0 +1,10 @@
+module Lolcommits
+  class CaptureFake < Capturer
+    def capture
+      test_image = File.join Configuration::LOLCOMMITS_ROOT, "test", "images", "test_image.jpg"
+      FileUtils.cp test_image, snapshot_location
+    end
+
+  end
+end
+

data/lib/lolcommits/capture_linux.rb

@@ -0,0 +1,28 @@
+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
+
+  end
+
+end

data/lib/lolcommits/capture_mac.rb

@@ -0,0 +1,19 @@
+module Lolcommits
+  class CaptureMac < Capturer
+    def capture_device_string
+      @capture_device.nil? ? nil : "-d \"#{@capture_device}\""
+    end
+
+    def capture
+      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
+
+    def imagesnap_bin
+      File.join(Configuration::LOLCOMMITS_ROOT, "vendor", "ext", "imagesnap", "imagesnap")
+    end
+  end
+end

data/lib/lolcommits/capture_windows.rb

@@ -0,0 +1,18 @@
+module Lolcommits
+  class CaptureWindows < Capturer
+    def capture
+      commandcam_exe = File.join Configuration::LOLCOMMITS_ROOT, "vendor", "ext", "CommandCam", "CommandCam.exe"
+      # DirectShow takes a while to show... at least for me anyway
+      delaycmd = " /delay 3000"
+      if capture_delay > 0
+        # CommandCam delay is in milliseconds
+        delaycmd = " /delay #{capture_delay * 1000}"
+      end
+      _, r, _ = Open3.popen3("#{commandcam_exe} /filename #{snapshot_location}#{delaycmd}")
+      # looks like we still need to read the output for something to happen
+      r.read
+    end
+
+  end
+
+end

data/lib/lolcommits/capturer.rb

@@ -0,0 +1,13 @@
+module Lolcommits
+  class Capturer
+    include Methadone::CLILogging
+    attr_accessor :capture_device, :capture_delay, :snapshot_location, :font
+
+    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/configuration.rb

@@ -0,0 +1,160 @@
+module Lolcommits
+  class Configuration
+    LOLBASEDIR = ENV['LOLCOMMITS_DIR'] || File.join(ENV['HOME'], '.lolcommits')
+    LOLCOMMITS_ROOT = File.join(File.dirname(__FILE__), '../..')
+    attr_writer :loldir
+
+    def initialize(attributes={})
+      attributes.each do |attr, val|
+        self.send("#{attr}=", val)
+      end
+    end
+
+    def self.platform
+      if is_fakecapture?
+        'Fake'
+      elsif is_mac?
+        'Mac'
+      elsif is_linux?
+        'Linux'
+      elsif is_windows?
+        'Windows'
+      else
+        raise "Unknown / Unsupported Platform."
+      end
+    end
+
+    def user_configuration
+      if File.exists?(user_configuration_file)
+        YAML.load(File.open(user_configuration_file))
+      else
+        nil
+      end
+    end
+
+    def user_configuration_file
+      "#{self.loldir}/config.yml"
+    end
+
+    def loldir
+      return @loldir if @loldir
+
+      basename ||= File.basename(Git.open('.').dir.to_s).sub(/^\./, 'dot')
+      basename.sub!(/ /, '-')
+
+      @loldir = Configuration.loldir_for(basename)
+    end
+
+    def self.loldir_for(basename)
+      loldir = File.join(LOLBASEDIR, basename)
+
+      if not File.directory? loldir
+        FileUtils.mkdir_p loldir
+      end
+      loldir
+    end
+
+    def most_recent
+      Dir.glob(File.join self.loldir, "*").max_by {|f| File.mtime(f)}
+    end
+
+    def raw_image
+      File.join self.loldir, "tmp_snapshot.jpg"
+    end
+
+    def main_image(commit_sha)
+      File.join self.loldir, "#{commit_sha}.jpg"
+    end
+
+    def puts_plugins
+      names = Lolcommits::PLUGINS.collect {|p| p.new(nil).name }
+      puts "Available plugins: #{names.join(', ')}"
+    end
+
+    def do_configure!(plugin, forced_options=nil)
+      if plugin.nil? || plugin.strip == ''
+        puts_plugins
+        print "Name of plugin to configure: "
+        plugin = STDIN.gets.strip
+      end
+
+      plugins = Lolcommits::PLUGINS.inject(Hash.new) do |acc, val|
+        p = val.new(nil)
+        acc.merge(p.name => p)
+      end
+
+      plugin_object = plugins[plugin]
+
+      if plugin_object.nil?
+        puts "Unable to find plugin: #{plugin}"
+        return
+      end
+
+      if forced_options.nil?
+        options = plugin_object.options.inject(Hash.new) do |acc, option|
+          print "#{option}: "
+          val = STDIN.gets.strip
+          val = true  if val == 'true'
+          val = false if val == 'false'
+
+          acc.merge(option => val)
+        end
+      else
+        options = forced_options
+      end
+
+      config = self.user_configuration || Hash.new
+      config[plugin] = options
+      File.open(self.user_configuration_file, 'w') do |f| 
+        f.write(config.to_yaml)
+      end 
+
+      puts "#{config.to_yaml}\n"
+      puts "Successfully Configured"
+    end
+
+    def self.is_mac?
+      RUBY_PLATFORM.to_s.downcase.include?("darwin")
+    end
+
+    def self.is_linux?
+      RUBY_PLATFORM.to_s.downcase.include?("linux")
+    end
+
+    def self.is_windows?
+      !! RUBY_PLATFORM.match(/(win|w)32/)
+    end
+
+    def self.is_fakecapture?
+      (ENV['LOLCOMMITS_FAKECAPTURE'] == '1' || false)
+    end
+
+    def self.valid_imagemagick_installed?
+      return false unless self.command_which('identify')
+      return false unless self.command_which('mogrify')
+      # you'd expect the below to work on its own, but it only handles old versions
+      # and will throw an exception if IM is not installed in PATH
+      MiniMagick::valid_version_installed?
+    end
+
+    def self.git_config_color_always?
+      `git config color.ui`.chomp =~ /always/
+    end
+
+    # Cross-platform way of finding an executable in the $PATH.
+    # idea taken from http://bit.ly/qDaTbY
+    #
+    #   which('ruby') #=> /usr/bin/ruby
+    def self.command_which(cmd)
+      exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+      ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+        exts.each { |ext|
+          exe = "#{path}/#{cmd}#{ext}"
+          return exe if File.executable? exe
+        }
+      end
+      return nil
+    end
+
+  end
+end

data/lib/lolcommits/git_info.rb

@@ -0,0 +1,27 @@
+module Lolcommits
+  class GitInfo
+    include Methadone::CLILogging
+    attr_accessor :sha, :message, :repo_internal_path, :repo
+
+    def initialize
+      debug "GitInfo: attempting to read local repository"
+      g    = Git.open('.')
+      debug "GitInfo: reading commits logs"
+      commit = g.log.first
+      debug "GitInfo: most recent commit is '#{commit}'"
+
+      self.message = commit.message.split("\n").first
+      self.sha     = commit.sha[0..10]
+      self.repo_internal_path = g.repo.path
+      regex = /.*[:\/](\w*).git/
+      match = g.remote.url.match regex if g.remote.url
+      self.repo = match[1] if match
+      
+      debug "GitInfo: parsed the following values from commit:"
+      debug "GitInfo: \t#{self.message}"
+      debug "GitInfo: \t#{self.sha}"
+      debug "GitInfo: \t#{self.repo_internal_path}" 
+      debug "GitInfo: \t#{self.repo}"
+    end
+  end
+end

data/lib/lolcommits/plugin.rb

@@ -0,0 +1,40 @@
+module Lolcommits
+  class Plugin
+    include Methadone::CLILogging
+    attr_accessor :default, :name, :runner, :options
+
+    def configuration
+      config = runner.config.user_configuration
+      return Hash.new if config.nil?
+      config[self.name] || Hash.new
+    end
+
+    def initialize(runner)
+      self.runner = runner
+      self.options = ['enabled']
+
+      plugdebug "Initializing"
+    end
+
+    def is_enabled?
+      enabled_config = configuration['enabled']
+      return self.default if enabled_config.nil? || enabled_config == ''
+      return enabled_config
+    end
+
+
+    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] + '/commits'))
+        lols.map { |lol| lol["sha"] }
+      rescue => error
+        @logger.info "Existing commits 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] + '/upload',
+        :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

@@ -0,0 +1,79 @@
+module Lolcommits
+  class Loltext < Plugin
+
+    def initialize(runner)
+      super
+
+      @font_location = runner ? runner.font : nil
+
+      self.name    = 'loltext'
+      self.default = true
+    end
+
+    def run
+      mm_run
+    end
+
+    # use minimagick wrapper
+    def mm_run
+      font_location = @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'
+        c.fill 'white'
+        c.stroke 'black'
+        c.strokewidth '2'
+        c.pointsize '48'
+        c.interline_spacing '-9'
+        c.font font_location
+        c.annotate '0', clean_msg(self.runner.message)
+      end
+
+      image.combine_options do |c|
+        c.gravity 'NorthEast'
+        c.fill 'white'
+        c.stroke 'black'
+        c.strokewidth '2'
+        c.pointsize '32'
+        c.font font_location
+        c.annotate '0', self.runner.sha
+      end
+
+      plugdebug "Writing changed file to #{self.runner.main_image}"
+      image.write self.runner.main_image
+    end
+
+    private
+
+    # do whatever is required to commit message to get it clean and ready for imagemagick
+    def clean_msg(text)
+      wrapped_text = word_wrap text
+      escape_quotes wrapped_text
+      text = scrub_profanity text
+    end
+
+
+    #search the commit for profanity and if it exists remove the commit
+    def scrub_profanity(text)
+      profanity = ['fuck', 'bitch', 'cunt', 'hate', 'pissed', 'balls', 'screw', 'ACM',
+                   'ass']
+      text.each do |word|
+        text = ' ' if profanity.include? word
+      end
+    end
+    # conversion for quotation marks to avoid shell interpretation
+    # does not seem to be a safe way to escape cross-platform?
+    def escape_quotes(text)
+      text.gsub(/"/, "''")
+    end
+
+    # convenience method for word wrapping
+    # based on https://github.com/cmdrkeene/memegen/blob/master/lib/meme_generator.rb
+    def word_wrap(text, col = 27)
+      wrapped = text.gsub(/(.{1,#{col + 4}})(\s+|\Z)/, "\\1\n")
+      wrapped.chomp!
+    end
+  end
+end

data/lib/lolcommits/plugins/statsd.rb

@@ -0,0 +1,25 @@
+require "statsd"
+
+#
+# This is just to keep some usage statistics on lolcommits.
+#
+
+module Lolcommits
+  class StatsD < Plugin
+    def initialize(runner)
+      super
+
+      self.name    = 'statsd'
+      self.default = true
+    end
+
+    def run
+      $statsd = Statsd.new('23.20.178.143')
+      if Configuration.is_fakecapture?
+        $statsd.increment 'app.lolcommits.fakecaptures'
+      else
+        $statsd.increment 'app.lolcommits.captures'
+      end
+    end
+  end
+end