iface 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea263ec6e38902c82cecbc40cefe2999addbff1a
-  data.tar.gz: 8d0e59d48c63503602bf6cb5a0a367d4b6d86d09
+  metadata.gz: 5d6fa26ea8fbe2745f309e5c2690bca592b2457b
+  data.tar.gz: ec6a7071343fa410811212083862d1fc592e67b1
 SHA512:
-  metadata.gz: 0624fb20cc6f57dd56636fff9ae64f8e06d129ae49a1cd93eeb1746d24661b29154b6984dd06486fa481529be79b07cf7bc3ddbf1cd57a9aef66f6b8027490bb
-  data.tar.gz: b831690e28b9eb1a4012d43836d80dd4d2d058a3e1f6382d4252bea1d5917c8aaa4a60fae070b5a5e8fc2c6d707f317e101de91453c5bce39580e2f411933fb0
+  metadata.gz: b7697cbb1c54cf9e06ce114d43b42742137428bdeac500e4962e6625951a430d194498a709fe96f222ab8a94d7ad79bd821094d296a68537e201344f3f5773a9
+  data.tar.gz: 0d304fd04fb52aa4515a4047578e5d3d61f19a8a9124d7c6d74ebac1761d851d261a43d2f618709be610ac2add9a7cef79e1b348729887a4a8a6d9c0e72191b4

data/lib/iface/config.rb

@@ -6,12 +6,11 @@ require 'ipaddr'
 module Iface
   # Represents a set of ConfigFiles for network interface configuration
   class Config
-    Reserved_IP_Ranges = %w{10.0.0.0/8 192.168.0.0/16}.collect { |i| IPAddr.new(i) }
+    Reserved_IP_Ranges = %w[10.0.0.0/8 192.168.0.0/16].collect { |i| IPAddr.new(i) }
 
     def self.discover(pattern)
       new.tap do |config|
         Dir.glob(pattern) do |fullname|
-          puts fullname
           File.open(fullname) { |io| config.add(fullname, io) }
         end
       end
@@ -19,20 +18,33 @@ module Iface
 
     def initialize
       @files = {}
+      @devices = {}
     end
 
+    # Adds the given `filename` and `io` and returns self
     def add(filename, io)
       file = ConfigFile.create(filename, io)
+
+      # add to files by type
       file_type = file.class.file_type_name
       if @files.key?(file_type)
         @files[file_type] << file
       else
         @files[file_type] = [file]
       end
+
+      # add PrimaryFile to devices by device name
+      @devices[file.device] = file if file.is_a?(PrimaryFile)
+
       self
     end
 
-    # Returns the PrimaryFile
+    # Returns the `PrimaryFile` for `device`
+    def [](device)
+      @devices[device]
+    end
+
+    # Returns the `PrimaryFile` for the primary interface
     #
     # There should be 0 or 1 of these; else it's an error.
     def primary
@@ -43,17 +55,17 @@ module Iface
           false
         else
           ipaddr = IPAddr.new(file.ip_address)
-          !Reserved_IP_Ranges.any? { |range| range.include?(ipaddr) }
+          Reserved_IP_Ranges.none? { |range| range.include?(ipaddr) }
         end
       end
 
       case result.size
-        when 0
-          nil
-        when 1
-          result.first
-        else
-          raise RuntimeError, "Expected 0 or 1 primary files; found #{result.size}"
+      when 0
+        nil
+      when 1
+        result.first
+      else
+        raise "Expected 0 or 1 primary files; found #{result.size}"
       end
     end
   end

data/lib/iface/config_file.rb

@@ -3,15 +3,22 @@
 require_relative 'ip_helpers'
 require_relative 'value_set'
 
+# Monkey-patches `String` to add helper methods
 class String
   def decamelize
-    gsub(/[A-Z]/) {|m| $` == '' ? m.downcase : "_#{m.downcase}"}
+    gsub(/[A-Z]/) { |m| $` == '' ? m.downcase : "_#{m.downcase}" }
   end
 end
 
 module Iface
   # Base class for a network interface config file
