lolcommits 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a283f0226d5232d1e4be28c672c14c840f93a8b3ce5a69da433ed96ce08f8164
-  data.tar.gz: 84d20b570725fe5616fe712c34c30292001763fead3bb39610a5d6b14396a139
+  metadata.gz: 5674698718c6e29b478a9c7e333b5a2983535f444b5aee83d0d5612a22d5ee73
+  data.tar.gz: 9de7e8e711ceaffd45d37d98c0a3878104505d174ff4f6cb1676ff077ec016f5
 SHA512:
-  metadata.gz: 6c067bb4881cf4443cc66d711d7c0b273425ff1f6b65b77bda2c78beefb0d7305185fcaab3396477af74b785343c62fb1ee2e4d247697f0d1ddf0ea3ab46dc10
-  data.tar.gz: aef9ad689994047883837153e4ae3719d542608ab91366b64cb6980a68bad6023ec806b9148b9dfe82c0d751617c00367e19f45e2c9d83a855a194ea4bbb68b3
+  metadata.gz: 716f490a4943d472f9fbcff961572ce97c981552a9f115b8f96c8a53717190eb53aa25755eb70133fd3566c31966c69868f638388ec01863872eafe5e3c9e8a8
+  data.tar.gz: 5634f2dc4c8a6ae5c465a3eedaa08a5968468dea9d95cf59706386e3c1a1e196ab3fc6d585e1eb7fb9f74ba3082651dafa4c955fbbd669e2263c3493800452ea

data/.travis.yml

@@ -2,21 +2,21 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
- - 2.1.10
- - 2.2.9
- - 2.3.6
- - 2.4.3
- - 2.5.0
- - ruby-head
+  - 2.1.10
+  - 2.2.9
+  - 2.3.6
+  - 2.4.3
+  - 2.5.0
+  - ruby-head
 
 before_install:
- # stub mplayer/ffmpeg so it looks like they are installed
- - mkdir -p ~/bin
- - touch ~/bin/mplayer ~/bin/ffmpeg
- - chmod +x ~/bin/mplayer ~/bin/ffmpeg
- - export PATH=~/bin:$PATH
- - gem update --system
- - git --version
+  # stub mplayer/ffmpeg so it looks like they are installed
+  - mkdir -p ~/bin
+  - touch ~/bin/mplayer ~/bin/ffmpeg
+  - chmod +x ~/bin/mplayer ~/bin/ffmpeg
+  - export PATH=~/bin:$PATH
+  - gem update --system
+  - git --version
 
 matrix:
   allow_failures:
@@ -35,3 +35,13 @@ deploy:
     tags: true
     all_branches: true
     repo: mroth/lolcommits
+
+env:
+  global:
+    - CC_TEST_REPORTER_ID=b8f6cc45b054ac68b7fddf7bb99379efb3dbc6fb728506d9975c63064d971071
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+after_script:
+  - ./cc-test-reporter after-build

data/CHANGELOG.md

@@ -7,6 +7,10 @@ project adheres to [Semantic Versioning][Semver].
 
   * Your contribution here!
 
