ipconverter 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 35d504928af695671d8144143e89352318257797
-  data.tar.gz: 2209fc9ad9a7198c04e7432f1082dfc9baa49467
+  metadata.gz: fb58eea08d7c5c456e4e104201be99be367d3001
+  data.tar.gz: 99fef017ef4f71cfde3b8f7c0e210e3e48878abe
 SHA512:
-  metadata.gz: 801b267b6b1316cc979a26d78662d0ecef5579aa160c90925488174783af33920eef1c7e3d1b7c164fe3126f646e561dabf8ff937d7d0c79ac656c3ea69d5789
-  data.tar.gz: 8a39dd4ec289ae550de076791d58ce113886baa4602091d302f7b13fcf32f3fca765cc68f9f40dca3267742b31ec4c59940222cf02bc7e0b5143eb201c348e39
+  metadata.gz: 7b37510036d6ca814507b484fc505e3de596f9eea574828f94be0faf6ee54a7bb0a2971d54d5803bd9d955b894e627cdbf5d162621a99aebe63f113390af1d78
+  data.tar.gz: 0bae9046ceed9f63c5de6ee3259f9fce79b291832bf55bb224ec29b7c67045f68ecaa7df36bdc4c0e13988b650211db6f2c334c8327f322c5f1ad5d866af5d98

data/.yardopts

@@ -0,0 +1 @@
+lib/**/*.rb ext/**/*.c README

data/Rakefile

@@ -2,6 +2,8 @@ require 'bundler/gem_tasks'
 require 'rake/testtask'
 require 'rake/extensiontask'
 
+ROOT = File.expand_path('..', __FILE__)
+
 Rake::TestTask.new do |t|
   t.libs << 'test'
   t.pattern = 'test/test_*.rb'
@@ -12,3 +14,9 @@ Rake::ExtensionTask.new 'ipconverter' do |ext|
 end
 
 task default: [:compile, :test]
+
+desc "Run benchmarks"
+task benchmark: [:compile] do
+  sh "ruby #{ROOT}/benchmark/str_to_int.rb"
+  sh "ruby #{ROOT}/benchmark/int_to_str.rb"
+end

data/benchmark/int_to_str.rb

@@ -2,7 +2,7 @@ require 'benchmark'
 require 'ipaddr'
 require 'ipconverter'
 
-def ruby_shift(ip)
+def self.ruby_shift(ip)
   [
     (ip >> 24) & 255,
     (ip >> 16) & 255,
@@ -11,13 +11,13 @@ def ruby_shift(ip)
   ].join('.')
 end
 
-ips = 0..999999
+ips = 0..999_999
 
 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('IpConverter') { ips.each { |ip| IpConverter.int_to_str(ip) } }
   x.report('noop') { ips.each { |ip| ip } }
 end

data/benchmark/str_to_int.rb

@@ -2,11 +2,12 @@ require 'benchmark'
 require 'ipaddr'
 require 'ipconverter'
 
-def ip_to_i(ip)
+def self.pack_unpack(ip)
   ip.split('.').collect(&:to_i).pack('C*').unpack('N').first
 end
 
-def ip_to_i2(ip)
+# rubocop:disable AbcSize
+def self.split_multiply(ip)
   octets = ip.split('.').map(&:to_i)
   octets[3] +
     octets[2] * 256 +
@@ -14,7 +15,7 @@ def ip_to_i2(ip)
     octets[0] * 256 * 256 * 256
 end
 
-def ipaddr_to_i(ip)
+def self.ipaddr_to_i(ip)
   IPAddr.new(ip).to_i
 end
 
@@ -33,8 +34,8 @@ puts 'iterations: 1,000,000'
 
 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('pack/unpack') { ips.each { |ip| pack_unpack(ip) } }
+  x.report('split/multiply') { ips.each { |ip| split_multiply(ip) } }
+  x.report('IpConverter') { ips.each { |ip| IpConverter.str_to_int(ip) } }
   x.report('noop') { ips.each { |ip| ip } }
 end

data/ext/ipconverter/ipconverter.c

@@ -14,9 +14,9 @@ void Init_ipconverter() {
 
 /*
  * call-seq:
- *    IpConverter.str_to_int(ip_addr_string) -> Fixnum
+ *    IpConverter.str_to_int(ip_addr_string) -> Integer
  *
- * Converts the passed IP address String into a Fixnum.
+ * Converts the passed IP address String into an Integer.
  *
  * Raises ArgumentError if ip address is not valid.  Leading and trailing
  * whitespace is ignored.
@@ -36,7 +36,7 @@ VALUE method_str_to_int(VALUE _module_, VALUE ip_string) {
   int success = ip_string_to_long(c_string, &result);
 
   if (success) {
-    // Convert the uint32_t back to a ruby Fixnum.
+    // Convert the uint32_t back to a ruby Integer.
     return UINT2NUM(result);
   } else {
     rb_raise(rb_eArgError, "Invalid IP Address String");
@@ -86,9 +86,9 @@ ip_string_to_long(char c_string[], uint32_t *result) {
  *
  */
 VALUE
-method_int_to_str(VALUE _module_, VALUE ip_fixnum) {
+method_int_to_str(VALUE _module_, VALUE ip_integer) {
   char c_string[16];
-  int64_t ip = NUM2LL(ip_fixnum);
+  int64_t ip = NUM2LL(ip_integer);
   if (ip > MAX_IP_INT || ip < 0) {
      rb_raise(rb_eArgError, "IP address integer out of range");
   }

data/ipconverter.gemspec

@@ -11,8 +11,8 @@ Gem::Specification.new do |spec|
   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.description   = 'Fast C extension for converting IP addresses from
+string to integer'
   spec.homepage      = 'http://github.com/joshuawscott/ipconverter'
   spec.license       = 'MIT'
 
@@ -26,4 +26,5 @@ string to integer)
   spec.add_development_dependency 'rake', '~> 10'
   spec.add_development_dependency 'minitest', '~> 5'
   spec.add_development_dependency 'rake-compiler', '~> 0.9'
+  spec.add_development_dependency 'rubocop', '~> 0.47'
 end

data/lib/ipconverter/version.rb

@@ -1,3 +1,3 @@
 module IpConverter
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'.freeze
 end

data/test/test_ipconverter.rb

@@ -2,9 +2,8 @@ require 'ipconverter'
 require 'minitest/autorun'
 
 class TestIpConverter < MiniTest::Test
-  MAX_IP_INT = 4294967295
-  def setup
-  end
+  MAX_IP_INT = 4_294_967_295
+  def setup; end
 
   def test_smallest_ip
     int = IpConverter.str_to_int '0.0.0.0'
@@ -43,11 +42,11 @@ class TestIpConverter < MiniTest::Test
   end
 
   def test_int_to_str_max
-    assert_equal "255.255.255.255", IpConverter.int_to_str(MAX_IP_INT) 
+    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 }
+    assert_raises(ArgumentError) { IpConverter.int_to_str(-1) }
   end
 
   def test_int_to_str_too_big

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ipconverter
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Joshua Scott
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-22 00:00:00.000000000 Z
+date: 2017-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.47'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.47'
 description: |-
   Fast C extension for converting IP addresses from
   string to integer
@@ -77,6 +91,7 @@ extensions:
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".yardopts"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -111,10 +126,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Utilities for working with IP addresses
 test_files:
 - test/test_ipconverter.rb
-has_rdoc: