pio 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8b1a7685cf52cf2c1130a376ecbb0deb4d3bab6f
-  data.tar.gz: dedeebabbd435531e5937344abd6c774e781b45b
+  metadata.gz: b195270747468aaa2b80432c46510f55f1454f48
+  data.tar.gz: 2a2ee7694241f4b47f7c55fa29c1fb749a0ef448
 SHA512:
-  metadata.gz: e3ec7121d3566f35e7c1b282019fbd38325c4c9910739a29e3407f2c5d58916f8d07306b3a8cf3fe65315c3c68c6a3aebc702a8e9866bf6a589434fdb338a3e6
-  data.tar.gz: 3844655945ad07e364deab3923dfeb702b96db4c2398e7a9511fbbf4592c381e10143dba62ee4d2cc7d098cb16e0c8ff260c02dbd433409a9d966dc1db96e1f8
+  metadata.gz: dfcc2a3f9db6f8e70ea6212883ce08dbfb3a274ed85ab71cc39383cb7a6be32bc2da936b658b80e89618b9788b37f3028c0b7859d455d3f32b672bafaa82f932
+  data.tar.gz: 8e87ff8d652dc724a1f64de6bcc65655ed732f60a0ea700e2e63e5a72aa8498192c1d40bf0972d3b13932ef622535bf38fecf3f5b1dc95c18fac12b9e6f1feee

data/lib/pio/ipv4_address.rb

@@ -78,13 +78,22 @@ module Pio
     # @return [Array]
     #    an array of decimal numbers converted from IPv4 address.
     #
-    def to_ary
+    def to_a
       to_s.split( "." ).collect do | each |
         each.to_i
       end
     end
 
 
+    #
+    # @return [Array]
+    #    an array of decimal numbers converted from IPv4 address.
+    #
+    def to_ary
+      to_a
+    end
+
+
     #
     # @return [IPv4Address]
     #   Returns the IPv4 address masked with masklen.

data/lib/pio/lldp.rb

@@ -21,8 +21,8 @@ module Pio
 
       def to_hash
         {
-          :destination_mac => Mac.new( destination_mac ).to_ary,
-          :source_mac => Mac.new( source_mac ).to_ary,
+          :destination_mac => Mac.new( destination_mac ).to_a,
+          :source_mac => Mac.new( source_mac ).to_a,
           :chassis_id => dpid,
           :port_id => port_id
         }
@@ -64,6 +64,7 @@ module Pio
       rescue
         raise Pio::ParseError, $!.message
       end
+
       lldp = allocate
       lldp.instance_variable_set :@frame, frame
       lldp

data/lib/pio/mac.rb

@@ -11,46 +11,45 @@ module Pio
 
 
     #
-    # Returns an Ethernet address in its numeric presentation.
+    # Creates a {Mac} instance that encapsulates Ethernet addresses.
     #
-    # @example
-    #   Mac.new("11:22:33:44:55:66") #=> 18838586676582
+    # @example address as a hexadecimal string
+    #   Mac.new("11:22:33:44:55:66")
     #
-    # @return [Number] the Ethernet address in numeric format
+    # @example address as a hexadecimal number
+    #   Mac.new(0xffffffffffff)
     #
-    attr_reader :value
+    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 }"
+      end
+    end
 
 
     #
-    # Creates a {Mac} instance that encapsulates Ethernet addresses.
-    #
-    # @overload initialize(value)
+    # Returns an Ethernet address in its numeric presentation.
     #
-    # @param [String,Integer] value
-    #   the Ethernet address to set to.
+    # @example
+    #   Mac.new("11:22:33:44:55:66").to_i #=> 18838586676582
     #
-    # @example address as a hexadecimal string
-    #   Mac.new("11:22:33:44:55:66")
+    def to_i
+      @value
+    end
+
+
     #
-    # @example address as a hexadecimal number
-    #   Mac.new(0xffffffffffff)
+    # @see to_i
     #
-    # @raise [ArgumentError] if invalid format is detected.
-    # @raise [TypeError] if supplied argument is not a String or Integer.
+    # @example
+    #   Mac.new("11:22:33:44:55:66").to_int #=> 18838586676582
     #
-    def initialize value
-      case value
-        when String
-          @value = create_from( value )
-        when Integer
-          @value = value
-          validate_value_range
-        when Mac
-          @value = create_from( value.to_s )
-        else
-          raise TypeError, "Invalid MAC address: #{ value.inspect }"
-      end
-      @string = string_format
+    def to_int
+      to_i
     end
 
 
@@ -61,10 +60,19 @@ module Pio
     # @example
     #   Mac.new(18838586676582).to_s #=> "11:22:33:44:55:66"
     #
