pio 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b195270747468aaa2b80432c46510f55f1454f48
-  data.tar.gz: 2a2ee7694241f4b47f7c55fa29c1fb749a0ef448
+  metadata.gz: 5b896a5fa15f8f59ec3e46d6fcb80aacf0dc8d96
+  data.tar.gz: 02c3e94ecc0f3850632d3ce7454a65f78946d231
 SHA512:
-  metadata.gz: dfcc2a3f9db6f8e70ea6212883ce08dbfb3a274ed85ab71cc39383cb7a6be32bc2da936b658b80e89618b9788b37f3028c0b7859d455d3f32b672bafaa82f932
-  data.tar.gz: 8e87ff8d652dc724a1f64de6bcc65655ed732f60a0ea700e2e63e5a72aa8498192c1d40bf0972d3b13932ef622535bf38fecf3f5b1dc95c18fac12b9e6f1feee
+  metadata.gz: dad2f7aa5d1fa30237e1d6ec906cf705c42e446b9fbb3b62e957fedfc984e5f4ab95f8232ee5e96e3e88ba8289f8b896fe91f59c66be5192c7ed26b8f6c722e3
+  data.tar.gz: 6a43c94a49bac807d8f867f88fd5b4005cb8bafa9315f6841e894c15ab24c8876e9d924b2e9160d80efeb0f10318576d0fe06e7a85c870c560b4803782ad6081

data/Gemfile

@@ -5,25 +5,25 @@ gemspec
 
 
 group :development, :test do
-  gem "coveralls", "~> 0.6.7", :require => false
+  gem "coveralls", "~> 0.7.0", :require => false
   gem "flay", "~> 2.4.0"
-  gem "flog", "~> 4.1.1"
+  gem "flog", "~> 4.1.2"
   gem "fuubar", "~> 1.2.1"
-  gem "guard", "~> 1.8.2"
+  gem "guard", "~> 1.8"
   gem "guard-bundler", "~> 1.0.0"
-  gem "guard-rspec", "~> 3.0.2"
+  gem "guard-rspec", "~> 3.1.0"
   gem "json", "~> 1.8.0"
   gem "rake", "~> 10.1.0"
   gem "rb-fchange", "~> 0.0.6", :require => false
   gem "rb-fsevent", "~> 0.9.3", :require => false
-  gem "rb-inotify", "~> 0.9.1", :require => false
+  gem "rb-inotify", "~> 0.9.2", :require => false
   gem "redcarpet", "~> 2.3.0" if RUBY_VERSION < "1.9.0"
   gem "redcarpet", "~> 3.0.0" if RUBY_VERSION >= "1.9.0"
   gem "reek", "~> 1.3.3"
   gem "rspec", "~> 2.14.1"
   gem "rspec-instafail", "~> 0.2.4"
   gem "terminal-notifier-guard", "~> 1.5.3"
-  gem "yard", "~> 0.8.7"
+  gem "yard", "~> 0.8.7.2"
 end
 
 

data/lib/pio/arp/message.rb

@@ -46,7 +46,7 @@ module Pio
       def option_hash
         mandatory_options.inject( {} ) do | opt, each |
           klass = option_to_klass[ each ]
-          opt_pair = { each => klass.new( user_options[ each ] ).to_ary }
+          opt_pair = { each => klass.new( user_options[ each ] ).to_a }
           opt.merge opt_pair
         end.merge default_options
       end

data/lib/pio/arp/request.rb

@@ -9,8 +9,8 @@ module Pio
     class Request < Message
       OPERATION = 1
 
-      BROADCAST_MAC_ADDRESS = Mac.new( 0xffffffffffff ).to_ary
-      ALL_ZERO_MAC_ADDRESS = Mac.new( 0 ).to_ary
+      BROADCAST_MAC_ADDRESS = Mac.new( 0xffffffffffff ).to_a
+      ALL_ZERO_MAC_ADDRESS = Mac.new( 0 ).to_a
 
 
       ########################################################################

data/lib/pio/mac.rb

@@ -3,9 +3,13 @@ require "forwardable"
 
 module Pio
   #
-  # Ethernet address class
+  # Ethernet address (MAC address) class.
   #
   class Mac
+    # Raised when Ethernet address is invalid.
+    class InvalidValueError < StandardError; end
+
+
     extend Forwardable
     def_delegator :@value, :hash
 
@@ -15,50 +19,51 @@ module Pio
     #
     # @example address as a hexadecimal string
     #   Mac.new("11:22:33:44:55:66")
