如何使用Ruby进行Shell脚本编写?


165

我要执行一些简单的Shell脚本编写任务

例如:从匹配某个正则表达式的文件列表中选择工作目录中的文件。

我知道我可以使用标准的bash和grep来做这种事情,但是我很高兴能够破解可以在Windows和Linux中运行的快速脚本,而无需记住大量的命令行程序和标志等。

我试图解决这个问题,但最终对应该在哪里获取信息(例如对当前目录的引用)感到困惑

所以问题是编写红宝石外壳脚本我需要知道Ruby库的哪些部分?


3
可能不是一个很好的答案,但是实用的Ruby for System Administration是一个很好的参考。amazon.com/Practical-System-Administration-Experts-Source/dp/...
exiquio

Answers:


148

默认情况下,您已经可以访问DirFile,它们本身非常有用。

Dir['*.rb'] #basic globs
Dir['**/*.rb'] #** == any depth of directory, including current dir.
#=> array of relative names

File.expand_path('~/file.txt') #=> "/User/mat/file.txt"
File.dirname('dir/file.txt') #=> 'dir'
File.basename('dir/file.txt') #=> 'file.txt'
File.join('a', 'bunch', 'of', 'strings') #=> 'a/bunch/of/strings'

__FILE__ #=> the name of the current file

从stdlib也有用的是FileUtils

require 'fileutils' #I know, no underscore is not ruby-like
include FileUtils
# Gives you access (without prepending by 'FileUtils.') to
cd(dir, options)
cd(dir, options) {|dir| .... }
pwd()
mkdir(dir, options)
mkdir(list, options)
mkdir_p(dir, options)
mkdir_p(list, options)
rmdir(dir, options)
rmdir(list, options)
ln(old, new, options)
ln(list, destdir, options)
ln_s(old, new, options)
ln_s(list, destdir, options)
ln_sf(src, dest, options)
cp(src, dest, options)
cp(list, dir, options)
cp_r(src, dest, options)
cp_r(list, dir, options)
mv(src, dest, options)
mv(list, dir, options)
rm(list, options)
rm_r(list, options)
rm_rf(list, options)
install(src, dest, mode = <src's>, options)
chmod(mode, list, options)
chmod_R(mode, list, options)
chown(user, group, list, options)
chown_R(user, group, list, options)
touch(list, options)

哪个很好


110

正如其他人已经说过的那样,您的第一行应该是

#!/usr/bin/env ruby

而且您还必须使其可执行:(在shell中)

chmod +x test.rb

然后遵循红宝石代码。如果您打开一个文件

File.open("file", "r") do |io|
    # do something with io
end

该文件将在您将pwd在Shell中获得的当前目录中打开。

脚本的路径也很容易获得。有了$0外壳程序的第一个参数,它就是脚本的相对路径。绝对路径可以这样确定:

#!/usr/bin/env ruby
require 'pathname'
p Pathname.new($0).realpath()

对于文件系统操作,我几乎总是使用路径名。这是许多其他与文件系统相关的类的包装。也有用:Dir,File ...


66

这是其他答案中缺少的重要内容:命令行参数通过ARGV(全局)数组向Ruby Shell脚本公开。

因此,如果您有一个名为my_shell_script的脚本:

#!/usr/bin/env ruby
puts "I was passed: "
ARGV.each do |value|
  puts value
end

...使其可执行(正如其他人提到的那样):

chmod u+x my_shell_script

并这样称呼它:

> ./my_shell_script one two three four five

你会得到这个:

I was passed: 
one
two
three
four
five

这些参数可以很好地与文件名扩展一起使用:

./my_shell_script *

I was passed: 
a_file_in_the_current_directory
another_file    
my_shell_script
the_last_file

大多数操作仅在UNIX(Linux,Mac OS X)上有效,但是您可以在Windows中执行类似(尽管不太方便)的操作。


32

这里有很多好的建议,所以我想再添加一点。

  1. 反引号(或反引号)使您可以更轻松地执行一些脚本编写工作。考虑

    puts `find . | grep -i lib`
  2. 如果您在获取反引号的输出时遇到问题,则这些内容将变为标准err而不是标准输出。使用此建议

    out = `git status 2>&1`
  3. 反引号进行字符串插值:

    blah = 'lib'
    `touch #{blah}`
  4. 您也可以在Ruby中使用管道。这是我博客的链接,但它链接回到这里,所以没关系:)关于这个主题,可能还有更高级的内容。

  5. 正如其他人指出的那样,如果您想变得认真一点,那就会有Rush:不仅是作为Shell的替代品(对我来说有点太可笑了),而且还可以作为您在Shell脚本和程序中使用的库。


