pio 0.2.7 → 0.3.0

data/lib/pio/lldp/optional_tlv.rb

@@ -1,11 +1,11 @@
-require "pio/lldp/port_description_value"
-require "pio/lldp/system_name_value"
-require "pio/lldp/system_description_value"
-require "pio/lldp/system_capabilities_value"
-require "pio/lldp/management_address_value"
-require "pio/lldp/organizationally_specific_value"
-require "pio/lldp/end_of_lldpdu_value"
-
+# -*- coding: utf-8 -*-
+require 'pio/lldp/port_description_value'
+require 'pio/lldp/system_name_value'
+require 'pio/lldp/system_description_value'
+require 'pio/lldp/system_capabilities_value'
+require 'pio/lldp/management_address_value'
+require 'pio/lldp/organizationally_specific_value'
+require 'pio/lldp/end_of_lldpdu_value'
 
 module Pio
   class Lldp
@@ -17,7 +17,7 @@ module Pio
       bit9 :tlv_info_length
       choice :tlv_value,
              :read_length => :tlv_info_length,
-             :onlyif => lambda { not end_of_lldpdu? },
+             :onlyif => lambda { !end_of_lldpdu? },
              :selection => :chooser do
         end_of_lldpdu_value 0
         port_description_value 4
@@ -26,40 +26,32 @@ module Pio
         system_capabilities_value 7
         management_address_value 8
         organizationally_specific_value 127
-        string "unknown"
+        string 'unknown'
       end
 
-
       def end_of_lldpdu?
         tlv_type == 0
       end
 
-
       def chooser
         if valid_optional_tlv?
           tlv_type
         else
-          "unknown"
+          'unknown'
         end
       end
 
-
-      ##########################################################################
       private
-      ##########################################################################
-
 
       def valid_optional_tlv?
-        optional_tlv? or end_of_lldpdu_tlv?
+        optional_tlv? || end_of_lldpdu_tlv?
       end
 
-
       def optional_tlv?
         tmp_tlv_type = tlv_type
-        4 <= tmp_tlv_type and tmp_tlv_type <= 127
+        4 <= tmp_tlv_type && tmp_tlv_type <= 127
       end
 
-
       def end_of_lldpdu_tlv?
         tlv_type == 0
       end
@@ -67,7 +59,6 @@ module Pio
   end
 end
 
-
 ### Local variables:
 ### mode: Ruby
 ### coding: utf-8-unix

data/lib/pio/lldp/organizationally_specific_value.rb

@@ -1,6 +1,6 @@
-require "rubygems"
-require "bindata"
-
+# -*- coding: utf-8 -*-
+require 'rubygems'
+require 'bindata'
 
 module Pio
   class Lldp
@@ -15,7 +15,6 @@ module Pio
   end
 end
 
-
 ### Local variables:
 ### mode: Ruby
 ### coding: utf-8-unix

data/lib/pio/lldp/port_description_value.rb

@@ -1,6 +1,6 @@
-require "rubygems"
-require "bindata"
-
+# -*- coding: utf-8 -*-
+require 'rubygems'
+require 'bindata'
 
 module Pio
   class Lldp
@@ -13,7 +13,6 @@ module Pio
   end
 end
 
-
 ### Local variables:
 ### mode: Ruby
 ### coding: utf-8-unix

data/lib/pio/lldp/port_id_tlv.rb

@@ -1,6 +1,6 @@
-require "rubygems"
-require "bindata"
-
+# -*- coding: utf-8 -*-
+require 'rubygems'
+require 'bindata'
 
 module Pio
   class Lldp
@@ -13,7 +13,6 @@ module Pio
       uint8 :subtype, :initial_value => 7
       string :port_id, :read_length => lambda { tlv_info_length - 1 }
 
-
       def get
         tmp_id = port_id
 
@@ -24,10 +23,9 @@ module Pio
         end
       end
 
-
-      def set value
-        self.port_id = if value.kind_of?( Fixnum ) and subtype == 7
-                         BinData::Uint32be.new( value ).to_binary_s
+      def set(value)
+        self.port_id = if subtype == 7
+                         BinData::Uint32be.new(value).to_binary_s
                        else
                          value
                        end
