lolcommits 0.9.2 → 0.9.3.pre1

data/lib/lolcommits/plugin/term_output.rb

@@ -0,0 +1,55 @@
+require 'base64'
+
+module Lolcommits
+  module Plugin
+    class TermOutput < Base
+      def run_postcapture
+        if terminal_supported?
+          if !runner.vcs_info || runner.vcs_info.repo.empty?
+            debug 'repo is empty, skipping term output'
+          else
+            base64 = Base64.encode64(open(runner.main_image, &:read))
+            puts "#{begin_escape}1337;File=inline=1:#{base64};alt=#{runner.message};#{end_escape}\n"
+          end
+        else
+          debug 'Disabled, your terminal is not supported (requires iTerm2)'
+        end
+      end
+
+      def self.name
+        'term_output'
+      end
+
+      def self.runner_order
+        :postcapture
+      end
+
+      def configure_options!
+        if terminal_supported?
+          super
+        else
+          puts "Sorry, your terminal does not support the #{self.class.name} plugin (requires iTerm2)"
+        end
+      end
+
+      private
+
+      # escape sequences for tmux sessions differ
+      def begin_escape
+        tmux? ? "\033Ptmux;\033\033]" : "\033]"
+      end
+
+      def end_escape
+        tmux? ? "\a\033\\" : "\a"
+      end
+
+      def tmux?
+        !ENV['TMUX'].nil?
+      end
+
+      def terminal_supported?
+        ENV['TERM_PROGRAM'] =~ /iTerm/
+      end
+    end
+  end
+end

data/lib/lolcommits/{plugins → plugin}/tranzlate.rb

@@ -1,7 +1,4 @@
-# -*- encoding : utf-8 -*-
 # Adapted and expanded from https://github.com/rwtnorton/moar-lolspeak
-# which was largely taken from an old Perl script and is sadly is not
-# available via rubygems
 
 module Lolspeak
   LOL_DICTIONARY = {
@@ -94,21 +91,23 @@ module Lolspeak
 end
 
 module Lolcommits
-  class Tranzlate < Plugin
-    extend Lolspeak
+  module Plugin
+    class Tranzlate < Base
+      extend Lolspeak
 
-    def run_precapture
-      debug "Commit message before: #{runner.message}"
-      runner.message = self.class.tranzlate(runner.message)
-      debug "Commit message after: #{runner.message}"
-    end
+      def run_precapture
+        debug "Commit message before: #{runner.message}"
+        runner.message = self.class.tranzlate(runner.message)
+        debug "Commit message after: #{runner.message}"
+      end
 
-    def self.name
-      'tranzlate'
-    end
+      def self.name
+        'tranzlate'
+      end
 
-    def self.runner_order
-      :precapture
+      def self.runner_order
+        :precapture
+      end
     end
   end
 end

data/lib/lolcommits/plugin/uploldz.rb

@@ -0,0 +1,65 @@
+require 'rest_client'
+require 'base64'
+
+module Lolcommits
+  module Plugin
+    class Uploldz < Base
+      attr_accessor :endpoint
+
+      def initialize(runner)
+        super
+        options.concat(
+          %w(
+            endpoint
+            optional_key
+            optional_http_auth_username
+            optional_http_auth_password
+          )
+        )
+      end
+
+      def run_postcapture
+        if !runner.vcs_info || runner.vcs_info.repo.empty?
+          puts 'Repo is empty, skipping upload'
+        else
+          debug "Posting capture to #{configuration['endpoint']}"
+          RestClient.post(
+            configuration['endpoint'],
+            {
+              file: File.new(runner.main_image),
+              message: runner.message,
+              repo: runner.vcs_info.repo,
+              author_name: runner.vcs_info.author_name,
+              author_email: runner.vcs_info.author_email,
+              sha: runner.sha,
+              key: configuration['optional_key']
+            },
+            Authorization: authorization_header
+          )
+        end
+      rescue => e
+        log_error(e, "ERROR: RestClient POST FAILED #{e.class} - #{e.message}")
+      end
+
+      def configured?
+        !configuration['enabled'].nil? && configuration['endpoint']
+      end
+
+      def authorization_header
+        user     = configuration['optional_http_auth_username']
+        password = configuration['optional_http_auth_password']
+        return unless user || password
+
+        'Basic ' + Base64.encode64("#{user}:#{password}").chomp
+      end
+
+      def self.name
+        'uploldz'
+      end
+
+      def self.runner_order
+        :postcapture
+      end
+    end
+  end
+end

data/lib/lolcommits/plugin_manager.rb

@@ -0,0 +1,48 @@
+module Lolcommits
+  class PluginManager
+    GEM_NAME_PREFIX = /^lolcommits-plugin-/
+
+    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)
+
+        @plugins << plugin if plugin.supported? && !plugin_located?(plugin)
+      end
+      @plugins
+    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
+    end
+
+    # require all plugins
+    def load_plugins
+      @plugins.map(&:activate!)
+    end
+
+    private
+
+    def plugin_located?(plugin)
+      @plugins.any? { |existing| existing.gem_name == plugin.gem_name }
+    end
+
+    def gem_list
+      Gem.refresh
+      Gem::Specification.respond_to?(:each) ? Gem::Specification : Gem.source_index.find_name('')
+    end
+  end
+end

