ipconverter 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b01a9e80032c6c523fe70643f565243dfa4e29f
-  data.tar.gz: 25c4af9335552cd0a58dc8bdbc1c8b50251057de
+  metadata.gz: cf2a5bcd16c2e1debc4e76243f377950e2e29886
+  data.tar.gz: e23960bd3f703c5a0e61eed15256ae7ac069cf79
 SHA512:
-  metadata.gz: 1360cf3d1f26031a4148b60ced541a31dbbb2d9d4714bde838025a8ce55963aae5cbdb4c24f5d538b2f568b08b3c2a50641e646f1ee1381284bf74581167811a
-  data.tar.gz: d6b6fe8f449d19aa9538b173b01d46d4fd30957b28418d608db74152a8300a748d0565514e35538073e9ebb3502f8fd67537f987c2cf7ad8773dbddd301b6587
+  metadata.gz: 68b2fb9ad042f6c2dbca75ef28eae042d2df7a4a34371637e94b6e71ceae060157a8a0c3706d44fcbced43db9bb2ca3efcda03d95716fdcee693b49371dc3f11
+  data.tar.gz: 58f602f002d910d26c07563a82c4d10a95b06cc2be2fc05f0fac13a1c23cfb4030f499321652ec8d2a09489c8465e0859cb1f6495b9070f7a1ebaae05d7df216

data/Rakefile

@@ -1,13 +1,12 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 require 'rake/testtask'
-require "rake/extensiontask"
+require 'rake/extensiontask'
 
 Rake::TestTask.new do |t|
   t.libs << 'test'
   t.pattern = 'test/test_*.rb'
 end
 
-Rake::ExtensionTask.new "ipconverter" do |ext|
-    ext.lib_dir = "lib/ipconverter"
+Rake::ExtensionTask.new 'ipconverter' do |ext|
+  ext.lib_dir = 'lib/ipconverter'
 end
-

data/bench.rb

@@ -10,8 +10,8 @@ def ip_to_i2(ip)
   octets = ip.split('.').map(&:to_i)
   octets[3] +
     octets[2] * 256 +
-    octets[1] * 256*256 +
-    octets[0] * 256*256*256 
+    octets[1] * 256 * 256 +
+    octets[0] * 256 * 256 * 256
 end
 
 def ipaddr_to_i(ip)
@@ -29,13 +29,12 @@ ips = []
   end
 end
 
-puts "iterations: " + ips.length
+puts 'iterations: ' + ips.length
 
 Benchmark.bmbm do |x|
   x.report('IPAddr#to_i') { ips.each { |ip| IPAddr.new(ip).to_i } }
   x.report('pack/unpack') { ips.each { |ip| ip_to_i(ip) } }
   x.report('split/multiply') { ips.each { |ip| ip_to_i2(ip) } }
-  x.report('C split/multiply') { ips.each {|ip| IpConverter.str_to_int(ip) } }
-  x.report('noop') { ips.each {|ip| ip } }
+  x.report('C split/multiply') { ips.each { |ip| IpConverter.str_to_int(ip) } }
+  x.report('noop') { ips.each { |ip| ip } }
 end
-

data/ext/ipconverter/extconf.rb

@@ -1,5 +1,4 @@
 require 'mkmf'
 extension_name = 'ipconverter'
-$CFLAGS << ' -I. '
 dir_config(extension_name)
 create_makefile(extension_name)

data/ext/ipconverter/ipconverter.c

@@ -9,8 +9,20 @@ void Init_ipconverter() {
   rb_define_method(IpConverter, "str_to_int", method_str_to_int, 1);
 }
 
