lolcommits 0.5.7 → 0.5.8.pre1

data/lib/lolcommits/capturer/capture_linux.rb

@@ -12,7 +12,7 @@ module Lolcommits
       tmpdir = Dir.mktmpdir
 
       # Default delay is 1s
-      delay = if capture_delay != 0 then capture_delay else 1 end
+      delay = capture_delay != 0 ? capture_delay : 1
 
       # There's no way to give a capture delay in mplayer, but a number of frame
       # mplayer's "delay" is actually a number of frames at 25 fps

data/lib/lolcommits/capturer/capture_linux_animated.rb

@@ -8,21 +8,20 @@ module Lolcommits
 
       # capture the raw video with ffmpeg video4linux2
       system_call "ffmpeg -v quiet -y -f video4linux2 -video_size 320x240 -i #{capture_device_string} -t #{capture_duration} #{video_location} > /dev/null"
-      if File.exists?(video_location)
-        # convert raw video to png frames with ffmpeg
-        system_call "ffmpeg #{capture_delay_string} -v quiet -i #{video_location} -t #{animated_duration} #{frames_location}/%09d.png > /dev/null"
+      return unless File.exist?(video_location)
+      # convert raw video to png frames with ffmpeg
+      system_call "ffmpeg #{capture_delay_string} -v quiet -i #{video_location} -t #{animated_duration} #{frames_location}/%09d.png > /dev/null"
 
-        # use fps to set delay and number of frames to skip (for lower filesized gifs)
-        fps   = video_fps(video_location)
-        skip  = frame_skip(fps)
-        delay = frame_delay(fps, skip)
-        debug "Capturer: anaimated gif choosing every #{skip} frames with a frame delay of #{delay}"
+      # use fps to set delay and number of frames to skip (for lower filesized gifs)
+      fps   = video_fps(video_location)
+      skip  = frame_skip(fps)
+      delay = frame_delay(fps, skip)
+      debug "Capturer: anaimated gif choosing every #{skip} frames with a frame delay of #{delay}"
 
-        # create the looping animated gif from frames (picks nth frame with seq)
-        seq_command = "seq -f #{frames_location}/%09g.png 1 #{skip} #{Dir["#{frames_location}/*"].length}"
-        # convert to animated gif with delay and gif optimisation
-        system_call "convert -layers OptimizeTransparency -delay #{delay} -loop 0 `#{seq_command}` -coalesce #{snapshot_location} > /dev/null"
-      end
+      # create the looping animated gif from frames (picks nth frame with seq)
+      seq_command = "seq -f #{frames_location}/%09g.png 1 #{skip} #{Dir["#{frames_location}/*"].length}"
+      # convert to animated gif with delay and gif optimisation
+      system_call "convert -layers OptimizeTransparency -delay #{delay} -loop 0 `#{seq_command}` -coalesce #{snapshot_location} > /dev/null"
     end
 
     private

data/lib/lolcommits/capturer/capture_mac_animated.rb

@@ -8,21 +8,20 @@ module Lolcommits
 
       # capture the raw video with videosnap
       system_call "#{executable_path} -s 240 #{capture_device_string}#{capture_delay_string}-t #{animated_duration} --no-audio #{video_location} > /dev/null"
-      if File.exists?(video_location)
-        # convert raw video to png frames with ffmpeg
-        system_call "ffmpeg -v quiet -i #{video_location} -t #{animated_duration} #{frames_location}/%09d.png"
+      return unless File.exist?(video_location)
+      # convert raw video to png frames with ffmpeg
+      system_call "ffmpeg -v quiet -i #{video_location} -t #{animated_duration} #{frames_location}/%09d.png"
 
-        # use fps to set delay and number of frames to skip (for lower filesized gifs)
-        fps   = video_fps(video_location)
-        skip  = frame_skip(fps)
-        delay = frame_delay(fps, skip)
-        debug "Capturer: anaimated gif choosing every #{skip} frames with a frame delay of #{delay}"
+      # use fps to set delay and number of frames to skip (for lower filesized gifs)
+      fps   = video_fps(video_location)
+      skip  = frame_skip(fps)
+      delay = frame_delay(fps, skip)
+      debug "Capturer: anaimated gif choosing every #{skip} frames with a frame delay of #{delay}"
 