data/lib/lolcommits/runner.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 require 'lolcommits/platform'
 
 module Lolcommits
@@ -33,7 +32,6 @@ module Lolcommits
 
       # do native plugins that need to happen before capture
       plugins_for(:precapture).each do |plugin|
-        debug "Runner: precapture about to execute #{plugin}"
         plugin.new(self).execute_precapture
       end
 
@@ -51,11 +49,10 @@ module Lolcommits
         # do native plugins that need to happen immediately after capture and
         # resize this is effectively the "image processing" phase for now,
         # reserve just for us and handle manually...?
-        Lolcommits::Loltext.new(self).execute_postcapture
+        Lolcommits::Plugin::Loltext.new(self).execute_postcapture
 
         # do native plugins that need to happen after capture
         plugins_for(:postcapture).each do |plugin|
-          debug "Runner: postcapture about to execute #{plugin}"
           plugin.new(self).execute_postcapture
         end
 
@@ -69,12 +66,14 @@ 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.subclasses
+      Lolcommits::Plugin.constants.map(&Lolcommits::Plugin.method(:const_get)) - [Lolcommits::Plugin::Base]
     end
 
     # the main capture

data/lib/lolcommits/test_helpers/fake_io.rb

@@ -0,0 +1,20 @@
+module Lolcommits
+  module TestHelpers
+    module FakeIO
+      # stdout captured and returned
+      # stdin mapped to inputs an IO stream seperated with enter key presses
+      def fake_io_capture(inputs: [])
+        input_stream = "#{inputs.join("\r\n")}\r\n"
+        $stdin       = StringIO.new(input_stream)
+        $stdout      = StringIO.new
+
+        yield
+
+        $stdout.string
+      ensure
+        $stdin = STDIN
+        $stdout = STDOUT
+      end
+    end
+  end
+end

data/lib/lolcommits/test_helpers/git_repo.rb

@@ -0,0 +1,44 @@
+module Lolcommits
+  module TestHelpers
+    module GitRepo
+      def repo
+        @repo ||= Git.open(repo_path)
+      end
+
+      def repo_path
+        '~/.lolcommits/sample-plugin-test-repo'
+      end
+
+      def repo_exists?
+        File.directory?(File.expand_path(repo_path, '.git'))
+      end
+
+      def last_commit
+        repo.log.first
+      end
+
+      def setup_repo
+        return if repo_exists?
+        `git init --quiet #{repo_path}`
+      end
+
+      def commit_repo_with_message(message = 'test message', file_name: 'test.txt', file_content: 'testing')
+        setup_repo unless repo_exists?
+        `echo '#{file_content}' >> #{repo_path}/#{file_name}`
+        `cd #{repo_path} && git add #{file_name}`
+        `cd #{repo_path} && git commit -m "#{message}"`
+      end
+
+      def in_repo
+        return unless repo_exists?
+        Dir.chdir(File.expand_path(repo_path)) do
+          yield
+        end
+      end
+
+      def teardown_repo
+        `rm -rf #{repo_path}`
+      end
+    end
+  end
+end

