ip_address_serializer2 0.10.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b1af3aef4f86d6d6c65910c1c10f2c7b165e038b6dee362de779be159e55ece4
+  data.tar.gz: '038f0e10c10cfd129b6cb7f0a5b93e5dbd16d471b0777cbe5d25b2339942b99f'
+SHA512:
+  metadata.gz: b8a7e1878c39cce72cf940befc5e659b267ca7c97bc43603c790f77f36e6e53ef29e2472d9ae67b7971c8351be71d2a3486a62d705f3b46fb51573aa7b0b78c0
+  data.tar.gz: 9babd801e6f74e2f337702da76f06df4ba5367866e5180fe690636d0a871727cc86d873fac2ee12f28d7f6b969c8ae3a3765abacc0c97e316ce472b840417e11

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/README.pdf

data/.rubocop.yml

@@ -0,0 +1,92 @@
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+Layout/LineLength:
+  Exclude:
+    - test/**/*
+  Max: 120
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Lint/BinaryOperatorWithIdenticalOperands:
+  Enabled: true
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+Lint/DuplicateElsifCondition:
+  Enabled: true
+Lint/DuplicateRescueException:
+  Enabled: true
+Lint/EmptyConditionalBody:
+  Enabled: true
+Lint/FloatComparison:
+  Enabled: true
+Lint/MissingSuper:
+  Enabled: true
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+Lint/OutOfRangeRegexpRef:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/SelfAssignment:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+Lint/TopLevelReturnWithArgument:
+  Enabled: true
+Lint/UnreachableLoop:
+  Enabled: true
+Metrics/BlockLength:
+  Exclude:
+    - test/**/*
+Metrics/MethodLength:
+  Max: 35
+Style/AccessorGrouping:
+  Enabled: true
+Style/ArrayCoercion:
+  Enabled: true
+Style/BisectedAttrAccessor:
+  Enabled: true
+Style/CaseLikeIf:
+  Enabled: true
+Style/ClassAndModuleChildren:
+  AutoCorrect: true
+  Enabled: true
+  EnforcedStyle: nested
+Style/Documentation:
+  Enabled: true
+Style/ExplicitBlockArgument:
+  Enabled: true
+Style/ExponentialNotation:
+  Enabled: true
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: always
+Style/GlobalStdStream:
+  Enabled: true
+Style/HashAsLastArrayItem:
+  Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/HashLikeCase:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Style/OptionalBooleanParameter:
+  Enabled: true
+Style/RedundantAssignment:
+  Enabled: true
+Style/RedundantFetchBlock:
+  Enabled: true
+Style/RedundantFileExtensionInRequire:
+  Enabled: true
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+Style/RedundantRegexpEscape:
+  Enabled: true
+Style/SingleArgumentDig:
+  Enabled: true
+Style/SlicingWithRange:
+  Enabled: true
+Style/StringConcatenation:
+  Enabled: true

data/.travis.yml

@@ -0,0 +1,9 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.8
+  - 2.6.6
+  - 2.7.1
+
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at mike.simkins@mac.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ip_address_serializer2.gemspec
+gemspec
+
+gem 'minitest', '~> 5.0'
+gem 'rake', '~> 12.0'

data/Gemfile.lock

