https://github.com/interop-tokyo-shownet/ipaddr-ext
Extensions for Ruby IPAddr Class
https://github.com/interop-tokyo-shownet/ipaddr-ext
ipaddr ruby shownet
Last synced: 12 months ago
JSON representation
Extensions for Ruby IPAddr Class
- Host: GitHub
- URL: https://github.com/interop-tokyo-shownet/ipaddr-ext
- Owner: interop-tokyo-shownet
- License: mit
- Created: 2022-12-03T13:15:22.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-12-28T05:21:41.000Z (over 1 year ago)
- Last Synced: 2025-05-10T23:03:39.319Z (about 1 year ago)
- Topics: ipaddr, ruby, shownet
- Language: Ruby
- Homepage:
- Size: 43 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# 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
```ruby
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)
#=> #
p (ipaddr3 + 5).to_s_with_prefix
#=> "3ffe:505:2::6/128"
ipaddr4 = IPAddr.new("3ffe:505:2::9")
p (ipaddr4 - 5)
#=> #
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
=> #
ipaddr5.wildcard_mask
=> "0.0.0.255"
# to_host
ipaddr5 = IPAddr.new("3ffe:505:2::/64")
ipaddr5.to_host
=> #
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](https://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](https://opensource.org/licenses/MIT).