data/lib/lolcommits/vcs_info.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 module Lolcommits
   # base class ala plugin.rb
   class VCSInfo

data/lib/lolcommits/version.rb

@@ -1,4 +1,4 @@
-# -*- encoding : utf-8 -*-
 module Lolcommits
-  VERSION = '0.9.2'.freeze
+  VERSION  = '0.9.3.pre1'.freeze
+  GEM_NAME = 'lolcommits'.freeze
 end

data/lolcommits.gemspec

@@ -1,11 +1,11 @@
-# -*- encoding: utf-8 -*-
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'lolcommits/version'
 
 Gem::Specification.new do |s|
-  s.name        = 'lolcommits'
+  s.name        = Lolcommits::GEM_NAME.dup
   s.version     = Lolcommits::VERSION.dup
+
   s.authors     = ['Matthew Rothenberg', 'Matthew Hutchinson']
   s.email       = ['mrothenberg@gmail.com', 'matt@hiddenloop.com']
   s.homepage    = 'http://mroth.github.com/lolcommits/'

data/test/lolcommits_test.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 require 'coveralls'
 Coveralls.wear!
 
@@ -19,7 +18,7 @@ class LolTest < MiniTest::Test
   # this will test the permissions but only locally, important before building a gem package!
   #
   def test_permissions
-    impact_perms     = File.lstat(Lolcommits::Loltext::DEFAULT_FONT_PATH).mode & 0o777
+    impact_perms     = File.lstat(Lolcommits::Plugin::Loltext::DEFAULT_FONT_PATH).mode & 0o777
     imagesnap_perms  = File.lstat(File.join(Configuration::LOLCOMMITS_ROOT, 'vendor', 'ext', 'imagesnap', 'imagesnap')).mode & 0o777
     videosnap_perms  = File.lstat(File.join(Configuration::LOLCOMMITS_ROOT, 'vendor', 'ext', 'videosnap', 'videosnap')).mode & 0o777
     commandcam_perms = File.lstat(File.join(Configuration::LOLCOMMITS_ROOT, 'vendor', 'ext', 'CommandCam', 'CommandCam.exe')).mode & 0o777

data/test/plugins_test.rb

@@ -1,4 +1,3 @@
-# -*- encoding : utf-8 -*-
 require 'coveralls'
 Coveralls.wear!
 
@@ -19,7 +18,7 @@ class PluginsTest < MiniTest::Test
   #
   def test_tranzlate
     [['what the hell', '(WH|W)UT TEH HELL'], ['seriously wtf', 'SRSLEH WTF']].each do |normal, lol|
