Skip to content

Latest commit

 

History

History
115 lines (59 loc) · 2.41 KB

developing_gems.md

File metadata and controls

115 lines (59 loc) · 2.41 KB

Gems

Creating Gems/Rails Engines

When creating a plain Ruby Gem use the Rootstrap's gem generator:

$ gem install rsgem
$ rsgem new [name]

Or use the Bundler command:

$ bundle gem [name]

When creating a Rails Engine use the Rails command:

$ rails plugin new [name] --mountable

Gem version

Keep gem version in a constant and use it like this:

spec.version  = [name]::VERSION

Dependencies versions

Take into account to restrict not only the lower required version of dependencies but also the upper supported version so to not break apps if any of your dependencies changes their API. Normally you should fix just to the major version.

Code quality tools

Make sure to add:

  • Rubocop

  • Reek

Gemfile/Gemfile.lock/gemspec

  • Gemfile should only have the gemspec directive. An exception is when you need to develop against a gem that hasn't yet been released, in this case you can declare that dependency in the Gemfile:
gem  'rack', github:  'rack/rack'

  • Gemfile.lock should be gitignored when developing gems.

  • gemspec is the place to declare dependencies.

Testing

Make the default rake task to run every intended check (tests, code analysis).

bundle exec rake

For testing against different versions of gem dependencies you should add a gemfiles folder and inside it declare each separate Gemfile which can be then used by the CI.

Release a new Gem version

To be able to publish or update your gem in RubyGems, you first need to create a release and tag for your version. You can follow this steps:

  1. Create a new branch for release purpose.
  2. Update your gem VERSION.
    1. Make sure your gemspec spec.version uses this new version.
    2. You can also open a PR if your changes include more than just the version number.
  3. Once your branch is merged, create a tag.
$ git tag v[x.x.x]          # Create a tag for version
$ git push origin v[x.x.x]  # Push the tag to Github

Publishing in RubyGems

First create an account on RubyGems. Then follow the next steps:

$ gem build [gem-name].gemspec          # Build the gem
$ gem push [gem-build].gem              # Push the gem to RubyGems
$ gem owner --add rootstrap [gem-name]  # Add Rootstrap as an Owner