https://github.com/alexwayfer/benchmark_toys

Toys template for benchmarks.
https://github.com/alexwayfer/benchmark_toys

Last synced: 4 months ago
JSON representation

Toys template for benchmarks.

• Host: GitHub
• URL: https://github.com/alexwayfer/benchmark_toys
• Owner: AlexWayfer
• License: mit
• Created: 2020-06-12T19:41:22.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2025-04-04T12:50:32.000Z (about 1 year ago)
• Last Synced: 2025-04-09T22:08:34.365Z (about 1 year ago)
• Language: Ruby
• Size: 111 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# Benchmark Toys

[![Cirrus CI - Base Branch Build Status](https://img.shields.io/cirrus/github/AlexWayfer/benchmark_toys?style=flat-square)](https://cirrus-ci.com/github/AlexWayfer/benchmark_toys)

[![Codecov branch](https://img.shields.io/codecov/c/github/AlexWayfer/benchmark_toys/main.svg?style=flat-square)](https://codecov.io/gh/AlexWayfer/benchmark_toys)

[![Code Climate](https://img.shields.io/codeclimate/maintainability/AlexWayfer/benchmark_toys.svg?style=flat-square)](https://codeclimate.com/github/AlexWayfer/benchmark_toys)

[![Inline docs](https://inch-ci.org/github/AlexWayfer/benchmark_toys.svg?branch=main)](https://inch-ci.org/github/AlexWayfer/benchmark_toys)

[![Gem](https://img.shields.io/gem/v/benchmark_toys.svg?style=flat-square)](https://rubygems.org/gems/benchmark_toys)

[![License](https://img.shields.io/github/license/AlexWayfer/benchmark_toys.svg?style=flat-square)](LICENSE.txt)

Toys template for benchmarks.

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'benchmark_toys'

```

And then execute:

```shell

bundle install

```

Or install it yourself as:

```shell

gem install benchmark_toys

```

## Usage

```ruby

require 'benchmark_toys'

expand BenchmarkToys::Template

# `bench` alias is built-in, but you can add additional aliases:

alias_tool :b, :benchmark

```

## 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](https://github.com/AlexWayfer/gem_toys#release).

## Contributing

Bug reports and pull requests are welcome on [GitHub](https://github.com/AlexWayfer/benchmark_toys).

## License

The gem is available as open source under the terms of the

[MIT License](https://opensource.org/licenses/MIT).