-      tranzlated = Lolcommits::Tranzlate.tranzlate(normal)
+      tranzlated = Lolcommits::Plugin::Tranzlate.tranzlate(normal)
       assert_match(/^#{lol}/, tranzlated)
     end
   end
@@ -28,25 +27,25 @@ class PluginsTest < MiniTest::Test
   # issue #136, https://github.com/mroth/lolcommits/issues/136
   def test_lol_twitter_build_tweet
     long_commit_message = FFaker::Lorem.sentence(500)
-    plugin              = Lolcommits::LolTwitter.new(nil)
+    plugin              = Lolcommits::Plugin::LolTwitter.new(nil)
     max_tweet_size      = 116
     suffix              = '... #lolcommits'
 
-    Lolcommits::LolTwitter.send(:define_method, :max_tweet_size, proc { max_tweet_size })
-    Lolcommits::LolTwitter.send(:define_method, :configuration, proc { {} })
+    Lolcommits::Plugin::LolTwitter.send(:define_method, :max_tweet_size, proc { max_tweet_size })
+    Lolcommits::Plugin::LolTwitter.send(:define_method, :configuration, proc { {} })
     assert_equal "#{long_commit_message[0..(max_tweet_size - suffix.length)]}#{suffix}", plugin.build_tweet(long_commit_message)
   end
 
   def test_lol_twitter_prefix_suffix
-    plugin = Lolcommits::LolTwitter.new(nil)
-    Lolcommits::LolTwitter.send(:define_method, :max_tweet_size, proc { 116 })
+    plugin = Lolcommits::Plugin::LolTwitter.new(nil)
+    Lolcommits::Plugin::LolTwitter.send(:define_method, :max_tweet_size, proc { 116 })
     assert_match 'commit msg #lolcommits', plugin.build_tweet('commit msg')
 
     plugin_config = {
       'prefix' => '@prefixing!',
       'suffix' => '#suffixing!'
     }
-    Lolcommits::LolTwitter.send(:define_method, :configuration, proc { plugin_config })
+    Lolcommits::Plugin::LolTwitter.send(:define_method, :configuration, proc { plugin_config })
     assert_equal '@prefixing! commit msg #suffixing!', plugin.build_tweet('commit msg')
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lolcommits
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.3.pre1
 platform: ruby
 authors:
 - Matthew Rothenberg
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-04 00:00:00.000000000 Z
+date: 2017-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aruba
@@ -327,7 +327,6 @@ files:
 - features/step_definitions/lolcommits_steps.rb
 - features/support/env.rb
 - features/support/path_helpers.rb
-- lib/core_ext/class.rb
 - lib/core_ext/mercurial-ruby/command.rb
 - lib/core_ext/mercurial-ruby/shell.rb
 - lib/core_ext/mini_magick/utilities.rb
@@ -350,23 +349,27 @@ files:
 - lib/lolcommits/cli/process_runner.rb
 - lib/lolcommits/cli/timelapse_gif.rb
 - lib/lolcommits/configuration.rb
+- lib/lolcommits/gem_plugin.rb
 - lib/lolcommits/installation.rb
 - lib/lolcommits/platform.rb
-- lib/lolcommits/plugin.rb
-- lib/lolcommits/plugins/dot_com.rb
-- lib/lolcommits/plugins/lol_flowdock.rb
-- lib/lolcommits/plugins/lol_hipchat.rb
-- lib/lolcommits/plugins/lol_protonet.rb
-- lib/lolcommits/plugins/lol_slack.rb
-- lib/lolcommits/plugins/lol_tumblr.rb
-- lib/lolcommits/plugins/lol_twitter.rb
-- lib/lolcommits/plugins/lol_yammer.rb
-- lib/lolcommits/plugins/lolsrv.rb
-- lib/lolcommits/plugins/loltext.rb
-- lib/lolcommits/plugins/term_output.rb
-- lib/lolcommits/plugins/tranzlate.rb
-- lib/lolcommits/plugins/uploldz.rb
+- lib/lolcommits/plugin/base.rb
+- lib/lolcommits/plugin/dot_com.rb
+- lib/lolcommits/plugin/lol_flowdock.rb
+- lib/lolcommits/plugin/lol_hipchat.rb
+- lib/lolcommits/plugin/lol_protonet.rb
+- lib/lolcommits/plugin/lol_slack.rb
+- lib/lolcommits/plugin/lol_tumblr.rb
+- lib/lolcommits/plugin/lol_twitter.rb
+- lib/lolcommits/plugin/lol_yammer.rb
+- lib/lolcommits/plugin/lolsrv.rb
+- lib/lolcommits/plugin/loltext.rb
+- lib/lolcommits/plugin/term_output.rb
+- lib/lolcommits/plugin/tranzlate.rb
+- lib/lolcommits/plugin/uploldz.rb
+- lib/lolcommits/plugin_manager.rb
 - lib/lolcommits/runner.rb
+- lib/lolcommits/test_helpers/fake_io.rb
+- lib/lolcommits/test_helpers/git_repo.rb
 - lib/lolcommits/vcs_info.rb
 - lib/lolcommits/version.rb
 - lolcommits.gemspec
@@ -395,9 +398,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