lolcommits 0.9.3.pre1 → 0.9.3.pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55a7484224a62eed8753cf32fad0f20d9a483085
-  data.tar.gz: 2df1e2ec28806051f29c7b36be4a0e488ee7e421
+  metadata.gz: c7f9361b802d1360887f9abf9851379a40a006af
+  data.tar.gz: f6eaccaf5bcd60b3de0919d0e2d50cd0c9b42c60
 SHA512:
-  metadata.gz: 95f619adfecfd08f49430f1745a73a1de8047b9342564d304149d61ba00ccb8bdff560760fa6bf33e440e25ab505f6c6239527ff328f88f098bf71bbb2dbfa08
-  data.tar.gz: 5aac1f41ae637f4d479707e60d4140fcf240ddb8820fd82de8415ca93c7d43494be40f2dfc266e16e6bad737bc9015089ead311ed32e099cb0d15d3f8558e162
+  metadata.gz: 7760ce09dbb11464c376382c1d7aad4503affba32f36aaae686f0095ad0348e97f5dc6d20185bbe26709936cca5e68f60aa99f6e705252a21479a44868c366dc
+  data.tar.gz: a55a968ffcb164820a4b7ca18994ebd58a7da8ca95cf06033e4ab069a5560cb0f22459757a374a74be3382bba48399b635c31c2c66d8e9d9b58523768daf5d08

data/.rubocop_todo.yml

@@ -1,50 +1,83 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-12-11 21:07:49 +0000 using RuboCop version 0.46.0.
+# on 2017-04-04 11:42:26 +0100 using RuboCop version 0.48.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
+# Offense count: 1
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'lib/lolcommits/cli/process_runner.rb'
+
 # Offense count: 35
 Metrics/AbcSize:
-  Max: 38
+  Max: 37
 
 # Offense count: 2
-# Configuration parameters: CountComments.
+# Configuration parameters: CountComments, ExcludedMethods.
 Metrics/BlockLength:
-  Max: 113
+  Max: 40
 
 # Offense count: 5
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 160
+  Max: 149
 
 # Offense count: 6
 Metrics/CyclomaticComplexity:
-  Max: 9
+  Max: 8
 
-# Offense count: 137
+# Offense count: 152
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Metrics/LineLength:
   Max: 161
 
-# Offense count: 44
+# Offense count: 42
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
   Max: 31
 
 # Offense count: 5
 Metrics/PerceivedComplexity:
-  Max: 11
+  Max: 10
 
-# Offense count: 34
+# Offense count: 1
+# Cop supports --auto-correct.
+Security/YAMLLoad:
+  Exclude:
+    - 'lib/lolcommits/configuration.rb'
+
+# Offense count: 37
 Style/Documentation:
   Enabled: false
 
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/EmptyLinesAroundBeginBody:
+  Exclude:
+    - 'lib/lolcommits/plugin/lol_flowdock.rb'
+    - 'lib/lolcommits/plugin/lol_slack.rb'
+
 # Offense count: 1
 # Cop supports --auto-correct.
-Security/YAMLLoad:
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: auto_detection, squiggly, active_support, powerpack, unindent
+Style/IndentHeredoc:
   Exclude:
-    - 'lib/lolcommits/configuration.rb'
+    - 'lib/lolcommits/backends/installation_git.rb'
+
+# Offense count: 77
+# Cop supports --auto-correct.
+# Configuration parameters: PreferredDelimiters.
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: SupportedStyles.
+# SupportedStyles: percent, brackets
+Style/SymbolArray:
+  EnforcedStyle: brackets

data/CHANGELOG.md

@@ -8,8 +8,9 @@ project adheres to [Semantic Versioning][Semver].
   * WIP - extract more plugins to gems ...
   * Your contribution here!
 
