govuk_seed_crawler 3.1.0 → 3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0d80cc9a1bf29784700e23b1f8c883fc6012a2e7a47776cc3af04ca87f253e7
-  data.tar.gz: ca2d04361ff8e9d9b3cf34f0432eb786b026ffcfd035b1a5faeed6c32801880a
+  metadata.gz: b21f7a2314d49cbd45cc088701f0daffb8a3e825b290fcf5c454584d87c4f0ef
+  data.tar.gz: 9196ec323378850139a89bcfa8e6200d9b3cc0ac22b60b07143b4ea836932530
 SHA512:
-  metadata.gz: 895569f56489bbfce199620c211742b226b56d0cc8a03d17451b8a382f2743ba1d7c7821ff9fe75925d411d9b99a595981cf72fb5334907f59f33bf0a24ec000
-  data.tar.gz: 8ea165b2ed3d62a63a5a331b03e14e2fe0dd68713bf7732d28bd2b5cfc4e20a6b5a4932c503fc0514d1a0ea1c6d58343afe864612d8190a2521638d62eea0e83
+  metadata.gz: 4d184e26fc0f0307ad3eb4117bd8f9591c1d4f6418d59a48a0272d5af81046760a2ba64e2e9756825d3f37c9d66d36ab67aab8ee07df9f631a68438d7c8b74f3
+  data.tar.gz: 8fe2a28c7e108612d5d4f32fa4c0fcf83ab849baefb974d8eb58cc140a788bdc487c521a45c3c8140a126cd60e5d4c1c63c1ace4025bbf6136535e9d8db80b63

data/.github/workflows/ci.yml

@@ -7,7 +7,7 @@ jobs:
       fail-fast: false
       matrix:
         # Due to https://github.com/actions/runner/issues/849, we have to use quotes for '3.0'
-        ruby: [ 2.7, '3.0', 3.1 ]
+        ruby: [2.7, '3.0', 3.1, 3.2]
     runs-on: ubuntu-latest
     services:
       rabbitmq:
@@ -42,6 +42,6 @@ jobs:
     if: ${{ github.ref == 'refs/heads/main' }}
     permissions:
       contents: write
-    uses: alphagov/govuk-infrastructure/.github/workflows/publish-rubygem.yaml@main
+    uses: alphagov/govuk-infrastructure/.github/workflows/publish-rubygem.yml@main
     secrets:
       GEM_HOST_API_KEY: ${{ secrets.ALPHAGOV_RUBYGEMS_API_KEY }}

data/CHANGELOG.md

@@ -6,6 +6,11 @@
   useful summary for people upgrading their application, not a replication
   of the commit log.
 
-## Unreleased
+## 3.2.1
 
