如何建立自己的ruby gem包

標籤：des   style   blog   http   color   io   os   使用   ar   

編寫一個最簡單的例子

1. 建好如下檔案夾

注意：lib目錄下必須有個和你gem名字一樣的rb檔案。

[ruby] view plaincopy

1. $ cd hola  
2. $ tree  
3. .  
4. ├── hola.gemspec  
5. └── lib  
6.     └── hola.rb  

2. 編寫代碼

. hola.rb

[ruby] view plaincopy

1. % cat lib/hola.rb  
2. class Hola  
3.   def self.hi  
4.     puts "Hello world!"  
5.   end  
6. end  

.hola.gemspec

 

[ruby] view plaincopy

1. % cat hola.gemspec  
2. Gem::Specification.new do |s|  
3.   s.name        = ‘hola‘  
4.   s.version     = ‘0.0.0‘  
5.   s.date        = ‘2010-04-28‘  
6.   s.summary     = "Hola!"  
7.   s.description = "A simple hello world gem"  
8.   s.authors     = ["Nick Quaranto"]  
9.   s.email       = ‘[email protected]‘  
10.   s.files       = ["lib/hola.rb"]  
11.   s.homepage    =  
12.     ‘http://rubygems.org/gems/hola‘  
13. end  

這裡面可以設定很多屬性。

上面欄位的意思，比較簡單。相信大家都能理解。

3.編譯產生gem

[ruby] view plaincopy

1. % gem build hola.gemspec  
2. Successfully built RubyGem  
3. Name: hola  
4. Version: 0.0.0  
5. File: hola-0.0.0.gem  
6.   
7. % gem install ./hola-0.0.0.gem  
8. Successfully installed hola-0.0.0  
9. 1 gem installed  

4.測試使用

[ruby] view plaincopy

1. % irb  
2. >> require ‘hola‘  
3. => true  
4. >> Hola.hi  
5. Hello world!  

注意：在ruby 1.9.2之前到版本裡面，需要先require ‘rubygem‘，才能使用我們寫的gem.

5.發布到rubygems網站

[ruby] view plaincopy

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

設定完之後發布

[ruby] view plaincopy

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

發布成功。

這樣任何一個人都可以使用你寫的gem了。

稍微複雜的rubygem例子

上面的例子只有一個ruby檔案，一般gem應該沒有這麼簡單的。

下面說下有多個ruby檔案該怎麼寫。

1. 目錄結構

多了個hola目錄和translator.rb檔案

[ruby] view plaincopy

1. % tree  
2. .  
3. ├── hola.gemspec  
4. └── lib  
5.     ├── hola  
6.     │   └── translator.rb  
7.     └── hola.rb  

2. 代碼

 

lib/hola/translator.rb

[ruby] view plaincopy

1. % cat  lib/hola/translator.rb  
2. class Hola::Translator  
3.   def initialize(language)  
4.     @language = language  
5.   end  
6.   
7.   def hi  
8.     case @language  
9.     when :spanish  
10.       "hola mundo"  
11.     else  
12.       "hello world"  
13.     end  
14.   end  
15. end  

lib/hola.rb

[ruby] view plaincopy

1. % cat lib/hola.rb  
2. class Hola  
3.   def self.hi(language = :english)  
4.     translator = Translator.new(language)  
5.     translator.hi  
6.   end  
7. end  
8.   
9. require ‘hola/translator‘  

.hola.gemspec

[ruby] view plaincopy

1. % cat hola.gemspec  
2. Gem::Specification.new do |s|  
3.   s.name        = ‘hola‘  
4.   s.version     = ‘0.0.0‘  
5.   s.date        = ‘2010-04-28‘  
6.   s.summary     = "Hola!"  
7.   s.description = "A simple hello world gem"  
8.   s.authors     = ["Nick Quaranto"]  
9.   s.email       = ‘[email protected]‘  
10.   s.files       = ["lib/hola.rb", "lib/hola/translator.rb"]  
11.   s.homepage    =  
12.     ‘http://rubygems.org/gems/hola‘  
13. end  

其他步驟和上面一樣了。很簡單吧！

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

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

1. 在剛才工程目錄下建個bin檔案夾

產生可執行檔，並且修改許可權為可運行。

[ruby] view plaincopy

1. % mkdir bin  
2. % touch bin/hola  
3. % chmod a+x bin/hola  

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

[ruby] view plaincopy

1. #!/usr/bin/env ruby  
2.   
3. require ‘hola‘  
4. puts Hola.hi(ARGV[0])  

測試下

[ruby] view plaincopy

1. % ruby -Ilib ./bin/hola  
2. hello world  
3.   
4. % ruby -Ilib ./bin/hola spanish  
5. hola mundo  

3 .最後修改gemspec

[ruby] view plaincopy

1. % head -4 hola.gemspec  
2. Gem::Specification.new do |s|  
3.   s.name        = ‘hola‘  
4.   s.version     = ‘0.0.1‘  
5.   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包（可用Regex）
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/

如何建立自己的ruby gem包