ipconverter 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 35d504928af695671d8144143e89352318257797
-  data.tar.gz: 2209fc9ad9a7198c04e7432f1082dfc9baa49467
+SHA256:
+  metadata.gz: 54ad3d7a1a322566c642df08f51b0f86b041dd0a112a30f14162b6405a3c134a
+  data.tar.gz: b0a2978036a14dde903662be197e151e87b762474e1127075d237c655893d9c8
 SHA512:
-  metadata.gz: 801b267b6b1316cc979a26d78662d0ecef5579aa160c90925488174783af33920eef1c7e3d1b7c164fe3126f646e561dabf8ff937d7d0c79ac656c3ea69d5789
-  data.tar.gz: 8a39dd4ec289ae550de076791d58ce113886baa4602091d302f7b13fcf32f3fca765cc68f9f40dca3267742b31ec4c59940222cf02bc7e0b5143eb201c348e39
+  metadata.gz: 19e0ed781d197381e9a5f223561350d295e9bc697faa62d312a0faf0af8b00621db0976b49674739a2ba4e235b45f6060e6a5c47dfa0b669733d1d54e4dbfbf3
+  data.tar.gz: 7655da0d139a1e0aec61f43093334d5c449110ba95c2be9a5d16a366ebb49339eddf6eada918e46ad6085a6b5927189a6dac96cad8bb50ffdab5d071d5fcbc38

data/.github/workflows/ruby.yaml

@@ -0,0 +1,28 @@
+name: Ruby CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: ["3.2", "3.1", "3.0", "2.7", "2.6"]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1.134.0
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rake
+      - name: rubocop
+        run: bundle exec rubocop

data/.rubocop.yml

@@ -0,0 +1,15 @@
+AllCops:
+  TargetRubyVersion: "2.6"
+  Exclude:
+    - "benchmark/**/*"
+    - "tmp/**/*"
+StringLiterals:
+  Enabled: false
+  SupportedStyles:
+    - single_quotes
+    - double_quotes
+LineLength:
+  Enabled: true
+  Max: 100
+Style/AccessModifierDeclarations:
+  Enabled: false

data/.yardopts

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

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in ipconverter.gemspec

data/README.md

@@ -1,10 +1,12 @@
 # IpConverter
 
+[![Build Status](https://travis-ci.org/joshuawscott/ipconverter.svg?branch=master)](https://travis-ci.org/joshuawscott/ipconverter)
+
 Library to deal with IP Address conversions/manipulation, such as converting
 a string representation like "192.168.2.1" to its integer representation
 (3232236033)
 
-Tested with Ruby >= 1.9.3.
+Tested with Ruby >= 2.0
 
 ## Installation
 

data/Rakefile

@@ -1,14 +1,24 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 require 'rake/extensiontask'
 
+ROOT = File.expand_path(__dir__)
+
 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'
+  ext.lib_dir = File.join %w[lib ipconverter]
 end
 
-task default: [:compile, :test]
+task default: %i[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

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require 'benchmark'
 require 'ipaddr'
 require 'ipconverter'
 
-def ruby_shift(ip)
+def self.ruby_shift(ip)
   [
     (ip >> 24) & 255,
     (ip >> 16) & 255,
@@ -11,13 +13,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

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 require 'benchmark'
 require 'ipaddr'
 require 'ipconverter'
 
-def ip_to_i(ip)
-  ip.split('.').collect(&:to_i).pack('C*').unpack('N').first
+def self.pack_unpack(ip)
+  ip.split('.').collect(&:to_i).pack('C*').unpack1('N')
 end
 
-def ip_to_i2(ip)
+def self.split_multiply(ip)
   octets = ip.split('.').map(&:to_i)
   octets[3] +
     octets[2] * 256 +
@@ -14,7 +16,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 +35,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/extconf.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 require 'mkmf'
 extension_name = 'ipconverter'
 dir_config(extension_name)
-create_makefile(extension_name)
+create_makefile("ipconverter/ipconverter")

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

@@ -1,6 +1,7 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-ext = File.expand_path('../ext', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+ext = File.expand_path('ext', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 $LOAD_PATH.unshift(ext) unless $LOAD_PATH.include?(ext)
 require 'ipconverter/version'
@@ -11,19 +12,22 @@ 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'
 
+  spec.required_ruby_version = ">= 2.6.0"
+
   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 = %w(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 'bundler'
   spec.add_development_dependency 'minitest', '~> 5'
-  spec.add_development_dependency 'rake-compiler', '~> 0.9'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rake-compiler', '~> 1.0'
+  spec.add_development_dependency 'rubocop', '~> 0.50'
 end

data/lib/ipconverter/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module IpConverter
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/lib/ipconverter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'ipconverter/version'
 require 'ipconverter/ipconverter'
 

data/test/test_ipconverter.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 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 +44,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,71 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: ipconverter
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Joshua Scott
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-03-22 00:00:00.000000000 Z
+date: 2023-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: rake-compiler
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.50'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.50'
 description: |-
   Fast C extension for converting IP addresses from
   string to integer
@@ -76,7 +90,10 @@ extensions:
 - ext/ipconverter/extconf.rb
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yaml"
 - ".gitignore"
+- ".rubocop.yml"
+- ".yardopts"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -94,7 +111,7 @@ homepage: http://github.com/joshuawscott/ipconverter
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -103,18 +120,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.3
-signing_key: 
+rubygems_version: 3.2.33
+signing_key:
 specification_version: 4
 summary: Utilities for working with IP addresses
 test_files:
 - test/test_ipconverter.rb
-has_rdoc: