ipaddr-tree 0.1.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ipaddr-tree.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Charles Lowell
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,17 @@
+# Ipaddr::Tree
+
+Map IP address space onto a binary tree
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ipaddr-tree'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ipaddr-tree

data/Rakefile

@@ -0,0 +1,23 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+task :console do
+  def iprange(start, finish)
+    IPAddr.new(start).blocks_until(finish).map(&:cidr_notation)
+  end
+
+  $:.unshift File.expand_path '../lib', __FILE__
+  require 'pry'
+  require 'ipaddr/tree'
+  require 'ipaddr/tree/range'
+  Pry.cli = true
+  Pry.start binding, {
+    :prompt => [
+      proc {|obj, *| "ip::tree> "},
+      proc {|obj, *| "ip::tree* "}
+    ],
+    :hooks => Pry::Hooks.from_hash({
+      :before_session => proc {|output, *| output.puts "IPAddr::Tree kicks the ass!"}
+    })
+  }
+end

data/ipaddr-tree.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/ipaddr/tree/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Charles Lowell"]
+  gem.email         = ["cowboyd@thefrontside.net"]
+  gem.description   = %q{Map IP Space onto a binary tree}
+  gem.summary       = %q{Sometimes it's helpful to be able to navigate around CIDR space like you would a tree}
+  gem.homepage      = "http://github.com/summon/ipaddr-tree.rb"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "ipaddr-tree"
+  gem.require_paths = ["lib"]
+  gem.version       = IPAddr::Tree::VERSION
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "pry"
+end

data/lib/ipaddr/tree.rb

@@ -0,0 +1,46 @@
+require 'ipaddr/tree/version'
+
+class IPAddr
+  module Tree
+    def parent
+      mask prefix_length - 1 if prefix_length > 0
+    end
+
+    def next_sibling
+      dup.set(@addr + 2 ** block_length) if @addr < (2 ** family_length) - 1
+    end
+
+    def previous_sibling
+      dup.set(@addr - 2 ** block_length) if @addr > 0
+    end
+
+    def left_child
+      mask prefix_length + 1 if block_length > 0
+    end
+
+    def right_child
+      mask(prefix_length + 1).set(@addr + 2 ** (block_length - 1)) if block_length > 0
+    end
+
+    def leaf?
+      prefix_length == family_length
+    end
+
+    def cidr_notation
+      "#{to_s}/#{prefix_length}"
+    end
+
+    def prefix_length
+      family_length - block_length
+    end
+
+    def block_length
+      Math.log2(addr_mask(~@mask_addr) + 1).to_i
+    end
+
+    def family_length
+      ipv4? ? 32 : 128
+    end
+  end
+  include Tree
+end

data/lib/ipaddr/tree/range.rb

@@ -0,0 +1,26 @@
+require 'ipaddr/tree'
+
+class IPAddr
+  module Tree::Range
+    def blocks_until(other)
+      other = IPAddr.new(other.to_s) unless other.is_a?(IPAddr)
+      return other.blocks_until(self) if other < self
+      if include? other
+        if next_sibling.include? other.next_sibling
+          [self]
+        elsif left_child && left_child.include?(other)
+          left_child.blocks_until(other)
+        elsif leaf?
+          [self]
+        else
+          [left_child] + right_child.blocks_until(other)
+        end
+      elsif parent.include? previous_sibling
+        [self] + next_sibling.blocks_until(other)
+      else
+        parent.blocks_until(other)
+      end
+    end
+  end
+  include Tree::Range
+end

data/lib/ipaddr/tree/version.rb

@@ -0,0 +1,4 @@
+require 'ipaddr'
+module IPAddr::Tree
+  VERSION = "0.1.1"
+end

data/spec/ipaddr/tree/range_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+require 'ipaddr/tree/range'
+
+describe IPAddr::Tree::Range do
+
+  it "calculates a full tree" do
+    iprange('0.0.0.4', '0.0.0.7').should eql ['0.0.0.4/30']
+  end
+
+  it "calculates that is full on the left" do
+    iprange('0.0.0.3', '0.0.0.7').should eql ['0.0.0.3/32', '0.0.0.4/30']
+  end
+
+  it 'generates a messed up little range' do
+    iprange('0.0.0.3', '0.0.0.9').should eql ['0.0.0.3/32', '0.0.0.4/30', '0.0.0.8/31']
+  end
+
+  it "generates a range that's clipped down to a single node" do
+    iprange('0.0.0.2', '0.0.0.8').should eql ['0.0.0.2/31', '0.0.0.4/30', '0.0.0.8/32']
+  end
+
+  it "generates a range that's clipped down to a single node" do
+    iprange('0.0.0.2', '0.0.0.9').should eql ['0.0.0.2/31', '0.0.0.4/30', '0.0.0.8/31']
+  end
+
+  it 'ahem' do
+    iprange('0.0.0.0/29', '0.0.0.6/32').should eql ["0.0.0.0/30", "0.0.0.4/31", "0.0.0.6/32"]
+  end
+
+  it 'handles can handle weirdness' do
+    iprange('0.0.0.4', '0.0.0.6').should eql ['0.0.0.4/31', '0.0.0.6/32']
+    iprange('155.48.168.0','155.48.171.0').should eql [
+      '155.48.168.0/23',
+      '155.48.170.0/24',
+      '155.48.171.0/32'
+    ]
+  end
+
+  it "handles some real ranges from the wild" do
+    iprange('64.70.116.50', '64.70.116.54').should eql ['64.70.116.50/31', '64.70.116.52/31', '64.70.116.54/32']
+    iprange('212.138.110.1','212.138.110.128').should eql [
+      '212.138.110.1/32',
+      '212.138.110.2/31',
+      '212.138.110.4/30',
+      '212.138.110.8/29',
+      '212.138.110.16/28',
+      '212.138.110.32/27',
+      '212.138.110.64/26',
+      '212.138.110.128/32'
+    ]
+    iprange('155.48.0.0', '155.48.255.255')
+  end
+
+
+  def iprange(start, finish)
+    IPAddr.new(start).blocks_until(IPAddr.new(finish)).map(&:cidr_notation)
+  end
+end

data/spec/ipaddr/tree_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe IPAddr::Tree do
+
+  describe "a middling node like 0.0.0.4/30" do
+    subject {IPAddr.new "0.0.0.4/30"}
+    its(:parent) {should match_cidr "0.0.0.0/29"}
+    its(:left_child) {should match_cidr "0.0.0.4/31"}
+    its(:right_child) {should match_cidr "0.0.0.6/31"}
+    its(:next_sibling) {should match_cidr "0.0.0.8/30"}
+    its(:previous_sibling) {should match_cidr "0.0.0.0/30"}
+    it {should_not be_leaf}
+  end
+
+  describe "a leaf node like 0.0.0.7/32" do
+    subject {IPAddr.new '0.0.0.7/32'}
+    its(:left_child) {should be_nil}
+    its(:right_child) {should be_nil}
+    it {should be_leaf}
+  end
+
+  describe "the far left corner" do
+    subject {IPAddr.new "0.0.0.0/32"}
+    its(:previous_sibling) {should be_nil}
+    its(:next_sibling) {should match_cidr '0.0.0.1/32'}
+    it {should be_leaf}
+  end
+
+  describe "the far right corner" do
+    subject {IPAddr.new '255.255.255.255'}
+    its(:next_sibling) {should be_nil}
+    its(:previous_sibling) {should match_cidr '255.255.255.254/32'}
+    it {should be_leaf}
+  end
+
+  describe "the root of the tree" do
+    subject {IPAddr.new '0.0.0.0/0'}
+    its(:parent) {should be_nil}
+    it {should_not be_leaf}
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'ipaddr/tree'
+
+RSpec::Matchers.define :match_cidr do |expected|
+  match do |actual|
+    actual.cidr_notation == expected
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: ipaddr-tree
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Charles Lowell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2156680780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2156680780
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &2156680120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2156680120
+description: Map IP Space onto a binary tree
+email:
+- cowboyd@thefrontside.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- ipaddr-tree.gemspec
+- lib/ipaddr/tree.rb
+- lib/ipaddr/tree/range.rb
+- lib/ipaddr/tree/version.rb
+- spec/ipaddr/tree/range_spec.rb
+- spec/ipaddr/tree_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/summon/ipaddr-tree.rb
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Sometimes it's helpful to be able to navigate around CIDR space like you
+  would a tree
+test_files:
+- spec/ipaddr/tree/range_spec.rb
+- spec/ipaddr/tree_spec.rb
+- spec/spec_helper.rb