+## [0.12.0][] (15 March 2018)
+  * Use CodeClimate and simplecov for coverage reports (@matthutchinson [#367][])
+  * Remove plugin runner order (@matthutchinson [#369][])
+
 ## [0.11.0][] (4 February 2018)
   * Require at least Ruby 2.1 (@matthutchinson [#366][])
     - drop support for Ruby 2.0
@@ -316,8 +320,9 @@ 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.11.0...HEAD
-[0.10.0]: https://github.com/mroth/lolcommits/compare/v0.10.0...v0.11.0
+[Unreleased]: https://github.com/mroth/lolcommits/compare/v0.12.0...HEAD
+[0.12.0]: https://github.com/mroth/lolcommits/compare/v0.11.0...v0.12.0
+[0.11.0]: https://github.com/mroth/lolcommits/compare/v0.10.0...v0.11.0
 [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
@@ -503,3 +508,5 @@ project adheres to [Semantic Versioning][Semver].
 [#363]: https://github.com/mroth/lolcommits/pull/363
 [#365]: https://github.com/mroth/lolcommits/pull/365
 [#366]: https://github.com/mroth/lolcommits/pull/366
+[#367]: https://github.com/mroth/lolcommits/pull/367
+[#369]: https://github.com/mroth/lolcommits/pull/369

data/README.md

@@ -10,9 +10,8 @@ By default, the lol images are stored by a Github style short SHA in a
 [![Gem Version](https://badge.fury.io/rb/lolcommits.svg)](https://rubygems.org/gems/lolcommits)
 [![Build Status](https://travis-ci.org/mroth/lolcommits.svg?branch=master)](https://travis-ci.org/mroth/lolcommits)
 [![Dependency Status](https://gemnasium.com/mroth/lolcommits.svg)](https://gemnasium.com/mroth/lolcommits)
-[![CodeClimate Status](https://d3s6mut3hikguw.cloudfront.net/github/mroth/lolcommits/badges/gpa.svg)](https://codeclimate.com/github/mroth/lolcommits)
-[![Coverage Status](https://coveralls.io/repos/mroth/lolcommits/badge.svg?branch=master&service=github)](https://coveralls.io/r/mroth/lolcommits)
-
+[![Maintainability](https://img.shields.io/codeclimate/maintainability/mroth/lolcommits.svg)](https://codeclimate.com/github/mroth/lolcommits/maintainability)
+[![Test Coverage](https://img.shields.io/codeclimate/c/mroth/lolcommits.svg)](https://codeclimate.com/github/mroth/lolcommits/test_coverage)
 
 ## Sample images
 

data/Rakefile

@@ -48,7 +48,6 @@ end
 
 require 'rubocop/rake_task'
 RuboCop::RakeTask.new
-task default: [:rubocop, :test, :features]
 
 desc 'Migrate an existing local .lolcommits directory to Dropbox'
 task :dropboxify do
@@ -71,3 +70,14 @@ task :dropboxify do
   # copy over existing files
   FileUtils.cp_r("#{backup_loldir}/.", loldir)
 end
+
+# run tests with code coverage
+namespace :test do
+  desc 'Run all unit tests and generate a coverage report'
+  task :coverage do
+    ENV['COVERAGE'] = 'true'
+    Rake::Task[:test].execute
+  end
+end
+
+task default: [:rubocop, 'test:coverage', :features]

data/lib/lolcommits/backends/git_info.rb

@@ -80,7 +80,7 @@ module Lolcommits
     end
 
     def last_commit
-      @commit ||= repository.log.first
+      @last_commit ||= repository.log.first
     end
 
     def remote_repo?

data/lib/lolcommits/backends/mercurial_info.rb

@@ -75,7 +75,7 @@ module Lolcommits
     end
 
     def last_commit
-      @commit ||= repository.commits.parent
+      @last_commit ||= repository.commits.parent
     end
   end
 end

data/lib/lolcommits/capturer/capture_windows_animated.rb

@@ -40,7 +40,7 @@ module Lolcommits
 
     # inspired by this code from @rdp http://tinyurl.com/y7t276bh
     def device_names
-      @_device_names ||= begin
+      @device_names ||= begin
         names      = []
         cmd_output = ''
         count      = 0

data/lib/lolcommits/configuration.rb

@@ -12,7 +12,7 @@ module Lolcommits
     end
 
     def yaml
-      @_yaml ||= begin
+      @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])

data/lib/lolcommits/gem_plugin.rb

@@ -34,10 +34,6 @@ module Lolcommits
       true
     end
 
-    def name
-      gem_name.split('-', 2).last
-    end
-
     def plugin_klass
       self.class.const_get(plugin_klass_name)
     rescue StandardError => e
@@ -45,6 +41,7 @@ module Lolcommits
     end
 
     def plugin_instance(runner)
+      # TODO: pass name to initializer as arg when all gems updated to accept
       plugin_klass.new(runner: runner, config: runner.config.yaml[name])
     end
 
@@ -52,6 +49,10 @@ module Lolcommits
       gem_spec.name
     end
 
+    def name
+      gem_name.split('-', 2).last
+    end
+
     private
 
     def gem_path

data/lib/lolcommits/platform.rb

@@ -65,8 +65,8 @@ module Lolcommits
       # cli_version check will throw a MiniMagick::Error exception if IM is not
       # installed in PATH, since it attempts to parse output from `identify`
       !MiniMagick.cli_version.nil?
-    rescue StandardError
-      return false
+    rescue MiniMagick::Error
+      false
     end
 
     # Is a valid install of ffmpeg present on the system?

data/lib/lolcommits/plugin/base.rb

@@ -5,10 +5,11 @@ module Lolcommits
     class Base
       include Lolcommits::Plugin::ConfigurationHelper
 
-      attr_accessor :runner, :configuration, :options
+      attr_accessor :runner, :configuration, :options, :name
 
-      def initialize(runner: nil, config: {})
+      def initialize(runner: nil, name: nil, config: {})
         self.runner = runner
+        self.name = name || self.class.to_s
         self.configuration = config || {}
         self.options = [:enabled]
       end
@@ -89,9 +90,9 @@ module Lolcommits
       end
 
       # helper to log errors with a message via debug
-      def log_error(e, message)
+      def log_error(error, message)
         debug message
-        debug e.backtrace.join("\n")
+        debug error.backtrace.join("\n")
       end
 
       # uniform debug logging for plugins
@@ -99,21 +100,6 @@ module Lolcommits
         super("#{self.class}: " + msg)
       end
 
-      # 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.
-      # Three hook positions exist, your plugin code can execute in one or more
-      # of these.
-      #
-      # @return [Array] the position(s) (:pre_capture, :post_capture,
-      # :capture_ready)
-      #
-      def self.runner_order
-        []
-      end
-
       private
 
       def configure_option_hash(option_hash, spacing_count = 0)

data/lib/lolcommits/plugin_manager.rb

@@ -20,12 +20,6 @@ module Lolcommits
       @plugins.map(&:activate!)
     end
 
-    def plugins_for(position)
-      @plugins.select do |plugin|
-        Array(plugin.plugin_klass.runner_order).include?(position)
-      end
-    end
-
     # @return [Lolcommits::Plugin] finds the first plugin matching name
     def find_by_name(name)
       @plugins.find { |plugin| plugin.name =~ /^#{name}/ } unless name.empty?
@@ -35,6 +29,13 @@ module Lolcommits
       @plugins.map(&:name).sort
     end
 
+    def enabled_plugins_for(runner)
+      @plugins.map do |gem_plugin|
+        plugin = gem_plugin.plugin_instance(runner)
+        plugin.enabled? ? plugin : nil
+      end.compact
+    end
+
     private
 
     # @return [Array] find all installed and supported plugins, populate

data/lib/lolcommits/runner.rb

@@ -20,21 +20,17 @@ module Lolcommits
         raise('Unknown VCS')
       end
 
-      self.sha      = vcs_info.sha if sha.nil?
-      self.message  = vcs_info.message if message.nil?
+      self.sha     = vcs_info.sha if sha.nil?
+      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?
-
+      debug "#{self.class}: running all enabled plugin hooks for #{hook}"
+      enabled_plugins.each do |plugin|
         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})"
+          puts "Warning: skipping plugin #{plugin.name} (invalid configuration, fix with: lolcommits --config -p #{plugin.name})"
         end
       end
     end
@@ -91,8 +87,8 @@ module Lolcommits
 
     private
 
-    def plugin_manager
-      @plugin_manager ||= config.plugin_manager
+    def enabled_plugins
+      @enabled_plugins ||= config.plugin_manager.enabled_plugins_for(self)
     end
 
     def image_file_type

data/lib/lolcommits/version.rb

@@ -1,4 +1,4 @@
 module Lolcommits
-  VERSION  = '0.11.0'.freeze
+  VERSION  = '0.12.0'.freeze
   GEM_NAME = 'lolcommits'.freeze
 end

data/lolcommits.gemspec

@@ -1,4 +1,4 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'lolcommits/version'
 
@@ -66,6 +66,6 @@ POSTINSTALL
   s.add_development_dependency('pry')
   s.add_development_dependency('rubocop')
   s.add_development_dependency('minitest')
-  s.add_development_dependency('coveralls')
+  s.add_development_dependency('simplecov')
   s.add_development_dependency('ffaker')
 end

data/test/permissions_test.rb

@@ -0,0 +1,20 @@
+require File.expand_path(File.dirname(__FILE__) + '/test_helper')
+
+class PermissionsTest < Minitest::Test
+  #
+  # issue #53, https://github.com/mroth/lolcommits/issues/53
+  # this will test the permissions but only locally, important before building a gem package!
+  #
+  def test_permissions
+    imagesnap_perms  = File.lstat(File.join(Lolcommits::Configuration::LOLCOMMITS_ROOT, 'vendor', 'ext', 'imagesnap', 'imagesnap')).mode & 0o777
+    videosnap_perms  = File.lstat(File.join(Lolcommits::Configuration::LOLCOMMITS_ROOT, 'vendor', 'ext', 'videosnap', 'videosnap')).mode & 0o777
+    commandcam_perms = File.lstat(File.join(Lolcommits::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 '%<perms>o', perms: imagesnap_perms}"
+    assert videosnap_perms == 0o755 || videosnap_perms == 0o775,
+           "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 '%<perms>o', perms: commandcam_perms}"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+if ENV['COVERAGE']
+  require 'simplecov'
+  SimpleCov.start
+  SimpleCov.at_exit do
+    SimpleCov.result.format!
+    `open ./coverage/index.html` if RUBY_PLATFORM =~ /darwin/
+  end
+end
+
+require 'lolcommits'
+require 'minitest/autorun'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lolcommits
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Matthew Rothenberg
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-04 00:00:00.000000000 Z
+date: 2018-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: methadone
@@ -194,7 +194,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -294,7 +294,8 @@ files:
 - lib/lolcommits/version.rb
 - lolcommits.gemspec
 - test/images/test_image.jpg
-- test/lolcommits_test.rb
+- test/permissions_test.rb
+- test/test_helper.rb
 - vendor/ext/CommandCam/COPYING
 - vendor/ext/CommandCam/CommandCam.exe
 - vendor/ext/CommandCam/LICENSE
@@ -351,4 +352,5 @@ test_files:
 - features/support/env.rb
 - features/support/path_helpers.rb
 - test/images/test_image.jpg
-- test/lolcommits_test.rb
+- test/permissions_test.rb
+- test/test_helper.rb

data/test/lolcommits_test.rb

@@ -1,32 +0,0 @@
-require 'coveralls'
-Coveralls.wear!
-
-require 'minitest/autorun'
-
-# Loads lolcommits directly from the lib folder so don't have to create
-# a gem before testing
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'lolcommits'
-
-include Lolcommits
-include Methadone::CLILogging
-
-class LolTest < MiniTest::Test
-  #
-  # issue #53, https://github.com/mroth/lolcommits/issues/53
-  # this will test the permissions but only locally, important before building a gem package!
-  #
-  def test_permissions
-    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
-
-    assert imagesnap_perms == 0o755 || imagesnap_perms == 0o775,
-           "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 '%<perms>o', perms: videosnap_perms}"
-    assert commandcam_perms == 0o755 || commandcam_perms == 0o775,
-           "expected perms of 755/775 but instead got #{format '%<perms>o', perms: commandcam_perms}"
-  end
-end