lolcommits 0.5.2 → 0.5.3

data/lib/lolcommits/configuration.rb

@@ -1,33 +1,16 @@
+# -*- encoding : utf-8 -*-
 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={})
+    def initialize(attributes = {})
       attributes.each do |attr, val|
         self.send("#{attr}=", val)
       end
     end
 
-    def self.platform
-      if is_fakeplatform?
-        ENV['LOLCOMMITS_FAKEPLATFORM']
-      elsif is_fakecapture?
-        'Fake'
-      elsif is_mac?
-        'Mac'
-      elsif is_linux?
-        'Linux'
-      elsif is_windows?
-        'Windows'
-      elsif is_cygwin?
-        'Cygwin'
-      else
-        raise "Unknown / Unsupported Platform."
-      end
-    end
-
     def read_configuration
       if File.exists?(configuration_file)
         YAML.load(File.open(configuration_file))
@@ -57,21 +40,12 @@ module Lolcommits
       dir
     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, "*.jpg").max_by {|f| File.mtime(f)}
+      Dir.glob(File.join self.loldir, '*.jpg').max_by { |f| File.mtime(f) }
     end
 
     def images
-      Dir.glob(File.join self.loldir, "*.jpg").sort_by {|f| File.mtime(f)}
+      Dir.glob(File.join self.loldir, '*.jpg').sort_by { |f| File.mtime(f) }
     end
 
     def images_today
@@ -94,13 +68,22 @@ module Lolcommits
       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
+    end
+
     def puts_plugins
       puts "Available plugins: #{Lolcommits::PLUGINS.map(&:name).join(', ')}"
     end
 
     def ask_for_plugin_name
       puts_plugins
-      print "Name of plugin to configure: "
+      print 'Name of plugin to configure: '
       STDIN.gets.strip
     end
 
@@ -120,8 +103,9 @@ module Lolcommits
         plugin_name = ask_for_plugin_name
       end
 
-      if plugin = find_plugin(plugin_name)
-        config = self.read_configuration || Hash.new
+      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
@@ -147,27 +131,56 @@ module Lolcommits
       read_configuration.to_yaml.to_s
     end
 
-    def self.is_mac?
-      RUBY_PLATFORM.to_s.downcase.include?("darwin")
+    # 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.is_linux?
-      RUBY_PLATFORM.to_s.downcase.include?("linux")
+    def self.loldir_for(basename)
+      loldir = File.join(LOLBASEDIR, basename)
+
+      if not File.directory? loldir
+        FileUtils.mkdir_p loldir
+      end
+      loldir
     end
 
-    def self.is_windows?
-      !! RUBY_PLATFORM.match(/(win|w)32/)
+    def self.platform_mac?
+      RUBY_PLATFORM.to_s.downcase.include?('darwin')
     end
 
-    def self.is_cygwin?
-      RUBY_PLATFORM.to_s.downcase.include?("cygwin")
+    def self.platform_linux?
+      RUBY_PLATFORM.to_s.downcase.include?('linux')
     end
 
-    def self.is_fakecapture?
+    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.is_fakeplatform?
+    def self.platform_fakeplatform?
       ENV['LOLCOMMITS_FAKEPLATFORM']
     end
 
@@ -176,7 +189,7 @@ module Lolcommits
       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?
+      MiniMagick.valid_version_installed?
     end
 
     def self.valid_ffmpeg_installed?
@@ -198,13 +211,12 @@ module Lolcommits
     def self.command_which(cmd)
       exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
       ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
-        exts.each { |ext|
+        exts.each do |ext|
           exe = "#{path}/#{cmd}#{ext}"
           return exe if File.executable? exe
-        }
+        end
       end
-      return nil
+      nil
     end
-
   end
 end

data/lib/lolcommits/git_info.rb

@@ -1,19 +1,26 @@
+# -*- encoding : utf-8 -*-
 module Lolcommits
   class GitInfo
     include Methadone::CLILogging
-    attr_accessor :sha, :message, :repo_internal_path, :repo
+    attr_accessor :sha, :message, :repo_internal_path, :repo, :url
+
+    def remote_https_url(url)
+      url.gsub(':', '/').gsub(/^git@/, 'https://').gsub(/\.git$/, '') + '/commit/'
+    end
 
     def initialize
-      debug "GitInfo: attempting to read local repository"
+      debug 'GitInfo: attempting to read local repository'
       g    = Git.open('.')
-      debug "GitInfo: reading commits logs"
+      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/
+      self.url = remote_https_url(g.remote.url) if g.remote.url
+
+      regex = /.*[:]([\/\w\-]*).git/
       match = g.remote.url.match regex if g.remote.url
       if match
         self.repo = match[1]
