tetralabo

facets/boolean 解説

2011-10-25T07:27:23+09:00

膨大な数の拡張メソッドが収録されているRuby Facets。現時点で日本語のドキュメントが存在しないため、普通は英語のドキュメントを解読していくことになるのですが、メソッドを一つ一つ解読していくのは大変です。そこでこのblogでは、私的なメモも兼ねて、Ruby Facetsに収録されたライブラリを日本語で解説していきます。

第5回は、すべてのオブジェクトに真偽値（true / false）関連の変換・判定メソッドを追加する facets/boolean です。Ruby Facets 2.9.1に準拠しています。

駆け足紹介（クイックツアー）
Objectに追加されるインスタンスメソッド
- bool?
- to_b
- to_bool
- true?
- false?

駆け足紹介（クイックツアー）

require 'facets/boolean'

# to_bool : オブジェクトを真偽値に変換する
true.to_bool  # => true
nil.to_bool   # => false
'abc'.to_bool # => true

# to_b : 真値（フラグの有効値）とみなしてもよさそうな文字列や数値などをtrueに、それ以外の値をfalseに変換する。ただし一部の値はnilに変換する
"yes".to_b       # => true
"no".to_b        # => false
"on".to_b        # => true
"off".to_b       # => false
"unknown".to_b   # => false
"null".to_b      # => nil
1.to_b           # => true
0.to_b           # => false

true.to_b    # => true
false.to_b   # => false
nil.to_b     # => false

# bool? : オブジェクトが真偽値かどうかを判定する
'foo'.bool? # => false
30.bool?    # => false
true.bool?  # => true
false.bool? # => true
nil.bool?   # => false

# true? / false? : それぞれオブジェクトがtrueかどうか、falseかどうかを判定する
t = true
f = false
n = nil
s = 'foo'

t.true?   # => true
f.true?   # => false
n.true?   # => false
s.true?   # => false

f.false?  # => true
n.false?  # => false

Objectに追加されるインスタンスメソッド

`bool?`

オブジェクトが真偽値を表すオブジェクト（true, falseのどちらか）であるかどうかを判定します。

require 'facets/boolean'

'foo'.bool? # => false
30.bool?    # => false
true.bool?  # => true
false.bool? # => true
nil.bool?   # => false

`to_b`

真値（フラグの有効値）とみなしてもよさそうな文字列や数値などをtrueに、それ以外の値をfalseに変換します。ただし一部の値はnilに変換します。

to_boolメソッドとの違いは、実際に真であるか偽であるかにかかわらず、「真のように見える値」であればtrueに、「偽のように見える値」であればfalseに変換されるという点です。 Ruby Facets 2.9.1時点では、以下のような値が「真のように見える値」と見なされます。

文字列 'true', 'yes', 'on', 't', '1', 'y', '==' (大文字/小文字は区別しません。また、前後の空白は取り除いて判定します)
0以外の数値
空でない配列やハッシュ
true

逆に、以下のような値は「偽のように見える値」と見なされます。

上記以外の文字列
0と等しい数値（0, 0.0）
空の配列やハッシュ
false, nil

以下の値は、to_bメソッドによりnilに変換されます。

文字列 'null', 'nil' (大文字/小文字は区別しません。また、前後の空白は取り除いて判定します)

require 'facets/boolean'

"true".to_b      # => true
"false".to_b     # => false
"yes".to_b       # => true
"no".to_b        # => false
"on".to_b        # => true
"off".to_b       # => false
"unknown".to_b   # => false
"null".to_b      # => nil
1.to_b           # => true
0.to_b           # => false
0.0.to_b         # => false

"True".to_b       # => true
" TRUE ".to_b     # => true

['a'].to_b       # => true
[].to_b          # => false
{'a' => 1}.to_b  # => true
{}.to_b          # => false

true.to_b    # => true
false.to_b   # => false
nil.to_b     # => false

`to_bool`

オブジェクトを真偽値（trueオブジェクトかfalseオブジェクトのどちらか）に変換します。

require 'facets/boolean'

true.to_bool  # => true
nil.to_bool   # => false
'abc'.to_bool # => true

`true?`

`false?`

それぞれ、オブジェクトが実際にtrueであるかどうか / falseであるかどうかを判定します。

「その値が真か偽か」という判定ではなく、「実際に真偽値を表すオブジェクト（true, false）であるかどうか」という判定を行います。そのため、'str'.true? や 1.true? は false を返します。

require 'facets/boolean'

