如何建立本身的ruby gem包

編寫一個最簡單的例子

1. 建好以下文件夾

注意：lib目錄下必須有個和你gem名字同樣的rb文件。

$ cd hola
$ tree
.
├── hola.gemspec
└── lib
    └── hola.rb

2. 編寫代碼

. hola.rb

% cat lib/hola.rb
class Hola
  def self.hi
    puts "Hello world!"
  end
end

.hola.gemspec

 

% cat hola.gemspec
Gem::Specification.new do |s|
  s.name        = 'hola'
  s.version     = '0.0.0'
  s.date        = '2010-04-28'
  s.summary     = "Hola!"
  s.description = "A simple hello world gem"
  s.authors     = ["Nick Quaranto"]
  s.email       = 'nick@quaran.to'
  s.files       = ["lib/hola.rb"]
  s.homepage    =
    'http://rubygems.org/gems/hola'
end

這裏面能夠設置不少屬性。

上面字段的意思，比較簡單。相信你們都能理解。

3.編譯生成gem

% gem build hola.gemspec
Successfully built RubyGem
Name: hola
Version: 0.0.0
File: hola-0.0.0.gem

% gem install ./hola-0.0.0.gem
Successfully installed hola-0.0.0
1 gem installed

4.測試使用

% irb
>> require 'hola'
=> true
>> Hola.hi
Hello world!

注意：在ruby 1.9.2以前到版本里面，須要先require 'rubygem'，才能使用咱們寫的gem.

5.發佈到rubygems網站

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

設定完以後發佈

% gem push hola-0.0.0.gem
Pushing gem to RubyGems.org...
Successfully registered gem: hola (0.0.0)

發佈成功。

這樣任何一我的均可以使用你寫的gem了。

稍微複雜的rubygem例子

上面的例子只有一個ruby文件，通常gem應該沒有這麼簡單的。

下面說下有多個ruby文件該怎麼寫。

1. 目錄結構

多了個hola目錄和translator.rb文件

% tree
.
├── hola.gemspec
└── lib
    ├── hola
    │   └── translator.rb
    └── hola.rb

2. 代碼

 

lib/hola/translator.rb

% cat  lib/hola/translator.rb
class Hola::Translator
  def initialize(language)
    @language = language
  end

  def hi
    case @language
    when :spanish
      "hola mundo"
    else
      "hello world"
    end
  end
end

lib/hola.rb

% cat lib/hola.rb
class Hola
  def self.hi(language = :english)
    translator = Translator.new(language)
    translator.hi
  end
end

require 'hola/translator'

.hola.gemspec

% cat hola.gemspec
Gem::Specification.new do |s|
  s.name        = 'hola'
  s.version     = '0.0.0'
  s.date        = '2010-04-28'
  s.summary     = "Hola!"
  s.description = "A simple hello world gem"
  s.authors     = ["Nick Quaranto"]
  s.email       = 'nick@quaran.to'
  s.files       = ["lib/hola.rb", "lib/hola/translator.rb"]
  s.homepage    =
    'http://rubygems.org/gems/hola'
end

其餘步驟和上面同樣了。很簡單吧！

最後說下怎麼寫個 gem包含可執行文件的例子。

這個也很簡單。像rake就是典型的包含可執行文件的gem.

1. 在剛纔工程目錄下建個bin文件夾

生成可執行文件，而且修改權限爲可運行。

% mkdir bin
% touch bin/hola
% chmod a+x bin/hola

2. 修改可執行文件內容
bin/hola

#!/usr/bin/env ruby

require 'hola'
puts Hola.hi(ARGV[0])

測試下

% ruby -Ilib ./bin/hola
hello world

% ruby -Ilib ./bin/hola spanish
hola mundo

3 .最後修改gemspec

% head -4 hola.gemspec
Gem::Specification.new do |s|
  s.name        = 'hola'
  s.version     = '0.0.1'
  s.executables << 'hola'

其餘就和上面同樣了。很簡單吧。

------------------------------------------------------------------------------

什麼是RubyGems？

RubyGems是一個方便而強大的Ruby程序包管理器，Ruby的第三方插件是用gem方式來管理，很是容易發佈和共享，一個簡單的命令就能夠安裝上 第三方的擴展庫。特色：能遠程安裝包，包之間依賴關係的管理，簡單可靠的卸載，查詢機制，能查詢本地和遠程服務器的包信息，能保持一個包的不一樣版本，基於 Web的查看接口，能查看你安裝的gem的信息。

安裝RubyGems

官方站點 http://rubygems.org/pages/download

下載地址：http://rubyforge.org/frs/?group_id=126

Windows 用戶直接下載.zip壓縮包，解壓縮，從CMD提示窗口下進入 setup.rb所在目錄， 運行 ruby setup.rb 便可安裝。

Ruby1.9.1 之後的版本自帶RubyGems，直接在CMD窗口下輸入指令 gem update --system 升級到最新版便可。

gem包的安裝方式：

RubyGems.org 是官方的Gem託管中心，RubyGems就是從這裏遠程下載gem包的。RubyGems 將全部的gem包 安裝到 /[ruby root]/lib/ruby/gems/[ver]/ 目錄下，這其中包括了cache、doc、gems、specifications 4個目錄，cache下放置下載的原生gem包，gems下則放置的是解壓過的gem包。當安裝過程當中遇到問題時，能夠進入這些目錄，手動刪除有問題的 gem包，而後從新運行 gem install [gemname] 命令便可。

RubyGems命令詳解：

咱們以目前最新的 rubygems 1.8.16 爲例：

# 查看RubyGems軟件的版本
gem -v

# 更新升級RubyGems軟件自身
gem update --system

# 更新全部已安裝的gem包
$ gem update

# 更新指定的gem包
# 注意：gem update [gemname]不會升級舊版本的包，可使用 gem install [gemname] --version=[ver]代替
$ gem update [gemname]

# 安裝指定gem包，程序先從本機查找gem包並安裝，若是本地沒有，則從遠程gem安裝。
gem install [gemname]

# 僅從本機安裝gem包
gem install -l [gemname]

# 僅從遠程安裝gem包
gem install -r [gemname]

# 安裝gem包，但不安裝相關文檔文件
gem install [gemname] --no-ri --no-rdoc

# 安裝指定版本的gem包
gem install [gemname] --version=[ver]

# 刪除指定的gem包，注意此命令將刪除全部已安裝的版本
gem uninstall [gemname]

# 刪除某指定版本gem
gem uninstall [gemname] --version=[ver]

# 查看本機已安裝的全部gem包
gem list

# 列出遠程RubyGems.org 上有此關鍵字的gem包（可用正則表達式）
gem list -r keyword

# 列出遠程RubyGems.org 上全部Gmes清單，並保存到文件。
gem list -r > remote_gem_list.txt

#查看全部gem包文檔及資料
gem server 

#顯示RubyGem使用幫助
gem help

#列出RubyGem命令一些使用範例
gem help example

更多命令請參考官方文檔： http://guides.rubygems.org/command-reference/