resolv-hosts-dynamic 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0a09b00f5fb36feb93cc7e35df97f86f42d3b84c
-  data.tar.gz: 1e19e5b90ad37b68fd5c8923f50f26e599b9e9e8
+SHA256:
+  metadata.gz: 126c6b7b7a5bc340dfcb8488cc1623921ad1976dda6034b7ce2f62e2114fc281
+  data.tar.gz: c82cbd54fba898efb13293f1e91d2254b393ec018b6f8f587949d5ce9c58d73f
 SHA512:
-  metadata.gz: 9a465e79ef198f2b6e12dffa7388e04dfd21bc129e14c29e5c5e72423a41eab6985ce69ac1a35f57d4ae2f84d1ec238460ccc285554fd45540491b8e2f8165f2
-  data.tar.gz: 21cba356d21780ed5b94d1e98a634cc06fa068fb722f595b527ae34ce6516021c7593e2a720e9e2008a3800e3e75c79280198b1136fa0f39185fcad449521e7e
+  metadata.gz: 1f21cc848051647d02da4b41babf250c6f59a40e4eb6944f1a25b4e61544fbdd0305888ccf7d5a577f50c95bbd704560e1e940a949b0d09c1f10fc253bb97a64
+  data.tar.gz: 4e3cd8ffbb2b9f4b1bc2b3a416d177816e9725d9bd0de196a9f9cf82800a12b64d8d065a25b71706eb9a1d328c488170a3a66ddb14418ffbbd41ec09a6014e7f

data/.github/workflows/test.yml

@@ -0,0 +1,27 @@
+name: Run tests
+on: [push, pull_request]
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['2.3', '2.4', '2.5', '2.6', '2.7', '3.0', '3.1']
+    runs-on: ubuntu-latest
+    env:
+      BUNDLE_GEMFILE: ${{ github.workspace }}/spec/spec.gemfile
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - run: bundle exec rspec
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+        bundler-cache: true
+    - run: bundle exec rubocop

data/.gitignore

@@ -1,6 +1,5 @@
 /.bundle/
 /.yardoc
-/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/

data/.pre-commit-config.yaml

@@ -0,0 +1,14 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.4.0
+  hooks:
+  - id: check-added-large-files
+  - id: check-merge-conflict
+  - id: check-yaml
+  - id: end-of-file-fixer
+  - id: trailing-whitespace
+- repo: https://github.com/mattlqx/pre-commit-ruby
+  rev: v1.3.5
+  hooks:
+  - id: rspec
+  - id: rubocop

data/.rubocop.yml

@@ -0,0 +1,21 @@
+---
+AllCops:
+  Exclude:
+    - 'spec/fixtures/**/*'
+    - 'vendor/bundle/**/*'
+  NewCops: enable
+Layout/HashAlignment:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+Metrics:
+  Enabled: false
+Naming/FileName:
+  Enabled: false
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+
+## [1.0.0] - 2023-03-12
+
+### Changed
+
+- Drop support for rubies older than 2.3.0.
+- Improve documentation.
+- Various lint fixes.
+
+
+## [0.0.2] - 2016-04-12
+
+### Changed
+
+- Fix minor doc bugs.
+
+
+## [0.0.1] - 2016-04-08
+
+Initial release.
+
+
+[1.0.0]: https://github.com/chris-reeves/gem-resolv-hosts-dynamic/compare/v0.0.2...v1.0.0
+[0.0.2]: https://github.com/chris-reeves/gem-resolv-hosts-dynamic/compare/v0.0.1...v0.0.2
+[0.0.1]: https://github.com/chris-reeves/gem-resolv-hosts-dynamic/releases/tag/v0.0.1

data/Gemfile

@@ -1,4 +1,16 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
+ruby '2.7.7'
+
 # Specify your gem's dependencies in resolv-hosts-dynamic.gemspec
 gemspec
+
+# Development dependencies
+group :development do
+  gem 'bundler', '~> 2'
+  gem 'rake', '~> 10.0'
+  gem 'rspec'
+  gem 'rubocop', '~> 1.26'
+end

