GemとBundler

Rubyのライブラリ管理システムのRubygemsとコマンドgemおよびbundlerについて説明します。

Rubygems

Rubyではライブラリのことをgem(英語の発音はジェムで意味は「宝石」)といいます。 そして、Rubyのライブラリ管理システムをRubygemsといいます。 gemはhttps://rubyges.orgに保管されています。 このウェブサイトをブラウザで開くと、gemの検索やgem情報の確認ができます。

Rubygems

このウェブサービスはRuby on Railsで作られているそうです。

ここからgemをダウンロード・インストールする仕組みもRubygemsと呼ばれ、Rubyに標準で添付されています。 狭い意味ではこれがRubygemsです。

Rubygemsのドキュメントは充実しています。 まずはRubyのドキュメントから見てください

ここにgemコマンドの使い方が書かれています。 Rubygems全般のドキュメント(英語)はRubygemsのウェブサイトにあります。

gemをホームページで探し、ダウンロードするだけならRubyのドキュメントの解説だけで十分です。

gemコマンド

さきほどのリンク先を参照してもらえば十分なので、このセクションではgemコマンドを使い、インストール、実行までの実例を示します。 なお、自前のgemを作ることもできますが、ここでは扱いません(それができるくらいなら「徒然Ruby」を読む必要ないですよね)。

rakというプログラムを例にとります。 このプログラムはカレントディレクトリ以下のファイルからパターンに対応する文字列が含まれるファイルを検索し、該当行を表示するプログラムです。 Unixのgrepに似ていますが、あるディレクトリの下にあるファイルすべてを対象にするのが特長です。

gemのインストールには「gemコマンド」に動作の指定「install」をつけ、「gem名」を続けます。 rakのインストールの場合は「gem install rak」です。

$ gem install rak
Fetching rak-1.4.gem
Successfully installed rak-1.4
Parsing documentation for rak-1.4
Installing ri documentation for rak-1.4
Done installing documentation for rak after 0 seconds
1 gem installed
$

これだけでインストールが完了します。 gemには、大別してライブラリと実行プログラムがあります。 rakは実行プログラムです。 rakを実行すると、赤でハイライトされた検索結果が表示されます。

$ rak webrick
Gemfile
6|gem "webrick"
$

この例では、カレントディレクトリのGemfileの6行目に「gem “webrick”」という行があることを示しています。

rakが不要になり、アンインストールしたい場合は次のようにします。

$ gem uninstall rak

他の操作については、Rubyのドキュメントを参考にしてください。

bundlerコマンド

gemに似たコマンドにbundlerがあります。 これもRubyに同梱されています。 bundlerはカレントディレクトリに書かれたGemfileに基づいてgemをインストールします。 Gemfileには複数のgemを指定でき、一度にインストールできるので、gemコマンドよりも便利です。 bundlerは、特に多くのgemを必要とする大規模なプログラムに向いています。 個人が小さいプログラムを作る場合にはgemコマンドで十分です。

gemのバージョンについても指定ができます。 特定の古いバージョンのgemでないと動作しないプログラムの場合は、Gemfileにそのgemのバージョンも記しておきます。 これは特に公開プログラムでは重要で、新しいバージョンのgemに対応するまでの間のつなぎとして用いられます。

多くの人にとってはbundlerを使うのはRuby on Railsでウェブサイトを作るような場合ではないでしょうか。 自作のプログラムでbundlerを使うケースはまだまだ少ないように思います。 そこで、ここではRailsに似ているが、それよりは簡単なアプリケーションであるJekyllを例にとってbundlerを説明したいと思います。 なお、Jekyllは静的なウェブサイトを作成するためのプログラムです。 Jekyllの詳細は「はじめてのJekyll + GitHub Pages」を参照してください。

まず、Jekyllをインストールします。

$ gem install jekyll

ここでは、sampleという名前のサイトを作りましょう。 「jekyll new」でサイトの元になるファイル群を作成します。

$ jekyll new sample
$ cd sample
$ ls
404.html  Gemfile  _config.yml  _posts  about.markdown  index.markdown

新しくディレクトリsampleが作られ、その下にいくつかのファイルが作られています。 その中にはGemfileもあります。 Gemfileは少し長いので、ここではコメント部を省略して掲載します。