-## [0.9.3][] (6 March 2017)
-  * Gem plugin support (@matthutchinson [#332][])
+## [0.9.3][] (5 April 2017)
+  * LOLCOMMITS_CAPTURE_DISABLED env var (@williamboman [#338][])
+  * Plugin Manager and Gem plugin support (@matthutchinson [#332][])
   * Add North gravity for ImageMagick (@domudall [#331][])
   * remove Ruby 1.9 magic comments (@matthutchinson [#330][])
   * add links to PRs in CHANGELOG (@bfontaine [#329][])
@@ -272,7 +273,8 @@ project adheres to [Semantic Versioning][Semver].
   instead of compositing multiply image Caption objects (this seems to be more
   reliable to not glitch.)
 
-[Unreleased]: https://github.com/mroth/lolcommits/compare/v0.9.2...HEAD
+[Unreleased]: https://github.com/mroth/lolcommits/compare/v0.9.3...HEAD
+[0.9.3]: https://github.com/mroth/lolcommits/compare/v0.9.2...v0.9.3
 [0.9.2]: https://github.com/mroth/lolcommits/compare/v0.9.1...v0.9.2
 [0.9.1]: https://github.com/mroth/lolcommits/compare/v0.9.0...v0.9.1
 [0.9.0]: https://github.com/mroth/lolcommits/compare/v0.8.1...v0.9.0
@@ -429,3 +431,4 @@ project adheres to [Semantic Versioning][Semver].
 [#330]: https://github.com/mroth/lolcommits/pull/330
 [#331]: https://github.com/mroth/lolcommits/pull/331
 [#332]: https://github.com/mroth/lolcommits/pull/332
+[#338]: https://github.com/mroth/lolcommits/pull/338

data/README.md

@@ -17,9 +17,9 @@ By default, the lol images are stored by a Github style short SHA in a
 
 <img src="https://lolcommits.github.io/assets/img/gallery.jpeg" />
 
-Please add your own lolcommit! Add to the [People Using
+Please add your own lolcommit to the [People Using
 Lolcommits](https://github.com/mroth/lolcommits/wiki/Lolcommits-from-around-the-world%21)
-page on our wiki.
+page on our wiki!
 
 
 ## Requirements
@@ -33,7 +33,7 @@ page on our wiki.
 ## Installation
 
 
-### Mac OS X
+### macOS
 
 You'll need ImageMagick installed. [Homebrew](http://mxcl.github.com/homebrew/)
 makes this easy.
@@ -45,13 +45,10 @@ Then install with:
 	[sudo] gem install lolcommits
 
 If you're using RVM (or rbenv), you can/should probably omit the sudo, but the
-default MacOSX Ruby install is dumb and requires it.
-
-If [Boxen](https://boxen.github.com) is your thing, [try
-this](https://github.com/AssuredLabor/puppet-lolcommits).
+default macOS Ruby install is dumb and requires it.
 
 Lolcommits v0.8.1 was the last release to support Ruby < 2.0. If you'd like to
-use this program on older rubies try:
+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
@@ -59,14 +56,14 @@ use this program on older rubies try:
 
 ### Linux
 
-Install dependencies using your package manager of choice, for example in
+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
-ffmpeg](http://ffmpeg.org/download.html)
+longer ships with the default Ubuntu sources ([downloads
+here](http://ffmpeg.org/download.html)).
 
 Then install with:
 
@@ -88,14 +85,15 @@ Windows](https://github.com/mroth/lolcommits/wiki/Installing-on-Windows).
 
 ### Enabling and basic usage
 
-From within any git repository, simply do a `lolcommits --enable`. From that
-point on, any git commit will automatically trigger a lolcommit capture! All
-lolcommits are stored in `~/.lolcommits` by default, placed in a subdirectory by
-project name, and 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.
 
-You can also enable lolcommits across all your local git repos. Follow [these
+Follow [these
 steps](https://github.com/mroth/lolcommits/wiki/Enabling-Lolcommits-for-all-your-Git-Repositories)
-to achieve this using `git init` and the `init.templatedir` setting.
+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!
@@ -103,7 +101,7 @@ installed!
 
 ### Other commands
 
-Ok, if you insist... Since you know about `--enable`, common sense suggests
+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.
 
@@ -118,10 +116,10 @@ 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 variables.
+forked process. See the section below for more capture configuration options.
 
 
-### Capture configuration variables
+### Capture configuration options
 
 lolcommits has some capture options for additional lulz. You can enable these
 via environment variables like so;
@@ -129,14 +127,18 @@ via environment variables like so;
 * `LOLCOMMITS_DEVICE` set a webcam device - **mac and linux only**
 * `LOLCOMMITS_ANIMATE` (in seconds) set time for capturing an animated gif -
   **requires ffmpeg**
-* `LOLCOMMITS_DELAY` (in seconds) set delay persistently (for slow webcams to
-  warmup)
+* `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 notification messages at commit time
-* `LOLCOMMITS_DIR` set the output directory used for all repositories (defaults to ~/.lolcommits)
+* `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')
+
 
-Or they can be set with these arguments to the capture command (located in your
+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}`
@@ -154,7 +156,8 @@ loltext plugin with this command:
 
     lolcommits --config -p loltext
 
-To find out more, read about [loltext options](https://github.com/mroth/lolcommits/wiki/Configure-Commit-Capturing#loltext-options).
+To find out more about styling, read about the [loltext
+options](https://github.com/mroth/lolcommits/wiki/Configure-Commit-Capturing#loltext-options).
 
 
 ### Animated Gif Capturing
@@ -164,7 +167,7 @@ you capture and the capabilities of your machine).
 [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)
-* OSX - `brew install ffmpeg`
+* macOS - `brew install ffmpeg`
 
 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
@@ -180,21 +183,38 @@ animated lolcommit gif")
 
 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 auto post to Twitter, Tumblr
-(and other services), or even translate your commit messages to
-[lolspeak](http://www.urbandictionary.com/define.php?term=lolspeak). They can be
-easily enabled, configured or disabled with the `--config` option:
+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/mroth/lolcommits/wiki/Configuring-Plugins).
+
+Until recently, all plugins lived inside the main lolcommits gem. We are in the
+process of extracting them to individual gems. For [gem
+plugins](https://github.com/lolcommits), you'll need
+to install the gem first:
+
+    [sudo] gem install lolcommits-plugin-sample
+
+To list available/installed plugins use:
+
+    lolcommits --plugins
+
+Plugins can be easily enabled, configured or disabled with the `--config`
+option:
 
     lolcommits --config
+    # or
+    lolcommits --config -p loltxt
 
-Check them out on our [plugins
-page](https://github.com/mroth/lolcommits/wiki/Configuring-Plugins).
+Interested in developing your own plugin? Follow this [this simple
+guide](https://github.com/lolcommits/lolcommits-plugin-sample) for the
+Lolcommits Plugin Sample gem.
 
 
 ## Timelapse
 
-To watch your face as it decays while you program, you can create an animated
-timelapse gif.
+Watch your face decay while you program, with an animated timelapse gif!
 
     lolcommits --timelapse
     # or for just today's lolcommits
@@ -203,10 +223,10 @@ timelapse gif.
 ## Troubles?
 
 Try our trouble-shooting [FAQ](https://github.com/mroth/lolcommits/wiki/FAQ), or
-take a read through our [wiki](https://github.com/mroth/lolcommits/wiki) for
-more information. If you think something is broken or missing, raise a [Github
-issue](https://github.com/mroth/lolcommits/issues) (and please take a little
-time to check if we haven't [already
+take a read through our [wiki](https://github.com/mroth/lolcommits/wiki). If you
+think something is broken or missing, please raise a [Github
+issue](https://github.com/mroth/lolcommits/issues) (and please check if we
+haven't [already
 addressed](https://github.com/mroth/lolcommits/issues?q=is%3Aissue+is%3Aclosed)
 it).
 

data/bin/lolcommits

@@ -36,13 +36,13 @@ class App
         debug 'Outputting at DEBUG verbosity'
       end
 
-      # TODO: move to a better place
-      load_plugins
+      plugin_manager = PluginManager.init
+      config         = Configuration.new(plugin_manager, test_mode: options[:test])
 
       if options[:'show-config']
-        puts configuration
+        puts config
       elsif options[:plugins]
-        puts configuration.plugins_list
+        config.list_plugins
       elsif options[:devices]
         puts Platform.device_list
         puts device_list_help
@@ -59,15 +59,15 @@ class App
         end
 
         if options[:last]
-          show_last_lolimage
+          show_last_lolimage(config.loldir)
         elsif options[:browse]
-          Launcher.open_folder(configuration.loldir)
+          Launcher.open_folder(config.loldir)
         elsif options[:timelapse]
-          TimelapseGif.new(configuration).run(options[:period])
+          TimelapseGif.new(config).run(options[:period])
         elsif options[:config]
-          configuration.do_configure!(options[:plugin])
+          config.do_configure!(options[:plugin])
         elsif options[:capture]
-          capture_lolcommit
+          capture_lolcommit(config)
         end
       end
     end
@@ -75,7 +75,7 @@ class App
 
   on('--test', 'run in test mode')
   on('--debug', 'show debugging info')
-  on('--show-config', 'show configuration file')
+  on('--show-config', 'show config file')
   on('--devices', 'list available capture devices (mac only)')
   on('--plugins', 'list all available plugins')
   on('--config', 'configure a plugin')
@@ -109,34 +109,17 @@ class App
       'Or:  lolcommits --help'
   end
 
-  # Gets a configuration object.  If running in test mode will override the
-  # LOLDIR for the configuration.
-  #
-  # @return [Lolcommits::Configuration]
-  def self.configuration
-    if options[:test]
-      Configuration.new(loldir: Configuration.loldir_for('test'))
-    else
-      Configuration.new
-    end
-  end
-
   def self.debug_enabled?
     options[:debug] || ENV['LOLCOMMITS_DEBUG'] || false
   end
 
-  def self.load_plugins
-    pm = Lolcommits::PluginManager.new
-    pm.locate_plugins
-    pm.load_plugins
-  end
-
   def self.device_list_help
     'Specify a device with --device "{device name}" or set the LOLCOMMITS_DEVICE env variable'
   end
 
-  def self.show_last_lolimage
-    lolimage = configuration.most_recent
+  def self.show_last_lolimage(loldir)
+    lolimage = Dir.glob(File.join(loldir, '*.{jpg,gif}')).max_by { |f| File.mtime(f) }
+
     if lolimage.nil?
       warn 'No lolcommits have been captured for this repository yet.'
       exit 1
@@ -150,7 +133,7 @@ class App
     result
   end
 
-  def self.capture_lolcommit
+  def self.capture_lolcommit(config)
     should_we_fork  = options[:fork] || ENV['LOLCOMMITS_FORK'] || false
     capture_stealth = options[:stealth] || ENV['LOLCOMMITS_STEALTH'] || false
     capture_delay   = (options[:delay] || ENV['LOLCOMMITS_DELAY']).to_i
@@ -160,10 +143,10 @@ class App
       capture_stealth: capture_stealth,
       capture_device: capture_device,
       capture_animate: capture_animate,
-      config: configuration
+      config: config
     }
 
-    process_runner = ProcessRunner.new(configuration)
+    process_runner = ProcessRunner.new(config)
     process_runner.fork_me?(should_we_fork) do
       if options[:test]
         info '*** Capturing in test mode.'

data/lib/lolcommits/backends/installation_git.rb

@@ -58,22 +58,26 @@ module Lolcommits
     end
 
     def self.hook_script(capture_args = '')
+      # TODO: have this return a single line bash like mercurial install, and DRY
+      # this method (only different in git is the rebase-merge check which could
+      # be extracted
       ruby_path     = Lolcommits::Platform.command_which('ruby', true)
       imagick_path  = Lolcommits::Platform.command_which('identify', true)
+      capture_cmd   = 'lolcommits --capture'
 
       if Lolcommits::Platform.platform_windows?
-        hook_export = "set path \"#{ruby_path};#{imagick_path};%PATH%\"\n"
+        capture_cmd = 'if "%LOLCOMMITS_CAPTURE_DISABLED%"=="true" (exit)'
+        capture_cmd = "set path=#{ruby_path};#{imagick_path};%PATH%&&#{capture_cmd}"
       else
-        locale_export = "export LANG=\"#{ENV['LANG']}\"\n"
-        hook_export   = "export PATH=\"#{ruby_path}:#{imagick_path}:$PATH\"\n"
+        locale_export = "LANG=\"#{ENV['LANG']}\""
+        hook_export   = "PATH=\"#{ruby_path}:#{imagick_path}:$PATH\""
+        capture_cmd   = "#{locale_export} #{hook_export} #{capture_cmd}"
       end
 
-      capture_cmd = 'lolcommits --capture'
-
       <<-EOS
 ### lolcommits hook (begin) ###
-if [ ! -d "$GIT_DIR/rebase-merge" ]; then
-#{locale_export}#{hook_export}#{capture_cmd} #{capture_args}
+if [ ! -d "$GIT_DIR/rebase-merge" ] && [ "$LOLCOMMITS_CAPTURE_DISABLED" != "true" ]; then
+#{capture_cmd} #{capture_args}
 fi
 ###  lolcommits hook (end)  ###
 EOS

data/lib/lolcommits/backends/installation_mercurial.rb

@@ -43,14 +43,16 @@ module Lolcommits
       capture_cmd   = 'lolcommits --capture'
 
       if Lolcommits::Platform.platform_windows?
-        capture_cmd = "set path=#{ruby_path};#{imagick_path};%PATH%&&#{capture_cmd}"
+        capture_cmd = 'if "%LOLCOMMITS_CAPTURE_DISABLED%"=="true" (exit)'
+        capture_cmd = "set path=#{ruby_path};#{imagick_path};%PATH%&&#{capture_cmd} #{capture_args}"
       else
         locale_export = "LANG=\"#{ENV['LANG']}\""
         hook_export   = "PATH=\"#{ruby_path}:#{imagick_path}:$PATH\""
-        capture_cmd = "#{locale_export} #{hook_export} #{capture_cmd}"
+        capture_cmd   = "#{locale_export} #{hook_export} #{capture_cmd}"
+        capture_cmd   = "if [ \"$LOLCOMMITS_CAPTURE_DISABLED\" != \"true\" ]; then #{capture_cmd} #{capture_args}; fi"
       end
 
-      "#{capture_cmd} #{capture_args}"
+      capture_cmd
     end
 
     def self.repository
@@ -60,7 +62,7 @@ module Lolcommits
     # does a mercurial hook exist with lolcommits commands?
     def self.lolcommits_hook_exists?
       config = repository.config
-      config.exists? && config.setting_exists?(HOOK_SECTION, 'post-commit.lolcommits')
+      config.exists? && config.setting_exists?(HOOK_SECTION, 'post-crecord.lolcommits')
     end
 
     # can we load the hgrc?

data/lib/lolcommits/configuration.rb

@@ -2,12 +2,11 @@ module Lolcommits
   class Configuration
     LOLCOMMITS_BASE = ENV['LOLCOMMITS_DIR'] || File.join(ENV['HOME'], '.lolcommits')
     LOLCOMMITS_ROOT = File.join(File.dirname(__FILE__), '../..')
-    attr_writer :loldir
+    attr_accessor :plugin_manager, :loldir
 
-    def initialize(attributes = {})
-      attributes.each do |attr, val|
-        send("#{attr}=", val)
-      end
+    def initialize(plugin_manager, test_mode: false)
+      @plugin_manager = plugin_manager
+      @loldir         = Configuration.loldir_for('test') if test_mode
     end
 
     def read_configuration
@@ -39,10 +38,6 @@ module Lolcommits
       dir
     end
 
-    def most_recent
-      Dir.glob(File.join(loldir, '*.{jpg,gif}')).max_by { |f| File.mtime(f) }
-    end
-
     def jpg_images
       Dir.glob(File.join(loldir, '*.jpg')).sort_by { |f| File.mtime(f) }
     end
@@ -67,26 +62,26 @@ module Lolcommits
       File.join(loldir, 'tmp_frames')
     end
 
-    def plugins_list
-      "Available plugins: \n * #{Lolcommits::Runner.plugins.map(&:name).sort.join("\n * ")}"
-    end
-
-    def ask_for_plugin_name
-      puts plugins_list
-      print 'Name of plugin to configure: '
-      gets.strip
+    def list_plugins
+      puts "Available plugins: \n * #{plugin_manager.plugin_names.join("\n * ")}"
     end
 
     def find_plugin(plugin_name_option)
       plugin_name = plugin_name_option.empty? ? ask_for_plugin_name : plugin_name_option
+      return if plugin_name.empty?
 
-      Lolcommits::Runner.plugins.each do |plugin|
-        return plugin.new(nil) if plugin.name == plugin_name
-      end
+      plugin_klass = plugin_manager.find_by_name(plugin_name)
+      return plugin_klass.new(nil) if plugin_klass
 
       puts "Unable to find plugin: '#{plugin_name}'"
       return if plugin_name_option.empty?
-      puts plugins_list
+      list_plugins
+    end
+
+    def ask_for_plugin_name
+      list_plugins
+      print 'Name of plugin to configure: '
+      gets.strip
     end
 
     def do_configure!(plugin_name)

data/lib/lolcommits/gem_plugin.rb

@@ -1,12 +1,9 @@
 module Lolcommits
   class GemPlugin
-    attr_accessor :name, :gem_name, :spec, :required
+    attr_accessor :gem_spec, :required
 
-    def initialize(name, gem_name, spec)
-      @name     = name
-      @gem_name = gem_name
-      @spec     = spec
-      @required = false
+    def initialize(gem_spec)
+      @gem_spec = gem_spec
     end
 
     # activate the plugin (require the gem - enables/loads the plugin
@@ -15,13 +12,13 @@ module Lolcommits
       begin
         require gem_path unless required?
       rescue LoadError => e
-        warn "Found plugin #{gem_name}, but could not require '#{gem_name}'"
+        warn "Found plugin #{name}, but could not require gem '#{gem_name}'"
         warn e
       rescue => e
-        warn "require '#{gem_name}' # Failed, saying: #{e}"
+        warn "require gem '#{gem_name}' failed with: #{e}"
       end
 
-      self.required = true
+      @required = true
     end
 
     alias required? required
@@ -29,7 +26,7 @@ module Lolcommits
     def supported?
       # false if the plugin gem does not support this version of Lolcommits
       lolcommits_version = Gem::Version.new(::Lolcommits::VERSION)
-      spec.dependencies.each do |dependency|
+      gem_spec.dependencies.each do |dependency|
         if dependency.name == Lolcommits::GEM_NAME
           return dependency.requirement.satisfied_by?(lolcommits_version)
         end
@@ -37,10 +34,28 @@ module Lolcommits
       true
     end
 
+    def name
+      gem_name.split('-', 2).last
+    end
+
+    def plugin_klass
+      self.class.const_get(plugin_klass_name)
+    rescue => e
+      warn "failed to load constant from plugin gem '#{plugin_klass_name}: #{e}'"
+    end
+
     private
 
+    def gem_name
+      gem_spec.name
+    end
+
     def gem_path
       gem_name.gsub(/-|_/, '/')
     end
+
+    def plugin_klass_name
+      gem_path.split('/').map(&:capitalize).join('::')
+    end
   end
 end

data/lib/lolcommits/plugin/base.rb

@@ -100,10 +100,16 @@ module Lolcommits
         'plugin'
       end
 
-      # a plugin requests to be run by the runner in one of these positions
-      # valid options are [:precapture, :postcapture]
+      # Returns position(s) of when a 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.
+      #
+      # @return [Array] the position(s) (:precapture and/or :postcapture)
+      #
       def self.runner_order
-        nil
+        []
       end
     end
   end

data/lib/lolcommits/plugin_manager.rb

@@ -1,41 +1,63 @@
 module Lolcommits
   class PluginManager
-    GEM_NAME_PREFIX = /^lolcommits-plugin-/
+    GEM_NAME_PREFIX = /^lolcommits-/
+
+    def self.init
+      pm = new
+      pm.load_plugins
+      pm
+    end
 
     def initialize
       @plugins = []
     end
 
-    # @return [Array] find all installed and supported plugins, storing to
-    #   @plugins Array, and returns this array
-    def locate_plugins
-      gem_list.each do |gem|
-        next if gem.name !~ GEM_NAME_PREFIX
-        plugin_name = gem.name.split('-', 2).last
-        plugin = GemPlugin.new(plugin_name, gem.name, gem)
+    # find and require all plugins
+    def load_plugins
+      find_plugins
+      @plugins.map(&:activate!)
+    end
 
-        @plugins << plugin if plugin.supported? && !plugin_located?(plugin)
-      end
-      @plugins
+    def plugins_for(position)
+      plugin_klasses.select { |p| Array(p.runner_order).include?(position) }
     end
 
-    # @return [Hash] A hash with all plugin names (minus the prefix) as
-    #   keys and Plugin objects as values
-    def plugins
-      h = {}
-      @plugins.each do |plugin|
-        h[plugin.name] = plugin
-      end
-      h
+    # @return [Lolcommits::Plugin] find first plugin matching name
+    def find_by_name(name)
+      plugin_klasses.find { |plugin| plugin.name =~ /^#{name}/ }
     end
 
-    # require all plugins
-    def load_plugins
-      @plugins.map(&:activate!)
+    def plugin_names
+      # TODO: when all plugins are gems, get names from GemPlugin with
+      #   @plugins.map(&:name)
+      plugin_klasses.map(&:name).sort
     end
 
     private
 
+    # @return [Array] find all classes inheriting from Lolcommits::Plugin::Base
+    def plugin_klasses
+      # TODO: when all plugins are gems, change this to
+      #   @plugins.map(&:plugin_klass)
+      ObjectSpace.each_object(Class).select { |klass| klass < Lolcommits::Plugin::Base }
+    end
+
+    # @return [Array] find all installed and supported plugins, populate
+    #   @plugins array and return it
+    def find_plugins
+      find_gems.map do |gem|
+        plugin = GemPlugin.new(gem)
+        @plugins << plugin if plugin.supported? && !plugin_located?(plugin)
+      end
+
+      @plugins
+    end
+
+    # @return [Array] find all installed gems matching GEM_NAME_PREFIX
+    def find_gems
+      gem_list.select { |gem| gem.name =~ GEM_NAME_PREFIX }
+    end
+
     def plugin_located?(plugin)
       @plugins.any? { |existing| existing.gem_name == plugin.gem_name }
     end

data/lib/lolcommits/runner.rb

@@ -28,15 +28,11 @@ module Lolcommits
     # this used to be handled with ActiveSupport::Callbacks, but
     # now we're just using a simple procedural list
     def run
-      # do things that need to happen before capture and plugins
-
-      # do native plugins that need to happen before capture
-      plugins_for(:precapture).each do |plugin|
+      # do plugins that need to happen before capture
+      plugin_manager.plugins_for(:precapture).each do |plugin|
         plugin.new(self).execute_precapture
       end
 
-      # do gem plugins that need to happen before capture?
-
       # do main capture to snapshot_loc
       run_capture
 
@@ -51,13 +47,11 @@ module Lolcommits
         # reserve just for us and handle manually...?
         Lolcommits::Plugin::Loltext.new(self).execute_postcapture
 
-        # do native plugins that need to happen after capture
-        plugins_for(:postcapture).each do |plugin|
+        # do plugins that need to happen after capture
+        plugin_manager.plugins_for(:postcapture).each do |plugin|
           plugin.new(self).execute_postcapture
         end
 
-        # do gem plugins that need to happen after capture?
-
         # do things that should happen last
         cleanup!
       else
@@ -66,16 +60,6 @@ module Lolcommits
       end
     end
 
-    # TODO: - move these plugin methods to Lolcommits::PluginManager after all
-    # plugins get "gemified"
-    def plugins_for(position)
-      self.class.plugins.select { |p| p.runner_order == position }
-    end
-
-    def self.plugins
-      Lolcommits::Plugin.constants.map(&Lolcommits::Plugin.method(:const_get)) - [Lolcommits::Plugin::Base]
-    end
-
     # the main capture
     def run_capture
       puts '*** Preserving this moment in history.' unless capture_stealth
@@ -99,6 +83,10 @@ module Lolcommits
 
     private
 
+    def plugin_manager
+      @plugin_manager ||= config.plugin_manager
+    end
+
     def image_file_type
       capture_animated? ? 'gif' : 'jpg'
     end

data/lib/lolcommits/version.rb

@@ -1,4 +1,4 @@
 module Lolcommits
-  VERSION  = '0.9.3.pre1'.freeze
+  VERSION  = '0.9.3.pre2'.freeze
   GEM_NAME = 'lolcommits'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lolcommits
 version: !ruby/object:Gem::Version
-  version: 0.9.3.pre1
+  version: 0.9.3.pre2
 platform: ruby
 authors:
 - Matthew Rothenberg
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-06 00:00:00.000000000 Z
+date: 2017-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aruba