netaddr 1.5.1 → 1.5.3

data/lib/tree.rb

@@ -1,9 +1,3 @@
-=begin rdoc
- Copyleft (c) 2006 Dustin Spinhirne
-
- Licensed under the same terms as Ruby, No Warranty is provided.
-=end
-
 module NetAddr
 
 #=Tree
@@ -29,10 +23,6 @@ module NetAddr
 #
 class Tree
 
-#==============================================================================#
-# initialize()
-#==============================================================================#
-
 #===Synopsis
 #Create a new Tree object.
 #
@@ -48,10 +38,6 @@ class Tree
         @v6_root = NetAddr::CIDRv6.new(0,0,{:Subnets => []})
     end
 
-#==============================================================================#
-# add!()
-#==============================================================================#
-
 #===Synopsis
 # Add a CIDR address or NetAddr::CIDR object to the tree.
 # Example:
@@ -84,10 +70,6 @@ class Tree
         return(nil)
     end
 
-#==============================================================================#
-# ancestors()
-#==============================================================================#
-
 #===Synopsis
 # Returns all the ancestors of the provided CIDR addresses.
 #
@@ -121,10 +103,6 @@ class Tree
         return(list)
     end
 
-#==============================================================================#
-# children()
-#==============================================================================#
-
 #===Synopsis
 # Returns all the immediate children of the provided CIDR addresses.
 #
@@ -159,10 +137,6 @@ class Tree
         return(list)
     end
 
-#==============================================================================#
-# descendants
-#==============================================================================#
-
 #===Synopsis
 # Return all descendants of the provided CIDR address.
 #
@@ -199,10 +173,6 @@ class Tree
         return(list)
     end
 
-#==============================================================================#
-# delete!()
-#==============================================================================#
-
 #===Synopsis
 # Remove the provided CIDR address from the tree.
 #
@@ -243,10 +213,6 @@ class Tree
         return(removed)
     end
 
-#==============================================================================#
-# dump
-#==============================================================================#
-
 #===Synopsis
 # Dump the contents of this tree.
 #
@@ -268,10 +234,6 @@ class Tree
         return(list)
     end
 
-#==============================================================================#
-# exists?()
-#==============================================================================#
-
 #===Synopsis
 # Has a CIDR address already been added to the tree?
 #
@@ -301,10 +263,6 @@ class Tree
         return(found)
     end
 
-#==============================================================================#
-# fill_in!()
-#==============================================================================#
-
 #===Synopsis
 # Fill in the missing subnets of a particular CIDR.
 #
@@ -341,10 +299,6 @@ class Tree
         return(filled)
     end
 
-#==============================================================================#
-# find()
-#==============================================================================#
-
 #===Synopsis
 # Find and return a CIDR from within the tree.
 #
@@ -375,10 +329,6 @@ class Tree
         return(me)
     end
 
-#==============================================================================#
-# find_space()
-#==============================================================================#
-
 #===Synopsis
 # Find subnets that are of at least size X. Only subnets that are not themselves 
 # subnetted will be returned. :Subnet takes precedence over :IPCount
@@ -446,10 +396,6 @@ class Tree
         return(new_list)
     end
 
-#==============================================================================#
-# longest_match()
-#==============================================================================#
-
 #===Synopsis
 #Find the longest matching branch of our tree to which a 
 #CIDR address belongs. Useful for performing 'routing table' style lookups.
@@ -479,10 +425,6 @@ class Tree
         return( NetAddr.cidr_build(found.version, found.to_i(:network), found.to_i(:netmask)) )
     end
 
-#==============================================================================#
-# prune!()
-#==============================================================================#
-
 #===Synopsis
 # Remove all subnets of the provided CIDR address.
 #
@@ -518,10 +460,6 @@ class Tree
         return(pruned)
     end
 
-#==============================================================================#
-# remove!()
-#==============================================================================#
-
 #===Synopsis
 # Remove the provided CIDR address, and all of its subnets from the tree.
 #
@@ -559,10 +497,6 @@ class Tree
         return(removed)
     end
 
-#==============================================================================#
-# resize!()
-#==============================================================================#
-
 #===Synopsis
 # Resize the provided CIDR address.
 #
@@ -601,10 +535,6 @@ class Tree
         return(resized)
     end
 
-#==============================================================================#
-# root()
-#==============================================================================#
-
 #===Synopsis
 # Returns the root of the provided CIDR address.
 #
@@ -640,10 +570,6 @@ class Tree
         return( NetAddr.cidr_build(parent.version, parent.to_i(:network), parent.to_i(:netmask)) )
     end
 
-#==============================================================================#
-# show()
-#==============================================================================#
-
 #===Synopsis
 # Print the tree as a formatted string.
 #
@@ -692,10 +618,6 @@ class Tree
         return(printed)
     end
 
-#==============================================================================#
-# siblings()
-#==============================================================================#
-
 #===Synopsis
 # Return list of the sibling CIDRs of the provided CIDR address.
 #
@@ -729,10 +651,6 @@ class Tree
         return(list)
     end
 
