lolcommits 0.17.2 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '088cc7f1206089c7bd38c2fcddfb70b66564cf7ad9aec31d431515107ab8443f'
-  data.tar.gz: fa276c54847eef35ad780762328f15748509bb741b04c5d96b6ebd2b2bea4e1c
+  metadata.gz: 3d68fc910621c20affe1a01a975da0c2b4165dec81689a69c347aab0121fc510
+  data.tar.gz: e32e2f3a25b64abac860446672eae4ec5a1b1c6af1fb14933d6f2965ab692e22
 SHA512:
-  metadata.gz: f5e2796f8a1493519602e6027f39e6b6aa644a1dece4e5141de16a6a2d1bd81c677ba2079a4ccf335da0d60b37fa7a79e040cc6887f0c3bde46ce38df9fab7b4
-  data.tar.gz: a17dcd832fcb303dac024e6d5b4a18782c3d58e073a9ae064c69785d2fd428c2b87756d865bcfd2d38fe0d69e2ad32aba62eb23026c0d13ec430c39461a26d23
+  metadata.gz: c35563bc2fa8ba6762f8e2c42fd41164968b1b121e0729be258834a009ca687199feb708c65044bc7ccb8a6b0d982086a1b948e7fb6099562573331b4246bf55
+  data.tar.gz: 374d4265eca8f0a3af139cdfde448e820c52379ce4600a1b9dc4c3be859916c224582153f8f6731400a3c2b01bf8517738356522d3a0e2083d74e045c66c46a5

data/.rubocop.yml

@@ -1,20 +1,320 @@
+require:
+  - rubocop-performance
+
 AllCops:
-  SuggestExtensions: false
   NewCops: enable
   Exclude:
-    - 'vendor/bundle/**/*'
-    - 'vendor/bundle/**/.*'
-    - '.bundle/**/*'
-    - 'bin/lolcommits'
-    - 'lolcommits.gemspec'
+    - 'vendor/**/*'
+    - 'tmp/**/*'
+  TargetRubyVersion: 3.1
+  SuggestExtensions: false
+
+Naming/InclusiveLanguage:
+  Enabled: true
+  CheckStrings: true
+  FlaggedTerms:
+    ' a offense':
+      Suggestions:
+        - an offense
+    auto-correct:
+      Suggestions:
+        - autocorrect
+    auto_correct:
+      Suggestions:
+        - autocorrect
+    behaviour:
+      Suggestions:
+        - behavior
+    offence:
+      Suggestions:
+        - offense
+
+Naming/PredicateName:
+  # Method define macros for dynamically generated method.
+  MethodDefinitionMacros:
+    - define_method
+    - define_singleton_method
+    - def_node_matcher
+    - def_node_search
+
+Layout/HashAlignment:
+  EnforcedHashRocketStyle:
+    - key
+    - table
+  EnforcedColonStyle:
+    - key
+    - table
+
+Layout/EndOfLine:
+  EnforcedStyle: lf
+
+Layout/ClassStructure:
+  Enabled: true
+  Categories:
+    module_inclusion:
+      - include
+      - prepend
+      - extend
+  ExpectedOrder:
+    - module_inclusion
+    - constants
+    - public_class_methods
+    - initializer
+    - instance_methods
+    - protected_methods
+    - private_methods
+
+Layout/RedundantLineBreak:
+  Enabled: true
+
+Lint/UselessAccessModifier:
+  MethodCreatingMethods:
+    - 'def_matcher'
+    - 'def_node_matcher'
 
-Style/IfUnlessModifier:
+Metrics/BlockLength:
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - '*.gemspec'
+
+Performance/DeletePrefix:
+  SafeMultiline: false
+
+Performance/DeleteSuffix:
+  SafeMultiline: false
+
+inherit_mode:
+  merge:
+    - Exclude
+
+# All cops except your using extensions are disabled by default.
+Bundler:
+  Enabled: false
+Layout:
+  Enabled: false
+Lint:
+  Enabled: false
+Metrics:
+  Enabled: false
+Naming:
+  Enabled: false
+Performance:
+  Enabled: false
+  Exclude:
+    - "test/**/*"
+Security:
+  Enabled: false
+Style:
   Enabled: false
 
