lolcommits 0.9.2 → 0.9.3.pre1

data/CONTRIBUTING.md

@@ -22,7 +22,7 @@ ensure Ruby style guidelines. If you want to run tests before conforming to this
 to verify functionality, just run `rake test` and `rake features` manually.
 
 With a passing test suite, commit your changes, push and submit a new [Pull
-Request](https://github.com/mroth/lolcomits/compare/):
+Request](https://github.com/mroth/lolcommits/compare/):
 
     git commit -am 'Added some feature'
     git push origin my-new-feature
@@ -34,7 +34,7 @@ request gets accepted:
 
 * Explain what your are doing (and why) in your Pull Request description.
 * If you are fixing an
-  [issue](https://github.com/mroth/lolcomits/issues), link to
+  [issue](https://github.com/mroth/lolcommits/issues), link to
   it in your description and [mention
   it](https://help.github.com/articles/closing-issues-via-commit-messages/) in
   the commit message.

data/README.md

@@ -40,7 +40,7 @@ makes this easy.
 
 	brew install imagemagick
 
-Then install the gem with:
+Then install with:
 
 	[sudo] gem install lolcommits
 
@@ -51,7 +51,7 @@ If [Boxen](https://boxen.github.com) is your thing, [try
 this](https://github.com/AssuredLabor/puppet-lolcommits).
 
 Lolcommits v0.8.1 was the last release to support Ruby < 2.0. If you'd like to
-use this gem on older rubies try:
+use this program on 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
@@ -68,7 +68,7 @@ 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)
 
-Then install the gem with:
+Then install with:
 
     gem install lolcommits
 
@@ -209,3 +209,10 @@ issue](https://github.com/mroth/lolcommits/issues) (and please take a little
 time to check if we haven't [already
 addressed](https://github.com/mroth/lolcommits/issues?q=is%3Aissue+is%3Aclosed)
 it).
+
+
+## License
+
+The program is available as open source under the terms of
+[LGPL-3](https://opensource.org/licenses/LGPL-3.0).
+

data/bin/lolcommits

@@ -1,5 +1,4 @@
 #!/usr/bin/env ruby
-# -*- encoding: utf-8 -*-
 
 begin
   require 'lolcommits'
@@ -37,6 +36,9 @@ class App
         debug 'Outputting at DEBUG verbosity'
       end
 
+      # TODO: move to a better place
+      load_plugins
+
       if options[:'show-config']
         puts configuration
       elsif options[:plugins]
@@ -123,6 +125,12 @@ class App
     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
@@ -196,16 +204,6 @@ class App
     capture_animate > 0
   end
 
-  # TODO: remove this after implementing gem based plugins
-  # https://github.com/mroth/lolcommits/issues/99
-  # Until then for local plugin dev, use $LOLCOMMITS_DIR/.plugins directory
-  def self.load_local_plugins!
-    plugins_dir = Configuration.loldir_for('.plugins')
-    Dir.glob("#{plugins_dir}/*.rb").each do |plugin|
-      load plugin
-    end
-  end
-
   #
   # change working dir to either a repo or the fs root
   #
@@ -223,10 +221,5 @@ class App
     end
   end
 
-  #
-  # load plugins
-  #
-  load_local_plugins!
-
   go!
 end

data/features/step_definitions/lolcommits_steps.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 require 'fileutils'
 require 'aruba/api'
 

data/features/support/env.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 require 'aruba/cucumber'
 require 'methadone/cucumber'
 require 'open3'

data/features/support/path_helpers.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 require 'fileutils'
 require 'aruba/api'
 require 'lolcommits/platform'

data/lib/core_ext/mini_magick/utilities.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 # To maintain MiniMagick compatibility on Windows for v3.8.1 we need this patch
 # If/when we upgrade MiniMagick to 4.2+ this patch can be removed
 # We are locked at v3.8.1 since MiniMagick 4+ dropped support for Ruby 1.8.7

data/lib/lolcommits.rb

@@ -1,7 +1,5 @@
-# -*- encoding : utf-8 -*-
 $LOAD_PATH.unshift File.expand_path('.')
 
-require 'core_ext/class'
 require 'mini_magick'
 require 'core_ext/mini_magick/utilities'
 require 'fileutils'
@@ -17,8 +15,9 @@ require 'lolcommits/configuration'
 require 'lolcommits/capturer'
 require 'lolcommits/vcs_info'
 require 'lolcommits/installation'
-require 'lolcommits/plugin'
 require 'lolcommits/platform'
+require 'lolcommits/gem_plugin'
+require 'lolcommits/plugin_manager'
 
 # after lolcommits/platform, so that we can do platform-conditional override
 require 'core_ext/mercurial-ruby/command'
@@ -29,19 +28,20 @@ require 'lolcommits/backends/installation_mercurial'
 require 'lolcommits/backends/git_info'
 require 'lolcommits/backends/mercurial_info'
 
-require 'lolcommits/plugins/loltext'
-require 'lolcommits/plugins/dot_com'
-require 'lolcommits/plugins/tranzlate'
-require 'lolcommits/plugins/lol_twitter'
-require 'lolcommits/plugins/uploldz'
-require 'lolcommits/plugins/term_output'
-require 'lolcommits/plugins/lolsrv'
-require 'lolcommits/plugins/lol_yammer'
-require 'lolcommits/plugins/lol_protonet'
-require 'lolcommits/plugins/lol_tumblr'
-require 'lolcommits/plugins/lol_slack'
-require 'lolcommits/plugins/lol_flowdock'
-require 'lolcommits/plugins/lol_hipchat'
+require 'lolcommits/plugin/base'
+require 'lolcommits/plugin/loltext'
+require 'lolcommits/plugin/dot_com'
+require 'lolcommits/plugin/tranzlate'
+require 'lolcommits/plugin/lol_twitter'
+require 'lolcommits/plugin/uploldz'
+require 'lolcommits/plugin/term_output'
+require 'lolcommits/plugin/lolsrv'
+require 'lolcommits/plugin/lol_yammer'
+require 'lolcommits/plugin/lol_protonet'
+require 'lolcommits/plugin/lol_tumblr'
+require 'lolcommits/plugin/lol_slack'
+require 'lolcommits/plugin/lol_flowdock'
+require 'lolcommits/plugin/lol_hipchat'
 
 # require runner after all the plugins have been required
 require 'lolcommits/runner'

data/lib/lolcommits/backends/git_info.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 module Lolcommits
   class GitInfo < VCSInfo
     attr_accessor :sha, :message, :repo_internal_path, :repo, :url,

data/lib/lolcommits/backends/installation_git.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 module Lolcommits
   #
   # Methods to handle enabling and disabling of lolcommits

data/lib/lolcommits/backends/installation_mercurial.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 module Lolcommits
   #
   # Methods to handle enabling and disabling of lolcommits

data/lib/lolcommits/backends/mercurial_info.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 module Lolcommits
   class MercurialInfo < VCSInfo
     attr_accessor :sha, :message, :repo_internal_path, :repo, :url,

data/lib/lolcommits/capturer.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 module Lolcommits
   class Capturer
     attr_accessor :capture_device, :capture_delay, :snapshot_location,

data/lib/lolcommits/capturer/capture_cygwin.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 module Lolcommits
   class CaptureCygwin < Capturer
     def capture

data/lib/lolcommits/capturer/capture_fake.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 module Lolcommits
   class CaptureFake < Capturer
     def capture

data/lib/lolcommits/capturer/capture_linux.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 module Lolcommits
   class CaptureLinux < Capturer
     MPLAYER_FPS = 25

data/lib/lolcommits/capturer/capture_linux_animated.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 module Lolcommits
   class CaptureLinuxAnimated < Capturer
     def capture

data/lib/lolcommits/capturer/capture_mac.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 module Lolcommits
   class CaptureMac < Capturer
     def capture_device_string

data/lib/lolcommits/capturer/capture_mac_animated.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 module Lolcommits
   class CaptureMacAnimated < Capturer
     def capture

data/lib/lolcommits/capturer/capture_windows.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 module Lolcommits
   class CaptureWindows < Capturer
     def capture

data/lib/lolcommits/cli/fatals.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 require 'lolcommits/platform'
 require 'methadone'
 
@@ -28,13 +27,6 @@ module Lolcommits
           end
         end
 
-        # make sure we can find the default font
-        unless File.readable? Lolcommits::Loltext::DEFAULT_FONT_PATH
-          fatal "Couldn't properly read Impact font from gem package, "\
-                'please file a bug?!'
-          exit 1
-        end
-
         # make sure imagemagick is around and good to go
         unless Platform.valid_imagemagick_installed?
           fatal 'FATAL: ImageMagick does not appear to be properly installed!'\

data/lib/lolcommits/cli/launcher.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 require 'launchy'
 
 module Lolcommits

data/lib/lolcommits/cli/process_runner.rb

@@ -1,5 +1,3 @@
-# -*- encoding: utf-8 -*-
-
 module Lolcommits
   module CLI
     # Helper class for forking lolcommits process to the background (or not).

data/lib/lolcommits/cli/timelapse_gif.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 require 'lolcommits/cli/fatals'
 
 require 'mini_magick'

data/lib/lolcommits/configuration.rb

@@ -1,5 +1,3 @@
-# -*- encoding : utf-8 -*-
-
 module Lolcommits
   class Configuration
     LOLCOMMITS_BASE = ENV['LOLCOMMITS_DIR'] || File.join(ENV['HOME'], '.lolcommits')
@@ -14,6 +12,8 @@ module Lolcommits
 
     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))
     end
 
@@ -68,31 +68,34 @@ module Lolcommits
     end
 
     def plugins_list
-      "Available plugins: \n * #{Lolcommits::Runner.plugins.map(&:name).join("\n * ")}"
+      "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: '
-      STDIN.gets.strip
+      gets.strip
     end
 
-    def find_plugin(plugin_name)
+    def find_plugin(plugin_name_option)
+      plugin_name = plugin_name_option.empty? ? ask_for_plugin_name : plugin_name_option
+
       Lolcommits::Runner.plugins.each do |plugin|
         return plugin.new(nil) if plugin.name == plugin_name
       end
 
       puts "Unable to find plugin: '#{plugin_name}'"
+      return if plugin_name_option.empty?
       puts plugins_list
     end
 
     def do_configure!(plugin_name)
       $stdout.sync = true
-      plugin_name = ask_for_plugin_name if plugin_name.to_s.strip.empty?
 
-      plugin = find_plugin(plugin_name)
+      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

data/lib/lolcommits/gem_plugin.rb

@@ -0,0 +1,46 @@
+module Lolcommits
+  class GemPlugin
+    attr_accessor :name, :gem_name, :spec, :required
+
+    def initialize(name, gem_name, spec)
+      @name     = name
+      @gem_name = gem_name
+      @spec     = spec
+      @required = false
+    end
+
+    # activate the plugin (require the gem - enables/loads the plugin
+    # immediately at point of call if not already required)
+    def activate!
+      begin
+        require gem_path unless required?
+      rescue LoadError => e
+        warn "Found plugin #{gem_name}, but could not require '#{gem_name}'"
+        warn e
+      rescue => e
+        warn "require '#{gem_name}' # Failed, saying: #{e}"
+      end
+
+      self.required = true
+    end
+
+    alias required? required
+
+    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|
+        if dependency.name == Lolcommits::GEM_NAME
+          return dependency.requirement.satisfied_by?(lolcommits_version)
+        end
+      end
+      true
+    end
+
+    private
+
+    def gem_path
+      gem_name.gsub(/-|_/, '/')
+    end
+  end
+end

data/lib/lolcommits/installation.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 module Lolcommits
   #
   # Methods to handle enabling and disabling of lolcommits

data/lib/lolcommits/platform.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 require 'mini_magick'
 require 'rbconfig'
 

data/lib/lolcommits/plugin/base.rb

@@ -0,0 +1,110 @@
+module Lolcommits
+  module Plugin
+    class Base
+      attr_accessor :runner, :options
+
+      def initialize(runner)
+        self.runner = runner
+        self.options = ['enabled']
+      end
+
+      def execute_precapture
+        return unless valid_configuration?
+        return unless enabled?
+        debug 'I am enabled, about to run precapture'
+        run_precapture
+      end
+
+      def execute_postcapture
+        return unless valid_configuration?
+        return unless enabled?
+        debug 'I am enabled, about to run postcapture'
+        run_postcapture
+      end
+
+      def run_precapture; end
+
+      def run_postcapture; end
+
+      def configuration
+        config = runner.config.read_configuration if runner
+        return {} unless config
+        config[self.class.name] || {}
+      end
+
+      # ask for 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
+      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
+      end
+
+      def enabled?
+        configuration['enabled'] == true
+      end
+
+      # check config is valid
+      def valid_configuration?
+        configured?
+      end
+
+      # empty plugin configuration
+      def configured?
+        !configuration.empty?
+      end
+
+      # uniform puts for plugins
+      # dont puts if the runner wants to be silent (stealth mode)
+      def puts(*args)
+        return if runner && runner.capture_stealth
+        super(args)
+      end
+
+      # helper to log errors with a message via debug
+      def log_error(e, message)
+        debug message
+        debug e.backtrace.join("\n")
+      end
+
+      # uniform debug logging for plugins
+      def debug(msg)
+        super("#{self.class}: " + msg)
+      end
+
+      # identifying plugin name (for config, listing)
+      def self.name
+        'plugin'
+      end
+
+      # a plugin requests to be run by the runner in one of these positions
+      # valid options are [:precapture, :postcapture]
+      def self.runner_order
+        nil
+      end
+    end
+  end
+end