-    # @return [String] the Ethernet address in String format
-    #
     def to_s
-      @string
+      sprintf( "%012x", @value ).unpack( "a2" * 6 ).join( ":" )
+    end
+
+
+    #
+    # @see to_s
+    #
+    # @example
+    #   Mac.new(18838586676582).to_str #=> "11:22:33:44:55:66"
+    #
+    def to_str
+      to_s
     end
 
 
@@ -73,22 +81,35 @@ module Pio
     # address string format.
     #
     # @example
-    #   Mac.new("11:22:33:44:55:66").to_ary #=> [ 0x11, 0x22, 0x33, 0x44, 0x55, 0x66 ]
-    #
-    # @return [Array] the Ethernet address in Array format
+    #   Mac.new("11:22:33:44:55:66").to_a #=> [ 0x11, 0x22, 0x33, 0x44, 0x55, 0x66 ]
     #
-    def to_ary
-      @string.split( ":" ).collect do | each |
+    def to_a
+      to_s.split( ":" ).collect do | each |
         each.hex
       end
     end
 
 
+    #
+    # @see to_a
+    #
+    # @example
+    #   Mac.new("11:22:33:44:55:66").to_ary #=> [ 0x11, 0x22, 0x33, 0x44, 0x55, 0x66 ]
+    #
+    def to_ary
+      to_a
+    end
+
+
     #
     # @private
     #
     def == other
-      to_s == other.to_s
+      begin
+        to_i == Mac.new( other ).to_i
+      rescue
+        false
+      end
     end
     alias :eql? :==
 
@@ -100,10 +121,8 @@ module Pio
     #   Mac.new("01:00:00:00:00:00").multicast? #=> true
     #   Mac.new("00:00:00:00:00:00").multicast? #=> false
     #
-    # @return [Boolean] whether the Ethernet address is multicast
-    #
     def multicast?
-      to_ary[ 0 ] & 1 == 1
+      to_a[ 0 ] & 1 == 1
     end
 
 
@@ -113,10 +132,8 @@ module Pio
     # @example
     #   Mac.new("ff:ff:ff:ff:ff:ff").broadcast? #=> true
     #
-    # @return [Boolean] whether the Ethernet address is broadcast
-    #
     def broadcast?
-      to_ary.all? { | each | each == 0xff }
+      to_a.all? { | each | each == 0xff }
     end
 
 
@@ -125,12 +142,12 @@ module Pio
     ################################################################################
 
 
-    def create_from string
+    def parse_mac_string mac
       octet_regex = "[0-9a-fA-F][0-9a-fA-F]"
