lolcommits 0.5.1 → 0.5.2.pre1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YjQ4MGRhYzg2Zjg0YTEwOTgxN2UyZTIzMGU1YzBkYzk1ZDk1NWJlOQ==
+  data.tar.gz: !binary |-
+    ZDRjYTY4MjAzNjdlNjUxM2ViZmY0Y2Q4MDQwODczMDMzNzQ0ODA1Nw==
+SHA512:
+  metadata.gz: !binary |-
+    OWFlYjVhYzM2MTU1OGM1NGJmMTY2MDc3MWQ3MzkzZDM1MmZhMThlNjI1MDky
+    NmJiOTI2NDI3NjYxN2IyMTA2ZTkwZWJlY2IzZTNjNmIyMWZhZTA3ZGMyODYy
+    YzFiN2EzZGQ1MDc0OTQ3MzM3N2JlM2U5MjE1YTI1YmIyZGVkNTY=
+  data.tar.gz: !binary |-
+    OWVkMjAzYjI4ZTdhZGZjZmQ3NzFmOWRjYzdiZWEwMDAzNzg4N2EzZTEzNWUy
+    ZGVhYmIzYzIwZGY1YzU5ZjM1NDZiOTJjNzk3OGQ5NGE4NDg2ZWYxZWU2ZjY0
+    Njk0ODdiMDRlZTJkZTAxMmMzMDQxNjI0NWVlMjA2ZWUxNjkzMGI=

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -1,3 +1,4 @@
+coverage
 *.gem
 .bundle
 Gemfile.lock

data/CHANGELOG

@@ -1,6 +1,19 @@
 0.x.x (in development)
   * TODO: figure out problems with GUI clients
 
