Skip to content
This repository was archived by the owner on Jun 4, 2026. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .aiignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# An .aiignore file follows the same syntax as a .gitignore file.
# .gitignore documentation: https://git-scm.com/docs/gitignore

# you can ignore files
.DS_Store
*.log
*.tmp

# or folders
.devcontainer/
.qlty/
.yardoc/
dist/
build/
out/
coverage/
docs/
pkg/
results/
26 changes: 26 additions & 0 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
// README at: https://github.com/devcontainers/templates/tree/main/src/ruby
{
"name": "Ruby",
// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
"image": "mcr.microsoft.com/devcontainers/ruby:1-3-bookworm",

// Features to add to the dev container. More info: https://containers.dev/features.
// "features": {},

// Use 'forwardPorts' to make a list of ports inside the container available locally.
// "forwardPorts": [],

// Use 'postCreateCommand' to run commands after the container is created.
// "postCreateCommand": "ruby --version",

// Configure tool-specific properties.
"customizations" : {
"jetbrains" : {
"backend" : "RubyMine"
}
},

// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
// "remoteUser": "root"
}
27 changes: 27 additions & 0 deletions .env.local.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
#
# DO NOT EDIT THIS FILE
#
# COPT THIS FILE TO .env.local
#
# That file is ignored by .gitignore. This file is not.
#
export DEBUG=false # do not allow byebug statements (override in .env.local)
export FLOSS_FUNDING_DEBUG=false # extra logging to help diagnose issues (override in .env.local)
export AUTOGEN_FIXTURE_CLEANUP=false # autogenerated gem fixture cleanup after every RSpec run
export GIT_HOOK_FOOTER_APPEND=false
export GIT_HOOK_FOOTER_APPEND_DEBUG=false
export GIT_HOOK_FOOTER_SENTINEL="⚡️ A message from a fellow meat-based-AI"

# Tokens used by ci:act and CI helpers for reading workflow/pipeline status via APIs
# GitHub (either GITHUB_TOKEN or GH_TOKEN will be used; fine-grained recommended)
# - Scope/permissions: For fine-grained tokens, grant repository access (Read) and Actions: Read
# - For classic tokens, public repos need no scopes; private repos typically require repo
export GITHUB_TOKEN=<your GH token for GHA status; NEVER COMMIT>
# Alternatively:
# export GH_TOKEN=<your GH token>

# GitLab (either GITLAB_TOKEN or GL_TOKEN will be used)
# - Scope: read_api is sufficient to read pipelines
export GITLAB_TOKEN=<your GitLab token for pipeline status; NEVER COMMIT>
# Alternatively:
# export GL_TOKEN=<your GitLab token>
46 changes: 46 additions & 0 deletions .envrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Run any command in this library's bin/ without the bin/ prefix!
# Prefer exe version over binstub
PATH_add exe
PATH_add bin

# Only add things to this file that should be shared with the team.

# **dotenv** (See end of file for .env.local integration)
# .env would override anything in this file, if enabled.
# .env is a DOCKER standard, and if we use it, it would be in deployed, or DOCKER, environments.
# Override and customize anything below in your own .env.local
# If you are using dotenv and not direnv,
# copy the following `export` statements to your own .env file.

### General Ruby ###
# Turn off Ruby Warnings about deprecated code
# export RUBYOPT="-W0"

### External Testing Controls
export K_SOUP_COV_DO=true # Means you want code coverage
export K_SOUP_COV_COMMAND_NAME="Test Coverage"
# Available formats are html, xml, rcov, lcov, json, tty
export K_SOUP_COV_FORMATTERS="html,xml,rcov,lcov,json,tty"
export K_SOUP_COV_MIN_BRANCH=80 # Means you want to enforce X% branch coverage
export K_SOUP_COV_MIN_LINE=96 # Means you want to enforce X% line coverage
export K_SOUP_COV_MIN_HARD=true # Means you want the build to fail if the coverage thresholds are not met
export K_SOUP_COV_MULTI_FORMATTERS=true
export K_SOUP_COV_OPEN_BIN= # Means don't try to open coverage results in browser
export MAX_ROWS=1 # Setting for simplecov-console gem for tty output, limits to the worst N rows of bad coverage
export KETTLE_TEST_SILENT=true

# Internal Debugging Controls
export DEBUG=false # do not allow byebug statements (override in .env.local)
export FLOSS_CFG_FUND_DEBUG=false # extra logging to help diagnose issues (override in .env.local)
export FLOSS_CFG_FUND_LOGFILE=tmp/log/debug.log

# Concurrently developing the rubocop-lts suite?
export RUBOCOP_LTS_LOCAL=false

# .env would override anything in this file, if `dotenv` is uncommented below.
# .env is a DOCKER standard, and if we use it, it would be in deployed, or DOCKER, environments,
# and that is why we generally want to leave it commented out.
# dotenv

# .env.local will override anything in this file.
dotenv_if_exists .env.local
48 changes: 48 additions & 0 deletions .git-hooks/commit-msg
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
#!/usr/bin/env ruby
# vim: set syntax=ruby

# Do not rely on Bundler; allow running outside a Bundler context
begin
require "rubygems"
rescue LoadError
# continue
end

begin
# External gems
require "gitmoji/regex"

full_text = File.read(ARGV[0])
# Is the first character a GitMoji?
gitmoji_index = full_text =~ Gitmoji::Regex::REGEX
if gitmoji_index == 0
exit 0
else
denied = <<EOM
Oh snap, think again...

______ _______ ___ _______ _______ _______ _______ ______ __
| _ | | | | || || || || || | | |
| | || | ___| | || ___|| ||_ _|| ___|| _ || |
| |_||_ | |___ | || |___ | | | | | |___ | | | || |
| __ || ___| ___| || ___|| _| | | | ___|| |_| ||__|
| | | || |___ | || |___ | |_ | | | |___ | | __
|___| |_||_______||_______||_______||_______| |___| |_______||______| |__|


Did you forget to add a relevant gitmoji? (see https://gitmoji.dev/ for tools)
In this project, a Gitmoji must be the first grapheme of the commit message.
What's a grapheme?
A symbol rendered to be visually identifiable as a single character, but which may be composed of multiple Unicode code points)
Must match: #{Gitmoji::Regex::REGEX.to_s}
#{gitmoji_index ? "Found a gitmoji at character index #{gitmoji_index}... not good enough.\n" : ""}
Example: git commit -m "✨ My excellent new feature"

EOM
puts denied
exit 1
end
rescue LoadError => e
warn("gitmoji-regex gem not found: #{e.class}: #{e.message}.\n\tSkipping gitmoji check and allowing commit to proceed.\n\tRecommendation: add 'gitmoji-regex' to your development dependencies to enable this check.")
exit 0
end
8 changes: 8 additions & 0 deletions .git-hooks/commit-subjects-goalie.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
🔖 Prepare release v
🔒️ Checksums for v

# Lines beginning with # are ignored.
# This file is read by .git-hooks/prepare-commit-msg in each project.
# Each line of this file will be matched against the commit subject using `starts_with?`.
# If any `starts_with?` match the project script bin/prepare-commit-msg will run.
# 🔒️ Checksums for v is the standard commit message by stone_checksums.
16 changes: 16 additions & 0 deletions .git-hooks/footer-template.erb.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
⚡️ A message from a fellow meat-based-AI ⚡️
- [❤️] Finely-crafted open-source tools like <%= @gem_name %> (& many more) are a full-time endeavor.
- [❤️] Though I adore my work, it lacks financial sustainability.
- [❤️] Please, help me continue enhancing your tools by becoming a sponsor:
- [💲] https://liberapay.com/pboling/donate
- [💲] https://github.com/sponsors/pboling

