lolcommits 0.5.7 → 0.5.8

data/lib/lolcommits/cli/timelapse_gif.rb

@@ -0,0 +1,45 @@
+# -*- encoding: utf-8 -*-
+require 'lolcommits/cli/fatals'
+
+require 'mini_magick'
+
+module Lolcommits
+  module CLI
+    # Creates an animated timeline GIF of lolcommits history.
+    class TimelapseGif
+      # param config [Lolcommits::Configuration]
+      def initialize(config)
+        @configuration = config
+      end
+
+      # Runs the history timeline animator task thingy
+      # param args [String] the arg passed to the gif command on CLI (optional)
+      def run(args = nil)
+        Fatals.die_if_not_git_repo!
+
+        case args
+        when 'today'
+          lolimages = @configuration.jpg_images_today
+          filename  = "#{Date.today}.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."
+      end
+    end
+  end
+end

data/lib/lolcommits/configuration.rb

@@ -1,4 +1,5 @@
 # -*- encoding : utf-8 -*-
+
 module Lolcommits
   class Configuration
     LOLCOMMITS_BASE = ENV['LOLCOMMITS_DIR'] || File.join(ENV['HOME'], '.lolcommits')
@@ -7,20 +8,17 @@ module Lolcommits
 
     def initialize(attributes = {})
       attributes.each do |attr, val|
-        self.send("#{attr}=", val)
+        send("#{attr}=", val)
       end
     end
 
     def read_configuration
-      if File.exists?(configuration_file)
-        YAML.load(File.open(configuration_file))
-      else
-        nil
-      end
+      return unless File.exist?(configuration_file)
+      YAML.load(File.open(configuration_file))
     end
 
     def configuration_file
-      "#{self.loldir}/config.yml"
+      "#{loldir}/config.yml"
     end
 
     def loldir
@@ -32,51 +30,40 @@ module Lolcommits
 
     def archivedir
       dir = File.join(loldir, 'archive')
-      if not File.directory? dir
-        FileUtils.mkdir_p dir
-      end
+      FileUtils.mkdir_p dir unless File.directory? dir
       dir
     end
 
     def most_recent
-      Dir.glob(File.join self.loldir, '*.{jpg,gif}').max_by { |f| File.mtime(f) }
+      Dir.glob(File.join loldir, '*.{jpg,gif}').max_by { |f| File.mtime(f) }
     end
 
     def jpg_images