source "https://rubygems.org"
gem "jekyll", "~> 4.2.2"
gem "minima", "~> 2.5"
group :jekyll_plugins do
  gem "jekyll-feed", "~> 0.12"
end
platforms :mingw, :x64_mingw, :mswin, :jruby do
  gem "tzinfo", "~> 1.2"
  gem "tzinfo-data"
end
gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]
gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]

OSがLinuxでRubyがCRuby(Cで書かれたRuby、MRI–Matz’ Ruby Implementationとも)の場合、platformsが指定されている部分とjrubyが指定されている部分は実行されないので、それを除くと3つのgemが指定されます。 ローカルでJekyllを動かす場合、webrickというgemが必要です。 webrickはRuby3.0から標準ライブラリから削除されましたので、Rubygemsからのインストールが必要です。 Gemfileをエディタで開き、webrickを追加します。

gem "webrick"

Gemfileに書かれたgemをインストールするには、bundlerを用います。 コマンドラインから「bundle install」としてください。 bundlerを起動するためのコマンド名は「bundle」です。

$ bundle install
Fetching gem metadata from https://rubygems.org/............
Resolving dependencies...
Using public_suffix 5.0.0
Using bundler 2.3.23
... ... ...
... ... ...
Using jekyll 4.2.2
Using jekyll-feed 0.16.0
Using jekyll-seo-tag 2.8.0
Using minima 2.5.1
Bundle complete! 8 Gemfile dependencies, 32 gems now installed.
Use `bundle info [gemname]` to see where a bundled gem is installed.

途中省略しましたが、全部で32個のgemがインストールされました(下から2行目を見てください)。 gemの数が多くなったのは「Gemfileで指定したgemが依存するgem」も含めてインストールしたからです。

インストール時に新しいファイル「Gemfile.lock」が作られます。 このファイルはインストール時点で「Gemfile指定バージョンの範囲での最新のgem」を確定したものです。 プログラムはこのファイルに基づいてバージョンが選ばれ、実行されます。 実行は「bundle exec プログラム名」という形で行います。 例えばjekyllでサーバーを起動するには「bundle exec jekyll serve」です。 単に「jekyll serve」とすると、Gemfile.lockのバージョンに無関係にgemが起動されます。 通常はその時点での最新版が使われます。 プログラムによっては旧版でないと動かない場合もあるので、Gemfile.lockのバージョンを守ることが大事です。 したがって、「bundle exec」は必ず付けてください。

$ bundle exec jekyll serve
Configuration file: /home/ユーザディレクトリ... .../sample/_config.yml
            Source: /home/ユーザディレクトリ... .../sample
       Destination: /home/ユーザディレクトリ... .../sample/_site
 Incremental build: disabled. Enable with --incremental
      Generating... 
       Jekyll Feed: Generating feed for posts
                    done in 0.417 seconds.
 Auto-regeneration: enabled for '/home/ユーザディレクトリ... .../sample'
    Server address: http://127.0.0.1:4000/
  Server running... press ctrl-c to stop.

下から2行目に「ローカルホストの4000番ポート」にサーバアドレスが設定されていることが記されています。 ブラウザ(Google Chrome、FirefoxやMicrosoft Edgeなど)を立ち上げ、「http://localhost:4000/」または同じことですが「http://127.0.0.1:4000/」を開くと、次のような画面が現れます。

sampleのローカルホストの画面

  • 「bundle exec jekyll serve」でローカルホスト(あなたが動かしているコンピュータのこと)がウェブサーバとなった
  • ローカルのアドレス(上記のアドレス)にJekyllが作成したページが存在する
  • ブラウザがそれをアクセスすると、上記の画面が表示される

※ ローカルというのは自分の動かしているコンピュータ、リモートというのはそこから離れて動いている別のコンピュータを指します。 また、ホストとはネットワーク上のコンピュータのことです。 ネットワーク上のサーバもコンピュータであり、ホストと呼ばれます。 サーバにアクセスするコンピュータはクライアントと呼ばれますが、これもホストです。

Jekyllはこのようにウェブサイトを作るプログラムです。 表示されたのはJekyllが作ったサンプルページです。 通常は、ユーザが更にカスタマイズしてウェブページを作ります。

  • Jekyllでは静的なウェブサイトを構築できる
  • JekyllはMarkdownをサポートする=>HTMLを書くよりも作業量が少なくて住む
  • JekyllはLiquidをサポートする=>ウェブサイトの内容をLiquidプログラムで構成できる
  • Jekyllのプラグインを使うとより少ない作業量でウェブサイトを構築できる