-#==============================================================================#
-# summarize_subnets!()
-#==============================================================================#
-
 #===Synopsis
 # Summarize all subnets of the provided CIDR address. The subnets will be
 # placed under the new summary address within the tree.
@@ -771,10 +689,6 @@ class Tree
     end
     alias :merge_subnets! :summarize_subnets!
 
-#==============================================================================#
-# supernets()
-#==============================================================================#
-
 #===Synopsis
 # Return list of the top-level supernets of this tree.
 #
@@ -795,12 +709,9 @@ class Tree
     end
 
 
-# PRIVATE INSTANCE METHODS
-private
 
-#==============================================================================#
-# add_to_parent()
-#==============================================================================#
+    
+private
 
 # Add NetStruct object to an array of NetStruct's
 #
@@ -831,10 +742,6 @@ private
         return(nil)
     end
 
-#==============================================================================#
-# add_to_tree()
-#==============================================================================#
-
 # Add CIDR to a Tree
 #
     def add_to_tree(cidr,root=nil)
@@ -844,10 +751,6 @@ private
         return(nil)
     end
 
-#==============================================================================#
-# dump_children()
-#==============================================================================#
-
 #  Dump contents of an Array of NetStruct objects
 #
     def dump_children(parent,depth=0)
@@ -864,10 +767,6 @@ private
         return(list)
     end
 
-#==============================================================================#
-# find_me()
-#==============================================================================#
-
 # Find the NetStruct to which a cidr belongs.
 #
     def find_me(cidr)
@@ -887,10 +786,6 @@ private
         return(me)
     end
 
-#==============================================================================#
-# find_parent()
-#==============================================================================#
-
 # Find the parent NetStruct to which a child NetStruct belongs.
 #
     def find_parent(cidr,parent=nil)

data/lib/validation_shortcuts.rb

@@ -1,10 +1,6 @@
 module NetAddr
 private
 
-#==============================================================================#
-# validate_args()
-#==============================================================================#
-
 # validate options hash 
 #
 def validate_args(to_validate,known_args)
@@ -15,10 +11,6 @@ def validate_args(to_validate,known_args)
 end 
 module_function :validate_args
 
-#==============================================================================#
-# validate_ip_int()
-#==============================================================================#
-
 def validate_ip_int(ip,version)
     version = 4 if (!version && ip < 2**32)
     if (version == 4)
@@ -31,10 +23,6 @@ def validate_ip_int(ip,version)
 end
 module_function :validate_ip_int
 
-#==============================================================================#
-# validate_ip_str()
-#==============================================================================#
-
 def validate_ip_str(ip,version)
     # check validity of charaters
     if (ip =~ /[^0-9a-fA-F\.:]/)
@@ -129,9 +117,6 @@ def validate_ip_str(ip,version)
 end
 module_function :validate_ip_str
 
-#==============================================================================#
-# validate_netmask_int()
-#==============================================================================#
 def validate_netmask_int(netmask,version,is_int=false)
     address_len = 32
     address_len = 128 if (version == 6)
@@ -149,9 +134,6 @@ def validate_netmask_int(netmask,version,is_int=false)
 end
 module_function :validate_netmask_int
 
-#==============================================================================#
-# validate_netmask_str()
-#==============================================================================#
 def validate_netmask_str(netmask,version)
     address_len = 32
     address_len = 128 if (version == 6)

data/test/cidr_test.rb

@@ -1,6 +1,7 @@
 #!/usr/bin/ruby
 
-require 'lib/netaddr.rb'
+#require 'lib/netaddr.rb'
+require_relative "../lib/netaddr.rb"
 require 'test/unit'
 
 

data/test/eui_test.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/ruby
 
-require 'lib/netaddr.rb'
+require_relative "../lib/netaddr.rb"
 require 'test/unit'
 
 

data/test/methods_test.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/ruby
 
-require 'lib/netaddr.rb'
+require_relative "../lib/netaddr.rb"
 require 'test/unit'
 
 

data/test/tree_test.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/ruby
 
-require 'lib/netaddr.rb'
+require_relative "../lib/netaddr.rb"
 require 'test/unit'
 
 

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: netaddr
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.5.3
 platform: ruby
 authors:
 - Dustin Spinhirne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-25 00:00:00.000000000 Z
+date: 2022-07-08 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: 
 executables: []
 extensions: []
 extra_rdoc_files:
-- README
+- README.md
 - Errors
 - changelog
 - license
 files:
 - Errors
-- README
+- README.md
 - changelog
 - lib/cidr.rb
 - lib/cidr_shortcuts.rb
@@ -55,8 +55,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: A package for manipulating network addresses.

data/README

@@ -1,17 +0,0 @@
-=Introduction
-
-NetAddr arose through my need as a network engineer for a 
-back-end module that could easily handle such advanced tasks 
-as automating the subnetting/supernetting
-of IP space, performing calculations on IP CIDR blocks, and other
-various items. At that time there were no modules that could
-do any of the things that I needed, so I set out to create my own. 
-Since it has proven to be fairly useful to me, I have decided to share the
-code with the Ruby community. 
- 
-I have added things that I find immediately useful for me. I am
-open to suggestions if there is something that I could add to make
-your life easier. 
- 
-Dustin Spinhirne
-