ipaddr-ext

IPAddrExt

IPAddrExt provides extensions of IPAddr class.

Installation

Install the gem and add to the application's Gemfile by executing:

$ bundle add ipaddr-ext

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install ipaddr-ext

Usage

require 'ipaddr-ext'

# to_s_with_prefix
ipaddr1 = IPAddr.new("3ffe:505:2::1")
p ipaddr1.to_s_with_prefix
#=> "3ffe:505:2::1/128"

ipaddr2 = IPAddr.new("3ffe:505:2::/64")
p ipaddr2.to_s_with_prefix
#=> "3ffe:505:2::/64"

# +/-
ipaddr3 = IPAddr.new("3ffe:505:2::1")
p (ipaddr3 + 5)
#=> #<IPAddr: IPv6:3ffe:0505:0002:0000:0000:0000:0000:0006/ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff>
p (ipaddr3 + 5).to_s_with_prefix
#=> "3ffe:505:2::6/128"

ipaddr4 = IPAddr.new("3ffe:505:2::9")
p (ipaddr4 - 5)
#=> #<IPAddr: IPv6:3ffe:0505:0002:0000:0000:0000:0000:0004/ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff>
p (ipaddr4 - 5).to_s_with_prefix
#=> "3ffe:505:2::4/128"

# broadcast / wildcard_mask
ipaddr5 = IPAddr.new("192.0.2.0/24")
ipaddr5.broadcast
=> #<IPAddr: IPv4:192.0.2.255/255.255.255.0>
ipaddr5.wildcard_mask
=> "0.0.0.255"

# to_host
ipaddr5 = IPAddr.new("3ffe:505:2::/64")
ipaddr5.to_host
=> #<IPAddr: IPv6:3ffe:0505:0002:0000:0000:0000:0000:0000/ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff>
ipaddr5.to_host.to_s_with_prefix
=> "3ffe:505:2::/128"
ipaddr5.to_host.succ.to_s_with_prefix
=> "3ffe:505:2::1/128"

# to_json: export with prefix string
IPAddr.new("3ffe:505:2::/64").to_json
=> "\"3ffe:505:2::/64\""

# ==: Fix to compare with address prefix
IPAddr.new("192.168.1.0/24") == IPAddr.new("192.168.1.0/24")
=> true
IPAddr.new("192.168.1.0/24") == IPAddr.new("192.168.1.0/25")
=> false # different behavior with pure IPAddr class

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/interop-tokyo-shownet/ipaddr-ext. This project is intended to be a safe, welcoming space for collaboration.

License

The gem is available as open source under the terms of the MIT License.