B4U 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ff78d0ea5014a0fca34de15bdff0406ebb3b666bfb480ca8891961248d0164a8
+  data.tar.gz: 9ad3d17206045b432aee3de3f5fac057517a477cead2785a474baa37946b2e57
+SHA512:
+  metadata.gz: d40a900ca9642a99c598a78fc6a257d3d7d6419951a695f7eb12c74e9c05bf4178b21c29a8af239acafbda8c2829b8867ab7d7a58e0957f5867f0839e7c97837
+  data.tar.gz: c8d9f5663e45d76709f6e0347ac5920363ae5783098b21fd987f42c4dc4ab3933a3c3541dd0146d511774f7c3ffd8c0e329c16c9b42c98ef0c627521a24c6a74

data/.rspec

@@ -0,0 +1,5 @@
+--require spec_helper
+--color
+--format RspecSonarqubeFormatter
+--out out/test-report.xml
+--format documentation

data/.rubocop.yml

@@ -0,0 +1,8 @@
+inherit_gem:
+  dvla-lint: ".rubocop.yml"
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.1.0
+  Exclude:
+    - 'B4U.gemspec'

data/.ruby-version

@@ -0,0 +1 @@
+3.4.2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-08-01
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENCE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 HM Government (Driver and Vehicle Licensing Agency)
+
+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,104 @@
+# B4U
+
+B4U is a configurable multithreaded task runner designed to integrate into any git project. It allows you to implement your own quality checks before git actions (commits, pushes, etc.).
+
+B4U is intended to be fast, configurable and (importantly) not annoying.
+
+## Quick Start
+
+1. **Install:** `gem install B4U`
+2. **Initialize:** `B4U --init`
+3. **Configure tasks** in `.B4U/commit.yml` and `.B4U/push.yml`
+4. **Commit these files** to your version control
+5. **Team setup:** `B4U --enable` (after cloning)
+
+## Installation
+
+Install the gem:
+
+```bash
+gem install B4U
+```
+
+Or add to your Gemfile:
+
+```ruby
+bundle add B4U
+```
+
+## Configuration
+
+B4U uses YAML configuration files in the `.B4U` directory:
+
+- `.B4U/commit.yml` - Tasks to run before commits
+- `.B4U/push.yml` - Tasks to run before pushes
+
+### Configuration Format
+
+Each task requires a `name` and `command`. Optionally add `ignore: true` for non-blocking tasks:
+
+```yaml
+linters:
+  - name: "Unit tests"
+    command: "bundle exec rspec"
+    ignore: true  # Won't block commit if this fails
+  - name: "Rubocop"
+    command: "bundle exec rubocop"
+  - name: "ESLint"
+    command: "npm run lint"
+  - name: "Type checking"
+    command: "npm run type-check"
+```
+
+**Important:** Tasks run in parallel, so only use read-only commands to avoid conflicts.
+
+## Usage
+
+### Command Line Options
+
+```bash
+B4U --help     # Show help
+B4U --version  # Show version
+B4U --init     # Initialize B4U in current project
+B4U --enable   # Enable B4U hooks in current project
+B4U --commit   # Run pre-commit tasks
+B4U --push     # Run pre-push tasks
+```
+
+## Setup
+
+Running `B4U --init` will:
+- Create a `.B4U` directory with configuration files.
+- Set up git hooks for pre-commit and pre-push events.
+
+Running `B4U --enable` will:
+- Set up your local git hooks for pre-commit and pre-push events.
+
+**Important:** Anyone who clones the project needs to run `B4U --enable` to activate the hooks locally so should add this to your setup script and/or README.md.
+
+## Troubleshooting
+
+**"Command not found: B4U"**
+- If you're seeing this error and you already have installed B4U, it is likely caused by your IDE or version manager.
+
+  B4U runs by calling itself from the shell scripts in the `.B4U` folder, so you can add any logic needed to point to the correct version of Ruby or even install the gem to the current version. 
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub. This project is intended to be a safe, welcoming space for collaboration.
+
+1. Fork the repository.
+2. Create your feature branch (`git checkout -b feature/amazing-feature`).
+3. Commit your changes (`git commit -am 'Add amazing feature'`).
+4. Push to the branch (`git push origin feature/amazing-feature`).
+5. Open a Pull Request.
+
+Please make sure to update tests as appropriate and adhere to the [code of conduct](CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the B4U project's codebases, issue trackers, and discussions is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'minitest/test_task'
+
+Minitest::TestTask.create
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/exe/B4U

@@ -0,0 +1,145 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'optparse'
+require 'B4U'
+require 'open3'
+require 'fileutils'
+require 'logger'
+require 'yaml'
+
+def setup_new_project
+  if Dir.exist? '.git'
+    if File.exist?(File.join(Dir.pwd, '.B4U'))
+      puts 'Found existing .B4U directory, exiting...'.red.bold
+      exit 1
+    else
+      FileUtils.mkdir '.B4U'
+      hooks = %w[commit push]
+      hooks.each do |hook_name|
+        set_config(hook_name)
+        set_hooks(hook_name)
+      end
+    end
+  else
+    puts "Couldn't find .git folder in the current directory: #{Dir.pwd}".red.bold
+    exit 1
+  end
+end
+
+def hook_executable(hook_name)
+  <<~BASH
+    #!/bin/sh
+
+    if ! command -v B4U 2>&1 >/dev/null
+    then
+        echo "B4U gem is not installed"
+        echo "You should install it using:"
+        echo "gem install B4U"
+        exit 1
+    fi
+    B4U --#{hook_name}
+  BASH
+end
+
+def config_file(hook_name)
+  <<~YAML
+    linters:
+      - placeholder:
+        name: Add your pre #{hook_name} tasks to .B4U/#{hook_name}.yml
+        command: echo "B4U is working, but you haven't set your pre-#{hook_name} tasks"; exit 1
+        ignore: false
+  YAML
+end
+
+def set_hooks(hook_name)
+  filename = ".B4U/pre-#{hook_name}"
+  File.open(filename, 'w') do |file|
+    file.write(hook_executable(hook_name))
+  end
+  File.chmod(0o755, filename)
+end
+
+def set_config(hook_name)
+  filename = ".B4U/#{hook_name}.yml"
+  File.open(filename, 'w') do |file|
+    file.write(config_file(hook_name))
+  end
+end
+
+def enable_git_hooks
+  system('git config core.hooksPath .B4U')
+end
+
+def parse_arguments
+  options = {}
+  # rubocop:disable Metrics/BlockLength
+  OptionParser.new do |opts|
+    opts.banner = 'Usage: B4U [options]'
+
+    opts.on('-h', '--help', 'Show help message') do
+      puts 'B4U - B4U is a configurable multithreaded task runner that is triggered by git actions'
+      puts 'usage: B4U [options]'
+      puts '   --init                           Create a new config file in the current directory'
+      puts '   --enable                         Add B4U hooks to your local git config in this repo'
+      puts '   --commit                         Runs B4U using the config in .B4U/commit.yml'
+      puts '   --push                           Runs B4U using the config in .B4U/push.yml'
+      puts '   --no-colour                      Disable colour output'
+      puts '   -h, --help                       Show help message'
+      puts '   -v, --version                    Show version'
+      exit
+    end
+    opts.on('-v', '--version', 'Show version') do
+      puts B4U::VERSION
+      exit
+    end
+    opts.on('--no-colour', 'Enable colour output') do
+      options[:no_colour] = true
+    end
+    opts.on('--init', 'init',
+            'Setup B4U in the current directory') do
+      String.enable_colour unless options[:no_colour]
+      setup_new_project
+      puts "Initialized B4U in #{Dir.pwd}".bg_green
+      puts 'you should add the .B4U directory to version control'.cyan.bold
+      enable_git_hooks
+      exit
+    end
+    opts.on('--enable', 'enable', 'Add B4U to your local git config') do
+      enable_git_hooks
+      puts 'Added B4U to the config for this project'.green
+      exit
+    end
+    opts.on('--commit', 'Run pre commit hooks') do
+      options[:config_file] = '.B4U/commit.yml'
+    end
+    opts.on('--push', 'Run pre push hooks') do
+      options[:config_file] = '.B4U/push.yml'
+    end
+  end.parse!
+  # rubocop:enable Metrics/BlockLength
+  options
+end
+
+def run_B4U(options)
+  String.enable_colour unless options[:no_colour]
+  config = if options[:config_file]
+             begin
+               YAML.load_file(options[:config_file])
+             rescue StandardError
+               puts "Couldn't load config file: #{options[:config_file]} in from directory #{Dir.pwd}".red.bold
+               exit 1
+             end
+           else
+             puts "You need to give B4U a command, run 'B4U -h' for help".red.bold
+             exit 1
+           end
+  B4U.lint(config:)
+end
+
+begin
+  options = parse_arguments
+  run_B4U(options)
+rescue OptionParser::InvalidOption, OptionParser::InvalidArgument => e
+  puts e.message
+end

data/lib/B4U/error.rb

@@ -0,0 +1,16 @@
+class LinterError < StandardError
+  attr_reader :linter, :console_output
+  def initialize(linter:, console_output:, msg: 'Linter error')
+    @linter = linter
+    @console_output = console_output
+    super(msg)
+  end
+end
+
+class StructureError < StandardError
+  attr_reader :files
+  def initialize(files:, msg: 'Structure error')
+    @files = files
+    super(msg)
+  end
+end

data/lib/B4U/linter.rb

@@ -0,0 +1,21 @@
+class Linter
+  attr_reader :name, :command, :ignore
+
+  def initialize(name:, command:, ignore: false)
+    @name = name
+    @command = command
+    @ignore = ignore
+  end
+
+  def run
+    console_output, status = Open3.capture2e(command)
+    if status.success?
+      puts "✅ - #{name}".green
+    elsif ignore
+      puts "❌ - #{name} (ignored)".magenta
+    else
+      puts "❌ - #{name}".red
+      raise LinterError.new(linter: name, console_output:)
+    end
+  end
+end

data/lib/B4U/runner.rb

@@ -0,0 +1,28 @@
+module B4U
+  class LinterRunner
+    def initialize(linters)
+      @linters = linters
+    end
+
+    def run_all
+      errors = @linters.map do |linter|
+        Thread.new do
+          begin
+            linter.run
+            nil
+          rescue LinterError => e
+            e
+          end
+        end
+      end.map(&:join).filter_map(&:value)
+      unless errors.empty?
+        puts "\n"
+        errors.each do |error|
+          puts "Linter '#{error.linter}' failed with the following output:".bold
+          puts error.console_output.red
+        end
+        exit 1
+      end
+    end
+  end
+end

data/lib/B4U/string_methods.rb

@@ -0,0 +1,31 @@
+class String
+  class << self
+    attr_accessor :colour_enabled
+  end
+
+  def self.enable_colour
+    self.colour_enabled = true
+  end
+
+  def self.disable_colour
+    self.colour_enabled = false
+  end
+
+  def colorize(code)
+    return self unless String.colour_enabled
+
+    "\e[#{code}m#{self}\e[0m"
+  end
+
+  def red = colorize(31)
+
+  def green = colorize(32)
+
+  def magenta = colorize(35)
+
+  def cyan = colorize(36)
+
+  def bg_green = colorize(42)
+
+  def bold = colorize(1)
+end

data/lib/B4U/version.rb

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

data/lib/B4U.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'B4U/runner'
+require_relative 'B4U/string_methods'
+require_relative 'B4U/linter'
+require_relative 'B4U/version'
+require_relative 'B4U/error'
+
+
+module B4U
+  def self.lint(config:)
+    ProjectChecker.ensure_project_root!(config['required-files']) unless config['required-files'].nil?
+    puts "Project structure valid, running #{config['linters'].count} linting steps...".green
+    linters = config['linters'].map do |linter|
+      Linter.new(
+        name: linter['name'],
+        command: linter['command'],
+        ignore: linter.fetch('ignore', false),
+        )
+    end
+    puts "Before you do that we are just going to check: #{linters.map(&:name)}".cyan.bold
+
+    runner = LinterRunner.new(linters)
+    runner.run_all
+    puts 'All linters passed!'.bg_green
+  end
+
+  class ProjectChecker
+    def self.ensure_project_root!(required_files)
+      puts 'Checking project structure...'.cyan
+      missing_files = required_files.reject { |file| File.exist?(file) }
+      raise StructureError.new(files: missing_files, msg: "Missing project files: #{missing_files.join(', ')}") unless missing_files.empty?
+    end
+  end
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: B4U
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Driver and Vehicle Licensing Agency (DVLA)
+- Niall James
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+email:
+- niall.james@dvla.gov.uk
+executables:
+- B4U
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENCE
+- README.md
+- Rakefile
+- exe/B4U
+- lib/B4U.rb
+- lib/B4U/error.rb
+- lib/B4U/linter.rb
+- lib/B4U/runner.rb
+- lib/B4U/string_methods.rb
+- lib/B4U/version.rb
+homepage: https://github.com/dvla/B4U
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/dvla/B4U/browse
+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.7
+specification_version: 4
+summary: Multithreaded Ruby lint runner
+test_files: []