slop下载 - slop源代码下载

斜坡

Slop 是一个简单的选项解析器，具有易于记忆的语法和友好的 API。

安装

 gem install slop

用法

 opts = Slop . parse do | o |
  o . string '-h' , '--host' , 'a hostname'
  o . integer '--port' , 'custom port' , default : 80
  o . string '-l' , '--login' , required : true
  o . symbol '-m' , '--method' , default : :get
  o . bool '-v' , '--verbose' , 'enable verbose mode'
  o . bool '-q' , '--quiet' , 'suppress output (quiet mode)'
  o . bool '-c' , '--check-ssl-certificate' , 'check SSL certificate for host'
  o . bool '-k' , '--use-keychain' , 'store passphrase in OS keychain'
  o . on '--version' , 'print the version' do
    puts Slop :: VERSION
    exit
  end
end

ARGV #=> -v --login alice --host 192.168.0.1 -m post --check-ssl-certificate --use-keychain false

opts [ :host ]         #=> 192.168.0.1
opts [ :login ]        #=> alice
opts [ :method ]       #=> :post
opts [ :use_keychain ] #=> false

# We can also check if a flag was passed (this has no bearing on the options default value):
opts . use_keychain?          #=> true
opts . verbose?               #=> true
opts . quiet?                 #=> false
opts . check_ssl_certificate? #=> true

opts . to_hash  #=> { host: "192.168.0.1", port: 80, login: "alice", method: :post, verbose: true, quiet: false, check_ssl_certificate: true }

请注意，我们添加到--version标志的块将在解析时执行。因此，应保留这些块以立即对标志的存在做出反应。如果您想访问其他选项或改变值，请查看下面的“自定义选项类型”部分并实现#finish方法。

选项类型

内置Option类型如下：

 o . string  #=> Slop::StringOption, expects an argument
o . bool    #=> Slop::BoolOption, argument optional, aliased to BooleanOption
o . integer #=> Slop::IntegerOption, expects an argument, aliased to IntOption
o . float   #=> Slop::FloatOption, expects an argument
o . array   #=> Slop::ArrayOption, expects an argument
o . regexp  #=> Slop::RegexpOption, expects an argument
o . symbol  #=> Slop::SymbolOption, expects an argument
o . null    #=> Slop::NullOption, no argument and ignored from `to_hash`
o . on      #=> alias for o.null

您可以在slop/types.rb中看到所有内置类型。欢迎提出更多类型的建议或拉取请求。

高级用法

这个例子实际上只是为了描述底层 API 是如何工作的。这不一定是最好的方法。

 opts = Slop :: Options . new
opts . banner = "usage: connect [options] ..."
opts . separator ""
opts . separator "Connection options:"
opts . string "-H" , "--hostname" , "a hostname"
opts . int "-p" , "--port" , "a port" , default : 80
opts . separator ""
opts . separator "Extra options:"
opts . array "--files" , "a list of files to import"
opts . bool "-v" , "--verbose" , "enable verbose mode" , default : true

parser = Slop :: Parser . new ( opts )
result = parser . parse ( [ "--hostname" , "192.168.0.1" , "--no-verbose" ] )

result . to_hash #=> { hostname: "192.168.0.1", port: 80,
                 #     files: [], verbose: false }

puts opts # prints out help

论点

想要检索解析器未处理的参数数组（即选项或消耗的参数）是很常见的。您可以使用Result#arguments方法来做到这一点：

 args = %w( connect --host google.com GET )
opts = Slop . parse args do | o |
  o . string '--host'
end

p opts . arguments #=> ["connect", "GET"] # also aliased to `args`

这在使用ARGF编写脚本时特别有用：

 opts = Slop . parse do | blah |
  # ...
end

# make sure sloptions aren't consumed by ARGF
ARGV . replace opts . arguments

ARGF . each { | line |
  # ...
}

数组

Slop 有一个内置的ArrayOption用于处理数组值：

 opts = Slop . parse do | o |
  # the delimiter defaults to ','
  o . array '--files' , 'a list of files' , delimiter : ','
