Ruby Gem Template

Tue 2025/03/18 Ruby ruby / cross-platform / template

Overview

• installation: see https://arrizza.com/setup-common.html

Summary

This is a template for a Ruby gem. It contains a set of scripts and configuration files that make creating, developing and maintaining a Ruby gem easier.

• See Quick Start for information on using scripts.
• See xplat.cfg to configure xplat.cfg file.
• See xplat-utils submodule for information on the submodule.

How to use

• create a git for your gem
• use a diff tool like meld, and copy contents from this repo into your gem.
• rename devrb_gem_template directory to your gem's name. Use the contents as a starting point or replace completely with your gem's content
• rename "devrb_gem_template" in source files to your gem's name.

Scripts

# clean it
./do_clean # start from scratch

# install it
./do_subm_update full # first time for submodules
./do_subm_update      # ... thereafter
./do_install full     # first time for OS and gems
./do_install          # ...thereafter

# doc it
./do_doc # generate doxygen html and PDF

# check it
./do_check # check configs and files are okay
./do_lint  # rubocop

# publish it
./do_publish # for ruby gems, publish to rubygems.org
./do_update  # update local gems in venv

# run it
./doit   # run the app/sample code to run the gem
./do_ver # run verification (if implemented)
./do_ut  # run unit tests (if implemented)