govuk_document_types 0.7.1 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d1ca4831e2fccf5819f5d1b0d9758448e22bede1794541d561921db1c7dfdcc
-  data.tar.gz: dfe564af149da8821063dcb542cd43c5cba6a1dc47a44ba523656bec7b50847f
+  metadata.gz: adad4f61a5d78fa9a467e79a12d0bafc4b54c1f0c5f6d7acbf0c458914936d6e
+  data.tar.gz: b1c6c9604283374fd65653ad1b241464a2e37aff574dbcfe99b159ebcbc9410e
 SHA512:
-  metadata.gz: d1a835c8ffedaf922411e509a1e7c357ccf97482d83a7b7aabf9bf49ff7d416598232f5af1a1d39abd55c63a521389d29d2af5683740898ee285857fa9c08df3
-  data.tar.gz: 3900036c325282d3a7fbf2065b5b108da92bcab612226f4547dfdcf4dfeede9056b56589d715b58acb4f530b7cf61f2f1db5e26f68ab5f6eff56c7f4716aa41d
+  metadata.gz: 761e2b47246c3e50a6b2b719f5932eb1845b2bf869f3670e5bc5b37ab75cec4edddc46cda0e1434d9c5bde20009662a195b31e34434acf98853ad85fb5756c57
+  data.tar.gz: d623119238d20bf59edc1d35dd97156c308b43638dd04538e90cf6c3244bb06b4f5735413a86a0187d5c6afd62b11b79c82eeaeb8441bb1cad0a4e0ca8ed3766

data/.ruby-version

@@ -1 +1 @@
-2.5.1
+2.6.6

data/CHANGELOG.md

@@ -1,3 +1,28 @@
+# 0.9.3
+
+* Added `standard` subtype to the guidance group
+
+# 0.9.2
+
+* Moved `case_study` from policy papers and consultations to news and comms.
+
+# 0.9.1
+
+* Removed `contact` from the guidance group.
+
+# 0.9.0
+
+* Add translations to content purpose supergroup titles
+
+# 0.8.0
+
+* Adds `GovukDocumentTypes.supergroup_subgroups` as a way to retrieve
+  subgroups registered to the specified supergroups.
+* Adds `GovukDocumentTypes.supergroup_document_types` as a way to retrieve
+  document types registered to the specified supergroups.
+* Adds `GovukDocumentTypes.subgroup_document_types` as a way to retrieve
+  document types registered to the specified subgroups.
+
 # 0.7.1
 
 * Add `hrmc_manual` format to `guidance` `content_purpose_subgroup`

data/README.md

@@ -5,26 +5,29 @@ of document types.
 
 https://docs.publishing.service.gov.uk/document-types.html
 
-This gem is only to be used in [publishing-api][publishing-api] and
-[rummager][rummager]. **Don't use it in your project**.
+## Usage
 
-## Long term vision
 
-This gem is used to share the canonical list of supertypes between rummager and publishing-api. We're currently migrating to a new system of indexing where rummager gets all data from the publishing-api (via a message queue). Once that work is completed this repo should be retired and the canonical list should be moved to either [govuk-content-schemas][] for use in the publishing-api, or be moved into publishing-api directly.
+Find the supertypes for a document type:
 
-## How to add a supertype
+```rb
+supertypes = GovukDocumentTypes.supertypes(document_type: "detailed_guide")
+supertypes["content_purpose_subgroup"]
+=> "guidance"
+```
 
-1. Add it to [data/supertypes.yml](data/supertypes.yml) in this gem and release a new version
-2. [Add the supertype][rummager-pr] in Rummager so that it can be indexed and searched with. Bump the gem in Rummager.
-3. [Add the type to content-schemas][schemas-pr]
-4. [Add the type to the content-store][content-store-pr]
-5. Bump the gem version in [publishing-api][publishing-api]
+Find the document types for a supertype:
 
-## How to update a supertype
+```rb
+GovukDocumentTypes.supergroup_document_types("policy_and_engagement")
+=> ["case_study", "closed_consultation", "consultation_outcome", "impact_assessment", "open_consultation", "policy_paper"]
+```
 