@@ -36,7 +34,6 @@ module Pio
   end
 end
 
-
 ### Local variables:
 ### mode: Ruby
 ### coding: utf-8-unix

data/lib/pio/lldp/system_capabilities_value.rb

@@ -1,6 +1,6 @@
-require "rubygems"
-require "bindata"
-
+# -*- coding: utf-8 -*-
+require 'rubygems'
+require 'bindata'
 
 module Pio
   class Lldp
@@ -14,7 +14,6 @@ module Pio
   end
 end
 
-
 ### Local variables:
 ### mode: Ruby
 ### coding: utf-8-unix

data/lib/pio/lldp/system_description_value.rb

@@ -1,6 +1,6 @@
-require "rubygems"
-require "bindata"
-
+# -*- coding: utf-8 -*-
+require 'rubygems'
+require 'bindata'
 
 module Pio
   class Lldp
@@ -13,7 +13,6 @@ module Pio
   end
 end
 
-
 ### Local variables:
 ### mode: Ruby
 ### coding: utf-8-unix

data/lib/pio/lldp/system_name_value.rb

@@ -1,6 +1,6 @@
-require "rubygems"
-require "bindata"
-
+# -*- coding: utf-8 -*-
+require 'rubygems'
+require 'bindata'
 
 module Pio
   class Lldp
@@ -13,7 +13,6 @@ module Pio
   end
 end
 
-
 ### Local variables:
 ### mode: Ruby
 ### coding: utf-8-unix

data/lib/pio/lldp/ttl_tlv.rb

@@ -1,6 +1,6 @@
-require "rubygems"
-require "bindata"
-
+# -*- coding: utf-8 -*-
+require 'rubygems'
+require 'bindata'
 
 module Pio
   class Lldp
@@ -12,20 +12,17 @@ module Pio
       bit9 :tlv_info_length, :value => 2
       string :ttl, :read_length => :tlv_info_length
 
-
       def get
-        BinData::Int16be.read( ttl )
+        BinData::Int16be.read(ttl)
       end
 
-
-      def set value
-        self.ttl = BinData::Int16be.new( value ).to_binary_s
+      def set(value)
+        self.ttl = BinData::Int16be.new(value).to_binary_s
       end
     end
   end
 end
 
-
 ### Local variables:
 ### mode: Ruby
 ### coding: utf-8-unix

data/lib/pio/lldp.rb

@@ -1,68 +1,56 @@
-require "forwardable"
-require "pio/lldp/frame"
-
+# -*- coding: utf-8 -*-
+require 'English'
+require 'forwardable'
+require 'pio/lldp/frame'
 
 module Pio
   # LLDP frame parser and generator.
   class Lldp
     # User options for creating an LLDP frame.
     class Options
-      def initialize options
+      def initialize(options)
         @options = options
-
-        unless dpid
-          raise TypeError, "Invalid DPID: #{ dpid.inspect }"
-        end
+        fail TypeError, "Invalid DPID: #{ dpid.inspect }" unless dpid
         unless port_id
-          raise TypeError, "Invalid port number: #{ port_id.inspect }"
+          fail TypeError, "Invalid port number: #{ port_id.inspect }"
         end
       end
 
-
       def to_hash
         {
-          :destination_mac => Mac.new( destination_mac ).to_a,
-          :source_mac => Mac.new( source_mac ).to_a,
+          :destination_mac => Mac.new(destination_mac).to_a,
+          :source_mac => Mac.new(source_mac).to_a,
           :chassis_id => dpid,
           :port_id => port_id
         }
       end
 
-
-      ##########################################################################
       private
-      ##########################################################################
-
 
       def dpid
-        @options[ :dpid ]
+        @options[:dpid]
       end
 
-
       def port_id
-        @options[ :port_number ]
+        @options[:port_number]
       end
 
-
       def destination_mac
-        @options[ :destination_mac ] || "01:80:c2:00:00:0e"
+        @options[:destination_mac] || '01:80:c2:00:00:0e'
       end
 
-
       def source_mac
