lolcommits-loltext 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7f540cfbbe558c62cbed5ce539fb1db7a8f8d57c
+  data.tar.gz: 5fff1e22ed73177e85a40bcd88e9485c1552cd5b
+SHA512:
+  metadata.gz: ce01cb3c5333f4113950f250c6d3c78026e14632b504c1b2967e17119a426a81bdee5d67fd4c158496fec19b453b9e05285739b741468bc59f7da8935f6e8dd3
+  data.tar.gz: 47bf286e11da2c549085e265861d4bf18b2703f88b3e263c71d098eec206c2677c923a637d00fd975fa545c9a9fbec809ba7bd5ad0fddefd4e174a0e4aae5b8c

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.simplecov

@@ -0,0 +1,9 @@
+SimpleCov.start do
+  add_filter '/test/'
+  add_filter '/vendor/'
+end
+
+SimpleCov.at_exit do
+  SimpleCov.result.format!
+  `open ./coverage/index.html` if RUBY_PLATFORM =~ /darwin/
+end

data/.travis.yml

@@ -0,0 +1,24 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+ - 2.0.0
+ - 2.1.7
+ - 2.2.4
+ - 2.3.3
+ - 2.4.1
+ - ruby-head
+
+before_install:
+ - gem install bundler -v 1.13.7
+ - git --version
+ - git config --global user.email "lol@commits.org"
+ - git config --global user.name "Lolcommits"
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+
+branches:
+  except:
+    - gh-pages

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,50 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer via [GitHub][maintainer]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[maintainer]: https://github.com/matthutchinson
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/CONTRIBUTING.md

