创建自定义的Ruby gem包的教程

所属分类: 脚本专栏 / ruby专题 阅读数: 885
收藏 0 赞 0 分享

编写一个最简单的例子

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' 

其他就和上面一样了。很简单吧。

更多精彩内容其他人还在看

Rails link_to 详解

想学习rauks link_to的朋友可以参考下面的例子。
收藏 0 赞 0 分享

ruby 小脚本搞定CVS服务器更换后checkout下来的工程迁移

CVS换了新的服务器,原来的工程需要更改Server配置,这个东东手工做起来 可是个体力活,写了一个脚本分发下来。
收藏 0 赞 0 分享

Ruby 魔法 学习笔记之一

Ruby的许多动态特性,让Ruby具有很多魔法,这个魔法足以让你来定制你自己的语言DSL, Rails就是Ruby在Web的DSL.
收藏 0 赞 0 分享

Ruby self在不同环境的含义

Ruby的self在不同的环境中有不同的含义,这点和java的this不同,原因是java实际上只有一种环境--在class的实例方法定义中使用,代表访问这个方法参数自动传进的那个对象。
收藏 0 赞 0 分享

ruby 程序的执行顺序

ruby程序的执行是顺序执行的,他是从脚本的第一行执行到最后一行,但是实际执行顺序是
收藏 0 赞 0 分享

ruby on rails 代码技巧

对于rails的一些使用技巧的代码
收藏 0 赞 0 分享

ruby 标准类型总结

诠释分析了ruby的标准类型,学习ruby的朋友,需要了解和掌握的。
收藏 0 赞 0 分享

ruby 去掉文件里重复的行

以前合并后台字典时,有重复的都是用vbs去,最近又看了一天的ruby,想起来写一下,没想到代码如此精简
收藏 0 赞 0 分享

Ruby rails 页面跳转(render和redirect_to)

今天在做R.R.log的时候发现个问题,在修改密码的时候如果没有通过校验,没有显示校验错误的信息。
收藏 0 赞 0 分享

Ruby 取得指定月日期数的方法

取得指定月日期数的Ruby代码
收藏 0 赞 0 分享
查看更多