lolcommits 0.9.8 → 0.10.0.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12f6e7333b2269c69ec65d675f107c330d05369371672c316e0610b9c263870a
-  data.tar.gz: d02a439065f69b0687c6f71b1c82d1131e59cf8cb3bc819db918419b8d0278fe
+  metadata.gz: 6ac258b4768122ade54206ac494b52d041dbe1ddbee4a8f464d302c4e477805c
+  data.tar.gz: 91abb44e9340561efb31942349d2b8edc17ad3b1d86149fe25bdae394beca967
 SHA512:
-  metadata.gz: df2fdfc47dc2475c4b5a369876d12e4651a261dff4cc1ee25d57ae1959733e6830a7bc2d3403df21d7e860f087c754d9f799717ef340410934f9cfb187d1d133
-  data.tar.gz: ab59a454da2e510712390135e46694a087e1510f7b1bdab64d960d1f60f72e05e3b30bd1e150c4b7df5c6fe20c5ab059075e75d68b6824cc27b9a09bf6b709c6
+  metadata.gz: 4a6946be8f2501f30dc74da7ffb99f332222f5489be04cb8be41c4c62112a7a82eb30de5f342f57219cf172413ed7df73405eab044be19ee15b8edb71a25b816
+  data.tar.gz: db2a6f1e5446ab3ed915d6229e91e97f28a359557d88b7f9a83b27d1516d562d0a40f266a4c40ef938e7f5843646a09391ea3fd2414577a2e0ec8748a18a96d7

data/.rubocop.yml

@@ -8,4 +8,12 @@ Metrics/BlockLength:
   Exclude:
     - 'lolcommits.gemspec'
 
+# don't agree with this one, can lead to long lines that are harder to parse
+Style/IfUnlessModifier:
+  Enabled: false
+
+# our gem supports 2.0+ but Rubocop only supports 2.1+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
 inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -1,44 +1,54 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2017-04-04 11:42:26 +0100 using RuboCop version 0.48.1.
+# on 2017-12-13 17:09:06 +0000 using RuboCop version 0.52.0.
 # 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: 7
+# Cop supports --auto-correct.
+# Configuration parameters: Include, TreatCommentsAsGroupSeparators.
+# Include: **/*.gemspec
+Gemspec/OrderedDependencies:
+  Exclude:
+    - 'lolcommits.gemspec'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: auto_detection, squiggly, active_support, powerpack, unindent
+Layout/IndentHeredoc:
+  Exclude:
+    - 'lib/lolcommits/backends/installation_git.rb'
+
 # Offense count: 1
 Lint/AmbiguousBlockAssociation:
   Exclude:
     - 'lib/lolcommits/cli/process_runner.rb'
 
-# Offense count: 35
+# Offense count: 19
 Metrics/AbcSize:
-  Max: 37
+  Max: 35
 
-# Offense count: 2
+# Offense count: 1
 # Configuration parameters: CountComments, ExcludedMethods.
 Metrics/BlockLength:
-  Max: 60
+  Max: 40
 
-# Offense count: 5
+# Offense count: 2
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 149
+  Max: 140
 
-# Offense count: 6
+# Offense count: 5
 Metrics/CyclomaticComplexity:
   Max: 9
 
-# Offense count: 152
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
-# URISchemes: http, https
-Metrics/LineLength:
-  Max: 161
-
-# Offense count: 42
+# Offense count: 23
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 31
+  Max: 24
 
 # Offense count: 5
 Metrics/PerceivedComplexity:
@@ -50,37 +60,38 @@ Security/YAMLLoad:
   Exclude:
     - 'lib/lolcommits/configuration.rb'
 
-# Offense count: 37
+# Offense count: 25
 Style/Documentation:
   Enabled: false
 
-# Offense count: 2
-# Cop supports --auto-correct.
-Layout/EmptyLinesAroundBeginBody:
-  Exclude:
-    - 'lib/lolcommits/plugin/lol_flowdock.rb'
-    - 'lib/lolcommits/plugin/lol_slack.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-# SupportedStyles: auto_detection, squiggly, active_support, powerpack, unindent
-Layout/IndentHeredoc:
+# Offense count: 5
+Style/MixinUsage:
   Exclude:
