snapgit 0.6.4

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 default font
+        unless File.readable? Lolcommits::Loltext::DEFAULT_FONT_PATH
+          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.to_s].flatten)
+
+        puts "*** #{gif.path} generated."
+      end
+    end
+  end
+end

data/lib/lolcommits/configuration.rb

@@ -0,0 +1,138 @@
+# -*- encoding : utf-8 -*-
+
+module Lolcommits
+  class Configuration
+    LOLCOMMITS_BASE = 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|
+        send("#{attr}=", val)
+      end
+    end
+
+    def read_configuration
+      return unless File.exist?(configuration_file)
+      YAML.load(File.open(configuration_file))
+    end
+
+    def configuration_file
+      "#{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 archivedir
+      dir = File.join(loldir, 'archive')
+      FileUtils.mkdir_p dir unless File.directory? dir
+      dir
+    end
+
+    def most_recent
+      Dir.glob(File.join(loldir, '*.{jpg,gif}')).max_by { |f| File.mtime(f) }
+    end
+
+    def jpg_images
+      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 }
+    end
+
+    def raw_image(image_file_type = 'jpg')
+      File.join loldir, "tmp_snapshot.#{image_file_type}"
+    end
+
+    def main_image(commit_sha, image_file_type = 'jpg')
+      File.join loldir, "#{commit_sha}.#{image_file_type}"
+    end
+
+    def video_loc
+      File.join(loldir, 'tmp_video.mov')
+    end
+
+    def frames_loc
+      File.join(loldir, 'tmp_frames')
+    end
+
+    def puts_plugins
+      puts "Available plugins: #{Lolcommits::Runner.plugins.map(&:name).join(', ')}"
+    end
+
+    def ask_for_plugin_name
+      puts_plugins
+      print 'Name of plugin to configure: '
+      STDIN.gets.strip
+    end
+
+    def find_plugin(plugin_name)
+      Lolcommits::Runner.plugins.each do |plugin|
+        return plugin.new(nil) if plugin.name == plugin_name
+      end
+
+      puts "Unable to find plugin: '#{plugin_name}'"
+      puts_plugins
+    end
+
+    # Modified by Felix to return useful values
+    def do_configure!(plugin_name)
+      plugin_name = ask_for_plugin_name if plugin_name.to_s.strip.empty?
+
+      plugin = find_plugin(plugin_name)
+      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} at path '#{configuration_file}'"
+        return configuration_file
+      else
+        puts "\nAborted plugin configuration for: #{plugin_name}"
+        return false
+      end
+    end
+
+    def save(config)
+      config_file_contents = config.to_yaml
+      File.open(configuration_file, 'w') do |f|
+        f.write(config_file_contents)
+      end
+    end
+
+    def to_s
+      read_configuration.to_yaml.to_s
+    end
+
+    # class methods
+
+    def self.loldir_for(basename)
+      loldir = File.join(LOLCOMMITS_BASE, basename)
+
+      if File.directory? loldir
+        begin
+          # ensure 755 permissions for loldir
+          File.chmod(0755, loldir)
+        rescue Errno::EPERM
+          # abort if permissions cannot be met
+          puts "FATAL: directory '#{loldir}' should be present and writeable by user '#{ENV['USER']}'"
+          puts 'Try changing the directory permissions to 755'
+          exit 1
+        end
+      else
+        FileUtils.mkdir_p loldir
+      end
+      loldir
+    end
+  end
+end

data/lib/lolcommits/git_info.rb

@@ -0,0 +1,82 @@
+# -*- encoding : utf-8 -*-
+module Lolcommits
+  class GitInfo
+    include Methadone::CLILogging
+    attr_accessor :sha, :message, :repo_internal_path, :repo, :url,
+                  :author_name, :author_email, :branch
+
+    GIT_URL_REGEX = %r{.*[:]([\/\w\-]*).git}
+
+    def initialize
+      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.tr(':', '/').tr(/^git@/, 'https://').tr(/\.git$/, '') + '/commit/'
+    end
+
+    def repository(path = '.')
+      @repository ||= Git.open(path)
+    end
+
+    def last_commit
+      @commit ||= repository.log.first
+    end
+  end
+end