-Style/StringLiterals:
+# Align `when` with `end`.
+Layout/CaseIndentation:
+  Enabled: true
+  EnforcedStyle: end
+
+# Align comments with method definitions.
+Layout/CommentIndentation:
+  Enabled: true
+
+Layout/ElseAlignment:
+  Enabled: true
+
+Layout/EmptyLineAfterMagicComment:
+  Enabled: true
+
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: true
+
+# In a regular class definition, no empty lines around the body.
+Layout/EmptyLinesAroundClassBody:
+  Enabled: true
+
+# In a regular method definition, no empty lines around the body.
+Layout/EmptyLinesAroundMethodBody:
+  Enabled: true
+
+# In a regular module definition, no empty lines around the body.
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: true
+
+# Align `end` with the matching keyword or starting expression except for
+# assignments, where it should be aligned with the LHS.
+Layout/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: variable
+
+# Method definitions after `private` or `protected` isolated calls need one
+# extra level of indentation.
+#
+# We break this rule in context, though, e.g. for private-only concerns,
+# so we leave it disabled.
+Layout/IndentationConsistency:
   Enabled: false
+  EnforcedStyle: indented_internal_methods
+
+# Detect hard tabs, no hard tabs.
+Layout/IndentationStyle:
+  Enabled: true
+
+# Two spaces, no tabs (for indentation).
+#
+# Doesn't behave properly with private-only concerns, so it's disabled.
+Layout/IndentationWidth:
+  Enabled: false
+
+Layout/LeadingCommentSpace:
+  Enabled: true
 
+Layout/SpaceAfterColon:
+  Enabled: true
+
+Layout/SpaceAfterComma:
+  Enabled: true
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+
+Layout/SpaceAroundKeyword:
+  Enabled: true
+
+# Use `foo {}` not `foo{}`.
+Layout/SpaceBeforeBlockBraces:
+  Enabled: true
+
+Layout/SpaceBeforeComma:
+  Enabled: true
+
+Layout/SpaceBeforeFirstArg:
+  Enabled: true
+
+# Use `->(x, y) { x + y }` not `-> (x, y) { x + y }`
+Layout/SpaceInLambdaLiteral:
+  Enabled: true
+
+# Use `[ a, [ b, c ] ]` not `[a, [b, c]]`
+# Use `[]` not `[ ]`
+Layout/SpaceInsideArrayLiteralBrackets:
+  Enabled: true
+  EnforcedStyle: space
+  EnforcedStyleForEmptyBrackets: no_space
+
+# Use `%w[ a b ]` not `%w[ a   b ]`.
+Layout/SpaceInsideArrayPercentLiteral:
+  Enabled: true
+
+# Use `foo { bar }` not `foo {bar}`.
+# Use `foo { }` not `foo {}`.
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+  EnforcedStyleForEmptyBraces: space
+
+# Use `{ a: 1 }` not `{a:1}`.
+# Use `{}` not `{  }`.
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+  EnforcedStyle: space
+  EnforcedStyleForEmptyBraces: no_space
+
+# Use `foo(bar)` not `foo( bar )`
+Layout/SpaceInsideParens:
+  Enabled: true
+
+# Requiring a space is not yet supported as of 0.59.2
+# Use `%w[ foo ]` not `%w[foo]`
 Layout/SpaceInsidePercentLiteralDelimiters:
   Enabled: false