-        # create the looping animated gif from frames (picks nth frame with seq)
-        seq_command = "seq -f #{frames_location}/%09g.png 1 #{skip} #{Dir["#{frames_location}/*"].length}"
-        # convert to animated gif with delay and gif optimisation
-        system_call "convert -layers OptimizeTransparency -delay #{delay} -loop 0 `#{seq_command}` -coalesce #{snapshot_location}"
-      end
+      # create the looping animated gif from frames (picks nth frame with seq)
+      seq_command = "seq -f #{frames_location}/%09g.png 1 #{skip} #{Dir["#{frames_location}/*"].length}"
+      # convert to animated gif with delay and gif optimisation
+      system_call "convert -layers OptimizeTransparency -delay #{delay} -loop 0 `#{seq_command}` -coalesce #{snapshot_location}"
     end
 
     def executable_path

data/lib/lolcommits/cli/fatals.rb

@@ -0,0 +1,77 @@
+# -*- encoding: utf-8 -*-
+require 'lolcommits/platform'
+require 'methadone'
+
+module Lolcommits
+  module CLI
+    # Helper methods for failing on error conditions in the lolcommits CLI.
+    module Fatals
+      include Lolcommits
+      include Methadone::CLILogging
+
+      # Check for platform related conditions that could prevent lolcommits from
+      # working properly.
+      #
+      # Die with an informative error message if any occur.
+      def self.die_on_fatal_platform_conditions!
+        # make sure the capture binaries are in a good state
+        if Platform.platform_mac?
+          %w(imagesnap videosnap).each do |executable|
+            next if 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
+        elsif Platform.platform_linux?
+          unless Platform.command_which('mplayer')
+            fatal "Couldn't find mplayer in your PATH!"
+            exit 1
+          end
+        end
+
+        # make sure we can find the Impact truetype font
+        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
+
+        # make sure imagemagick is around and good to go
+        unless Platform.valid_imagemagick_installed?
+          fatal 'FATAL: ImageMagick does not appear to be properly installed!'\
+                '(or version is too old)'
+          exit 1
+        end
+
+        # check for a error condition with git config affecting ruby-git
+        if Platform.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
+
+      # Die with an informative error message if ffmpeg is not installed.
+      # This is only used for certain functions (such as animation), so only run
+      # this when you know the user wants to perform one of them.
+      def self.die_if_no_valid_ffmpeg_installed!
+        unless Platform.valid_ffmpeg_installed?
+          fatal 'FATAL: ffmpeg does not appear to be properly installed!'
+          exit 1
+        end
+      end
+
+      # If we are not in a git repo, we can't do git related things!
+      # Die with an informative error message in that case.
+      def self.die_if_not_git_repo!
+        debug 'Checking for valid git repo'
+        Git.open('.') # FIXME: should be extracted to GitInfo class
+        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
+  end
+end

data/lib/lolcommits/cli/launcher.rb

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+require 'launchy'
+
+module Lolcommits
+  module CLI
+    # Helper class for wrapping the opening of files on the desktop in a
+    # cross-platform way.
+    #
+    # Right now this is mostly just a wrapper for Launchy, in case we want
+    # to factor out it's dependency later or swap it out.
+    class Launcher
+      def self.open_image(path)
+        open_with_launchy(path)
+      end
+
+      def self.open_folder(path)
+        open_with_launchy(path)
+      end
+
+      # Opens with Launchy, which knows how to open pretty much anything
+      # local files, urls, etc.
+      #
+      # Private so we replace it later easier if we want.
+      def self.open_with_launchy(thing)
+        Launchy.open(thing)
+      end
+    end
+  end
+end

data/lib/lolcommits/cli/process_runner.rb

@@ -0,0 +1,48 @@
+# -*- encoding: utf-8 -*-
+
+module Lolcommits
+  module CLI
+    # Helper class for forking lolcommits process to the background (or not).
+    class ProcessRunner
+      # Initializes a new process runner.
+      #
+      # @param config [Lolcommits::Configuration]
+      def initialize(config)
+        @configuration = config
+      end
+
+      # Forks the lolcommits process if requested.
+      #
+      # Writes the PID of the lolcommits process to the filesystem when
+      # backgrounded, for monitoring purposes.
+      #
+      # @param please [Boolean] whether or not to fork lolcommits process
+      # @yield the main event loop for lolcommits
+      def fork_me?(please, &block)
+        if please
+          $stdout.sync = true
+          write_pid fork {
+            yield block
+            delete_pid
+          }
+        else
+          yield block
+        end
+      end
+
+      private
+
+      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
+    end
+  end
+end

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