lolcommits-sample_plugin 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0ffe9fd14e59f028f2881574a9c751c7f7a30eef2389ed4b318764af767788c
-  data.tar.gz: f178c6cd63b5eb23dfd5099018d24172802a8f799bce8d25e876af3d5ba68402
+  metadata.gz: 4963638d9fb2e82c3d6668cc04840305be43caf5082685cf664888915ce3964e
+  data.tar.gz: afce17712fcd4941780a77589510408a9dca0d84154a8149d4966521c203eb7a
 SHA512:
-  metadata.gz: e5624a9283d099d28f88c409a82eeda9080149dbdcdbf885e15431540701080a8aff37f3fdac522c8c9132bdfe7238bd36d6a8d76c3e9a0f9e8b6832c7633b76
-  data.tar.gz: 7fd9f771eb7479ecc947f12b5d9dd25e0b88bffe802e1eb611a8700e8efda57249d528d186c70aebdc950a132a96ddfac1be24933811f97f144eb43bee7448e6
+  metadata.gz: f094d34b8a5e41d19918514e4eec00dac5ce45ff6d5741d5c634899ad4464ac1460b03be1f44a8bd8c319c9371fd1aaa75ed8429769d9dc26dd1148930ca76dd
+  data.tar.gz: cca703fa294bd230bb015bf67cb06bc657382f5bdc90083bdfad8c8b2c1cf79baf2489fe23e59bcc3d20ef0c780f16729ce5e41eaa4b8bfb45521f258da33203

data/.github/workflows/build.yml

@@ -0,0 +1,34 @@
+name: Tests
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: ['3.1', '3.2', '3.3', '3.4']
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Configure git user name, email
+      run: |
+        git config --global user.name $NAME
+        git config --global user.email $EMAIL
+      env:
+        NAME: "George Costanza"
+        EMAIL: "george.costanza@vandelay.com"
+    - name: Run tests
+      run: bundle exec rake test

data/.github/workflows/push_gem.yml

@@ -0,0 +1,25 @@
+name: Publish gem to RubyGems.org
+
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  push:
+    name: Push gem to RubyGems.org
+    runs-on: ubuntu-latest
+
+    permissions:
+      id-token: write
+      contents: write
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: ruby
+
+      - uses: rubygems/release-gem@v1

data/.travis.yml

@@ -2,10 +2,10 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.4.9
-  - 2.5.7
-  - 2.6.5
-  - 2.7.0
+  - 2.5.8
+  - 2.6.6
+  - 2.7.2
+  - 3.0.0
   - ruby-head
 
 before_install:

data/CHANGELOG.md

@@ -9,6 +9,10 @@ project adheres to [Semantic Versioning][Semver].
 
 - Your contribution here!
 
+## [0.5.0] - 2024-09-22
+### Removed
+- Support for Ruby < 3.1 (older rubies no longer supported)
+
 ## [0.4.0] - 2020-01-24
 ### Removed
 - Support for Ruby < 2.4 (older rubies no longer supported)
@@ -58,7 +62,8 @@ project adheres to [Semantic Versioning][Semver].
 ### Changed
 - Initial release
 
-[Unreleased]: https://github.com/lolcommits/lolcommits-sample_plugin/compare/v0.4.0...HEAD
+[Unreleased]: https://github.com/lolcommits/lolcommits-sample_plugin/compare/v0.5.0...HEAD
+[0.5.0]: https://github.com/lolcommits/lolcommits-sample_plugin/compare/v0.4.0...v0.5.0
 [0.4.0]: https://github.com/lolcommits/lolcommits-sample_plugin/compare/v0.3.0...v0.4.0
 [0.3.0]: https://github.com/lolcommits/lolcommits-sample_plugin/compare/v0.2.0...v0.3.0
 [0.2.0]: https://github.com/lolcommits/lolcommits-sample_plugin/compare/v0.1.2...v0.2.0

data/README.md

@@ -1,10 +1,8 @@
 # Lolcommits Sample Plugin
 