在Mac上,请在Ruby中使用Applescript以获得更多功能。这是我的shell_here脚本:

#!/usr/bin/env ruby
`env | pbcopy` 
cmd =  %Q@tell app "Terminal" to do script "$(paste_env)"@
puts cmd

`osascript -e "${cmd}"`

我只需要缩进代码4个空格就可以对其进行格式化。我也把反引号放回去了,但是我一点都不了解Ruby,因此您需要检查以确保它符合您的意图。
比尔蜥蜴2010年

@比尔蜥蜴,是的,那是我需要的“技巧”:双缩进。谢谢您的帮助。
Dan Rosenstark 2010年


22

去给自己一个Ruby日常脚本的副本。它具有许多有用的技巧,可指导您如何做自己想做的事情。


2
好书,我现在正在阅读:感觉就像是一次禅代码之旅。而且,如果您不了解TDD,则可以一路学习TDD的基础知识。
塞巴斯蒂安RoccaSerra

我认为这本书有一些不错的信息,但对经验丰富的程序员来说却有很多开销。
D


12

假设您编写了script.rb脚本。放:

#!/usr/bin/env ruby

作为第一行,并做一个 chmod +x script.rb


7

当您想编写更复杂的ruby脚本时,这些工具可能会有所帮助:

例如:

  • thor(脚本框架)

  • gli(类似于git的界面)

  • 美沙酮(用于创建简单工具)

它们使您可以快速开始编写自己的脚本,尤其是“命令行应用程序”。


5

当使用Ruby作为shell脚本时,以上答案很有趣并且非常有帮助。对我来说,我不使用Ruby作为日常语言,我更喜欢仅将ruby用作流控制,并且仍然使用bash来完成任务。

一些辅助功能可用于测试执行结果

#!/usr/bin/env ruby
module ShellHelper
  def test(command)
    `#{command} 2> /dev/null`
    $?.success?
  end

  def execute(command, raise_on_error = true)
    result = `#{command}`
    raise "execute command failed\n" if (not $?.success?) and raise_on_error
    return $?.success?
  end

  def print_exit(message)
    print "#{message}\n"
    exit
  end

  module_function :execute, :print_exit, :test
end

使用helper,ruby脚本可以像bash一样:

#!/usr/bin/env ruby
require './shell_helper'
include ShellHelper

print_exit "config already exists" if test "ls config"

things.each do |thing|
  next if not test "ls #{thing}/config"
  execute "cp -fr #{thing}/config_template config/#{thing}"
end

伙计,这太好了,谢谢!
Victor Martins

4

“如何编写红宝石”超出了SO的范围。

但是要将这些ruby脚本转换为可执行脚本,请将其作为ruby脚本的第一行:

#!/path/to/ruby

然后使文件可执行:

chmod a+x myscript.rb

而你走了。



3

webmat的答案是完美的。我只想指出一个补充。如果您需要为脚本处理很多命令行参数,则应使用optparse。它很简单,可以极大地帮助您。


3

在ruby中,常量__FILE__将始终为您提供正在运行的脚本的路径。

在Linux上,/usr/bin/env是您的朋友:

#! /usr/bin/env ruby
# Extension of this script does not matter as long
# as it is executable (chmod +x)
puts File.expand_path(__FILE__)

在Windows上,它取决于.rb文件是否与ruby相关联。如果他们是:

# This script filename must end with .rb
puts File.expand_path(__FILE__)

如果不是,则必须在它们上显式调用ruby,我使用一个中间.cmd文件:

my_script.cmd:

@ruby %~dp0\my_script.rb

my_script.rb:

puts File.expand_path(__FILE__)
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.