+  #EnforcedStyle: space
+
+# Use `hash[:key]` not `hash[ :key ]`
+Layout/SpaceInsideReferenceBrackets:
+  Enabled: true
+
+# Blank lines should not have any spaces.
+Layout/TrailingEmptyLines:
+  Enabled: true
+
+# No trailing whitespace.
+Layout/TrailingWhitespace:
+  Enabled: true
+
+Lint/RedundantStringCoercion:
+  Enabled: true
+
+# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+Lint/RequireParentheses:
+  Enabled: true
+
+Lint/UriEscapeUnescape:
+  Enabled: true
+
+Performance/FlatMap:
+  Enabled: true
+
+# We generally prefer &&/|| but like low-precedence and/or in context
+Style/AndOr:
+  Enabled: false
+
+# Prefer Foo.method over Foo::method
+Style/ColonMethodCall:
+  Enabled: true
+
+Style/DefWithParentheses:
+  Enabled: true
+
+# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
+Style/HashSyntax:
+  Enabled: true
+  EnforcedShorthandSyntax: either
+
+# Defining a method with parameters needs parentheses.
+Style/MethodDefParentheses:
+  Enabled: true
+
+Style/ParenthesesAroundCondition:
+  Enabled: true
+
+Style/PercentLiteralDelimiters:
+  Enabled: true
+  PreferredDelimiters:
+    default: "()"
+    "%i": "[]"
+    "%I": "[]"
+    "%r": "{}"
+    "%w": "[]"
+    "%W": "[]"
+
+# Use quotes for string literals when they are enough.
+Style/RedundantPercentQ:
+  Enabled: false
+
+Style/RedundantReturn:
+  Enabled: true
+  AllowMultipleReturnValues: true
+
+Style/Semicolon:
+  Enabled: true
+  AllowAsExpressionSeparator: true
+
+Style/StabbyLambdaParentheses:
+  Enabled: true
+
+# Use `"foo"` not `'foo'` unless escaping is required
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+  Include:
+    - "app/**/*"
+    - "config/**/*"
+    - "lib/**/*"
+    - "test/**/*"
+    - "Gemfile"
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: true
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: true
 
-inherit_from: .rubocop_todo.yml
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec

data/README.md

@@ -1,28 +1,28 @@
 # lolcommits
 