-// Converts a passed ruby string into an integer
-// returns integer or nil (if ip is invalid)
+/*
+ * call-seq:
+ *    IpConverter.str_to_int(ip_addr_string) -> Fixnum
+ *
+ * Converts the passed IP address String into a Fixnum.
+ *
+ * Raises ArgumentError if ip address is not valid.  Leading and trailing
+ * whitespace is ignored.
+ *
+ * Example:
+ *    IpConverter.str_to_int("192.168.2.1")
+ *      => 3232236033
+ *
+ */
 VALUE method_str_to_int(VALUE _module_, VALUE ip_string) {
 
   // C string version of the ip_string

data/ipconverter.gemspec

@@ -6,23 +6,24 @@ $LOAD_PATH.unshift(ext) unless $LOAD_PATH.include?(ext)
 require 'ipconverter/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "ipconverter"
+  spec.name          = 'ipconverter'
   spec.version       = IpConverter::VERSION
-  spec.authors       = ["Joshua Scott"]
-  spec.email         = ["joshua.scott@gmail.com"]
-  spec.summary       = %q{Utilities for working with IP addresses}
-  spec.description   = %q{Fast C extension for converting IP addresses from string to integer}
-  spec.homepage      = "http://github.com/joshuawscott/ipconverter"
-  spec.license       = "MIT"
+  spec.authors       = ['Joshua Scott']
+  spec.email         = ['joshua.scott@gmail.com']
+  spec.summary       = 'Utilities for working with IP addresses'
+  spec.description   = %q(Fast C extension for converting IP addresses from
+string to integer)
+  spec.homepage      = 'http://github.com/joshuawscott/ipconverter'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.extensions    = ['ext/ipconverter/extconf.rb']
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib", "ext"]
+  spec.require_paths = %w(lib ext)
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake", "~> 10"
-  spec.add_development_dependency "minitest", "~> 5"
-  spec.add_development_dependency 'rake-compiler', "~> 0.9"
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10'
+  spec.add_development_dependency 'minitest', '~> 5'
+  spec.add_development_dependency 'rake-compiler', '~> 0.9'
 end

data/lib/ipconverter.rb

@@ -1,6 +1,11 @@
-require "ipconverter/version"
-require "ipconverter/ipconverter"
+require 'ipconverter/version'
+require 'ipconverter/ipconverter'
 
+# Contains the methods for doing IP Address conversions
+#
+# Example:
+#     IpConverter.str_to_int('192.168.2.1') # 3232236033
+#
 module IpConverter
   module_function :str_to_int
 end

data/lib/ipconverter/version.rb

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

data/test/test_ipconverter.rb

@@ -6,34 +6,34 @@ class TestIpConverter < MiniTest::Test
   end
 
   def test_smallest_ip
-    int = IpConverter.str_to_int "0.0.0.0"
+    int = IpConverter.str_to_int '0.0.0.0'
     assert_equal int, 0
   end
 
   def test_largest_ip
-    int = IpConverter.str_to_int "255.255.255.255"
+    int = IpConverter.str_to_int '255.255.255.255'
     # maximum 32-bit integer
     assert_equal int, 256 * 256 * 256 * 256 - 1
   end
 
   def test_handles_spaces
-    int = IpConverter.str_to_int " 35.49.102.66 "
-    assert_equal int, IpConverter.str_to_int("35.49.102.66")
+    int = IpConverter.str_to_int ' 35.49.102.66 '
+    assert_equal int, IpConverter.str_to_int('35.49.102.66')
   end
+
   def test_no_overflow
-    assert_raises(ArgumentError) { IpConverter.str_to_int "12.12.0.256" }
+    assert_raises(ArgumentError) { IpConverter.str_to_int '12.12.0.256' }
   end
 
   def test_short_ip
-    assert_raises(ArgumentError) { IpConverter.str_to_int "12.34.56" }
+    assert_raises(ArgumentError) { IpConverter.str_to_int '12.34.56' }
   end
 
   def test_long_ip
-    assert_raises(ArgumentError) { IpConverter.str_to_int "12.34.56.78.90" }
+    assert_raises(ArgumentError) { IpConverter.str_to_int '12.34.56.78.90' }
   end
 
   def test_junk
-    assert_raises(ArgumentError) { IpConverter.str_to_int "junk" }
+    assert_raises(ArgumentError) { IpConverter.str_to_int 'junk' }
   end
-
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ipconverter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Joshua Scott
@@ -66,7 +66,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: Fast C extension for converting IP addresses from string to integer
+description: |-
+  Fast C extension for converting IP addresses from
+  string to integer
 email:
 - joshua.scott@gmail.com
 executables: []