詳しくは「はじめてのJekyll + GitHub Pages」を参照してください。

サーバを止めるには「CTRL+C」を押します。

「bundle install」と「bundle exec」が最も良く使うコマンドです。 その他には、gemをGemfileの範囲でアップデートする「bundle update」も使うことがあるでしょう。 bundlerについての更に詳しい情報はBundlerのホームページを参照してください。

Railsを用いたウェブアプリケーションを作成する場合、Gemfileの内容を変更、追加しなければならないこともあると思います。 その時はbundlerのウェブサイトにある「Gemfileの書き方」(Learn More Gemfiles)を参考にしてください。

まとめ

今回はRubyのライブラリをgemと呼ぶこと、そしてgemのインストール方法を紹介しました。 これを読んでお分かりいただけたと思いますが、gemのインストールは簡単です。 あとは、どんなgemがあるのか、という知識が必要なだけです。

直接Rubygemsで調べるのも良いですが、Bestgemsというgemのランキングサイトも参考になると思います。 今日の時点でのダウンロード1位がbundlerですが、これはbundlerがRuby同梱であることを考えると不思議な気がします。 また、人気のRailsですが40位とかなり低いのも不思議です。

ダウンロード上位のgemは有用なことが多いと思われますので、時々眺めてみると良いでしょう。

2023

単項マイナスと構文解析

1 minute read

単項マイナスとは 単項マイナスと括弧 括弧なし単項マイナスを許容する場合のBNF calcの場合

Raccライブラリと構文解析

3 minute read

パーサ・ジェネレータとは 少し複雑な文法 四則(加減乗除)計算のBNF Racc で実装 クラス定義、BNFの記述部分 ヘッダー、インナー、フッター コンパイルと実行 演算子の優先順位と結合における左右の優先順位 まとめ

StrScanライブラリと字句解析

less than 1 minute read

StrScanライブラリのドキュメント 字句解析とは StrScanライブラリ StrScanライブラリを使った字句解析 実例

Gem

1 minute read

lbtというgemを作って公開してみた lbtはどんなgemか ファイルの配置 lbt.gemspec Rakefile gemのビルド RubyGems.orgへのアップロード 補足・・rake/gempackagetaskサブライブラリについて

Encoding

1 minute read

文字列のエンコーディングに頭を悩ませることはほとんどなくなりました。 なぜなら、どのアプリ、システムもUTF-8を使うようになったからです。 Rubyでもエンコーディングの問題が起こることはまず無いでしょう。 ですが、今回はエンコーディングの考え方を整理してみたいと思います。

Thread

less than 1 minute read

Fiberを書いたときから、次はスレッドを書こうと思っていましたが、時間がかかってしまいました。 その理由は、期待したとおりのスレッドの効果がなかったためです。 今回はそのことを書きますが、これはRubyのスレッドの抱えている問題なのか、自分のやり方が悪いのかははっきりしていません。

Fiber

1 minute read

Fiberは「ノンプリエンプティブな軽量スレッド」とRubyのマニュアルに記載されています。

RDoc

less than 1 minute read

今回はRubyプログラムから自動的にドキュメントを作成するRDocについて書きたいと思います。 私はこのことについて、エキスパートではありません。 この記事も、初心者の体験談だと考えてください。

Back to Top ↑

2022

Ruby/GTK4

5 minute read

Ruby/Gtkの記事を先日書いたときに、「これはかなり使える」という手応えを感じたので、WordBook(Railsで作った単語帳プログラム)のGTK 4版を作りました。 プログラムは「徒然なるままにRuby」のGitHubレポジトリに置いてあります。 レポジトリをダウンロードし、ディレクトリ_example/...

Shoes – Rubyとグラフィック

5 minute read

Rubyはグラフィックについて弱い印象があります。 しかし、グラフィックはデバイスに関することなので、言語そのものには直接の関係はないはずで、あるとすればライブラリです。 今後グラフィック関係のgemが開発されることに期待しましょう。

Rails7 テスト

5 minute read

前回作ったWordbook(リソースフル)のテストを書いてみます。 RailsのテストはminitestをRails用に拡張したものです。

Rails7 モデルとデータベース

2 minute read

