ipconverter 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf2a5bcd16c2e1debc4e76243f377950e2e29886
-  data.tar.gz: e23960bd3f703c5a0e61eed15256ae7ac069cf79
+  metadata.gz: a5c6788e7c3fc69744f0dc2f24403f73eca1ca1f
+  data.tar.gz: 2698334ced4e0b518741dc61ab0920e79476ab0a
 SHA512:
-  metadata.gz: 68b2fb9ad042f6c2dbca75ef28eae042d2df7a4a34371637e94b6e71ceae060157a8a0c3706d44fcbced43db9bb2ca3efcda03d95716fdcee693b49371dc3f11
-  data.tar.gz: 58f602f002d910d26c07563a82c4d10a95b06cc2be2fc05f0fac13a1c23cfb4030f499321652ec8d2a09489c8465e0859cb1f6495b9070f7a1ebaae05d7df216
+  metadata.gz: ae82161f4019c9223c3d1daca44cede206c70a2909503c7d077bbff8be044e081fb9e48209ce387ad8ad6ec13f5d6732a6b9963b3fbacd13c9023fba19d1cd4f
+  data.tar.gz: 740c071a89938af5001e5a62a27161c7859352cd6184b168595e8209b65928f8c348ab1e8b8f7c13bc3c376bd0ca2788c93b497aa732cc619f12add4fed50b07

data/benchmark/int_to_str.rb

@@ -0,0 +1,23 @@
+require 'benchmark'
+require 'ipaddr'
+require 'ipconverter'
+
+def ruby_shift(ip)
+  [
+    (ip >> 24) & 255,
+    (ip >> 16) & 255,
+    (ip >> 8) & 255,
+    (ip >> 0) & 255
+  ].join('.')
+end
+
+ips = 0..999999
+
+puts 'iterations: 1,000,000'
+
+Benchmark.bmbm do |x|
+  x.report('IPAddr#to_s') { ips.each { |ip| IPAddr.new(ip, Socket::AF_INET).to_s } }
+  x.report('Ruby shifts') { ips.each { |ip| ruby_shift(ip) } }
+  x.report('C shifts') { ips.each { |ip| IpConverter.int_to_str(ip) } }
+  x.report('noop') { ips.each { |ip| ip } }
+end

data/{bench.rb → benchmark/str_to_int.rb}

@@ -29,7 +29,7 @@ ips = []
   end
 end
 
-puts 'iterations: ' + ips.length
+puts 'iterations: 1,000,000'
 
 Benchmark.bmbm do |x|
   x.report('IPAddr#to_i') { ips.each { |ip| IPAddr.new(ip).to_i } }

data/ext/ipconverter/ipconverter.c

@@ -1,12 +1,15 @@
 #include <ruby.h>
 #include "ipconverter.h"
 
+#define MAX_IP_INT 4294967295
+
 // Module name
 VALUE IpConverter = Qnil;
 
 void Init_ipconverter() {
   IpConverter = rb_define_module("IpConverter");
   rb_define_method(IpConverter, "str_to_int", method_str_to_int, 1);
+  rb_define_method(IpConverter, "int_to_str", method_int_to_str, 1);
 }
 
 /*
@@ -68,3 +71,40 @@ ip_string_to_long(char c_string[], uint32_t *result) {
   return 1;
 }
 
+/*
+ * call-seq:
+ *    IpConverter.int_to_str(ip_addr_integer) -> String
+ *
+ * Converts the passed integer into an IPv4 address string.
+ * 
+ * Raises ArugmentError if number is negative, or greater than the maximum
+ * possible value for an IPv4 address (4294967295)
+ *
+ * Example:
+ *    IpConverter.int_to_str(3232236033)
+ *      => "192.168.2.1"
+ * 
+ */
+VALUE
+method_int_to_str(VALUE _module_, VALUE ip_fixnum) {
+  char c_string[16];
+  int64_t ip = NUM2LL(ip_fixnum);
+  if (ip > MAX_IP_INT || ip < 0) {
+     rb_raise(rb_eArgError, "IP address integer out of range");
+  }
+  ip_long_to_string((uint32_t)ip, c_string);
+  return rb_str_new2(c_string);
+}
+
+// This one is a void because the bounds checking is done with the uint32_t
+// type already.
+static void
+ip_long_to_string(uint32_t ip, char c_string[]) {
+  uint8_t bytes[4];
+  bytes[0] = ip & 0xFF;
+  bytes[1] = (ip >> 8) & 0xFF;
+  bytes[2] = (ip >> 16) & 0xFF;
+  bytes[3] = (ip >> 24) & 0xFF; 
+
+  sprintf(c_string, "%d.%d.%d.%d", bytes[3], bytes[2], bytes[1], bytes[0]);
+}

data/ext/ipconverter/ipconverter.h

@@ -1,3 +1,7 @@
 VALUE method_str_to_int(VALUE, VALUE);
 static int ip_string_to_long(char[], uint32_t*);
+
+VALUE method_int_to_str(VALUE, VALUE);
+static void ip_long_to_string(uint32_t, char[]);
+
 void Init_ipconverter();

data/lib/ipconverter.rb

@@ -8,4 +8,5 @@ require 'ipconverter/ipconverter'
 #
 module IpConverter
   module_function :str_to_int
+  module_function :int_to_str
 end

data/lib/ipconverter/version.rb

@@ -1,3 +1,3 @@
 module IpConverter
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/test/test_ipconverter.rb

@@ -2,6 +2,7 @@ require 'ipconverter'
 require 'minitest/autorun'
 
 class TestIpConverter < MiniTest::Test
+  MAX_IP_INT = 4294967295
   def setup
   end
 
@@ -13,7 +14,7 @@ class TestIpConverter < MiniTest::Test
   def test_largest_ip
     int = IpConverter.str_to_int '255.255.255.255'
     # maximum 32-bit integer
-    assert_equal int, 256 * 256 * 256 * 256 - 1
+    assert_equal int, MAX_IP_INT
   end
 
   def test_handles_spaces
@@ -36,4 +37,20 @@ class TestIpConverter < MiniTest::Test
   def test_junk
     assert_raises(ArgumentError) { IpConverter.str_to_int 'junk' }
   end
+
+  def test_int_to_str_0
+    assert_equal "0.0.0.0", IpConverter.int_to_str(0)
+  end
+
+  def test_int_to_str_max
+    assert_equal "255.255.255.255", IpConverter.int_to_str(MAX_IP_INT) 
+  end
+
+  def test_int_to_str_negative
+    assert_raises(ArgumentError) { IpConverter.int_to_str -1 }
+  end
+
+  def test_int_to_str_too_big
+    assert_raises(ArgumentError) { IpConverter.int_to_str(MAX_IP_INT + 1) }
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ipconverter
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Joshua Scott
@@ -81,7 +81,8 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bench.rb
+- benchmark/int_to_str.rb
+- benchmark/str_to_int.rb
 - ext/ipconverter/extconf.rb
 - ext/ipconverter/ipconverter.c
 - ext/ipconverter/ipconverter.h