# Overview
[](http://badge.fury.io/rb/gemsmith)
[](https://codeclimate.com/github/bkuhlmann/gemsmith)
[](http://travis-ci.org/bkuhlmann/gemsmith)
Gemsmith allows you to easily craft new gems via the command line with custom settings (if desired). If you are
a fan of [Bundler](https://github.com/carlhuda/bundler), then you'll appreciate the additional capabilities of this
gem. Gemsmith is essentially an enhanced version of Bundler's gem building capabilities.
# Features
* Builds a gem skeleton with Bundler functionality in mind.
* Supports common settings that can be applied to new gem creations.
* Supports binary skeletons with [Thor](https://github.com/wycats/thor) command line functionality.
* Supports [Ruby on Rails](http://rubyonrails.org).
* Supports [RSpec](http://rspec.info).
* Supports [Pry](http://pryrepl.org).
* Supports [Guard](https://github.com/guard/guard).
* Supports [Code Climate](https://codeclimate.com).
* Supports [Travis CI](http://travis-ci.org) skeletons.
* Adds commonly needed README, CHANGELOG, LICENSE, etc. template files.
* Provides the ability to open any installed gem within your favorite editor.
# Requirements
1. A UNIX-based system.
2. [Ruby 2.x.x](http://www.ruby-lang.org).
3. [RubyGems](http://rubygems.org).
4. [Bundler](https://github.com/carlhuda/bundler).
# Setup
Type the following from the command line to securely install (recommended):
gem cert --add <(curl -Ls http://www.redalchemist.com/gem-public.pem)
gem install gemsmith -P HighSecurity
...or type the following to insecurely install (not recommended):
gem install gemsmith
You can configure common settings for future gem builds by creating the following file:
~/.gemsmith/settings.yml
...using the following settings (for example):
---
:author_name: Brooke Kuhlmann
:author_email: brooke@redalchemist.com
:author_url: http://www.redalchemist.com
:company_name: Red Alchemist
If no options are configured, then the defaults are as follows:
gem_platform: Gem::Platform::RUBY
author_name: <git name>
author_email: <git email>
author_url: https://www.unknown.com
gem_url: <author URL>
company_name: <author name>
company_url: <author URL>
github_user: <github user>
year: <current year>
ruby_version: 2.0.0
ruby_patch: p0
rails_version: 3.2.0
# Usage
From the command line, type: gemsmith help
gemsmith -c, [create=GEM_NAME] # Create new gem.
gemsmith -e, [edit] # Edit gem settings in default editor (assumes $EDITOR environment variable).
gemsmith -h, [help] # Show this message.
gemsmith -o, [open=NAME] # Opens gem in default editor (assumes $EDITOR environment variable).
gemsmith -r, [read=NAME] # Opens gem in default browser.
gemsmith -v, [version] # Show version.
For more gem creation options, type: gemsmith help create
-b, [--bin] # Add binary support.
-r, [--rails] # Add Rails support.
-p, [--pry] # Add Pry support.
# Default: true
-g, [--guard] # Add Guard support.
# Default: true
-s, [--rspec] # Add RSpec support.
# Default: true
-t, [--travis] # Add Travis CI support.
# Default: true
-c, [--code-climate] # Add Code Climate support.
# Default: true
Also, don't forget that once you have created your gem skeleton, the following rake tasks are also
available to you via Bundler (i.e. rake -T):
rake build # Build <gem>-<version>.gem into the pkg directory
rake install # Build and install <gem>-<version>.gem into system gems
rake release # Create tag v0.1.1 and build and push <gem>-<version>.gem to Rubygems
# Tests
To test, do the following:
0. cd to the gem root.
0. bundle install
0. bundle exec rspec spec
# Best Practices
0. [Semantic Versioning](http://semver.org)
0. [Best Practices While Cutting Gems](http://rubysource.com/crafting-rubies-best-practices-while-cutting-gems).
0. [Ruby on Rails Gem Packaging](http://weblog.rubyonrails.org/2009/9/1/gem-packaging-best-practices).
0. [Gem Activation and You: Part I](http://erik.hollensbe.org/2013/05/11/gem-activation-and-you)
0. [Gem Activation and You: Part II](http://erik.hollensbe.org/2013/05/15/gem-activation-and-you-part-2-bundler-and-binstubs)
0. [Why You Should Use a BSD Style License](http://www.freebsd.org/doc/en/articles/bsdl-gpl/article.html).
0. Add -w to the RUBYOPT environment variable when testing. [Details](http://avdi.org/devblog/2011/06/23/how-ruby-helps-you-fix-your-broken-code).
## When To Include a Railtie ([Crafting Rails Applications](http://pragprog.com/book/jvrails/crafting-rails-applications) - Page 93 by José Valim)
* "Your gem needs to perform a given task while or after the Rails application is initialized."
* "Your gem needs to change a configuration value, such as setting a generator."
* "Your gem must provide Rake tasks and generators in nondefault locations (the default location for the former is lib/tasks and lib/gen- erators or lib/rails/generators for the latter)."
* "You want your gem to provide configuration options to the appli- cation, such as config.my_gem.key # :value."
# Documentation
In order to make your gem easier to use and adopt by others, good documentation is always a plus. Consider submitting
your gem to RubyDocs[http://rubydoc.info] once your gem is released and available for use. RubyDocs supports both
RDoc and YARD formats.
# Promotion
Once your gem is released, you might like to let the world know about the new awesomeness. Here are several resources:
* [How to Spread the Word About Your Code](https://hacks.mozilla.org/2013/05/how-to-spread-the-word-about-your-code)
* [Ruby Toolbox](https://www.ruby-toolbox.com)
* [RubyFlow](http://www.rubyflow.com)
* [The Ruby Show](http://rubyshow.com)
* [Ruby 5](http://ruby5.envylabs.com)
# Versioning
Read [Semantic Versioning](http://semver.org) for details. Briefly, it means:
* Patch (x.y.Z) - Incremented for small, backwards compatible bug fixes.
* Minor (x.Y.z) - Incremented for new, backwards compatible public API enhancements and/or bug fixes.
* Major (X.y.z) - Incremented for any backwards incompatible public API changes.
# Contributions
Read CONTRIBUTING for details.
# Credits
Developed by [Brooke Kuhlmann](http://www.redalchemist.com) at [Red Alchemist](http://www.redalchemist.com).
# License
Copyright (c) 2011 [Red Alchemist](http://www.redalchemist.com).
Read the LICENSE for details.
# History
Read the CHANGELOG for details.