lolcommits-sample_plugin 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7ffe2fc5bb37796e2caa83cdc405f1ab4808549f
-  data.tar.gz: c619b4df32c1e19f25d3bbce19a7b84fd0ee549c
+SHA256:
+  metadata.gz: 458f611a07c9da71c65f2158fa4d3c28882c9c9955666e08ae3ad3f80ca9eceb
+  data.tar.gz: 11ef71f56de73bc96d06f0e24fd0d20e2fe731c15ef23a6da495db50f15cfa9a
 SHA512:
-  metadata.gz: d453e58648d7b88bd2a8d7b842ae99779b05a90ddc80405f3181b0c9f5c9a267f50509bfc770dad363e56dbcca22de8bec2190d29462e90d665fb881de67bb34
-  data.tar.gz: 3bac9cf3fcd42827acac4ae7834b3f889d0cc21db2cbef0596a01de2e3c3bdd79c7d0ea5858f7aebaf606c72771b33d49e2566afb5b280149a4ce6132f1ad59f
+  metadata.gz: 3ede2aeb0f2b4d3ac198b0d0ed3d9ab39e9df9e4fd9a213df9fd0ea7900fcf43714a906fda0e83d66ab785fc918f9d8ea867ba941e895c22915460f27836cc9a
+  data.tar.gz: c5103c9f2e1272427d3e04a58c0fc74e2511d1703501063c62c5c43d850be66fb4b51e9970dd88519ca6d5b11e7575b00759708fecaa2f981c8e2e0bf086dc26

data/.travis.yml

@@ -4,13 +4,14 @@ 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
+ - 2.5.0
  - ruby-head
 
 before_install:
- - gem install bundler -v 1.13.7
+ - gem update --system
  - git --version
  - git config --global user.email "lol@commits.org"
  - git config --global user.name "Lolcommits"

data/lib/lolcommits/plugin/sample_plugin.rb

@@ -5,17 +5,21 @@ module Lolcommits
     class SamplePlugin < Base
 
       ##
-      # Returns the name of the plugin.
+      # Plugin initializer
+      #
+      # @param runner [Lolcommits::Runner] an instance of a lolcommits runner
+      # @param config [Hash] plugin config hash (parsed from saved config YAML)
       #
-      # Identifies the plugin to lolcommits. This should be uniq and
-      # descriptive.
+      # The default superclass method sets @runner and @configuration instance
+      # vars and @options to `[:enabled]`
       #
-      # @return [String] the plugin name
+      # Override this method to change the default configurable option names
       #
-      def self.name
-        'plugin-sample'
+      def initialize(runner: nil, config: nil)
+        super
       end
 
+      ##
       # Returns position(s) of when this plugin should run during the capture
       # process.
       #
