pio 0.3.0 → 0.4.0

data/lib/pio/lldp/chassis_id_tlv.rb

@@ -1,5 +1,5 @@
-# -*- coding: utf-8 -*-
-require 'rubygems'
+# encoding: utf-8
+
 require 'bindata'
 
 module Pio
@@ -8,12 +8,12 @@ module Pio
     class ChassisIdTlv < BinData::Primitive
       endian :big
 
-      bit7 :tlv_type, :value => 1
+      bit7 :tlv_type, value: 1
       bit9(:tlv_info_length,
-           :value => lambda { subtype.num_bytes + chassis_id.length })
-      uint8 :subtype, :initial_value => 7
+           value: -> { subtype.num_bytes + chassis_id.length })
+      uint8 :subtype, initial_value: 7
       string(:chassis_id,
-             :read_length => lambda { tlv_info_length - subtype.num_bytes })
+             read_length: -> { tlv_info_length - subtype.num_bytes })
 
       def get
         tmp_chassis_id = chassis_id
@@ -40,15 +40,9 @@ module Pio
 
       def mac_address
         chassis_id.unpack('C6').map do |each|
-          sprintf '%02x', each
+          format '%02x', each
         end.join('').hex
       end
     end
   end
 end
-
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End:

data/lib/pio/lldp/end_of_lldpdu_value.rb

@@ -1,5 +1,5 @@
-# -*- coding: utf-8 -*-
-require 'rubygems'
+# encoding: utf-8
+
 require 'bindata'
 
 module Pio
@@ -8,13 +8,7 @@ module Pio
     class EndOfLldpduValue < BinData::Record
       endian :big
 
-      stringz :tlv_info_string, :length => 0, :value => ''
+      stringz :tlv_info_string, length: 0, value: ''
     end
   end
 end
-
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End:

data/lib/pio/lldp/frame.rb

@@ -1,5 +1,5 @@
-# -*- coding: utf-8 -*-
-require 'rubygems'
+# encoding: utf-8
+
 require 'bindata'
 
 require 'pio/lldp/chassis_id_tlv'
@@ -16,13 +16,13 @@ module Pio
 
       endian :big
 
-      ethernet_header :ether_type => 0x88cc
+      ethernet_header ether_type: 0x88cc
       chassis_id_tlv :chassis_id
       port_id_tlv :port_id
-      ttl_tlv :ttl, :initial_value => 120
+      ttl_tlv :ttl, initial_value: 120
       array(:optional_tlv,
-            :type => :optional_tlv,
-            :read_until => lambda { element.end_of_lldpdu? })
+            type: :optional_tlv,
+            read_until: -> { element.end_of_lldpdu? })
 
       def dpid
         chassis_id.to_i
@@ -68,9 +68,3 @@ module Pio
     end
   end
 end
-
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End:

data/lib/pio/lldp/management_address_value.rb

@@ -1,5 +1,5 @@
-# -*- coding: utf-8 -*-
-require 'rubygems'
+# encoding: utf-8
+
 require 'bindata'
 
 module Pio
@@ -10,17 +10,11 @@ module Pio
 
       uint8 :string_length
       uint8 :subtype
-      string :management_address, :read_length => lambda { string_length - 1 }
+      string :management_address, read_length: -> { string_length - 1 }
       uint8 :interface_numbering_subtype
       uint32 :interface_number
       uint8 :oid_string_length
-      string :object_identifier, :read_length => lambda { oid_string_length }
+      string :object_identifier, read_length: -> { oid_string_length }
     end
   end
 end
-
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End:

data/lib/pio/lldp/optional_tlv.rb

@@ -1,4 +1,5 @@
-# -*- coding: utf-8 -*-
+# encoding: utf-8
+
 require 'pio/lldp/port_description_value'
 require 'pio/lldp/system_name_value'
 require 'pio/lldp/system_description_value'
@@ -16,9 +17,9 @@ module Pio
       bit7 :tlv_type
       bit9 :tlv_info_length
       choice :tlv_value,