<% if ENV["GIT_HOOK_FOOTER_APPEND_DEBUG"] == "true" %>
@pwd = <%= @pwd %>
@gemspecs = <%= @gemspecs %>
@spec = <%= @spec %>
@gemspec_path = <%= @gemspec_path %>
@gem_name <%= @gem_name %>
@spec_name <%= @spec_name %>
@content <%= @content %>
<% end %>
19 changes: 19 additions & 0 deletions .git-hooks/prepare-commit-msg
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
#!/bin/sh

# Fail on error and unset variables
set -eu

# Determine project root as the parent directory of this hook script
PROJECT_ROOT="$(CDPATH= cd -- "$(dirname -- "$0")"/.. && pwd)"

# Run the Ruby hook within the direnv context (if available),
# so ENV from .envrc/.env.local at project root is loaded.
# One of the things .envrc needs to do is add $PROJECT_ROOT/bin/ to the path.
# You should have this line at the top of .envrc
# PATH_add bin
# NOTE: If this project ships exe scripts it should also add that.
if command -v direnv >/dev/null 2>&1; then
exec direnv exec "$PROJECT_ROOT" "kettle-commit-msg" "$@"
else
raise "direnv not found. Local development of this project ($PROJECT_ROOT) with tools from the kettle-dev gem may not work properly. Please run 'brew install direnv'."
fi
13 changes: 13 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# These are supported funding model platforms

buy_me_a_coffee: pboling
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
github: [pboling] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
issuehunt: pboling # Replace with a single IssueHunt username
ko_fi: pboling # Replace with a single Ko-fi username
liberapay: pboling # Replace with a single Liberapay username
open_collective: galtzo-floss
patreon: galtzo # Replace with a single Patreon username
polar: pboling
thanks_dev: u/gh/pboling
tidelift: rubygems/bundle-namespace
13 changes: 13 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
version: 2
updates:
- package-ecosystem: bundler
directory: "/"
schedule:
interval: "weekly"
open-pull-requests-limit: 5
ignore:
- dependency-name: "rubocop-lts"
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"
21 changes: 21 additions & 0 deletions .github/workflows/auto-assign.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Auto Assign
on:
issues:
types: [opened]
pull_request:
types: [opened]
jobs:
run:
runs-on: ubuntu-latest
permissions:
issues: write
pull-requests: write
steps:
- name: 'Auto-assign issue'
uses: pozil/auto-assign-issue@v2
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
assignees: pboling
abortIfPreviousAssignees: true
allowSelfAssign: true
numOfAssignee: 1
70 changes: 70 additions & 0 deletions .github/workflows/codeql-analysis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# For most projects, this workflow file will not need changing; you simply need
# to commit it to your repository.
#
# You may wish to alter this file to override the set of languages analyzed,
# or to provide custom queries or build logic.
#
# ******** NOTE ********
# We have attempted to detect the languages in your repository. Please check
# the `language` matrix defined below to confirm you have the correct set of
# supported CodeQL languages.
#
name: "CodeQL"

on:
push:
branches: [ main, '*-stable' ]
pull_request:
# The branches below must be a subset of the branches above
branches: [ main, '*-stable' ]
schedule:
- cron: '35 1 * * 5'

jobs:
analyze:
name: Analyze
runs-on: ubuntu-latest
permissions:
actions: read
contents: read
security-events: write

strategy:
fail-fast: false
matrix:
language: [ 'ruby' ]
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
# Learn more about CodeQL language support at https://git.io/codeql-language-support

steps:
- name: Checkout repository
uses: actions/checkout@v5

# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v3
with:
languages: ${{ matrix.language }}
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.
# queries: ./path/to/local/query, your-org/your-repo/queries@main

# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
# If this step fails, then you should remove it and run the build manually (see below)
- name: Autobuild
uses: github/codeql-action/autobuild@v3

# ℹ️ Command-line programs to run using the OS shell.
# 📚 https://git.io/JvXDl

# ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
# and modify them (or add more) to build your code if your project
# uses a compiled language

#- run: |
# make bootstrap
# make release

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v3
Loading
Loading