@@ -21,10 +28,10 @@ module Lolcommits
         self.repo = g.repo.path.split(File::SEPARATOR)[-2]
       end
 
-      debug "GitInfo: parsed the following values from commit:"
+      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_internal_path}"
       debug "GitInfo: \t#{self.repo}"
     end
   end

data/lib/lolcommits/installation.rb

@@ -0,0 +1,117 @@
+# -*- encoding : utf-8 -*-
+module Lolcommits
+  #
+  # Methods to handle enabling and disabling of lolcommits
+  #
+  class Installation
+    HOOK_PATH = File.join '.git', 'hooks', 'post-commit'
+    HOOK_DIR = File.join '.git', 'hooks'
+
+    #
+    # IF --ENABLE, DO ENABLE
+    #
+    def self.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_file_exists?
+        remove_existing_hook! if lolcommits_hook_exists?
+
+        # 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_file_exists? ? 'a' : 'w') do |f|
+        f.write(hook_script(!hook_file_exists?))
+      end
+
+      FileUtils.chmod 0755, HOOK_PATH
+
+      info 'installed lolcommit 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
+
+    #
+    # IF --DISABLE, DO DISABLE
+    #
+    def self.do_disable
+      if lolcommits_hook_exists?
+        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
+    end
+
+    protected
+
+    def self.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
+
+    # does a git hook exist at all?
+    def self.hook_file_exists?
+      File.exists?(HOOK_PATH)
+    end
+
+    # does a git hook exist with lolcommits commands?
+    def self.lolcommits_hook_exists?
+      hook_file_exists? &&
+        File.read(HOOK_PATH).to_s =~ /lolcommits.*\(begin\)(.*\n)*.*lolcommits.*\(end\)/
+    end
+
+    # does the git hook file have a good shebang?
+    def self.good_shebang?
+      File.read(HOOK_PATH).lines.first =~ /^\#\!\/bin\/.*sh/
+    end
+
+    def self.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
+  end
+end

data/lib/lolcommits/plugin.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 module Lolcommits
   class Plugin
     include Methadone::CLILogging
@@ -5,34 +6,34 @@ module Lolcommits
     attr_accessor :runner, :options
 
     def initialize(runner)
-      debug "Initializing"
+      debug 'Initializing'
       self.runner = runner
       self.options = ['enabled']
     end
 
     def execute
-      if is_enabled?
-        debug "I am enabled, about to run"
+      if enabled?
+        debug 'I am enabled, about to run'
         run
       else
-        debug "Disabled, doing nothing for execution"
+        debug 'Disabled, doing nothing for execution'
       end
     end
 
     def run
-      debug "base plugin, does nothing to anything"
+      debug 'base plugin, does nothing to anything'
     end
 
     def configuration
       config = runner.config.read_configuration if runner
-      return Hash.new unless config
-      config[self.class.name] || Hash.new
+      return {} unless config
+      config[self.class.name] || {}
     end
 
     # ask for plugin options
     def configure_options!
       puts "Configuring plugin: #{self.class.name}\n"
-      options.inject(Hash.new) do |acc, option|
+      options.reduce(Hash.new) do |acc, option|
         print "#{option}: "
         val = STDIN.gets.strip.downcase
         if %w(true yes).include?(val)
@@ -44,13 +45,13 @@ module Lolcommits
       end
     end
 
-    def is_enabled?
+    def enabled?
       configuration['enabled'] == true
     end
 
     # check config is valid
     def valid_configuration?
-      if is_configured?
+      if configured?
         true
       else
         puts "Missing #{self.class.name} config - configure with: lolcommits --config -p #{self.class.name}"
@@ -59,7 +60,7 @@ module Lolcommits
     end
 
     # empty plugin configuration
-    def is_configured?
+    def configured?
       !configuration.empty?
     end
 

data/lib/lolcommits/plugins/dot_com.rb

@@ -1,8 +1,8 @@
+# -*- encoding : utf-8 -*-
 require 'httmultiparty'
 
 module Lolcommits
   class DotCom < Plugin
-
     def initialize(runner)
       super
       self.options.concat(['api_key', 'api_secret', 'repo_id'])
@@ -13,22 +13,22 @@ module Lolcommits
 
       t = Time.now.to_i.to_s
       resp = HTTMultiParty.post('http://www.lolcommits.com/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)
-          },
+                                :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)
-        }
+                                  :key   => configuration['api_key'],
+                                  :t     => t,
+                                  :token =>  Digest::SHA1.hexdigest(configuration['api_secret'] + t)
+                                }
       )
     end
 
-    def is_configured?
+    def configured?
       !configuration['enabled'].nil? &&
         configuration['api_key'] &&
         configuration['api_secret'] &&