-    - 'lib/lolcommits/backends/installation_git.rb'
+    - 'Rakefile'
+    - 'bin/lolcommits'
+    - 'features/support/env.rb'
+    - 'test/lolcommits_test.rb'
 
-# Offense count: 77
+# Offense count: 5
 # Cop supports --auto-correct.
 # Configuration parameters: PreferredDelimiters.
 Style/PercentLiteralDelimiters:
-  Enabled: false
-
-Gemspec/OrderedDependencies:
-  Enabled: false
+  Exclude:
+    - 'Rakefile'
+    - 'features/support/path_helpers.rb'
+    - 'lib/lolcommits/backends/installation_mercurial.rb'
+    - 'lib/lolcommits/cli/fatals.rb'
+    - 'lib/lolcommits/installation.rb'
 
 # Offense count: 1
 # Cop supports --auto-correct.
-# Configuration parameters: SupportedStyles.
+# Configuration parameters: MinSize.
 # SupportedStyles: percent, brackets
 Style/SymbolArray:
   EnforcedStyle: brackets
+
+# Offense count: 90
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 161

data/.travis.yml

@@ -4,9 +4,9 @@ cache: bundler
 rvm:
  - 2.0.0
  - 2.1.10
- - 2.2.8
- - 2.3.5
- - 2.4.2
+ - 2.2.9
+ - 2.3.6
+ - 2.4.3
  - ruby-head
 
 before_install:

data/CHANGELOG.md

@@ -7,6 +7,14 @@ project adheres to [Semantic Versioning][Semver].
 
   * Your contribution here!
 