-      if /^(#{ octet_regex }:){5}(#{ octet_regex })$/=~ string
-        string.gsub( ":", "" ).hex
+      if /^(#{ octet_regex }:){5}(#{ octet_regex })$/=~ mac
+        mac.gsub( ":", "" ).hex
       else
-        raise ArgumentError, %{Invalid MAC address: "#{ string }"}
+        raise ArgumentError, %{Invalid MAC address: "#{ mac }"}
       end
     end
 
@@ -140,11 +157,6 @@ module Pio
         raise ArgumentError, "Invalid MAC address: #{ @value }"
       end
     end
-
-
-    def string_format
-      sprintf( "%012x", @value ).unpack( "a2" * 6 ).join( ":" )
-    end
   end
 end
 

data/lib/pio/version.rb

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

data/pio.org

@@ -36,6 +36,20 @@ http://www.zeespencer.com/articles/building-a-remote-pairing-setup/
 [2013-09-22 日 23:09]
 
 http:///www.asahi-net.or.jp/~aa4t-nngk/ipttut/output/icmpheaders.html
+** [[http://www.ruby-forum.com/topic/217963][any good tools for reading networking data with optional TLV - Ruby Forum]] [2013-06-21 Fri]
+:PROPERTIES:
+:ID:       1670C09A-20C7-45F9-B068-56376DFD864C
+:END:
+  BinData での optional TLV の使い方
+
+** Trema/Pioでパケットを作ろう(1)                                     :NOTE:
+[2013-10-06 日 15:55]
+
+http://d.hatena.ne.jp/stereocat/20131005/1380977633
+** Trema/Pioでパケットを作ろう(2)                                     :NOTE:
+[2013-10-06 日 15:55]
+
+http://d.hatena.ne.jp/stereocat/20131006/1381028321
 * Tasks
 このアイテムをそれぞれのリリースに割り振る。
 ** NEXT git パスワードを省略できるように
@@ -48,6 +62,18 @@ http:///www.asahi-net.or.jp/~aa4t-nngk/ipttut/output/icmpheaders.html
 [2013-09-18 水 12:01]
 ** TODO phost を Pio で書き直す
 [2013-09-24 火 15:36]
+** 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]
@@ -85,11 +111,60 @@ CLOSED: [2013-09-26 木 15:35]
 *** DONE Trema への組込み
 CLOSED: [2013-09-26 木 15:35]
 [2013-09-26 木 15:35]
-** TODO 0.2.4 リリース
+*** DONE gem の命名規則に合わせる
+CLOSED: [2013-09-26 木 08:28] SCHEDULED: <2013-09-26 木>
+:LOGBOOK:
+CLOCK: [2013-09-26 木 08:20]--[2013-09-26 木 08:28] =>  0:08
+CLOCK: [2013-09-26 木 08:05]--[2013-09-26 木 08:06] =>  0:01
+:END:
+:PROPERTIES:
+:Effort:   0:30
+:END:
+[2013-09-26 木 08:05]
+*** DONE 明示的に spec_helper.rb をロードしてる部分をなくす
+CLOSED: [2013-09-26 木 08:18] SCHEDULED: <2013-09-26 木>
+:LOGBOOK:
+CLOCK: [2013-09-26 木 08:14]--[2013-09-26 木 08:15] =>  0:01
+:END:
+:PROPERTIES:
+:Effort:   0:30
+:END:
+[2013-09-26 木 08:14]
+** DONE 0.2.5 リリース
+CLOSED: [2013-10-10 木 15:00]
 :LOGBOOK:
 CLOCK: [2013-09-26 木 13:31]--[2013-09-26 木 13:32] =>  0:01
 :END:
 [2013-09-26 木 13:31]
+*** DONE Trema::Mac を Pio::Mac で置き換え
+CLOSED: [2013-10-10 木 14:57] SCHEDULED: <2013-10-10 木>
+:LOGBOOK:
+CLOCK: [2013-10-10 木 11:38]--[2013-10-10 木 13:30] =>  1:52
+:END:
+[2013-10-03 木 09:04]
+**** DONE Trema ソースコード内の Trema::Mac を Pio::Mac で置換
+CLOSED: [2013-10-10 木 13:42]
+[2013-10-03 木 09:05]
+**** DONE Trema::Mac のテストコードを削除
+CLOSED: [2013-10-10 木 13:42]
+:LOGBOOK:
+CLOCK: [2013-10-03 木 09:06]--[2013-10-03 木 09:07] =>  0:01
+:END:
+[2013-10-03 木 09:06]
+**** DONE cruise.rb が通ることを確認
+CLOSED: [2013-10-10 木 14:57]
+[2013-10-03 木 09:08]
+*** DONE Pio::Mac のYARD コメントでダブってるやつは @see にする
+CLOSED: [2013-10-10 木 13:37] SCHEDULED: <2013-10-10 木>
+:LOGBOOK:
+CLOCK: [2013-10-10 木 13:30]--[2013-10-10 木 13:37] =>  0:07
+CLOCK: [2013-10-07 月 10:23]--[2013-10-07 月 10:24] =>  0:01
+:END:
+[2013-10-07 月 10:23]
+
+=#to_a= と =#to_ary= のコメントとか．
+** TODO 0.2.6 リリース
+[2013-10-10 木 13:37]
 *** TODO 鈴木さんルータの ARP 部分を Pio で書き直してもらう
 - State "TODO"       from "WAITING"    [2013-09-19 木 14:18]
 - State "WAITING"    from "TODO"       [2013-09-18 水 12:04] \\
@@ -100,24 +175,26 @@ CLOCK: [2013-09-14 土 10:20]--[2013-09-14 土 10:21] =>  0:01
 [2013-09-14 土 10:20]
 
 GitHub のチケットはこちら:
+https://github.com/trema/pio/issues/1
+**** NEXT 鈴木さんルータの ARP 部分を試しに自分で書き直してみる
+SCHEDULED: <2013-10-04 金>
+:PROPERTIES:
+:Effort:   1:00
+:END:
+[2013-10-04 金 08:39]
+**** DONE 鈴木さんに ping
+CLOSED: [2013-10-01 火 12:29] SCHEDULED: <2013-10-01 火>
+:LOGBOOK:
+CLOCK: [2013-09-29 日 21:06]--[2013-09-29 日 21:07] =>  0:01
+:END:
+[2013-09-29 日 21:06]
+
 https://github.com/trema/pio/issues/1
 ** TODO 0.3.0 リリース
 - State "TODO"       from "WAITING"    [2013-09-19 木 14:16]
 - State "WAITING"    from "TODO"       [2013-09-06 金 17:17] \\
   0.2.0 が無事に出てから
 [2013-09-05 木 17:29]
-*** TODO ICMP パーサを作る
-[2013-08-02 金 17:19]
-*** DONE gem の命名規則に合わせる
-CLOSED: [2013-09-26 木 08:28] SCHEDULED: <2013-09-26 木>
-:LOGBOOK:
-CLOCK: [2013-09-26 木 08:20]--[2013-09-26 木 08:28] =>  0:08
-CLOCK: [2013-09-26 木 08:05]--[2013-09-26 木 08:06] =>  0:01
-:END:
-:PROPERTIES:
-:Effort:   0:30
-:END:
-[2013-09-26 木 08:05]
 *** NEXT YARD の警告をつぶす
 SCHEDULED: <2014-08-19 火>
 :PROPERTIES:
@@ -129,21 +206,15 @@ SCHEDULED: <2014-08-19 火>
 CLOCK: [2013-09-18 水 17:20]--[2013-09-18 水 17:21] =>  0:01
 :END:
 [2013-09-18 水 17:20]
-*** DONE 明示的に spec_helper.rb をロードしてる部分をなくす
-CLOSED: [2013-09-26 木 08:18] SCHEDULED: <2013-09-26 木>
+*** TODO ICMP パーサを作る
+[2013-08-02 金 17:19]
+**** WAITING 近藤さんに PR 出してもらう                          :WAITING:
+- State "WAITING"    from "TODO"       [2013-10-07 月 08:56] \\
+  近藤さんが PR の準備中．
 :LOGBOOK:
-CLOCK: [2013-09-26 木 08:14]--[2013-09-26 木 08:15] =>  0:01
-:END:
-:PROPERTIES:
-:Effort:   0:30
+CLOCK: [2013-10-03 木 09:10]--[2013-10-03 木 09:12] =>  0:02
 :END:
-[2013-09-26 木 08:14]
-** WAITING 0.4.0 リリース                                    :WAITING:
-- State "WAITING"    from "TODO"       [2013-09-06 金 17:18] \\
-  0.3.0 が無事に出てから。
-[2013-09-06 金 16:30]
-*** TODO DHCP パーサを作る
-[2013-08-02 金 17:17]
+[2013-10-03 木 09:10]
 
-近藤さんがすでにコーディング中。Pull-Request が来たらいっしょにリファ
-クタリングして取り込む予定。
+開発は PR で追跡することにする．マージが可能な状態かとか，テスト成功/失
+敗も見えるし．

data/pio.org_archive

@@ -838,3 +838,20 @@ CLOSED: [2013-09-13 金 14:05] SCHEDULED: <2013-09-13 金>
 CLOCK: [2013-09-13 金 13:28]--[2013-09-13 金 14:05] =>  0:37
 :END:
 [2013-09-13 金 13:28]
+
+* Archived Tasks
+
+** CANCELED Pio::Mac を Trema に組込む
+CLOSED: [2013-10-10 木 13:41] SCHEDULED: <2013-10-04 金>
+- State "CANCELED"   from "NEXT"       [2013-10-10 木 13:41] \\
+  ダブってたのでキャンセル
+:PROPERTIES:
+:Effort:   0:30
+:ARCHIVE_TIME: 2013-10-10 木 13:41
+:ARCHIVE_FILE: ~/play/pio/pio.org
+:ARCHIVE_OLPATH: Releases/0.2.5 リリース
+:ARCHIVE_CATEGORY: pio
+:ARCHIVE_TODO: CANCELED
+:ARCHIVE_ITAGS: PIO
+:END:
+[2013-10-04 金 08:46]

data/spec/pio/mac_spec.rb

@@ -10,8 +10,8 @@ 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( :value ) { should eq 0x112233445566 }
-        its( :to_s ) { should eq "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 ] }
         its( :multicast? ){ should be_true }
         its( :broadcast? ){ should be_false }
@@ -21,8 +21,8 @@ module Pio
       context "with 0" do
         let( :value ) { 0 }
         it { should eq Mac.new( 0 ) }
-        its( :value ) { should eq 0 }
-        its( :to_s ) { should eq "00:00:00:00:00:00" }
+        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( :multicast? ){ should be_false }
         its( :broadcast? ){ should be_false }
@@ -32,8 +32,8 @@ module Pio
       context "with 0xffffffffffff" do
         let( :value ) { 0xffffffffffff }
         it { should eq Mac.new( 0xffffffffffff ) }
-        its( :value ) { should eq 0xffffffffffff }
-        its( :to_s ) { should eq "ff:ff:ff:ff:ff:ff" }
+        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( :multicast? ){ should be_true }
         its( :broadcast? ){ should be_true }

metadata

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