今回はRailsにおけるデータの作成と保存、そして変更について説明します。 そのベースになるモデルとデータベースの話から始め、appendとchangeの動作について詳しく説明します。

Rails7とBootstrap

2 minute read

一般に、HTMLは文書の構造を表し、CSSはその体裁(見栄え)を表します。 Railsは最終的にCSSを含むHTML文書を出力するので、この2つについての理解が必須です。 この記事ではとくにCSSの人気ライブラリであるBootstrapを紹介します。 BootstrapはJavascriptも含んでいます。

Rails7のインストール

2 minute read

Rubyの最も人気のあるアプリケーションであるRuby on Railsを取り上げようと思い、書き始めました。 予想してはいましたが、相当な分量になってしまいました。 そのため、何回かに分けて記事にすることにします。 また、対象となる読者のレベルをどうしようかと考えましたが、「徒然Ruby」が基礎的な内容から始ま...

GemとBundler

1 minute read

Rubyのライブラリ管理システムのRubygemsとコマンドgemおよびbundlerについて説明します。

minitest(3)モックの詳細

1 minute read

minitestについて連続して2回書いてきました。 「minitestはドキュメントが少ない」という人がいますが、私も同感です。 例えば、モックとスタブの説明も少ないです。 そこで、今回はmock.rbのソースコードを参考に、モックの私的ドキュメントを書いてみました。 あくまで私個人の考えであり、minites...

minitest(1)テストとは

2 minute read

アプリ作成の記事でminitestを使いました。 今回はminitestについて、また一般にテストについて、私の考えを書こうと思います。

public、private、protected

2 minute read

今回はメソッドの呼び出し制限ついて説明します。 呼び出し制限にはpublic、private、protectedの3つがあります。

アプリ制作、インストール、テスト

1 minute read

2023/10/29 追記:この記事は新しく書き直しました。 古い記事で使っていたGitHubのCalcが大幅にアップデートされたためです。 そこで、この記事に合うようなプログラムsimple_calcを新たに作りました。 このプログラムは本レポジトリの_example/simple_calcにあります。

case文

2 minute read

if〜elsif〜・・・〜else〜endは皆さん良く使うでしょうか? これは場合分けで良く使われる方法です。 これと同様の制御構造にcase文があります。 Cのswitch文に似ていますが、より強力な機能を持っています。 if-else-endよりも高い能力があるといえます。

Lambda

2 minute read

Procオブジェクトを生成するメソッドlambdaについて説明します。

Proc オブジェクト

2 minute read

今回はブロックを一般化したオブジェクトProcを説明します。

モジュール

1 minute read

モジュールには名前空間とミックスイン(Mix-in)の2つの機能があります。 ここではミックスインについて説明します。

Kernelモジュール

less than 1 minute read

Kernelモジュールのメソッドはどこでも使うことができます。 そのメソッドの中には便利で有用なものが多いです。

便利なメソッド

1 minute read

ここでは私が便利だと思ったメソッドを紹介します。

文字列と正規表現

3 minute read

文字列は最も使うオブジェクトのひとつです。 特にウェブ・アプリケーションでは、コンテンツだけでなくHTMLのタグやCSSを含めすべてが文字列です。 Rubyは文字列オブジェクトのメソッドが充実しており、またパターンマッチのための正規表現も充実しています。

配列

2 minute read

配列は、どのプログラミング言語にもあると思います。 複数の要素を一括して扱うことができるのが配列です。 Rubyの配列はメソッドが充実しているので、プログラムを効率的、機能的に書くのに役立ちます。

トップレベルのメソッド

1 minute read

今回はメソッド定義です。 メソッド定義はRubyの核心ですが、今回はトップレベルに限って説明します。 この限定によって、内容はかなり易しくなっています。

ブロックとイテレータ

less than 1 minute read

ブロックはRubyの特長です。 ブロックのおかげで記述が非常にすっきりと分かりやすくなります。 今回はブロックをイテレータの本体として使う方法を説明します。

整数

less than 1 minute read

ここではRubyの最も基本的なオブジェクトである整数について説明します。

Hello world

less than 1 minute read

「徒然なるままに」をネットで調べてみると、「することもなく、手持無沙汰なのにまかせてという意味」とありました。 まさに、自分の現状を言い当てた言葉。 しかも、ブログに書くネタもなかなか思いつかない日々。

Back to Top ↑