+## [0.10.0][] (10 January 2018)
+  * Plugin configuration changes (@matthutchinson [#365][])
+    - `--plugins` now shows if plugin is enabled or not
+    - `default_options` now available, nested hash with default values
+    - if `valid_configuration?` fails, warning message shows
+    - `prompt_autocomplete_hash` helper method added
+  * Better plugin config flow (@matthutchinson [#363][])
+
 ## [0.9.8][] (3 December 2017)
   * Extract protonet to gem (@matthutchinson [#361][])
   * Extract flowdock to gem (@matthutchinson [#360][])
@@ -302,7 +310,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.8...HEAD
+[Unreleased]: https://github.com/mroth/lolcommits/compare/v0.10.0...HEAD
+[0.10.0]: https://github.com/mroth/lolcommits/compare/v0.9.8...v0.10.0
 [0.9.8]: https://github.com/mroth/lolcommits/compare/v0.9.7...v0.9.8
 [0.9.7]: https://github.com/mroth/lolcommits/compare/v0.9.6...v0.9.7
 [0.9.6]: https://github.com/mroth/lolcommits/compare/v0.9.5...v0.9.6
@@ -484,3 +493,5 @@ project adheres to [Semantic Versioning][Semver].
 [#359]: https://github.com/mroth/lolcommits/pull/359
 [#360]: https://github.com/mroth/lolcommits/pull/360
 [#361]: https://github.com/mroth/lolcommits/pull/361
+[#363]: https://github.com/mroth/lolcommits/pull/363
+[#365]: https://github.com/mroth/lolcommits/pull/365

data/README.md

@@ -190,13 +190,6 @@ other services), or even translate your commit messages to
 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/search?q=topic%3Alolcommits-plugin+org%3Alolcommits&type=Repositories),
-you'll need to install the gem first:
-
-    [sudo] gem install lolcommits-plugin-sample
-
 To list all installed plugins use:
 
     lolcommits --plugins
@@ -209,8 +202,8 @@ Installed plugins can be easily enabled, configured or disabled with the
     lolcommits --config -p loltext
 
 Interested in developing your own plugin? Follow [this simple
-guide](https://github.com/lolcommits/lolcommits-plugin-sample#developing-your-own-plugin) at the
-Lolcommits Plugin Sample README.
+guide](https://github.com/lolcommits/lolcommits-sample_plugin#developing-your-own-plugin) at the
+Lolcommits Sample Plugin README.
 
 
 ## Timelapse

data/appveyor.yml

@@ -15,10 +15,6 @@ clone_folder: c:\projects\lolcommits
 clone_depth: 10
 skip_tags: true
 
-branches:
-  except:
-    - gh-pages
-
 init:
   # stub mplayer/ffmpeg so it looks like they are installed
   - mkdir c:\bin

data/features/bugs.feature

@@ -26,16 +26,6 @@ Feature: Bug regression testing
     # Then there should be 4 commit entries in the git log
     Then there should be exactly 6 jpgs in "../.lolcommits/yuh8history"
 
-  #
-  # issue #81, https://github.com/mroth/lolcommits/issues/81
-  #
-  Scenario: don't want initialized constant warning from Faraday (MRI 1.8.7)
-    When I successfully run `lolcommits`
-    Then the output should not contain:
-    """
-    warning: already initialized constant DEFAULT_BOUNDARY
-    """
-
   #
   # issue #87, https://github.com/mroth/lolcommits/issues/87
   #

data/features/lolcommits.feature

@@ -67,15 +67,16 @@ Feature: Basic UI functionality
       """
     And the exit status should be 1
 
-  Scenario: Capture doesnt break in forked mode
-    Given I am in a git repo named "forked"
-    And I do a git commit
-    When I run `lolcommits --capture --fork`
-    Then there should be exactly 1 pid in "~/.lolcommits/forked"
-    When I wait for the child process to exit in "forked"
-    Then a directory named "~/.lolcommits/forked" should exist
-      And a file named "~/.lolcommits/forked/tmp_snapshot.jpg" should not exist
-      And there should be exactly 1 jpg in "~/.lolcommits/forked"
+  # flakey test sometimes fails: https://travis-ci.org/mroth/lolcommits/jobs/312629988#L620
+  # Scenario: Capture doesnt break in forked mode
+  #   Given I am in a git repo named "forked"
+  #   And I do a git commit
+  #   When I run `lolcommits --capture --fork`
+  #   Then there should be exactly 1 pid in "~/.lolcommits/forked"
+  #   When I wait for the child process to exit in "forked"
+  #   Then a directory named "~/.lolcommits/forked" should exist
+  #     And a file named "~/.lolcommits/forked/tmp_snapshot.jpg" should not exist
+  #     And there should be exactly 1 jpg in "~/.lolcommits/forked"
 
   Scenario: Commiting in an enabled git repo triggers successful capture
     Given I am in a git repo named "myrepo" with lolcommits enabled
@@ -119,10 +120,10 @@ Feature: Basic UI functionality
     When I run `lolcommits --config --test -p loltext` interactively
       And I wait for output to contain "enabled:"
       Then I type "false"
-    Then the output should contain "Successfully configured plugin: loltext"
+      Then the output should contain "Disabling plugin: loltext - answer with 'true' to enable & configure"
     And a file named "~/.lolcommits/test/config.yml" should exist
     When I successfully run `lolcommits --test --show-config`
-    Then the output should match /loltext:\s+enabled: false/
+    Then the output should match /loltext:\s+:enabled: false/
 
   Scenario: test capture should work regardless of whether in a lolrepo
     Given I am in a directory named "nothingtoseehere"

data/features/step_definitions/lolcommits_steps.rb

@@ -160,7 +160,8 @@ Then(/^there should be exactly (.*?) (jpg|gif|pid)s? in "(.*?)"$/) do |n, type,
 end
 
 Then(/^the output should contain a list of plugins$/) do
-  step %(the output should contain "Available plugins: ")
+  step %(the output should contain "Installed plugins: (* enabled)")
+  step %(the output should contain "[*] loltext")
 end
 
 When(/^I do a git commit with commit message "(.*?)"$/) do |commit_msg|

data/features/support/path_helpers.rb

@@ -30,9 +30,7 @@ module PathHelpers
   def preseve_cmds_in_path(cmds, tmpbindir)
     cmds.each do |cmd|
       whichcmd = Lolcommits::Platform.command_which(cmd)
-      unless whichcmd.nil?
-        FileUtils.ln_s whichcmd, File.join(tmpbindir, File.basename(whichcmd))
-      end
+      FileUtils.ln_s whichcmd, File.join(tmpbindir, File.basename(whichcmd)) unless whichcmd.nil?
     end
   end
 end

data/lib/core_ext/hash/hash_dig.rb

@@ -0,0 +1,21 @@
+# Backport Hash#dig to Ruby < 2.3
+# inspired by https://github.com/Invoca/ruby_dig
+
+module HashDig
+  def dig(key, *rest)
+    value = self[key]
+    if value.nil? || rest.empty?
+      value
+    elsif value.respond_to?(:dig)
+      value.dig(*rest)
+    else
+      raise TypeError, "#{value.class} does not have #dig method"
+    end
+  end
+end
+
+if RUBY_VERSION < '2.3'
+  class Hash
+    include HashDig
+  end
+end

data/lib/lolcommits.rb

@@ -1,5 +1,7 @@
 $LOAD_PATH.unshift File.expand_path('.')
 
+require 'core_ext/hash/hash_dig' # backport Hash#dig for Ruby < 2.3
+
 require 'mini_magick'
 require 'core_ext/mini_magick/utilities'
 require 'fileutils'

data/lib/lolcommits/backends/git_info.rb

@@ -42,18 +42,12 @@ module Lolcommits
     end
 
     def url
-      @url ||= begin
-        if repository.remote && repository.remote.url
-          remote_https_url(repository.remote.url)
-        end
-      end
+      @url ||= remote_repo? ? remote_https_url(repository.remote.url) : nil
     end
 
     def repo
       @repo ||= begin
-        if repository.remote && repository.remote.url
-          match = repository.remote.url.match(GIT_URL_REGEX)
-        end
+        match = repository.remote.url.match(GIT_URL_REGEX) if remote_repo?
 
         if match
           match[1]
@@ -88,5 +82,9 @@ module Lolcommits
     def last_commit
       @commit ||= repository.log.first
     end
+
+    def remote_repo?
+      repository.remote && repository.remote.url
+    end
   end
 end

data/lib/lolcommits/configuration.rb

@@ -11,11 +11,13 @@ module Lolcommits
       @loldir         = Configuration.loldir_for('test') if test_mode
     end
 
-    def read_configuration
-      return unless File.exist?(configuration_file)
-      # TODO: change to safe_load when Ruby 2.0.0 support drops
-      # YAML.safe_load(File.open(configuration_file), [Symbol])
-      YAML.load(File.open(configuration_file))
+    def yaml
+      @_yaml ||= begin
+        return Hash.new({}) unless File.exist?(configuration_file)
+        # TODO: change to safe_load when Ruby 2.0.0 support drops
+        # YAML.safe_load(File.open(configuration_file), [Symbol])
+        YAML.load(File.open(configuration_file)) || Hash.new({})
+      end
     end
 
     def configuration_file
@@ -65,19 +67,23 @@ module Lolcommits
     end
 
     def list_plugins
-      puts "Available plugins: \n * #{plugin_manager.plugin_names.join("\n * ")}"
+      puts "Installed plugins: (* enabled)\n"
+
+      plugin_manager.plugins.each do |gem_plugin|
+        plugin = gem_plugin.plugin_klass.new(config: yaml[gem_plugin.name])
+        puts " [#{plugin.enabled? ? '*' : '-'}] #{gem_plugin.name}"
+      end
     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?
+    def find_plugin(name)
+      plugin_name = name.empty? ? ask_for_plugin_name : name
+      plugin = plugin_manager.find_by_name(plugin_name)
 
-      plugin_klass = plugin_manager.find_by_name(plugin_name)
-      return plugin_klass.new(config: self) if plugin_klass
+      return plugin if plugin
 
       puts "Unable to find plugin: '#{plugin_name}'"
-      return if plugin_name_option.empty?
-      list_plugins
+      list_plugins unless name.empty?
+      nil
     end
 
     def ask_for_plugin_name
@@ -88,33 +94,47 @@ module Lolcommits
 
     def do_configure!(plugin_name)
       $stdout.sync = true
-
       plugin = find_plugin(plugin_name.to_s.strip)
       return unless plugin
-      config = read_configuration || {}
-      plugin_name   = plugin.class.name
-      plugin_config = plugin.configure_options!
-      # having a plugin_config, means configuring went OK
-      if plugin_config
-        # save plugin and print config
-        config[plugin_name] = plugin_config
-        save(config)
-        puts self
-        puts "\nSuccessfully configured plugin: #{plugin_name} at path '#{configuration_file}'"
-      else
-        puts "\nAborted plugin configuration for: #{plugin_name}"
+
+      puts "Configuring plugin: #{plugin.name}\n"
+      plugin_config = plugin.plugin_klass.new(config: yaml[plugin_name]).configure_options! || {}
+
+      unless plugin_config[:enabled]
+        puts "Disabling plugin: #{plugin.name} - answer with 'true' to enable & configure"
+      end
+    rescue Interrupt
+      # e.g. user Ctrl+c or aborted by plugin configure_options!
+      puts "\n"
+      if plugin
+        puts "Configuration aborted: #{plugin.name} has been disabled"
+        plugin_config ||= {}
+        plugin_config[:enabled] = false
+      end
+    ensure
+      if plugin
+        # clean away legacy enabled key, later we can remove this
+        plugin_config.delete('enabled')
+        # save plugin config (if we have anything in the hash)
+        save(plugin.name, plugin_config) unless plugin_config.empty?
+
+        # print config if plugin was enabled
+        if plugin_config[:enabled]
+          puts "\nSuccessfully configured plugin: #{plugin.name} - at path '#{configuration_file}'"
+          puts plugin_config.to_yaml.to_s
+        end
       end
     end
 
-    def save(config)
-      config_file_contents = config.to_yaml
+    def save(plugin_name, plugin_config)
+      config_file_contents = yaml.merge(plugin_name => plugin_config).to_yaml
       File.open(configuration_file, 'w') do |f|
         f.write(config_file_contents)
       end
     end
 
     def to_s
-      read_configuration.to_yaml.to_s
+      yaml.to_yaml.to_s
     end
 
     # class methods

data/lib/lolcommits/gem_plugin.rb

@@ -44,6 +44,10 @@ module Lolcommits
       warn "failed to load constant from plugin gem '#{plugin_klass_name}: #{e}'"
     end
 
+    def plugin_instance(runner)
+      plugin_klass.new(runner: runner, config: runner.config.yaml[name])
+    end
+
     def gem_name
       gem_spec.name
     end
@@ -55,7 +59,12 @@ module Lolcommits
     end
 
     def plugin_klass_name
-      gem_path.split('/').map(&:capitalize).join('::')
+      # convert gem paths to plugin classes e.g.
+      # lolcommits/loltext --> Lolcommits::Plugin::Loltext
+      # lolcommits/term_output --> Lolcommits::Plugin::TermOutput
+      gem_path.split('/').insert(1, 'plugin').collect do |c|
+        c.split('_').collect(&:capitalize).join
+      end.join('::')
     end
   end
 end

data/lib/lolcommits/plugin/base.rb

@@ -1,30 +1,16 @@
+require 'lolcommits/plugin/configuration_helper'
+
 module Lolcommits
   module Plugin
     class Base
-      attr_accessor :runner, :config, :options
+      include Lolcommits::Plugin::ConfigurationHelper
 
-      def initialize(runner: nil, config: nil)
-        self.runner = runner
-        self.config = config || runner.config
-        self.options = ['enabled']
-      end
-
-      def execute_pre_capture
-        return unless configured_and_enabled?
-        debug 'I am enabled, about to run pre capture'
-        run_pre_capture
-      end
+      attr_accessor :runner, :configuration, :options
 
-      def execute_post_capture
-        return unless configured_and_enabled?
-        debug 'I am enabled, about to run post capture'
-        run_post_capture
-      end
-
-      def execute_capture_ready
-        return unless configured_and_enabled?
-        debug 'I am enabled, about to run capture ready'
-        run_capture_ready
+      def initialize(runner: nil, config: {})
+        self.runner = runner
+        self.configuration = config || {}
+        self.options = [:enabled]
       end
 
       def run_pre_capture; end
@@ -33,57 +19,60 @@ module Lolcommits
 
       def run_capture_ready; end
 
-      def configuration
-        saved_config = config.read_configuration
-        return {} unless saved_config
-        saved_config[self.class.name] || {}
-      end
-
-      # ask for plugin options
+      ##
+      # Prompts the user to configure all plugin options.
+      #
+      # Available options can be defined in an Array (@options instance var)
+      # and/or a Hash (by overriding the `default_options` method).
+      #
+      # By default (on initialize), `@options` is set with `[:enabled]`. This is
+      # mandatory since `enabled?` checks this option is true before running any
+      # capture hooks.
+      #
+      # Using a Hash to define default options allows you to:
+      #
+      #  - including default values
+      #  - define nested options, user is prompted for each nested option key
+      #
+      # `configure_option_hash` will iterate over all options prompting the user
+      # for input and building the configuration Hash.
+      #
+      # Lolcommits will save this Hash to a YAML file. During the capture
+      # process the configuration is loaded, parsed and available in the plugin
+      # class as `@configuration`. Or if you want to fall back to default
+      # values, you should use `config_option` to fetch option values.
+      #
+      # Alternatively you can override this method entirely to customise the
+      # process. A helpful `parse_user_input` method is available to help parse
+      # strings from STDIN (into boolean, integer or nil values).
+      #
+      # @return [Hash] the configured plugin options
       def configure_options!
-        puts "Configuring plugin: #{self.class.name}\n"
-        options.reduce({}) do |acc, option|
-          print "#{option}: "
-          val = parse_user_input(gets.strip)
-          # check enabled option isn't a String
-          if (option == 'enabled') && ![true, false].include?(val)
-            puts "Aborting - please respond with 'true' or 'false'"
-            exit 1
-          else
-            acc.merge(option => val)
-          end
-        end
+        configure_option_hash(
+          Hash[options.map { |key, _value| [key, nil] }].merge(default_options)
+        )
       end
 
-      def parse_user_input(str)
-        # cater for bools, strings, ints and blanks
-        if 'true'.casecmp(str).zero?
-          true
-        elsif 'false'.casecmp(str).zero?
-          false
-        elsif str =~ /^[0-9]+$/
-          str.to_i
-        elsif str.strip.empty?
-          nil
-        else
-          str
-        end
+      def default_options
+        {}
       end
 
-      def configured_and_enabled?
-        valid_configuration? && enabled?
+      def config_option(*keys)
+        configuration.dig(*keys) || default_options.dig(*keys)
       end
 
       def enabled?
-        configuration['enabled'] == true
+        # legacy configs (< 0.9.9) used a string key
+        configuration[:enabled] || configuration['enabled']
       end
 
       # check config is valid
       def valid_configuration?
-        configured?
+        !configuration.empty?
       end
 
       # empty plugin configuration
+      # TODO: remove this method in after 0.9.9 release
       def configured?
         !configuration.empty?
       end
@@ -92,12 +81,12 @@ module Lolcommits
       # dont puts or print if the runner wants to be silent (stealth mode)
       def puts(*args)
         return if runner && runner.capture_stealth
-        super(args)
+        super(*args)
       end
 
-      def print(args)
+      def print(*args)
         return if runner && runner.capture_stealth
-        super(args)
+        super(*args)
       end
 
       # helper to log errors with a message via debug
@@ -111,11 +100,6 @@ module Lolcommits
         super("#{self.class}: " + msg)
       end
 
-      # identifying plugin name (for config, listing)
-      def self.name
-        'plugin'
-      end
-
       # Returns position(s) of when a plugin should run during the capture
       # process.
       #
@@ -130,6 +114,29 @@ module Lolcommits
       def self.runner_order
         []
       end
+
+      private
+
+      def configure_option_hash(option_hash, spacing_count = 0)
+        option_hash.keys.reduce({}) do |acc, option|
+          option_value = option_hash[option]
+          prefix       = '  ' * spacing_count
+          if option_value.is_a?(Hash)
+            puts "#{prefix}#{option}:\n"
+            acc.merge(option => configure_option_hash(option_value, (spacing_count + 1)))
+          else
+            print "#{prefix}#{option.to_s.tr('_', ' ')}#{" (#{option_value})" unless option_value.nil?}: "
+            user_value = parse_user_input(gets.chomp.strip)
+
+            # if not enabled, disable and return without setting more options
+            # useful with nested hash configs, place enabled as first sub-option
+            # if answer is !true, no further sub-options will be prompted for
+            return { option => false } if option == :enabled && user_value != true
+
+            acc.merge(option => user_value)
+          end
+        end
+      end
     end
   end
 end

data/lib/lolcommits/plugin/configuration_helper.rb

@@ -0,0 +1,51 @@
+module Lolcommits
+  module Plugin
+    module ConfigurationHelper
+      # handle for bools, strings, ints and blanks from user input
+      def parse_user_input(str)
+        if 'true'.casecmp(str).zero?
+          true
+        elsif 'false'.casecmp(str).zero?
+          false
+        elsif str =~ /^[0-9]+$/
+          str.to_i
+        elsif str.strip.empty?
+          nil
+        else
+          str
+        end
+      end
+
+      # user input with autocomplete (via tab) through array of named values
+      #
+      # e.g.
+      # prompt_autocomplete_hash("Organization: ", orgs)
+      #
+      # where orgs are an array of hashes like so (with string keys):
+      # [
+      #   { 'name' => 'some human readable name', 'value' => 1234 },
+      # ]
+      # User will be asked for Organization, can tab to autocomplete, and chosen
+      # value is returned.
+      def prompt_autocomplete_hash(prompt, items, name: 'name', value: 'value', suggest_words: 5)
+        words = items.map { |item| item[name] }.sort
+        puts "e.g. #{words.take(suggest_words).join(', ')}" if suggest_words > 0
+        completed_input = gets_autocomplete(prompt, words)
+        items.find { |item| item[name] == completed_input }[value]
+      end
+
+      private
+
+      def gets_autocomplete(prompt, words)
+        completion_handler = proc { |s| words.grep(/^#{Regexp.escape(s)}/) }
+        Readline.completion_append_character = ''
+        Readline.completion_proc = completion_handler
+
+        while (line = Readline.readline(prompt, true).strip)
+          return line if words.include?(line)
+          puts "'#{line}' not found"
+        end
+      end
+    end
+  end
+end

data/lib/lolcommits/plugin_manager.rb

@@ -8,6 +8,8 @@ module Lolcommits
       pm
     end
 
+    attr_reader :plugins
+
     def initialize
       @plugins = []
     end
@@ -19,29 +21,22 @@ module Lolcommits
     end
 
     def plugins_for(position)
-      plugin_klasses.select { |p| Array(p.runner_order).include?(position) }
+      @plugins.select do |plugin|
+        Array(plugin.plugin_klass.runner_order).include?(position)
+      end
     end
 
-    # @return [Lolcommits::Plugin] find first plugin matching name
+    # @return [Lolcommits::Plugin] finds the first plugin matching name
     def find_by_name(name)
-      plugin_klasses.find { |plugin| plugin.name =~ /^#{name}/ }
+      @plugins.find { |plugin| plugin.name =~ /^#{name}/ } unless name.empty?
     end
 
     def plugin_names
-      # TODO: when all plugins are gems, get names from GemPlugin with
-      #   @plugins.map(&:name)
-      plugin_klasses.map(&:name).sort
+      @plugins.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

data/lib/lolcommits/runner.rb

@@ -24,14 +24,27 @@ module Lolcommits
       self.message  = vcs_info.message if message.nil?
     end
 
+    def execute_plugins_for(hook)
+      plugin_manager.plugins_for(hook).each do |gem_plugin|
+        plugin_name = gem_plugin.name
+        plugin      = gem_plugin.plugin_instance(self)
+        next unless plugin.enabled?
+
+        if plugin.valid_configuration?
+          debug "Runner: #{plugin_name} is enabled with valid config, running #{hook}"
+          plugin.send("run_#{hook}")
+        else
+          puts "Warning: skipping plugin #{plugin_name} (invalid configuration, try: lolcommits --config -p #{plugin_name})"
+        end
+      end
+    end
+
     # wrap run to handle things that should happen before and after
     # this used to be handled with ActiveSupport::Callbacks, but
     # now we're just using a simple procedural list
     def run
       # do plugins that need to happen before capture
-      plugin_manager.plugins_for(:pre_capture).each do |plugin|
-        plugin.new(runner: self).execute_pre_capture
-      end
+      execute_plugins_for(:pre_capture)
 
       # do main capture to snapshot_loc
       run_capture
@@ -42,14 +55,10 @@ module Lolcommits
         resize_snapshot!
 
         # execute post_capture plugins, use to alter the capture
-        plugin_manager.plugins_for(:post_capture).each do |plugin|
-          plugin.new(runner: self).execute_post_capture
-        end
+        execute_plugins_for(:post_capture)
 
         # execute capture_ready plugins, capture is ready for export/sharing
-        plugin_manager.plugins_for(:capture_ready).each do |plugin|
-          plugin.new(runner: self).execute_capture_ready
-        end
+        execute_plugins_for(:capture_ready)
 
         # clean away any tmp files
         cleanup!

data/lib/lolcommits/version.rb

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

data/lolcommits.gemspec

@@ -64,13 +64,12 @@ POSTINSTALL
   s.add_runtime_dependency('git', '~> 1.3.0')
 
   # included plugins
-  s.add_runtime_dependency('lolcommits-loltext', '~> 0.0.4')
+  s.add_runtime_dependency('lolcommits-loltext', '~> 0.0.5')
 
   # development & test gems
   s.add_development_dependency('rdoc')
   s.add_development_dependency('pry')
   s.add_development_dependency('rubocop')
-  s.add_development_dependency('travis')
   s.add_development_dependency('minitest')
   s.add_development_dependency('coveralls')
   s.add_development_dependency('ffaker')

data/test/lolcommits_test.rb

@@ -23,10 +23,10 @@ class LolTest < MiniTest::Test
     commandcam_perms = File.lstat(File.join(Configuration::LOLCOMMITS_ROOT, 'vendor', 'ext', 'CommandCam', 'CommandCam.exe')).mode & 0o777
 
     assert imagesnap_perms == 0o755 || imagesnap_perms == 0o775,
-           "expected perms of 755/775 but instead got #{format '%o', imagesnap_perms}"
+           "expected perms of 755/775 but instead got #{format '%<perms>o', perms: imagesnap_perms}"
     assert videosnap_perms == 0o755 || videosnap_perms == 0o775,
-           "expected perms of 755/775 but instead got #{format '%o', videosnap_perms}"
+           "expected perms of 755/775 but instead got #{format '%<perms>o', perms: videosnap_perms}"
     assert commandcam_perms == 0o755 || commandcam_perms == 0o775,
-           "expected perms of 755/775 but instead got #{format '%o', commandcam_perms}"
+           "expected perms of 755/775 but instead got #{format '%<perms>o', perms: commandcam_perms}"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lolcommits
 version: !ruby/object:Gem::Version
-  version: 0.9.8
+  version: 0.10.0.pre1
 platform: ruby
 authors:
 - Matthew Rothenberg
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-05 00:00:00.000000000 Z
+date: 2018-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aruba
@@ -171,14 +171,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 0.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 0.0.5
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -221,20 +221,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: travis
-  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
@@ -309,10 +295,10 @@ files:
 - config/cucumber.yml
 - features/bugs.feature
 - features/lolcommits.feature
-- features/plugins.feature
 - features/step_definitions/lolcommits_steps.rb
 - features/support/env.rb
 - features/support/path_helpers.rb
+- lib/core_ext/hash/hash_dig.rb
 - lib/core_ext/mercurial-ruby/command.rb
 - lib/core_ext/mercurial-ruby/shell.rb
 - lib/core_ext/mini_magick/utilities.rb
@@ -340,6 +326,7 @@ files:
 - lib/lolcommits/installation.rb
 - lib/lolcommits/platform.rb
 - lib/lolcommits/plugin/base.rb
+- lib/lolcommits/plugin/configuration_helper.rb
 - lib/lolcommits/plugin/lol_yammer.rb
 - lib/lolcommits/plugin_manager.rb
 - lib/lolcommits/runner.rb
@@ -388,9 +375,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements:
 - imagemagick
 - a webcam
@@ -399,4 +386,11 @@ rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Capture webcam image on git commit for lulz.
-test_files: []
+test_files:
+- features/bugs.feature
+- features/lolcommits.feature
+- features/step_definitions/lolcommits_steps.rb
+- features/support/env.rb
+- features/support/path_helpers.rb
+- test/images/test_image.jpg
+- test/lolcommits_test.rb

data/features/plugins.feature

@@ -1,20 +0,0 @@
-Feature: Plugins Work
-
-  Background:
-    Given a mocked home directory
-
-  @slow_process @unstable
-  Scenario: Lolcommits.com integration works
-    Given I am in a git repo named "dot_com" with lolcommits enabled
-    When I run `lolcommits --config` interactively
-      And I wait for output to contain "Name of plugin to configure:"
-      Then I type "dot_com"
-      And I wait for output to contain "enabled:"
-      Then I type "true"
-      And I wait for output to contain "api_key:"
-      Then I type "b2a70ac0b64e012fa61522000a8c42dc"
-      And I wait for output to contain "api_secret:"
-      Then I type "b2a70ac0b64e012fa61522000a8c42dc"
-      And I wait for output to contain "repo_id:"
-      Then I type "b2a70ac0b64e012fa61522000a8c42dc"
-    Then the output should contain "Successfully configured plugin: dot_com"