-        @options[ :source_mac ] || "01:02:03:04:05:06"
+        @options[:source_mac] || '01:02:03:04:05:06'
       end
     end
 
-
     extend Forwardable
 
-
-    def self.read raw_data
+    def self.read(raw_data)
       begin
-        frame = Frame.read( raw_data )
+        frame = Frame.read(raw_data)
       rescue
-        raise Pio::ParseError, $!.message
+        raise Pio::ParseError, $ERROR_INFO.message
       end
 
       lldp = allocate
@@ -70,12 +58,10 @@ module Pio
       lldp
     end
 
-
-    def initialize options
-      @frame = Frame.new( Options.new( options ).to_hash )
+    def initialize(options)
+      @frame = Frame.new(Options.new(options).to_hash)
     end
 
-
     def_delegator :@frame, :destination_mac
     def_delegator :@frame, :source_mac
     def_delegator :@frame, :ether_type
@@ -83,7 +69,7 @@ module Pio
     def_delegator :@frame, :dpid
     def_delegator :@frame, :optional_tlv
     def_delegator :@frame, :port_id
-    alias :port_number :port_id
+    alias_method :port_number, :port_id
     def_delegator :@frame, :ttl
     def_delegator :@frame, :port_description
     def_delegator :@frame, :system_name
@@ -93,14 +79,12 @@ module Pio
     def_delegator :@frame, :management_address
     def_delegator :@frame, :organizationally_specific
 
-
     def to_binary
-      @frame.to_binary_s + "\000" * ( 64 - @frame.num_bytes )
+      @frame.to_binary_s + "\000" * ( 64 - @frame.num_bytes)
     end
   end
 end
 
-
 ### Local variables:
 ### mode: Ruby
 ### coding: utf-8-unix

data/lib/pio/mac.rb

@@ -1,5 +1,5 @@
-require "forwardable"
-
+# -*- coding: utf-8 -*-
+require 'forwardable'
 
 module Pio
   #
@@ -9,11 +9,9 @@ module Pio
     # Raised when Ethernet address is invalid.
     class InvalidValueError < StandardError; end
 
-
     extend Forwardable
     def_delegator :@value, :hash
 
-
     #
     # Creates a {Mac} instance that encapsulates Ethernet addresses.
     #
@@ -25,22 +23,19 @@ module Pio
     # @param value [#to_str, #to_int] the value converted to an
     #   Ethernet address.
     #
-    def initialize value
-      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 }"
+    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
+        fail TypeError
       end
+    rescue ArgumentError, TypeError
+      raise InvalidValueError, "Invalid MAC address: #{ value.inspect }"
     end
 
-
     # @!group Converters
 
     #
@@ -55,7 +50,6 @@ module Pio
       @value
     end
 
-
     #
     # Returns the Ethernet address as 6 pairs of hexadecimal digits
     # delimited by colons.
@@ -66,10 +60,9 @@ module Pio
     # @return [String]
     #
     def to_s
-      sprintf( "%012x", @value ).unpack( "a2" * 6 ).join( ":" )
+      sprintf('%012x', @value).unpack('a2' * 6).join(':')
     end
 
-
     #
     # Implicitly converts +obj+ to a string.
     #
@@ -85,25 +78,24 @@ module Pio
       to_s
     end
 
-
     #
     # 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 |
+      to_s.split(':').map do | each |
         each.hex
       end
     end
 
     # @!endgroup
 
-
     # @!group Predicates
 
     #
@@ -114,10 +106,9 @@ module Pio
     #   Mac.new("00:00:00:00:00:00").multicast? #=> false
     #
     def multicast?
-      to_a[ 0 ] & 1 == 1
+      to_a[0] & 1 == 1
     end
 
-
     #
     # Returns true if Ethernet address is a broadcast address.
     #
@@ -128,7 +119,6 @@ module Pio
       to_a.all? { | each | each == 0xff }
     end
 
-
     #
     # Returns +true+ if Ethernet address is an IEEE 802.1D or 802.1Q
     # reserved address. See
@@ -140,12 +130,11 @@ module Pio
     #   Mac.new("11:22:33:44:55:66").reserved? #=> false
     #
     def reserved?
