lolcommits 0.13.1 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3eb952160c813f290a4ca2520f22424fdc6b9994
-  data.tar.gz: a06c38ab8276d5534f8977f9c654b901e27bcc55
+SHA256:
+  metadata.gz: 4225dde2c474dff419dbeb58619e1d9358af4862997e51726e6a9c0f0841bfc8
+  data.tar.gz: 9d09ffafba3cf5d9c50004c7106f272cbc54816c9b9e46be37bc94b548da20da
 SHA512:
-  metadata.gz: 7be7a56b902295d3cc0a91529820c8fabeb61df08cecc82ca1ea07e3b4ac5937260d14dc99b7152add0b7e25aaa55782ed0ccb730f0caeef5bc841c3a6338649
-  data.tar.gz: b2d241f9df3c63c13035725659b2946645c5e2b2beb06da46e26118d335a8c8133fd33787a22131ed2db19e974adad2738f510be512a364c7ba10fe80e6fc299
+  metadata.gz: f0c21b9d900549127a694a640d088e4a7c6c24bd84b1a791481b13234cd54efc5f96f45fcde31a3360b95573f2c654866e2dc071f1005c107283e1b8069d30a3
+  data.tar.gz: c4fb82801d5ed3b145fd55b007f065a7b4d8d53ff5c231aa4b45dbe3d7b7c18a03e4775357bbcd4a27f3d2ee76e5fd3753a5e4260d88b5b675f9e668a75436c3

data/.rubocop.yml

@@ -3,6 +3,7 @@ AllCops:
     - 'vendor/bundle/**/*'
     - 'vendor/bundle/**/.*'
     - '.bundle/**/*'
+    - 'bin/lolcommits'
 
 Metrics/BlockLength:
   Exclude:

data/.rubocop_todo.yml

@@ -39,11 +39,11 @@ Metrics/BlockLength:
 # Offense count: 2
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 140
+  Max: 150
 
 # Offense count: 5
 Metrics/CyclomaticComplexity:
-  Max: 9
+  Max: 10
 
 # Offense count: 23
 # Configuration parameters: CountComments.
@@ -94,4 +94,4 @@ Style/SymbolArray:
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Metrics/LineLength:
-  Max: 161
+  Max: 168

data/CHANGELOG.md

@@ -1,17 +1,25 @@
-### Lolcommits Change Log
+### ChangeLog
 
-All notable changes to this project will be documented in this file. This
-project adheres to [Semantic Versioning][Semver].
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning][Semver].
 
 ## [Unreleased]
 
   * Your contribution here!
 
