govuk_document_types 1.0.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f789c70349961ccb4ddc415ffc398ef47ab69faf0028bacb93329ab8ddc2c2f
-  data.tar.gz: ac205000cf9fc8c16864126521efa05b7d8144b818092489ed92b3808e582bd7
+  metadata.gz: eafd1e5501cefa5331b908c7357798f5f0a235d88ac91f300b1ce8f03f875350
+  data.tar.gz: abe7b6241cdacb05bf3bef50918f0a77f3d9079694f64a4e217a05d3dbaf81f7
 SHA512:
-  metadata.gz: '012833c1d2ad5b68779578a1544e2344819a0da9ee67a9d0cf345e4163fdae7c5e6fe4855f476fdb5c58087e695946bdcb983a3d37d500ea05fca7024b32d61f'
-  data.tar.gz: 1d0f62f78a9f0fb884ae3010d5fac1c40e79c80087fab0c68e4a5acb740ee0a381cb772016e7bd0aa2ed3c2ceddf0a085f63c49d29b1b4fc06df929b3ae26a1f
+  metadata.gz: bda63a418c5d4f865ac7788134461865ed62195ff7b649d02d25c23867c36c98184fd22dd520031c128c1e7265c79400370078998818e5f61d3fd883da978571
+  data.tar.gz: 76da516561c3edf0cccd15c733e50aa5eb92fa2b5c0531f35c0410e5c2eb597262bd91d81074681869ac2722fe086f2af30e82856027a21ed8f6c11fb686b8cd

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: bundler
+    directory: /
+    schedule:
+      interval: daily

data/.github/workflows/ci.yml

@@ -0,0 +1,53 @@
+on: [push, pull_request]
+
+jobs:
+  codeql-sast:
+    name: CodeQL SAST scan
+    uses: alphagov/govuk-infrastructure/.github/workflows/codeql-analysis.yml@main
+    permissions:
+      security-events: write
+
+  dependency-review:
+    name: Dependency Review scan
+    uses: alphagov/govuk-infrastructure/.github/workflows/dependency-review.yml@main
+  
+  # This matrix job runs the test suite against multiple Ruby versions
+  test_matrix:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [3.1, 3.2]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Clone publishing-api for content schemas
+        uses: actions/checkout@v2
+        with:
+          repository: alphagov/publishing-api
+          ref: main
+          path: tmp/publishing-api
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rake
+        env:
+          GOVUK_CONTENT_SCHEMAS_PATH: tmp/publishing-api/content_schemas
+
+  # Branch protection rules cannot directly depend on status checks from matrix jobs.
+  # So instead we define `test` as a dummy job which only runs after the preceding `test_matrix` checks have passed.
+  # Solution inspired by: https://github.community/t/status-check-for-a-matrix-jobs/127354/3
+  test:
+    needs: test_matrix
+    runs-on: ubuntu-latest
+    steps:
+      - run: echo "All matrix tests have passed 🚀"
+
+  publish:
+    needs: test
+    if: ${{ github.ref == 'refs/heads/main' }}
+    permissions:
+      contents: write
+    uses: alphagov/govuk-infrastructure/.github/workflows/publish-rubygem.yml@main
+    secrets:
+      GEM_HOST_API_KEY: ${{ secrets.ALPHAGOV_RUBYGEMS_API_KEY }}

data/.rubocop.yml

@@ -0,0 +1,18 @@
+inherit_gem:
+  rubocop-govuk:
+    - config/default.yml
+    - config/rspec.yml
+
+inherit_mode:
+  merge:
+    - Exclude
+
+# **************************************************************
+# TRY NOT TO ADD OVERRIDES IN THIS FILE
+#
+# This repo is configured to follow the RuboCop GOV.UK styleguide.
+# Any rules you override here will cause this repo to diverge from
+# the way we write code in all other GOV.UK repos.
+#
+# See https://github.com/alphagov/rubocop-govuk/blob/main/CONTRIBUTING.md
+# **************************************************************

data/.ruby-version