-      ( to_i >> 8 ) == 0x0180c20000
+      ( to_i >> 8) == 0x0180c20000
     end
 
     # @!endgroup
 
-
     # @!group Equality
 
     #
@@ -165,15 +154,12 @@ module Pio
     #
     # @return [Boolean]
     #
-    def == other
-      begin
-        to_i == Mac.new( other ).to_i
-      rescue InvalidValueError
-        false
-      end
+    def ==(other)
+      to_i == Mac.new(other).to_i
+    rescue InvalidValueError
+      false
     end
 
-
     #
     # Returns +true+ if +obj+ and +other+ refer to the same hash key.
     # +#==+ is used for the comparison.
@@ -190,13 +176,12 @@ module Pio
     #
     # @see #==
     #
-    def eql? other
-      self.== other
+    def eql?(other)
+      self == other
     end
 
     # @!endgroup
 
-
     # @!group Debug
 
     #
@@ -211,31 +196,23 @@ module Pio
 
     # @!endgroup
 
-
-    ################################################################################
     private
-    ################################################################################
-
 
-    def parse_mac_string mac
-      octet_regex = "[0-9a-fA-F][0-9a-fA-F]"
-      if /^(#{ octet_regex }:){5}(#{ octet_regex })$/=~ mac
-        mac.gsub( ":", "" ).hex
+    def parse_mac_string(mac)
+      octet_regex = '[0-9a-fA-F][0-9a-fA-F]'
+      if /^(#{ octet_regex }:){5}(#{ octet_regex })$/ =~ mac
+        mac.gsub(':', '').hex
       else
-        raise ArgumentError
+        fail ArgumentError
       end
     end
 
-
     def validate_value_range
-      unless ( @value >= 0 and @value <= 0xffffffffffff )
-        raise ArgumentError
-      end
+      fail ArgumentError unless @value >= 0 && @value <= 0xffffffffffff
     end
   end
 end
 
-
 ### Local variables:
 ### mode: Ruby
 ### coding: utf-8-unix

data/lib/pio/message_util.rb

@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+module Pio
+  # Pio Message Util.
+  module MessageUtil
+    def option_hash
+      mandatory_options.reduce({}) do | opt, each |
+        klass = option_to_klass[each]
+        opt_pair = { each => klass.new(user_options[each]).to_a }
+        opt.merge opt_pair
+      end.merge default_options
+    end
+  end
+end
+
+### Local variables:
+### mode: Ruby
+### coding: utf-8
+### indent-tabs-mode: nil
+### End:

data/lib/pio/type/config.reek

@@ -0,0 +1,4 @@
+TooManyStatements:
+  exclude:
+  - ipv4_header
+  enabled: true

data/lib/pio/type/ethernet_header.rb

@@ -1,14 +1,17 @@
-require "pio/type/mac_address"
-
+# -*- coding: utf-8 -*-
+require 'pio/type/mac_address'
 
 module Pio
   module Type
+    #
+    # Adds ethernet_header macro.
+    #
     module EthernetHeader
-      def ethernet_header options
+      def ethernet_header(options)
         class_eval do
           mac_address :destination_mac
           mac_address :source_mac
-          uint16 :ether_type, :value => options[ :ether_type ]
+          uint16 :ether_type, :value => options[:ether_type]
         end
       end
     end

data/lib/pio/type/ip_address.rb

@@ -1,6 +1,6 @@
-require "bindata"
-require "pio/ipv4_address"
-
+# -*- coding: utf-8 -*-
+require 'bindata'
+require 'pio/ipv4_address'
 
 module Pio
   module Type
@@ -8,20 +8,17 @@ module Pio
     class IpAddress < BinData::Primitive
       array :octets, :type => :uint8, :initial_length => 4
 
-
-      def set value
+      def set(value)
         self.octets = value
       end
 
-
       def get
-        IPv4Address.new octets.collect { | each | "%d" % each }.join( "." )
+        IPv4Address.new octets.map { | each | sprintf('%d', each) }.join('.')
       end
     end
   end
 end
 
-
 ### Local variables:
 ### mode: Ruby
 ### coding: utf-8-unix