-             :read_length => :tlv_info_length,
-             :onlyif => lambda { !end_of_lldpdu? },
-             :selection => :chooser do
+             read_length: :tlv_info_length,
+             onlyif: -> { !end_of_lldpdu? },
+             selection: :chooser do
         end_of_lldpdu_value 0
         port_description_value 4
         system_name_value 5
@@ -58,9 +59,3 @@ module Pio
     end
   end
 end
-
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End:

data/lib/pio/lldp/options.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+require 'pio/options'
+
+module Pio
+  class Lldp
+    # User options for creating an LLDP frame.
+    class Options < Pio::Options
+      mandatory_option :dpid
+      mandatory_option :port_number
+      option :destination_mac
+      option :source_mac
+
+      DEFAULT_DESTINATION_MAC = '01:80:c2:00:00:0e'.freeze
+      DEFAULT_SOURCE_MAC = '01:02:03:04:05:06'.freeze
+
+      def initialize(options)
+        validate options
+        @dpid = options[:dpid].freeze
+        @port_id = options[:port_number].freeze
+        @destination_mac =
+          Mac.new(options[:destination_mac] || DEFAULT_DESTINATION_MAC).freeze
+        @source_mac =
+          Mac.new(options[:source_mac] || DEFAULT_SOURCE_MAC).freeze
+      end
+
+      def to_hash
+        {
+          chassis_id: @dpid,
+          port_id: @port_id,
+          destination_mac: @destination_mac,
+          source_mac: @source_mac
+        }.freeze
+      end
+    end
+  end
+end

data/lib/pio/lldp/organizationally_specific_value.rb

@@ -1,5 +1,5 @@
-# -*- coding: utf-8 -*-
-require 'rubygems'
+# encoding: utf-8
+
 require 'bindata'
 
 module Pio
@@ -14,9 +14,3 @@ module Pio
     end
   end
 end
-
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End:

data/lib/pio/lldp/port_description_value.rb

@@ -1,5 +1,5 @@
-# -*- coding: utf-8 -*-
-require 'rubygems'
+# encoding: utf-8
+
 require 'bindata'
 
 module Pio
@@ -12,9 +12,3 @@ module Pio
     end
   end
 end
-
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End:

data/lib/pio/lldp/port_id_tlv.rb

@@ -1,5 +1,5 @@
-# -*- coding: utf-8 -*-
-require 'rubygems'
+# encoding: utf-8
+
 require 'bindata'
 
 module Pio
@@ -8,10 +8,10 @@ module Pio
     class PortIdTlv < BinData::Primitive
       endian :big
 
-      bit7 :tlv_type, :value => 2
-      bit9 :tlv_info_length, :initial_value => lambda { port_id.num_bytes + 1 }
-      uint8 :subtype, :initial_value => 7
-      string :port_id, :read_length => lambda { tlv_info_length - 1 }
+      bit7 :tlv_type, value: 2
+      bit9 :tlv_info_length, initial_value: -> { port_id.num_bytes + 1 }
+      uint8 :subtype, initial_value: 7
+      string :port_id, read_length: -> { tlv_info_length - 1 }
 
       def get
         tmp_id = port_id
@@ -33,9 +33,3 @@ module Pio
     end
   end
 end
-
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End:

data/lib/pio/lldp/system_capabilities_value.rb

@@ -1,5 +1,5 @@
-# -*- coding: utf-8 -*-
-require 'rubygems'
+# encoding: utf-8
+
 require 'bindata'
 
 module Pio
@@ -13,9 +13,3 @@ module Pio
     end
   end
 end
-
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End:

data/lib/pio/lldp/system_description_value.rb

@@ -1,5 +1,5 @@
-# -*- coding: utf-8 -*-
-require 'rubygems'
+# encoding: utf-8
+
 require 'bindata'
 
 module Pio
@@ -12,9 +12,3 @@ module Pio
     end
   end
 end
-
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End:

data/lib/pio/lldp/system_name_value.rb

@@ -1,5 +1,5 @@
-# -*- coding: utf-8 -*-
-require 'rubygems'
+# encoding: utf-8
+
 require 'bindata'
 
 module Pio
@@ -12,9 +12,3 @@ module Pio
     end
   end
 end