-    #
     # @example address as a hexadecimal number
     #   Mac.new(0xffffffffffff)
     #
+    # @param value [#to_str, #to_int] the value converted to an
+    #   Ethernet address.
+    #
     def initialize value
-      if value.respond_to?( :to_str )
-        @value = parse_mac_string( value.to_str )
-      elsif value.respond_to?( :to_int )
-        @value = value.to_int
-        validate_value_range
-      else
-        raise TypeError, "Invalid MAC address: #{ value.inspect }"
+      begin
+        if value.respond_to?( :to_str )
+          @value = parse_mac_string( value.to_str )
+        elsif value.respond_to?( :to_int )
+          @value = value.to_int
+          validate_value_range
+        else
+          raise TypeError
+        end
+      rescue ArgumentError, TypeError
+        raise InvalidValueError, "Invalid MAC address: #{ value.inspect }"
       end
     end
 
 
+    # @!group Converters
+
     #
     # Returns an Ethernet address in its numeric presentation.
     #
     # @example
     #   Mac.new("11:22:33:44:55:66").to_i #=> 18838586676582
     #
+    # @return [Integer]
+    #
     def to_i
       @value
     end
 
 
-    #
-    # @see to_i
-    #
-    # @example
-    #   Mac.new("11:22:33:44:55:66").to_int #=> 18838586676582
-    #
-    def to_int
-      to_i
-    end
-
-
     #
     # Returns the Ethernet address as 6 pairs of hexadecimal digits
     # delimited by colons.
     #
     # @example
-    #   Mac.new(18838586676582).to_s #=> "11:22:33:44:55:66"
+    #   Mac.new(0x112233445566).to_s #=> "11:22:33:44:55:66"
+    #
+    # @return [String]
     #
     def to_s
       sprintf( "%012x", @value ).unpack( "a2" * 6 ).join( ":" )
@@ -66,10 +71,15 @@ module Pio
 
 
     #
-    # @see to_s
+    # Implicitly converts +obj+ to a string.
     #
     # @example
-    #   Mac.new(18838586676582).to_str #=> "11:22:33:44:55:66"
+    #   mac = Mac.new("11:22:33:44:55:66")
+    #   puts "MAC = " + mac #=> "MAC = 11:22:33:44:55:66"
+    #
+    # @see #to_s
+    #
+    # @return [String]
     #
     def to_str
       to_s
@@ -77,11 +87,13 @@ module Pio
 
 
     #
-    # Returns an array of decimal numbers converted from Ethernet's
+    # Returns an Array of decimal numbers converted from Ethernet's
     # address string format.
     #
     # @example
-    #   Mac.new("11:22:33:44:55:66").to_a #=> [ 0x11, 0x22, 0x33, 0x44, 0x55, 0x66 ]
+    #   Mac.new("11:22:33:44:55:66").to_a #=> [0x11, 0x22, 0x33, 0x44, 0x55, 0x66]
+    #
+    # @return [Array]
     #
     def to_a
       to_s.split( ":" ).collect do | each |
@@ -89,53 +101,116 @@ module Pio
       end
     end
 
+    # @!endgroup
+
+
+    # @!group Predicates
+
+    #
+    # Returns true if Ethernet address is a multicast address.
+    #
+    # @example
+    #   Mac.new("01:00:00:00:00:00").multicast? #=> true
+    #   Mac.new("00:00:00:00:00:00").multicast? #=> false
+    #
+    def multicast?
+      to_a[ 0 ] & 1 == 1
+    end
+
 
     #
-    # @see to_a
+    # Returns true if Ethernet address is a broadcast address.
     #
     # @example
-    #   Mac.new("11:22:33:44:55:66").to_ary #=> [ 0x11, 0x22, 0x33, 0x44, 0x55, 0x66 ]
+    #   Mac.new("ff:ff:ff:ff:ff:ff").broadcast? #=> true
     #
-    def to_ary
-      to_a
+    def broadcast?
+      to_a.all? { | each | each == 0xff }
     end
 
 
     #