+[![Build](https://img.shields.io/github/actions/workflow/status/lolcommits/lolcommits-sample_plugin/build.yml?branch=main&style=flat)](https://github.com/lolcommits/lolcommits-sample_plugin/actions/workflows/build.yml)
 [![Gem](https://img.shields.io/gem/v/lolcommits-sample_plugin.svg?style=flat)](http://rubygems.org/gems/lolcommits-sample_plugin)
-[![Travis](https://img.shields.io/travis/com/lolcommits/lolcommits-sample_plugin/master.svg?style=flat)](https://travis-ci.com/lolcommits/lolcommits-sample_plugin)
 [![Depfu](https://img.shields.io/depfu/lolcommits/lolcommits-sample_plugin.svg?style=flat)](https://depfu.com/github/lolcommits/lolcommits-sample_plugin)
-[![Maintainability](https://api.codeclimate.com/v1/badges/ce34ea41c79820a2fc75/maintainability)](https://codeclimate.com/github/lolcommits/lolcommits-sample_plugin/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/ce34ea41c79820a2fc75/test_coverage)](https://codeclimate.com/github/lolcommits/lolcommits-sample_plugin/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
@@ -25,7 +23,7 @@ be enabled, you'll see something like this for a capture:
     (it was an image!)
 
 Use this repo to jump-start development on your own plugin. It has
-tests, docs and hooks with useful tools; Travis, CodeClimate, Rdoc etc.
+tests, docs and hooks with useful tools; CI, Rdoc etc.
 
 ## Developing your own plugin
 
@@ -284,10 +282,8 @@ and [pull
 requests](https://github.com/lolcommits/lolcommits-sample_plugin/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.com/lolcommits/lolcommits-sample_plugin). Read the
-[contributing
+When submitting pull requests, remember to add tests covering any new behaviour,
+and ensure all tests are passing on CI. Read the [contributing
 guidelines](https://github.com/lolcommits/lolcommits-sample_plugin/blob/master/CONTRIBUTING.md)
 for more details.
 
@@ -305,9 +301,7 @@ The gem is available as open source under the terms of
 
 ## Links
 
-* [Travis CI](https://travis-ci.com/lolcommits/lolcommits-sample_plugin)
-* [Test Coverage](https://codeclimate.com/github/lolcommits/lolcommits-sample_plugin/test_coverage)
-* [Code Climate](https://codeclimate.com/github/lolcommits/lolcommits-sample_plugin)
+* [CI](https://github.com/lolcommits/lolcommits-sample_plugin/actions/workflows/build.yml)
 * [RDoc](http://rdoc.info/projects/lolcommits/lolcommits-sample_plugin)
 * [Issues](http://github.com/lolcommits/lolcommits-sample_plugin/issues)
 * [Report a bug](http://github.com/lolcommits/lolcommits-sample_plugin/issues/new)

data/Rakefile

@@ -18,14 +18,4 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
-# run tests with code coverage (default)
-namespace :test do
-  desc "Run all tests and features and generate a code coverage report"
-  task :coverage do
-    ENV['COVERAGE'] = 'true'
-    Rake::Task['test'].execute
-  end
-end
-
-
-task :default => ['test:coverage']
+task :default => ['test']

data/lib/lolcommits/sample_plugin/version.rb

@@ -2,6 +2,6 @@
 
 module Lolcommits
   module SamplePlugin
-    VERSION = "0.4.0".freeze
+    VERSION = "0.5.0".freeze
   end
 end

data/lolcommits-plugin-sample.gemspec

@@ -26,13 +26,11 @@ Gem::Specification.new do |spec|
   spec.executables   = []
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 2.4"
+  spec.required_ruby_version = ">= 3.1"
 
-  spec.add_runtime_dependency "lolcommits", ">= 0.14.2"
+  spec.add_runtime_dependency "lolcommits", ">= 0.17.2"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest"
-  spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "pry"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lolcommits-sample_plugin
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Matthew Hutchinson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-24 00:00:00.000000000 Z
+date: 2024-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lolcommits
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.2
+        version: 0.17.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.2
+        version: 0.17.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,34 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Use this gem as a guide or template to get started with lolcommits plugin
   development
 email:
@@ -102,6 +74,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/build.yml"
+- ".github/workflows/push_gem.yml"
 - ".gitignore"
 - ".simplecov"
 - ".travis.yml"
@@ -119,8 +93,6 @@ files:
 - lib/lolcommits/sample_plugin.rb
 - lib/lolcommits/sample_plugin/version.rb
 - lolcommits-plugin-sample.gemspec
-- test/lolcommits/plugin/sample_plugin_test.rb
-- test/test_helper.rb
 homepage: https://github.com/lolcommits/lolcommits-sample_plugin
 licenses:
 - LGPL-3.0
@@ -138,17 +110,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.5.16
 signing_key: 
 specification_version: 4
 summary: Example gem for lolcommits plugin development
-test_files:
-- test/lolcommits/plugin/sample_plugin_test.rb
-- test/test_helper.rb
+test_files: []

data/test/lolcommits/plugin/sample_plugin_test.rb

@@ -1,109 +0,0 @@
-# frozen_string_literal: true
-
-require 'test_helper'
-
-describe Lolcommits::Plugin::SamplePlugin do
-
-  include Lolcommits::TestHelpers::GitRepo
-  include Lolcommits::TestHelpers::FakeIO
-
-  describe 'with a runner' do
-    def runner
-      # a simple lolcommits runner with an empty configuration Hash
-      @runner ||= Lolcommits::Runner.new(
-        lolcommit_path: "/path/to/lolcommit.jpg"
-      )
-    end
-
-    def plugin
-      @plugin ||= Lolcommits::Plugin::SamplePlugin.new(runner: runner)
-    end
-
-    def valid_enabled_config
-      {
-        enabled: true,
-        ask_for_cheese: false,
-        always_a_great_commit?: true,
-        camera_emoji: {
-          enabled: true,
-          emoji_multiplier: 5
-        }
-      }
-    end
-
-    describe '#run_pre_capture' do
-      before { commit_repo_with_message }
-
-      it 'outputs a message to stdout' do
-        in_repo do
-          _(Proc.new { plugin.run_pre_capture }).
-            must_output "✨  Say cheese 😁 !\n"
-        end
-      end
-
-      after { teardown_repo }
-    end
-
-    describe '#run_post_capture' do
-      before { commit_repo_with_message }
-
-      it 'outputs a message to stdout' do
-        plugin.configuration = valid_enabled_config
-        in_repo do
-          _(Proc.new { plugin.run_post_capture }).
-            must_output "📸  📸  📸  📸  📸  Snap!\n"
-        end
-      end
-
-      after { teardown_repo }
-    end
-
-    describe '#run_capture_ready' do
-
-      before { commit_repo_with_message }
-
-      it 'outputs a message to stdout' do
-        in_repo do
-          _(Proc.new { plugin.run_capture_ready }).
-            must_output "wow! #{last_commit.sha[0..10]} at /path/to/lolcommit.jpg is your best looking commit yet!\n(it was an image!)\n"
-        end
-      end
-
-      after { teardown_repo }
-    end
-
-    describe '#enabled?' do
-      it 'returns be false by default' do
-        _(plugin.enabled?).must_equal false
-      end
-
-      it 'returns true when configured' do
-        plugin.configuration = valid_enabled_config
-        _(plugin.enabled?).must_equal true
-      end
-    end
-
-    describe 'configuration' do
-      it 'allows plugin options to be configured' do
-        configured_plugin_options = {}
-
-        fake_io_capture(inputs: %w(true false true true 5)) do
-          configured_plugin_options = plugin.configure_options!
-        end
-
-        _(configured_plugin_options).must_equal(valid_enabled_config)
-      end
-
-      describe '#valid_configuration?' do
-        it 'returns false without config set' do
-          _(plugin.valid_configuration?).must_equal(false)
-        end
-
-        it 'returns true for a valid configuration' do
-          plugin.configuration = valid_enabled_config
-          _(plugin.valid_configuration?).must_equal true
-        end
-      end
-    end
-  end
-end

data/test/test_helper.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
-
-# lolcommits gem
-require 'lolcommits'
-
-# lolcommit test helpers
-require 'lolcommits/test_helpers/git_repo'
-require 'lolcommits/test_helpers/fake_io'
-
-if ENV['COVERAGE']
-  require 'simplecov'
-end
-
-# plugin gem test libs
-require 'lolcommits/sample_plugin'
-require 'minitest/autorun'
-
-# swallow all debug output during test runs
-def debug(msg); end