Create and publish your first Ruby gem

Run RubyMine and click New Project on the Welcome Screen.

In the New Project dialog, select Gem on the left pane and specify the following settings:

• Location: Specify a project's location and name (hello_rubymine in our case).

• Ruby SDK: Select a required Ruby interpreter.

note

If the Bundler gem is not installed to the selected interpreter, RubyMine will automatically install it upon the project creation.

After you’ve specified all the options, click Create in the New Project dialog. RubyMine will create a new Gem application.

To open hello_rubymine.rb, press CtrlShift0N, start typing hello_rubymine.rb, select this file, and click Enter.

In the opened lib/hello_rubymine.rb file, add the following code:

require "hello_rubymine/version"

module HelloRubymine
    def self.greet(name)
        puts "Hello, #{name}! I'm Ruby!"
    end
end

Press CtrlShift0N, start typing hello_rubymine.gemspec, select the hello_rubymine.gemspec file, and click Enter

In the opened hello_rubymine.gemspec file, specify the required gemspec attributes.

For our sample gem, we've specified the following fields:

• authors: A gem's author(s).

• email: An email address.

• summary: A short gem's description

• homepage: The URL of the gem's home page. We'll specify this address later after publishing the gem's code to GitHub.

• metadata["source_code_uri"]: The gem's source code URI. We'll use the same value as for the homepage.

• metadata["allowed_push_host"]: We removed this string from *.gemspec for publishing to RubyGems.

From the main menu, select Git | Share Project on GitHub.

In the invoked dialog, specify the name of the repository to be created on GitHub. Then, select the required account in the Share by field and click the Share button.

In the next dialog, you will be prompted to choose files for the initial commit. Leave the default set of files, specify the commit message, and click Add. Then, wait until a project is pushed to GitHub.

After the project is created on GitHub, provide the homepage and metadata["source_code_uri"] attributes in the project's *.gemspec file (https://github.com/rubyminedoc/hello_rubymine in our case). Then, commit and push changes made in *.gemspec.

From the main menu, go to Tools | Gem | Build Gem.

In the invoked dialog, click the Build button to build the gem. RubyMine will display the information about the created gem in the Run tool window.

You can see the created gem in the Project view (Alt01).

From the main menu, go to Tools | Run IRB Console.

Type require 'hello_rubymine' and press Enter to load our gem to IRB.

Then, type HelloRubymine.greet("JetBrains") in a console and press Enter again to make sure our gem works as expected.

From the main menu, select Tools | Gem | Push Gem.

In the Run tool window, specify your RubyGems credentials.

Your gem will be published to RubyGems.org.