-1. Update [data/supertypes.yml](data/supertypes.yml) in this gem and release a new version.
-2. Bump the gem version in [rummager][rummager]. Rummager's nightly re-indexing will pick up your changes.
-3. Bump the gem version in [publishing-api][publishing-api]. All documents have to be sent to the content-store again for your changes to be picked up.
+## How to add or update a supertype
+
+1. Add it to [data/supertypes.yml](data/supertypes.yml) in this gem and release a new version
+2. Bump the gem version across GOV.UK apps using [Dependabot](https://app.dependabot.com/)
+3. Run the `rummager:update_supertypes` rake task in Search-api to set the correct supertypes in each document in the Elasticsearch indices. Do this _after_ bumping the gem version because this rake task uses information in the gem to find the correct supertype for the document_type defined in each document.
 
 ## Running the test suite
 
@@ -35,11 +38,3 @@ bundle exec rake
 ## License
 
 [MIT License](LICENSE.txt)
-
-[rummager-pr]: https://github.com/alphagov/rummager/pull/756
-[govuk-content-schemas]: https://github.com/alphagov/govuk-content-schemas
-[schemas-pr]: https://github.com/alphagov/govuk-content-schemas/pull/551
-[content-store-pr]: https://github.com/alphagov/content-store/pull/268
-
-[publishing-api]: https://github.com/alphagov/publishing-api
-[rummager]: https://github.com/alphagov/rummager

data/data/supertypes.yml

@@ -161,8 +161,6 @@ content_purpose_document_supertype:
         # "Tags"
         - document_collection
         - mainstream_browse_page
-        - policy
-        - policy_area
         - taxon
         - topic
 
@@ -224,8 +222,6 @@ user_journey_document_supertype:
         - license_finder
         - mainstream_browse_page
         - organisation
-        - policy
-        - policy_area
         - search
         - service_manual_homepage
         - service_manual_topic
@@ -392,6 +388,7 @@ content_purpose_subgroup:
         - drug_safety_update
     - id: news
       document_types:
+        - case_study
         - news_article
         - news_story
         - press_release
@@ -441,7 +438,6 @@ content_purpose_subgroup:
         - manual_section
         - guidance
         - map
-        - contact
         - calendar
         - statutory_guidance
         - notice
@@ -449,6 +445,7 @@ content_purpose_subgroup:
         - travel_advice
         - promotional
         - hmrc_manual
+        - standard
     - id: business_support
       document_types:
         - international_development_fund
@@ -458,7 +455,6 @@ content_purpose_subgroup:
     - id: policy
       document_types:
         - impact_assessment
-        - case_study
         - policy_paper
     - id: consultations
       document_types:
@@ -521,6 +517,7 @@ content_purpose_supergroup:
         - correspondence
         - speech
         - government_response
+        - case_study
     - id: services
       document_types:
         - completed_transaction
@@ -543,7 +540,6 @@ content_purpose_supergroup:
         - manual_section
         - guidance
         - map
-        - contact
         - calendar
         - statutory_guidance
         - notice
@@ -556,10 +552,10 @@ content_purpose_supergroup:
         - business_finance_support_scheme
         - statutory_instrument
         - hmrc_manual
+        - standard
     - id: policy_and_engagement
       document_types:
         - impact_assessment
-        - case_study
         - policy_paper
         - open_consultation
         - closed_consultation
@@ -584,7 +580,3 @@ content_purpose_supergroup:
         - aaib_report
         - raib_report
         - maib_report
-
-
-
-

data/govuk_document_types.gemspec

@@ -23,4 +23,5 @@ Gem::Specification.new do |spec|
   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 "i18n-spec"
 end

data/lib/govuk_document_types.rb

@@ -1,14 +1,15 @@
+require "govuk_document_types/translations_railtie" if defined?(Rails)
 require "govuk_document_types/version"
 require "yaml"
 
 module GovukDocumentTypes
-  DATA = YAML.load_file(File.dirname(__FILE__) + "/../data/supertypes.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 = {}
 
-    DATA.each do |name, definition|
+    SUPERTYPES.each do |name, definition|
       group_data = definition["items"].find do |supertype|
         supertype['document_types'].include?(document_type)
       end
@@ -24,4 +25,28 @@ module GovukDocumentTypes
     groups = SUPERGROUPS["content_purpose_supergroup"]["items"]
     groups.select { |g| ids.include?(g["id"]) }
   end
+
+  def self.supergroup_subgroups(*supergroup_ids)
+    SUPERGROUPS
+      .dig('content_purpose_supergroup', 'items')
+      .select { |supergroup| supergroup_ids.include?(supergroup['id']) }
+      .map { |supergroup| supergroup['subgroups'] }
+      .flatten
+      .uniq
+      .sort
+  end
+
+  def self.supergroup_document_types(*supergroup_ids)
+    subgroup_document_types(*supergroup_subgroups(*supergroup_ids))
+  end
+
+  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'] }
+      .flatten
+      .uniq
+      .sort
+  end
 end

data/lib/govuk_document_types/translations_railtie.rb

@@ -0,0 +1,21 @@
+require 'rails'
+module GovukDocumentTypes
+  class TranslationsRailtie < ::Rails::Railtie
+    initializer 'govuk_document_types' do |app|
+      GovukDocumentTypes::TranslationsRailtie.instance_eval do
+        pattern = pattern_from app.config.i18n.available_locales
+        add("rails/locale/#{pattern}.yml")
+      end
+    end
+
+    def self.add(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 ','}}"
+    end
+  end
+end

data/lib/govuk_document_types/version.rb

@@ -1,3 +1,3 @@
 module GovukDocumentTypes
-  VERSION = "0.7.1".freeze
+  VERSION = "0.9.3".freeze
 end

data/rails/locale/en.yml

@@ -0,0 +1,28 @@
+---
+en:
+  content_purpose_supergroup:
+    guidance_and_regulation: Guidance and regulation
+    news_and_communications: News and communications
+    policy_and_engagement: Policy papers and consultations
+    research_and_statistics: "Research and statistics"
+    services: Services
+    transparency: Transparency and freedom of information releases
+  content_purpose_subgroup:
+    announcements: Announcements
+    business_support: Business funds and grants
+    consultations: Consultations
+    decisions: Decisions
+    freedom_of_information_releases: Freedom of information releases
+    guidance: Guidance
+    incidents: Incident reports
+    news: News
+    policy: Policy papers
+    regulation: Regulation
+    research: Research
+    safety_alerts: Safety alerts
+    services: Services
+    speeches_and_statements: Speeches and statements
+    statistics: Statistics
+    transactions: Transactions
+    transparency_data: Transparency data
+    updates_and_alerts: Updates and alerts

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_document_types
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.9.3
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-30 00:00:00.000000000 Z
+date: 2021-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: i18n-spec
+  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: Gem to share document type groupings
 email:
 - govuk-dev@digital.cabinet-office.gov.uk
@@ -75,7 +89,9 @@ files:
 - data/supertypes.yml
 - govuk_document_types.gemspec
 - lib/govuk_document_types.rb
+- lib/govuk_document_types/translations_railtie.rb
 - lib/govuk_document_types/version.rb
+- rails/locale/en.yml
 homepage: https://github.com/alphagov/govuk_document_types
 licenses:
 - MIT
@@ -95,8 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Gem to share document type groupings