ipaddr_list 0.0.1

data/ChangeLog

@@ -0,0 +1,4 @@
+== 0.0.1 / 2008-09-05
+
+* initial release
+

data/README

@@ -0,0 +1,32 @@
+
+= ipaddr_list
+
+seach ip address area faster than linear search IPAddr's Array.
+
+== Synopsis
+
+  require 'ipaddr_list'
+
+  list = IPAddrList.new(['192.168.2.3/24', '192.168.0.100/24'], :BinarySearch)
+  list.add('192.168.1.100/24')
+  list.include?('192.168.0.30') #=> true
+
+== Description
+
+== Installation
+
+=== Archive Installation
+
+	rake install
+
+=== Gem Installation
+
+	gem install ipaddr_list
+
+== Features/Problems
+
+== Copyright
+
+Author::    Keiji, Yoshimi <walf443 at gmail.com>
+Copyright:: Copyright (c) 2008 Keiji, Yoshimi
+License:: you can redistribute it and/or modify it under the same terms as Ruby itself.

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+require 'rake/contrib/sshpublisher'
+require 'fileutils'
+include FileUtils
+
+load File.join(File.dirname(__FILE__), 'tasks', 'basic_config.rake')
+
+NAME              = "ipaddr_list"
+DESCRIPTION       = <<-"END_DESCRIPTION"
+
+END_DESCRIPTION
+BIN_FILES         = %w(  )
+VERS              = "0.0.1"
+
+EXTRA_RDOC_FILES = []
+HECKLE_ROOT_MODULES = ["IPAddrList"]
+
+SPEC = Gem::Specification.new do |s|
+	s.name              = NAME
+	s.version           = VERS
+	s.platform          = Gem::Platform::RUBY
+	s.has_rdoc          = true
+	s.extra_rdoc_files  = DEFAULT_EXTRA_RDOC_FILES + EXTRA_RDOC_FILES
+	s.rdoc_options     += RDOC_OPTS + ['--title', "#{NAME} documentation"]
+	s.summary           = DESCRIPTION
+	s.description       = DESCRIPTION
+	s.author            = AUTHOR
+	s.email             = EMAIL
+	s.homepage          = HOMEPATH
+	s.executables       = BIN_FILES
+	s.rubyforge_project = RUBYFORGE_PROJECT
+	s.bindir            = "bin"
+	s.require_path      = "lib"
+	s.autorequire       = ""
+	s.test_files        = Dir["spec/*_spec.rb"]
+
+	#s.add_dependency('activesupport', '>=1.3.1')
+	#s.required_ruby_version = '>= 1.8.2'
+
+  if Gem::RubyGemsVersion >= "1.2"
+	  s.add_development_dependency('rspec', '>=1.1.4')
+  end
+
+	s.files = PKG_FILES + EXTRA_RDOC_FILES
+	s.extensions = EXTENSIONS
+end
+
+import File.join(File.dirname(__FILE__), 'tasks', 'basic_tasks.rake')

data/lib/ipaddr_list.rb

