[Feature:1.9] How about IPAddr#<=> to take care of mask_addr?

[Nobuhiro_IMAI]

e$B$$$^$$$G$9!#e(B

#1877 e$B$O$"$j$,$H$&$4$6$$$^$7$?!#e(B

IPAddr
e$B$N%$%s%9%?%s%9$,%O%C%7%e$N%-!<$K=PMh$k$h$&$K$J$C$?$N$G!"4JC1$Je(B
Access Control List e$B$r=q$$$F$_$?$N$G$9$,!"e(B

RUBY_DESCRIPTION
=> “ruby 1.9.2dev (2009-08-07 trunk 24440) [i686-linux]”
acl = {
?> IPAddr.new(“192.168.2.0/29”) => :admin,
?> IPAddr.new(“192.168.2.0/24”) => :user,
?> }
=> {#<IPAddr: IPv4:192.168.2.0/255.255.255.248>=>:admin, #<IPAddr:
IPv4:192.168.2.0/255.255.255.0>=>:user}
acl.select{|r, | r === “192.168.2.56”}.max.last
=> :user
acl.select{|r, | r === “192.168.2.1”}.max.last
=> :user

e$B$H!“$A$g$C$H;DG0$J46$8$G$9!#e(B<=> e$B$G!“e(B@addr e$B$,F1$8>l9g$Oe(B
@mask_addr e$B$NBge(B
e$B$-$$J}$,e(B IPAddr
e$B$H$7$FBg$-$$$H$9$k$H!”%M%C%H%^%9%/$ND9$$J}$,:NMQ$5$l$ke(B
e$B$h$&$J%$%a!<%8$G$&$l$7$$5$$,$9$k$N$G$9$,!”$I$&$G$7$g$&$+!)e(B

e$B$^$?!"$3$l$Ge(B(e$B$H$$$&$+85$+$i!)e(B) IPAddr#==
e$B$OITMW$J5$$,$9$k$N$G$9$,!"2?e(B
e$B$+8+Mn$H$7$F$k$G$7$g$&$+!)e(B

IPAddr.new(“192.168.2.0/24”) == IPAddr.new(“192.168.2.0/32”)

e$B$,e(B true e$B$+$ie(B false
e$B$KJQ$o$k$H$$$&;EMMJQ99$J$N$G$9$,!"$I$&$G$7$g$&$+!)e(B

Nobuhiro IMAI [email protected]
Key fingerprint = F39E D552 545D 7C64 D690 F644 5A15 746C BD8E 7106

Index: lib/ipaddr.rb

— lib/ipaddr.rb (revision 24440)
+++ lib/ipaddr.rb (working copy)
@@ -133,16 +133,10 @@ class IPAddr

Returns a new ipaddr built by bitwise negation.

def ~
return self.clone.set(addr_mask(~@addr))
end

• Returns true if two ipaddrs are equal.

• def ==(other)

• other = coerce_other(other)

• return @family == other.family && @addr == other.to_i

• end

• Returns a new ipaddr built by masking IP address with the given

  prefixlen/netmask. (e.g. 8, 64, “255.255.255.0”, etc.)

  def mask(prefixlen)
  return self.clone.mask!(prefixlen)
  end
  @@ -325,11 +319,11 @@ class IPAddr
  def <=>(other)
  other = coerce_other(other)

  return nil if other.family != @family

• return @addr <=> other.to_i

• return [@addr, @mask_addr] <=> [other.to_i, other.mask_addr]
  end
  include Comparable

Checks equality used by Hash.

def eql?(other)
@@ -372,10 +366,12 @@ class IPAddr
af, _to_string(@addr), _to_string(@mask_addr))
end

protected

• attr_reader :mask_addr
• def set(addr, *family)
  case family[0] ? family[0] : @family
  when Socket::AF_INET
  if addr < 0 || addr > IN4MASK
  raise ArgumentError, “invalid address”
  @@ -789,15 +785,24 @@ class TC_Operator < Test::Unit::TestCase
  a = ~@in6_addr_any
  assert_equal(IN6MASK128, a.to_s)
  assert_equal(“::”, @in6_addr_any.to_s)
  end

• def test_equal
• assert_equal(true, @a == IPAddr.new(“3ffe:505:2::”))

• def test_compare
• assert_equal(true, @a == IPAddr.new(“3ffe:505:2::/48”))
• assert_equal(false, @a == IPAddr.new(“3ffe:505:2::”))
  assert_equal(false, @a == IPAddr.new(“3ffe:505:3::”))
  assert_equal(true, @a != IPAddr.new(“3ffe:505:3::”))

• assert_equal(false, @a != IPAddr.new(“3ffe:505:2::”))

• assert_equal(false, @a != IPAddr.new(“3ffe:505:2::/48”))
• x = IPAddr.new(“3ffe:505:3::/48”)
• y = IPAddr.new(“3ffe:505:2::/64”)
• assert_equal(true, @a < x)
• assert_equal(true, @a < y)
• assert_equal(false, x < y)
• min, max = [y, x, @a].minmax
• assert_equal(@a, min)
• assert_equal(x, max)
  end

def test_mask
a = @a.mask(32)
assert_equal(“3ffe:505::”, a.to_s)

[Nobuhiro_IMAI]

e$B$$$^$$$G$9!#e(B

From: Nobuhiro IMAI <nov_at_yo.rim.or.jp>
Date: Fri, 7 Aug 2009 18:31:36 +0900

e$B$H!"$A$g$C$H;DG0$J46$8$G$9!#e(B<=> e$B$G!“e(B@addr e$B$,F1$8>l9g$Oe(B @mask_addr e$B$NBge(B
e$B$-$$J}$,e(B IPAddr e$B$H$7$FBg$-$$$H$9$k$H!”%M%C%H%^%9%/$ND9$$J}$,:NMQ$5$l$ke(B
e$B$h$&$J%$%a!<%8$G$&$l$7$$5$$,$9$k$N$G$9$,!"$I$&$G$7$g$&$+!)e(B

e$B$^$?!"$3$l$Ge(B(e$B$H$$$&$+85$+$i!)e(B) IPAddr#== e$B$OITMW$J5$$,$9$k$N$G$9$,!"2?e(B
e$B$+8+Mn$H$7$F$k$G$7$g$&$+!)e(B

IPAddr.new(“192.168.2.0/24”) == IPAddr.new(“192.168.2.0/32”)

e$B$,e(B true e$B$+$ie(B false e$B$KJQ$o$k$H$$$&;EMMJQ99$J$N$G$9$,!"$I$&$G$7$g$&$+!)e(B

e$B>/$7;~4V$,3+$$$F$7$^$$$^$7$?$,!"e(B

• e$B%"%I%l%9$,F1$8>l9g!"%M%C%H%^%9%/D9$,D9$$J}$,e(B IPAddr
  e$B$H$7$FBg$-$$$H$_e(B
  e$B$J$9e(B(IPAddr#<=> e$B$Ge(B @mask_addr e$B$r9MN8$9$ke(B)
• <=> e$B$He(B Comparable e$B$K$h$je(B ==
  e$B$ODj5A$5$l$k$N$G!"e(BIPAddr#== e$B$OGQ;_$9$ke(B

e$B$H$$$&e(B [ruby-dev:39038] e$B$N%Q%C%A$O$I$&$G$7$g$&$+!)e(B

[Nobuhiro_IMAI]

e$B$$$^$$$G$9!#e(B

From: Nobuhiro IMAI <nov_at_yo.rim.or.jp>
Date: Fri, 14 Aug 2009 21:19:42 +0900

e$B>/$7;~4V$,3+$$$F$7$^$$$^$7$?$,!"e(B

• e$B%"%I%l%9$,F1$8>l9g!"%M%C%H%^%9%/D9$,D9$$J}$,e(B IPAddr e$B$H$7$FBg$-$$$H$_e(B
  e$B$J$9e(B(IPAddr#<=> e$B$Ge(B @mask_addr e$B$r9MN8$9$ke(B)
• <=> e$B$He(B Comparable e$B$K$h$je(B == e$B$ODj5A$5$l$k$N$G!"e(BIPAddr#== e$B$OGQ;_$9$ke(B

e$B$H$$$&e(B [ruby-dev:39038] e$B$N%Q%C%A$O$I$&$G$7$g$&$+!)e(B

e$B$5$i$K;~4V$,3+$$$F$7$^$$$^$7$?$,!"$I$A$i$b<u$1F~$l$i$l$J$$$G$7$g$&$+!)e(B

IPAddr.new(“192.168.2.0/24”) == IPAddr.new(“192.168.2.0/32”)

e$B$,e(B true e$B$+$ie(B false e$B$KJQ$o$k$H$$$&;EMMJQ99$J$N$G$9$,!"$I$&$G$7$g$&$+!)e(B

e$B$H$$$&$N$,$^$:$$$G$7$g$&$+!#e(B

[Nobuhiro_IMAI]

　ここ数ヶ月私生活で忙しく、返事が遅れてしまいすみません。

At Sat, 12 Sep 2009 21:18:13 +0900,
Nobuhiro IMAI wrote:

さらに時間が開いてしまいましたが、どちらも受け入れられないでしょうか？

IPAddr.new(“192.168.2.0/24”) == IPAddr.new(“192.168.2.0/32”)

が true から false に変わるという仕様変更なのですが、どうでしょうか？

というのがまずいでしょうか。

　これは受け入れられません。IPAddrはネットマスクも保持するため
ネットワークも表現できますが、第一義はIPアドレスなので、ネット
マスクの違いで等しくなくなるのはまずいです。

　その上で、ソートの便宜を考えて <=> についてはネットマスクを
見て a1 == a2 && (a1 <=> a2) != 0 というケースを許すというのも
なくはないと思いますが、ユースケースに見られるニーズを満たす
よりよい方法はほかにあると思います。

　まず、改めてAPIを見るとネットマスクを取る手段がないので、
#mask_addr や #prefixlen のようなメソッドを用意して
sort_by/max_by {|i| [i, i.mask_addr] } できるようにするのが
ひとつ。(これは本件に関係なく)

　もう一つは class NetAddr < IPAddr のようなサブクラスを作り、
そちらで == や <=> をオーバーライドする方法。

　両方やってもいいかもしれませんね。どうでしょうか。

[Nobuhiro_IMAI]

At Mon, 28 Sep 2009 10:26:18 +0900,
Kazuhiro NISHIYAMA wrote:

IPAddr.new(“192.168.0.2/24”) #=> #<IPAddr: IPv4:192.168.0.0/255.255.255.0>

のようにネットマスクがあるとnewã®å¼•æ•°ã®æ–‡å­—åˆ—ã‚ˆã‚Šã‚‚æƒ…å ±ãŒæ¸›ã£ã¦ã—ã¾ã£ã¦
別途元のIPアドレスを持っておかないといけないのが不便です。

　これはど忘れしていました。ネットマスクを指定すると mask! されて
ネットワークアドレスになるんですね。（というかすべてがネットワーク
アドレスで、フルビットマスクによって単一のIPアドレスを表す）

　とすれば == の変更はリーズナブルとも言えますが、互換性を失うこと
にはやはり抵抗を覚えます。

　次のようなAPIの改修方針はどうでしょうか。

IPAddr.new(addr_with_netmask) # / を含む文字列

で生成されたインスタンスについては内部でフラグを立て、 netmask に
依らない比較を含め従来通りに振る舞うようにします。

　その上でこの用法は段階的に警告〜廃止し、新設する

IPAddr.parse(addr_with_netmask) # / を含む文字列
IPAddr.new(addr, netmask) # ネットマスクは第2引数で指定

への移行を促します。

　こうすると、新たに「フルビットでないネットマスクを指定された
IPã‚¢ãƒ‰ãƒ¬ã‚¹ã€ã¨ã„ã†æ–°ç¨®ã®ã‚¤ãƒ³ã‚¹ã‚¿ãƒ³ã‚¹ãŒåŠ ã‚ã‚‹ã“ã¨ã«ãªã‚‹ã®ã§ã€
等価性や大小関係を含む任意の演算について新しい定義を導入できる
ようになります。

　ただの思いつきですが、ひとつの材料としていただければ。

[Nobuhiro_IMAI]

e$B$$$^$$$G$9!#e(B

From: “Akinori MUSHA” <knu_at_iDaemons.org>
Date: Sun, 27 Sep 2009 12:00:48 +0900

• e$B%"%I%l%9$,F1$8>l9g!"%M%C%H%^%9%/D9$,D9$$J}$,e(B IPAddr e$B$H$7$FBg$-$$$H$_e(B
  e$B$J$9e(B(IPAddr#<=> e$B$Ge(B @mask_addr e$B$r9MN8$9$ke(B)
• <=> e$B$He(B Comparable e$B$K$h$je(B == e$B$ODj5A$5$l$k$N$G!"e(BIPAddr#== e$B$OGQ;_$9$ke(B

e$B$H$$$&e(B [ruby-dev:39038] e$B$N%Q%C%A$O$I$&$G$7$g$&$+!)e(B

IPAddr.new(“192.168.2.0/24”) == IPAddr.new(“192.168.2.0/32”)

e$B$,e(B true e$B$+$ie(B false e$B$KJQ$o$k$H$$$&;EMMJQ99$J$N$G$9$,!"$I$&$G$7$g$&$+!)e(B

e$B$H$$$&$N$,$^$:$$$G$7$g$&$+!#e(B

e$B!!$3$l$O<u$1F~$l$i$l$^$;$s!#e(BIPAddre$B$O%M%C%H%^%9%/$bJ];}$9$k$?$ae(B
e$B%M%C%H%o!<%/$bI=8=$G$-$^$9$,!“Bh0l5A$Oe(BIPe$B%”%I%l%9$J$N$G!"%M%C%He(B
e$B%^%9%/$N0c$$$GEy$7$/$J$/$J$k$N$O$^$:$$$G$9!#e(B

e$B$=$&$G$9$+!"J,$+$j$^$7$?!#e(B<=> e$B$NJQ99$O<h$j2<$2$^$9!#e(B

e$B$=$l$O$=$l$H$7$F!“e(B<=> e$B$He(B include Comparable e$B$,$”$l$Pe(B
== e$B$NDj5A$OITMW$Ke(B
e$B;W$($k$N$G$9$,!“e(B==
e$B$rL@<(E*$KDj5A$9$kM}M3$,$”$l$P65$($F$/$@$5$$!#8=>ue(B
e$B$G$Oe(B == e$B$NDj5A$rA4It>C$7$F$b!"F0:n$OF1$8$@$H;W$$$^$9!#e(B

e$B!!$b$&0l$D$Oe(B class NetAddr < IPAddr e$B$N$h$&$J%5%V%/%i%9$r:n$j!"e(B
e$B$=$A$i$Ge(B == e$B$de(B <=> e$B$r%*!<%P!<%i%$%I$9$kJ}K!!#e(B

e$B!!N>J}$d$C$F$b$$$$$+$b$7$l$^$;$s$M!#$I$&$G$7$g$&$+!#e(B

e$B$3$A$i$O;~4V$r8+$D$1$F%Q%C%A$r=q$1$l$P$$$$$J$H;W$$$^$9!#e(B

[Nobuhiro_IMAI]

At Sun, 27 Sep 2009 12:00:48 +0900,
Akinori MUSHA wrote:

e$B!!$3$l$O<u$1F~$l$i$l$^$;$s!#e(BIPAddre$B$O%M%C%H%^%9%/$bJ];}$9$k$?$ae(B
e$B%M%C%H%o!<%/$bI=8=$G$-$^$9$,!“Bh0l5A$Oe(BIPe$B%”%I%l%9$J$N$G!"%M%C%He(B
e$B%^%9%/$N0c$$$GEy$7$/$J$/$J$k$N$O$^$:$$$G$9!#e(B

e$B%M%C%H%^%9%/$G;W$$=P$7$?$N$G$9$,!"e(B

IPAddr.new(“192.168.0.1/24”) #=> #<IPAddr:
IPv4:192.168.0.0/255.255.255.0>
IPAddr.new(“192.168.0.2/24”) #=> #<IPAddr:
IPv4:192.168.0.0/255.255.255.0>

e$B$N$h$&$K%M%C%H%^%9%/$,$"$k$He(Bnewe$B$N0z?t$NJ8;zNs$h$j$b>pJs$,8:$C$F$7$^$C$Fe(B
e$BJLES85$Ne(BIPe$B%"%I%l%9$r;}$C$F$*$+$J$$$H$$$1$J$$$N$,ITJX$G$9!#e(B