@@ -1 +1 @@
-2.6.6
+3.1.5

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# 3.0.0
+
+* BREAKING: Remove specialist topics ([PR #108](https://github.com/alphagov/govuk_document_types/pull/108))
+* Drop support for Ruby 3.0
+
+# 2.0.0
+
+* BREAKING: Drop support for Ruby 2.7 ([PR #89](https://github.com/alphagov/govuk_document_types/pull/89))
+* Added new call for evidence document type to supertypes and group ([PR #91](https://github.com/alphagov/govuk_document_types/pull/91))
+
 # 1.0.1
 
 * Remove Flood & Coastal Erosion Risk Management Report (FCERM) Research Report from research supergroup

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in govuk_document_types.gemspec
 gemspec

data/README.md

@@ -37,4 +37,4 @@ bundle exec rake
 
 ## License
 
-[MIT License](LICENSE.txt)
+[MIT License](LICENCE)

data/Rakefile

@@ -1,6 +1,8 @@
 require "bundler/gem_tasks"
+require "rubocop/rake_task"
 require "rspec/core/rake_task"
 
+RuboCop::RakeTask.new
 RSpec::Core::RakeTask.new(:spec)
 
-task default: :spec
+task default: %i[rubocop spec]

data/data/supergroups.yml

@@ -21,6 +21,7 @@ content_purpose_supergroup:
       subgroups:
         - policy
         - consultations
+        - calls_for_evidence
     - id: research_and_statistics
       subgroups:
         - research

data/data/supertypes.yml

@@ -17,7 +17,6 @@ user_journey_document_supertype:
         - service_manual_topic
         - services_and_information
         - taxon
-        - topic
         - topical_event
 
 email_document_supertype:
@@ -27,6 +26,9 @@ email_document_supertype:
   items:
     - id: "publications"
       document_types:
+        - call_for_evidence
+        - call_for_evidence_outcome
+        - closed_call_for_evidence
         - closed_consultation
         - consultation
         - consultation_outcome
@@ -43,6 +45,7 @@ email_document_supertype:
         - national_statistics
         - notice
         - official_statistics
+        - open_call_for_evidence
         - open_consultation
         - policy_paper
         - promotional
@@ -69,6 +72,12 @@ government_document_supertype:
   # we expect that everything should be mapped to a valid supertype.
   default: other
   items:
+    - id: calls-for-evidence
+      document_types:
+        - call_for_evidence
+        - open_call_for_evidence
+        - call_for_evidence_outcome
+        - closed_call_for_evidence
     - id: consultations
       document_types:
         - consultation
@@ -162,10 +171,8 @@ content_purpose_subgroup:
     - id: news
       document_types:
         - case_study
-        - news_article
         - news_story
         - press_release
-        - world_location_news_article
         - world_news_story
         - fatality_notice
     - id: decisions
@@ -191,7 +198,6 @@ content_purpose_subgroup:
         - completed_transaction
         - local_transaction
         - form
-        - calculator
         - smart_answer
         - simple_smart_answer
         - place
@@ -236,7 +242,6 @@ content_purpose_subgroup:
         - consultation_outcome
     - id: research
       document_types:
-        - dfid_research_output
         - independent_report
         - research
     - id: statistics
@@ -260,6 +265,11 @@ content_purpose_subgroup:
         - aaib_report
         - raib_report
         - maib_report
+    - id: calls_for_evidence
+      document_types:
+        - open_call_for_evidence
+        - closed_call_for_evidence
+        - call_for_evidence_outcome
 
 content_purpose_supergroup:
   name: "Content Purpose Supergroup"
@@ -270,10 +280,8 @@ content_purpose_supergroup:
       document_types:
         - medical_safety_alert
         - drug_safety_update
-        - news_article
         - news_story
         - press_release
-        - world_location_news_article
         - world_news_story
         - fatality_notice
         - tax_tribunal_decision
@@ -296,7 +304,6 @@ content_purpose_supergroup:
         - completed_transaction
         - local_transaction
         - form
-        - calculator
         - smart_answer
         - simple_smart_answer
         - place
@@ -333,9 +340,11 @@ content_purpose_supergroup:
         - open_consultation
         - closed_consultation
         - consultation_outcome
+        - open_call_for_evidence
+        - closed_call_for_evidence
+        - call_for_evidence_outcome
     - id: research_and_statistics
       document_types:
-        - dfid_research_output
         - independent_report
         - research
         - statistics

data/govuk_document_types.gemspec

@@ -1,7 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'govuk_document_types/version'
+require "govuk_document_types/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "govuk_document_types"
@@ -13,15 +12,18 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/alphagov/govuk_document_types"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.required_ruby_version = ">= 3.1"
+  spec.files = `git ls-files -z`.split("\x0").reject do |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"]
+  spec.require_paths = %w[lib]
 
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "govuk-lint", "~> 3.0"
+  spec.add_development_dependency "govuk_schemas", ">= 4.5.0"
   spec.add_development_dependency "i18n-spec"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop-govuk", "4.17.1"
 end

data/lib/govuk_document_types/translations_railtie.rb

@@ -1,7 +1,7 @@
-require 'rails'
+require "rails"
 module GovukDocumentTypes
   class TranslationsRailtie < ::Rails::Railtie
-    initializer 'govuk_document_types' do |app|
+    initializer "govuk_document_types" do |app|
       GovukDocumentTypes::TranslationsRailtie.instance_eval do
         pattern = pattern_from app.config.i18n.available_locales
         add("rails/locale/#{pattern}.yml")
@@ -9,13 +9,13 @@ module GovukDocumentTypes
     end
 
     def self.add(pattern)
-      files = Dir[File.join(File.dirname(__FILE__), '../..', pattern)]
+      files = Dir[File.join(File.dirname(__FILE__), "../..", pattern)]
       I18n.load_path.concat(files)
     end
 
     def self.pattern_from(args)
       array = Array(args || [])
-      array.blank? ? '*' : "{#{array.join ','}}"
+      array.blank? ? "*" : "{#{array.join ','}}"
     end
   end
 end

data/lib/govuk_document_types/version.rb

@@ -1,3 +1,3 @@
 module GovukDocumentTypes
-  VERSION = "1.0.1".freeze
+  VERSION = "3.0.0".freeze
 end

data/lib/govuk_document_types.rb

@@ -3,15 +3,15 @@ require "govuk_document_types/version"
 require "yaml"
 
 module GovukDocumentTypes
-  SUPERTYPES = YAML.load_file(File.dirname(__FILE__) + "/../data/supertypes.yml")
-  SUPERGROUPS = YAML.load_file(File.dirname(__FILE__) + "/../data/supergroups.yml")
+  SUPERTYPES = YAML.load_file("#{File.dirname(__FILE__)}/../data/supertypes.yml")
+  SUPERGROUPS = YAML.load_file("#{File.dirname(__FILE__)}/../data/supergroups.yml")
 
   def self.supertypes(document_type:)
     types = {}
 
     SUPERTYPES.each do |name, definition|
       group_data = definition["items"].find do |supertype|
-        supertype['document_types'].include?(document_type)
+        supertype["document_types"].include?(document_type)
       end
 
       type = (group_data && group_data["id"]) || definition["default"]
@@ -28,9 +28,9 @@ module GovukDocumentTypes
 
   def self.supergroup_subgroups(*supergroup_ids)
     SUPERGROUPS
-      .dig('content_purpose_supergroup', 'items')
-      .select { |supergroup| supergroup_ids.include?(supergroup['id']) }
-      .map { |supergroup| supergroup['subgroups'] }
+      .dig("content_purpose_supergroup", "items")
+      .select { |supergroup| supergroup_ids.include?(supergroup["id"]) }
+      .map { |supergroup| supergroup["subgroups"] }
       .flatten
       .uniq
       .sort
@@ -42,9 +42,9 @@ module GovukDocumentTypes
 
   def self.subgroup_document_types(*subgroup_ids)
     SUPERTYPES
-      .dig('content_purpose_subgroup', 'items')
-      .select { |subgroup| subgroup_ids.include?(subgroup['id']) }
-      .map { |subgroup| subgroup['document_types'] }
+      .dig("content_purpose_subgroup", "items")
+      .select { |subgroup| subgroup_ids.include?(subgroup["id"]) }
+      .map { |subgroup| subgroup["document_types"] }
       .flatten
       .uniq
       .sort

data/rails/locale/en.yml

@@ -10,6 +10,7 @@ en:
   content_purpose_subgroup:
     announcements: Announcements
     business_support: Business funds and grants
+    calls_for_evidence: Calls for evidence
     consultations: Consultations
     decisions: Decisions
     freedom_of_information_releases: Freedom of information releases

metadata

@@ -1,45 +1,59 @@
 --- !ruby/object:Gem::Specification
 name: govuk_document_types
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 3.0.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-27 00:00:00.000000000 Z
+date: 2024-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: govuk_schemas
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 4.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 4.5.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: i18n-spec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: govuk-lint
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -53,19 +67,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: i18n-spec
+  name: rubocop-govuk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.17.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.17.1
 description: Gem to share document type groupings
 email:
 - govuk-dev@digital.cabinet-office.gov.uk
@@ -73,13 +87,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".ruby-version"
 - CHANGELOG.md
 - Gemfile
-- Jenkinsfile
-- LICENSE.txt
+- LICENCE
 - README.md
 - Rakefile
 - bin/console
@@ -104,14 +120,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.5.11
 signing_key: 
 specification_version: 4
 summary: Gem to share document type groupings

data/Jenkinsfile

@@ -1,7 +0,0 @@
-#!/usr/bin/env groovy
-
-library("govuk")
-
-node {
-  govuk.buildProject()
-}