t = true
f = false
n = nil
s = 'foo'

t.true?   # => true
f.true?   # => false
n.true?   # => false
s.true?   # => false

t.false?  # => false
f.false?  # => true
n.false?  # => false
s.false?  # => false

NYAOS上でpikを動かすための設定（0.3.0pre対応版）

2011-09-19T18:11:51+09:00

nyaos で pik を使う設定と pik の動作原理 - *Trace Output*

上記ページで公開されている方法を使うと、NYAOS上でもpikを使ってrubyを切り替えることが可能になります。

しかし、上記関数はpik 0.2.8を使っていれば動作するのですが、最新のpik 0.3.0 preを使っている場合には動作しません（自動生成されるバッチファイルの名前が、pik.batからpik_run.batに変更されたためです）。そこで、pik 0.3.0 preにも対応できるように、上記ページで公開されている関数を書き換えました。

以下の関数定義を_nyaファイルに追加すると、pik 0.2.8とpik 0.3.0 preの両方をNYAOS上で使えるようになります。

# pikをNYAOS上で使うための関数
pik{
  pik_runner.exe pik.bat %*

  # pik 0.3.0 pre 以降対応
  if exist "%USERPROFILE%.pik\pik_run.bat" then
    source "%USERPROFILE%.pik\pik_run.bat" 2> nul
  else
    # pik 0.2.8 以前対応
    if exist "%USERPROFILE%.pik\pik.bat" then
      source "%USERPROFILE%.pik\pik.bat" 2> nul
    endif
  endif
}

※_nyaファイルの中にすでにpik関数の定義を追加している場合は、その定義を上記の関数定義で上書きしてください。

facets/exception 解説（Ruby Facets）

2010-02-06T11:45:00+09:00

第4回は例外（Exception）クラスを拡張する facets/exception です。Ruby Facets 2.8.1に準拠しています。

駆け足紹介（クイックツアー）
クラスメソッド
- Exception.suppress(*exception_classes) { ... }
インスタンスメソッド
- detail
- raised? { ... }

駆け足紹介（クイックツアー）

require 'facets/exception'

# detail: エラーの詳細を表示する
begin
    wrong_name_method
rescue NameError
    puts $!.detail
end
# 出力: 
# undefined local variable or method `wrong_name_method' for main:Object
#   exception-tour.rb:5
#   LOGGED FROM: exception-tour.rb:7


# Exception.suppress: 指定したクラスに属する例外を抑制する
Exception.suppress(NameError, ArgumentError) do
    wrong_name_method
end
puts "NameError is suppressed."

クラスメソッド

`Exception.suppress(*exception_classes) { ... }`

ブロック内において、指定したクラスの例外が発生しても、インタープリタの実行が終了されないようにするる。

引数には1つ以上の例外クラスを与える。ブロック実行中に何らかの例外が発生したとき、その例外が引数で指定した例外クラスのどれかに属している（kind_of? 判定で true になる）なら、そのままブロックを抜ける。

require 'facets/exception/suppress'

wrong_name_method
# undefined local variable or method `wrong_name_method' for main:Object (NameError)

Exception.suppress(NameError, ArgumentError) do
  wrong_name_method
end
# 何も起きない

インスタンスメソッド

`detail`

その例外の詳細を表す文字列を返す。バックトレースや呼び出し元などの情報を含んでおり、message や to_s よりも詳しい情報を得ることができる。

require 'facets/exception/detail'

begin
    wrong_name_method
rescue
    puts "-- Detail ----------------"
    puts $!.detail
end

