lolcommits-term_output 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2379fcb9aa1d9303fffe4b571cf638ce5707b7b937f7d5b64be6c08f4a7b128a
-  data.tar.gz: 4d971d9e7ef33bc4a111f3c0b13794a71ad8fdb9590bed4c4719adacd811376b
+  metadata.gz: 3ae550e3afc8a28f05357eb39bc55721eee09ecac0712d39ea291d93105e6d44
+  data.tar.gz: ae046fb5b4e7fc06dd0473a24482ba7d9a0a3617e45c95977ea34dff5b1d55ee
 SHA512:
-  metadata.gz: 25a1254cf0c9bb81cc701c631596fe80e33de7254c8c9d1d5622edfc7a5ac71b86ee1eb57952d3f5ba0423043da038ba64e0bbf014661a0138381ad41b67070e
-  data.tar.gz: 1ba47cca44f55cca6ed659ff97d78b1a4d8645236d9a7aeba0b19e5d7530f63ae8b0accaa560f6443fb993519d62cb05b8a2aaac3bfc7ca9dd03c65a5d73ffb7
+  metadata.gz: 7ffe0d92834700718178a23131a6fe326ca3643ea3251fb199477571cb4fb6c8a68959b458e5048eab85e36aac410efbeb6fdebff17bfed05311356e8e975906
+  data.tar.gz: 12c7c95e7a8979975a4b12406a8f16c8a2b35fc7dc42d8f3ef16c902e7f9fc5ddf7a8a9b1ad69cf3fbea364dfcca8e744767b2faa87240888c6d6b271d47ab33

data/CHANGELOG.md

@@ -2,13 +2,23 @@
 
 All notable changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog][KeepAChangelog] and this project
-adheres to [Semantic Versioning][Semver].
+The format is based on [Keep a Changelog][KeepAChangelog] and this
+project adheres to [Semantic Versioning][Semver].
 
 ## [Unreleased]
 
 - Your contribution here!
 
+## [0.3.0] - 2019-05-20
+### Changed
+- lolcommits gem is a runtime dependency
+- Use `lolcommit_path` (instead of `main_image`)
+- Requires at least lolcommits >= `0.14.2`
+- Updated README and gemspec
+
+### Removed
+- Support for lolcommits < `0.14.2`
+
 ## [0.2.0] - 2019-04-24
 ### Removed
 - Support for Ruby < 2.3 (older rubies no longer supported)
@@ -50,7 +60,8 @@ adheres to [Semantic Versioning][Semver].
 ### Changed
 - Initial release
 
-[Unreleased]: https://github.com/lolcommits/lolcommits-term_output/compare/v0.2.0...HEAD
+[Unreleased]: https://github.com/lolcommits/lolcommits-term_output/compare/v0.3.0...HEAD
+[0.3.0]: https://github.com/lolcommits/lolcommits-term_output/compare/v0.2.0...v0.3.0
 [0.2.0]: https://github.com/lolcommits/lolcommits-term_output/compare/v0.1.1...v0.2.0
 [0.1.1]: https://github.com/lolcommits/lolcommits-term_output/compare/v0.1.0...v0.1.1
 [0.1.0]: https://github.com/lolcommits/lolcommits-term_output/compare/v0.0.6...v0.1.0

data/README.md