@@ -0,0 +1,60 @@
+PATH
+  remote: .
+  specs:
+    ip_address_serializer2 (0.10.0)
+      activemodel (~> 6.0)
+      ruby-ip (~> 0.9)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activesupport (6.0.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    concurrent-ruby (1.1.7)
+    coveralls (0.8.23)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (>= 0.19.4, < 2.0)
+      tins (~> 1.6)
+    docile (1.3.2)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    json (2.3.1)
+    minitest (5.14.1)
+    rake (12.3.3)
+    ruby-ip (0.9.3)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sync (0.5.0)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tins (1.25.0)
+      sync
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  coveralls
+  ip_address_serializer2!
+  minitest (~> 5.0)
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Mike Simkins
+
+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,61 @@
+# IpAddressSerializer2
+
+[![Build Status](https://travis-ci.org/G7M3/ip_address_serializer2.svg?branch=master)](https://travis-ci.org/G7M3/ip_address_serializer2)
+
+[![Coverage Status](https://coveralls.io/repos/github/G7M3/ip_address_serializer2/badge.svg?branch=master)](https://coveralls.io/github/G7M3/ip_address_serializer2?branch=master)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ip_address_serializer2'
+```
+
+And then execute:
+
+```shell
+    $ bundle install
+```
+
+Or install it yourself as:
+
+```shell
+    $ gem install ip_address_serializer2
+```
+
+## Usage
+
+Once the Gem has been added to your Gemfile, in any model that is required to hold an IP Address, add the
+following line to your model
+
+```ruby
+serialize <field name symbol>, IPAddressSerializer
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake test` 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 tags, 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/g7m3/ip\_address\_serializer2.
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected
+to adhere to the [code of conduct](https://github.com/g7m3/ip_address_serializer2/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the IpAddressSerializer2 project's codebases, issue trackers, chat rooms and
+mailing lists is expected to follow the [code of conduct](https://github.com/g7m3/ip_address_serializer2/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'ip_address_serializer2'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ip_address_serializer2.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative 'lib/ip_address_serializer2/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ip_address_serializer2'
+  spec.version       = IpAddressSerializer2::VERSION
+  spec.authors       = ['Mike Simkins']
+  spec.email         = ['software@g7m3.com']
+
+  spec.summary       = 'Gem to enable serialized storage of an IP Address in a string'
+  spec.description   = 'ActiveRecord Serializer to allow the storage of a CIDR IP Address in a String Field'
+  spec.homepage      = 'https://github.com/g7m3/ip_address_serializer2'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['allowed_push_host'] = "https://rubygems.org"
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/g7m3/ip_address_serializer2'
+  spec.metadata['changelog_uri'] = 'https://github.com/g7m3/ip_address_serializer2/blob.master/CHANGELOG.md'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'minitest', '~> 5.14'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
+  spec.add_development_dependency 'coveralls'
+
+  spec.add_dependency 'activemodel', '~> 6.0'
+  spec.add_dependency 'ruby-ip', '~> 0.9'
+
+  # 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(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+end

data/lib/ip_address_serializer2.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require 'ip_address_serializer2/version'
+require 'ip'
+
+DELIMITER = '^'
+V4DELIMITER = '~'
+V6DELIMITER = ':'
+CTXDELIMITER = '%'
+
+# This is the main module. It is called IPAddressSerializer to maintain compatability
+# with the original project, nowever, as it now relies on a custom fork of the ruby-ip
+# library, then gem is called something different
+module IPAddressSerializer
+  class Error < StandardError; end
+
+  # Load the value and return the IP Object.
+  # @param [String] value String representation of the IP Object
+  # @return [IP] The IP Object (from ruby-ip)
+  def self.load(value)
+    return nil if value.nil?
+
+    ctext = nil
+    if value.is_a?(String) && value.index(CTXDELIMITER)
+      ctext = value.split(CTXDELIMITER)[1]
+      value = value.split(CTXDELIMITER)[0]
+    end
+    if value.is_a?(String) && value.index(DELIMITER)
+      value = value.gsub(V4DELIMITER, '') if value[1] == '4' && value.index(V4DELIMITER)
+      value = value.gsub(V6DELIMITER, '') if value[1] == '6' && value.index(V6DELIMITER)
+      ip = IP.new(value.split(DELIMITER))
+      ip.ctx = ctext if ctext
+      ip
+    end
+  end
+
+  # Save the value, which converts either a String, or an IP Object to the String representation for storage
+  # @param [String, IP, IP::V4, IP::V6] String representation, or internal IP representation of an IP Address
+  # @return [String] The encoded string value representing the IP address object
+  def self.dump(value)
+    return nil if value.nil?
+
+    case value
+    when String
+      ip = IP.new(value)
+    when IP, IP::V4, IP::V6
+      ip = value
+    end
+    address = nil
+    if ip.proto == 'v4'
+      rawhex = ip.to_hex
+      address = rawhex[0..1] + V4DELIMITER +
+                rawhex[2..3] + V4DELIMITER +
+                rawhex[4..5] + V4DELIMITER +
+                rawhex[6..7]
+    end
+    if ip.proto == 'v6'
+      rawhex = ip.to_hex
+      address = rawhex[0..3] + V6DELIMITER +
+                rawhex[4..7] + V6DELIMITER +
+                rawhex[8..11] + V6DELIMITER +
+                rawhex[12..15] + V6DELIMITER +
+                rawhex[16..19] + V6DELIMITER +
+                rawhex[20..23] + V6DELIMITER +
+                rawhex[24..27] + V6DELIMITER +
+                rawhex[28..31]
+    end
+    if ip.ctx.nil?
+      [ip.proto, address, ip.pfxlen].join(DELIMITER)
+    else
+      ctext = CTXDELIMITER + ip.ctx.to_s
+      [ip.proto, address, ip.pfxlen, ctext].join(DELIMITER)
+    end
+  end
+end

data/lib/ip_address_serializer2/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module IpAddressSerializer2
+  VERSION = '0.10.0'
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: ip_address_serializer2
+version: !ruby/object:Gem::Version
+  version: 0.10.0
+platform: ruby
+authors:
+- Mike Simkins
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: ruby-ip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: ActiveRecord Serializer to allow the storage of a CIDR IP Address in
+  a String Field
+email:
+- software@g7m3.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ip_address_serializer2.gemspec
+- lib/ip_address_serializer2.rb
+- lib/ip_address_serializer2/version.rb
+homepage: https://github.com/g7m3/ip_address_serializer2
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/g7m3/ip_address_serializer2
+  source_code_uri: https://github.com/g7m3/ip_address_serializer2
+  changelog_uri: https://github.com/g7m3/ip_address_serializer2/blob.master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Gem to enable serialized storage of an IP Address in a string
+test_files: []