lolcommits-sample_plugin 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7ffe2fc5bb37796e2caa83cdc405f1ab4808549f
+  data.tar.gz: c619b4df32c1e19f25d3bbce19a7b84fd0ee549c
+SHA512:
+  metadata.gz: d453e58648d7b88bd2a8d7b842ae99779b05a90ddc80405f3181b0c9f5c9a267f50509bfc770dad363e56dbcca22de8bec2190d29462e90d665fb881de67bb34
+  data.tar.gz: 3bac9cf3fcd42827acac4ae7834b3f889d0cc21db2cbef0596a01de2e3c3bdd79c7d0ea5858f7aebaf606c72771b33d49e2566afb5b280149a4ce6132f1ad59f

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,31 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+ - 2.0.0
+ - 2.1.10
+ - 2.2.8
+ - 2.3.5
+ - 2.4.2
+ - 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
+
+env:
+  global:
+    - CC_TEST_REPORTER_ID=7fb6d4a66ca2ac21658b29d3738952994f3b68354a8e3e6318bf1108eda6c243
+    - GIT_COMMITTED_AT=$(if [ "$TRAVIS_PULL_REQUEST" == "false" ]; then git log -1 --pretty=format:%ct; else git log -1 --skip 1 --pretty=format:%ct; fi)
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build - GIT_COMMITTED_AT=$(if [ "$TRAVIS_PULL_REQUEST" == "false" ]; then git log -1 --pretty=format:%ct; else git log -1 --skip 1 --pretty=format:%ct; fi)
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

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-sample_plugin.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-sample_plugin/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-sample_plugin/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,286 @@
+# Lolcommits Sample Plugin
+
+[![Gem Version](https://img.shields.io/gem/v/lolcommits-sample_plugin.svg?style=flat)](http://rubygems.org/gems/lolcommits-sample_plugin)
+[![Travis Build Status](https://travis-ci.org/lolcommits/lolcommits-sample_plugin.svg?branch=master)](https://travis-ci.org/lolcommits/lolcommits-sample_plugin)
+[![Maintainability](https://img.shields.io/codeclimate/maintainability/lolcommits/lolcommits-sample_plugin.svg)](https://codeclimate.com/github/lolcommits/lolcommits-sample_plugin/maintainability)
+[![Test Coverage](https://img.shields.io/codeclimate/c/lolcommits/lolcommits-sample_plugin.svg)](https://codeclimate.com/github/lolcommits/lolcommits-sample_plugin/test_coverage)
+[![Gem Dependency Status](https://gemnasium.com/badges/github.com/lolcommits/lolcommits-sample_plugin.svg)](https://gemnasium.com/github.com/lolcommits/lolcommits-sample_plugin)
+
+[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!
+
+Lolcommit plugins are automatically loaded before the capturing process starts.
+The flexible class design allows developers to add features by running code
+before or after snapshots are taken.
+
+This gem showcases an example plugin. It prints short messages to the screen
+before and after every lolcommit. Something like this;
+
+    ✨  Say cheese 😁 !
+    *** Preserving this moment in history.
+    📸  Snap
+    ✨  wow! 9e6303c is your best looking commit yet! 😘  💻
+
+Use this repo to jump-start development on your own plugin. It has tests, docs
+and integration with useful tools (Travis, CodeClimate, Rdoc etc.) See below for
+more information on how to get started.
+
+## Developing your own plugin
+
+First, there are some things your gem *must* do to be loaded and executed
+correctly. At the very least:
+
+* Name your gem with the `lolcommits-` prefix.
+* Include a class that inherits from `Lolcommits::Plugin::Base` (this will be
+  the entry point to your plugin from the lolcommits gem).
+* This main plugin class must meet the requirements explained below.
+* Require `lolcommits` in your gem spec as a development dependency.
+
+### Your Plugin Class
+
+You plugin class must have a namespace and path that matches your gem name and
+be in the `LOAD_PATH` (required) with the gem for example:
+
+    # a gem named: lolcommits-zapier
+    # should have a plugin class inheriting from Base like so:
+    class Lolcommits::Plugin::Zapier < Lolcommits::Plugin::Base
+      ...
+    end
+    # at lib/lolcommits/plugin/zapier.rb
+    # required in a file at lib/lolcommits/zapier.rb
+
+    # or a gem named: lolcommits-super_awesome
+    # should have a plugin class
+    class Lolcommits::Plugin::SuperAwesome < Lolcommits::Plugin::Base
+      ...
+    end
+    # required in a file at lib/lolcommits/super_awesome.rb
+
+You **should** override the following methods in this class:
+
+* `def self.name` - identifies the plugin to lolcommits and users, keep things
+  simple and choose a name that matches your gem name.
+* `def self.runner_order` - return the hooks this plugin should run at during
+  the capture process (`:pre_capture`, `:post_capture` and/or `:capture_ready`).
+* `def run_pre_capture`, `def run_post_capture` and/or `def run_capture_ready` -
+  override with your plugin's behaviour.
+
+Three hooks points are available during the lolcommits capture process.
+
+* `:pre_capture` - called before the camera starts capturing, at this point you
+  could alter the commit message/sha text.
+* `:post_capture` - called immediately after the camera snaps the raw image (or
+  video for gif captures) use this hook to alter the image, other plugins may
+  hook here to modify the image too.
+  `:capture_ready` - called after all `:post_capture` plugins have ran, at this
+  point the capture should be ready for exporting or sharing.
+
+### Plugin configuration
+
+The `Base` class initializer defines an `@options` instance var, with an array
+of setting names that the user can configure. By default, the only option is
+`enabled` and plugins *must* be configured as `enabled = true` to run.
+
+A plugin can be configured by the lolcommits gem with;
+
+    lolcommits --config
+    # or
+    lolcommits --config -p plugin-name
+
+Use the `configuration` method in your plugin class to read these options.
+Plugin methods you may want to override with custom configuration code include:
+
+* `def enabled?` - usually checks `configuration['enabled']` to determine if the
+  plugin should run.
+* `def configure_options!` - prompts the user for configuration (based on the
+  `@options`) returns a hash that will be persisted.
+* `def configured?` - checks the persisted config hash is present.
+* `def valid_configuration?`- checks the persisted config hash has valid data.
+
+If your plugin requires no configuration, you could override the `enabled?`
+method to always return `true`. Users could disable your plugin by uninstalling
+the gem.
+
+By default a plugin will only run it's capture hooks if:
+
+* `valid_configuration?` returns true
+* `enabled?` returns true
+
+For more help, check out [the
+documentation](http://www.rubydoc.info/github/lolcommits/lolcommits-sample_plugin/Lolcommits/Plugin/SamplePlugin)
+for this plugin, or take a look at [other
+  lolcommit_plugins](https://github.com/search?q=topic%3Alolcommits-plugin+org%3Alolcommits&type=Repositories) in the wild.
+
+### The Lolcommits 'runner'
+
+The only required argument for your plugin class initializer is a
+`Lolcommits::Runner` instance. By default, the base plugin initializer will set
+this in the `runner` instance var.
+
+Use these runner methods to access the commit, repo and configuration:
+
+* `runner.message` - the git commit message.
+* `runner.sha` - the git sha for the current commit.
+* `runner.vcs_info` - a reference to the
+  [Lolcommits::VCSInfo](https://github.com/mroth/lolcommits/blob/master/lib/lolcommits/vcs_info.rb)
+  instance.
+* `runner.config` - a reference to the
+  [Lolcommits::Configuration](https://github.com/mroth/lolcommits/blob/master/lib/lolcommits/configuration.rb)
+  instance.
+
+After the capturing process has completed, (i.e. in the `run_post_capture` or
+`run_capture_ready` hooks) these methods will reveal the captured snapshot file.
+
+* `runner.snapshot_loc` - the raw image file.
+* `runner.main_image` - the processed image file, resized, with text overlay
+  applied (or any other effects from other plugins).
+
+During plugin configuration, your plugin class will be initialized with the
+optional `config` argument (and no runner). This allows you to read the existing
+saved options during configuration. E.g. to show the existing options back to
+the user.
+
+Take a look at the
+[Lolcommits::Runner](https://github.com/mroth/lolcommits/blob/master/lib/lolcommits/runner.rb)
+for more details.
+
+### Testing your plugin
+
+It's a good idea to include tests with your gem. To make this easier for you,
+the main lolcommits gem provides helpers to work with IO and Git repos in
+test.
+
+    # add one or both of these to your plugin's test_helper file
+    require 'lolcommits/test_helpers/git_repo'
+    require 'lolcommits/test_helpers/fake_io'
+
+    # and include either (or both) modules in your test
+    include Lolcommits::TestHelpers::GitRepo
+    include Lolcommits::TestHelpers::FakeIO
+
+Use the following methods to manage a test repo:
+
+    setup_repo                 # create the test repo
+    commit_repo_with_message   # perform a git commit in the test repo
+    last_commit                # git commit info for the last commit in the test repo
+    teardown_repo              # destroy the test repo
+    in_repo(&block)            # run lolcommits within the test repo
+
+For submitting and capturing IO use the `fake_io_capture` method. E.g. to
+capture the output of the `configure_options` method, while sending the string
+input 'true' (followed by a carriage return) when prompted on STDIN:
+
+    output = fake_io_capture(inputs: %w(true)) do
+      configured_plugin_options = plugin.configure_options!
+    end
+
+For more examples take a look at the [tests in this
+repo](https://github.com/lolcommits/lolcommits-sample_plugin/blob/master/test/lolcommits/plugin/sample_plugin_test.rb)
+(MiniTest).
+
+### General advice
+
+Use this gem as a starting point, renaming files, classes and references. Or
+build a new plugin gem from scratch with:
+
+    bundle gem lolcommits-my-plugin
+
+For more examples, take a look at other published [lolcommit
+plugins](https://github.com/lolcommits).
+
+If you feel something is missing (or out of date) in this short guide. Please
+create a new
+[issue](https://github.com/lolcommits/lolcommits-sample_plugin/issues).
+
+## History
+
+Until recently, all plugins lived inside the main lolcommits gem. We are in the
+process of extracting them to individual gems, loaded with the new plugin
+manager. Ruby gem versioning will take care of managing dependencies and
+compatibility with the main gem.
+
+---
+
+## Requirements
+
+* Ruby >= 2.0.0
+* A webcam
+* [ImageMagick](http://www.imagemagick.org)
+* [ffmpeg](https://www.ffmpeg.org) (optional) for animated gif capturing
+
+## Installation
+
+Follow the [install guide](https://github.com/mroth/lolcommits#installation) for
+lolcommits first. Then run the following:
+
+    $ gem install lolcommits-sample_plugin
+
+Next configure and enable this plugin with:
+
+    $ lolcommits --config -p sample_plugin
+    # set enabled to `true`
+
+That's it! Every lolcommit now comes with it's own short (emoji themed) message!
+
+## Development
+
+Check out this repo and run `bin/setup`, this will install 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-sample_plugin/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-sample_plugin/issues) and [pull
+requests](https://github.com/lolcommits/lolcommits-sample_plugin/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-sample_plugin). Read the
+[contributing
+guidelines](https://github.com/lolcommits/lolcommits-sample_plugin/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-sample_plugin/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-sample_plugin)
+* [Test Coverage](https://codeclimate.com/github/lolcommits/lolcommits-sample_plugin/test_coverage)
+* [Code Climate](https://codeclimate.com/github/lolcommits/lolcommits-sample_plugin)
+* [RDoc](http://rdoc.info/projects/lolcommits/lolcommits-sample_plugin)
+* [Issues](http://github.com/lolcommits/lolcommits-sample_plugin/issues)
+* [Report a bug](http://github.com/lolcommits/lolcommits-sample_plugin/issues/new)
+* [Gem](http://rubygems.org/gems/lolcommits-sample_plugin)
+* [GitHub](https://github.com/lolcommits/lolcommits-sample_plugin)

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 Sample Plugin"
+  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/sample_plugin"
+
+# 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/plugin/sample_plugin.rb

@@ -0,0 +1,163 @@
+require 'lolcommits/plugin/base'
+
+module Lolcommits
+  module Plugin
+    class SamplePlugin < Base
+
+      ##
+      # Returns the name of the plugin.
+      #
+      # Identifies the plugin to lolcommits. This should be uniq and
+      # descriptive.
+      #
+      # @return [String] the plugin name
+      #
+      def self.name
+        'plugin-sample'
+      end
+
+      # Returns position(s) of when this plugin should run during the capture
+      # process.
+      #
+      # Defines when the plugin will execute in the capture process. This must
+      # be defined, if the method returns nil, or [] the plugin will never run.
+      # Three hook positions exist, your plugin code can execute in one or more
+      # of these.
+      #
+      # @return [Array] the position(s) (:pre_capture, :post_capture,
+      # :capture_ready)
+      #
+      def self.runner_order
+        [:pre_capture, :post_capture, :capture_ready]
+      end
+
+      ##
+      #
+      # Plugin initializer
+      #
+      # @param runner [Lolcommits::Runner] a instance of a lolcommits runner
+      # @param config [Lolcommits::Configuration] (optional)
+      #
+      # The default superclass method sets @runner and @config instance vars and
+      # the default plugin option key `@options = ['enabled']`. `@runner.config`
+      # is used if no `config` parameter is passed.
+      #
+      # Override this method to change the default options, or assign any useful
+      # variables necessary for the plugin to run.
+      #
+      def initialize(runner: nil, config: nil)
+        super
+      end
+
+      ##
+      #
+      # Pre-capture hook, runs before lolcommits captures a snapshot.
+      #
+      # Override this method to execute plugin code before the lolcommit
+      # snapshot is captured.
+      #
+      # Prints a short (emoji themed) message to STDOUT
+      #
+      def run_pre_capture
+        puts "✨  Say cheese 😁 !"
+      end
+
+      ##
+      #
+      # Post-capture hook, run after lolcommits captures a snapshot.
+      #
+      # Override this method to execute plugin code after the lolcommit
+      # snapshot is captured.
+      #
+      # Prints a short (emoji themed) message to STDOUT
+      #
+      def run_post_capture
+        puts "📸  Snap "
+      end
+
+      ##
+      #
+      # Capture ready hook, runs after lolcommits captures a snapshot.
+      #
+      # Override this method to execute plugin code after the lolcommit snapshot
+      # is captured and all image processing in post capture hooks (from other
+      # plugins) has completed
+      #
+      # Prints a short (emoji themed) message to STDOUT with the current commit
+      # sha.
+      #
+      def run_capture_ready
+        puts "✨  wow! #{self.runner.sha} is your best looking commit yet! 😘  💻"
+      end
+
+      ##
+      # Returns true/false indicating if the plugin is enabled or not.
+      #
+      # The default superclass method will return true if the enabled option is
+      # true  e.g. configuration['enabled'] == true
+      #
+      # Override this method to define your own custom enabled logic. E.g. check
+      # for valid or required configuration options to be set. If this method
+      # always returns true, the only way to disable the plugin will be to
+      # uninstall the gem.
+      #
+      # @return [Boolean] true/false indicating if plugin is enabled
+      #
+      def enabled?
+        super
+      end
+
+      ##
+      # Prompts the user to configure the plugin's options.
+      #
+      # The default superclass method will iterate over the @options array and
+      # build a configuration hash, prompting for user input on each option key.
+      #
+      # Lolcommits will save this configuration hash to its default config file
+      # (YAML). This config Hash is loaded and parsed during the capturing
+      # process and available in this plugin class via the configuration method.
+      #
+      # Override this method to define your own configuration flow. A helpful
+      # parse_user_input method is available to help parse strings from STDIN.
+      #
+      # @return [Hash] a hash of configured plugin options
+      #
+      def configure_options!
+        super
+      end
+
+      ##
+      # Returns true/false indicating if the plugin has been correctly
+      # configured.
+      #
+      # The default superclass method calls configured?. When false a message is
+      # shown explaining the plugin has not yet been configured, with help on
+      # how to configure it.
+      #
+      # Override this method to define your own configuration checks and
+      # messaging.
+      #
+      # This method must return true for the plugin to execute. It is checked by
+      # the lolcommits runner prior to running a pre or post capture hook.
+      #
+      # @return [Boolean] true/false indicating if plugin is correct configured
+      #
+      def valid_configuration?
+        super
+      end
+
+      ##
+      # Returns true/false indicating if the plugin has been configured.
+      #
+      # The default superclass method checks if the configuration hash is empty.
+      # Override this method to define your own check on whether configuration
+      # has taken place.
+      #
+      # @return [Boolean] true/false indicating if plugin has been configured
+      #
+      def configured?
+        super
+      end
+    end
+  end
+end

data/lib/lolcommits/sample_plugin/version.rb

@@ -0,0 +1,5 @@
+module Lolcommits
+  module SamplePlugin
+    VERSION = "0.0.1".freeze
+  end
+end

data/lib/lolcommits/sample_plugin.rb

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

data/lolcommits-plugin-sample.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lolcommits/sample_plugin/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "lolcommits-sample_plugin"
+  spec.version       = Lolcommits::SamplePlugin::VERSION
+  spec.authors       = ["Matthew Hutchinson"]
+  spec.email         = ["matt@hiddenloop.com"]
+
+  spec.summary       = %q{Example gem for lolcommits plugin development}
+  spec.description   = %q{Use this gem as a guide or template to get started with lolcommits plugin development}
+
+  spec.homepage      = "https://github.com/lolcommits/lolcommits-sample_plugin"
+  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{^(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.8"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "pry"
+end

data/test/lolcommits/plugin/sample_plugin_test.rb

@@ -0,0 +1,112 @@
+require 'test_helper'
+
+describe Lolcommits::Plugin::SamplePlugin do
+
+  include Lolcommits::TestHelpers::GitRepo
+  include Lolcommits::TestHelpers::FakeIO
+
+  it 'should run on pre_capture and capture_ready' do
+    ::Lolcommits::Plugin::SamplePlugin.runner_order.must_equal [
+      :pre_capture, :post_capture, :capture_ready
+    ]
+  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::SamplePlugin.new(runner: 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 '#run_pre_capture' do
+
+      before { commit_repo_with_message }
+
+      it 'should output a message to stdout' do
+        in_repo do
+          Proc.new { plugin.run_pre_capture }.
+            must_output "✨  Say cheese 😁 !\n"
+        end
+      end
+
+      after { teardown_repo }
+    end
+
+    describe '#run_capture_ready' do
+
+      before { commit_repo_with_message }
+
+      it 'should output a message to stdout' do
+        in_repo do
+          Proc.new { plugin.run_capture_ready }.
+            must_output "✨  wow! #{last_commit.sha[0..10]} is your best looking commit yet! 😘  💻\n"
+        end
+      end
+
+      after { teardown_repo }
+    end
+
+    describe '#enabled?' do
+      it 'should be false by default' do
+        plugin.enabled?.must_equal false
+      end
+
+      it 'should true when configured' do
+        plugin.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
+        configured_plugin_options = {}
+
+        output = fake_io_capture(inputs: %w(true)) do
+          configured_plugin_options = plugin.configure_options!
+        end
+
+        configured_plugin_options.must_equal( { "enabled" => true })
+      end
+
+      it 'should indicate when configured' do
+        plugin.config = valid_enabled_config
+        plugin.configured?.must_equal true
+      end
+
+      describe '#valid_configuration?' do
+        it 'should be false without config set' do
+          plugin.valid_configuration?.must_equal(false)
+        end
+
+        it 'should be true for a valid configuration' do
+          plugin.config = valid_enabled_config
+          plugin.valid_configuration?.must_equal true
+        end
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,22 @@
+$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']
+  require 'simplecov'
+end
+
+# plugin gem test libs
+require 'lolcommits/sample_plugin'
+require 'minitest/autorun'
+
+# swallow all debug output during test runs
+def debug(msg); end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: lolcommits-sample_plugin
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matthew Hutchinson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-23 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.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.8
+- !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: pry
+  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: Use this gem as a guide or template to get started with lolcommits plugin
+  development
+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/plugin/sample_plugin.rb
+- lib/lolcommits/sample_plugin.rb
+- lib/lolcommits/sample_plugin/version.rb
+- lolcommits-plugin-sample.gemspec
+- test/lolcommits/plugin/sample_plugin_test.rb
+- test/test_helper.rb
+homepage: https://github.com/lolcommits/lolcommits-sample_plugin
+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.13
+signing_key: 
+specification_version: 4
+summary: Example gem for lolcommits plugin development
+test_files:
+- test/lolcommits/plugin/sample_plugin_test.rb
+- test/test_helper.rb