@@ -0,0 +1,179 @@
+
+require 'ipaddr'
+
+# taking method from 1.9.0 for comparing IPAddr instance.
+if RUBY_VERSION < '1.9.0'
+  class IPAddr
+    # This code come from Ruby 1.9
+    # Compares the ipaddr with another.
+    def <=>(other)
+      other = coerce_other(other)
+
+      return nil if other.family != @family
+
+      return @addr <=> other.to_i
+    end
+    include Comparable
+
+    private
+    
+    def coerce_other(other)
+      case other
+      when IPAddr
+        other
+      when String
+        self.class.new(other)
+      else
+        self.class.new(other, @family)
+      end
+    end
+  end
+end
+
+#
+# SYNOPSIS
+#
+#   require 'ipaddr_list'
+#   list = IPAddrList.new(['192.168.2.3/24', '192.168.0.100/24'], :BinarySearch)
+#   list.add('192.168.1.100/24')
+#   list.include?('192.168.0.30') #=> true
+#
+#
+class IPAddrList
+  module Algorithm
+    # base interface for algorithm module. algorithm module should include this.
+    module Lint
+      # called automatically from IPAddrList#initialize.
+      # you should implement how save ip address list.
+      def after_init ip_list=[]
+        raise NotImprementedError
+      end
+
+      # abstract method. your should implement adding iterating ip address list.
+      def each &block
+        raise NotImprementedError
+      end
+      
+      include Enumerable
+
+      # abstract method. you should implement adding ip address to ip address list.
+      def add ip
+        raise NotImprementedError
+      end
+    end
+
+    # slow and simple. It's for just benchmarking script.
+    module LinearSearch
+      include Lint
+
+      def after_init ip_list=[]
+        @ip_list = ip_list.map {|item|
+          if item.kind_of? IPAddr
+            item
+          else
+            IPAddr.new(item.to_s)
+          end
+        }
+      end
+
+      def add ip
+        unless ip.kind_of? IPAddr
+          ip = IPAddr.new(ip.to_s)
+        end
+        @ip_list.push ip
+      end
+
+      $LinearCount = 0
+      def each &block
+        @ip_list.each(&block)
+      end
+
+      def include? ip
+        if ip.kind_of? IPAddr
+          ipaddr = ip
+        else
+          ipaddr = IPAddr.new(ip)
+        end
+        @ip_list.any? {|item| item.include? ipaddr }
+      end
+    end
+
+    # searching ipaddress with binary search.
+    module BinarySearch
+      include Lint
+
+      def after_init ip_list=[]
+        @ip_list = ip_list.map {|item|
+          if item.kind_of? IPAddr
+            item
+          else
+            IPAddr.new(item.to_s)
+          end
+        }.sort
+      end
+
+      def add ip
+        unless ip.kind_of? IPAddr
+          ip = IPAddr.new(ip.to_s)
+        end
+        @ip_list.push(ip)
+        @ip_list = @ip_list.sort
+      end
+
+      def each &block
+        @ip_list.each(&block)
+        self
+      end
+
+      def include? ip
+        binary_search ip do |ipaddr, range|
+          range.any? {|idx| @ip_list[idx].include? ipaddr }
+        end
+      end
+
+      # binary search
+      # SEE ALSO: http://dsas.blog.klab.org/archives/51293334.html
+      def binary_search ip, &block
+        ipaddr = IPAddr.new(ip)
+        min_idx = 0
+        max_idx = @ip_list.size - 1
+        if @ip_list[max_idx] > ipaddr
+          min_idx = max_idx
+        elsif @ip_list[min_idx] < ipaddr
+          max_idx = min_idx
+        else
+          span = max_idx - min_idx
+          while ( ( span ) > 7 ) do
+            middle_idx = span / 2 + min_idx
+            middle_ip = @ip_list[ middle_idx ]
+            if ipaddr >= middle_ip
+              min_idx = middle_idx
+            else
+              max_idx = middle_idx
+            end
+
+            span = max_idx - min_idx
+          end
+        end
+
+        block.call(ipaddr, min_idx..max_idx)
+      end
+    end
+  end
+
+  def initialize ip_list, algorithm=IPAddrList::Algorithm::BinarySearch
+    unless algorithm.kind_of? Module
+      algorithm = IPAddrList::Algorithm.const_get(algorithm.to_s)
+    end
+    self.extend(algorithm)
+    @algorithm = algorithm
+    after_init ip_list
+  end
+end
+
+if $0 == __FILE__
+  ip_list = IPAddrList.new(['192.168.2.3/24', '192.168.0.100/24'], :BinarySearch)
+  ip_list.add('192.168.1.10/24')
+  p ip_list.include?('192.168.1.1')
+  p ip_list.include?('192.168.0.100')
+end

data/spec/ipaddr_list_spec.rb

@@ -0,0 +1,5 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+require 'ipaddr_list'
+
+describe IPAddrList do
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+-Du -c -fs

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'spec'
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/../lib/'))
+

data/tasks/basic_config.rake

@@ -0,0 +1,22 @@
+AUTHOR            = "Keiji, Yoshimi"
+EMAIL             = "walf443 at gmail.com"
+RUBYFORGE_PROJECT = "akasakarb"
+RUBYFORGE_PROJECT_ID = 4314
+HOMEPATH          = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+RDOC_OPTS = [
+	"--charset", "utf-8",
+	"--opname", "index.html",
+	"--line-numbers",
+	"--main", "README",
+	"--inline-source",
+  '--exclude', '^(example|extras)/'
+]
+DEFAULT_EXTRA_RDOC_FILES = ['README', 'ChangeLog']
+PKG_FILES = [ 'Rakefile' ] + 
+  DEFAULT_EXTRA_RDOC_FILES +
+  Dir.glob('{bin,lib,test,spec,doc,tasks,script,generator,templates,extras,website}/**/*') + 
+  Dir.glob('ext/**/*.{h,c,rb}') +
+  Dir.glob('examples/**/*.rb') +
+  Dir.glob('tools/*.rb')
+
+EXTENSIONS = FileList['ext/**/extconf.rb'].to_a

data/tasks/basic_tasks.rake