-
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End:

data/lib/pio/lldp/ttl_tlv.rb

@@ -1,5 +1,5 @@
-# -*- coding: utf-8 -*-
-require 'rubygems'
+# encoding: utf-8
+
 require 'bindata'
 
 module Pio
@@ -8,9 +8,9 @@ module Pio
     class TtlTlv < BinData::Primitive
       endian :big
 
-      bit7 :tlv_type, :value => 3
-      bit9 :tlv_info_length, :value => 2
-      string :ttl, :read_length => :tlv_info_length
+      bit7 :tlv_type, value: 3
+      bit9 :tlv_info_length, value: 2
+      string :ttl, read_length: :tlv_info_length
 
       def get
         BinData::Int16be.read(ttl)
@@ -22,9 +22,3 @@ module Pio
     end
   end
 end
-
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End:

data/lib/pio/mac.rb

@@ -1,4 +1,5 @@
-# -*- coding: utf-8 -*-
+# encoding: utf-8
+
 require 'forwardable'
 
 module Pio
@@ -60,7 +61,7 @@ module Pio
     # @return [String]
     #
     def to_s
-      sprintf('%012x', @value).unpack('a2' * 6).join(':')
+      format('%012x', @value).unpack('a2' * 6).join(':')
     end
 
     #
@@ -191,7 +192,7 @@ module Pio
     # @return [String]
     #
     def inspect
-      %{#<#{ self.class }:#{ __id__ } "#{ to_s }">}
+      %(#<#{self.class}:#{__id__} "#{self}">)
     end
 
     # @!endgroup
@@ -212,9 +213,3 @@ module Pio
     end
   end
 end
-
-### Local variables:
-### mode: Ruby
-### coding: utf-8-unix
-### indent-tabs-mode: nil
-### End:

data/lib/pio/message_type_selector.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+require 'English'
+
+module Pio
+  # Macros for defining message types.
+  module MessageTypeSelector
+    def message_type(options)
+      const_set(:MESSAGE_TYPE, options)
+    end
+
+    def read(raw_data)
+      begin
+        frame = const_get(:Frame).read(raw_data)
+      rescue
+        raise Pio::ParseError, $ERROR_INFO.message
+      end
+
+      const_get(:MESSAGE_TYPE)[frame.message_type].create_from frame
+    end
+  end
+end

data/lib/pio/options.rb

@@ -0,0 +1,65 @@
+# encoding: utf-8
+
+module Pio
+  # User options utility.
+  class Options
+    def self.mandatory_option(name)
+      unless const_defined?(:MANDATORY_OPTIONS)
+        const_set(:MANDATORY_OPTIONS, [])
+      end
+      const_get(:MANDATORY_OPTIONS) << name
+    end
+
+    def self.option(name)
+      const_set(:OPTIONS, []) unless const_defined?(:OPTIONS)
+      const_get(:OPTIONS) << name
+    end
+
+    private
+
+    def validate(user_options)
+      check_unknown user_options
+      check_mandatory user_options
+    end
+
+    def mandatory_options
+      klass = self.class
+      if klass.const_defined?(:MANDATORY_OPTIONS)
+        klass.const_get(:MANDATORY_OPTIONS)
+      else
+        []
+      end
+    end
+
+    def options
+      klass = self.class
+      if klass.const_defined?(:OPTIONS)
+        klass.const_get(:OPTIONS)
+      else
+        []
+      end
+    end
+
+    def check_unknown(user_options)
+      valid_options = mandatory_options + options
+      user_options.keys.each do |each|
+        fail "Unknown option: #{each}." unless valid_options.include?(each)
+      end
+    end
+
+    def check_mandatory(user_options)
+      self.class.const_get(:MANDATORY_OPTIONS).each do |each|
+        check_existence(user_options, each)
+      end
+    end
+
+    def check_existence(user_options, key)
+      value = user_options.fetch(key) do |missing_key|
+        fail ArgumentError, "The #{missing_key} option should be passed."
+      end
+      unless value
+        fail(ArgumentError, "The #{key} option shouldn't be #{value.inspect}.")
+      end
+    end
+  end
+end