-    # @private
+    # Returns +true+ if Ethernet address is an IEEE 802.1D or 802.1Q
+    # reserved address. See
+    # http://standards.ieee.org/develop/regauth/grpmac/public.html for
+    # details.
+    #
+    # @example
+    #   Mac.new("01:80:c2:00:00:00").reserved? #=> true
+    #   Mac.new("11:22:33:44:55:66").reserved? #=> false
+    #
+    def reserved?
+      ( to_i >> 8 ) == 0x0180c20000
+    end
+
+    # @!endgroup
+
+
+    # @!group Equality
+
+    #
+    # Returns +true+ if +other+ can be converted to a {Mac}
+    # object and its numeric representation is equal to +obj+'s.
+    #
+    # @example
+    #   mac_address = Mac.new("11:22:33:44:55:66")
+    #
+    #   mac_address == Mac.new("11:22:33:44:55:66") #=> true
+    #   mac_address == "11:22:33:44:55:66" #=> true
+    #   mac_address == 0x112233445566 #=> true
+    #   mac_address == "INVALID_MAC_ADDRESS" #=> false
+    #
+    # @param other [#to_str, #to_int] a {Mac} object or an object
+    #   that can be converted to an Ethernet address.
+    #
+    # @return [Boolean]
     #
     def == other
       begin
         to_i == Mac.new( other ).to_i
-      rescue
+      rescue InvalidValueError
         false
       end
     end
-    alias :eql? :==
 
 
     #
-    # Returns true if Ethernet address is a multicast address.
+    # Returns +true+ if +obj+ and +other+ refer to the same hash key.
+    # +#==+ is used for the comparison.
     #
     # @example
-    #   Mac.new("01:00:00:00:00:00").multicast? #=> true
-    #   Mac.new("00:00:00:00:00:00").multicast? #=> false
+    #   fdb = {
+    #     Mac.new("11:22:33:44:55:66") => 1,
+    #     Mac.new("66:55:44:33:22:11") => 2
+    #   }
     #
-    def multicast?
-      to_a[ 0 ] & 1 == 1
+    #   fdb[ Mac.new("11:22:33:44:55:66")] #=> 1
+    #   fdb["11:22:33:44:55:66"] #=> 1
+    #   fdb[0x112233445566] #=> 1
+    #
+    # @see #==
+    #
+    def eql? other
+      self.== other
     end
 
+    # @!endgroup
+
+
+    # @!group Debug
 
     #
-    # Returns true if Ethernet address is a broadcast address.
+    # Returns a string containing a human-readable representation of
+    # {Mac} for debugging.
     #
-    # @example
-    #   Mac.new("ff:ff:ff:ff:ff:ff").broadcast? #=> true
+    # @return [String]
     #