end

# Both of these will return o[:files] as ["foo.txt", "bar.rb"]:
# --files foo.txt,bar.rb
# --files foo.txt --files bar.rb
# This will return o[:files] as []:
# --files ""

如果要禁用内置字符串分割，请将分隔符设置为nil 。

自定义选项类型

Slop 对添加的每个新选项使用选项类型类。它们默认为NullOption 。当您输入o.array Slop 时，它会查找名为Slop::ArrayOption的选项。该类必须至少包含 1 个方法call 。该方法在解析时执行，该方法的返回值用作选项值。我们可以用它来构建自定义选项类型：

 module Slop
  class PathOption < Option
    def call ( value )
      Pathname . new ( value )
    end
  end
end

opts = Slop . parse %w( --path ~/ ) do | o |
  o . path '--path' , 'a custom path name'
end

p opts [ :path ] #=> #<Pathname:~/>

自定义选项还可以实现finish方法。默认情况下，此方法不执行任何操作，但它会在解析完所有选项后执行。这允许我们返回并改变状态，而不必依赖于以特定顺序解析的选项。这是一个例子：

 module Slop
  class FilesOption < ArrayOption
    def finish ( opts )
      if opts . expand?
        self . value = value . map { | f | File . expand_path ( f ) }
      end
    end
  end
end

opts = Slop . parse %w( --files foo.txt,bar.rb -e ) do | o |
  o . files '--files' , 'an array of files'
  o . bool '-e' , '--expand' , 'if used, list of files will be expanded'
end

p opts [ :files ] #=> ["/full/path/foo.txt", "/full/path/bar.rb"]

错误

Slop 会引发以下错误：

当需要参数时不使用参数的选项： Slop::MissingArgument
Slop 不知道使用的选项： Slop::UnknownOption
未提供时标记为required选项： Slop::MissingRequiredOption
标记为validate_types选项，其参数与其类型不匹配（即bla代表integer ）： Slop::InvalidOptionValue

这些错误继承自Slop::Error ，因此您可以将它们全部挽救。或者，您可以使用suppress_errors配置选项来抑制这些错误：

 opts = Slop . parse suppress_errors : true do
  o . string '-name'
end

# or per option:

opts = Slop . parse do
  o . string '-host' , suppress_errors : true
  o . int '-port'
end

验证类型

默认情况下，Slop 不会验证参数是否为给定选项的有效值；相反，如果该选项有默认值，它将覆盖提供的无效参数。为了让类型（例如integer和float ）验证并指示提供的值无效，可以向参数本身或其选项集提供额外的选项：

 opts = Slop :: Options . new
opts . int "-p" , "--port" , "a port" , default : 80 , validate_types : true

parser = Slop :: Parser . new ( opts )
result = parser . parse ( [ "--port" , "bla" ] )
# invalid value for -p, --port (Slop::InvalidOptionValue)

# Or to the option set...
opts = Slop :: Options . new ( validate_types : true )
opts . int "-p" , "--port" , "a port" , default : 80

parser = Slop :: Parser . new ( opts )
result = parser . parse ( [ "--port" , "bla" ] )
# invalid value for -p, --port (Slop::InvalidOptionValue)

打印帮助

Slop.parse的返回值是Slop::Result ，它提供了一个很好的帮助字符串来显示您的选项。只需puts opts或调用opts.to_s ：

 opts = Slop . parse do | o |
  o . string '-h' , '--host' , 'hostname'
  o . int '-p' , '--port' , 'port (default: 80)' , default : 80
  o . string '--username'
  o . separator ''
  o . separator 'other options:'
  o . bool '--quiet' , 'suppress output'
  o . on '-v' , '--version' do
    puts "1.1.1"
  end
end

puts opts

输出：

 % ruby run.rb
usage: run.rb [options]
    -h, --host     hostname
    -p, --port     port (default: 80)
    --username

other options:
    --quiet        suppress output
    -v, --version

此方法采用可选的prefix值，默认为" " * 4 ：