data/Gemfile.lock

@@ -0,0 +1,60 @@
+PATH
+  remote: .
+  specs:
+    resolv-hosts-dynamic (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (10.5.0)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.28.2)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.17.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.17.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.2.0)
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  bundler (~> 2)
+  rake (~> 10.0)
+  resolv-hosts-dynamic!
+  rspec
+  rubocop (~> 1.26)
+
+RUBY VERSION
+   ruby 2.7.7p221
+
+BUNDLED WITH
+   2.3.8

data/README.md

@@ -1,5 +1,8 @@
 # Resolv::Hosts::Dynamic
 
+[![Gem Version](https://badge.fury.io/rb/resolv-hosts-dynamic.svg)](https://badge.fury.io/rb/resolv-hosts-dynamic)
+[![Tests](https://github.com/chris-reeves/gem-resolv-hosts-dynamic/actions/workflows/test.yml/badge.svg)](https://github.com/chris-reeves/gem-resolv-hosts-dynamic/actions/workflows/test.yml)
+
 Dynamic in-memory 'hosts' file for resolving hostnames. Injects entries into
 an in-memory 'hosts' file which can later be used for name resolution without
 having to modify the system hosts file. This is an extension to the standard
@@ -126,7 +129,8 @@ Resolv.getaddresses('www.google.com')
 ## Contributing
 
 1. Fork it ( https://github.com/chris-reeves/gem-resolv-hosts-dynamic/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+2. Install pre-commit (`pip install pre-commit; pre-commit install`)
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request

data/Rakefile

@@ -1,5 +1,9 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
 
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
 
+require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new

data/lib/resolv-hosts-dynamic.rb

@@ -1,26 +1,33 @@
+# frozen_string_literal: true
+
 require 'resolv'
 
 class Resolv
   class Hosts
+    ##
+    # Resolve::Hosts::Dynamic is a dynamic in-memory 'hosts' file for
+    # resolving hostnames. It injects entries into an in-memory 'hosts' file
+    # which can later be used for name resolution without having to modify the
+    # system hosts file. This is an extension to the standard ruby Resolv
+    # library and is useful for over-riding name resolution during testing.
     class Dynamic
-
       def initialize(hosts = [])
         @mutex = Mutex.new
         @name2addr = {}
         @addr2name = {}
 
-        hosts = [hosts] if !hosts.is_a? Array
+        hosts = [hosts] unless hosts.is_a? Array
 
-        hosts.each { |host|
-          self.add_address(host)
-        }
+        hosts.each do |host|
+          add_address(host)
+        end
       end
 
       ##
       # Adds +host+ to the custom resolver.
 
       def add_address(host)
-        @mutex.synchronize {
+        @mutex.synchronize do
           addr = host['addr']
           hostname = host['hostname']
           aliases = host['aliases']
@@ -39,20 +46,20 @@ class Resolv
           @addr2name[addr] += aliases if aliases
           @name2addr[hostname] = [] unless @name2addr.include? hostname
           @name2addr[hostname] << addr
-          aliases.each {|n|
+          aliases&.each do |n|
             n.untaint
             @name2addr[n] = [] unless @name2addr.include? n
             @name2addr[n] << addr
-          } if aliases
-        }
+          end
+        end
       end
 
       ##
       # Gets the IP address of +name+ from the custom resolver.
 
       def getaddress(name)
-        each_address(name) {|address| return address}
-        raise ResolvError.new("No dynamic hosts entry for name: #{name}")
+        each_address(name) { |address| return address } # rubocop:disable Lint/UnreachableLoop
+        raise ResolvError, "No dynamic hosts entry for name: #{name}"
       end
 
       ##
@@ -60,25 +67,23 @@ class Resolv
 
       def getaddresses(name)
         ret = []
-        each_address(name) {|address| ret << address}
-        return ret
+        each_address(name) { |address| ret << address }
+        ret
       end
 
       ##
       # Iterates over all IP addresses for +name+ retrieved from the custom resolver.
 
       def each_address(name, &proc)
-        if @name2addr.include?(name)
-          @name2addr[name].each(&proc)
-        end
+        @name2addr[name].each(&proc) if @name2addr.include?(name)
       end
 
       ##
       # Gets the hostname of +address+ from the custom resolver.
 
       def getname(address)
-        each_name(address) {|name| return name}
-        raise ResolvError.new("No dynamic hosts entry for address: #{address}")
+        each_name(address) { |name| return name } # rubocop:disable Lint/UnreachableLoop
+        raise ResolvError, "No dynamic hosts entry for address: #{address}"
       end
 
       ##
@@ -86,19 +91,16 @@ class Resolv
 
       def getnames(address)
         ret = []
-        each_name(address) {|name| ret << name}
-        return ret
+        each_name(address) { |name| ret << name }
+        ret
       end
 
       ##
       # Iterates over all hostnames for +address+ retrieved from the custom resolver.
 
       def each_name(address, &proc)
-        if @addr2name.include?(address)
-          @addr2name[address].each(&proc)
-        end
+        @addr2name[address].each(&proc) if @addr2name.include?(address)
       end
-
     end
   end
 end

data/resolv-hosts-dynamic.gemspec

@@ -1,23 +1,36 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
-  spec.name          = "resolv-hosts-dynamic"
-  spec.version       = "0.0.2"
-  spec.authors       = ["Chris Reeves"]
-  spec.email         = ["chris.reeves@york.ac.uk"]
-  spec.summary       = %q{Dynamic in-memory 'hosts' file for resolving hostnames.}
-  spec.description   = %q{Dynamic in-memory 'hosts' file for resolving hostnames. Injects entries into an in-memory 'hosts' file which can later be used for name resolution without having to modify the system hosts file. This is an extension to the standard ruby Resolv library and is useful for over-riding name resolution during testing.}
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.name          = 'resolv-hosts-dynamic'
+  spec.version       = '1.0.0'
+  spec.authors       = ['Chris Reeves']
+  spec.email         = ['chris.reeves@iname.com']
+  spec.summary       = "Dynamic in-memory 'hosts' file for resolving hostnames."
+  spec.description   = <<-DESCRIPTION
+    Dynamic in-memory 'hosts' file for resolving hostnames. Injects entries
+    into an in-memory 'hosts' file which can later be used for name resolution
+    without having to modify the system hosts file. This is an extension to
+    the standard ruby Resolv library and is useful for over-riding name
+    resolution during testing.
+  DESCRIPTION
+  spec.homepage      = 'https://github.com/chris-reeves/gem-resolv-hosts-dynamic'
+  spec.license       = 'MIT'
+
+  spec.metadata = {
+    'homepage_uri'          => 'https://github.com/chris-reeves/gem-resolv-hosts-dynamic',
+    'changelog_uri'         => 'https://github.com/chris-reeves/gem-resolv-hosts-dynamic/blob/master/CHANGELOG.md',
+    'source_code_uri'       => 'https://github.com/chris-reeves/gem-resolv-hosts-dynamic',
+    'bug_tracker_uri'       => 'https://github.com/chris-reeves/gem-resolv-hosts-dynamic/issues',
+    'rubygems_mfa_required' => 'true',
+  }
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
+  spec.required_ruby_version = '>= 2.3.0' # rubocop:disable Gemspec/RequiredRubyVersion
 end

data/spec/resolv-hosts-dynamic_spec.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Resolv::Hosts::Dynamic do
-
   describe '#initialize' do
     context 'with an empty params list' do
       res = Resolv::Hosts::Dynamic.new
@@ -122,7 +123,7 @@ describe Resolv::Hosts::Dynamic do
       res.add_address({
         'addr'     => '127.1.2.3',
         'hostname' => 'host.example.com',
-        'aliases'  => [ 'host', 'host2' ],
+        'aliases'  => %w[host host2],
       })
 
       it 'should map the hostname to the address' do
@@ -217,7 +218,7 @@ describe Resolv::Hosts::Dynamic do
     dynres.add_address({
       'addr'     => '127.1.2.3',
       'hostname' => 'host.example.com',
-      'aliases'  => 'host'
+      'aliases'  => 'host',
     })
 
     # name with multiple addresses
@@ -236,9 +237,9 @@ describe Resolv::Hosts::Dynamic do
       end
 
       it 'raises ResolvError if the name can not be looked up' do
-        expect{
+        expect do
           res.getaddress('no.such.host.')
-        }.to raise_error(Resolv::ResolvError)
+        end.to raise_error(Resolv::ResolvError)
       end
     end
 
@@ -246,7 +247,7 @@ describe Resolv::Hosts::Dynamic do
       it 'resolves host.example.com to multiple addresses' do
         expect(
           res.getaddresses('host.example.com')
-        ).to eq [ '127.1.2.3', '127.4.5.6' ]
+        ).to eq ['127.1.2.3', '127.4.5.6']
       end
 
       it 'resolves to no addresses if the name can not be looked up' do
@@ -264,9 +265,9 @@ describe Resolv::Hosts::Dynamic do
       end
 
       it 'raises ResolvError if the address can not be looked up' do
-        expect{
+        expect do
           res.getname('127.7.8.9')
-        }.to raise_error(Resolv::ResolvError)
+        end.to raise_error(Resolv::ResolvError)
       end
     end
 
@@ -274,7 +275,7 @@ describe Resolv::Hosts::Dynamic do
       it 'resolves 127.1.2.3 to a single hostname' do
         expect(
           res.getnames('127.1.2.3')
-        ).to eq [ 'host.example.com', 'host' ]
+        ).to eq ['host.example.com', 'host']
       end
 
       it 'resolves to no hostnames if the address can not be looked up' do

data/spec/spec.gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec path: '..'
+
+# This is a cut down Gemfile with minimal dependencies sufficient to run spec
+# tests across as wide a range of ruby versions as possible.
+group :development do
+  gem 'rspec'
+end

data/spec/spec_helper.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'resolv-hosts-dynamic'

metadata

@@ -1,81 +1,52 @@
 --- !ruby/object:Gem::Specification
 name: resolv-hosts-dynamic
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Chris Reeves
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-12 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  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'
-description: Dynamic in-memory 'hosts' file for resolving hostnames. Injects entries
-  into an in-memory 'hosts' file which can later be used for name resolution without
-  having to modify the system hosts file. This is an extension to the standard ruby
-  Resolv library and is useful for over-riding name resolution during testing.
+date: 2023-03-12 00:00:00.000000000 Z
+dependencies: []
+description: |2
+      Dynamic in-memory 'hosts' file for resolving hostnames. Injects entries
+      into an in-memory 'hosts' file which can later be used for name resolution
+      without having to modify the system hosts file. This is an extension to
+      the standard ruby Resolv library and is useful for over-riding name
+      resolution during testing.
 email:
-- chris.reeves@york.ac.uk
+- chris.reeves@iname.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
+- ".pre-commit-config.yaml"
 - ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
 - lib/resolv-hosts-dynamic.rb
 - resolv-hosts-dynamic.gemspec
 - spec/resolv-hosts-dynamic_spec.rb
+- spec/spec.gemfile
 - spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/chris-reeves/gem-resolv-hosts-dynamic
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/chris-reeves/gem-resolv-hosts-dynamic
+  changelog_uri: https://github.com/chris-reeves/gem-resolv-hosts-dynamic/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/chris-reeves/gem-resolv-hosts-dynamic
+  bug_tracker_uri: https://github.com/chris-reeves/gem-resolv-hosts-dynamic/issues
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -84,18 +55,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Dynamic in-memory 'hosts' file for resolving hostnames.
 test_files:
 - spec/resolv-hosts-dynamic_spec.rb
+- spec/spec.gemfile
 - spec/spec_helper.rb