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メソッドを実装してください。

オプションの種類

組み込みオプションの種類は次のとおりです。

 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としてマークされたオプション。その型と一致しない引数 (つまり、 integerのbla ): 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です。