更新日: 2017年3月16日
Ruby

Gemの作り方(Ruby Gem)

Ruby で通常の gem を作る方法です。Bundler を使った Ruby Gem の作り方を解説します。Bundler を使うので、入ってなければ前もってインストールしておきます。

bundler のインストール。


$ gem install bundler

$ gem install bundler

— 環境 —
bundler 1.14.4
rake 12.0.0

【お知らせ】英単語を画像イメージで楽に暗記できる辞書サイトを作りました。英語学習中の方は、ぜひご利用ください！

画像付き英語辞書 Imagict | 英単語をイメージで暗記
【開発記録】
英単語を画像イメージで暗記できる英語辞書サービスを作って公開しました

Gem のテンプレートを生成

まずは、bundle gem コマンドで gem の雛形を生成します。–test オプションを付けると、spec が共に生成される。


$ bundle gem sample-mygem --test
Creating gem 'sample-mygem'...
MIT License enabled in config
Code of conduct enabled in config
      create  sample-mygem/Gemfile
      create  sample-mygem/.gitignore
      create  sample-mygem/lib/sample/mygem.rb
      create  sample-mygem/lib/sample/mygem/version.rb
      create  sample-mygem/sample-mygem.gemspec
      create  sample-mygem/Rakefile
      create  sample-mygem/README.md
      create  sample-mygem/bin/console
      create  sample-mygem/bin/setup
      create  sample-mygem/.travis.yml
      create  sample-mygem/.rspec
      create  sample-mygem/spec/spec_helper.rb
      create  sample-mygem/spec/sample/mygem_spec.rb
      create  sample-mygem/LICENSE.txt
      create  sample-mygem/CODE_OF_CONDUCT.md
Initializing git repo in /path/to/sample-mygem

$ bundle gem sample-mygem --test

Creating gem 'sample-mygem'...

MIT License enabled in config

Code of conduct enabled in config

create sample-mygem/Gemfile

create sample-mygem/.gitignore

create sample-mygem/lib/sample/mygem.rb

create sample-mygem/lib/sample/mygem/version.rb

create sample-mygem/sample-mygem.gemspec

create sample-mygem/Rakefile

create sample-mygem/README.md

create sample-mygem/bin/console

create sample-mygem/bin/setup

create sample-mygem/.travis.yml

create sample-mygem/.rspec

create sample-mygem/spec/spec_helper.rb

create sample-mygem/spec/sample/mygem_spec.rb

create sample-mygem/LICENSE.txt

create sample-mygem/CODE_OF_CONDUCT.md

Initializing git repo in /path/to/sample-mygem

sample-mygem とハイフン区切りの gem 名にした場合は、ハイフンが lib/sample/mygem.rb とディレクトリに分割されて lib 以下のファイルが生成されます。区切りなしや、_（アンダースコア）区切りの場合はディレクトリ分割されません。

依存する gem を gemspec ファイルに追記

gemspec ファイルは gem の仕様書となるファイルです。依存関係の仕様を明確にするために、このファイルにこれから作る gem が依存する gem を追記します。

sample-mygem.gemspec

Gem::Specification.new do |spec|
  # ...
  spec.add_dependency 'httpclient', '>= 2.6'
  spec.add_development_dependency 'rake', '~> 10.0'
end

Gem::Specification.new do |spec|

# ...

spec.add_dependency 'httpclient', '>= 2.6'

spec.add_development_dependency 'rake', '~> 10.0'

end

開発環境にのみ必要な gem は add_development_dependency で追加する。依存する gem は、gemspec で解決されるので Gemfile には書かないようにしました。

続いて bundler で gem をインストール。vendor/bundle ディレクトリ以下にインストールします。


$ bundle install --path vendor/bundle

$ bundle install --path vendor/bundle

.gitignore に vendor/bundle ディレクトリを追加しておく。

.gitignore


/vendor/bundle/

/vendor/bundle/

プライベートな gem で RubyGems(rubygems.org) に公開しない場合

RugyGems に公開しない場合は、gemspec の metadata[‘allowed_push_host’] に push するサーバーを設定します。

sample-mygem.gemspec

# Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
# to allow pushing to a single host or delete this section to allow pushing to any host.
if spec.respond_to?(:metadata)
  spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
else
  raise "RubyGems 2.0 or newer is required to protect against " \
    "public gem pushes."
end

# Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'

# to allow pushing to a single host or delete this section to allow pushing to any host.

if spec.respond_to?(:metadata)

spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"

else

raise "RubyGems 2.0 or newer is required to protect against " \

"public gem pushes."

end

RubyGems に公開する場合は、上記コード(if ~ else ~ end) を削除します。

gemspec の Author 情報等を編集

gemspec ファイルには、Author 情報（開発者）や gem の説明なども書きます。それらの情報を適切に編集する。最終的に sample-mygem.gemspec は以下のような内容になりました。

sample-mygem.gemspec

# coding: utf-8
lib = File.expand_path('../lib', __FILE__)
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
require 'sample/mygem/version'

