rake_announcer 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9f033924b9e95ad1947563291a063111eb9f4e66de47bdcc12ab6561fd375e7d
+  data.tar.gz: 65250075c28fec5daf1f647f092b6c55f0814e40cb0acaa29a636191a484a7cf
+SHA512:
+  metadata.gz: 78e89dfdc50c1e3d7dfea87a4fa91230d6264dbdc938b7ec4267bf066ad2ee067475036539fca0388ae05f07c8c5620af1f0a5c3b8167b6797fa24a72658863f
+  data.tar.gz: 608a4bb5122aa8b6081881cbc2d5ab2d90c3c66905613f4a78a43109efd57b3683989b8a650c665463ffe6dde95cd56fc7cd2a45cc0fa4a901def36e2d2db17c

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 1.0.0 (06 February 2025)
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 David Bull
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+# RakeAnnouncer
+
+[![Build Status](https://github.com/ukdave/rake_announcer/actions/workflows/main.yml/badge.svg)](https://github.com/ukdave/rake_announcer/actions/workflows/main.yml)
+[![Release](https://img.shields.io/github/v/release/ukdave/rake_announcer)](https://github.com/ukdave/rake_announcer/releases)
+[![License](https://img.shields.io/github/license/ukdave/rake_announcer)](https://github.com/ukdave/rake_announcer/blob/main/LICENSE.txt)
+
+A small gem to enhance existing rake tasks by printing a brief message before each one is invoked. The list of tasks to wrap/enhance is configurable. Also included is a task to print a simple and colourful "All Tests Passed" message.
+
+This gem was inspired by [Rake-n-Bake](https://github.com/RichardVickerstaff/rake-n-bake).
+
+![Screenshot](screenshot.png?raw=true "Screenshot")
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add rake_announcer
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install rake_announcer
+```
+
+## Usage
+
+Add the following to your Rakefile:
+
+```ruby
+require "rake_announcer/rake_task"
+RakeAnnouncer::RakeTask.new(tasks: %i[spec rubocop])
+```
+
+Include the names of any rake tasks that you want announced in the `tasks` array. The above example will print a message before the `spec` and `rubocop` tasks.
+
+You can also print a simple "All Tests Passed" message by adding the `rake_announcer:ok` task, e.g.:
+
+```ruby
+task default: %i[spec rubocop rake_announcer:ok]
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+To release a new version, run `bundle exec rake semver:XXX` (replacing `XXX` with `major` or `minor` or `patch`), which will bump the version number and create a git tag for the version. Then run `bundle exec rake release`, which will push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ukdave/rake_announcer.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/rake_announcer/rake_task.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "rake/tasklib"
+require "rake_announcer"
+
+module RakeAnnouncer
+  class RakeTask < Rake::TaskLib
+    def initialize(name: :rake_announcer, tasks: [])
+      super()
+
+      namespace name do
+        tasks.each do |t|
+          RakeAnnouncer.enhance_rake_task(t)
+        end
+
+        desc "Print the 'ALL TESTS PASSED' message"
+        task :ok do
+          RakeAnnouncer.ok
+        end
+      end
+    end
+  end
+end

data/lib/rake_announcer/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RakeAnnouncer
+  VERSION = "1.0.0"
+end

data/lib/rake_announcer.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "rake"
+require "term/ansicolor"
+require_relative "rake_announcer/version"
+
+module RakeAnnouncer
+  class Error < StandardError; end
+
+  def self.enhance_rake_task(task_name)
+    announce_task = Rake::Task.define_task("announce_#{task_name}") do
+      RakeAnnouncer.announce("Running #{task_name}")
+    end
+    Rake::Task[task_name].enhance([announce_task.name])
+  end
+
+  def self.announce(message)
+    puts "\n#{Term::ANSIColor.blue}#{Term::ANSIColor.underline}● #{message}#{Term::ANSIColor.reset}"
+  end
+
+  # rubocop:disable Metrics/MethodLength
+  def self.ok(message = "ALL TESTS PASSED")
+    puts
+    print Term::ANSIColor.bold,
+          Term::ANSIColor.red,     "*",
+          Term::ANSIColor.yellow,  "*",
+          Term::ANSIColor.green,   "*",
+          Term::ANSIColor.blue,    "*",
+          Term::ANSIColor.magenta, "*",
+          Term::ANSIColor.green,   " #{message} ",
+          Term::ANSIColor.magenta, "*",
+          Term::ANSIColor.blue,    "*",
+          Term::ANSIColor.green,   "*",
+          Term::ANSIColor.yellow,  "*",
+          Term::ANSIColor.red,     "*",
+          Term::ANSIColor.clear
+    puts
+  end
+  # rubocop:enable Metrics/MethodLength
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: rake_announcer
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- David Bull
+bindir: exe
+cert_chain: []
+date: 2025-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13'
+- !ruby/object:Gem::Dependency
+  name: term-ansicolor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+description: |
+  A small gem to enhance existing rake tasks by printing a brief message before each one is invoked. The list of tasks
+  to wrap/enhance is configurable. Also included is a task to print a simple and colourful "All Tests Passed" message.
+email:
+- david@uk-dave.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/rake_announcer.rb
+- lib/rake_announcer/rake_task.rb
+- lib/rake_announcer/version.rb
+homepage: https://github.com/ukdave/rake_announcer
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ukdave/rake_announcer
+  source_code_uri: https://github.com/ukdave/rake_announcer
+  changelog_uri: https://github.com/ukdave/rake_announcer/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Print a message before each rake task
+test_files: []