@@ -1,18 +1,19 @@
 # Lolcommits Term Output
 
 [![Gem](https://img.shields.io/gem/v/lolcommits-term_output.svg?style=flat)](http://rubygems.org/gems/lolcommits-term_output)
-[![Travis](https://travis-ci.org/lolcommits/lolcommits-term_output.svg?branch=master)](https://travis-ci.org/lolcommits/lolcommits-term_output)
+[![Travis](https://img.shields.io/travis/com/lolcommits/lolcommits-term_output/master.svg?style=flat)](https://travis-ci.com/lolcommits/lolcommits-term_output)
 [![Depfu](https://img.shields.io/depfu/lolcommits/lolcommits-term_output.svg?style=flat)](https://depfu.com/github/lolcommits/lolcommits-term_output)
 [![Maintainability](https://api.codeclimate.com/v1/badges/3f2a468adb10524add39/maintainability)](https://codeclimate.com/github/lolcommits/lolcommits-term_output/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/3f2a468adb10524add39/test_coverage)](https://codeclimate.com/github/lolcommits/lolcommits-term_output/test_coverage)
 
-[lolcommits](https://lolcommits.github.io/) takes a snapshot with your webcam
-every time you git commit code, and archives a lolcat style image with it. Git
-blame has never been so much fun!
+[lolcommits](https://lolcommits.github.io/) takes a snapshot with your
+webcam every time you git commit code, and archives a lolcat style image
+with it. Git blame has never been so much fun!
 
-This plugin uses the [inline image](http://iterm2.com/documentation-images.html)
-feature available in [iTerm2](http://iterm2.com/index.html) to display each
-lolcommit image in your terminal (after committing). For example:
+This plugin uses the [inline
+image](http://iterm2.com/documentation-images.html) feature available in
+[iTerm2](http://iterm2.com/index.html) to display each lolcommit (images
+only) in your terminal (after committing). For example:
 
 ![iterm inline sample screenshot](./assets/images/sample.png)
 
@@ -35,20 +36,20 @@ Then configure to enable and set the remote endpoint:
     $ lolcommits --config -p term_output
     # set enabled to `true`
 
-That's it! Your next lolcommit will be displayed within your terminal. To
-disable use:
+That's it! Your next lolcommit will be displayed within your terminal.
+To disable use:
 
     $ lolcommits --config -p term_output
     # and set enabled to `false`
 
 ## Development
 
-Check out this repo and run `bin/setup`, this will install all dependencies and
-generate docs. Use `bundle exec rake` to run all tests and generate a coverage
-report.
+Check out this repo and run `bin/setup`, this will install all
+dependencies and generate docs. Use `bundle exec rake` to run all tests
+and generate a coverage report.
 
-You can also run `bin/console` for an interactive prompt that will allow you to
-experiment with the gem code.
+You can also run `bin/console` for an interactive prompt that will allow
+you to experiment with the gem code.
 
 ## Tests
 
@@ -65,25 +66,29 @@ Generate docs for this gem with:
 ## Troubles?
 
 If you think something is broken or missing, please raise a new
-[issue](https://github.com/lolcommits/lolcommits-term_output/issues). Take
-a moment to check it hasn't been raised in the past (and possibly closed).
+[issue](https://github.com/lolcommits/lolcommits-term_output/issues).
+Take a moment to check it hasn't been raised in the past (and possibly
+closed).
 
 ## Contributing
 
-Bug [reports](https://github.com/lolcommits/lolcommits-term_output/issues) and [pull
-requests](https://github.com/lolcommits/lolcommits-term_output/pulls) are welcome on
-GitHub.
+Bug
+[reports](https://github.com/lolcommits/lolcommits-term_output/issues)
+and [pull
+requests](https://github.com/lolcommits/lolcommits-term_output/pulls)
+are welcome on GitHub.
 
-When submitting pull requests, remember to add tests covering any new behaviour,
-and ensure all tests are passing on [Travis
-CI](https://travis-ci.org/lolcommits/lolcommits-term_output). Read the
+When submitting pull requests, remember to add tests covering any new
+behaviour, and ensure all tests are passing on [Travis
+CI](https://travis-ci.com/lolcommits/lolcommits-term_output). Read the
 [contributing
 guidelines](https://github.com/lolcommits/lolcommits-term_output/blob/master/CONTRIBUTING.md)
 for more details.
 
-This project is intended to be a safe, welcoming space for collaboration, and
-contributors are expected to adhere to the [Contributor
-Covenant](http://contributor-covenant.org) code of conduct. See
+This project is intended to be a safe, welcoming space for
+collaboration, and contributors are expected to adhere to the
+[Contributor Covenant](http://contributor-covenant.org) code of conduct.
+See
 [here](https://github.com/lolcommits/lolcommits-term_output/blob/master/CODE_OF_CONDUCT.md)
 for more details.
 
@@ -94,7 +99,7 @@ The gem is available as open source under the terms of
 
 ## Links
 
-* [Travis CI](https://travis-ci.org/lolcommits/lolcommits-term_output)
+* [Travis CI](https://travis-ci.com/lolcommits/lolcommits-term_output)
 * [Code Climate](https://codeclimate.com/github/lolcommits/lolcommits-term_output)
 * [Test Coverage](https://codeclimate.com/github/lolcommits/lolcommits-term_output/coverage)
 * [RDoc](http://rdoc.info/projects/lolcommits/lolcommits-term_output)

data/lib/lolcommits/plugin/term_output.rb

@@ -23,9 +23,10 @@ module Lolcommits
       end
 
       ##
-      # Post-capture hook, runs after lolcommits captures a snapshot. If the
-      # terminal is supported (and we have commits) the lolcommit image is
-      # rendered inline to the terminal output (with the commit message).
+      # Post-capture hook, runs after lolcommits captures a snapshot. If
+      # the # terminal is supported (and we have commits) the lolcommit
+      # image is rendered inline to the terminal output (with the
+      # commit message).
       #
       # See here for more details: https://iterm2.com/documentation-images.html
       #
@@ -33,8 +34,11 @@ module Lolcommits
         if terminal_supported?
           if !runner.vcs_info || runner.vcs_info.repo.empty?
             debug 'repo is empty, skipping term output'
+          elsif !image_path
+            debug 'lolcommit videos not supported'
           else
-            base64 = Base64.encode64(open(runner.main_image, &:read).to_s)
+            debug "rendering image in iTerm"
+            base64 = Base64.encode64(open(image_path, &:read).to_s)
             puts "#{begin_escape}1337;File=inline=1:#{base64};alt=#{runner.message};#{end_escape}\n"
           end
         else
@@ -45,8 +49,22 @@ module Lolcommits
       private
 
       ##
-      # Generate starting escape character sequence. Terminals running Tmux
-      # sessions require a different escape code.
+      # The full path to the lolcommit image (gif or jpg), returns nil
+      # if runner only captured a video
+      #
+      # @return [String] file path
+      #
+      def image_path
+        @image_path ||= if runner.capture_video && !runner.capture_gif
+          nil
+        else
+          runner.capture_gif ? runner.lolcommit_gif_path : runner.lolcommit_path
+        end
+      end
+
+      ##
+      # Generate starting escape character sequence. Terminals running
+      # Tmux sessions require a different escape code.
       #
       # @return [String] escape char sequence for inline images
       #
@@ -55,8 +73,8 @@ module Lolcommits
       end
 
       ##
-      # Generate ending escape character sequence. Terminals running Tmux
-      # sessions require a different escape code.
+      # Generate ending escape character sequence. Terminals running
+      # Tmux sessions require a different escape code.
       #
       # @return [String] escape char sequence for inline images
       #
@@ -65,8 +83,8 @@ module Lolcommits
       end
 
       ##
-      # Determine if the terminal is running a Tmux session (checks for the TMUX
-      # env var to be set).
+      # Determine if the terminal is running a Tmux session (checks for
+      # the TMUX env var to be set).
       #
       # @return [Boolan] true when running within a Tmux session
       #

data/lib/lolcommits/term_output/version.rb

@@ -2,6 +2,6 @@
 
 module Lolcommits
   module TermOutput
-    VERSION = "0.2.0".freeze
+    VERSION = "0.3.0".freeze
   end
 end

data/lolcommits-term_output.gemspec

@@ -9,25 +9,17 @@ Gem::Specification.new do |spec|
   spec.email       = ["matt@hiddenloop.com"]
   spec.summary     = "Display lolcommits within your iTerm terminal"
   spec.homepage    = "https://github.com/lolcommits/lolcommits-term_output"
-  spec.license     = "LGPL-3"
+  spec.license     = "LGPL-3.0"
   spec.description = "Display lolcommits within your iTerm terminal"
 
   spec.metadata = {
-    "homepage_uri"    => "https://github.com/lolcommits/lolcommits-term_output",
-    "changelog_uri"   => "https://github.com/lolcommits/lolcommits-term_output/blob/master/CHANGELOG.md",
-    "source_code_uri" => "https://github.com/lolcommits/lolcommits-term_output",
-    "bug_tracker_uri" => "https://github.com/lolcommits/lolcommits-term_output/issues",
+    "homepage_uri"      => "https://github.com/lolcommits/lolcommits-term_output",
+    "changelog_uri"     => "https://github.com/lolcommits/lolcommits-term_output/blob/master/CHANGELOG.md",
+    "source_code_uri"   => "https://github.com/lolcommits/lolcommits-term_output",
+    "bug_tracker_uri"   => "https://github.com/lolcommits/lolcommits-term_output/issues",
+    "allowed_push_host" => "https://rubygems.org"
   }
 
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = "https://rubygems.org"
-  else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
-  end
-
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(assets|test|features)/}) }
   spec.test_files    = `git ls-files -- {test,features}/*`.split("\n")
   spec.bindir        = "bin"
@@ -36,7 +28,8 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.3"
 
-  spec.add_development_dependency "lolcommits", ">= 0.12.0"
+  spec.add_runtime_dependency "lolcommits", ">= 0.14.2"
+
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rake"

data/test/lolcommits/plugin/term_output_test.rb

@@ -24,7 +24,7 @@ describe Lolcommits::Plugin::TermOutput do
     def runner
       # a simple lolcommits runner with an empty configuration Hash
       @runner ||= Lolcommits::Runner.new(
-        main_image: Tempfile.new('main_image.jpg')
+        lolcommit_path: Tempfile.new('lolcommit.jpg')
       )
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lolcommits-term_output
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Matthew Hutchinson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-24 00:00:00.000000000 Z
+date: 2019-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lolcommits
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.12.0
-  type: :development
+        version: 0.14.2
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.14.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -122,7 +122,7 @@ files:
 - test/test_helper.rb
 homepage: https://github.com/lolcommits/lolcommits-term_output
 licenses:
-- LGPL-3
+- LGPL-3.0
 metadata:
   homepage_uri: https://github.com/lolcommits/lolcommits-term_output
   changelog_uri: https://github.com/lolcommits/lolcommits-term_output/blob/master/CHANGELOG.md