ipaddr-ext 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 84e45c02d4f47c83919da49e0ed33015bec5b70b0f520925ae08e5a7fb2005c3
+  data.tar.gz: 3c146451e5fc613b3aacf1fd5db662c253b2653b12c32a40c9f91fc18b11f67f
+SHA512:
+  metadata.gz: 9860c9fa616cd56c56094f563410aae1f2ea4a956c63c7b520fa13503b8245af5934075b817df5c2f18d8a6db79182d24abfba4f1b011778b1e120754ed8b371
+  data.tar.gz: a80046f2c50c372008890e3ca8095b60d1189ee00182bb3a95784167a58d1c7456d1e26b41baee6b0de58dd97efb76b9b6584d4b664e085f672c52d70a4e9fb0

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Interop Tokyo ShowNet NOC team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,75 @@
+# 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)
+#=> #<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\""
+```
+
+## 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).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/ipaddr-ext.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/ipaddr-ext/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "ipaddr-ext"
+  spec.version = IPAddrExt::VERSION
+  spec.authors = ["Taketo Takashima"]
+  spec.email = ["t.taketo1113@gmail.com"]
+
+  spec.summary = "Extensions for IPAddr Class"
+  spec.description = "Extensions for IPAddr Class"
+  spec.homepage = "https://github.com/interop-tokyo-shownet/ipaddr-ext"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/interop-tokyo-shownet/ipaddr-ext"
+  spec.metadata["changelog_uri"] = "https://github.com/interop-tokyo-shownet/ipaddr-ext/releases"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rake", ">= 13.0"
+  spec.add_development_dependency "rspec", ">= 3.0"
+end

data/lib/ipaddr-ext/extensions.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module IPAddrExt
+  module Extensions
+    # Returns the broadcast address
+    def broadcast
+      case @family
+      when Socket::AF_INET
+        unless prefix == 32
+          broadcast_addr = @addr + (IPAddr::IN4MASK ^ @mask_addr)
+          return self.clone.set(broadcast_addr, @family)
+        else
+          return self.clone
+        end
+
+      when Socket::AF_INET6
+        nil
+
+      else
+        raise AddressFamilyError, "unsupported address family"
+      end
+    end
+
+    # Returns the wildcard mask in string format e.g. 0.0.255.255
+    # ref: https://github.com/ruby/ipaddr/pull/44
+    def wildcard_mask
+      case @family
+      when Socket::AF_INET
+        mask = IPAddr::IN4MASK ^ @mask_addr
+      when Socket::AF_INET6
+        mask = IPAddr::IN6MASK ^ @mask_addr
+      else
+        raise AddressFamilyError, "unsupported address family"
+      end
+
+      _to_string(mask)
+    end
+
+    # Returns a address greater than the original address by offset
+    # @param offset [Integer]
+    def +(offset)
+      self.clone.set(@addr + offset, @family)
+    end
+
+    # Returns a address less than the original address by offset
+    # @param offset [Integer]
+    def -(offset)
+      self.clone.set(@addr - offset, @family)
+    end
+
+    # Returns the host address
+    def to_host
+      case @family
+      when Socket::AF_INET
+        self.mask(32)
+      when Socket::AF_INET6
+        self.mask(128)
+      else
+        raise AddressFamilyError, "unsupported address family"
+      end
+    end
+
+    # Returns the address with prefix
+    def to_s_with_prefix
+      "#{self.to_s}/#{prefix}"
+    end
+  end
+end

data/lib/ipaddr-ext/json.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module IPAddrExt
+  module JSON
+    def to_json
+      if ipv4? && prefix == 32
+        format("\"%s\"", to_s)
+      elsif ipv6? && prefix == 128
+        format("\"%s\"", to_s)
+      else
+        format("\"%s/%s\"", to_s, prefix)
+      end
+    end
+  end
+end

data/lib/ipaddr-ext/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module IPAddrExt
+  VERSION = "0.1.0"
+end

data/lib/ipaddr-ext.rb

@@ -0,0 +1,9 @@
+require "ipaddr"
+require 'json'
+
+require "ipaddr-ext/version"
+require "ipaddr-ext/extensions"
+require "ipaddr-ext/json"
+
+IPAddr.send(:include, IPAddrExt::Extensions)
+IPAddr.send(:include, IPAddrExt::JSON)

data/sig/ipaddr-ext.rbs

@@ -0,0 +1,4 @@
+module IPAddrExt
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: ipaddr-ext
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Taketo Takashima
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Extensions for IPAddr Class
+email:
+- t.taketo1113@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ipaddr-ext.gemspec
+- lib/ipaddr-ext.rb
+- lib/ipaddr-ext/extensions.rb
+- lib/ipaddr-ext/json.rb
+- lib/ipaddr-ext/version.rb
+- sig/ipaddr-ext.rbs
+homepage: https://github.com/interop-tokyo-shownet/ipaddr-ext
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/interop-tokyo-shownet/ipaddr-ext
+  source_code_uri: https://github.com/interop-tokyo-shownet/ipaddr-ext
+  changelog_uri: https://github.com/interop-tokyo-shownet/ipaddr-ext/releases
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Extensions for IPAddr Class
+test_files: []