data/lib/lolcommits/init.rb

@@ -0,0 +1,121 @@
+# -*- encoding : utf-8 -*-
+module Lolcommits
+  class Init
+    require 'lolcommits'
+    require 'fileutils'
+    require 'tmpdir'
+
+    # rubocop:disable Metrics/MethodLength
+    def self.run_setup(lolcommits_binary)
+      require 'io/console'
+      @lolcommits_binary = lolcommits_binary
+      set_lolcommits_env_config
+
+      puts 'This setup will run through the necessary steps to get you up and running'
+      puts 'Please follow the wizard to authenticate Twitter and Gravatar'
+      puts "If you don't want to use Gravatar, just don't provide any values"
+      puts 'Confirm with Enter'
+      STDIN.getch
+
+      Dir.mktmpdir do |_tmp_dir|
+        `git init` # just to make lolcommits believe we're in a git folder
+        result = request_auth_tokens
+
+        if result == false
+          puts 'Setup failed - please try again'
+          abort
+        end
+        @config_path = result
+      end
+
+      puts '-'
+      puts 'Successfully generated keys... now setting up your git projects:'
+      puts '-'
+
+      puts 'Do you want snapgit to automatically enable itself for all local git repositories? (y/n)'
+      if STDIN.getch.strip == 'y'
+        enable_for_all_projects
+      elsif File.directory?('.git')
+        puts 'Do you want to enable snapgit just for the local directory? (y/n)'
+        if STDIN.getch.strip == 'y'
+          enable_for_local_folder
+          return
+        end
+      else
+        puts '-'
+        puts 'Please navigate to the project you want to enable snapgit for'
+        puts 'and run `snapgit init`'
+        abort
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    def self.set_lolcommits_env_config
+      ENV['LOLCOMMITS_INIT_PARAMS'] = ' --delay 1' # this is required to actually work on a Mac
+      ENV['LOLCOMMITS_INIT_PARAMS'] += ' --stealth' # we don't want any output
+      ENV['LOLCOMMITS_INIT_PARAMS'] += ' &' # this way the delay is not noticable
+    end
+
+    # @return (success or not)
+    def self.request_auth_tokens
+      $stdout.sync = true
+      Configuration.new.do_configure!('snapgit')
+    end
+
+    def self.enable_for_local_folder
+      enable_for_project('.')
+      puts "Successfully enabled snapgit 🎉"
+    end
+
+    def self.enable_for_all_projects
+      projs = git_projects
+      puts projs
+      puts 'Do you want to enable snapgit for all those repos? (y/n)'
+      abort unless STDIN.getch.strip == 'y'
+
+      projs.each do |current|
+        enable_for_project(current)
+      end
+      puts "Successfully enabled snapgit for #{projs.count} projects 🎉"
+    end
+
+    def self.enable_for_project(path)
+      puts "Enabling snapgit for '#{File.expand_path(path)}'..."
+      Dir.chdir(path) do
+        # Add the `lolcommits --capture` to the post-hook
+        Lolcommits::Installation.do_enable
+
+        # Copy the config.yml to the ~/.lolcommits/[project] folder
+        to_path = Lolcommits::Configuration.new.loldir # this will use the current dir by default
+        # rubocop:disable Lint/HandleExceptions
+        begin
+          FileUtils.cp(@config_path, to_path)
+        rescue ArgumentError # if the file is the same
+        end
+        # rubocop:enable Lint/HandleExceptions
+      end
+    end
+
+    def self.git_projects
+      puts 'Searching for git repos'
+      # We're using README.md assuming that every repo has one
+      # This is due to Spotlight not finding hidden files (.git)
+      potential = `mdfind -name "README.md" -onlyin ~`.split("\n")
+
+      # After we have all README.md we look for a .git folder in
+      # each of those
+      potential.collect do |current|
+        path = File.expand_path('..', current)
+        path if File.directory?(File.join(path, '.git'))
+      end.delete_if(&:nil?)
+    end
+  end
+end
+
+# Cheap monkey patching to not get any output when enabling lolcommits
+module Lolcommits
+  class Installation
+    def self.info(_str)
+    end
+  end
+end