-- Drop support for Ruby < 2.7
+- Update minimum Slop requirement from 3.6 to 4.0 ([#38](https://github.com/alphagov/govuk_seed_crawler/pull/38))
+
+## 3.2.0
+
+- Drop support for Ruby < 2.7 ([#23](https://github.com/alphagov/govuk_seed_crawler/pull/23))
+- Update major version of 'Slop' dependency ([#17](https://github.com/alphagov/govuk_seed_crawler/pull/17))

data/README.md

@@ -31,6 +31,12 @@ Run with `--help` to see a list of options:
 bundle exec seed-crawler --help
 ```
 
+## Deployment
+
+The gem is automatically deployed to RubyGems when the gem [version](https://github.com/alphagov/govuk_seed_crawler/blob/main/lib/govuk_seed_crawler/version.rb) is updated on `main`. (Don't forget to add to the [CHANGELOG](https://github.com/alphagov/govuk_seed_crawler/blob/main/CHANGELOG.md)!
+
+For the new gem version to be used on GOV.UK, you'll need to update the [reference in govuk-puppet](https://github.com/alphagov/govuk-puppet/blob/c5112961e9c3063f077d2de2ffa887b00466c623/modules/govuk_crawler/manifests/init.pp#L142-L150).
+
 ## Contributing
 
 1. Fork it ( http://github.com/{my-github-username}/govuk_seed_crawler/fork )

data/govuk_seed_crawler.gemspec

@@ -20,17 +20,17 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "bunny", ">= 1.3", "< 3.0"
   spec.add_runtime_dependency "crack", "0.4.5"
-  spec.add_runtime_dependency "nokogiri", ">= 1.6", "< 1.14"
+  spec.add_runtime_dependency "nokogiri", ">= 1.6", "< 1.15"
   # Something, somewhere, sometimes requires public_suffix.
   # public_suffix > 1.5 requires ruby > 2.
   spec.add_runtime_dependency "public_suffix", ">= 1.4.6", "< 5.1.0"
   spec.add_runtime_dependency "sitemap-parser", ">= 0.3", "< 0.6"
-  spec.add_runtime_dependency "slop", "~> 3.6.0"
+  spec.add_runtime_dependency "slop", ">= 4.0", "< 4.11"
 
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rspec-mocks", "~> 3.0"
-  spec.add_development_dependency "rubocop-govuk", "4.8.0"
+  spec.add_development_dependency "rubocop-govuk", "4.10.0"
   spec.add_development_dependency "webmock", "~> 3.18"
 end

data/lib/govuk_seed_crawler/cli_parser.rb

@@ -13,7 +13,6 @@ module GovukSeedCrawler
   class CLIParser
     DEFAULTS = {
       exchange: "govuk_crawler_exchange",
-      help: nil,
       host: "localhost",
       password: "guest",
       port: "5672",
@@ -21,7 +20,6 @@ module GovukSeedCrawler
       topic: "#",
       username: "guest",
       verbose: false,
-      version: nil,
       vhost: "/",
     }.freeze
 
@@ -32,45 +30,48 @@ module GovukSeedCrawler
     end
 
     def options
-      Slop.parse!(@argv_array, help: true) do
-        banner <<~HELP
-          Usage: #{$PROGRAM_NAME} site_root [options]
-
-          Seeds an AMQP topic exchange with messages, each containing a URL, for the GOV.UK Crawler Worker
-          to consume:
-
-          https://github.com/alphagov/govuk_crawler_worker
-
-          The AMQP password can also be set as an environment variable and will be read from
-          `#{ENV_AMQP_PASS_KEY}`. If both the environment variable and command-line option for password
-          are set, the environment variable will take higher precedent.
-        HELP
-
-        on :version, "Display version and exit" do
-          puts "Version: #{GovukSeedCrawler::VERSION}"
-          exit 0
-        end
-
-        on :host=, "AMQP host to publish to", default: DEFAULTS[:host]
-        on :port=, "AMQP port", default: DEFAULTS[:port]
-        on :username=, "AMQP username", default: DEFAULTS[:username]
-        on :password=, "AMQP password", default: DEFAULTS[:password]
-        on :exchange=, "AMQP exchange", default: DEFAULTS[:exchange]
-        on :topic=, "AMQP topic", default: DEFAULTS[:topic]
-        on :vhost=, "AMQP vhost", default: DEFAULTS[:vhost]
-
-        on :quiet, "Quiet output", default: DEFAULTS[:quiet]
-        on :verbose, "Verbose output", default: DEFAULTS[:verbose]
+      opts = Slop::Options.new
+      opts.banner = <<~HELP
+        Usage: #{$PROGRAM_NAME} site_root [options]
+
+        Seeds an AMQP topic exchange with messages, each containing a URL, for the GOV.UK Crawler Worker
+        to consume:
+
+        https://github.com/alphagov/govuk_crawler_worker
+
+        The AMQP password can also be set as an environment variable and will be read from
+        `#{ENV_AMQP_PASS_KEY}`. If both the environment variable and command-line option for password
+        are set, the environment variable will take higher precedent.
+      HELP
+      opts.string "--host", "AMQP host to publish to", default: DEFAULTS[:host]
+      opts.string "--port", "AMQP port", default: DEFAULTS[:port]
+      opts.string "--username", "AMQP username", default: DEFAULTS[:username]
+      opts.string "--password", "AMQP password", default: DEFAULTS[:password]
+      opts.string "--exchange", "AMQP exchange", default: DEFAULTS[:exchange]
+      opts.string "--topic", "AMQP topic", default: DEFAULTS[:topic]
+      opts.string "--vhost", "AMQP vhost", default: DEFAULTS[:vhost]
+      opts.bool "-q", "--quiet", "Quiet output", default: DEFAULTS[:quiet]
+      opts.bool "-v", "--verbose", "Verbose output", default: DEFAULTS[:verbose]
+      opts.on "--version", "Display version and exit" do
+        puts "Version: #{GovukSeedCrawler::VERSION}"
+        exit 0
       end
+      opts.on "-h", "--help" do
+        puts opts
+        exit
+      end
+      parser = Slop::Parser.new(opts)
+      parser.parse(@argv_array)
     end
 
     def parse
       opts = options
 
-      if opts[:version].nil?
-        raise CLIException.new("too many arguments provided", opts.help) if @argv_array.size > 1
-        raise CLIException.new("site_root must be provided", opts.help) if @argv_array.size != 1
-      end
+      # opts.arguments shows all arguments NOT processed by the parser,
+      # which should just be the first arg (site root).
+      # See https://github.com/leejarvis/slop#arguments
+      raise CLIException.new("too many arguments provided", opts.to_s) if opts.arguments.count > 1
+      raise CLIException.new("site_root must be provided", opts.to_s) if opts.arguments.count.zero?
 
       options_hash = opts.to_hash
       options_hash[:password] = ENV[ENV_AMQP_PASS_KEY] unless ENV[ENV_AMQP_PASS_KEY].nil?

data/lib/govuk_seed_crawler/version.rb

@@ -1,3 +1,3 @@
 module GovukSeedCrawler
-  VERSION = "3.1.0".freeze
+  VERSION = "3.2.1".freeze
 end

data/spec/govuk_seed_crawler/cli_parser_spec.rb

@@ -32,7 +32,7 @@ describe GovukSeedCrawler::CLIParser do
       options = described_class.new(["http://www.foo.com/"]).options
 
       expect { described_class.new(["-h"]).parse }
-        .to output("#{options.help}\n").to_stdout
+        .to output(options.to_s).to_stdout
         .and raise_exception(SystemExit) { |e| expect(e.status).to eq(0) }
     end
 
@@ -66,10 +66,8 @@ describe GovukSeedCrawler::CLIParser do
         password: "bar",
         exchange: "some_custom_exchange",
         topic: "some_custom_topic",
-        help: nil,
         quiet: false,
         verbose: true,
-        version: nil,
         vhost: "a_vhost",
       }
 

data/spec/govuk_seed_crawler/cli_runner_spec.rb

@@ -33,7 +33,7 @@ describe GovukSeedCrawler::CLIRunner do
       expect(GovukSeedCrawler.logger.level).to eq(Logger::INFO)
     end
 
-    it "sets to ERROR for quite" do
+    it "sets to ERROR for quiet" do
       described_class.new(["http://www.example.com", "--quiet"])
       expect(GovukSeedCrawler.logger.level).to eq(Logger::ERROR)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_seed_crawler
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.1
 platform: ruby
 authors:
 - GOV.UK developers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-31 00:00:00.000000000 Z
+date: 2023-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -53,7 +53,7 @@ dependencies:
         version: '1.6'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '1.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -63,7 +63,7 @@ dependencies:
         version: '1.6'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: public_suffix
   requirement: !ruby/object:Gem::Requirement
@@ -108,16 +108,22 @@ dependencies:
   name: slop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: '4.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: '4.11'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -180,14 +186,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.8.0
+        version: 4.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.8.0
+        version: 4.10.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -256,7 +262,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.24
+rubygems_version: 3.4.9
 signing_key: 
 specification_version: 4
 summary: Retrieves a list of URLs to seed the crawler by publishing them to a RabbitMQ