Project

gem_toys

0.0
The project is in a healthy, maintained state
Toys template for gems, like building, releasing, etc.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies

Development

~> 2.0
~> 3.9
~> 1.24.1
~> 0.21.2
~> 0.6.0
~> 0.12.0

Runtime

~> 2.0
~> 2.0
 Project Readme

Gem Toys

Cirrus CI - Base Branch Build Status Codecov branch Code Climate Depfu Inline docs license Gem

Toys template for gems, like building, releasing, etc.

Installation

Add this line to your application's Gemfile:

gem 'gem_toys'

And then execute:

bundle install

Or install it yourself as:

gem install gem_toys

Usage

# .toys.rb
require 'gem_toys'
expand GemToys::Template,
  ## default is `CHANGELOG.md`
  changelog_file_name: 'ChangeLog.md',
  ## default is `## Unreleased`
  unreleased_title: '## main (unreleased)',
  ## default is `"lib/#{project_name_with_slashes_instead_dashes}/version.rb"`
  version_file_path: 'lib/my-awesome_gem.rb',
  ## default is `v`, so tags are like `v4.1.0`
  version_tag_prefix: ''

# `gem` namespace created, aliases are optional, but handful
alias_tool :g, :gem

Build

toys gem build builds a gem with the current version and move it to the pkg/ directory.

Install

toys gem install builds a gem and install it locally.

Release

toys gem release does:

  1. Update lib/*gem_name*/version.rb file. Can be refined with :version_file_path option on expand.
  2. Insert Markdown title with changes from ## Unreleased in a CHANGELOG.md file. Can be refined with :unreleased_title option on expand.
  3. Builds a gem.
  4. Ask you for manual check, if you want (print anything of OK). You also can change manually a content of CHANGELOG.md, for example, before committing.
  5. Commit these files.
  6. Tag this commit with vX.Y.Z.
  7. Push git commit and tag.
  8. Push the new gem.

Development

After checking out the repo, run bundle install to install dependencies.

Then, run toys rspec to run the tests.

To install this gem onto your local machine, run toys gem install.

To release a new version, run toys gem release %version%. See how it works here.

Contributing

Bug reports and pull requests are welcome on GitHub.

License

The gem is available as open source under the terms of the MIT License.