DEV Community

Davide Santangelo
Davide Santangelo

Posted on

Creating a Ruby Gem: A Step-by-Step Guide with Detailed Instructions


Ruby Gems serve as the cornerstone of the Ruby programming ecosystem, providing a structured means of packaging and disseminating reusable code. Developing your own Ruby Gem can be an empowering endeavor, affording you the ability to encapsulate functionality into easily distributable components. In this article, we will comprehensively outline the process of creating a fully operational Ruby Gem from the ground up. This guide will include the implementation of robust test code to ensure the gem's functionality.

Setting Up Your Development Environment

Before embarking on the creation of your Ruby Gem, it is essential to ascertain that both Ruby and RubyGems are installed on your system. A simple verification can be accomplished through the execution of the following commands in your terminal:

ruby -v
gem -v
Enter fullscreen mode Exit fullscreen mode

Should these commands yield version numbers, your system is adequately equipped. If not, it is imperative to install Ruby and RubyGems before proceeding.

Creating the gem

To initiate the creation of your Ruby Gem, the bundle gem command can be employed. This command is made available through the Bundler gem. Open your terminal, navigate to your desired directory for gem creation, and execute the following steps:

gem install bundler
bundle gem my_awesome_gem
cd my_awesome_gem
Enter fullscreen mode Exit fullscreen mode

In the provided code snippet, replace my_awesome_gem with your preferred gem name.

Defining Functionality

Upon setting up the basic gem structure, focus shifts to defining the gem's core functionality. The my_awesome_gem.rb file within the lib directory will house the gem's functionality. For the sake of illustration, let's create a file named my_awesome_gem.rb with the following content:

# lib/my_awesome_gem.rb
module MyAwesomeGem
  def self.greet
    "Hello from My Awesome Gem!"
Enter fullscreen mode Exit fullscreen mode

Adding Tests

Integral to the creation of a reliable gem is the implementation of comprehensive testing. The built-in minitest framework will be utilized for this purpose. Create a test directory and a corresponding test file as demonstrated:

mkdir test
touch test/test_my_awesome_gem.rb
Enter fullscreen mode Exit fullscreen mode

Edit the test_my_awesome_gem.rb file to integrate tests for the gem's functionality:

# test/test_my_awesome_gem.rb
require 'minitest/autorun'
require 'my_awesome_gem'

class TestMyAwesomeGem < Minitest::Test
  def test_greet
    assert_equal "Hello from My Awesome Gem!", MyAwesomeGem.greet
Enter fullscreen mode Exit fullscreen mode

Building and Installing the Gem

In order to build and locally install the gem for testing, execute the ensuing commands:

gem build my_awesome_gem.gemspec
gem install ./my_awesome_gem-x.x.x.gem
Enter fullscreen mode Exit fullscreen mode

Ensure that x.x.x is substituted with the actual version number of your gem.

Publishing the Gem

Prior to publishing, it is necessary to possess a RubyGems account. If you do not have one, you can create an account at

Once logged in, utilize the following command to push your gem to RubyGems:

gem push my_awesome_gem-x.x.x.gem
Enter fullscreen mode Exit fullscreen mode


The process of creating a Ruby Gem is an empowering endeavor, enabling you to contribute to the Ruby community by sharing your code. By diligently following the detailed steps presented in this guide, you have learned how to establish your development environment, define functionality, incorporate robust testing, build, install, and ultimately publish your gem. This process promotes code reusability, fosters collaboration, and facilitates personal growth as a developer. Best of luck on your gem creation journey!

Top comments (0)