-- Detail ----------------
undefined local variable or method `wrong_name_method' for main:Object
  exception-detail.rb:4
  LOGGED FROM: exception-detail.rb:7

`raised? { ... }`

ブロックの実行時に例外が発生するかどうかを判定するメソッドのようだが、現時点（Ruby Facets 2.8.1）では正常に動作しない。ソースコードを見る限り、rescue 節に例外クラスでない self を渡そうとしているため、もともと動作するはずがないメソッドのようだ。

class Exception
  # Does a block raise an a given +exception+.
  #
  def self.raised? #:yeild:
    begin
      yield
      false
    rescue self
      true
    end
  end
end

facets/numeric 解説（Ruby Facets）

2010-02-02T01:30:00+09:00

第2回は数値（Numeric）クラスを拡張する facets/numeric です。Ruby Facets 2.8.1に準拠しています。

駆け足紹介（クイックツアー）
インスタンスメソッド

駆け足紹介（クイックツアー）

require 'facets/numeric'

# round_at, round_to: 数値を任意の桁で丸める
p 25.1482.round_at(1)  # => 25.1
p 25.1482.round_at(2)  # => 25.15
p 25.1482.round_at(6)  # => 25.1482
p 25.1482.round_at(0)  # => 25.0
p 25.1482.round_at(-1) # => 30.0
p 25.1482.round_at(-2) # => 0.0

p 25.1482.round_to(0.1)      # => 25.1
p 25.1482.round_to(0.01)     # => 25.15
p 25.1482.round_to(1)        # => 25.0
p 25.1482.round_to(10)       # => 30.0


# distance: 減算（機能は - 演算子と同じ）
p 7.distance(4) # => 3

p ([1, 2, 3] - [2])       # => [1, 3]
p [1, 2, 3].distance([2]) # undefined method (NoMethodError)

インスタンスメソッド

`distance(other)`

self - otherと同じ。「数値同士での減算」を明示したいときに使う。

require 'facets/numeric/distance'

p 4.distance(3) # => 1  (4 - 3と同じ)

p ([1, 2, 3] - [2])       # => [1, 3]
p [1, 2, 3].distance([2]) # undefined method (NoMethodError)

`length`

`size`

何もしない（selfを返す）。

……のはずだが、sizeメソッドを整数に対して実行すると、なぜか意図通りの数値が返ってこない（rubyのバグ？）。

require 'facets/numeric/length'
require 'facets/numeric/size'

p 3.length      # => 3
p 2.5.length    # => 2.5

p 3.size      # => 4 (?)
p 4.size      # => 4
p 5.size      # => 4 (?)

p RUBY_DESCRIPTION  # =>"ruby 1.8.7 (2008-08-11 patchlevel 72) [i386-mswin32]"

`round_at(d)`

小数点以下d桁まで残し、近い方の数字に丸める（小数点以下d桁で四捨五入する）。返り値はかならずFloatになる。

dが0であれば整数部分のみを残す。
dが負の数であれば、整数部分までさかのぼって丸める。
dが小数（Float）だとうまく動作しない。

require 'facets/numeric/round'

p 25.1482.round_at(1)  # => 25.1
p 25.1482.round_at(2)  # => 25.15
p 25.1482.round_at(10) # => 25.1482
p 25.1482.round_at(0)  # => 25.0
p 25.1482.round_at(-1) # => 30.0
p 25.1482.round_at(-2) # => 0.0

p 25.round_at(2) # => 25.0

`round_to(n)`

round_atメソッドと機能は同じだが、引数が異なる。

require 'facets/numeric/round'

p 25.1482.round_to(0.1)      # => 25.1
p 25.1482.round_to(0.01)     # => 25.15
p 25.1482.round_to(0.000001) # => 25.1482
p 25.1482.round_to(1)        # => 25.0
p 25.1482.round_to(10)       # => 30.0
p 25.1482.round_to(100)      # => 0.0

p 25.round_to(0.01) # => 25.0

facets/time 解説（Ruby Facets）

2010-01-31T13:03:48+09:00

第1回はTimeクラスを拡張する facets/time です。Ruby Facets 2.8.1に準拠しています。

駆け足紹介（クイックツアー）
クラスメソッド
- Time.elapse { ... }
- Time.stamp(fmt)
インスタンスメソッド

駆け足紹介（クイックツアー）

require 'facets/time'

# Time.elapse: ブロックの実行時間を計測する
p Time.elapse{ sleep(1) }  # => 1.07800006866455


time = Time.now
p time  # => Sat Jan 30 21:41:42 +0900 2010

# hence, ago: 時間を進めたり戻したりできる
p time.hence(5, :days)  # => Thu Feb 04 21:41:42 +0900 2010
p time.ago(2, :weeks)   # => Sat Jan 16 21:41:42 +0900 2010


# change: 時刻のうち一部だけを書き換える
p time.change(:day => 2, :minute => 30) #=> Sat Jan 02 21:41:42 +0900 2010


# trunc, round: 時刻を指定した単位（秒）で丸める
#               60 なら1分単位、60 * 60 なら1時間単位
p time.trunc(60)       # => Sat Jan 30 21:41:00 +0900 2010
p time.trunc(60 * 60)  # => Sat Jan 30 21:00:00 +0900 2010
p time.round(60)       # => Sat Jan 30 21:42:00 +0900 2010
p time.round(60 * 60)  # => Sat Jan 30 22:00:00 +0900 2010


# stamp: 時刻を指定したフォーマットで文字列化
p time.stamp(:short)  # => "30 Jan 21:41"
p time.stamp(:time)   # => "21:41"
p time.stamp(:number) # => "20100130214142"
p time.stamp(:db)     # => "2010-01-30 21:41:42"

p Time.stamp(:db)     # Time.now.stamp(:db)と同じ

クラスメソッド

`Time.elapse { ... }`

ブロックの実行時間を計測し、結果をFloatで返す（Benchmark.realtime と同じ）。

require 'facets/time/elapse'

Time.elapse { sleep 1 }  #=> 0.999188899993896

`Time.stamp(fmt)`

Time.now.stamp(fmt) と同じ。詳しくはstampメソッドを参照。

インスタンスメソッド

`advance(options)`

ActiveSupportの Time#advance と同じ。

`ago(number, units=:seconds)`

`hence(number, units=:seconds)`

agoなら時間を戻し、henceなら時間を進めた、新しいTimeオブジェクトを生成して返す。動かす量は数値（number）と単位（units）の組み合わせで指定でき、単位には :seconds, :minutes, :hours, :days, :weeks, :months, :years のいずれかを指定できる。

require 'facets/time/ago'
require 'facets/time/hence'

time = Time.now
p time                     # => Sat Jan 30 18:59:29 +0900 2010
p time.hence(5)            # => Sat Jan 30 18:59:34 +0900 2010
p time.hence(5, :seconds)  # 上の例と同じ
p time.hence(30, :minutes) # => Sat Jan 30 19:29:29 +0900 2010
p time.hence(7, :days)     # => Sat Feb 06 18:59:29 +0900 2010
p time.ago(3, :weeks)      # => Sat Jan 09 18:59:29 +0900 2010

numberに負の数（-20）を指定した場合には、逆方向のメソッドが呼び出される。

time.hence(-10) # time.ago(10) と同じ

`change(options)`

時刻を部分的に変更した、新しいTimeオブジェクトを生成して返す。「年だけを2009年に変更」「時間を13時30分に変更」などの処理が可能。

時間（:hour）、分（:minute）、秒（:second）を変更した場合、それより下の時間要素は0に設定される。たとえば「15時30分」であるTimeオブジェクトに対して、changeで時間だけを13時に変更すると、時刻は「13時00分」となる。

require 'facets/time/change'

time = Time.now
p time                                    # => Sat Jan 30 20:45:12 +0900 2010
p time.change(:year => 2000, :month => 3) # => Thu Mar 30 20:45:38 +0900 2000
p time.change(:hour => 23)                # => Sat Jan 30 23:00:00 +0900 2010

`round(amount)`

時刻をamount秒単位で丸めた、新しいTimeオブジェクトを生成して返す。たとえばamountが60であれば、時刻を1分単位で割り、四捨五入のように近いほうの時刻へ丸める。

近いほうの時刻にするのではなく切り捨てたい場合には、truncメソッドを使う。

require 'facets/time/round'

time = Time.now
p time                     # => Sat Jan 30 20:57:56 +0900 2010
p time.round(60)           # => Sat Jan 30 20:58:00 +0900 2010
p time.round(60 * 60)      # => Sat Jan 30 21:00:00 +0900 2010

`set(options)`

changeメソッドと同じだが、時間・分・秒を変更しても、その下の時間要素を0にしない。

`stamp(fmt = nil)`

時刻を指定したフォーマットの文字列に整形する。fmtはフォーマットの種類を表すSymbol。

require 'facets/time/stamp'

time = Time.now
p time.stamp(:short) # => "30 Jan 18:18"
p time.stamp(:long) # => "January 30, 2010 18:18"
p time.stamp(:time) # => "18:18"
p time.stamp(:number) # => "20100130181814"
p time.stamp(:utc) # =>"2010-01-30 18:18:14"

使用可能なフォーマットとその内容については、Time::FORMAT定数を見れば確認できる。

require 'facets/time/stamp'

p Time::FORMAT.class # => Hash
p Time::FORMAT.keys  # => [:datbase, :day1st, :utc, nil, :long, :number, :dmYHM, :short, :rfc822, :db, :time, :dbase]
p Time::FORMAT[:db]  # => "%Y-%m-%d %H:%M:%S"

なお、Symbolではなく文字列を引数にすると、Time#strftimeとほぼ同じ動作を行う。

`trunc(amount)`

時刻をamount秒単位で切り捨てた、新しいTimeオブジェクトを生成して返す。たとえばamountが60であれば、時刻を1分単位で割り、余り（秒）は切り捨てる。

切り捨てでなく近いほうの時刻にしたい場合には、roundメソッドを使う。

require 'facets/time/trunc'

time = Time.now
p time                     # => Sat Jan 30 20:57:56 +0900 2010
p time.trunc(60)           # => Sat Jan 30 20:57:00 +0900 2010
p time.trunc(60 * 60)      # => Sat Jan 30 20:00:00 +0900 2010

[メモ] Rubyで使えるMarkdownパーサ

2009-11-22T13:14:45+09:00

見つけたものからメモっていきます。

BlueCloth

http://www.deveiate.org/projects/BlueCloth

Markdown。RubyにおけるMarkdownパーサの元祖。2.0.0からは拡張ライブラリになって大幅に高速化された。

BlueFeather

http://ruby.morphball.net/bluefeather/

MarkdownExtra＋独自拡張。pure ruby。拙作。BlueCloth 1.0.0を改造して作ったもの。

Kramdown

http://kramdown.rubyforge.org/

Markdown Extra＋独自拡張。pure ruby。比較的新しい。「Marukuより5倍速く、BlueFeatherより10倍速い」らしい。

[Tips] WindowsやLinuxで標準ブラウザを開く方法

2009-11-19T07:50:00+09:00

WindowsやLinuxで、標準Webブラウザを呼び出して、任意のページを表示させる方法（Macでの方法は不明）。

Windows

require 'dl/win32'

sw_show_normal = 1
api = Win32API.new('shell32.dll','ShellExecute',%w(p p p p p i),'i')
api.call(0, 'open', 'path/to/document.html', 0, 0, sw_show_normal)

# もしくは
# api.call(0, 'open', 'http://example.net/', 0, 0, sw_show_normal)

補足

Windows APIのShellExecute関数を利用している。
Windows標準のstartコマンドを使って、以下のように書く方法もあるが、URLを渡してもちゃんと動くのかどうかがはっきりしないため、ここでは使っていない。
```
system "start path/to/document.html"
```
Win32APIライブラリは、Ruby 1.9.1で非推奨となっている（警告が出る）ので使っていない。dl/win32 で代用可能。

Linux

path = 'path/to/document.html'
# もしくは
# uri = 'http://example.net/'

system("/etc/alternatives/x-www-browser #{path} &") || system("firefox #{path} &")

補足

Linux環境では、/etc/alternatives/x-www-browser に標準ブラウザへのシンボリックリンクが置かれている。

tetralabo

facets/boolean 解説

駆け足紹介（クイックツアー）

Objectに追加されるインスタンスメソッド

bool?

to_b

to_bool

true?

false?

NYAOS上でpikを動かすための設定（0.3.0pre対応版）

facets/exception 解説 （Ruby Facets）

駆け足紹介（クイックツアー）

クラスメソッド

Exception.suppress(*exception_classes) { ... }

インスタンスメソッド

detail

raised? { ... }

facets/numeric 解説 （Ruby Facets）

駆け足紹介（クイックツアー）

インスタンスメソッド

distance(other)

length

size

round_at(d)

round_to(n)

facets/time 解説 （Ruby Facets）

駆け足紹介（クイックツアー）

クラスメソッド

Time.elapse { ... }

Time.stamp(fmt)

インスタンスメソッド

advance(options)

ago(number, units=:seconds)

hence(number, units=:seconds)

change(options)

round(amount)

set(options)

stamp(fmt = nil)

trunc(amount)

[メモ] Rubyで使えるMarkdownパーサ

BlueCloth

BlueFeather

Kramdown

[Tips] WindowsやLinuxで標準ブラウザを開く方法

Windows

補足

Linux

補足

参考

`bool?`

`to_b`

`to_bool`

`true?`

`false?`

facets/exception 解説（Ruby Facets）

`Exception.suppress(*exception_classes) { ... }`

`detail`

`raised? { ... }`

facets/numeric 解説（Ruby Facets）

`distance(other)`

`length`

`size`

`round_at(d)`

`round_to(n)`

facets/time 解説（Ruby Facets）

`Time.elapse { ... }`

`Time.stamp(fmt)`

`advance(options)`

`ago(number, units=:seconds)`

`hence(number, units=:seconds)`

`change(options)`

`round(amount)`

`set(options)`

`stamp(fmt = nil)`

`trunc(amount)`