-    def broadcast?
-      to_a.all? { | each | each == 0xff }
+    def inspect
+      %{#<#{ self.class }:#{ __id__ } "#{ to_s }">}
     end
 
+    # @!endgroup
+
 
     ################################################################################
     private
@@ -147,14 +222,14 @@ module Pio
       if /^(#{ octet_regex }:){5}(#{ octet_regex })$/=~ mac
         mac.gsub( ":", "" ).hex
       else
-        raise ArgumentError, %{Invalid MAC address: "#{ mac }"}
+        raise ArgumentError
       end
     end
 
 
     def validate_value_range
       unless ( @value >= 0 and @value <= 0xffffffffffff )
-        raise ArgumentError, "Invalid MAC address: #{ @value }"
+        raise ArgumentError
       end
     end
   end

data/lib/pio/version.rb

@@ -1,7 +1,7 @@
 # Base module.
 module Pio
   # gem version.
-  VERSION = "0.2.5"
+  VERSION = "0.2.6"
 end
 
 

data/pio.org

@@ -43,10 +43,16 @@ http:///www.asahi-net.or.jp/~aa4t-nngk/ipttut/output/icmpheaders.html
   BinData での optional TLV の使い方
 
 ** Trema/Pioでパケットを作ろう(1)                                     :NOTE:
+:PROPERTIES:
+:ID:       BA8B555C-1FBE-4FDD-BFAC-D80EE9366643
+:END:
 [2013-10-06 日 15:55]
 
 http://d.hatena.ne.jp/stereocat/20131005/1380977633
 ** Trema/Pioでパケットを作ろう(2)                                     :NOTE:
+:PROPERTIES:
+:ID:       29F0265C-BF73-4749-A93D-20B0BF62C45E
+:END:
 [2013-10-06 日 15:55]
 
 http://d.hatena.ne.jp/stereocat/20131006/1381028321
@@ -58,22 +64,20 @@ http://d.hatena.ne.jp/stereocat/20131006/1381028321
 [2013-09-05 木 21:32]
 ** TODO 各 OpenFlow メッセージのパーサを作る
 [2013-09-06 金 19:27]
+*** TODO Trema::Hello の spec を見直し
 ** TODO Nick さんに README の英語をチェックしてもらう
 [2013-09-18 水 12:01]
 ** TODO phost を Pio で書き直す
 [2013-09-24 火 15:36]
+
+関連するタスク:
+- [[*Trema/Pio%E3%81%A7%E3%83%91%E3%82%B1%E3%83%83%E3%83%88%E3%82%92%E4%BD%9C%E3%82%8D%E3%81%86(1)][Trema/Pioでパケットを作ろう(1)]]
+- [[*Trema/Pio%E3%81%A7%E3%83%91%E3%82%B1%E3%83%83%E3%83%88%E3%82%92%E4%BD%9C%E3%82%8D%E3%81%86(2)][Trema/Pioでパケットを作ろう(2)]]
 ** TODO DHCP パーサを作る
 [2013-08-02 金 17:17]
 
 近藤さんがすでにコーディング中。Pull-Request が来たらいっしょにリファ
 クタリングして取り込む予定。
-** TODO おかしな MAC アドレスはすべて InvalidMAC 例外にまとめる
-:LOGBOOK:
-CLOCK: [2013-10-07 月 10:22]--[2013-10-07 月 10:23] =>  0:01
-:END:
-[2013-10-07 月 10:22]
-
-ファイルは lib/pio/mac.rb
 * Releases
 ** DONE 0.2.2 リリース
 CLOSED: [2013-09-26 木 15:34]
@@ -165,6 +169,27 @@ CLOCK: [2013-10-07 月 10:23]--[2013-10-07 月 10:24] =>  0:01
 =#to_a= と =#to_ary= のコメントとか．
 ** TODO 0.2.6 リリース
 [2013-10-10 木 13:37]
+*** DONE Pio::Mac のリファクタリング
+CLOSED: [2013-10-11 金 13:31] SCHEDULED: <2013-10-11 金>
+:LOGBOOK:
+CLOCK: [2013-10-11 金 09:39]--[2013-10-11 金 12:16] =>  2:37
+:END:
+[2013-10-11 金 09:37]
+
+- YARD コメント
+- RSpec
+- いらないメソッドの削除
+など．
+*** DONE おかしな MAC アドレスはすべて InvalidMAC 例外にまとめる
+CLOSED: [2013-10-11 金 13:31]
+:LOGBOOK:
+CLOCK: [2013-10-07 月 10:22]--[2013-10-07 月 10:23] =>  0:01
+:END:
+[2013-10-07 月 10:22]
+
+ファイルは lib/pio/mac.rb
+** TODO 0.2.7 リリース
+[2013-10-11 金 14:32]
 *** TODO 鈴木さんルータの ARP 部分を Pio で書き直してもらう
 - State "TODO"       from "WAITING"    [2013-09-19 木 14:18]
 - State "WAITING"    from "TODO"       [2013-09-18 水 12:04] \\
@@ -177,7 +202,7 @@ CLOCK: [2013-09-14 土 10:20]--[2013-09-14 土 10:21] =>  0:01
 GitHub のチケットはこちら:
 https://github.com/trema/pio/issues/1
 **** NEXT 鈴木さんルータの ARP 部分を試しに自分で書き直してみる
-SCHEDULED: <2013-10-04 金>
+SCHEDULED: <2013-10-10 木>
 :PROPERTIES:
 :Effort:   1:00
 :END:

data/spec/pio/mac_spec.rb

@@ -9,65 +9,107 @@ module Pio
 
       context %{with "11:22:33:44:55:66"} do
         let( :value ) { "11:22:33:44:55:66" }
-        it { should eq Mac.new( "11:22:33:44:55:66" ) }
-        its( :to_int ) { should eq 0x112233445566 }
-        its( :to_str ) { should eq "11:22:33:44:55:66" }
-        its( :to_ary ) { should eq [ 0x11, 0x22, 0x33, 0x44, 0x55, 0x66 ] }
+
+        describe "#==" do
+          it { should eq Mac.new( "11:22:33:44:55:66" ) }
+          it { should eq "11:22:33:44:55:66" }
+          it { should_not eq Mac.new( "66:55:44:33:22:11" ) }
+          it { should_not eq "66:55:44:33:22:11" }
+          it { should eq 0x112233445566 }
+          it { should_not eq 42 }
+          it { should_not eq "INVALID_MAC_ADDRESS" }
+        end
+        describe "#eql?" do
+          it { expect( subject ).to eql Mac.new( "11:22:33:44:55:66" ) }
+          it { expect( subject ).to eql "11:22:33:44:55:66" }
+          it { expect( subject ).not_to eql Mac.new( "66:55:44:33:22:11" ) }
+          it { expect( subject ).not_to eql "66:55:44:33:22:11" }
+          it { expect( subject ).to eql 0x112233445566 }
+          it { expect( subject ).not_to eql 42 }
+          it { expect( subject ).not_to eql "INVALID_MAC_ADDRESS" }
+        end
+
+        its( :hash ) { should eq Mac.new( "11:22:33:44:55:66" ).hash }
+
+        its( :to_i ) { should eq 0x112233445566 }
+        its( :to_a ) { should eq [ 0x11, 0x22, 0x33, 0x44, 0x55, 0x66 ] }
+        its( :to_s ) { should eq "11:22:33:44:55:66" }
+        describe "#to_str" do
+          context %{when "MAC = " + subject} do
+            it { expect( "MAC = " + subject ).to eq "MAC = 11:22:33:44:55:66" }
+          end
+        end
+
         its( :multicast? ){ should be_true }
         its( :broadcast? ){ should be_false }
+        its( :reserved? ){ should be_false }
+      end
+
+
+      context "with reserved address" do
+        ( 0x0..0xf ).each do | each |
+          octet = "%02x" % each
+          reserved_address = "01:80:c2:00:00:#{ octet }"
+
+          context "when #{ reserved_address }" do
+            let( :value ) { reserved_address }
+            its( :reserved? ) { should be_true }
+          end
+        end
       end
 
 
       context "with 0" do
         let( :value ) { 0 }
+
         it { should eq Mac.new( 0 ) }
-        its( :to_int ) { should eq 0 }
-        its( :to_str ) { should eq "00:00:00:00:00:00" }
-        its( :to_ary ) { should eq [ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 ] }
+        its( :to_i ) { should eq 0 }
+        its( :to_a ) { should eq [ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 ] }
+        its( :to_s ) { should eq "00:00:00:00:00:00" }
         its( :multicast? ){ should be_false }
         its( :broadcast? ){ should be_false }
+        its( :reserved? ){ should be_false }
       end
 
 
       context "with 0xffffffffffff" do
         let( :value ) { 0xffffffffffff }
+
         it { should eq Mac.new( 0xffffffffffff ) }
-        its( :to_int ) { should eq 0xffffffffffff }
-        its( :to_str ) { should eq "ff:ff:ff:ff:ff:ff" }
-        its( :to_ary ) { should eq [ 0xff, 0xff, 0xff, 0xff, 0xff, 0xff ] }
+        its( :to_i ) { should eq 0xffffffffffff }
+        its( :to_a ) { should eq [ 0xff, 0xff, 0xff, 0xff, 0xff, 0xff ] }
+        its( :to_s ) { should eq "ff:ff:ff:ff:ff:ff" }
         its( :multicast? ){ should be_true }
         its( :broadcast? ){ should be_true }
+        its( :reserved? ){ should be_false }
       end
 
 
       context %{with "INVALID MAC ADDRESS"} do
         let( :value ) { "INVALID MAC ADDRESS" }
-        it { expect { subject }.to raise_error( ArgumentError ) }
+
+        it { expect { subject }.to raise_error( Mac::InvalidValueError ) }
       end
 
 
       context "with -1" do
         let( :value ) { -1 }
-        it { expect { subject }.to raise_error( ArgumentError ) }
+
+        it { expect { subject }.to raise_error( Mac::InvalidValueError ) }
       end
 
 
       context "with 0x1000000000000" do
         let( :value ) { 0x1000000000000 }
-        it { expect { subject }.to raise_error( ArgumentError ) }
+
+        it { expect { subject }.to raise_error( Mac::InvalidValueError ) }
       end
 
 
       context "with [ 1, 2, 3 ]" do
         let( :value ) { [ 1, 2, 3 ] }
-        it { expect { subject }.to raise_error( TypeError ) }
-      end
-
 
-      context %{with "00:00:00:00:00:01"} do
-        let( :value ) { "00:00:00:00:00:01" }
-        it { expect( subject ).to eql Mac.new( "00:00:00:00:00:01" ) }
-        its( :hash ) { should eq Mac.new( "00:00:00:00:00:01" ).hash }
+        it { expect { subject }.to raise_error( Mac::InvalidValueError ) }
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pio
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Yasuhito Takamiya
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-10 00:00:00.000000000 Z
+date: 2013-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bindata