Gem::Specification.new do |spec|
  spec.name          = "sample-mygem"
  spec.version       = Sample::Mygem::VERSION
  spec.authors       = ["author name"]
  spec.email         = ["develper_name@example.com"]

  spec.summary       = 'summary'
  spec.description   = 'description'
  spec.homepage      = 'http://example.com'
  spec.license       = "MIT"

  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
    f.match(%r{^(test|spec|features)/})
  end
  spec.bindir        = "exe"
  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
  spec.require_paths = ["lib"]

  spec.add_development_dependency "bundler", "~> 1.14"
  spec.add_development_dependency "rake", "~> 10.0"
end

# coding: utf-8

lib = File.expand_path('../lib', __FILE__)

$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)

require 'sample/mygem/version'

Gem::Specification.new do |spec|

spec.name = "sample-mygem"

spec.version = Sample::Mygem::VERSION

spec.authors = ["author name"]

spec.email = ["[email protected]"]

spec.summary = 'summary'

spec.description = 'description'

spec.homepage = 'http://example.com'

spec.license = "MIT"

spec.files = `git ls-files -z`.split("\x0").reject do |f|

f.match(%r{^(test|spec|features)/})

end

spec.bindir = "exe"

spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }

spec.require_paths = ["lib"]

spec.add_development_dependency "bundler", "~> 1.14"

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

end

gemspec に TODO や FIXME などの単語が残っていると、gem 実行時にエラーとなるので修正する。GitHub に OSS として公開する場合は、homepage に GitHub のリポジトリ URL を指定すると良いです。

gem 本体の作成

続いて、gem 本体となる lib ディレクトリ以下のファイルを、Ruby コードで作成していきます。

lib/sample/mygem.rb

require "sample/mygem/version"

module Sample
  module Mygem
    # Your code goes here...
    def self.greet
      puts 'Hello Rubygem !'
    end
  end
end

require "sample/mygem/version"

module Sample

module Mygem

# Your code goes here...

def self.greet

puts 'Hello Rubygem !'

end

今回はサンプルなので、Hello Rubygem ! と挨拶を出力するだけの機能です。

実行可能なコマンドを作成

実行可能なコマンドは、bin ディレクトリ内に作って実行権を付与します。こちらもサンプルなので、hello とだけ出力するコマンドを作る例。

bin/hello


#!/usr/bin/env bash

echo 'hello'

#!/usr/bin/env bash

echo 'hello'


$ chmod 755 bin/hello

$ chmod 755 bin/hello

実行。


$ bin/hello
hello

$ bin/hello

hello

バージョン番号の指定

lib/sample/mygem/version.rb

上記ファイルに、gem の version 番号を書いてアップデートしていきます。

README.md を作成

マークダウンで README を書く。オープンソースとして、GitHub に push して公開する場合は、README.md を分かりやすく書くと良いかと。私は英語で書くようにしています。

動作確認

ここまでできたら、作成した gem を読み込んだ状態でコンソールを起動して、gem 動作の確認を行ってみましょう。


$ bin/console
irb(main):002:0> Sample::Mygem.greet
Hello Rubygem !
=> nil

$ bin/console

irb(main):002:0> Sample::Mygem.greet

Hello Rubygem !

=> nil

上手く動きました！

ビルドして RubyGems リポジトリに公開

RubyGems (rubygems.org) に公開する場合は、ビルドしてリリースします。まずは、ビルド。


$ bundle exec rake build

$ bundle exec rake build

続いて、RubyGems に公開するためのAPIキーを取得します。前もって rubygems.org のアカウントが必要です。


$ curl -u user_name https://rubygems.org/api/v1/api_key.yaml > ~/.gem/credentials; chmod 0600 ~/.gem/credentials
Enter host password for user 'user_name':

$ curl -u user_name https://rubygems.org/api/v1/api_key.yaml > ~/.gem/credentials; chmod 0600 ~/.gem/credentials

Enter host password for user 'user_name':

user_name は、RubyGems(rubygems.org) のユーザー名を指定。パスワードが求められるので入力する。

APIキーを確認。


$ cat ~/.gem/credentials
---
:rubygems_api_key: *****

$ cat ~/.gem/credentials

---

:rubygems_api_key: *****

最後に rubygems.org に公開します。


$ bundle exec rake release

$ bundle exec rake release

あとは、開発〜リポジトリにプッシュ（GitHub など）〜リリース（rubygems.org に公開）の繰り返しです。rubygems.org にリリース（アップデート）する際は、バージョン番号を上げないと弾かれるので、バージョン番号を適宜上げていきます。おつかれさまでした！

私は以下の本で Ruby を覚えました。メタプログラミングRubyは入門を超える内容で難しめです。

たのしいRuby 第5版

パーフェクトRuby (PERFECT SERIES 6)

メタプログラミングRuby 第2版

<< 前の記事 : ローカル開発中のgemをGemfileに書いてインストール

Gemの作り方(Ruby Gem)

Gem のテンプレートを生成

依存する gem を gemspec ファイルに追記

プライベートな gem で RubyGems(rubygems.org) に公開しない場合

gemspec の Author 情報等を編集

gem 本体の作成

実行可能なコマンドを作成

バージョン番号の指定

README.md を作成

動作確認

ビルドして RubyGems リポジトリに公開

Leave Your Message! コメントをキャンセル