1st commit

Author: noraj

.editorconfig

@@ -0,0 +1,16 @@
+# EditorConfig: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+# ruby
+[*.rb]
+charset = utf-8
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true

.github/FUNDING.yml

@@ -0,0 +1,4 @@
+github: noraj
+issuehunt: noraj
+ko_fi: noraj
+liberapay: noraj

.github/dependabot.yml

@@ -0,0 +1,13 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    labels:
+      - "dependency::update"

.github/workflows/documentation.yml

@@ -0,0 +1,45 @@
+name: Documentation
+
+on:
+  push:
+    branches: [ master ]
+
+permissions:
+  contents: read
+  id-token: write
+  pages: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Git checkout
+        uses: actions/checkout@v4 # https://github.com/actions/checkout
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Build Jekyll documentation
+        uses: actions/jekyll-build-pages@v1 # https://github.com/actions/jekyll-build-pages
+        with:
+        destination: output/
+      - name: Ruby setup
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+      - name: Build YARD documentation
+        id: build
+        run: bundle exec yard doc
+      - name: Upload static files as artifact
+        id: deployment
+        uses: actions/upload-pages-artifact@v3 # https://github.com/actions/upload-pages-artifact
+        with:
+          path: output/
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4 # https://github.com/actions/deploy-pages

.github/workflows/tests.yml

@@ -0,0 +1,37 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Tests
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.4', '3.3', '3.2', '3.1']
+    env:
+      BUNDLE_WITHOUT: docs development # https://bundler.io/v1.5/groups.html
+    steps:
+    - uses: actions/checkout@v4 # https://github.com/actions/checkout
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake test
+    - name: Run lint
+      run: bundle exec rubocop

.gitignore

@@ -0,0 +1,3 @@
+playground/
+output/
+*.gem

.rubocop.yml

@@ -0,0 +1,26 @@
+inherit_mode:
+  merge:
+    - Exclude
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable
+  Exclude:
+    - 'playground/*.rb'
+    - 'test/*.rb'
+Gemspec/AddRuntimeDependency:
+  Enabled: false # https://github.com/rubocop/rubocop/pull/13030#discussion_r1674791776
+Layout/HashAlignment:
+  Exclude:
+    - '*.gemspec'
+Layout/SpaceAroundOperators:
+  Exclude:
+    - '*.gemspec'
+Metrics/AbcSize:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/ModuleLength:
+  Enabled: false
+

.tool-versions

@@ -0,0 +1 @@
+ruby 3.4.1

.yardopts

@@ -0,0 +1,7 @@
+--output-dir output/yard
+--markup markdown
+--markup-provider commonmarker
+--plugin coderay
+-
+--main README.md
+LICENSE

Gemfile

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in .gemspec
+# gemspec
+
+# Needed for the CLI only
+group :runtime, :cli do
+  gem 'docopt', '~> 0.6' # for argument parsing
+end
+
+# Needed for the CLI & library
+group :runtime, :all do
+end
+
+# Needed to install dependencies
+group :development, :install do
+  gem 'bundler', '~> 2.1'
+end
+
+# Needed to run tests
+group :development, :test do
+  gem 'minitest', '~> 5.25'
+  gem 'rake', '~> 13.2'
+end
+
+# Needed for linting
+group :development, :lint do
+  gem 'rubocop', '~> 1.75'
+end
+
+group :development, :docs do
+  gem 'commonmarker', '~> 2.0' # for markdown support in YARD
+  gem 'webrick', '~> 1.9' # for yard server
+  # gem 'yard', ['>= 0.9.27', '< 0.10']
+  # https://github.com/lsegal/yard/issues/1528
+  gem 'yard', github: 'ParadoxV5/yard', ref: '9e869c940859570b07b81c5eadd6070e76f6291e', branch: 'commonmarker-1.0'
+  gem 'yard-coderay', '~> 0.1' # for syntax highlight support in YARD
+end