lolcommits 0.6.4 → 0.6.5

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MTQ5MmRhOGIwMTQxNjczMTkwZmMxZWE1ZjdkNTJjNTc0OTcxNzM2Mg==
+    NDZhY2Q5NDc0OTVjMzA5ZDE4MmFkNzc3OTc4YTBkM2UxNGQzOTcyNQ==
   data.tar.gz: !binary |-
-    ODNkMmIxMDYzYjlmNmUyYjZjOTI3OGI2MGNhOWRmZDM5ZTUwZTRkYQ==
+    M2EwYjliMDA0ZmFmYThhOWVhNDUyMjlkMGMyZTA0ODAzNDE0ZTk5Ng==
 SHA512:
   metadata.gz: !binary |-
-    NDgxMTJlYWM3ZjEyOTBjZTEwZmExMTA0ZDZjMmU0MGM3MDk3ZTI1ZTc5NDkz
-    ZDhiMzEzZTBjMmJlZjMzOGI0YTViYjI4MGY3ZWE0YTA4MDg3OTFkNzU2ZTg5
-    Y2FhMmJmODhkN2U0OGVhNjY0MzcxODEyOWUxMDU1MzcxZWI1MWM=
+    NmYzMmU0YjJjYjlmNTk4ODFlNDM0MDVkZDlhOWQzODI3ZTE0ZGM4ZTg4NjY1
+    ZDBhODFlNWU0NDUyODA0Y2FjNTM5YzVkNzk5MDNlNzI0ODlmMTgwYjE5Njc5
+    ZWU2NjY0MmM0MTc5NzcwZjhkODU0ZDAyODFkMmM3ODU4YTcyY2M=
   data.tar.gz: !binary |-
-    OWM3YTRkMzFkZGJiNmQ4MDM2OTUzZWEwZDA3MThiZDBkNTNlYmJlN2U4ZmFl
-    MGQwNmQ4NWU0MzdlNTk4M2I4N2U5OGJiODNmMjg5MDc3ODk2Y2NiYzU3ZjVj
-    NjcyZjA2YjZkZTZkMjg1ZDY1M2MwZTJiOGE4ZTg1NjQ4NDAzM2U=
+    YmQzZGVjYWE3YWU5ZjViOWZhNTZlYTFiOGMwNTE3OTA5MWEzMzFmZTFjYjc0
+    ODliNTdjOGVkNzJhMWFhODlhZTczZjk4NTdjNTQ3NDI1MTUxODMxYmZiNDI2
+    Njc1MThhMmVlZDBkYmI2NThjNDJiYjFmMTBjNDZkMWY0ZWUwYjE=

data/CHANGELOG.md

@@ -3,6 +3,9 @@
 0.7.0 (WIP)
   * extract plugins to separate gems ...
 