+  #
+  # When reading from an existing file, use `.create`. When creating a config
+  # programatically for writing to a file, instantiate one of the subclasses
+  # (e.g. `PrimaryFile.new`).
   class ConfigFile
+    attr_reader :filename, :device, :vars
+
     def self.create(filename, io)
       fname = File.split(filename).last
       device, range_num, clone_num = parse_filename(fname)
@@ -28,10 +35,9 @@ module Iface
 
     def self.parse_filename(filename)
       match = filename.match(/\Aifcfg-(\w+)((-range(\d+))|(:(\d+)))?\Z/)
-      if match
-        device, _skip0, _skip1, range_num, _skip2, clone_num = match.captures
-        [device, range_num&.to_i, clone_num&.to_i]
-      end
+      return unless match
+      device, _skip0, _skip1, range_num, _skip2, clone_num = match.captures
+      [device, range_num&.to_i, clone_num&.to_i]
     end
 
     def self.recognize?(_device, _range_num, _clone_num, _vars)
@@ -39,16 +45,13 @@ module Iface
     end
 
     def self.file_type_name
-      if self.name =~ /File\Z/
-        self.name.split('::').last[0..-5].decamelize.to_sym
-      else
-        nil
-      end
+      name.split('::').last[0..-5].decamelize.to_sym if name.match?(/File\Z/)
     end
 
-    def initialize(filename, device, _range_num, _clone_num, _vars)
+    def initialize(filename, device, _range_num, _clone_num, vars)
       @filename = filename
       @device = device
+      @vars = vars
     end
 
     def static?
@@ -72,11 +75,10 @@ module Iface
 
     def initialize(filename, device, range_num, clone_num, vars)
       super
-      if (vars['bootproto'] == 'static') || (vars['bootproto'] == 'none') # RHEL6 uses "none"
-        @ip_address = vars['ipaddr']
-        @ipv6_address = vars['ipv6addr']
-        @ipv6_secondaries = vars['ipv6addr_secondaries']&.split(/\s+/)
-      end
+      return unless %w[static none].include?(vars['bootproto']) # RHEL6 uses "none"
+      @ip_address = vars['ipaddr']
+      @ipv6_address = vars['ipv6addr']
+      @ipv6_secondaries = vars['ipv6addr_secondaries']&.split(/\s+/)
     end
 
     def static?
@@ -152,10 +154,24 @@ module Iface
     end
   end
 
+  # Represents a loopback file (device "lo")
   class LoopbackFile < ConfigFile
     def self.recognize?(device, _range_num, _clone_num, _vars)
       device == 'lo'
     end
+
+    def initialize(filename, device, range_num, _clone_num, vars)
+      super
+      @ip_address = vars['ipaddr']
+    end
+
+    def static?
+      true
+    end
+
+    def include?(ip)
+      @ip_address == ip
+    end
   end
 
   FILE_TYPES = [

data/lib/iface/ip_address.rb

@@ -3,6 +3,7 @@
 require 'ipaddr'
 
 module Iface
+  # Represents an IP address including subnet mask
   class IpAddress
     def initialize(*args)
       @ipaddr = IPAddr.new(*args)

data/lib/iface/ip_helpers.rb

@@ -2,7 +2,7 @@
 
 # Adds IP-related methods to all Integers
 class Integer
-  Mask32_ = 0xffffffffffffffff
+  Mask32_ = 0xffffffffffffffff # rubocop:disable Style/ConstantName
 
   def to_ip(ipver = 4)
     to_ipaddr(ipver).to_s

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iface
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Jim Cain
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-19 00:00:00.000000000 Z
+date: 2017-09-20 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: camelotjim@jcain.net
@@ -22,7 +22,7 @@ files:
 - lib/iface/ip_address.rb
 - lib/iface/ip_helpers.rb
 - lib/iface/value_set.rb
-homepage: http://rubygems.org/gems/hola
+homepage: http://rubygems.org/gems/iface
 licenses:
 - BSD-3-Clause
 metadata: {}