README.md in gem_bench-1.0.5 vs README.md in gem_bench-2.0.0

- old
+ new

@@ -5,38 +5,53 @@ `gem_bench` can also be used to trim down app load times by keeping your worst players on the bench. Gem: "Put me in coach!" You: ❨╯°□°❩╯︵┻━┻ -| Project | GemBench | -|------------------------ | ----------------------- | -| gem name | [gem_bench](https://rubygems.org/gems/gem_bench) | -| license | [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT) | -| download rank | [![Downloads Today](https://img.shields.io/gem/rd/gem_bench.svg)](https://github.com/pboling/gem_bench) | -| version | [![Version](https://img.shields.io/gem/v/gem_bench.svg)](https://rubygems.org/gems/gem_bench) | -| dependencies | [![Depfu](https://badges.depfu.com/badges/a34c123a78a86496bbc2163b801089dd/count.svg)](https://depfu.com/github/pboling/activerecord-tablefree?project_id=5613) | -| continuous integration | [![Build Status](https://travis-ci.org/pboling/gem_bench.svg?branch=master)](https://travis-ci.org/pboling/gem_bench) | -| test coverage | [![Test Coverage](https://api.codeclimate.com/v1/badges/fe504d4ab2fb77cecf7d/test_coverage)](https://codeclimate.com/github/pboling/gem_bench/test_coverage) | -| maintainability | [![Maintainability](https://api.codeclimate.com/v1/badges/fe504d4ab2fb77cecf7d/maintainability)](https://codeclimate.com/github/pboling/gem_bench/maintainability) | -| code triage | [![Open Source Helpers](https://www.codetriage.com/pboling/gem_bench/badges/users.svg)](https://www.codetriage.com/pboling/gem_bench) | -| homepage | [on Github.com][homepage] | -| documentation | [on Rdoc.info][documentation] | -| inline documenation | [![Inline docs](http://inch-ci.org/github/pboling/gem_bench.png)](http://inch-ci.org/github/pboling/gem_bench) | -| live chat | [![Join the chat at https://gitter.im/pboling/gem_bench](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/pboling/gem_bench?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) | -| expert support | [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/peterboling?utm_source=github&utm_medium=button&utm_term=peterboling&utm_campaign=github) | -| Spread ~♡ⓛⓞⓥⓔ♡~ | [🌍 🌎 🌏](https://about.me/peter.boling), [🍚](https://www.crowdrise.com/helprefugeeswithhopefortomorrowliberia/fundraiser/peterboling), [➕](https://plus.google.com/+PeterBoling/posts), [👼](https://angel.co/peter-boling), [🐛](https://www.topcoder.com/members/pboling/), [:shipit:][coderwall], [![Tweet Peter](https://img.shields.io/twitter/follow/galtzo.svg?style=social&label=Follow)](http://twitter.com/galtzo) | +| Project | GemBench | +|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| gem name | [gem_bench](https://rubygems.org/gems/gem_bench) | +| license | [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT) | +| download rank | [![Downloads Today](https://img.shields.io/gem/rd/gem_bench.svg)](https://github.com/pboling/gem_bench) | +| version | [![Version](https://img.shields.io/gem/v/gem_bench.svg)](https://rubygems.org/gems/gem_bench) | +| dependencies | [![Depfu](https://badges.depfu.com/badges/865e7bb1d0d3eb3ba807fca7344e22d1/overview.svg)](https://depfu.com/github/pboling/gem_bench?project_id=5613) | +| continuous integration | [![Current][🚎cwfi]][🚎cwf] [![Heads][🖐hwfi]][🖐hwf] [![Style][🧮swfi]][🧮swf] [![Coverage][📗cov-wfi]][📗cov-wf] | +| test coverage | [![Test Coverage](https://api.codeclimate.com/v1/badges/80787f126e7a486b19af/test_coverage)](https://codeclimate.com/github/pboling/gem_bench/test_coverage) | +| maintainability | [![Maintainability](https://api.codeclimate.com/v1/badges/80787f126e7a486b19af/maintainability)](https://codeclimate.com/github/pboling/gem_bench/maintainability) | +| code triage | [![Open Source Helpers](https://www.codetriage.com/pboling/gem_bench/badges/users.svg)](https://www.codetriage.com/pboling/gem_bench) | +| homepage | [on Github.com][homepage] | +| documentation | [on Rdoc.info][documentation] | +| live chat | [![Join the chat][🏘chati]][🏘chat] | +| expert support | [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/peterboling?utm_source=github&utm_medium=button&utm_term=peterboling&utm_campaign=github) | +| Spread ~♡ⓛⓞⓥⓔ♡~ | [🌏](https://about.me/peter.boling), [👼](https://angel.co/peter-boling), [![Tweet Peter](https://img.shields.io/twitter/follow/galtzo.svg?style=social&label=Follow)](http://twitter.com/galtzo) | +[🚎cwf]: https://github.com/rubocop-lts/rubocop-lts/actions/workflows/current.yml +[🚎cwfi]: https://github.com/rubocop-lts/rubocop-lts/actions/workflows/current.yml/badge.svg +[🖐hwf]: https://github.com/rubocop-lts/rubocop-lts/actions/workflows/heads.yml +[🖐hwfi]: https://github.com/rubocop-lts/rubocop-lts/actions/workflows/heads.yml/badge.svg +[🧮swf]: https://github.com/rubocop-lts/rubocop-lts/actions/workflows/style.yml +[🧮swfi]: https://github.com/rubocop-lts/rubocop-lts/actions/workflows/style.yml/badge.svg +[📗cov-wf]: https://github.com/rubocop-lts/rubocop-lts/actions/workflows/coverage.yml +[📗cov-wfi]: https://github.com/rubocop-lts/rubocop-lts/actions/workflows/coverage.yml/badge.svg +[🏘chat]: https://matrix.to/#/%23pboling_gem_bench:gitter.im +[🏘chati]: https://badges.gitter.im/Join%20Chat.svg + +### New for 2.0.0 - Dropped Support for Ruby 2.0, 2.1, 2.2 + +-- Required Ruby is now 2.3+ +- `VERSION` is now namespaced at `GemBench::Version::VERSION` and is enhanced by `version_gem`. + ### New for 1.0.2 - Gemfile specs Version constraints are important. Give the Gemfile some love in your CI build Create a `spec/gemfile_spec.rb` like: ```ruby -Rspec.describe "Gemfile" do +Rspec.describe("Gemfile") do it("has version constraint on every gem") do requirements = GemBench::StrictVersionRequirement.new({verbose: false}) - expect(requirements.list_missing_version_constraints).to eq([]) + expect(requirements.list_missing_version_constraints).to(eq([])) end end ``` Then your build will fail as soon as a gem is added without a proper constraint: @@ -115,11 +130,11 @@ gem 'gem_bench', :group => :test ## Usage -Works with Ruby >= 2.0 due to use of named parameters. +Works with Ruby >= 2.3. ### Example! Getting tired of seeing this `irb` warning, perhaps? @@ -363,30 +378,23 @@ ## Future This gem determines which gems need to be loaded at Rails' boot time by looking for Railties and Engines. A future version will also look for initializers, because gems which have code that runs (e.g. configuration) in an initializer also need to be loaded at boot time. -## Development +## Contributors -After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. +[![Contributors](https://contrib.rocks/image?repo=pboling/gitmoji-regex)][🖐contributors] -To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). +Made with [contributors-img][contrib-rocks]. +[🖐contributors]: https://github.com/pboling/gem_bench/graphs/contributors +[contrib-rocks]: https://contrib.rocks + ## Contributing -Bug reports and pull requests are welcome on GitHub at https://github.com/pboling/gem_bench. +See [CONTRIBUTING.md](CONTRIBUTING.md) -If you see: `is feeling very lost right now` then I'd like to know. -Create an issue and tell me about it, or fix it yo'sef. - -1. Fork it -2. Create your feature branch (`git checkout -b my-new-feature`) -3. Commit your changes (`git commit -am 'Added some feature'`) -4. Push to the branch (`git push origin my-new-feature`) -5. Make sure to add tests for it. This is important so I don't break it in a future version unintentionally. -6. Create new Pull Request - ## Versioning This library aims to adhere to [Semantic Versioning 2.0.0][semver]. Violations of this scheme should be reported as bugs. Specifically, if a minor or patch version is released that breaks backward @@ -397,15 +405,17 @@ As a result of this policy, you can (and should) specify a dependency on this gem using the [Pessimistic Version Constraint][pvc] with two digits of precision. For example: - spec.add_dependency 'gem_bench', '~> 0.0' + spec.add_dependency 'gem_bench', '~> 2.0' +See [CHANGELOG.md](CHANGELOG.md) for list of releases. + ## Legal * [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT) -* Copyright (c) 2013 - 2018 [Peter H. Boling][peterboling] of [Rails Bling][railsbling] +* Copyright (c) 2013 - 2014, 2016 - 2020, 2023 [Peter H. Boling][peterboling] of [Rails Bling][railsbling] [semver]: http://semver.org/ [pvc]: http://docs.rubygems.org/read/chapter/16#page74 [bundle-group-pattern]: https://gist.github.com/pboling/4564780 [railsbling]: http://www.railsbling.com