+0.6.5 (12 April 2016)
+  * Add mercurial support (@tak #301 #302 #303)
+
 0.6.4 (15 March 2016)
   * Add quotes to correctly handle paths with spaces (@matthutchinson #298)
 

data/bin/lolcommits

@@ -113,7 +113,7 @@ def do_configure
 end
 
 def do_last
-  Fatals.die_if_not_git_repo!
+  Fatals.die_if_not_vcs_repo!
   lolimage = configuration.most_recent
   if lolimage.nil?
     warn 'No lolcommits have been captured for this repository yet.'
@@ -132,9 +132,11 @@ def change_dir_to_root_or_repo!
   loop do
     cur = File.expand_path('.')
     nxt = File.expand_path('..', cur)
-    if File.directory?(File.expand_path('.git')) || nxt == cur
-      return # found root or git dir
+    if nxt == cur
+      warn 'Repository root not found'
+      return
     end
+    return if VCSInfo.repo_root?
     Dir.chdir(nxt)
   end
 end
@@ -304,6 +306,8 @@ Fatals.die_on_fatal_platform_conditions!
 #
 change_dir_to_root_or_repo!
 
+# TODO: Allow local backend definitions?
+
 #
 # load system local plugins
 #
@@ -326,7 +330,7 @@ elsif Choice.choices[:devices]
 elsif Choice.choices[:last]
   do_last
 elsif Choice.choices[:browse]
-  Fatals.die_if_not_git_repo!
+  Fatals.die_if_not_vcs_repo!
   Launcher.open_folder(configuration.loldir)
 elsif Choice.choices[:gif]
   TimelapseGif.new(configuration).run(Choice.choices[:gif])

data/features/lolcommits.feature

@@ -24,31 +24,31 @@ Feature: Basic UI functionality
     Given I am in a git repo
     When I successfully run `lolcommits --enable`
     Then the output should contain "installed lolcommit hook to:"
-      And the lolcommits post-commit hook should be properly installed
+      And the lolcommits git post-commit hook should be properly installed
       And the exit status should be 0
 
-  Scenario: Enable in a git repo that already has a post-commit hook
+  Scenario: Enable in a git repo that already has a git post-commit hook
     Given I am in a git repo
-    And a post-commit hook with "#!/bin/sh\n\n/my/own/script"
+    And a git post-commit hook with "#!/bin/sh\n\n/my/own/script"
     When I successfully run `lolcommits --enable`
     Then the output should contain "installed lolcommit hook to:"
-      And the lolcommits post-commit hook should be properly installed
-      And the post-commit hook should contain "#!/bin/sh"
-      And the post-commit hook should contain "/my/own/script"
+      And the lolcommits git post-commit hook should be properly installed
+      And the git post-commit hook should contain "#!/bin/sh"
+      And the git post-commit hook should contain "/my/own/script"
       And the exit status should be 0
 
-  Scenario: Enable in a git repo that has post-commit hook with a bad shebang
+  Scenario: Enable in a git repo that has git post-commit hook with a bad shebang
     Given I am in a git repo
-    And a post-commit hook with "#!/bin/ruby"
+    And a git post-commit hook with "#!/bin/ruby"
     And I run `lolcommits --enable`
       Then the output should contain "doesn't start with a good shebang"
-      And the post-commit hook should not contain "lolcommits --capture"
+      And the git post-commit hook should not contain "lolcommits --capture"
       And the exit status should be 1
 
   Scenario: Enable in a git repo passing capture arguments
     Given I am in a git repo
     When I successfully run `lolcommits --enable -w 5 --fork`
-    Then the post-commit hook should contain "lolcommits --capture -w 5 --fork"
+    Then the git post-commit hook should contain "lolcommits --capture -w 5 --fork"
     And the exit status should be 0
 
   Scenario: Disable in a enabled git repo
@@ -63,7 +63,7 @@ Feature: Basic UI functionality
     When I run `lolcommits --enable`
     Then the output should contain:
       """
-      You don't appear to be in the base directory of a git project.
+      You don't appear to be in the base directory of a supported vcs project.
       """
     And the exit status should be 1
 
@@ -77,7 +77,7 @@ Feature: Basic UI functionality
       And a file named "~/.lolcommits/forked/tmp_snapshot.jpg" should not exist
       And there should be exactly 1 jpg in "~/.lolcommits/forked"
 
-  Scenario: Commiting in an enabled repo triggers successful capture
+  Scenario: Commiting in an enabled git repo triggers successful capture
     Given I am in a git repo named "myrepo" with lolcommits enabled
     When I do a git commit
     Then the output should contain "*** Preserving this moment in history."
@@ -85,7 +85,7 @@ Feature: Basic UI functionality
       And a file named "~/.lolcommits/myrepo/tmp_snapshot.jpg" should not exist
       And there should be exactly 1 jpg in "~/.lolcommits/myrepo"
 
-  Scenario: Commiting in enabled repo subdirectory triggers successful capture
+  Scenario: Commiting in enabled git repo subdirectory triggers successful capture
     Given I am in a git repo named "testcapture" with lolcommits enabled
       And a directory named "subdir"
       And an empty file named "subdir/FOOBAR"
@@ -158,7 +158,7 @@ Feature: Basic UI functionality
     When I successfully run `lolcommits --test --show-config`
     Then the output should match /loltext:\s+enabled: false/
 
-  Scenario: test capture should work regardless of whether in a git repo
+  Scenario: test capture should work regardless of whether in a lolrepo
     Given I am in a directory named "nothingtoseehere"
     When I run `lolcommits --test --capture`
     Then the output should contain "*** Capturing in test mode."
@@ -171,13 +171,13 @@ Feature: Basic UI functionality
     Then a directory named "~/.lolcommits/test" should exist
     And a directory named "~/.lolcommits/randomgitrepo" should not exist
 
-  Scenario: last command should work properly when in a lolrepo
+  Scenario: last command should work properly when in a git lolrepo
     Given I am in a git repo
     And its loldir has 2 lolimages
     When I run `lolcommits --last`
     Then the exit status should be 0
 
-  Scenario: last command should work properly when in a lolrepo subdirectory
+  Scenario: last command should work properly when in a git lolrepo subdirectory
     Given I am in a git repo
       And its loldir has 2 lolimages
       And a directory named "randomdir"
@@ -185,7 +185,7 @@ Feature: Basic UI functionality
     When I run `lolcommits --last`
     Then the output should not contain:
       """
-      Can't do that since we're not in a valid git repository!
+      Unknown VCS
       """
     And the exit status should be 0
 
@@ -195,7 +195,7 @@ Feature: Basic UI functionality
     When I run `lolcommits --last`
     Then the output should contain:
       """
-      Can't do that since we're not in a valid git repository!
+      Unknown VCS
       """
     And the exit status should be 1
 
@@ -209,13 +209,13 @@ Feature: Basic UI functionality
       """
     Then the exit status should be 1
 
-  Scenario: browse command should work properly when in a lolrepo
+  Scenario: browse command should work properly when in a git lolrepo
     Given I am in a git repo
     And its loldir has 2 lolimages
     When I run `lolcommits --browse`
     Then the exit status should be 0
 
-  Scenario: browse command should work properly when in a lolrepo subdirectory
+  Scenario: browse command should work properly when in a git lolrepo subdirectory
     Given I am in a git repo
       And its loldir has 2 lolimages
       And a directory named "subdir"
@@ -223,7 +223,7 @@ Feature: Basic UI functionality
     When I run `lolcommits --browse`
     Then the output should not contain:
       """
-      Can't do that since we're not in a valid git repository!
+      Unknown VCS
       """
     And the exit status should be 0
 
@@ -233,11 +233,11 @@ Feature: Basic UI functionality
     When I run `lolcommits --browse`
     Then the output should contain:
       """
-      Can't do that since we're not in a valid git repository!
+      Unknown VCS
       """
     And the exit status should be 1
 
-  Scenario: handle commit messages with quotation marks
+  Scenario: handle git commit messages with quotation marks
     Given I am in a git repo with lolcommits enabled
     When I successfully run `git commit --allow-empty -m 'no "air quotes" bae'`
     Then the exit status should be 0
@@ -278,9 +278,101 @@ Feature: Basic UI functionality
       """
     And the exit status should be 1
 
-  Scenario: Enable on windows platform setting PATH in post-commit hook
+  Scenario: Enable on windows platform setting PATH in git post-commit hook
     Given I am using a "win32" platform
       And I am in a git repo
     When I successfully run `lolcommits --enable`
-    Then the post-commit hook should contain "set path"
+    Then the git post-commit hook should contain "set path"
     And the exit status should be 0
+
+  Scenario: Enable in a naked mercurial repo
+    Given I am in a mercurial repo
+    When I successfully run `lolcommits --enable`
+    Then the output should contain "installed lolcommit hook to:"
+    And the lolcommits mercurial post-commit hook should be properly installed
+    And the exit status should be 0
+
+  Scenario: Enable in a mercurial repo that already has a mercurial post-commit hook
+    Given I am in a mercurial repo
+    And a mercurial post-commit hook with "[hooks]\npost-commit.mine = /my/own/script"
+    When I successfully run `lolcommits --enable`
+    Then the output should contain "installed lolcommit hook to:"
+    And the lolcommits mercurial post-commit hook should be properly installed
+    And the mercurial post-commit hook should contain "post-commit.mine = /my/own/script"
+    And the exit status should be 0
+
+  Scenario: Enable in a mercurial repo passing capture arguments
+    Given I am in a mercurial repo
+    When I successfully run `lolcommits --enable -w 5 --fork`
+    Then the mercurial post-commit hook should contain "lolcommits --capture -w 5 --fork"
+    And the exit status should be 0
+
+  Scenario: Disable in a enabled mercurial repo
+    Given I am in a mercurial repo with lolcommits enabled
+    When I successfully run `lolcommits --disable`
+    Then the output should contain "uninstalled"
+    And a file named ".hg/hgrc" should exist
+    And the exit status should be 0
+
+  Scenario: Commiting in an enabled mercurial repo triggers successful capture
+    Given I am in a mercurial repo named "myrepo" with lolcommits enabled
+    When I do a mercurial commit
+    Then the output should contain "*** Preserving this moment in history."
+    And a directory named "~/.lolcommits/myrepo" should exist
+    And a file named "~/.lolcommits/myrepo/tmp_snapshot.jpg" should not exist
+    And there should be exactly 1 jpg in "~/.lolcommits/myrepo"
+
+  Scenario: Commiting in enabled mercurial repo subdirectory triggers successful capture
+    Given I am in a mercurial repo named "testcapture" with lolcommits enabled
+    And a directory named "subdir"
+    And an empty file named "subdir/FOOBAR"
+    When I cd to "subdir/"
+    And I do a mercurial commit
+    Then the output should contain "*** Preserving this moment in history."
+    And a directory named "~/.lolcommits/testcapture" should exist
+    And a directory named "~/.lolcommits/subdir" should not exist
+    And there should be exactly 1 jpg in "~/.lolcommits/testcapture"
+
+  Scenario: last command should work properly when in a mercurial lolrepo
+    Given I am in a mercurial repo
+    And its loldir has 2 lolimages
+    When I run `lolcommits --last`
+    Then the exit status should be 0
+
+  Scenario: last command should work properly when in a mercurial lolrepo subdirectory
+    Given I am in a mercurial repo
+    And its loldir has 2 lolimages
+    And a directory named "randomdir"
+    And I cd to "randomdir"
+    When I run `lolcommits --last`
+    Then the output should not contain:
+      """
+      Unknown VCS
+      """
+    And the exit status should be 0
+
+  Scenario: browse command should work properly when in a mercurial lolrepo
+    Given I am in a mercurial repo
+    And its loldir has 2 lolimages
+    When I run `lolcommits --browse`
+    Then the exit status should be 0
+
+  Scenario: browse command should work properly when in a mercurial lolrepo subdirectory
+    Given I am in a mercurial repo
+    And its loldir has 2 lolimages
+    And a directory named "subdir"
+    And I cd to "subdir"
+    When I run `lolcommits --browse`
+    Then the output should not contain:
+      """
+      Unknown VCS
+      """
+    And the exit status should be 0
+
+  Scenario: handle mercurial commit messages with quotation marks
+    Given I am in a mercurial repo with lolcommits enabled
+    When I successfully run `touch meh`
+    And I successfully run `hg add meh`
+    And I successfully run `hg commit -m 'no "air quotes" bae'`
+    Then the exit status should be 0
+    And there should be exactly 1 jpg in its loldir

data/features/step_definitions/lolcommits_steps.rb

@@ -2,12 +2,16 @@
 require 'fileutils'
 require 'aruba/api'
 
-def postcommit_hook
+def postcommit_hook_git
   '.git/hooks/post-commit'
 end
 
+def postcommit_hook_mercurial
+  '.hg/hgrc'
+end
+
 def default_repo
-  'mygit'
+  'myrepo'
 end
 
 def default_loldir
@@ -53,24 +57,77 @@ Given(/^I am in a git repo with lolcommits enabled$/) do
     )
 end
 
-Given(/^a post\-commit hook with "(.*?)"$/) do |file_content|
+Given(/^a git post\-commit hook with "(.*?)"$/) do |file_content|
   steps %(
-    Given a file named "#{postcommit_hook}" with:
+    Given a file named "#{postcommit_hook_git}" with:
       """
       #{file_content}
       """
     )
 end
 
-Then(/^the lolcommits post\-commit hook should be properly installed$/) do
+Then(/^the lolcommits git post\-commit hook should be properly installed$/) do
+  steps %(
+    Then the git post-commit hook should contain "lolcommits --capture"
+    )
+end
+
+Then(/^the git post\-commit hook (should|should not) contain "(.*?)"$/) do |should, content|
+  steps %(
+    Then the file "#{postcommit_hook_git}" #{should} contain "#{content}"
+    )
+end
+
+Given(/^a mercurial repo named "(.*?)"$/) do |repo_name|
+  steps %(
+   Given I successfully run `hg init "#{repo_name}"`
+    )
+end
+
+Given(/^I am in a mercurial repo named "(.*?)"$/) do |repo|
   steps %(
-    Then the post-commit hook should contain "lolcommits --capture"
+    Given a mercurial repo named "#{repo}"
+    And I cd to "#{repo}"
+    )
+end
+
+Given(/^I am in a mercurial repo$/) do
+  steps %(
+    Given I am in a mercurial repo named "#{default_repo}"
+    )
+end
+
+Given(/^I am in a mercurial repo named "(.*?)" with lolcommits enabled$/) do |repo|
+  steps %(
+    Given I am in a mercurial repo named "#{repo}"
+    And I successfully run `lolcommits --enable`
     )
 end
 
-Then(/^the post\-commit hook (should|should not) contain "(.*?)"$/) do |should, content|
+Given(/^I am in a mercurial repo with lolcommits enabled$/) do
   steps %(
-    Then the file "#{postcommit_hook}" #{should} contain "#{content}"
+    Given I am in a mercurial repo named "#{default_repo}" with lolcommits enabled
+    )
+end
+
+Given(/^a mercurial post\-commit hook with "(.*?)"$/) do |file_content|
+  steps %(
+    Given a file named "#{postcommit_hook_mercurial}" with:
+      """
+      #{file_content}
+      """
+    )
+end
+
+Then(/^the lolcommits mercurial post\-commit hook should be properly installed$/) do
+  steps %(
+    Then the mercurial post-commit hook should contain "lolcommits --capture"
+    )
+end
+
+Then(/^the mercurial post\-commit hook (should|should not) contain "(.*?)"$/) do |should, content|
+  steps %(
+    Then the file "#{postcommit_hook_mercurial}" #{should} contain "#{content}"
     )
 end
 
@@ -132,6 +189,31 @@ Then(/^there should be (\d+) commit entries in the git log$/) do |n|
   expect(n.to_i).to eq `git shortlog | grep -E '^[ ]+\w+' | wc -l`.chomp.to_i
 end
 
+When(/^I do a mercurial commit with commit message "(.*?)"$/) do |commit_msg|
+  filename = Faker::Lorem.words(1).first
+  steps %(
+    Given a 98 byte file named "#{filename}"
+    And I successfully run `hg add #{filename}`
+    And I successfully run `hg commit -m "#{commit_msg}"`
+    )
+end
+
+When(/^I do a mercurial commit$/) do
+  step %(I do a mercurial commit with commit message "#{Faker::Lorem.sentence}")
+end
+
+When(/^I do (\d+) mercurial commits$/) do |n|
+  n.to_i.times do
+    step %(I do a mercurial commit)
+    sleep 0.1
+  end
+end
+
+Then(/^there should be (\d+) commit entries in the mercurial log$/) do |n|
+  sleep 1 # let the file writing catch up
+  expect(n.to_i).to eq `hg log | grep '^changeset:' | wc -l`.chomp.to_i
+end
+
 Given(/^I am using a "(.*?)" platform$/) do |host_os_name|
   set_env 'LOLCOMMITS_FAKE_HOST_OS', host_os_name
 end

data/lib/core_ext/mercurial-ruby/command.rb

@@ -0,0 +1,36 @@
+# need to use popen3 on windows - popen4 always eventually calls fork
+if Lolcommits::Platform.platform_windows?
+
+  module Mercurial
+    class Command
+      private
+
+      def execution_proc
+        proc do
+          debug(command)
+          result = ''
+          error = ''
+          status = nil
+          Open3.popen3(command) do |_stdin, stdout, stderr, wait_thread|
+            Timeout.timeout(timeout) do
+              while (tmp = stdout.read(102_400))
+                result += tmp
+              end
+            end
+
+            while (tmp = stderr.read(1024))
+              error += tmp
+            end
+            status = if RUBY_VERSION =~ /^1\.8/
+                       error.empty? ? 0 : 1
+                     else
+                       wait_thread.value
+                     end
+          end
+          raise_error_if_needed(status, error)
+          result
+        end
+      end
+    end
+  end
+end

data/lib/core_ext/mercurial-ruby/shell.rb

@@ -0,0 +1,16 @@
+# windows command line doesn't like single quotes
+module Mercurial
+  class Shell
+    def self.interpolate_arguments(cmd_with_args)
+      cmd_with_args.shift.tap do |cmd|
+        cmd.gsub!(/\?/) do
+          if Lolcommits::Platform.platform_windows?
+            "\"#{cmd_with_args.shift}\""
+          else
+            cmd_with_args.shift.to_s.enclose_in_single_quotes
+          end
+        end
+      end
+    end
+  end
+end

data/lib/core_ext/string.rb

@@ -0,0 +1,9 @@
+# -*- encoding : utf-8 -*-
+if RUBY_VERSION =~ /^1\.8/
+  class String
+    # used unconditionally by mercurial-ruby
+    def encode(str, _options)
+      str
+    end
+  end
+end

data/lib/lolcommits.rb

@@ -2,6 +2,7 @@
 $LOAD_PATH.unshift File.expand_path('.')
 
 require 'core_ext/class'
+require 'core_ext/string'
 require 'mini_magick'
 require 'core_ext/mini_magick/utilities'
 require 'fileutils'
@@ -9,15 +10,26 @@ require 'git'
 require 'open3'
 require 'methadone'
 require 'date'
+require 'mercurial-ruby'
+require 'core_ext/mercurial-ruby/shell'
 
 require 'lolcommits/version'
 require 'lolcommits/configuration'
 require 'lolcommits/capturer'
-require 'lolcommits/git_info'
+require 'lolcommits/vcs_info'
 require 'lolcommits/installation'
 require 'lolcommits/plugin'
 require 'lolcommits/platform'
 
+# after lolcommits/platform, so that we can do platform-conditional override
+require 'core_ext/mercurial-ruby/command'
+
+# backends
+require 'lolcommits/backends/installation_git'
+require 'lolcommits/backends/installation_mercurial'
+require 'lolcommits/backends/git_info'
+require 'lolcommits/backends/mercurial_info'
+
 require 'lolcommits/plugins/loltext'
 require 'lolcommits/plugins/dot_com'
 require 'lolcommits/plugins/tranzlate'

data/lib/lolcommits/{git_info.rb → backends/git_info.rb}

@@ -1,12 +1,20 @@
 # -*- encoding : utf-8 -*-
 module Lolcommits
-  class GitInfo
+  class GitInfo < VCSInfo
     include Methadone::CLILogging
     attr_accessor :sha, :message, :repo_internal_path, :repo, :url,
                   :author_name, :author_email, :branch
 
     GIT_URL_REGEX = %r{.*[:]([\/\w\-]*).git}
 
+    def self.repo_root?(path = '.')
+      File.directory?(File.join(path, '.git'))
+    end
+
+    def self.local_name(path = '.')
+      File.basename(Git.open(path).dir.to_s)
+    end
+
     def initialize
       debug 'GitInfo: parsed the following values from commit:'
       debug "GitInfo: \t#{message}"

data/lib/lolcommits/backends/installation_git.rb

@@ -0,0 +1,121 @@
+# -*- encoding : utf-8 -*-
+module Lolcommits
+  #
+  # Methods to handle enabling and disabling of lolcommits
+  #
+  class InstallationGit
+    HOOK_PATH = File.join '.git', 'hooks', 'post-commit'
+    HOOK_DIR = File.join '.git', 'hooks'
+
+    #
+    # IF --ENABLE, DO ENABLE
+    #
+    def self.do_enable
+      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
+      Dir.mkdir(HOOK_DIR) unless File.directory?(HOOK_DIR)
+
+      # should add a shebang (or not) adding will rewrite hook file
+      add_shebang = false
+      if hook_file_exists?
+        # clear away any existing lolcommits hook
+        remove_existing_hook! if lolcommits_hook_exists?
+
+        # if file is empty we should add a shebang (and rewrite hook)
+        if File.read(HOOK_PATH).strip.empty?
+          add_shebang = true
+        elsif !good_shebang?
+          # look for good shebang in existing hook, abort if none found
+          warn "the existing hook (at #{HOOK_PATH}) doesn't start with a good shebang; like #!/bin/sh"
+          exit 1
+        end
+      else
+        add_shebang = true
+      end
+
+      File.open(HOOK_PATH, add_shebang ? 'w' : 'a') do |f|
+        f.write("#!/bin/sh\n") if add_shebang
+        f.write(hook_script)
+      end
+
+      FileUtils.chmod 0755, HOOK_PATH
+      HOOK_PATH
+    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.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"
+        end
+      else
+        info "no post commit hook found (at #{HOOK_PATH}), so there is nothing to uninstall"
+      end
+    end
+
+    def self.hook_script
+      ruby_path     = Lolcommits::Platform.command_which('ruby', true)
+      imagick_path  = Lolcommits::Platform.command_which('identify', true)
+
+      if Lolcommits::Platform.platform_windows?
+        hook_export = "set path \"#{ruby_path};#{imagick_path};%PATH%\"\n"
+      else
+        locale_export = "export LANG=\"#{ENV['LANG']}\"\n"
+        hook_export   = "export PATH=\"#{ruby_path}:#{imagick_path}:$PATH\"\n"
+      end
+
+      capture_cmd   = 'lolcommits --capture'
+      capture_args  = " #{ARGV[1..-1].join(' ')}" if ARGV.length > 1
+
+      <<-EOS
+### lolcommits hook (begin) ###
+if [ ! -d "$GIT_DIR/rebase-merge" ]; then
+#{locale_export}#{hook_export}#{capture_cmd}#{capture_args}
+fi
+###  lolcommits hook (end)  ###
+EOS
+    end
+
+    # does a git hook exist at all?
+    def self.hook_file_exists?
+      File.exist?(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 =~ %r{^\#\!\/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|
+        skip = true if !skip && (line =~ /lolcommits.*\(begin\)/)
+
+        out << line unless skip
+
+        skip = false if skip && (line =~ /lolcommits.*\(end\)/)
+      end
+
+      out.close
+    end
+  end
+end

data/lib/lolcommits/backends/installation_mercurial.rb

@@ -0,0 +1,88 @@
+# -*- encoding : utf-8 -*-
+module Lolcommits
+  #
+  # Methods to handle enabling and disabling of lolcommits
+  #
+  class InstallationMercurial
+    HOOK_SECTION = 'hooks'.freeze
+    HOOK_OPERATIONS = %w(commit record crecord).freeze
+
+    #
+    # IF --ENABLE, DO ENABLE
+    #
+    def self.do_enable
+      unless File.directory?('.hg')
+        fatal "You don't appear to be in the base directory of a mercurial project."
+        exit 1
+      end
+
+      if lolcommits_hook_exists?
+        # clear away any existing lolcommits hook
+        remove_existing_hook!
+      end
+
+      config = repository.config
+      HOOK_OPERATIONS.each do |op|
+        config.add_setting(HOOK_SECTION, "post-#{op}.lolcommits", hook_script)
+      end
+      config.path
+    end
+
+    #
+    # IF --DISABLE, DO DISABLE
+    #
+    def self.do_disable
+      config = repository.config
+      if lolcommits_hook_exists?
+        remove_existing_hook!
+        info "uninstalled lolcommits hook (from #{config.path})"
+      elsif config.exists?
+        info "couldn't find an lolcommits hook (at #{config.path})"
+      else
+        info "no post commit hook found (at #{config.path}), so there is nothing to uninstall"
+      end
+    end
+
+    def self.hook_script
+      ruby_path     = Lolcommits::Platform.command_which('ruby', true)
+      imagick_path  = Lolcommits::Platform.command_which('identify', true)
+      capture_cmd   = 'lolcommits --capture'
+
+      if Lolcommits::Platform.platform_windows?
+        capture_cmd = "set path=#{ruby_path};#{imagick_path};%PATH%&&#{capture_cmd}"
+      else
+        locale_export = "LANG=\"#{ENV['LANG']}\""
+        hook_export   = "PATH=\"#{ruby_path}:#{imagick_path}:$PATH\""
+        capture_cmd = "#{locale_export} #{hook_export} #{capture_cmd}"
+      end
+
+      capture_args = ARGV[1..-1].join(' ') if ARGV.length > 1
+      "#{capture_cmd} #{capture_args}"
+    end
+
+    def self.repository
+      Mercurial::Repository.open('.')
+    end
+
+    # does a mercurial hook exist with lolcommits commands?
+    def self.lolcommits_hook_exists?
+      config = repository.config
+      config.exists? && config.setting_exists?(HOOK_SECTION, 'post-commit.lolcommits')
+    end
+
+    # can we load the hgrc?
+    def self.valid_hgrc?
+      repository.config.exists?
+    end
+
+    def self.remove_existing_hook!
+      config = repository.config
+      HOOK_OPERATIONS.each do |op|
+        setting = "post-#{op}.lolcommits"
+        if config.setting_exists?(HOOK_SECTION, setting)
+          config.delete_setting!(HOOK_SECTION, setting)
+        end
+      end
+    end
+  end
+end

data/lib/lolcommits/backends/mercurial_info.rb

@@ -0,0 +1,81 @@
+# -*- encoding : utf-8 -*-
+module Lolcommits
+  class MercurialInfo < VCSInfo
+    include Methadone::CLILogging
+    attr_accessor :sha, :message, :repo_internal_path, :repo, :url,
+                  :author_name, :author_email, :branch
+
+    def self.repo_root?(path = '.')
+      File.directory?(File.join(path, '.hg'))
+    end
+
+    def self.local_name(path = '.')
+      File.basename(File.dirname(Mercurial::Repository.open(path).dothg_path))
+    end
+
+    def initialize
+      # mercurial sets HG_RESULT for post- hooks
+      if ENV.key?('HG_RESULT') && ENV['HG_RESULT'] != '0'
+        debug 'Aborting lolcommits hook from failed operation'
+        exit 1
+      end
+
+      Mercurial.configure do |conf|
+        conf.hg_binary_path = 'hg'
+      end
+      debug 'MercurialInfo: parsed the following values from commit:'
+      debug "MercurialInfo: \t#{message}"
+      debug "MercurialInfo: \t#{sha}"
+      debug "MercurialInfo: \t#{repo_internal_path}"
+      debug "MercurialInfo: \t#{repo}"
+      debug "MercurialInfo: \t#{branch}"
+      debug "MercurialInfo: \t#{author_name}" if author_name
+      debug "MercurialInfo: \t#{author_email}" if author_email
+    end
+
+    def branch
+      @branch ||= last_commit.branch_name
+    end
+
+    def message
+      @message ||= begin
+        message = last_commit.message || ''
+        message.split("\n").first
+      end
+    end
+
+    def sha
+      @sha ||= last_commit.id[0..10]
+    end
+
+    def repo_internal_path
+      @repo_internal_path ||= repository.dothg_path
+    end
+
+    def url
+      @url ||= repository.path
+    end
+
+    def repo
+      @repo ||= File.basename(File.dirname(repo_internal_path))
+    end
+
+    def author_name
+      @author_name ||= last_commit.author
+    end
+
+    def author_email
+      @author_email ||= last_commit.author_email
+    end
+
+    private
+
+    def repository(path = '.')
+      @repository ||= Mercurial::Repository.open(path)
+    end
+
+    def last_commit
+      @commit ||= repository.commits.parent
+    end
+  end
+end

data/lib/lolcommits/cli/fatals.rb

@@ -64,12 +64,16 @@ module Lolcommits
 
       # 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!"
+      def self.die_if_not_vcs_repo!
+        debug 'Checking for valid vcs repo'
+        current = File.expand_path('.')
+        parent = File.dirname(current)
+        while current != parent
+          return if VCSInfo.repo_root?(current)
+          current = parent
+          parent = File.dirname(current)
+        end
+        fatal 'Unknown VCS'
         exit 1
       end
     end

data/lib/lolcommits/cli/timelapse_gif.rb

@@ -15,7 +15,7 @@ module Lolcommits
       # 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!
+        Fatals.die_if_not_vcs_repo!
 
         case args
         when 'today'

data/lib/lolcommits/configuration.rb

@@ -23,7 +23,12 @@ module Lolcommits
 
     def loldir
       return @loldir if @loldir
-      basename ||= File.basename(Git.open('.').dir.to_s).sub(/^\./, 'dot')
+      basename ||= if VCSInfo.repo_root?
+                     VCSInfo.local_name
+                   else
+                     File.basename(Dir.getwd)
+                   end
+      basename.sub!(/^\./, 'dot')
       basename.sub!(/ /, '-')
       @loldir = Configuration.loldir_for(basename)
     end

data/lib/lolcommits/installation.rb

@@ -4,48 +4,25 @@ 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'
+    def self.backend
+      if GitInfo.repo_root?
+        InstallationGit
+      elsif MercurialInfo.repo_root?
+        InstallationMercurial
+      else
+        fatal "You don't appear to be in the base directory of a supported vcs project."
+        exit 1
+      end
+    end
 
     #
     # IF --ENABLE, DO ENABLE
     #
     def self.do_enable
-      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
-      Dir.mkdir(HOOK_DIR) unless File.directory?(HOOK_DIR)
-
-      # should add a shebang (or not) adding will rewrite hook file
-      add_shebang = false
-      if hook_file_exists?
-        # clear away any existing lolcommits hook
-        remove_existing_hook! if lolcommits_hook_exists?
-
-        # if file is empty we should add a shebang (and rewrite hook)
-        if File.read(HOOK_PATH).strip.empty?
-          add_shebang = true
-        elsif !good_shebang?
-          # look for good shebang in existing hook, abort if none found
-          warn "the existing hook (at #{HOOK_PATH}) doesn't start with a good shebang; like #!/bin/sh"
-          exit 1
-        end
-      else
-        add_shebang = true
-      end
-
-      File.open(HOOK_PATH, add_shebang ? 'w' : 'a') do |f|
-        f.write("#!/bin/sh\n") if add_shebang
-        f.write(hook_script)
-      end
-
-      FileUtils.chmod 0755, HOOK_PATH
+      path = backend.do_enable
 
       info 'installed lolcommit hook to:'
-      info "  -> #{File.expand_path(HOOK_PATH)}"
+      info "  -> #{File.expand_path(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
@@ -55,72 +32,7 @@ module Lolcommits
     # IF --DISABLE, DO DISABLE
     #
     def self.do_disable
-      if lolcommits_hook_exists?
-        remove_existing_hook!
-        info "uninstalled lolcommits hook (from #{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"
-        end
-      else
-        info "no post commit hook found (at #{HOOK_PATH}), so there is nothing to uninstall"
-      end
-    end
-
-    def self.hook_script
-      ruby_path     = Lolcommits::Platform.command_which('ruby', true)
-      imagick_path  = Lolcommits::Platform.command_which('identify', true)
-
-      if Lolcommits::Platform.platform_windows?
-        hook_export = "set path \"#{ruby_path};#{imagick_path};%PATH%\"\n"
-      else
-        locale_export = "export LANG=\"#{ENV['LANG']}\"\n"
-        hook_export   = "export PATH=\"#{ruby_path}:#{imagick_path}:$PATH\"\n"
-      end
-
-      capture_cmd   = 'lolcommits --capture'
-      capture_args  = " #{ARGV[1..-1].join(' ')}" if ARGV.length > 1
-
-      <<-EOS
-### lolcommits hook (begin) ###
-if [ ! -d "$GIT_DIR/rebase-merge" ]; then
-#{locale_export}#{hook_export}#{capture_cmd}#{capture_args}
-fi
-###  lolcommits hook (end)  ###
-EOS
-    end
-
-    # does a git hook exist at all?
-    def self.hook_file_exists?
-      File.exist?(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 =~ %r{^\#\!\/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|
-        skip = true if !skip && (line =~ /lolcommits.*\(begin\)/)
-
-        out << line unless skip
-
-        skip = false if skip && (line =~ /lolcommits.*\(end\)/)
-      end
-
-      out.close
+      backend.do_disable
     end
   end
 end

data/lib/lolcommits/plugins/lol_protonet.rb

@@ -27,7 +27,7 @@ module Lolcommits
     end
 
     def message
-      "commited some #{random_adjective} #{random_object} to #{runner.git_info.repo}@#{runner.sha} (#{runner.git_info.branch}) "
+      "commited some #{random_adjective} #{random_object} to #{runner.vcs_info.repo}@#{runner.sha} (#{runner.vcs_info.branch}) "
     end
 
     def random_object

data/lib/lolcommits/plugins/lol_slack.rb

@@ -52,7 +52,7 @@ module Lolcommits
           :token    => configuration['access_token'],
           :filetype => 'jpg',
           :filename => runner.sha,
-          :title    => runner.message + "[#{runner.git_info.repo}]",
+          :title    => runner.message + "[#{runner.vcs_info.repo}]",
           :channels => configuration['channels'])
 
         debug response

data/lib/lolcommits/plugins/lolsrv.rb

@@ -40,8 +40,8 @@ module Lolcommits
     def upload(file, sha)
       RestClient.post(configuration['server'] + '/uplol',
                       :lol  => File.new(file),
-                      :url  => runner.git_info.url + sha,
-                      :repo => runner.git_info.repo,
+                      :url  => runner.vcs_info.url + sha,
+                      :repo => runner.vcs_info.repo,
                       :date => File.ctime(file),
                       :sha  => sha)
     rescue => e

data/lib/lolcommits/plugins/uploldz.rb

@@ -21,7 +21,7 @@ module Lolcommits
     def run_postcapture
       return unless valid_configuration?
 
-      if runner.git_info.repo.empty?
+      if runner.vcs_info.repo.empty?
         puts 'Repo is empty, skipping upload'
       else
         debug "Posting capture to #{configuration['endpoint']}"
@@ -29,9 +29,9 @@ module Lolcommits
                         {
                           :file         => File.new(runner.main_image),
                           :message      => runner.message,
-                          :repo         => runner.git_info.repo,
-                          :author_name  => runner.git_info.author_name,
-                          :author_email => runner.git_info.author_email,
+                          :repo         => runner.vcs_info.repo,
+                          :author_name  => runner.vcs_info.author_name,
+                          :author_email => runner.vcs_info.author_email,
                           :sha          => runner.sha,
                           :key          => configuration['optional_key']
                         },

data/lib/lolcommits/runner.rb

@@ -4,7 +4,7 @@ require 'lolcommits/platform'
 module Lolcommits
   class Runner
     attr_accessor :capture_delay, :capture_stealth, :capture_device, :message,
-                  :sha, :snapshot_loc, :main_image, :config, :git_info,
+                  :sha, :snapshot_loc, :main_image, :config, :vcs_info,
                   :capture_animate
 
     include Methadone::CLILogging
@@ -15,9 +15,16 @@ module Lolcommits
       end
 
       return unless sha.nil? || message.nil?
-      self.git_info = GitInfo.new
-      self.sha      = git_info.sha if sha.nil?
-      self.message  = git_info.message if message.nil?
+      if GitInfo.repo_root?
+        self.vcs_info = GitInfo.new
+      elsif MercurialInfo.repo_root?
+        self.vcs_info = MercurialInfo.new
+      else
+        raise('Unknown VCS')
+      end
+
+      self.sha      = vcs_info.sha if sha.nil?
+      self.message  = vcs_info.message if message.nil?
     end
 
     # wrap run to handle things that should happen before and after

data/lib/lolcommits/vcs_info.rb

@@ -0,0 +1,63 @@
+# -*- encoding : utf-8 -*-
+module Lolcommits
+  # base class ala plugin.rb
+  class VCSInfo
+    include Methadone::CLILogging
+    attr_accessor :sha, :message, :repo_internal_path, :repo, :url,
+                  :author_name, :author_email, :branch
+
+    def self.repo_root?(path = '.')
+      GitInfo.repo_root?(path) || MercurialInfo.repo_root?(path)
+    end
+
+    def self.base_message(method)
+      raise NotImplementedError, "#{self.class.name} is a base class; implement '#{method}' in a subclass", caller
+    end
+
+    def self.local_name(path = '.')
+      if GitInfo.repo_root?(path)
+        GitInfo.local_name(path)
+      elsif MercurialInfo.repo_root?(path)
+        MercurialInfo.local_name(path)
+      else
+        raise "'#{File.expand_path(path)}' is not the root of a supported VCS"
+      end
+    end
+
+    def initialize
+      base_message(__method__)
+    end
+
+    def branch
+      base_message(__method__)
+    end
+
+    def message
+      base_message(__method__)
+    end
+
+    def sha
+      base_message(__method__)
+    end
+
+    def repo_internal_path
+      base_message(__method__)
+    end
+
+    def url
+      base_message(__method__)
+    end
+
+    def repo
+      base_message(__method__)
+    end
+
+    def author_name
+      base_message(__method__)
+    end
+
+    def author_email
+      base_message(__method__)
+    end
+  end
+end

data/lib/lolcommits/version.rb

@@ -1,4 +1,4 @@
 # -*- encoding : utf-8 -*-
 module Lolcommits
-  VERSION = '0.6.4'.freeze
+  VERSION = '0.6.5'.freeze
 end

data/lolcommits.gemspec

@@ -42,6 +42,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency('launchy', '~> 2.4.3')
   s.add_runtime_dependency('methadone', '~> 1.8.0')
   s.add_runtime_dependency('open4', '~> 1.3.4')
+  s.add_runtime_dependency('mercurial-ruby', '~> 0')
 
   # plugin gems
   s.add_runtime_dependency('twitter', '~> 5.13.0')       # twitter

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lolcommits
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.6.5
 platform: ruby
 authors:
 - Matthew Rothenberg
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-15 00:00:00.000000000 Z
+date: 2016-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -179,6 +179,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.3.4
+- !ruby/object:Gem::Dependency
+  name: mercurial-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: twitter
   requirement: !ruby/object:Gem::Requirement
@@ -423,8 +437,15 @@ files:
 - features/support/env.rb
 - features/support/path_helpers.rb
 - lib/core_ext/class.rb
+- lib/core_ext/mercurial-ruby/command.rb
+- lib/core_ext/mercurial-ruby/shell.rb
 - lib/core_ext/mini_magick/utilities.rb
+- lib/core_ext/string.rb
 - lib/lolcommits.rb
+- lib/lolcommits/backends/git_info.rb
+- lib/lolcommits/backends/installation_git.rb
+- lib/lolcommits/backends/installation_mercurial.rb
+- lib/lolcommits/backends/mercurial_info.rb
 - lib/lolcommits/capturer.rb
 - lib/lolcommits/capturer/capture_cygwin.rb
 - lib/lolcommits/capturer/capture_fake.rb
@@ -438,7 +459,6 @@ files:
 - lib/lolcommits/cli/process_runner.rb
 - lib/lolcommits/cli/timelapse_gif.rb
 - lib/lolcommits/configuration.rb
-- lib/lolcommits/git_info.rb
 - lib/lolcommits/installation.rb
 - lib/lolcommits/platform.rb
 - lib/lolcommits/plugin.rb
@@ -453,6 +473,7 @@ files:
 - lib/lolcommits/plugins/tranzlate.rb
 - lib/lolcommits/plugins/uploldz.rb
 - lib/lolcommits/runner.rb
+- lib/lolcommits/vcs_info.rb
 - lib/lolcommits/version.rb
 - lolcommits.gemspec
 - test/images/test_image.jpg