ライブラリ
クラス
-
Gem
:: Command (1) -
OpenSSL
:: SSL :: SSLContext (1) - OptionParser (10)
-
Psych
:: Nodes :: Node (2) -
RDoc
:: Options (11) -
Rake
:: FileTask (2) - Regexp (1)
- String (8)
モジュール
キーワード
-
add
_ option (1) - capitalize! (1)
-
coverage
_ report (1) - downcase! (1)
- encode (3)
-
extra
_ accessors (1) - help (1)
- load (1)
-
main
_ page (1) - merge (1)
- needed? (1)
-
on
_ head (1) -
on
_ tail (1) - open (2)
-
option
_ parser (1) - order! (2)
-
page
_ dir (1) -
parse
_ csv (1) - read (1)
- separator (1)
- swapcase! (1)
-
template
_ dir (1) - title (1)
-
to
_ a (1) -
to
_ s (1) -
to
_ yaml (1) - upcase! (1)
- ver (1)
- verbosity (1)
- visibility (1)
- webcvs (1)
- yaml (1)
検索結果
先頭5件
-
OptionParser
:: Arguable # options -> OptionParser (81952.0) -
自身をパースするための OptionParser オブジェクトを返します。 初回呼び出し時に自動的に生成されます。 この OptionParser#default_argv には self がセットされています。
自身をパースするための OptionParser オブジェクトを返します。
初回呼び出し時に自動的に生成されます。
この OptionParser#default_argv には self がセットされています。
ブロックを与えた場合は、OptionParser を引数としてブロックを実行します。
ブロックの実行結果を返します。
ブロックの実行途中で OptionParser::ParseError
が発生した場合は、全て rescue し、エラーメッセージを出力し、
nil を返します。
//emlist[][ruby]{
require 'optparse'
o = nil
ARG... -
OptionParser
:: Arguable # options {|opt| . . . } -> object | nil (81952.0) -
自身をパースするための OptionParser オブジェクトを返します。 初回呼び出し時に自動的に生成されます。 この OptionParser#default_argv には self がセットされています。
自身をパースするための OptionParser オブジェクトを返します。
初回呼び出し時に自動的に生成されます。
この OptionParser#default_argv には self がセットされています。
ブロックを与えた場合は、OptionParser を引数としてブロックを実行します。
ブロックの実行結果を返します。
ブロックの実行途中で OptionParser::ParseError
が発生した場合は、全て rescue し、エラーメッセージを出力し、
nil を返します。
//emlist[][ruby]{
require 'optparse'
o = nil
ARG... -
OpenSSL
:: SSL :: SSLContext # options -> Integer | nil (72928.0) -
設定されているオプションフラグを返します。
設定されているオプションフラグを返します。
@see OpenSSL::SSL::SSLContext#options= -
Regexp
# options -> Integer (72841.0) -
正規表現の生成時に指定されたオプションを返します。戻り値は、 Regexp::EXTENDED, Regexp::IGNORECASE, Regexp::MULTILINE, Regexp::FIXEDENCODING, Regexp::NOENCODING, の論理和です。
正規表現の生成時に指定されたオプションを返します。戻り値は、
Regexp::EXTENDED, Regexp::IGNORECASE,
Regexp::MULTILINE,
Regexp::FIXEDENCODING,
Regexp::NOENCODING,
の論理和です。
これで得られるオプションには生成時に指定したもの以外の
オプションを含んでいる場合があります。これらのビットは
内部的に用いられているもので、Regexp.new にこれらを
渡しても無視されます。
//emlist[例][ruby]{
p Regexp::IGNORECASE # => 1
p //i.optio... -
RDoc
:: Options # option _ parser -> OptionParser | nil (36907.0) -
コマンドライン引数の解析のための OptionParser オブジェクトを返し ます。
コマンドライン引数の解析のための OptionParser オブジェクトを返し
ます。 -
RDoc
:: Options # template _ dir -> String | nil (36907.0) -
コマンドライン引数の --template オプションで指定したテンプレートに対応 するディレクトリを返します。
コマンドライン引数の --template オプションで指定したテンプレートに対応
するディレクトリを返します。
オプションの解析前は nil を返します。 -
RDoc
:: Options # title -> String | nil (36607.0) -
ドキュメントのタイトルを返します。指定されていない場合は nil を返します。
ドキュメントのタイトルを返します。指定されていない場合は nil を返します。 -
Rake
:: FileTask # timestamp -> Time | Rake :: LateTime (28261.0) -
ファイルタスクのタイムスタンプを返します。
ファイルタスクのタイムスタンプを返します。
//emlist[][ruby]{
# Rakefile での記載例とする
task default: "test.txt"
file "test.txt" do |task|
Rake.application.options.build_all = false
task.timestamp # => #<Rake::LateTime:0x2ba58f0>
end
//} -
RDoc
:: Options # verbosity -> 0 | 1 | 2 (27910.0) -
プログラムの解析時に表示する情報の詳細さを数値で返します。
プログラムの解析時に表示する情報の詳細さを数値で返します。
以下の値を指定する事ができます。
: 0(--quiet オプションを指定した場合)
情報を表示しません。
: 1
通常の表示を行います。
: 2(--verbose オプションを指定した場合)
詳細な情報を表示します。 -
RDoc
:: Options # visibility -> :public | :protected | :private (27910.0) -
コマンドライン引数の --visibility で指定したオプションを Symbol で返します。
コマンドライン引数の --visibility で指定したオプションを Symbol
で返します。 -
RDoc
:: Options # coverage _ report -> Integer | false (27607.0) -
コマンドライン引数の --coverage-report オプションを指定していた場合、指 定した数値を返します。
コマンドライン引数の --coverage-report オプションを指定していた場合、指
定した数値を返します。
指定しなかった場合は false を返します。 -
RDoc
:: Options # extra _ accessors -> Regexp | nil (27607.0) -
コマンドライン引数の --accessor オプションで指定したアクセサの名前すべ てにマッチする正規表現オブジェクトを返します。
コマンドライン引数の --accessor オプションで指定したアクセサの名前すべ
てにマッチする正規表現オブジェクトを返します。
指定しなかった場合は nil を返します。 -
Gem
:: Command # add _ option(*opts) {|value , options| . . . } (19210.0) -
コマンドに対するコマンドラインオプションとハンドラを追加します。
コマンドに対するコマンドラインオプションとハンドラを追加します。
ブロックには、コマンドライン引数の値とそのオプションが渡されます。
オプションはハッシュになっています。
@param opts オプションを指定します。
@see OptionParser#make_switch -
Psych
:: Nodes :: Node # to _ yaml(io=nil , options={}) -> String | IO (18952.0) -
AST を YAML ドキュメントに変換します。
AST を YAML ドキュメントに変換します。
io に IO オブジェクトを指定した場合は、その
オブジェクトに変換後のドキュメントが書き込まれます。
この場合は io を返り値として返します。
io を省略した(nil を指定した)場合には変換後のドキュメントを
文字列で返します。
Psych::Nodes::Stream 以外を変換しようとすると、AST として不正で
あるためエラーが発生します。
options には以下が指定できます。
: :version
YAML document に付加するバージョンを [major, minor] という配列、
もしくは文... -
String
# capitalize!(*options) -> self | nil (18928.0) -
文字列先頭の文字を大文字に、残りを小文字に破壊的に変更します。
文字列先頭の文字を大文字に、残りを小文字に破壊的に変更します。
@param options オプションの詳細は String#downcase を参照してください。
@return capitalize! は self を変更して返しますが、
変更が起こらなかった場合は nil を返します。
//emlist[例][ruby]{
str = "foobar"
str.capitalize!
p str # => "Foobar"
str = "fooBAR"
str.capitalize!
p str # => "Foobar"
//}
@see Stri... -
RDoc
:: Options # main _ page -> String | nil (18607.0) -
コマンドライン引数の --main オプションで指定したファイル名、クラス/モ ジュール名を返します。
コマンドライン引数の --main オプションで指定したファイル名、クラス/モ
ジュール名を返します。
指定しなかった場合は nil を返します。 -
RDoc
:: Options # merge -> true | nil (18607.0) -
コマンドライン引数の --merge オプションを指定していた場合、true を返し ます。そうでない場合は nil を返します。
コマンドライン引数の --merge オプションを指定していた場合、true を返し
ます。そうでない場合は nil を返します。 -
RDoc
:: Options # page _ dir -> Pathname | nil (18607.0) -
コマンドライン引数の --page-dir オプションで指定したディレクトリを返し ます。
コマンドライン引数の --page-dir オプションで指定したディレクトリを返し
ます。
指定されていない場合は nil を返します。 -
RDoc
:: Options # webcvs -> String | nil (18607.0) -
コマンドライン引数の --webcvs オプションで指定した URL を文字列で返しま す。
コマンドライン引数の --webcvs オプションで指定した URL を文字列で返しま
す。
指定しなかった場合は nil を返します。 -
OptionParser
# to _ s -> String (18448.0) -
サマリの文字列を返します。
サマリの文字列を返します。
//emlist[例][ruby]{
require "optparse"
options = {}
opts = OptionParser.new do |opts|
opts.banner = "Usage: example.rb [options]"
opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
options[:verbose] = v
end
end
puts opts.help
# => Usage: example.rb [options]
# -v... -
OptionParser
# separator(sep) -> () (18412.0) -
サマリにオプションを区切るための文字列 sep を挿入します。 オプションにいくつかの種類がある場合に、サマリがわかりやすくなります。
サマリにオプションを区切るための文字列 sep を挿入します。
オプションにいくつかの種類がある場合に、サマリがわかりやすくなります。
サマリには on メソッドを呼んだ順にオプションが表示されるので、区切りを挿入したい
ところでこのメソッドを呼びます。
@param sep サマリの区切りを文字列で指定します。
//emlist[][ruby]{
require 'optparse'
opts = OptionParser.new
opts.banner = "Usage: example.rb [options]"
opts.separator ""
opts.separator... -
OptionParser
# on _ tail(*arg , &block) -> self (18358.0) -
オプションを取り扱うためのブロックを自身の持つリストの最後に登録します。
オプションを取り扱うためのブロックを自身の持つリストの最後に登録します。
--version や --help の説明をサマリの最後に表示したい時に便利です。
@param arg OptionParser#on と同様です。
@param block OptionParser#on と同様です。
//emlist[例][ruby]{
require "optparse"
opts = OptionParser.new do |opts|
opts.on_head("-i", "--init")
opts.on("-u", "--update")
opts.on_tai... -
OptionParser
# to _ a -> [String] (18358.0) -
サマリの各行を要素とした配列を返します。
サマリの各行を要素とした配列を返します。
//emlist[例][ruby]{
require "optparse"
opts = OptionParser.new do |opts|
opts.on_head("-i", "--init")
opts.on("-u", "--update")
opts.on_tail("-h", "--help")
end
opts.to_a # => ["Usage: test [options]", " -i, --init\n", " -u, --update\n", " -h, --help\n"]
//} -
Psych
:: Nodes :: Node # yaml(io=nil , options={}) -> String | IO (9952.0) -
AST を YAML ドキュメントに変換します。
AST を YAML ドキュメントに変換します。
io に IO オブジェクトを指定した場合は、その
オブジェクトに変換後のドキュメントが書き込まれます。
この場合は io を返り値として返します。
io を省略した(nil を指定した)場合には変換後のドキュメントを
文字列で返します。
Psych::Nodes::Stream 以外を変換しようとすると、AST として不正で
あるためエラーが発生します。
options には以下が指定できます。
: :version
YAML document に付加するバージョンを [major, minor] という配列、
もしくは文... -
String
# downcase!(*options) -> self | nil (9928.0) -
全ての大文字を対応する小文字に破壊的に置き換えます。 どの文字がどう置き換えられるかは、オプションの有無や文字列のエンコーディングに依存します。
全ての大文字を対応する小文字に破壊的に置き換えます。
どの文字がどう置き換えられるかは、オプションの有無や文字列のエンコーディングに依存します。
@param options オプションの詳細は String#downcase を参照してください。
@return self を変更して返します。変更が無かった場合は nil を返します。
//emlist[例][ruby]{
str = "STRing?"
str.downcase!
p str # => "string?"
//}
@see String#downcase, String#upcase!, String#swapc... -
String
# swapcase!(*options) -> self | nil (9928.0) -
大文字を小文字に、小文字を大文字に破壊的に変更します。
大文字を小文字に、小文字を大文字に破壊的に変更します。
@param options オプションの詳細は String#downcase を参照してください。
swapcase! は self を変更して返しますが、
置換が起こらなかった場合は nil を返します。
このメソッドはマルチバイト文字を認識しません。
//emlist[例][ruby]{
str = "ABCxyz"
str.swapcase!
p str # => "abcXYZ"
//}
@see String#swapcase, String#upcase!, String#downcase!, String... -
String
# upcase!(*options) -> self | nil (9928.0) -
全ての小文字を対応する大文字に破壊的に置き換えます。 どの文字がどう置き換えられるかは、オプションの有無や文字列のエンコーディングに依存します。
全ての小文字を対応する大文字に破壊的に置き換えます。
どの文字がどう置き換えられるかは、オプションの有無や文字列のエンコーディングに依存します。
@param options オプションの詳細は String#downcase を参照してください。
//emlist[例][ruby]{
buf = "stRIng? STring."
buf.upcase!
p buf # => "STRING? STRING."
//}
@see String#upcase, String#downcase!,
String#swapcase!, String#capitalize! -
String
# parse _ csv(**options) -> [String] (9691.0) -
CSV.parse_line(self, options) と同様です。
CSV.parse_line(self, options) と同様です。
1 行の CSV 文字列を、文字列の配列に変換するためのショートカットです。
@param options CSV.new と同様のオプションを指定します。
//emlist[][ruby]{
require "csv"
p "Matz,Ruby\n".parse_csv # => ["Matz", "Ruby"]
p "Matz|Ruby\r\n".parse_csv(col_sep: '|', row_sep: "\r\n") # => ... -
String
# encode(**options) -> String (9649.0) -
self を指定したエンコーディングに変換した文字列を作成して返します。引数 を2つ与えた場合、第二引数は変換元のエンコーディングを意味します。さもな くば self のエンコーディングが使われます。 無引数の場合は、Encoding.default_internal が nil でなければそれが変換先のエンコーディングになり、かつ :invalid => :replace と :undef => :replace が指定されたと見なされ、nil ならば変換は行われません。
self を指定したエンコーディングに変換した文字列を作成して返します。引数
を2つ与えた場合、第二引数は変換元のエンコーディングを意味します。さもな
くば self のエンコーディングが使われます。
無引数の場合は、Encoding.default_internal が nil でなければそれが変換先のエンコーディングになり、かつ :invalid => :replace と :undef => :replace が指定されたと見なされ、nil ならば変換は行われません。
@param encoding 変換先のエンコーディングを表す文字列か Encoding オブジェクトを... -
String
# encode(encoding , **options) -> String (9649.0) -
self を指定したエンコーディングに変換した文字列を作成して返します。引数 を2つ与えた場合、第二引数は変換元のエンコーディングを意味します。さもな くば self のエンコーディングが使われます。 無引数の場合は、Encoding.default_internal が nil でなければそれが変換先のエンコーディングになり、かつ :invalid => :replace と :undef => :replace が指定されたと見なされ、nil ならば変換は行われません。
self を指定したエンコーディングに変換した文字列を作成して返します。引数
を2つ与えた場合、第二引数は変換元のエンコーディングを意味します。さもな
くば self のエンコーディングが使われます。
無引数の場合は、Encoding.default_internal が nil でなければそれが変換先のエンコーディングになり、かつ :invalid => :replace と :undef => :replace が指定されたと見なされ、nil ならば変換は行われません。
@param encoding 変換先のエンコーディングを表す文字列か Encoding オブジェクトを... -
String
# encode(encoding , from _ encoding , **options) -> String (9649.0) -
self を指定したエンコーディングに変換した文字列を作成して返します。引数 を2つ与えた場合、第二引数は変換元のエンコーディングを意味します。さもな くば self のエンコーディングが使われます。 無引数の場合は、Encoding.default_internal が nil でなければそれが変換先のエンコーディングになり、かつ :invalid => :replace と :undef => :replace が指定されたと見なされ、nil ならば変換は行われません。
self を指定したエンコーディングに変換した文字列を作成して返します。引数
を2つ与えた場合、第二引数は変換元のエンコーディングを意味します。さもな
くば self のエンコーディングが使われます。
無引数の場合は、Encoding.default_internal が nil でなければそれが変換先のエンコーディングになり、かつ :invalid => :replace と :undef => :replace が指定されたと見なされ、nil ならば変換は行われません。
@param encoding 変換先のエンコーディングを表す文字列か Encoding オブジェクトを... -
OptionParser
:: Arguable # order! {|s| . . . } -> [String] (9625.0) -
自身を破壊的にパースし、パースされずに残った引数を文字列の配列として返します。 OptionParser#order! を参照して下さい。
自身を破壊的にパースし、パースされずに残った引数を文字列の配列として返します。
OptionParser#order! を参照して下さい。
@raise OptionParser::ParseError 自身のパースに失敗した場合、発生します。
実際は OptionParser::ParseError のサブク
ラスの例外になります。
//emlist[][ruby]{
require 'optparse'
o = nil
ARGV.options.on('-... -
OptionParser
# banner -> String (9448.0) -
サマリの最初に表示される文字列を返します。
サマリの最初に表示される文字列を返します。
@return サマリの最初に表示される文字列を返します。
//emlist[例][ruby]{
require "optparse"
options = {}
opts = OptionParser.new do |opts|
opts.banner = "Usage: example.rb [options]"
opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
options[:verbose] = v
end
end
p opts.banner # =... -
OptionParser
# help -> String (9448.0) -
サマリの文字列を返します。
サマリの文字列を返します。
//emlist[例][ruby]{
require "optparse"
options = {}
opts = OptionParser.new do |opts|
opts.banner = "Usage: example.rb [options]"
opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
options[:verbose] = v
end
end
puts opts.help
# => Usage: example.rb [options]
# -v... -
OptionParser
# ver -> String (9358.0) -
program_name、version と release から生成したバージョンを表す文字列を返します。
program_name、version と release から生成したバージョンを表す文字列を返します。
//emlist[例][ruby]{
require "optparse"
OptionParser.new do |opts|
opts.banner = "Usage: example.rb [options]"
opts.program_name = "Optparse Example"
opts.version = [0, 1]
opts.release = "2019-05-01"
opts.on_tail("--version", "Show v... -
OptionParser
:: Arguable # order! -> [String] (9325.0) -
自身を破壊的にパースし、パースされずに残った引数を文字列の配列として返します。 OptionParser#order! を参照して下さい。
自身を破壊的にパースし、パースされずに残った引数を文字列の配列として返します。
OptionParser#order! を参照して下さい。
@raise OptionParser::ParseError 自身のパースに失敗した場合、発生します。
実際は OptionParser::ParseError のサブク
ラスの例外になります。
//emlist[][ruby]{
require 'optparse'
o = nil
ARGV.options.on('-... -
OptionParser
# load(filename = nil) -> bool (9238.0) -
指定された filename を読み込んで各行をまとめたものに対して OptionParser#parse を行ないます。
指定された filename を読み込んで各行をまとめたものに対して OptionParser#parse を行ないます。
パースが成功した場合に true を返します。
ファイルが存在しなかった場合に false を返します。
@param filename 各行をパースしたいファイルの名前を文字列で指定します。
指定されないか nil である場合、~/.options/ に
プログラムのサフィックスを付けた '~/.options/コマンド名' というファイルをパースします。
//emlist[例][ruby]{
re... -
OptionParser
# banner=(heading) (9166.0) -
サマリの最初に表示される文字列を指定します。
サマリの最初に表示される文字列を指定します。
@param heading サマリの最初に表示される文字列を指定します。
//emlist[例][ruby]{
require "optparse"
options = {}
opts = OptionParser.new do |opts|
opts.banner = "Usage: example.rb [options]" # => "Usage: example.rb [options]"
opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
option... -
OptionParser
# on _ head(*arg , &block) -> self (9058.0) -
オプションを取り扱うためのブロックを自身の持つリストの最初に登録します。
オプションを取り扱うためのブロックを自身の持つリストの最初に登録します。
@param arg OptionParser#on と同様です。
@param block OptionParser#on と同様です。
//emlist[例][ruby]{
require "optparse"
opts = OptionParser.new do |opts|
opts.on_head("-i", "--init")
opts.on("-u", "--update")
opts.on_tail("-h", "--help")
end
puts opts.help
# => ... -
Rake
:: FileTask # needed? -> bool (9058.0) -
このタスクが必要である場合は真を返します。 そうでない場合は偽を返します。
このタスクが必要である場合は真を返します。
そうでない場合は偽を返します。
このタスクで作成しようとしているファイルが存在しない場合や、
このタスクで作成しようとしているファイルが古い場合に真を返します。
//emlist[][ruby]{
# Rakefile での記載例とする
task default: "test.txt"
file "test.txt" do |task|
Rake.application.options.build_all = false
task.needed? # => true
IO.write("test.txt", "test")
t... -
OpenURI
:: OpenRead # open(mode = & # 39;r& # 39; , perm = nil , options = {}) {|sio| . . . } -> nil (931.0) -
自身が表すリソースを取得して StringIO オブジェクトとして返します。 OpenURI.open_uri(self, *rest, &block) と同じです。
自身が表すリソースを取得して StringIO オブジェクトとして返します。
OpenURI.open_uri(self, *rest, &block) と同じです。
ブロックを与えた場合は StringIO オブジェクトを引数としてブロックを
評価します。ブロックの終了時に StringIO は close されます。nil を返します。
返り値である StringIO オブジェクトは OpenURI::Meta モジュールで extend されています。
@param mode モードを文字列で与えます。Kernel.#open と同じです。
@param perm 無視されます... -
OpenURI
:: OpenRead # read(options = {}) -> String (721.0) -
自身が表す内容を読み込んで文字列として返します。 self.open(options={}) {|io| io.read } と同じです。 このメソッドによって返される文字列は OpenURI::Meta によって extend されています。
自身が表す内容を読み込んで文字列として返します。
self.open(options={}) {|io| io.read } と同じです。
このメソッドによって返される文字列は OpenURI::Meta
によって extend されています。
@param options ハッシュを与えます。
require 'open-uri'
uri = URI.parse('http://www.example.com/')
str = uri.read
p str.is_a?(OpenURI::Meta) # => true
p str.content_type -
OpenURI
:: OpenRead # open(mode = & # 39;r& # 39; , perm = nil , options = {}) -> StringIO (631.0) -
自身が表すリソースを取得して StringIO オブジェクトとして返します。 OpenURI.open_uri(self, *rest, &block) と同じです。
自身が表すリソースを取得して StringIO オブジェクトとして返します。
OpenURI.open_uri(self, *rest, &block) と同じです。
ブロックを与えた場合は StringIO オブジェクトを引数としてブロックを
評価します。ブロックの終了時に StringIO は close されます。nil を返します。
返り値である StringIO オブジェクトは OpenURI::Meta モジュールで extend されています。
@param mode モードを文字列で与えます。Kernel.#open と同じです。
@param perm 無視されます...