How to create a new Ruby gem?

To create a new Ruby gem, should I use Jeweler or开发者_开发知识库 should I use Bundler's built-in gem skeleton to create a base gem? What are the differences that matter?

Use Bundler

From the command line:

bundle gem your_new_gem

This will create a directory called your_new_gem with just a basic set of files and directory structure that are now considered best-practice. It's quick, easy, and a great place to start.

Creating a Gem isn't that difficult and I would advise to try building a gem from scratch, without any tools. After you know what's involved (creating a gemspec, building and pushing it to rubygems.org), you can use tools to speed up the process. My guess is you won't because making a gem is hardly the trouble at all.

I would go with Jeweler. The Bundler skeleton is only going to give you the basics. Jeweler has alot more options to work with and many helpful rake tasks for versioning, pushing to github, creating the gemspec, building and installing.

If you are working with Rails 3 engines, I have a Jeweler fork (definitely a work-in-progress) that will generate the app skelaton and include the engine file. You just have to run the jeweler command with --rails3-engine as an option. Here is the fork if you are interested:
https://github.com/johnmcaliley/jeweler

I would recommend using the built-in bundler command.

bundle gem your_gem_name

There are some rules that you should follow when creating a gem. Such as naming conventions and versioning rules. I recently wrote a post on creating gems in netguru's blog. I think you'll find what you need in there.

https://netguru.co/blog/posts/creating-a-gem-a-step-by-step-tutorial

Hope this helps.

Here's an alternative that's worth looking at: ore

Bundler gives you a single template for ruby gems, whereas ore has multiple built in templates, plus the ability to create your own. It also supports Git, SVN (urgh) and Mercurial.

You can build a gem in RubyMine too. File > New Project > New Gem. It is that easy. But I want to make some notes about this approach:

For debugging, RubyMine will use the Fast Debugger gem, ruby-debug-ide. I know that most people now are using Pry with Byebug, but ruby-debug-ide is an interface which glues ruby-debug to IDEs like Eclipse (RDT), NetBeans and RubyMine.

Under Run > Edit Configurations > + > Ruby, I add a new debug configuration, according to the documentation here: https://www.jetbrains.com/help/ruby/run-debug-configuration-gem-command.html#1

Under Configuration, under 'Ruby Script', I add the path to the ruby gem file under lib: lib/my_gem.rb Under Configuration, under 'Ruby SDK', I specify an RVM gemset I am using. Under Bundler section, I check 'Run the script in context of bundler'. This would use bundle exec, which will read the dependencies in my Gemfile in my project's root. Now for gems, the Gemfile contains a method call "gemspec", which in turn reads the dependencies in dependencies in my_gem.gemspec. There, I have dependencies passed to the Gem::Specification.new block:

  spec.add_development_dependency "bundler", "~> 1.7"
  spec.add_development_dependency "rake", "~> 10.0"