@@ -0,0 +1,139 @@
+
+REV = File.read(".svn/entries")[/committed-rev="(d+)"/, 1] rescue nil
+CLEAN.include ['**/.*.sw?', '*.gem', '.config']
+
+Rake::GemPackageTask.new(SPEC) do |p|
+	p.need_tar = true
+	p.gem_spec = SPEC
+end
+
+task :default => [:spec]
+task :test    => [:spec]
+task :package => [:clean]
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = ['--options', 'spec/spec.opts']
+  t.warning = true
+  t.rcov = true
+  t.rcov_dir = 'doc/output/coverage'
+  t.rcov_opts = ['--exclude', 'spec,\.autotest']
+end
+
+desc "Heckle each module and class in turn"
+task :heckle => :spec do
+  root_modules = HECKLE_ROOT_MODULES
+  spec_files = FileList['spec/**/*_spec.rb']
+  
+  current_module, current_method = nil, nil
+  heckle_caught_modules = Hash.new { |hash, key| hash[key] = [] }
+  unhandled_mutations = 0
+  
+  root_modules.each do |root_module|
+    IO.popen("heckle #{root_module} -t #{spec_files}") do |pipe|
+      while line = pipe.gets
+        line = line.chomp
+        
+        if line =~ /^\*\*\*  ((?:\w+(?:::)?)+)#(\w+)/
+          current_module, current_method = $1, $2
+        elsif line == "The following mutations didn't cause test failures:"
+          heckle_caught_modules[current_module] << current_method
+        elsif line == "+++ mutation"
+          unhandled_mutations += 1 
+        end
+              
+        puts line
+      end
+    end
+  end
+  
+  if unhandled_mutations > 0
+    error_message_lines = ["*************\n"]
+    
+    error_message_lines << 
+      "Heckle found #{unhandled_mutations} " + 
+      "mutation#{"s" unless unhandled_mutations == 1} " +
+      "that didn't cause spec violations\n"
+
+    heckle_caught_modules.each do |mod, methods|
+      error_message_lines <<
+        "#{mod} contains the following poorly-specified methods:"
+      methods.each do |m| 
+        error_message_lines << " - #{m}"
+      end
+      error_message_lines << ""
+    end
+    
+    error_message_lines <<
+      "Get your act together and come back " +
+      "when your specs are doing their job!"
+    
+    puts "*************"
+    raise error_message_lines.join("\n")
+  else
+    puts "Well done! Your code withstood a heckling."
+  end
+end
+
+require 'spec/rake/verify_rcov'
+RCov::VerifyTask.new(:rcov => :spec) do |t|
+  t.index_html = "doc/output/coverage/index.html"
+  t.threshold = 100
+end
+
+task :install do
+	name = "#{NAME}-#{VERS}.gem"
+	sh %{rake package}
+	sh %{sudo gem install pkg/#{name}}
+end
+
+task :uninstall => [:clean] do
+	sh %{sudo gem uninstall #{NAME}}
+end
+
+
+Rake::RDocTask.new do |rdoc|
+	rdoc.rdoc_dir = 'html'
+	rdoc.options += RDOC_OPTS
+	rdoc.template = "resh"
+	#rdoc.template = "#{ENV['template']}.rb" if ENV['template']
+	if ENV['DOC_FILES']
+		rdoc.rdoc_files.include(ENV['DOC_FILES'].split(/,\s*/))
+	else
+		rdoc.rdoc_files.include('README', 'ChangeLog')
+		rdoc.rdoc_files.include('lib/**/*.rb')
+		rdoc.rdoc_files.include('ext/**/*.c')
+	end
+end
+
+desc "Publish to RubyForge"
+task :rubyforge => [:rdoc, :package] do
+	require 'rubyforge'
+	Rake::RubyForgePublisher.new(RUBYFORGE_PROJECT, 'yoshimi').upload
+end
+
+desc 'Package and upload the release to rubyforge.'
+task :release => [:clean, :package] do |t|
+	require 'rubyforge'
+	v = ENV["VERSION"] or abort "Must supply VERSION=x.y.z"
+	abort "Versions don't match #{v} vs #{VERS}" unless v == VERS
+	pkg = "pkg/#{NAME}-#{VERS}"
+
+	rf = RubyForge.new
+	puts "Logging in"
+	rf.login
+
+	c = rf.userconfig
+#	c["release_notes"] = description if description
+#	c["release_changes"] = changes if changes
+	c["preformatted"] = true
+
+	files = [
+		"#{pkg}.tgz",
+		"#{pkg}.gem"
+	].compact
+
+	puts "Releasing #{NAME} v. #{VERS}"
+	rf.add_release RUBYFORGE_PROJECT_ID, RUBYFORGE_PACKAGE_ID, VERS, *files
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: ipaddr_list
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Keiji, Yoshimi
+autorequire: ""
+bindir: bin
+cert_chain: []
+
+date: 2008-09-13 00:00:00 +09:00
+default_executable: 
+dependencies: []
+
+description: ""
+email: walf443 at gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- ChangeLog
+files: 
+- Rakefile
+- README
+- ChangeLog
+- lib/ipaddr_list.rb
+- spec/ipaddr_list_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- doc/output
+- tasks/basic_config.rake
+- tasks/basic_tasks.rake
+has_rdoc: true
+homepage: http://akasakarb.rubyforge.org
+post_install_message: 
+rdoc_options: 
+- --charset
+- utf-8
+- --opname
+- index.html
+- --line-numbers
+- --main
+- README
+- --inline-source
+- --exclude
+- ^(example|extras)/
+- --title
+- ipaddr_list documentation
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: akasakarb
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: ""
+test_files: 
+- spec/ipaddr_list_spec.rb