-      Dir.glob(File.join self.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
-      jpg_images.select { |f| Date.parse(File.mtime(f).to_s) === Date.today }
+      jpg_images.select { |f| Date.parse(File.mtime(f).to_s) == Date.today }
     end
 
     def raw_image(image_file_type = 'jpg')
-      File.join self.loldir, "tmp_snapshot.#{image_file_type}"
+      File.join loldir, "tmp_snapshot.#{image_file_type}"
     end
 
     def main_image(commit_sha, image_file_type = 'jpg')
-      File.join self.loldir, "#{commit_sha}.#{image_file_type}"
+      File.join loldir, "#{commit_sha}.#{image_file_type}"
     end
 
     def video_loc
-      File.join(self.loldir, 'tmp_video.mov')
+      File.join(loldir, 'tmp_video.mov')
     end
 
     def frames_loc
-      File.join(self.loldir, 'tmp_frames')
-    end
-
-    def puts_devices
-      # TODO: handle other platforms here (linux/windows)
-      if self.class.platform_mac?
-        capturer = Lolcommits::CaptureMacAnimated.new
-        puts `#{capturer.executable_path} -l`
-        puts "Specify a device with --device=\"{device name}\" or set the LOLCOMMITS_DEVICE env variable"
-      end
+      File.join(loldir, 'tmp_frames')
     end
 
     def puts_plugins
-      puts "Available plugins: #{Lolcommits::PLUGINS.map(&:name).join(', ')}"
+      puts "Available plugins: #{Lolcommits::Runner.plugins.map(&:name).join(', ')}"
     end
 
     def ask_for_plugin_name
@@ -86,10 +73,8 @@ module Lolcommits
     end
 
     def find_plugin(plugin_name)
-      Lolcommits::PLUGINS.each do |plugin|
-        if plugin.name == plugin_name
-          return plugin.new(nil)
-        end
+      Lolcommits::Runner.plugins.each do |plugin|
+        return plugin.new(nil) if plugin.name == plugin_name
       end
 
       puts "Unable to find plugin: '#{plugin_name}'"
@@ -97,30 +82,27 @@ module Lolcommits
     end
 
     def do_configure!(plugin_name)
-      if plugin_name.to_s.strip.empty?
-        plugin_name = ask_for_plugin_name
-      end
+      plugin_name = ask_for_plugin_name if plugin_name.to_s.strip.empty?
 
       plugin = find_plugin(plugin_name)
-      if plugin
-        config = self.read_configuration || {}
-        plugin_config = plugin.configure_options!
-        # having a plugin_config, means configuring went OK
-        if plugin_config
-          # save plugin and print config
-          config[plugin_name] = plugin_config
-          save(config)
-          puts self
-          puts "\nSuccessfully configured plugin: #{plugin_name}"
-        else
-          puts "\nAborted plugin configuration for: #{plugin_name}"
-        end
+      return unless plugin
+      config = read_configuration || {}
+      plugin_config = plugin.configure_options!
+      # having a plugin_config, means configuring went OK
+      if plugin_config
+        # save plugin and print config
+        config[plugin_name] = plugin_config
+        save(config)
+        puts self
+        puts "\nSuccessfully configured plugin: #{plugin_name}"
+      else
+        puts "\nAborted plugin configuration for: #{plugin_name}"
       end
     end
 
     def save(config)
       config_file_contents = config.to_yaml
-      File.open(self.configuration_file, 'w') do |f|
+      File.open(configuration_file, 'w') do |f|
         f.write(config_file_contents)
       end
     end
@@ -131,24 +113,6 @@ module Lolcommits
 
     # class methods
 
-    def self.platform
-      if platform_fakeplatform?
-        ENV['LOLCOMMITS_FAKEPLATFORM']
-      elsif platform_fakecapture?
-        'Fake'
-      elsif platform_mac?
-        'Mac'
-      elsif platform_linux?
-        'Linux'
-      elsif platform_windows?
-        'Windows'
-      elsif platform_cygwin?
-        'Cygwin'
-      else
-        fail 'Unknown / Unsupported Platform.'
-      end
-    end
-
     def self.loldir_for(basename)
       loldir = File.join(LOLCOMMITS_BASE, basename)
 
@@ -167,72 +131,5 @@ module Lolcommits
       end
       loldir
     end
-
-    def self.platform_mac?
-      RUBY_PLATFORM.to_s.downcase.include?('darwin')
-    end
-
-    def self.platform_linux?
-      RUBY_PLATFORM.to_s.downcase.include?('linux')
-    end
-
-    def self.platform_windows?
-      !!RUBY_PLATFORM.match(/(win|w)32/)
-    end
-
-    def self.platform_cygwin?
-      RUBY_PLATFORM.to_s.downcase.include?('cygwin')
-    end
-
-    def self.platform_fakecapture?
-      (ENV['LOLCOMMITS_FAKECAPTURE'] == '1' || false)
-    end
-
-    def self.platform_fakeplatform?
-      ENV['LOLCOMMITS_FAKEPLATFORM']
-    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?
-    rescue
-      puts "FATAL: ImageMagick >= #{MiniMagick.minimum_image_magick_version} required (http://imagemagick.org)"
-      puts 'Please check the following command works and returns a valid version number'
-      puts '=> mogrify --version'
-      exit 1
-    end
-
-    def self.valid_ffmpeg_installed?
-      self.command_which('ffmpeg')
-    end
-
-    def self.git_config_color_always?
-      `git config color.ui`.chomp =~ /always/
-    end
-
-    def self.can_animate?
-      ['Mac', 'Linux'].include? platform
-    end
-
-    # Cross-platform way of finding an executable in the $PATH.
-    # idea taken from http://bit.ly/qDaTbY, if only_path is true, only the path
-    # is returned (not the path and command)
-    #
-    #   which('ruby') #=> /usr/bin/ruby
-    def self.command_which(cmd, only_path = false)
-      exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
-      ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
-        exts.each do |ext|
-          exe = "#{path}/#{cmd}#{ext}"
-          if File.executable? exe
-            return only_path ? path : exe
-          end
-        end
-      end
-      nil
-    end
   end
 end

data/lib/lolcommits/git_info.rb

@@ -3,50 +3,80 @@ module Lolcommits
   class GitInfo
     include Methadone::CLILogging
     attr_accessor :sha, :message, :repo_internal_path, :repo, :url,
-                  :author_name, :author_email
+                  :author_name, :author_email, :branch
 
-    GIT_URL_REGEX = /.*[:]([\/\w\-]*).git/
+    GIT_URL_REGEX = %r{.*[:]([\/\w\-]*).git}
 
     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
-
-      if g.remote.url
-        self.url = remote_https_url(g.remote.url)
-        match = g.remote.url.match(GIT_URL_REGEX)
-      end
-
-      if match
-        self.repo = match[1]
-      elsif !g.repo.path.empty?
-        self.repo = g.repo.path.split(File::SEPARATOR)[-2]
-      end
-
-      if commit.author
-        self.author_name = commit.author.name
-        self.author_email = commit.author.email
-      end
-
       debug 'GitInfo: parsed the following values from commit:'
       debug "GitInfo: \t#{message}"
       debug "GitInfo: \t#{sha}"
       debug "GitInfo: \t#{repo_internal_path}"
       debug "GitInfo: \t#{repo}"
+      debug "GitInfo: \t#{branch}"
       debug "GitInfo: \t#{author_name}" if author_name
       debug "GitInfo: \t#{author_email}" if author_email
     end
 
+    def branch
+      @branch ||= repository.current_branch
+    end
+
+    def message
+      @message ||= begin
+        message = last_commit.message || ''
+        message.split("\n").first
+      end
+    end
+
+    def sha
+      @sha ||= last_commit.sha[0..10]
+    end
+
+    def repo_internal_path
+      @repo_internal_path ||= repository.repo.path
+    end
+
+    def url
+      @url ||= begin
+        remote_https_url(repository.remote.url) if repository.remote
+      end
+    end
+
+    def repo
+      @repo ||= begin
+        if repository.remote && repository.remote.url
+          match = repository.remote.url.match(GIT_URL_REGEX)
+        end
+
+        if match
+          match[1]
+        elsif !repository.repo.path.empty?
+          repository.repo.path.split(File::SEPARATOR)[-2]
+        end
+      end
+    end
+
+    def author_name
+      @author_name ||= last_commit.author.name if last_commit.author
+    end
+
+    def author_email
+      @author_email ||= last_commit.author.email if last_commit.author
+    end
+
     private
 
     def remote_https_url(url)
       url.gsub(':', '/').gsub(/^git@/, 'https://').gsub(/\.git$/, '') + '/commit/'
     end
+
+    def repository(path = '.')
+      @repository ||= Git.open(path)
+    end
+
+    def last_commit
+      @commit ||= repository.log.first
+    end
   end
 end

data/lib/lolcommits/installation.rb

@@ -11,15 +11,13 @@ module Lolcommits
     # IF --ENABLE, DO ENABLE
     #
     def self.do_enable
-      if not File.directory?('.git')
+      unless 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
+      Dir.mkdir(HOOK_DIR) unless File.directory?(HOOK_DIR)
 
       # should add a shebang (or not) adding will rewrite hook file
       add_shebang = false
@@ -40,9 +38,7 @@ module Lolcommits
       end
 
       File.open(HOOK_PATH, add_shebang ? 'w' : 'a') do |f|
-        if add_shebang
-          f.write("#!/bin/sh\n")
-        end
+        f.write("#!/bin/sh\n") if add_shebang
         f.write(hook_script)
       end
 
@@ -62,7 +58,7 @@ module Lolcommits
       if lolcommits_hook_exists?
         remove_existing_hook!
         info "uninstalled lolcommits hook (from #{HOOK_PATH})"
-      elsif File.exists?(HOOK_PATH)
+      elsif File.exist?(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"
@@ -72,11 +68,9 @@ module Lolcommits
       end
     end
 
-    protected
-
-    def self.hook_script(add_shebang = true)
-      ruby_path     = Lolcommits::Configuration.command_which('ruby', true)
-      imagick_path  = Lolcommits::Configuration.command_which('identify', true)
+    def self.hook_script(_add_shebang = true)
+      ruby_path     = Lolcommits::Platform.command_which('ruby', true)
+      imagick_path  = Lolcommits::Platform.command_which('identify', true)
       locale_export = "export LANG=\"#{ENV['LANG']}\"\n"
       hook_export   = "export PATH=\"#{ruby_path}:#{imagick_path}:$PATH\"\n"
       capture_cmd   = 'lolcommits --capture'
@@ -91,7 +85,7 @@ EOS
 
     # does a git hook exist at all?
     def self.hook_file_exists?
-      File.exists?(HOOK_PATH)
+      File.exist?(HOOK_PATH)
     end
 
     # does a git hook exist with lolcommits commands?
@@ -102,7 +96,7 @@ EOS
 
     # does the git hook file have a good shebang?
     def self.good_shebang?
-      File.read(HOOK_PATH).lines.first =~ /^\#\!\/bin\/.*sh/
+      File.read(HOOK_PATH).lines.first =~ %r{^\#\!\/bin\/.*sh}
     end
 
     def self.remove_existing_hook!
@@ -111,15 +105,11 @@ EOS
       skip = false
 
       hook.lines.each do |line|
-        if !skip && (line =~ /lolcommits.*\(begin\)/)
-          skip = true
-        end
+        skip = true if !skip && (line =~ /lolcommits.*\(begin\)/)
 
         out << line unless skip
 
-        if skip && (line =~ /lolcommits.*\(end\)/)
-          skip = false
-        end
+        skip = false if skip && (line =~ /lolcommits.*\(end\)/)
       end
 
       out.close

data/lib/lolcommits/platform.rb

@@ -0,0 +1,134 @@
+# -*- encoding : utf-8 -*-
+require 'mini_magick'
+
+module Lolcommits
+  class Platform
+    # A convenience name for the platform.  Mainly used for metaprogramming.
+    # @return String
+    def self.platform
+      if platform_fakeplatform?   then ENV['LOLCOMMITS_FAKEPLATFORM']
+      elsif platform_fakecapture? then 'Fake'
+      elsif platform_mac?         then 'Mac'
+      elsif platform_linux?       then 'Linux'
+      elsif platform_windows?     then 'Windows'
+      elsif platform_cygwin?      then 'Cygwin'
+      else
+        fail 'Unknown / Unsupported Platform.'
+      end
+    end
+
+    # Are we on a Mac platform?
+    # @return Boolean
+    def self.platform_mac?
+      RUBY_PLATFORM.to_s.downcase.include?('darwin')
+    end
+
+    # Are we on a Linux platform?
+    # @return Boolean
+    def self.platform_linux?
+      RUBY_PLATFORM.to_s.downcase.include?('linux')
+    end
+
+    # Are we on a Windows platform?
+    # @return Boolean
+    def self.platform_windows?
+      !RUBY_PLATFORM.match(/(win|w)32/).nil?
+    end
+
+    # Are we on a Cygwin platform?
+    # @return Boolean
+    def self.platform_cygwin?
+      RUBY_PLATFORM.to_s.downcase.include?('cygwin')
+    end
+
+    # Are we currently faking webcam capture for test purposes?
+    # @return Boolean
+    def self.platform_fakecapture?
+      (ENV['LOLCOMMITS_FAKECAPTURE'] == '1' || false)
+    end
+
+    # Are we currently overriding and faking the platform entirely?
+    # @todo possibly make this a private method?
+    # @return Boolean
+    def self.platform_fakeplatform?
+      ENV['LOLCOMMITS_FAKEPLATFORM']
+    end
+
+    # Is the platform capable of capturing animated GIFs from webcam?
+    # @return Boolean
+    def self.can_animate?
+      # FIXME: this is currently matching against string instead of
+      # simply returning platform_mac? || platform_linux?
+      # This is not ideal... but otherwise overriding platform via
+      # LOLCOMMITS_FAKEPLATFORM when running cucumber tests won't work.
+      # We should come up with a better solution.
+      %w(Mac Linux).include? platform
+    end
+
+    # 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')
+      # 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?
+    rescue
+      return false
+    end
+
+    # Is a valid install of ffmpeg present on the system?
+    #
+    # @note For now, this just checks for presence, any version should work.
+    # @return Boolean
+    def self.valid_ffmpeg_installed?
+      command_which('ffmpeg')
+    end
+
+    # Cross-platform way of finding an executable in the $PATH.
+    #
+    # Idea taken from http://bit.ly/qDaTbY, if only_path is true, only the path
+    # is returned (not the path and command)
+    #
+    # @example
+    #   command_which('ruby') #=> /usr/bin/ruby
+    #
+    # @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.each do |ext|
+          exe = "#{path}/#{cmd}#{ext}"
+          return only_path ? path : exe if File.executable? exe
+        end
+      end
+      nil
+    end
+
+    # Is `git config color.ui` set to 'always'?
+    #
+    # Due to a bug in the ruby-git library, git config for color.ui cannot be
+    # set to 'always' or it won't read properly.
+    #
+    # This helper method let's us check for that error condition so we can
+    # alert the user in the CLI tool.
+    #
+    # @return Boolean
+    def self.git_config_color_always?
+      `git config color.ui`.chomp =~ /always/
+    end
+
+    # Returns a list of system camera devices in a format suitable to display
+    # to the user.
+    #
+    # @note Currently only functions on Mac.
+    # @return String
+    def self.device_list
+      # TODO: handle other platforms here (linux/windows)
+      if Platform.platform_mac?
+        capturer = Lolcommits::CaptureMacAnimated.new
+        `#{capturer.executable_path} -l`
+      end
+    end
+  end
+end

data/lib/lolcommits/plugin.rb

@@ -46,7 +46,7 @@ module Lolcommits
     # ask for plugin options
     def configure_options!
       puts "Configuring plugin: #{self.class.name}\n"
-      options.reduce(Hash.new) do |acc, option|
+      options.reduce({}) do |acc, option|
         print "#{option}: "
         val = parse_user_input(STDIN.gets.strip)
         # check enabled option isn't a String
@@ -103,7 +103,7 @@ module Lolcommits
 
     # uniform debug logging for plugins
     def debug(msg)
-      super("Plugin: #{self.class.to_s}: " + msg)
+      super("Plugin: #{self.class}: " + msg)
     end
 
     # identifying plugin name (for config, listing)

data/lib/lolcommits/plugins/dot_com.rb

@@ -7,27 +7,27 @@ module Lolcommits
 
     def initialize(runner)
       super
-      self.options.concat(['api_key', 'api_secret', 'repo_id'])
+      options.concat(%w(api_key api_secret repo_id))
     end
 
     def run_postcapture
       return unless valid_configuration?
 
       t = Time.now.to_i.to_s
-      resp = HTTMultiParty.post("#{BASE_URL}/git_commits.json",
-                                :body => {
-                                  :git_commit => {
-                                    :sha              => self.runner.sha,
-                                    :repo_external_id => configuration['repo_id'],
-                                    :image            => File.open(self.runner.main_image),
-                                    :raw              => File.open(self.runner.snapshot_loc)
-                                  },
-
-                                  :key   => configuration['api_key'],
-                                  :t     => t,
-                                  :token =>  Digest::SHA1.hexdigest(configuration['api_secret'] + t)
-                                }
-      )
+      HTTMultiParty.post(
+        "#{BASE_URL}/git_commits.json",
+        :body => {
+          :git_commit => {
+            :sha              => runner.sha,
+            :repo_external_id => configuration['repo_id'],
+            :image            => File.open(runner.main_image),
+            :raw              => File.open(runner.snapshot_loc)
+          },
+
+          :key   => configuration['api_key'],
+          :t     => t,
+          :token =>  Digest::SHA1.hexdigest(configuration['api_secret'] + t)
+        })
     rescue => e
       log_error(e, "ERROR: HTTMultiParty POST FAILED #{e.class} - #{e.message}")
     end