@@ -0,0 +1,37 @@
+### Contributing
+
+Pull Requests are welcome! To start helping out:
+
+[Fork](https://guides.github.com/activities/forking) then clone the repository:
+
+    git clone git@github.com:your-username/lolcommits-loltext.git
+
+Create your feature branch:
+
+    git checkout -b my-new-feature
+
+When you are happy with your change, run the full test suite:
+
+    bundle exec rake
+
+With a passing test suite, commit your changes, push and submit a new [Pull
+Request](https://github.com/lolcommits/lolcommits-loltext/compare):
+
+    git commit -am 'Added some feature'
+    git push origin my-new-feature
+
+At this point you'll be waiting for one of our maintainers to review it. We will
+try to reply to new Pull Requests within a few days. We might suggest some
+changes, improvements or alternatives. To increase the chance that your pull
+request gets accepted:
+
+* Explain what your are doing (and why) in your Pull Request description.
+* If you are fixing an
+  [issue](https://github.com/lolcommits/lolcommits-loltext/issues), link to
+  it in your description and [mention
+  it](https://help.github.com/articles/closing-issues-via-commit-messages) in
+  the commit message.
+* Write a good [commit
+  message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
+* Write tests.
+

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,168 @@
+# Lolcommits Loltext
+
+[![Gem Version](https://img.shields.io/gem/v/lolcommits-loltext.svg?style=flat)](http://rubygems.org/gems/lolcommits-loltext)
+[![Travis Build Status](https://travis-ci.org/lolcommits/lolcommits-loltext.svg?branch=master)](https://travis-ci.org/lolcommits/lolcommits-loltext)
+[![Coverage Status](https://coveralls.io/repos/github/lolcommits/lolcommits-loltext/badge.svg?branch=master)](https://coveralls.io/github/lolcommits/lolcommits-loltext)
+[![Code Climate](https://codeclimate.com/github/lolcommits/lolcommits-loltext/badges/gpa.svg)](https://codeclimate.com/github/lolcommits/lolcommits-loltext)
+[![Gem Dependency Status](https://gemnasium.com/badges/github.com/lolcommits/lolcommits-loltext.svg)](https://gemnasium.com/github.com/lolcommits/lolcommits-loltext)
+
+[lolcommits](https://lolcommits.github.io/) 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!
+
+This plugin annotates each lolcommit with the commit message and sha text. You
+can style and position these however you like, or add a transparent overlay
+color that covers the entire image.
+
+By default your lolcommit will look something like this (maybe without the
+horse):
+
+![horse
+commit](https://github.com/lolcommits/lolcommits-loltext/raw/master/assets/images/horse.jpg)
+
+You can easily change the plugin options to achieve something like this:
+
+![hipster
+commit](https://github.com/lolcommits/lolcommits-loltext/raw/master/assets/images/hipster.jpg)
+
+See [below](https://github.com/lolcommits/lolcommits-loltext#configuration) for
+more information on the options available.
+
+## Requirements
+
+* Ruby >= 2.0.0
+* A webcam
+* [ImageMagick](http://www.imagemagick.org)
+* [ffmpeg](https://www.ffmpeg.org) (optional) for animated gif capturing
+
+## Installation
+
+By default, this plugin is automatically included with the main lolcommits gem.
+If you have uninstalled this gem, install it again with:
+
+    $ gem install lolcommits-loltext
+
+That's it! Every lolcommit will now be stamped with your commit message and sha.
+This plugin is enabled by default (if no configuration for it exists). To
+disable (so no text or overlay is applied) use:
+
+    $ lolcommits --config -p loltext
+    # and set enabled to `false`
+
+### Configuration
+
+Configure this plugin with:
+
+    $ lolcommits --config -p loltext
+    # set enabled to `true` (then set your own options or choose the defaults)
+
+The following options are available:
+
+* text color
+* text font
+* text position
+* uppercase text?
+* size (point size for the font)
+* stroke color (font outline color, or none)
+* transparent overlay (cover the image with a random background color)
+* transparent overlay % (sets the fill colorize strength)
+
+Please note that:
+
+* The message and sha text can have different text options
+* Any blank options will use the default (indicated when prompted for an option)
+* Always use the full absolute path to font files
+* Valid text positions are NE, NW, SE, SW, S, C (centered)
+* Colors can be hex values (#FC0) or strings (white, red etc.)
+* You can set one or more `overlay_colors` to pick from, separated with commas
+
+With these options it is possible to create your own unique lolcommit format.
+To achieve these '[hipster
+styled](https://twitter.com/matthutchin/status/738411190343368704)' 🕶 commits,
+try the following:
+
+```
+loltext:
+  enabled: true
+  :message:
+    :color: white
+    :font: "/Users/matt/Library/Fonts/Raleway-Light.ttf"
+    :position: C
+    :size: 30
+    :stroke_color: none
+    :uppercase: true
+  :sha:
+    :color: white
+    :font: "/Users/matt/Library/Fonts/Raleway-Light.ttf"
+    :position: S
+    :size: 20
+    :stroke_color: none
+    :uppercase: false
+  :overlay:
+    :enabled: true
+```
+
+**NOTE**: you can grab the '_Raleway-Light_' font for free from
+[fontsquirrel](https://www.fontsquirrel.com/fonts/Raleway).
+
+## Development
+
+Check out this repo and run `bin/setup`, to install all dependencies and
+generate docs. Run `bundle exec rake` to run all tests and generate a coverage
+report.
+
+You can also run `bin/console` for an interactive prompt that will allow you to
+experiment with the gem code.
+
+## Tests
+
+MiniTest is used for testing. Run the test suite with:
+
+    $ rake test
+
+## Docs
+
+Generate docs for this gem with:
+
+    $ rake rdoc
+
+## Troubles?
+
+If you think something is broken or missing, please raise a new
+[issue](https://github.com/lolcommits/lolcommits-loltext/issues). Take
+a moment to check it hasn't been raised in the past (and possibly closed).
+
+## Contributing
+
+Bug [reports](https://github.com/lolcommits/lolcommits-loltext/issues) and [pull
+requests](https://github.com/lolcommits/lolcommits-loltext/pulls) are welcome on
+GitHub.
+
+When submitting pull requests, remember to add tests covering any new behaviour,
+and ensure all tests are passing on [Travis
+CI](https://travis-ci.org/lolcommits/lolcommits-loltext). Read the
+[contributing
+guidelines](https://github.com/lolcommits/lolcommits-loltext/blob/master/CONTRIBUTING.md)
+for more details.
+
+This project is intended to be a safe, welcoming space for collaboration, and
+contributors are expected to adhere to the [Contributor
+Covenant](http://contributor-covenant.org) code of conduct. See
+[here](https://github.com/lolcommits/lolcommits-loltext/blob/master/CODE_OF_CONDUCT.md)
+for more details.
+
+## License
+
+The gem is available as open source under the terms of
+[LGPL-3](https://opensource.org/licenses/LGPL-3.0).
+
+## Links
+
+* [Travis CI](https://travis-ci.org/lolcommits/lolcommits-loltext)
+* [Test Coverage](https://coveralls.io/github/lolcommits/lolcommits-loltext)
+* [Code Climate](https://codeclimate.com/github/lolcommits/lolcommits-loltext)
+* [RDoc](http://rdoc.info/projects/lolcommits/lolcommits-loltext)
+* [Issues](http://github.com/lolcommits/lolcommits-loltext/issues)
+* [Report a bug](http://github.com/lolcommits/lolcommits-loltext/issues/new)
+* [Gem](http://rubygems.org/gems/lolcommits-loltext)
+* [GitHub](https://github.com/lolcommits/lolcommits-loltext)

data/Rakefile

@@ -0,0 +1,31 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "rdoc/task"
+
+# generate docs
+RDoc::Task.new do |rd|
+  rd.main     = "README.md"
+  rd.title    = "Lolcommits Loltext"
+  rd.rdoc_dir = "doc"
+  rd.options  << "--all"
+  rd.rdoc_files.include("README.md", "LICENSE", "lib/**/*.rb")
+end
+
+# run tests
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+# run tests with code coverage (default)
+namespace :test do
+  desc "Run all tests and features and generate a code coverage report"
+  task :coverage do
+    ENV['COVERAGE'] = 'true'
+    Rake::Task['test'].execute
+  end
+end
+
+
+task :default => ['test:coverage']

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "lolcommits/loltext"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+# install deps
+bundle install
+
+# generate docs
+bundle exec rake rdoc

data/lib/lolcommits/loltext.rb

@@ -0,0 +1,2 @@
+require 'lolcommits/loltext/version'
+require 'lolcommits/plugin/loltext'

data/lib/lolcommits/loltext/version.rb

@@ -0,0 +1,5 @@
+module Lolcommits
+  module Loltext
+    VERSION = "0.0.2".freeze
+  end
+end

data/lib/lolcommits/plugin/loltext.rb

@@ -0,0 +1,236 @@
+require 'lolcommits/plugin/base'
+
+module Lolcommits
+  module Plugin
+    class Loltext < Base
+
+      DEFAULT_FONT_PATH = File.join(
+        File.dirname(__FILE__), "../../../vendor/fonts/Impact.ttf"
+      ).freeze
+
+      ##
+      # Returns the name of the plugin. Identifies the plugin to lolcommits.
+      #
+      # @return [String] the plugin name
+      #
+      def self.name
+        'loltext'
+      end
+
+      # Returns position(s) of when this plugin should run during the capture
+      # process.
+      #
+      # @return [Array] the position(s) (:precapture and/or :postcapture)
+      #
+      def self.runner_order
+        [:postcapture]
+      end
+
+      ##
+      # Returns true/false indicating if the plugin is enabled or not.
+      # Enabled by default (if no configuration exists)
+      #
+      # @return [Boolean] true/false indicating if plugin is enabled
+      #
+      def enabled?
+        !configured? || super
+      end
+
+      ##
+      # Returns true/false indicating if the plugin has been correctly
+      # configured.
+      #
+      # Valid by default (if no configuration exists)
+      #
+      # @return [Boolean] true/false indicating if plugin is correct configured
+      #
+      def valid_configuration?
+        !configured? || super
+      end
+
+      ##
+      # Prompts the user to configure text options.
+      #
+      # @return [Hash] a hash of configured plugin options
+      #
+      def configure_options!
+        options = super
+        if options['enabled']
+          puts '---------------------------------------------------------------'
+          puts '  LolText options '
+          puts ''
+          puts '  * any blank options will use the (default)'
+          puts '  * always use the full absolute path to fonts'
+          puts '  * valid text positions are NE, NW, SE, SW, S, C (centered)'
+          puts '  * colors can be hex #FC0 value or a string \'white\''
+          puts '      - use `none` for no stroke color'
+          puts '  * overlay fills your image with a random color'
+          puts '      - set one or more overlay_colors with a comma seperator'
+          puts '      - overlay_percent (0-100) sets the fill colorize strength'
+          puts '---------------------------------------------------------------'
+
+          options[:message] = configure_sub_options(:message)
+          options[:sha]     = configure_sub_options(:sha)
+          options[:overlay] = configure_sub_options(:overlay)
+        end
+        options
+      end
+
+      ##
+      #
+      # Post-capture hook, runs after lolcommits captures a snapshot.
+      #
+      # Annotates the image with the git commit message and sha text
+      #
+      def run_postcapture
+        debug 'Annotating image via MiniMagick'
+        image = MiniMagick::Image.open(runner.main_image)
+        if config_option(:overlay, :enabled)
+          image.combine_options do |c|
+            c.fill config_option(:overlay, :overlay_colors).sample
+            c.colorize config_option(:overlay, :overlay_percent)
+          end
+        end
+
+        annotate(image, :message, clean_msg(runner.message))
+        annotate(image, :sha, runner.sha)
+        debug "Writing changed file to #{runner.main_image}"
+        image.write runner.main_image
+      end
+
+
+      private
+
+      def annotate(image, type, string)
+        debug("annotating #{type} to image with #{string}")
+
+        transformed_position = position_transform(config_option(type, :position))
+        annotate_location = '0'
+
+        # move South gravity off the edge of the image.
+        if transformed_position == 'South'
+          annotate_location = '+0+20'
+        end
+
+        string.upcase! if config_option(type, :uppercase)
+
+        image.combine_options do |c|
+          c.strokewidth runner.capture_animated? ? '1' : '2'
+          c.interline_spacing(-(config_option(type, :size) / 5))
+          c.stroke config_option(type, :stroke_color)
+          c.fill config_option(type, :color)
+          c.gravity transformed_position
+          c.pointsize runner.capture_animated? ? (config_option(type, :size) / 2) : config_option(type, :size)
+          c.font config_option(type, :font)
+          c.annotate annotate_location, string
+        end
+      end
+
+      # TODO: consider this type of configuration prompting in Plugin::Base
+      # i.e. allow sub option and working with hash of defaults
+      def configure_sub_options(type)
+        print "#{type}:\n"
+        defaults = config_defaults[type]
+
+        # sort option keys since different `Hash#keys` varys across Ruby versions
+        defaults.keys.sort_by(&:to_s).reduce({}) do |acc, opt|
+          # if we have an enabled key set to false, abort asking for any more options
+          if acc.key?(:enabled) && acc[:enabled] != true
+            acc
+          else
+            print "  #{opt.to_s.tr('_', ' ')} (#{defaults[opt]}): "
+            val = parse_user_input(gets.chomp.strip)
+            # handle array options (comma seperated string)
+            if defaults[opt].is_a?(Array) && !val.nil?
+              val = val.split(',').map(&:strip).delete_if(&:empty?)
+            end
+            acc.merge(opt => val)
+          end
+        end
+      end
+
+      # default text styling and positions
+      def config_defaults
+        {
+          message: {
+            color: 'white',
+            font: DEFAULT_FONT_PATH,
+            position: 'SW',
+            size: 48,
+            stroke_color: 'black',
+            uppercase: false
+          },
+          sha: {
+            color: 'white',
+            font: DEFAULT_FONT_PATH,
+            position: 'NE',
+            size: 32,
+            stroke_color: 'black',
+            uppercase: false
+          },
+          overlay: {
+            enabled: false,
+            overlay_colors: [
+              '#2e4970', '#674685', '#ca242f', '#1e7882', '#2884ae', '#4ba000',
+              '#187296', '#7e231f', '#017d9f', '#e52d7b', '#0f5eaa', '#e40087',
+              '#5566ac', '#ed8833', '#f8991c', '#408c93', '#ba9109'
+            ],
+            overlay_percent: 50
+          }
+        }
+      end
+
+      # return the config option, defaults apply if not set
+      def config_option(type, option)
+        default_option = config_defaults[type][option]
+        if configuration[type]
+          configuration[type][option] || default_option
+        else
+          default_option
+        end
+      end
+
+      # explode psuedo-names for text positioning
+      def position_transform(position)
+        case position
+        when 'NE'
+          'NorthEast'
+        when 'NW'
+          'NorthWest'
+        when 'SE'
+          'SouthEast'
+        when 'SW'
+          'SouthWest'
+        when 'C'
+          'Center'
+        when 'S'
+          'South'
+        end
+      end
+
+      # do whatever is required to commit message to get it clean and ready for
+      # imagemagick
+      def clean_msg(text)
+        wrapped_text = word_wrap text
+        escape_quotes wrapped_text
+        escape_ats wrapped_text
+      end
+
+      # conversion for quotation marks to avoid shell interpretation
+      def escape_quotes(text)
+        text.gsub(/"/, "''")
+      end
+
+      def escape_ats(text)
+        text.gsub(/@/, '\@')
+      end
+
+      # convenience method for word wrapping
+      # based on https://github.com/cmdrkeene/memegen/blob/master/lib/meme_generator.rb
+      def word_wrap(text, col = 27)
+        wrapped = text.gsub(/(.{1,#{col + 4}})(\s+|\Z)/, "\\1\n")
+        wrapped.chomp!
+      end
+    end
+  end
+end

data/lolcommits-loltext.gemspec

@@ -0,0 +1,44 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lolcommits/loltext/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "lolcommits-loltext"
+  spec.version       = Lolcommits::Loltext::VERSION
+  spec.authors       = ["Matthew Hutchinson"]
+  spec.email         = ["matt@hiddenloop.com"]
+  spec.summary       = %q{lolcommits text annotation plugin}
+
+  spec.description = <<-EOF
+  Overlay the commit message and sha on your lolcommit. Configure text style,
+  positioning and an optional transparent overlay.
+  EOF
+
+  spec.homepage      = "https://lolcommits.github.io"
+  spec.license       = "LGPL-3"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(assets|test|features)/}) }
+  spec.test_files    = `git ls-files -- {test,features}/*`.split("\n")
+  spec.bindir        = "bin"
+  spec.executables   = []
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.0.0"
+
+  spec.add_development_dependency "lolcommits", ">= 0.9.3"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "coveralls"
+end

data/test/lolcommits/plugin/loltext_test.rb

@@ -0,0 +1,136 @@
+require 'test_helper'
+
+describe Lolcommits::Plugin::Loltext do
+
+  include Lolcommits::TestHelpers::GitRepo
+  include Lolcommits::TestHelpers::FakeIO
+
+  def plugin_name
+    'loltext'
+  end
+
+  it 'should have a name' do
+    ::Lolcommits::Plugin::Loltext.name.must_equal plugin_name
+  end
+
+  it 'should run on post capturing' do
+    ::Lolcommits::Plugin::Loltext.runner_order.must_equal [:postcapture]
+  end
+
+  describe 'default font' do
+    it 'should have the correct file permissions' do
+      font_permissions = File.lstat(Lolcommits::Plugin::Loltext::DEFAULT_FONT_PATH).mode & 0o777
+      (font_permissions == 0o644).must_equal(true,
+        "expected perms of 644/664 but instead got #{format '%o', font_permissions}")
+    end
+  end
+
+  describe 'with a runner' do
+    def runner
+      # a simple lolcommits runner with an empty configuration Hash
+      @runner ||= Lolcommits::Runner.new(
+        config: OpenStruct.new(read_configuration: {})
+      )
+    end
+
+    def plugin
+      @plugin ||= Lolcommits::Plugin::Loltext.new(runner)
+    end
+
+    def valid_enabled_config
+      @config ||= OpenStruct.new(
+        read_configuration: {
+          plugin.class.name => { 'enabled' => true }
+        }
+      )
+    end
+
+    describe 'initalizing' do
+      it 'should assign runner and an enabled option' do
+        plugin.runner.must_equal runner
+        plugin.options.must_equal ['enabled']
+      end
+    end
+
+    describe '#enabled?' do
+      it 'should be true by default' do
+        plugin.enabled?.must_equal true
+      end
+
+      it 'should true when configured' do
+        plugin.runner.config = valid_enabled_config
+        plugin.enabled?.must_equal true
+      end
+    end
+
+    describe 'configuration' do
+      it 'should not be configured by default' do
+        plugin.configured?.must_equal false
+      end
+
+      it 'should allow plugin options to be configured' do
+        # enabled
+        inputs = ['true']
+
+        # styling message and sha
+        inputs += %w(
+          red
+          myfont.ttf
+          SE
+          38
+          orange
+          true
+        ) * 2
+
+        # styling overlay
+        inputs += %w(true  #2884ae,#7e231f 40)
+
+        configured_plugin_options = {}
+        output = fake_io_capture(inputs: inputs) do
+          configured_plugin_options = plugin.configure_options!
+        end
+
+        configured_plugin_options.must_equal( {
+          "enabled" => true,
+          message: {
+            color: 'red',
+            font: 'myfont.ttf',
+            position: 'SE',
+            size: 38,
+            stroke_color: 'orange',
+            uppercase: true
+          },
+          sha: {
+            color: 'red',
+            font: 'myfont.ttf',
+            position: 'SE',
+            size: 38,
+            stroke_color: 'orange',
+            uppercase: true
+          },
+          overlay: {
+            enabled: true,
+            overlay_colors: ['#2884ae', '#7e231f'],
+            overlay_percent: 40
+          }
+        })
+      end
+
+      it 'should indicate when configured' do
+        plugin.runner.config = valid_enabled_config
+        plugin.configured?.must_equal true
+      end
+
+      describe '#valid_configuration?' do
+        it 'should be trye even if config is not set' do
+          plugin.valid_configuration?.must_equal(true)
+        end
+
+        it 'should be true for a valid configuration' do
+          plugin.runner.config = valid_enabled_config
+          plugin.valid_configuration?.must_equal true
+        end
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,28 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+# necessary libs from lolcommits (allowing plugin to run)
+require 'git'
+require 'lolcommits/runner'
+require 'lolcommits/vcs_info'
+require 'lolcommits/backends/git_info'
+
+# lolcommit test helpers
+require 'lolcommits/test_helpers/git_repo'
+require 'lolcommits/test_helpers/fake_io'
+
+if ENV['COVERAGE']
+  if ENV['TRAVIS']
+    require 'coveralls'
+    Coveralls.wear!
+  else
+    require 'simplecov'
+  end
+end
+
+# plugin gem test libs
+require 'lolcommits/loltext'
+require 'lolcommits/plugin/loltext'
+require 'minitest/autorun'
+
+# swallow all debug output during test runs
+def debug(msg); end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: lolcommits-loltext
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Matthew Hutchinson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lolcommits
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+    Overlay the commit message and sha on your lolcommit. Configure text style,
+    positioning and an optional transparent overlay.
+email:
+- matt@hiddenloop.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".simplecov"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/lolcommits/loltext.rb
+- lib/lolcommits/loltext/version.rb
+- lib/lolcommits/plugin/loltext.rb
+- lolcommits-loltext.gemspec
+- test/lolcommits/plugin/loltext_test.rb
+- test/test_helper.rb
+- vendor/fonts/Impact.ttf
+homepage: https://lolcommits.github.io
+licenses:
+- LGPL-3
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: lolcommits text annotation plugin
+test_files:
+- test/lolcommits/plugin/loltext_test.rb
+- test/test_helper.rb