+0.5.2 (4 December 2013)
+  * Allow lolsrv plugin to sync/upload gifs (@matthutchinson #180)
+  * Plugins refactor, can now configure themselves (@matthutchinson #179)
+    - also closes issue #136 and issue #73
+  * Fix for Twitter gem dependency issue (@matthutchinson #178)
+  * Added coveralls support (@Aaron1011 #177)
+    - gitignore updated, coveralls badge added to README
+  * Refactor tranzlate plugin, lolspeak now in plugin (@matthutchinson #176)
+  * Fix for 'Cannot satisfy json dependancy' (@matthutchinson #175)
+  * Better post commit hook enabling/disabling (@matthutchinson #173)
+  * Improved --enable option, accepts passing arguments (@matthutchinson #154)
+    - README updated to explain enabling with options
+
 0.5.1 (13 November 2013)
   * Fix JSON gem issue #163 (@matthutchinson, #171)
   * Enable image capture under Cygwin (@cwc, #105)

data/README.md

@@ -8,6 +8,7 @@ By default, the lolimages are stored by a Github style short SHA in a `~/.lolcom
 [![Gem Version](https://badge.fury.io/rb/lolcommits.png)](http://badge.fury.io/rb/lolcommits)
 [![Build Status](https://secure.travis-ci.org/mroth/lolcommits.png?branch=master)](http://travis-ci.org/mroth/lolcommits)
 [![Dependency Status](https://gemnasium.com/mroth/lolcommits.png)](https://gemnasium.com/mroth/lolcommits)
+[![Coverage Status](https://coveralls.io/repos/mroth/lolcommits/badge.png)](https://coveralls.io/r/mroth/lolcommits)
 
 ## Sample images
 <img src="http://blog.mroth.info/images/postcontent/yearinsideprojects/lolcommits_users2.jpg" />
@@ -47,22 +48,34 @@ From within any git repository, simply do a `lolcommits --enable`. From that poi
 Don't worry about it too much, half the fun of lolcommits is forgetting it's installed!
 
 ### Other commands
-Ok, if you insist... Since you know about `--enable`, common sense suggest there is also a repository specific `--disable`, hopefully you can guess what that does. Other handy common commands include `--last`, which will open for display your most recent lolcommit image, or `--browse`, which pops open the directory containing all the lolcommit images for your current repository. You can always do `--help` for a full list of available commands.
-
-### Configuration variables
-lolcommits has some options for additional lulz.  You can enable via
-environment variables.
-
- * Set webcam device on mac - set `LOLCOMMITS_DEVICE` environment variable.
- * Set delay persistently (for slow to warmup webcams) - set
-   `LOLCOMMITS_DELAY` var to time in seconds.
- * Set font file location - set `LOLCOMMITS_FONT` environment variable.
- * Animated gifs - set `LOLCOMMITS_ANIMATE=3` (currently Mac/OSX only and requires `ffmpeg`).
- * Fork lolcommits runner - set `LOLCOMMITS_FORK` environment variable
-   (causes capturing command to fork to a new process, speedily returning you to your terminal).
- * Disable the notification at commit time - set `LOLCOMMITS_STEALTH` environment variable.
-
-Read the [available environment variables](https://github.com/mroth/lolcommits/wiki/Available-Environment-Variables) for more information.
+Ok, if you insist... Since you know about `--enable`, common sense suggests there is also a repository specific `--disable`, hopefully you can guess what that does. Other handy common commands include `--last`, which will open for display your most recent lolcommit image, or `--browse`, which pops open the directory containing all the lolcommit images for your current repository. You can always do `--help` for a full list of available commands.
+
+**NOTE**: Any extra arguments you pass with the --enable command are auto-appended to the git-commit capture command.  For example;
+
+    lolcommits --enable --delay=5 --animate=4 --fork
+
+Will configure capturing of an animated gif (4 secs) after a 5 sec delay in a forked process. See the section below for more capture configuration variables.
+
+### Capture configuration variables
+lolcommits has some capture options for additional lulz. You can enable these via environment variables like so;
+
+* `LOLCOMMITS_DEVICE` set a webcam device - **mac and linux only**
+* `LOLCOMMITS_ANIMATE` (in seconds) set time for capturing an animated gif - **mac only & requires ffmpeg**
+* `LOLCOMMITS_DELAY` (in seconds) set delay persistently (for slow webcams to warmup)
+* `LOLCOMMITS_FONT` set font file location for lolcommit text
+* `LOLCOMMITS_FORK` fork lolcommit runner (capture command forks to a new process, speedily returning you to your terminal)
+* `LOLCOMMITS_STEALTH` disable notification messages at commit time
+
+Or they can be set via the following arguments in the capture command (located in your repository's `.git/hooks/post-commit` file).
+
+* `--device=DEVICE` or `-d DEVICE`
+* `--animate=SECONDS` or `-a SECONDS`
+* `--delay=SECONDS` or `-w SECONDS`
+* `--font=FONT_PATH` or `-f FONT_PATH`
+* `--fork`
+* `--stealth`
+
+Read how to [configure commit capturing](https://github.com/mroth/lolcommits/wiki/Configure-Commit-Capturing) for more details.
 
 ### Animated Gif Capturing
 Animated gifs (Mac/OSX only) can take a while to generate (depending on the number of seconds you capture and the capabilities of your machine). `ffmpeg` is required and can be installed with brew like so;

data/bin/lolcommits

@@ -62,6 +62,35 @@ def die_if_not_git_repo!
   end
 end
 
+def good_shebang?
+  File.read(HOOK_PATH).lines.first =~ /^\#\!\/bin\/.*sh/
+end
+
+def lolcommits_hook?
+  File.exists?(HOOK_PATH) &&
+    File.read(HOOK_PATH).to_s =~ /lolcommits.*\(begin\)(.*\n)*.*lolcommits.*\(end\)/
+end
+
+def 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
+
 #
 # NO ARGUMENTS SPECIFIED, HELP THE USER OUT
 #
@@ -89,34 +118,58 @@ def do_enable
     Dir.mkdir(HOOK_DIR)
   end
 
-  if File.exists? HOOK_PATH
-    fatal "A post-commit hook already exists for this project."
-    #TODO: disambiguate between OUR post-commit hook and something else
-    exit 1
+  # clear away any existing lolcommits hook
+  if hook_exists = File.exists?(HOOK_PATH)
+    remove_existing_hook
+
+    # 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_exists ? 'a' : 'w') do |f|
+    f.write(hook_script(!hook_exists))
   end
 
-  ruby_path   = Lolcommits::Configuration.command_which('ruby')
-  hook_export = "export PATH=\"#{ruby_path}:$PATH\"\n" if ruby_path
-  doc = "#!/bin/sh\n#{hook_export}lolcommits --capture\n"
-  File.open(HOOK_PATH, 'w') {|f| f.write(doc) }
   FileUtils.chmod 0755, HOOK_PATH
-  info "installed lolcommmit hook as:"
+
+  info "installed lolcommmit 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
 
+def 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
+
 #
 # IF --DISABLE, DO DISABLE
 #
 def do_disable
-  if File.exists? HOOK_PATH
-    #TODO: check if hook file has been modified before removing
-    FileUtils.rm HOOK_PATH
-    info "removed #{HOOK_PATH}"
+  if lolcommits_hook?
+    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 "lolcommits is not enabled for this directory, so there is nothing to uninstall."
+    info "no post commit hook found (at #{HOOK_PATH}), so there is nothing to uninstall"
   end
 end
 
@@ -387,7 +440,7 @@ if not (Choice.choices[:enable] || Choice.choices[:disable])
   elsif Choice.choices[:configure]
     do_configure()
   elsif Choice.choices[:show_config]
-    puts configuration.user_configuration.to_yaml
+    puts configuration
   elsif Choice.choices[:plugins]
     configuration.puts_plugins()
   elsif Choice.choices[:last]

data/features/lolcommits.feature

@@ -21,16 +21,50 @@ Feature: Basic UI functionality
     Given a git repository named "loltest" with no "post-commit" hook
     When I cd to "loltest"
     And I successfully run `lolcommits --enable`
-    Then the output should contain "installed lolcommmit hook as:"
+    Then the output should contain "installed lolcommmit hook to:"
       And the output should contain "(to remove later, you can use: lolcommits --disable)"
       And a file named ".git/hooks/post-commit" should exist
+      And the file ".git/hooks/post-commit" should contain "lolcommits --capture"
+      And the exit status should be 0
+
+  Scenario: Enable in a git repository that already has a post-commit hook
+    Given a git repository named "loltest" with a "post-commit" hook
+      And the "loltest" repository "post-commit" hook has content "#!/bin/sh\n\n/my/own/script"
+    When I cd to "loltest"
+    And I successfully run `lolcommits --enable`
+    Then the output should contain "installed lolcommmit hook to:"
+      And the output should contain "(to remove later, you can use: lolcommits --disable)"
+      And a file named ".git/hooks/post-commit" should exist
+      And the file ".git/hooks/post-commit" should contain "#!/bin/sh"
+      And the file ".git/hooks/post-commit" should contain "/my/own/script"
+      And the file ".git/hooks/post-commit" should contain "lolcommits --capture"
+      And the exit status should be 0
+
+  Scenario: Enable in a git repository that already has post-commit hook with a bad shebang
+    Given a git repository named "loltest" with a "post-commit" hook
+      And the "loltest" repository "post-commit" hook has content "#!/bin/ruby"
+    When I cd to "loltest"
+    And I run `lolcommits --enable`
+    Then the output should contain "doesn't start with with a good shebang"
+      And the file ".git/hooks/post-commit" should not contain "lolcommits --capture"
+      And the exit status should be 1
+
+  Scenario: Enable in a git repository passing capture arguments
+    Given a git repository named "loltest" with no "post-commit" hook
+    When I cd to "loltest"
+    And I successfully run `lolcommits --enable -w 5 --fork`
+    Then the output should contain "installed lolcommmit hook to:"
+      And the output should contain "(to remove later, you can use: lolcommits --disable)"
+      And a file named ".git/hooks/post-commit" should exist
+      And the file ".git/hooks/post-commit" should contain "lolcommits --capture -w 5 --fork"
       And the exit status should be 0
 
   Scenario: Disable in a enabled git repository
     Given I am in a git repository named "lolenabled" with lolcommits enabled
     When I successfully run `lolcommits --disable`
-    Then the output should contain "removed"
-      And a file named ".git/hooks/post-commit" should not exist
+    Then the output should contain "uninstalled"
+      And a file named ".git/hooks/post-commit" should exist
+      And the file ".git/hooks/post-commit" should not contain "lolcommits --capture"
       And the exit status should be 0
 
   Scenario: Trying to enable while not in a git repo fails
@@ -100,7 +134,7 @@ Feature: Basic UI functionality
     Then the output should contain a list of plugins
     And the output should contain "Name of plugin to configure:"
     Then the output should contain "enabled:"
-    Then the output should contain "Successfully Configured"
+    Then the output should contain "Successfully configured plugin: loltext"
     And a file named "../.lolcommits/config-test/config.yml" should exist
     When I successfully run `lolcommits --show-config`
     Then the output should contain "loltext:"
@@ -112,7 +146,7 @@ Feature: Basic UI functionality
     And I run `lolcommits --config` and wait for output
     When I enter "loltext" for "Name of plugin to configure"
     And I enter "true" for "enabled"
-    Then I should be presented "Successfully Configured"
+    Then I should be presented "Successfully configured plugin: loltext"
     And a file named "../.lolcommits/config-test/config.yml" should exist
     When I successfully run `lolcommits --show-config`
     Then the output should contain "loltext:"
@@ -124,7 +158,7 @@ Feature: Basic UI functionality
     And I run `lolcommits --config --test` and wait for output
     And I enter "loltext" for "Name of plugin to configure"
     And I enter "true" for "enabled"
-    Then I should be presented "Successfully Configured"
+    Then I should be presented "Successfully configured plugin: loltext"
     And a file named "../.lolcommits/test/config.yml" should exist
     When I successfully run `lolcommits --test --show-config`
     Then the output should contain "loltext:"

data/features/plugins.feature

@@ -9,7 +9,7 @@ Feature: Plugins Work
     And I enter "b2a70ac0b64e012fa61522000a8c42dc" for "api_key"
     And I enter "b2a720b0b64e012fa61522000a8c42dc" for "api_secret"
     And I enter "c4aed530b64e012fa61522000a8c42dc" for "repo_id"
-    Then I should be presented "Successfully Configured"
+    Then I should be presented "Successfully configured plugin: dot_com"
     When I do a git commit
     Then the output should contain "*** Preserving this moment in history."
     And there should be exactly 1 jpg in "../.lolcommits/dot_com"
@@ -19,7 +19,7 @@ Feature: Plugins Work
     And I run `lolcommits --config` and wait for output
     And I enter "loltext" for "Plugin Name"
     And I enter "false" for "enabled"
-    Then I should be presented "Successfully Configured"
+    Then I should be presented "Successfully configured plugin: loltext"
     When I do a git commit
     Then the output should contain "*** Preserving this moment in history."
     And there should be exactly 1 jpg in "../.lolcommits/loltext"
@@ -30,8 +30,8 @@ Feature: Plugins Work
     And I enter "lolsrv" for "Plugin Name"
     And I enter "true" for "enabled"
     And I enter "http://localhost" for "server"
-    Then I should be presented "Successfully Configured"
+    Then I should be presented "Successfully configured plugin: lolsrv"
     When I do a git commit
     Then the output should contain "*** Preserving this moment in history."
     And there should be exactly 1 jpg in "../.lolcommits/lolsrv"
-    
+

data/features/step_definitions/lolcommits_steps.rb

@@ -27,6 +27,12 @@ Given /^the git repository named "(.*?)" has a "(.*?)" hook$/ do |repo_name, hoo
   touch(hook_file) if not File.exists? hook_file
 end
 
+Given /^the "(.*?)" repository "(.*?)" hook has content "(.*?)"$/ do |repo_name, hook_name, hook_content|
+  step %{the git repository named "#{repo_name}" has a "#{hook_name}" hook}
+  hook_file = File.join current_dir, repo_name, ".git", "hooks", hook_name
+  File.open(hook_file, 'w') { |f| f.write(hook_content) }
+end
+
 Given /^a git repository named "(.*?)" with (a|no) "(.*?)" hook$/ do |repo_name, yesno_modifier, hook_name|
   step %{a git repository named "#{repo_name}"}
   step %{the git repository named "#{repo_name}" has #{yesno_modifier} "#{hook_name}" hook}

data/lib/lolcommits/configuration.rb

@@ -28,15 +28,15 @@ module Lolcommits
       end
     end
 
-    def user_configuration
-      if File.exists?(user_configuration_file)
-        YAML.load(File.open(user_configuration_file))
+    def read_configuration
+      if File.exists?(configuration_file)
+        YAML.load(File.open(configuration_file))
       else
         nil
       end
     end
 
-    def user_configuration_file
+    def configuration_file
       "#{self.loldir}/config.yml"
     end
 
@@ -95,50 +95,56 @@ module Lolcommits
     end
 
     def puts_plugins
-      names = Lolcommits::PLUGINS.collect {|p| p.new(nil).name }
-      puts "Available plugins: #{names.join(', ')}"
+      puts "Available plugins: #{Lolcommits::PLUGINS.map(&:name).join(', ')}"
     end
 
-    def do_configure!(plugin, forced_options=nil)
-      if plugin.nil? || plugin.strip == ''
-        puts_plugins
-        print "Name of plugin to configure: "
-        plugin = STDIN.gets.strip
-      end
+    def ask_for_plugin_name
+      puts_plugins
+      print "Name of plugin to configure: "
+      STDIN.gets.strip
+    end
 
-      plugins = Lolcommits::PLUGINS.inject(Hash.new) do |acc, val|
-        p = val.new(nil)
-        acc.merge(p.name => p)
+    def find_plugin(plugin_name)
+      Lolcommits::PLUGINS.each do |plugin|
+        if plugin.name == plugin_name
+          return plugin.new(nil)
+        end
       end
 
-      plugin_object = plugins[plugin]
+      puts "Unable to find plugin: '#{plugin_name}'"
+      puts_plugins
+    end
 
-      if plugin_object.nil?
-        puts "Unable to find plugin: #{plugin}"
-        return
+    def do_configure!(plugin_name)
+      if plugin_name.to_s.strip.empty?
+        plugin_name = ask_for_plugin_name
       end
 
-      if forced_options.nil?
-        options = plugin_object.options.inject(Hash.new) do |acc, option|
-          print "#{option}: "
-          val = STDIN.gets.strip
-          val = true  if val == 'true'
-          val = false if val == 'false'
-
-          acc.merge(option => val)
+      if plugin = find_plugin(plugin_name)
+        config = self.read_configuration || Hash.new
+        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
-      else
-        options = forced_options
       end
+    end
 
-      config = self.user_configuration || Hash.new
-      config[plugin] = options
-      File.open(self.user_configuration_file, 'w') do |f|
-        f.write(config.to_yaml)
+    def save(config)
+      config_file_contents = config.to_yaml
+      File.open(self.configuration_file, 'w') do |f|
+        f.write(config_file_contents)
       end
+    end
 
-      puts "#{config.to_yaml}\n"
-      puts "Successfully Configured"
+    def to_s
+      read_configuration.to_yaml.to_s
     end
 
     def self.is_mac?