Bundler の履歴(No.15)

Tag: Bundler

目次†

↑

参考情報†

Bundler: The best way to manage a Ruby application's gems…公式

↑

概要†

使用するgemsを管理するためのツール

↑

使用方法†

↑

参考情報†

↑

簡単にGemfileだけを使う方法†

Gemfileを用意する。例えばActiveRecordを単独で使用する場合
```
source 'https://rubygems.org'

gem 'activerecord'
gem 'mysql2'
```
インストール。vendor/bundle以下にgemが追加される。
```
$ bundle install --path vendor/bundle
```
使用する。自分のscriptの先頭で以下のようにかいて、ruby hoge.rbのように実行すると、vendor/bundle以下のgemを使ってくれる。
```
require "rubygems"
require "bundler/setup"
require "active_record"
```

ruby - Are bundle exec and require 'bundler/setup' equivalent? - Stack Overflowに、bundle execとbundle/setupの違いの説明あり。

↑

アプリのひな形を作成†

gemとしてインストール可能なアプリのひな形を作る事も出来る(-bで実行ファイルも作ってくれる。-tがつくとテストファイルも作ってくれる)
```
bundle gem sampleapp -b -t
```

↑

Gemfile†

↑

requireってなに?†

ruby on rails - Bundler: What is the :require => false on the gemfile means? - Stack Overflowによると、require => falseが指定されたものは、ダウンロードはされるが自動的にrequireはされないといいうこと。
require するときの名前をかえることもできるらしい。

↑

gemパッケージの作り方†

↑

注意: Windowsの場合†

msysgitにパスを通してないとbundle gemがエラーになる。

↑

ひな形の生成†

↑

ファイルの生成†

bundle gemコマンドでつくることができる。
```
bundle gem demo
```
オプションで-bを指定すれば実行ファイルを、-tを指定すればテストファイルを作ってくれる(rspec)。
```
bundle gem demo -b -t
```
もしくはminitestもサポートしている
```
bundle gem dbtools  -b --test=minitest
```
後からspecサポートを追加したい場合、次のリンクが参考になる。Ruby - bundlerを使ってRSpecを書きつつGemを開発する - Qiita [キータ]
- gemspecにrspecを追加して、bundle install実行。specフォルダとspec_helperをつくるぐらいかな。

↑

gemspecファイルの編集†

demo.gemspecファイルを編集する。

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

Gem::Specification.new do |spec|
  spec.name          = "demo"
  spec.version       = Demo::VERSION
  spec.authors       = ["src"]
  spec.email         = ["tanaka@test.net"]
  spec.description   = %q{TODO: Write a gem description}
  spec.summary       = %q{TODO: Write a gem summary}
  spec.homepage      = ""
  spec.license       = "MIT"

  spec.files         = `git ls-files`.split($/)
  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
  spec.require_paths = ["lib"]

  spec.add_development_dependency "bundler", "~> 1.3"
  spec.add_development_dependency "rake"
end

gitと連携することが考えられていて、authors、email、filesなどはgitから情報をもってきている。
descriptionに、TODOやFIXMEが含まれているとビルドできない。
依存関係の設定は、runtime_dependencyとdevelopment_dependencyが存在。runtimeはgemを動かすのに必要なもの。developmentは開発時に必要なもの(例:RSpec)。
開発ディレクトリでbundle installすると、runtime/development両方の依存関係にあるライブラリがインストールｓれる。
開発後gemファイルをgem installやbundle installでインストールした場合、runtime dependencyにあるラウぶらりだけがインストールされる。

↑

gemのインストール†

pathを指定する。開発時はruntime_dependency/development_dependencyry方法がインストールされる。リリース後はruntime_dependencyだけインストールされる。
```
bundle install --path .bundle
```

↑

パッケージ作成†

lib/demo.rbに実装を書く。

require "demo/version"

module Demo
  def self.hello_world
    p "hello world!!"
  end
end

↑

パッケージ実行†

bundle 経由で実行する
```
bundle exec bin/demo.rb
```

↑

パッケージビルド†

パッケージをビルドする。rakeコマンドを使用
```
rake build
```
パッケージをインストールする。
```
gem install pkg/demo-0.0.1.gem
```
またはrake installで一発。
動作確認(irbででも)。
```
require 'demo'
puts Demo.hello_world
```

↑

パッケージリリース(PENDING)†

rake release

↑

Tips†

↑

パス指定の省略†

buldle install のパス指定を省略する。bundler - bundle install するときに vendor/bundle を省略する方法 - Qiita
/.bundle/configに以下を記述。bundle configで確認できる。
```
---
BUNDLE_PATH: ./vendor/bundle
```

↑

パッケージの命名規則†

Name your gem - RubyGems Guidesが参考になる。アンダースコアは単語の区切り、ハイフン(ダッシュ)はパッケージ階層として解釈されるので使い分けたほうが良い。
パッケージ名にハイフンを使う場合注意が必要 [#z37b810f]
Create a Ruby Gem. Real World, play by play. Part 1にもあるようにパッケージ名にaaa-bbbのようにハイフンを挟むとaaa/bbbのような深いフォルダが作成されてしまう。これを避けるためには、ハイフンを使わない、アンダースコアを使う、自分でフォルダ構造を変更するなどの工夫が必要になる。

↑

トラブルシューティング†

↑

Gemfileでgitリポジトリを指定したgemが更新されない†

gemspecでバージョンが上がっていれば「bundle update」で更新できる => 利用する側に手を入れるのが一番よい(と思ったけどだめかも)。さわれない場合vendor/bundleを削除して入れなおすしかない?

Bundler の履歴(No.15)

目次†

関連ページ†

参考情報†

概要†

使用方法†

参考情報†

簡単にGemfileだけを使う方法†

アプリのひな形を作成†

Gemfile†

requireってなに?†

gemパッケージの作り方†

注意: Windowsの場合†

ひな形の生成†

ファイルの生成†

gemspecファイルの編集†

gemのインストール†

パッケージ作成†

パッケージ実行†

パッケージビルド†

パッケージリリース(PENDING)†

Tips†

パス指定の省略†

パッケージの命名規則†

トラブルシューティング†

Gemfileでgitリポジトリを指定したgemが更新されない†