# Gemsmith [](http://badge.fury.io/rb/gemsmith) [](https://codeclimate.com/github/bkuhlmann/gemsmith/maintainability) [](https://codeclimate.com/github/bkuhlmann/gemsmith/test_coverage) [](https://circleci.com/gh/bkuhlmann/gemsmith) A command line interface for smithing new Ruby gems. ## Table of Contents - [Features](#features) - [Screencasts](#screencasts) - [Requirements](#requirements) - [Setup](#setup) - [Install](#install) - [Configuration](#configuration) - [Existing Gems](#existing-gems) - [Usage](#usage) - [Command Line Interface (CLI)](#command-line-interface-cli) - [Rake](#rake) - [Tests](#tests) - [Security](#security) - [Git Signing Key](#git-signing-key) - [Gem Certificates](#gem-certificates) - [Private Gem Servers](#private-gem-servers) - [Gem Specification Metadata](#gem-specification-metadata) - [Gem Credentials](#gem-credentials) - [Promotion](#promotion) - [Troubleshooting](#troubleshooting) - [Versioning](#versioning) - [Code of Conduct](#code-of-conduct) - [Contributions](#contributions) - [License](#license) - [History](#history) - [Credits](#credits) ## Features - Builds a gem skeleton with enhanced Bundler functionality. - Uses [Refinements](https://github.com/bkuhlmann/refinements) Ruby core library enhancements. - Uses [Versionaire](https://github.com/bkuhlmann/versionaire) for semantic versioning. - Uses [Runcom](https://github.com/bkuhlmann/runcom) for resource configuration management. - Uses [Milestoner](https://github.com/bkuhlmann/milestoner) for consistent project/gem versioning. - Uses [Pragmater](https://github.com/bkuhlmann/pragmater) for Ruby source pragma directives. - Uses [Tocer](https://github.com/bkuhlmann/tocer) for README table of contents generation. - Supports [Bundler Audit](https://github.com/rubysec/bundler-audit). - Supports [Circle CI](https://circleci.com). - Supports [Code Climate](https://codeclimate.com). - Supports [Git Cop](https://github.com/bkuhlmann/git-cop). - Supports [GitHub](https://github.com). - Supports [Guard](https://github.com/guard/guard). - Supports [Pry](http://pryrepl.org). - Supports [Reek](https://github.com/troessner/reek). - Supports [RSpec](http://rspec.info). - Supports [Rubocop](https://github.com/rubocop-hq/rubocop). - Supports [Rubocop RSpec](https://github.com/rubocop-hq/rubocop-rspec). - Supports [Ruby on Rails](http://rubyonrails.org). - Supports [RubyGems Security](http://guides.rubygems.org/security). - Supports [Thor](https://github.com/erikhuda/thor). - Supports common settings and a structured layout for building gems. - Supports publishing to public or private gem servers. - Provides common documentation: - [README](README.md) - [CHANGES](CHANGES.md) - [CONTRIBUTING](CONTRIBUTING.md) - [CODE OF CONDUCT](CODE_OF_CONDUCT.md) - [LICENSE](LICENSE.md) - Aids in viewing source code of semantically versioned gems within your favorite editor. - Aids in viewing documentation of semantically versioned within your default browser. ## Screencasts [](https://asciinema.org/a/173862) ## Requirements 1. A UNIX-based system. 1. [Ruby 2.6.x](https://www.ruby-lang.org). 1. [RubyGems](https://rubygems.org). 1. [Bundler](https://github.com/bundler/bundler). ## Setup ### Install Type the following to install: gem install gemsmith ### Configuration This gem can be configured via a global configuration: ~/.config/gemsmith/configuration.yml It can also be configured via [XDG](https://github.com/bkuhlmann/xdg) environment variables. The default configuration is as follows: :year: :github_user: "", :gem: :label: "Undefined" :name: "undefined" :path: "undefined" :class: "Undefined" :platform: "Gem::Platform::RUBY" :url: "https://github.com//" :license: "MIT" :author: :name: "" :email: "" :url: "" :organization: :name: "" :url: "" :versions: :ruby: "" :rails: "5.1" :generate: :bundler_audit: true :circle_ci: false :cli: false :code_climate: false :engine: false :git_cop: true :git_hub: true :guard: true :pry: true :reek: true :rspec: true :rubocop: true :security: false :publish: :sign: false Feel free to take this default configuration, modify, and save as your own custom `configuration.yml`. ### Existing Gems If you have gems that were not originally crafted by Gemsmith, you can add Gemsmith support to them by modifying the following files: Add the following to your gem's `*.gemspec` file: spec.add_development_dependency "gemsmith" Replace or add a modified version of the following to your gem's `Rakefile`: # frozen_string_literal: true begin require "gemsmith/rake/setup" rescue LoadError => error puts error.message end *NOTE: Ensure `require "bundler/gem_tasks"` is removed as Gemsmith replaces Bundler functionality.* With those changes, you can leverage the benefits of Gemsmith within your existing gem. ## Usage ### Command Line Interface (CLI) From the command line, type: `gemsmith --help` gemsmith -c, [--config] # Manage gem configuration. gemsmith -g, [--generate=GEM] # Generate new gem. gemsmith -h, [--help=COMMAND] # Show this message or get help for a command. gemsmith -o, [--open=GEM] # Open a gem in default editor. gemsmith -r, [--read=GEM] # Open a gem in default browser. gemsmith -v, [--version] # Show gem version. For more gem generation options, type: `gemsmith --help --generate` [--bundler-audit], [--no-bundler-audit] # Add Bundler Audit support. # Default: true [--circle-ci], [--no-circle-ci] # Add Circle CI support. [--cli], [--no-cli] # Add CLI support. [--code-climate], [--no-code-climate] # Add Code Climate support. [--engine], [--no-engine] # Add Rails Engine support. [--git-cop], [--no-git-cop] # Add Git Cop support. # Default: true [--git-hub], [--no-git-hub] # Add GitHub support. # Default: true [--guard], [--no-guard] # Add Guard support. # Default: true [--pry], [--no-pry] # Add Pry support. # Default: true [--reek], [--no-reek] # Add Reek support. # Default: true [--rspec], [--no-rspec] # Add RSpec support. # Default: true [--rubocop], [--no-rubocop] # Add Rubocop support. # Default: true [--security], [--no-security] # Add security support. ### Rake Once a gem skeleton has been created, the following tasks are available (i.e. `bundle exec rake -T`): rake build # Build example-0.1.0.gem package rake bundle:audit # Updates the ruby-advisory-db then runs bundle-audit rake clean # Clean gem artifacts rake code_quality # Run code quality checks rake git_cop # Run Git Cop rake install # Install example-0.1.0.gem package rake publish # Build, tag as 0.1.0 (unsigned), and push example-0.1.0.gem to RubyGems rake reek # Check for code smells rake rubocop # Run RuboCop rake rubocop:auto_correct # Auto-correct RuboCop offenses rake spec # Run RSpec code examples rake toc # Update Table of Contents (README) *NOTE: Some tasks might differ depending on what options you enabled/disabled during gem generation.* When building/testing your gem locally, a typical workflow is: 1. `bundle exec rake install` 1. Test your gem locally. 1. Repeat until satisfied. When satified with your gem, builds are green, and ready to publish, run: bundle exec rake publish ## Tests To test, run: bundle exec rake ## Security ### Git Signing Key To securely sign your Git tags, install and configure [GPG](https://www.gnupg.org): brew install gpg gpg --gen-key When creating your GPG key, choose these settings: - Key kind: RSA and RSA (default) - Key size: 4096 - Key validity: 0 - Real Name: `` - Email: `` - Passphrase: `` To obtain your key, run the following and take the part after the forward slash: gpg --list-keys | grep pub Add your key to your global Git configuration in the `[user]` section. Example: [user] signingkey = Now, when publishing your gems with Gemsmith (i.e. `bundle exec rake publish`), signing of your Git tag will happen automatically. You will be prompted for the GPG Passphrase each time but that is to be expected. ### Gem Certificates To create a certificate for your gems, run the following: cd ~/.ssh gem cert --build you@example.com chmod 600 gem-*.pem The resulting `*.pem` key files can be referenced via the `:private_key:` and `:public_key:` keys within the `~/.gemsmithrc` file. To learn more about gem certificates, read about RubyGems [Security](http://guides.rubygems.org/security). ## Private Gem Servers By default, the following Rake task will publish your gem to [RubyGems](https://rubygems.org): bundle exec rake publish You can change this behavior by adding metadata to your gemspec that will allow the Rake tasks, mentioned above, to publish your gem to an alternate/private gem server instead. This can be done by updating your gem specification and RubyGems credentials. ### Gem Specification Metadata Add the following metadata to your gemspec: Gem::Specification.new do |spec| spec.metadata = { "allowed_push_key" => "example_key", "allowed_push_host" => "https://gems.example.com" } end The gemspec metadata keys and values *must* be strings per the [RubyGems Specification](http://guides.rubygems.org/specification-reference/#metadata). Each key represents the following: - `allowed_push_key`: Provides a reference (look up) to the key defined the RubyGems credentials file so that sensitive credentials are not used within your gemspec. - `allowed_push_host`: Provides the URL of the private gem server to push your gem to. ### Gem Credentials With your gem specification metadata established, you are ready to publish your gem to a public or private server. If this is your first time publishing a gem and no gem credentials have been configured, you'll be prompted for them. Gem credentials are stored in the RubyGems `~/.gem/credentials` file. From this point forward, future gem publishing will use your stored credentials instead. Multiple credentials can be stored in the `~/.gem/credentials` file. Example: --- :rubygems_api_key: 2a0b460650e67d9b85a60e183defa376 :example_key: "Basic dXNlcjpwYXNzd29yZA==" Should you need to delete a credential (due to a bad login/password for example), you can open the `~/.gem/credentials` in your default editor and remove the line(s) you don't need. Upon next publish of your gem, you'll be prompted for the missing credentials. ## Promotion Once your gem is released, let the world know about your accomplishment by posting an update to these sites: - [RubyFlow](http://www.rubyflow.com) - [Ruby Library Hunt](https://ruby.libhunt.com) - [RubyDaily](http://rubydaily.org) - [Awesome Ruby](https://awesome-ruby.com) - [Ruby Toolbox](https://www.ruby-toolbox.com) - [Ruby Community](https://www.ruby-lang.org/en/community) ## Troubleshooting When running `bundle exec rake install` or `bundle exec rake publish` with modified, staged, or uncommitted Git changes, the rake task will throw an error to this effect. When this occurs, it is recommended that you commit your changes or [stash](https://git-scm.com/docs/git-stash) them before proceeding. ## Versioning Read [Semantic Versioning](https://semver.org) for details. Briefly, it means: - Major (X.y.z) - Incremented for any backwards incompatible public API changes. - Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes. - Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes. ## Code of Conduct Please note that this project is released with a [CODE OF CONDUCT](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms. ## Contributions Read [CONTRIBUTING](CONTRIBUTING.md) for details. ## License Copyright 2011 [Alchemists](https://www.alchemists.io). Read [LICENSE](LICENSE.md) for details. ## History Read [CHANGES](CHANGES.md) for details. ## Credits Developed by [Brooke Kuhlmann](https://www.alchemists.io) at [Alchemists](https://www.alchemists.io).