+## [0.14.0][] (14 May 2019)
+  * `main_image` now deprecated, use `lolcommit_path` instead (@matthutchinson)
+  * make actual videos to make gifs from (@ruxton [#386][])
+  * improved tabs/spacing on git commit hook text (@matthutchinson)
+  * add video captures `-v {seconds}` and runner overlays (@matthutchinson [#392][])
+  * `Capturer` classes refactored and renamed (@matthutchinson)
+  * `AnimatedGif` class takes care of gif generating (@matthutchinson)
+
 ## [0.13.1][] (29 April 2019)
   * Update all links and badges (in gemspec, README etc.) to lolcommits
-    organisation
-  * remove gem `post_install` message
-  * use `lolcommits-loltext ~> 0.1.0'
+    organisation (@matthutchinson)
+  * remove gem `post_install` message (@matthutchinson)
+  * use `lolcommits-loltext ~> 0.1.0' (@matthutchinson)
 
 ## [0.13.0][] (23 April 2019)
   * Require at least Ruby 2.3
@@ -342,7 +350,8 @@ project adheres to [Semantic Versioning][Semver].
   reliable to not glitch.)
 
 [Semver]: http://semver.org
-[Unreleased]: https://github.com/lolcommits/lolcommits/compare/v0.13.1...HEAD
+[Unreleased]: https://github.com/lolcommits/lolcommits/compare/v0.14.0...HEAD
+[0.14.0]: https://github.com/lolcommits/lolcommits/compare/v0.13.1...v0.14.0
 [0.13.1]: https://github.com/lolcommits/lolcommits/compare/v0.13.0...v0.13.1
 [0.13.0]: https://github.com/lolcommits/lolcommits/compare/v0.12.1...v0.13.0
 [0.12.1]: https://github.com/lolcommits/lolcommits/compare/v0.12.0...v0.12.1
@@ -537,3 +546,5 @@ project adheres to [Semantic Versioning][Semver].
 [#377]: https://github.com/lolcommits/lolcommits/pull/377
 [#384]: https://github.com/lolcommits/lolcommits/pull/384
 [#385]: https://github.com/lolcommits/lolcommits/pull/385
+[#386]: https://github.com/lolcommits/lolcommits/pull/386
+[#392]: https://github.com/lolcommits/lolcommits/pull/392

data/Gemfile

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 gemspec

data/README.md

@@ -8,15 +8,17 @@
 
 > git-based selfies for software developers
 
-lolcommits takes a snapshot with your webcam every time you git commit code, and
-archives a lolcat style image with it. Git blame has never been so much fun.
+lolcommits takes a snapshot with your webcam every time you git commit
+code, and archives a lolcat style image with it. Git blame has never
+been so much fun.
 
 By default, the lol images are stored by a Github style short SHA in a
 `~/.lolcommits` directory created for you.
 
 ## History
 
-Originally created by [@mroth] in 2011 as a joke project for [Hack && Tell], lolcommits has grown considerably since then, and is now
+Originally created by [@mroth] in 2011 as a joke project for [Hack &&
+Tell], lolcommits has grown considerably since then, and is now
 primarily maintained by [@matthutchinson].
 
 Thank you to all of the [contributors] throughout the years!
@@ -48,8 +50,8 @@ page on our wiki!
 
 ### macOS
 
-You'll need ImageMagick installed. [Homebrew](http://mxcl.github.com/homebrew/)
-makes this easy.
+You'll need ImageMagick installed.
+[Homebrew](http://mxcl.github.com/homebrew/) makes this easy.
 
 	brew install imagemagick
 
@@ -57,11 +59,11 @@ Then install with:
 
 	[sudo] gem install lolcommits
 
-If you're using RVM (or rbenv), you can/should probably omit the sudo, but the
-default macOS Ruby install usually requires it.
+If you're using RVM (or rbenv), you can/should probably omit the sudo,
+but the default macOS Ruby install usually requires it.
 
-Lolcommits v0.8.1 was the last release to support Ruby < 2.0. If you'd like to
-use older Rubies try:
+Lolcommits v0.8.1 was the last release to support Ruby < 2.0. If you'd
+like to use older Rubies try:
 
     [sudo] gem install lolcommits --version 0.8.1   # for Ruby 1.9
     [sudo] gem install lolcommits --version 0.7.0   # for Ruby 1.8
@@ -69,13 +71,13 @@ use older Rubies try:
 
 ### Linux
 
-Install these dependencies using your package manager of choice, for example in
-Ubuntu:
+Install these dependencies using your package manager of choice, for
+example in Ubuntu:
 
     sudo apt-get install mplayer imagemagick libmagickwand-dev
 
-For Ubuntu 14.04 or newer, you need to manually install ffmpeg since it no
-longer ships with the default Ubuntu sources ([downloads
+For Ubuntu 14.04 or newer, you need to manually install ffmpeg since it
+no longer ships with the default Ubuntu sources ([downloads
 here](http://ffmpeg.org/download.html)).
 
 Then install with:
@@ -98,108 +100,131 @@ Windows](https://github.com/lolcommits/lolcommits/wiki/Installing-on-Windows).
 
 ### Enabling and basic usage
 
-Within any git repository, simply run `lolcommits --enable`. From that point on,
-any git commit will automatically trigger a lolcommit capture! By default, all
-lolcommits are stored in `~/.lolcommits` and placed in a subdirectory by project
-name, with a filename matching the commit hash.
+Within any git repository, simply run `lolcommits --enable`. From that
+point on, any git commit will automatically trigger a lolcommit capture!
+By default, all lolcommits are stored in `~/.lolcommits` and placed in a
+subdirectory by project name, with a filename matching the commit hash.
 
 Follow [these
 steps](https://github.com/lolcommits/lolcommits/wiki/Enabling-Lolcommits-for-all-your-Git-Repositories)
 to enable lolcommits across all your repos; using `git init` and the
 `init.templatedir` setting.
 
-Don't worry about it too much, half the fun of lolcommits is forgetting it's
-installed!
+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 suggests
-there is also a repository specific `--disable`, hopefully you can guess what
-that does.
+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, 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.
+Other handy common commands include `--last`, which will open for
+display your most recent lolcommit, 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 `--enable` are appended to the
-git post-hook capture command. For example;
+**NOTE**: Any extra arguments you pass with `--enable` are appended to
+the git post-hook 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 options.
+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 options.
 
 
 ### Capture configuration options
 
-lolcommits has some capture options for additional lulz. You can enable these
-via environment variables like so;
+lolcommits has some capture options for additional lulz. You can enable
+these via environment variables like so;
 
-* `LOLCOMMITS_DEVICE` set a webcam device - **except windows (non-animated) captures**
-* `LOLCOMMITS_ANIMATE` (in seconds) set time for capturing an animated gif -
+* `LOLCOMMITS_DEVICE` set a webcam device - **except windows
+  (non-animated) captures**
+* `LOLCOMMITS_VIDEO` (in seconds) set time for capturing a video -
   **requires ffmpeg**
-* `LOLCOMMITS_DELAY` (in seconds) set delay time before capturing (for slow
-  webcams to warmup)
-* `LOLCOMMITS_FORK` fork lolcommit runner (capture command forks to a new
-  process, speedily returning you to your terminal)
+* `LOLCOMMITS_ANIMATE` (in seconds) set time for capturing an animated
+  gif - **requires ffmpeg**
+* `LOLCOMMITS_DELAY` (in seconds) set delay time before capturing (for
+  slow webcams to warmup)
+* `LOLCOMMITS_FORK` fork lolcommit runner (capture command forks to a
+  new process, speedily returning you to your terminal)
 * `LOLCOMMITS_STEALTH` disable all notification messages when capturing
-* `LOLCOMMITS_DIR` set the output directory used for all repositories (defaults
-  to ~/.lolcommits)
-* `LOLCOMMITS_CAPTURE_DISABLED` disables lolcommit capturing in the commit hook
-  (when set as 'true')
+* `LOLCOMMITS_DIR` set the output directory used for all repositories
+  (defaults to ~/.lolcommits)
+* `LOLCOMMITS_CAPTURE_DISABLED` disables lolcommit capturing in the
+  commit hook (when set as 'true')
 
-
-Or they can be set with arguments to the capture command (located in your
-repository's `.git/hooks/post-commit` file).
+Or they can be set with arguments to the capture command (located in
+your repository's `.git/hooks/post-commit` file).
 
 * `--device {name}` or `-d {name}`
+* `--video {seconds}` or `-v {seconds}`
 * `--animate {seconds}` or `-a {seconds}`
 * `--delay {seconds}` or `-w {seconds}`
 * `--fork`
 * `--stealth`
 
-Use `lolcommits --devices` to list all attached video devices available for
-capturing.
-
-You can configure lolcommit text positions, font styles (type, size, color etc.)
-or add a transparent overlay to your images. Simply configure the default
-loltext plugin with this command:
+You can configure lolcommit text positions, font styles (type, size,
+color etc.) or add a transparent overlay to your images. Simply
+configure the default loltext plugin with this command:
 
     lolcommits --config -p loltext
 
 To find out more about styling, read about the [loltext
 options](https://github.com/lolcommits/lolcommits/wiki/Configure-Commit-Capturing#loltext-options).
 
+Use `lolcommits --devices` to list all attached video devices available
+for capturing.
+
+Finally, run `lolcommits --help` for details on all the available
+arguments.
 
-### Animated Gif Capturing
 
-Animated gifs can take a while to generate (depending on the number of seconds
-you capture and the capabilities of your machine).
-[ffmpeg](https://www.ffmpeg.org) is required and can be installed like so;
+### Videos
 
-* Linux - [follow this guide](https://www.ffmpeg.org/download.html#build-linux)
+You can tell lolcommits to capture an mp4 video (instead of an image).
+[ffmpeg](https://www.ffmpeg.org) is required and can be installed like
+so;
+
+* Linux - [follow this
+  guide](https://www.ffmpeg.org/download.html#build-linux)
 * macOS - `brew install ffmpeg`
-* Windows - [follow this guide](https://ffmpeg.org/download.html#build-windows)
+* Windows - [follow this
+  guide](https://ffmpeg.org/download.html#build-windows)
+
+To enable, use the `-v {seconds}` option or set the `LOLCOMMITS_VIDEO`
+environment variable with the number of seconds to capture.
 
-To enable, just set the `LOLCOMMITS_ANIMATE` environment variable with the
-number of seconds to capture. If you find animated capturing takes too long, try
-setting `LOLCOMMITS_FORK=true`.
+
+### Animated Gifs
+
+Animated gifs can take a while to generate (depending on the number of
+seconds you capture and the capabilities of your machine).
+
+To enable, use the `-a {seconds}` option or set the `LOLCOMMITS_ANIMATE`
+environment variable with the number of seconds to capture. If you find
+animated capturing takes too long, try setting `LOLCOMMITS_FORK=true`.
 
 ![Example animated lolcommit
-gif](http://cdn2.usa.bugleblogs.com/blogs/000/000/003/de0eb9aa695.gif "Example
-animated lolcommit gif")
+gif](http://cdn2.usa.bugleblogs.com/blogs/000/000/003/de0eb9aa695.gif
+"Example animated lolcommit gif")
+
+**NOTE**: If both `LOLCOMMITS_ANIMATE` and `LOLCOMMITS_VIDEO` options are set, the
+video duration takes precedence and is applied to both captures.
 
 
 ### Plugins
 
-A growing number of plugins are available, allowing you to transform or share
-your lolcommits with others. The default plugin simply appends your commit
-message and sha to the captured image. Others can post to Twitter, Tumblr (and
-other services), or even translate your commit messages to
-[lolspeak](http://www.urbandictionary.com/define.php?term=lolspeak). Check them
-out on our [plugins
+A growing number of plugins are available, allowing you to transform or
+share your lolcommits with others. The default plugin simply appends
+your commit message and sha to the captured image. Others can post to
+Twitter, Tumblr (and other services), or even translate your commit
+messages to
+[lolspeak](http://www.urbandictionary.com/define.php?term=lolspeak).
+Check them out on our [plugins
 page](https://github.com/lolcommits/lolcommits/wiki/Configuring-Plugins).
 
 To list all installed plugins use:
@@ -214,8 +239,8 @@ Installed plugins can be easily enabled, configured or disabled with the
     lolcommits --config -p loltext
 
 Interested in developing your own plugin? Follow [this simple
-guide](https://github.com/lolcommits/lolcommits-sample_plugin#developing-your-own-plugin) at the
-Lolcommits Sample Plugin README.
+guide](https://github.com/lolcommits/lolcommits-sample_plugin#developing-your-own-plugin)
+at the Lolcommits Sample Plugin README.
 
 
 ## Timelapse
@@ -228,11 +253,12 @@ Watch your face decay while you program, with an animated timelapse gif!
 
 ## Troubles?
 
-Try our trouble-shooting [FAQ](https://github.com/lolcommits/lolcommits/wiki/FAQ), or
-take a read through our [wiki](https://github.com/lolcommits/lolcommits/wiki). If you
-think something is broken or missing, please raise a [Github
-issue](https://github.com/lolcommits/lolcommits/issues) (and please check if we
-haven't [already
+Try our trouble-shooting
+[FAQ](https://github.com/lolcommits/lolcommits/wiki/FAQ), or take a read
+through our [wiki](https://github.com/lolcommits/lolcommits/wiki). If
+you think something is broken or missing, please raise a [Github
+issue](https://github.com/lolcommits/lolcommits/issues) (and please
+check if we haven't [already
 addressed](https://github.com/lolcommits/lolcommits/issues?q=is%3Aissue+is%3Aclosed)
 it).
 
@@ -241,4 +267,3 @@ it).
 
 The program is available as open source under the terms of
 [LGPL-3](https://opensource.org/licenses/LGPL-3.0).
-

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler'
 require 'rake/clean'
 
@@ -32,7 +34,7 @@ Rake::TestTask.new do |t|
 end
 
 Rake::FileUtilsExt.verbose(false)
-CUKE_RESULTS = 'results.html'.freeze
+CUKE_RESULTS = 'results.html'
 CLEAN << CUKE_RESULTS
 Cucumber::Rake::Task.new(:features) do |t|
   optstr = "features --format html -o #{CUKE_RESULTS} --format progress -x"

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'lolcommits'

data/bin/lolcommits

@@ -21,11 +21,11 @@ class App
   include Lolcommits::CLI
 
   description 'git-based selfies for software developers (https://lolcommits.github.io)'
-  version     Lolcommits::VERSION
+  version Lolcommits::VERSION
 
   main do
     # check for fatal conditions before execution
-    Fatals.die_if_no_valid_ffmpeg_installed! if capture_animated?
+    Fatals.die_if_no_valid_ffmpeg_installed! if capture_duration.positive?
     Fatals.die_on_fatal_platform_conditions!
 
     if options.empty?
@@ -39,7 +39,9 @@ class App
       plugin_manager = PluginManager.init
       config         = Configuration.new(plugin_manager, test_mode: options[:test])
 
-      if options[:'show-config']
+      if options[:version]
+        puts Lolcommits::VERSION
+      elsif options[:'show-config']
         puts config
       elsif options[:plugins]
         config.list_plugins
@@ -59,14 +61,14 @@ class App
         end
 
         if options[:last]
-          show_last_lolimage(config.loldir)
+          show_last_lolcommit(config.loldir)
         elsif options[:browse]
           Launcher.open_folder(config.loldir)
         elsif options[:timelapse]
-          TimelapseGif.new(config).run(options[:period])
+          TimelapseGif.new(config.loldir).run(options[:period])
         elsif options[:config]
           config.do_configure!(options[:plugin])
-        elsif options[:capture]
+        elsif options[:capture] || options[:video] || options[:animate]
           capture_lolcommit(config)
         end
       end
@@ -87,17 +89,19 @@ class App
   on('-l', '--last', 'view the most recent lolcommit')
   on('-b', '--browse', 'browse this repo\'s lolcommits')
 
-  on('--timelapse', 'generate animated timelapse gif from captured images')
+  on('-t', '--timelapse', 'generate animated timelapse gif from captured images')
   on('--period {today}', 'period to use for the timelapse gif (today or all)')
 
   # optional capturing options
   on('--device {name}', 'device name to capture from (mac/linux only)')
-  on('-a', '--animate {seconds}', 'enable animated gif captures with duration')
+  on('-a', '--animate {seconds}', 'animated gif capture with duration')
+  on('-v', '--video {seconds}', 'video capture with duration')
   on('-w', '--delay {seconds}', 'delay before taking a snapshot')
-  on('--stealth', 'capture image in stealth mode (no output)')
-  on('--fork', 'fork capturing process to the background')
   on('-s', '--sha {string}', 'pass commit sha manually (--test mode only)')
   on('-m', '--msg {string}', 'pass commit message manually (--test mode only)')
+  on('--stealth', 'capture image in stealth mode (no output)')
+  on('--fork', 'fork capturing process to the background')
+  on('--version', 'show current version info')
 
   #
   # No options specified, help the user out
@@ -117,37 +121,36 @@ class App
     'Specify a device with --device "{device name}" or set the LOLCOMMITS_DEVICE env variable'
   end
 
-  def self.show_last_lolimage(loldir)
-    lolimage = Dir.glob(File.join(loldir, '*.{jpg,gif}')).max_by { |f| File.mtime(f) }
+  def self.show_last_lolcommit(loldir)
+    lolimage = Dir.glob(File.join(loldir, '*.{jpg,mp4,gif}')).max_by { |f| File.mtime(f) }
 
     if lolimage.nil?
       warn 'No lolcommits have been captured for this repository yet.'
       exit 1
     end
-    Launcher.open_image(lolimage)
-  end
-
-  def self.capture_device
-    result = options[:device] || ENV['LOLCOMMITS_DEVICE'] || nil
-    result ||= Dir.glob('/dev/video*').first if Platform.platform_linux?
-    result
+    Launcher.open_file(lolimage)
   end
 
   def self.capture_lolcommit(config)
-    should_we_fork  = options[:fork] || ENV['LOLCOMMITS_FORK'] || false
+    should_fork     = options[:fork] || ENV['LOLCOMMITS_FORK'] || false
     capture_stealth = options[:stealth] || ENV['LOLCOMMITS_STEALTH'] || false
+    capture_device  = options[:device] || ENV['LOLCOMMITS_DEVICE'] || nil
     capture_delay   = (options[:delay] || ENV['LOLCOMMITS_DELAY']).to_i
+    capture_gif     = !(options[:animate] || ENV['LOLCOMMITS_ANIMATE']).nil?
+    capture_video   = !(options[:video] || ENV['LOLCOMMITS_VIDEO']).nil?
 
     capture_options = {
       capture_delay: capture_delay,
       capture_stealth: capture_stealth,
       capture_device: capture_device,
-      capture_animate: capture_animate,
+      capture_duration: capture_duration,
+      capture_gif: capture_gif,
+      capture_video: capture_video,
       config: config
     }
 
     process_runner = ProcessRunner.new(config)
-    process_runner.fork_me?(should_we_fork) do
+    process_runner.fork_me?(should_fork) do
       if options[:test]
         info '*** Capturing in test mode.'
         capture_options.merge!(test_capture_options)
@@ -157,7 +160,7 @@ class App
       runner.run
 
       # automatically open the image in test mode
-      Launcher.open_image(runner.main_image) if options[:test]
+      Launcher.open_file(runner.lolcommit_path) if options[:test]
     end
   end
 
@@ -170,17 +173,19 @@ class App
 
   # Duration for animated capturing
   #
-  # If animation is enabled, returns an integer > 0 representing seconds.
-  # Seconds will be 0 if no option set, meaning no animated capture will take
-  # place.
+  # If video/animation is enabled, this returns an integer > 0 (seconds)
+  # Seconds will be 0 if no option set, meaning a regular image capture
+  # will take place. Video duration takes precedence if both options are
+  # set.
   #
   # @return [Integer]
-  def self.capture_animate
-    (options[:animate] || ENV['LOLCOMMITS_ANIMATE']).to_i
-  end
-
-  def self.capture_animated?
-    capture_animate > 0
+  def self.capture_duration
+    (
+      options[:video] ||
+      ENV['LOLCOMMITS_VIDEO'] ||
+      options[:animate] ||
+      ENV['LOLCOMMITS_ANIMATE']
+    ).to_i
   end
 
   #