-[![Build](https://img.shields.io/github/actions/workflow/status/lolcommits/lolcommits/build.yml?branch=main&style=flat)](https://github.com/lolcommits/lolcommits/actions/workflows/build.yml)
+[![CI](https://img.shields.io/github/actions/workflow/status/lolcommits/lolcommits/ci.yml?branch=main&style=flat&label=CI)](https://github.com/lolcommits/lolcommits/actions/workflows/ci.yml)
 [![Depfu](https://img.shields.io/depfu/lolcommits/lolcommits.svg?style=flat)](https://depfu.com/github/lolcommits/lolcommits)
 [![Gem](https://img.shields.io/gem/v/lolcommits.svg?style=flat)](http://rubygems.org/gems/lolcommits)
 
 > git-based selfies for software developers
 
-lolcommits 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 takes a snapshot with your webcam every time you git commit,
+archiving a "[LOLcat](https://en.wikipedia.org/wiki/Lolcat)" style image. Git
+blame has never been so much fun!
 
-By default, the lol images are stored by a Github style short SHA in a
-`~/.lolcommits` directory created for you.
+By default these lol images are stored with a short SHA filename in a
+`~/.lolcommits` directory created just for you.
 
 ## History
 
-Originally created by [@mroth] in 2011 as a joke project for [Hack &&
-Tell], lolcommits has grown considerably since then, and is now
-primarily maintained by [@matthutchinson].
+Originally created by [@mroth] in 2011 (as a joke project for [Hack && Tell]),
+lolcommits has grown considerably, has a plugin ecosystem and is now maintained
+by [@matthutchinson].
 
-Thank you to all of the [contributors] throughout the years!
+Thanks to all the [contributors] and users throughout the years!
 
-[@mroth]: https://github.com/mroth
 [@matthutchinson]: https://github.com/matthutchinson
+[@mroth]: https://github.com/mroth
 [Hack && Tell]: https://hackandtell.org
 [contributors]: https://github.com/lolcommits/lolcommits/graphs/contributors
 
@@ -32,7 +32,7 @@ Thank you to all of the [contributors] throughout the years!
 
 Please add your own lolcommit to the [People Using
 Lolcommits](https://github.com/lolcommits/lolcommits/wiki/Lolcommits-from-around-the-world%21)
-page on our wiki!
+page!
 
 
 ## Requirements
@@ -54,21 +54,11 @@ You'll need ImageMagick installed.
 
 Then install with:
 
-	[sudo] gem install lolcommits
-
-If you're using RVM (or rbenv), you can/should probably omit the sudo,
-but the default macOS Ruby install usually requires it.
-
-Lolcommits v0.8.1 was the last release to support Ruby < 2.0. If you'd
-like to use 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
-
+	gem install lolcommits
 
 ### Linux
 
-Install these dependencies using your package manager of choice, for
+Install dependencies using your package manager of choice, for
 example in Ubuntu:
 
     sudo apt-get install mplayer imagemagick libmagickwand-dev
@@ -84,7 +74,6 @@ Then install with:
 For more details, see [Installing on
 Linux](https://github.com/lolcommits/lolcommits/wiki/Installing-on-Linux).
 
-
 ### Windows - here be dragons!
 
 It works, but you'll need some more detailed instructions to get the
@@ -94,7 +83,6 @@ Windows](https://github.com/lolcommits/lolcommits/wiki/Installing-on-Windows).
 
 ## Usage
 
-
 ### Enabling and basic usage
 
 Within any git repository, simply run `lolcommits --enable`. From that

data/bin/lolcommits

@@ -1,22 +1,12 @@
 #!/usr/bin/env ruby
 
-begin
-  require 'lolcommits'
-rescue LoadError
-  require 'rubygems'
-  require 'lolcommits'
-end
-
-require 'optparse'
-require 'optparse_plus'
-require 'lolcommits/cli.rb'
+require 'lolcommits'
 
 # allow logging from everywhere
 include OptparsePlus::CLILogging
 
 class App
   include OptparsePlus::Main
-
   include Lolcommits
   include Lolcommits::CLI
 
@@ -37,7 +27,7 @@ class App
       end
 
       plugin_manager = PluginManager.init
-      config         = Configuration.new(plugin_manager, test_mode: options[:test])
+      config = Configuration.new(plugin_manager, test_mode: options[:test])
 
       if options[:version]
         puts Lolcommits::VERSION

data/lib/core_ext/mercurial-ruby/changed_file.rb

@@ -1,12 +1,10 @@
-# frozen_string_literal: true
-
 module Mercurial
   class ChangedFile
     private
 
     def enforce_unicode(str)
       # String#encode patched to be Ruby 3.0+ compatible
-      str.encode('utf-8', invalid: :replace, undef: :replace, replace: '?')
+      str.encode("utf-8", invalid: :replace, undef: :replace, replace: "?")
     end
   end
 end

data/lib/core_ext/mercurial-ruby/command.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 if Lolcommits::Platform.platform_windows?
   module Mercurial
     class Command
@@ -9,8 +7,8 @@ if Lolcommits::Platform.platform_windows?
       def execution_proc
         proc do
           debug(command)
-          result = ''
-          error = ''
+          result = ""
+          error = ""
           status = nil
           Open3.popen3(command) do |_stdin, stdout, stderr, wait_thread|
             Timeout.timeout(timeout) do

data/lib/core_ext/mercurial-ruby/config_file.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Mercurial
   class ConfigFile
     def exists?

data/lib/core_ext/mercurial-ruby/repository.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Mercurial
   class Repository
     def self.open(destination)

data/lib/core_ext/mercurial-ruby/shell.rb

@@ -1,11 +1,9 @@
-# frozen_string_literal: true
-
 module Mercurial
   class Shell
     # windows command line doesn't like single quotes
     def self.interpolate_arguments(cmd_with_args)
       cmd_with_args.shift.tap do |cmd|
-        cmd.gsub!('?') do
+        cmd.gsub!("?") do
           if Lolcommits::Platform.platform_windows?
             "\"#{cmd_with_args.shift}\""
           else

data/lib/lolcommits/animated_gif.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Lolcommits
   class AnimatedGif
     def create(video_path:, output_path:)
@@ -20,12 +18,19 @@ module Lolcommits
       # create the looping animated gif from frames (delete frame files except every #{skip} frame)
       Dir["#{frames_dir}/*.png"].each do |frame_filename|
         basename = File.basename(frame_filename)
-        frame_number = basename.split('.').first.to_i
+        frame_number = basename.split(".").first.to_i
         File.delete(frame_filename) if frame_number % skip != 0
       end
 
-      # convert to animated gif with delay and gif optimisation
-      system_call "convert -layers OptimizeTransparency -delay #{delay} -loop 0 \"#{frames_dir}/*.png\" -coalesce \"#{output_path}\""
+      # convert to animated gif with delay and transparency optimising
+      MiniMagick.convert do |convert|
+        convert << "#{frames_dir}/*.png"
+        convert.layers "OptimizeTransparency"
+        convert.delay delay
+        convert.loop 0
+        convert.coalesce
+        convert << output_path
+      end
 
       # remove tmp frames dir
       FileUtils.rm_rf(frames_dir)
@@ -38,13 +43,13 @@ module Lolcommits
     end
 
     def null_string
-      Lolcommits::Platform.platform_windows? ? 'nul' : '/dev/null'
+      Lolcommits::Platform.platform_windows? ? "nul" : "/dev/null"
     end
 
     def frame_delay(fps, skip)
       # calculate frame delay
       delay = ((100.0 * skip) / fps.to_f).to_i
-      [delay, 6].max # hard limit for IE browsers
+      [ delay, 6 ].max # hard limit for IE browsers
     end
 
     def video_fps(file)

data/lib/lolcommits/backends/git_info.rb

@@ -1,19 +1,17 @@
-# frozen_string_literal: true
-
 module Lolcommits
   class GitInfo
     GIT_URL_REGEX = %r{.*:([/\w-]*).git}
 
-    def self.repo_root?(path = '.')
-      File.directory?(File.join(path, '.git'))
+    def self.repo_root?(path = ".")
+      File.directory?(File.join(path, ".git"))
     end
 
-    def self.local_name(path = '.')
+    def self.local_name(path = ".")
       File.basename(Git.open(path).dir.to_s)
     end
 
     def initialize
-      debug 'parsed the following values from commit:'
+      debug "parsed the following values from commit:"
       debug "\t#{message}"
       debug "\t#{sha}"
       debug "\t#{repo_internal_path}"
@@ -30,7 +28,7 @@ module Lolcommits
 
     def message
       @message ||= begin
-        message = last_commit.message || ''
+        message = last_commit.message || ""
         message.split("\n").first
       end
     end
@@ -81,7 +79,7 @@ module Lolcommits
       "#{url.tr(':', '/').gsub(/^git@/, 'https://').gsub(/\.git$/, '')}/commit/"
     end
 
-    def repository(path = '.')
+    def repository(path = ".")
       @repository ||= Git.open(path)
     end
 

data/lib/lolcommits/backends/installation_git.rb

@@ -1,17 +1,15 @@
-# frozen_string_literal: true
-
 module Lolcommits
   #
   # Methods to handle enabling and disabling of lolcommits
   #
   class InstallationGit
-    HOOK_PATH = File.join '.git', 'hooks', 'post-commit'
-    HOOK_DIR = File.join '.git', 'hooks'
+    HOOK_PATH = File.join ".git", "hooks", "post-commit"
+    HOOK_DIR = File.join ".git", "hooks"
 
     #
     # IF --ENABLE, DO ENABLE
     #
-    def self.do_enable(capture_args = '')
+    def self.do_enable(capture_args = "")
       # its possible a hooks dir doesnt exist, so create it if so
       Dir.mkdir(HOOK_DIR) unless File.directory?(HOOK_DIR)
 
@@ -33,7 +31,7 @@ module Lolcommits
         add_shebang = true
       end
 
-      File.open(HOOK_PATH, add_shebang ? 'w' : 'a') do |f|
+      File.open(HOOK_PATH, add_shebang ? "w" : "a") do |f|
         f.write("#!/bin/sh\n") if add_shebang
         f.write(hook_script(capture_args))
       end
@@ -59,9 +57,9 @@ module Lolcommits
       end
     end
 
-    def self.hook_script(capture_args = '')
-      ruby_path     = Lolcommits::Platform.command_which('ruby', only_path: true)
-      imagick_path  = Lolcommits::Platform.command_which('identify', only_path: true)
+    def self.hook_script(capture_args = "")
+      ruby_path     = Lolcommits::Platform.command_which("ruby", only_path: true)
+      imagick_path  = Lolcommits::Platform.command_which("identify", only_path: true)
       capture_cmd   = "if [ ! -d \"$GIT_DIR/rebase-merge\" ] && [ \"$LOLCOMMITS_CAPTURE_DISABLED\" != \"true\" ]; then lolcommits --capture #{capture_args}; fi"
       exports       = "GIT_DIR=${GIT_DIR-`git rev-parse --git-dir`} && LANG=\"#{ENV.fetch('LANG', nil)}\" && PATH=\"$PATH:#{ruby_path}:#{imagick_path}\""
 
@@ -95,7 +93,7 @@ module Lolcommits
 
     def self.remove_existing_hook!
       hook = File.read(HOOK_PATH)
-      out  = File.open(HOOK_PATH, 'w')
+      out  = File.open(HOOK_PATH, "w")
       skip = false
 
       hook.lines.each do |line|