分享

如何创建自己的ruby gem包

 CJOL藏经阁 2014-05-06


 编写一个最简单的例子

1. 建好如下文件夹

注意:lib目录下必须有个和你gem名字一样的rb文件。

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


2. 编写代码

. hola.rb

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

.hola.gemspec

  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       = 'nick@quaran.to'  
  10.   s.files       = ["lib/hola.rb"]  
  11.   s.homepage    =  
  12.     'http:///gems/hola'  
  13. end  
这里面可以设置很多属性。我会专门写篇文章介绍。

上面字段的意思,比较简单。相信大家都能理解。


3.编译生成gem

  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.测试使用

  1. % irb  
  2. >> require 'hola'  
  3. => true  
  4. >> Hola.hi  
  5. Hello world!  
注意:在ruby 1.9.2之前到版本里面,需要先require 'rubygem',才能使用我们写的gem.


5.发布到rubygems网站

  1. $ curl -u tom https:///api/v1/api_key.yaml >  
  2. ~/.gem/credentials  
  3. Enter host password for user 'tom':  
设定完之后发布

  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文件

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

2. 代码

lib/hola/translator.rb

  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
  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

  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       = 'nick@quaran.to'  
  10.   s.files       = ["lib/hola.rb""lib/hola/translator.rb"]  
  11.   s.homepage    =  
  12.     'http:///gems/hola'  
  13. end  
红色是和上面不一样的地方。


其他步骤和上面一样了。很简单吧!


最后说下怎么写个 gem包含可执行文件的例子。

这个也很简单。像rake就是典型的包含可执行文件的gem.

1. 在刚才工程目录下建个bin文件夹

生成可执行文件,并且修改权限为可运行。

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

2. 修改可执行文件内容
bin/hola

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

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

3 .最后修改gemspec
  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'  
其他就和上面一样了。很简单吧。








    本站是提供个人知识管理的网络存储空间,所有内容均由用户发布,不代表本站观点。请注意甄别内容中的联系方式、诱导购买等信息,谨防诈骗。如发现有害或侵权内容,请点击一键举报。
    转藏 分享 献花(0

    0条评论

    发表

    请遵守用户 评论公约

    类似文章 更多