@@ -31,24 +35,6 @@ module Lolcommits
         [: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.
@@ -59,20 +45,21 @@ module Lolcommits
       # Prints a short (emoji themed) message to STDOUT
       #
       def run_pre_capture
-        puts "✨  Say cheese 😁 !"
+        puts "✨  Say cheese 😁 !" if config_option(:ask_for_cheese)
       end
 
       ##
       #
       # Post-capture hook, run after lolcommits captures a snapshot.
       #
-      # Override this method to execute plugin code after the lolcommit
-      # snapshot is captured.
+      # 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 "
+        return unless config_option(:camera_emoji, :enabled)
+        puts "#{"📸  " * config_option(:camera_emoji, :emoji_multiplier).to_i}Snap!"
       end
 
       ##
@@ -87,19 +74,24 @@ module Lolcommits
       # sha.
       #
       def run_capture_ready
-        puts "✨  wow! #{self.runner.sha} is your best looking commit yet! 😘  💻"
+        if config_option(:always_a_great_commit?)
+          puts "✨  wow! #{self.runner.sha} is your best looking commit yet! 😘  💻"
+        end
       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
+      # The default superclass method returns true if the enabled option is true
+      # i.e. 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.
+      # Override this method to define your own custom enabled logic. If this
+      # method always returns true, the only way to disable the plugin will be
+      # to uninstall the gem.
+      #
+      # Note: a `valid_configuration?` method also exists and is checked before
+      # any plugin hooks execute. Use that to check individual config option
+      # values.
       #
       # @return [Boolean] true/false indicating if plugin is enabled
       #
@@ -108,56 +100,67 @@ module Lolcommits
       end
 
       ##
-      # Prompts the user to configure the plugin's 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).
       #
-      # The default superclass method will iterate over the @options array and
-      # build a configuration hash, prompting for user input on each option key.
+      # By default (on initialize), `@options` is set with `[:enabled]`. This is
+      # mandatory since `enabled?` checks this option is true before running any
+      # capture hooks.
       #
-      # 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.
+      # Using a Hash to define default options allows you to:
       #
-      # Override this method to define your own configuration flow. A helpful
-      # parse_user_input method is available to help parse strings from STDIN.
+      #  - fall back to default values
+      #  - define nested options, user is prompted for each nested option key
       #
-      # @return [Hash] a hash of configured plugin options
+      # `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 dig the hash.
+      #
+      # 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!
         super
       end
 
+      def default_options
+        {
+          ask_for_cheese: true,
+          always_a_great_commit?: true,
+          camera_emoji: {
+            enabled: false,
+            emoji_multiplier: 2
+          }
+        }
+      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.
+      # The default superclass method simply checks if `@configuration` is
+      # present (not empty).
       #
-      # Override this method to define your own configuration checks and
-      # messaging.
+      # By default if this method returns false, plugin hooks will not execute
+      # and a warning message is shown prompting the user to re-configure the
+      # plugin.
       #
-      # 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.
+      # Override to define your own configuration checks and/or messaging.
       #
       # @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

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

data/lolcommits-plugin-sample.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.0.0"
 
-  spec.add_development_dependency "lolcommits", ">= 0.9.8"
+  spec.add_development_dependency "lolcommits", ">= 0.10.0"
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest"

data/test/lolcommits/plugin/sample_plugin_test.rb

@@ -14,9 +14,7 @@ describe Lolcommits::Plugin::SamplePlugin do
   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: {})
-      )
+      @runner ||= Lolcommits::Runner.new
     end
 
     def plugin
@@ -24,22 +22,18 @@ describe Lolcommits::Plugin::SamplePlugin do
     end
 
     def valid_enabled_config
-      @config ||= OpenStruct.new(
-        read_configuration: {
-          plugin.class.name => { 'enabled' => true }
+      {
+        enabled: true,
+        ask_for_cheese: false,
+        always_a_great_commit?: true,
+        camera_emoji: {
+          enabled: true,
+          emoji_multiplier: 5
         }
-      )
-    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
@@ -68,33 +62,24 @@ describe Lolcommits::Plugin::SamplePlugin do
 
     describe '#enabled?' do
       it 'should be false by default' do
-        plugin.enabled?.must_equal false
+        assert_nil plugin.enabled?
       end
 
       it 'should true when configured' do
-        plugin.config = valid_enabled_config
+        plugin.configuration = 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
+        output = fake_io_capture(inputs: %w(true false true true 5)) 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
+        configured_plugin_options.must_equal(valid_enabled_config)
       end
 
       describe '#valid_configuration?' do
@@ -103,7 +88,7 @@ describe Lolcommits::Plugin::SamplePlugin do
         end
 
         it 'should be true for a valid configuration' do
-          plugin.config = valid_enabled_config
+          plugin.configuration = valid_enabled_config
           plugin.valid_configuration?.must_equal true
         end
       end

data/test/test_helper.rb

@@ -2,9 +2,7 @@ $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'
+require 'lolcommits'
 
 # lolcommit test helpers
 require 'lolcommits/test_helpers/git_repo'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lolcommits-sample_plugin
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Matthew Hutchinson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-23 00:00:00.000000000 Z
+date: 2018-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lolcommits
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.8
+        version: 0.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.8
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -140,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Example gem for lolcommits plugin development