govuk_document_types 0.8.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb2f822160da7b706b543bc0b58a2470ec172693b9f3f0a89fd5137c0db5367d
-  data.tar.gz: c947a14e448b6a4fa8aef7415c2a91ae8c87e5895e85a02b382d41bdd921f2b5
+  metadata.gz: f152778caca037e3809f912c605c4584dee81a1b0e12e8673f8bc83ba5765aef
+  data.tar.gz: 1099c56c1e8b2f1dfcfe92100d78a76fec263e193e16a8f93daba8e28060a0e9
 SHA512:
-  metadata.gz: dd60e6eb75bf94f6eaa380de68917ede7b057beb4f93e8df41cc360d3f136a070b442f7746a509d4407da0ea29e5b5674882f6f8ea38c9829711be02ed6b8b9f
-  data.tar.gz: 6b7e39e60cd3648499f31d846d31ea8d33d1749599082d0277f5c9099f8b61cf0c473dc5aa72cf642072dbf8c2960b3dd503129d163b66a483e18b5512ea7a8d
+  metadata.gz: 6b68846617a60aee53b4d3742382b749a757e53db4aa581e3b860d41ec42f78493440012479806a35ed39799f70d8f79f1b2d87fb5dbe91561c299d9f69568bc
+  data.tar.gz: 9152ba233f0554176f18511b33bf59a10d1e818a53eb8c69077eb44d75158e4c895df1fb3eef1969dfe2bb78174f975964744725a1638b0da7ff48e884e2ae1f

data/.ruby-version

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

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+# 1.0.0
+
+* Remove deprecated supertypes
+* Add Flood & Coastal Erosion Risk Management Report (FCERM) Research Report to research supergroup
+
+# 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

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

@@ -1,215 +1,3 @@
-navigation_document_supertype:
-  name: "Navigation document type"
-  description: "Used to filter pages on the new taxonomy-based navigation pages"
-  default: other
-  items:
-    - id: guidance
-      document_types:
-        - answer
-        - contact
-        - detailed_guide
-        - document_collection
-        - form
-        - guidance
-        - guide
-        - licence
-        - local_transaction
-        - manual
-        - map
-        - place
-        - promotional
-        - regulation
-        - simple_smart_answer
-        - smart_answer
-        - statutory_guidance
-        - transaction
-        - travel_advice
-
-content_purpose_document_supertype:
-  name: "Content purpose"
-  description: "DEPRECATED - Please use `content_purpose_subgroup`. The team grouped document types that serve a similar purpose for users into top-level content groups. In time, this information could be used to serve relevant links into a content page sidebar and pull feeds of specific content groups into navigation pages."
-  default: other
-  items:
-    - id: updates-and-alerts
-      description: To provide time-based information on a new thing (alert) or something that's already happened (update)
-      document_types:
-        - drug_safety_update
-        - fatality_notice
-        - medical_safety_alert
-        - national_statistics_announcement
-        - official_statistics_announcement
-        - staff_update
-        - statistics_announcement
-
-    - id: news
-      description: To communicate what government is doing (non-urgent)
-      document_types:
-        - case_study
-        - correspondence # Also used for other things
-        - news_article
-        - news_story
-        - press_release
-        - world_location_news_article
-        - world_news_story
-
-    - id: resources
-      document_types:
-        - map
-        - promotional
-
-    - id: speeches-and-statements
-      document_types:
-        - authored_article
-        - oral_statement
-        - speech
-        - written_statement
-
-    - id: guidance
-      description: To provide information that prepares the user for doing a thing (without the need to share any personal information).
-      document_types:
-        - answer
-        - calendar
-        - detailed_guide
-        - guidance
-        - guide
-        - hmrc_manual
-        - hmrc_manual_section
-        - html_publication
-        - manual
-        - manual_section
-        - policy_paper
-        - regulation
-        - statutory_guidance
-        - travel_advice
-
-    - id: contacts
-      document_types:
-        - contact
-
-    - id: transactions
-      description: To provide specific information and tools that enables the user to do a thing, based on information they provide during the transaction.
-      document_types:
-        - calculator
-        - completed_transaction
-        - form
-        - licence
-        - local_transaction
-        - place
-        - simple_smart_answer
-        - smart_answer
-        - transaction
-
-    - id: reports
-      description: To share in detail the outcome of investigations, research and changes in regulation (government and independent bodies).
-      document_types:
-        - aaib_report
-        - consultation_outcome
-        - impact_assessment
-        - independent_report
-        - maib_report
-        - raib_report
-        - research
-        - service_standard_report
-
-    - id: decisions
-      description: To share decisions and/or reports made by government on a specific thing.
-      document_types:
-        - asylum_support_decision
-        - decision
-        - dfid_research_output
-        - employment_appeal_tribunal_decision
-        - employment_tribunal_decision
-        - government_response
-        - international_treaty
-        - tax_tribunal_decision
-        - utaac_decision
-
-    - id: engagement-activities
-      description: To enable bodies and people to comment on government policy and provide evidence.
-      document_types:
-        - closed_consultation
-        - cma_case
-        - consultation
-        - notice
-        - open_consultation
-
-    - id: data
-      description: To provide data that enables people to hold government to account (both raw data and data with analysis).
-      document_types:
-        - foi_release
-        - national_statistics
-        - official_statistics
-        - statistical_data_set
-        - statistics
-        - transparency
-
-    - id: organising-entities
-      description: Things that exist in the real world
-      document_types:
-        - working_group
-        - organisation
-        - person
-        - worldwide_organisation
-        - world_location
-        - topical_event
-        - field_of_operation
-        - ministerial_role
-
-    - id: navigation
-      description: Pages that enable users to get to content pages
-      document_types:
-        # "Tags"
-        - document_collection
-        - mainstream_browse_page
-        - policy
-        - policy_area
-        - taxon
-        - topic
-
-        # Hardcoded pages to let users navigate
-        - finder
-        - homepage
-        - search
-        - travel_advice_index
-
-    - id: grants-and-funding
-      document_types:
-        - countryside_stewardship_grant
-        - esi_fund
-        - international_development_fund
-        - business_finance_support_scheme
-
-    - id: corporate-info
-      document_types:
-        - about
-        - about_our_services
-        - access_and_opening
-        - complaints_procedure
-        - corporate_report
-        - equality_and_diversity
-        - help_page
-        - media_enquiries
-        - membership
-        - our_energy_use
-        - our_governance
-        - personal_information_charter
-        - petitions_and_campaigns
-        - procurement
-        - publication_scheme
-        - recruitment
-        - services_and_information
-        - social_media_use
-        - terms_of_reference
-        - welsh_language_scheme
-
-    - id: service-manual
-      document_types:
-        - service_manual_homepage
-        - service_manual_service_toolkit
-        - service_manual_service_standard
-        - service_manual_guide
-        - service_manual_topic
-
 user_journey_document_supertype:
   name: "User journey"
   description: "Used to distinguish pages used mainly for navigation (finding) from content pages (thing)"
@@ -224,8 +12,6 @@ user_journey_document_supertype:
         - license_finder
         - mainstream_browse_page
         - organisation
-        - policy
-        - policy_area
         - search
         - service_manual_homepage
         - service_manual_topic
@@ -234,23 +20,6 @@ user_journey_document_supertype:
         - topic
         - topical_event
 
-search_user_need_document_supertype:
-  name: "Search user need"
-  description: "Used to group documents based on user need, core for mainstream users and government for specialist users in search results"
-  default: government
-  items:
-    - id: core
-      document_types:
-        - answer
-        - guide
-        - local_transaction
-        - place
-        - simple_smart_answer
-        - smart_answer
-        - transaction
-        - travel_advice
-        - travel_advice_index
-
 email_document_supertype:
   name: "Email document type"
   description: "High level group for email subscriptions use to identify publications and announcement"
@@ -392,6 +161,7 @@ content_purpose_subgroup:
         - drug_safety_update
     - id: news
       document_types:
+        - case_study
         - news_article
         - news_story
         - press_release
@@ -441,7 +211,6 @@ content_purpose_subgroup:
         - manual_section
         - guidance
         - map
-        - contact
         - calendar
         - statutory_guidance
         - notice
@@ -449,6 +218,7 @@ content_purpose_subgroup:
         - travel_advice
         - promotional
         - hmrc_manual
+        - standard
     - id: business_support
       document_types:
         - international_development_fund
@@ -458,7 +228,6 @@ content_purpose_subgroup:
     - id: policy
       document_types:
         - impact_assessment
-        - case_study
         - policy_paper
     - id: consultations
       document_types:
@@ -468,6 +237,7 @@ content_purpose_subgroup:
     - id: research
       document_types:
         - dfid_research_output
+        - flood_and_coastal_erosion_risk_management_research_report
         - independent_report
         - research
     - id: statistics
@@ -521,6 +291,7 @@ content_purpose_supergroup:
         - correspondence
         - speech
         - government_response
+        - case_study
     - id: services
       document_types:
         - completed_transaction
@@ -543,7 +314,6 @@ content_purpose_supergroup:
         - manual_section
         - guidance
         - map
-        - contact
         - calendar
         - statutory_guidance
         - notice
@@ -556,10 +326,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
@@ -567,6 +337,7 @@ content_purpose_supergroup:
     - id: research_and_statistics
       document_types:
         - dfid_research_output
+        - flood_and_coastal_erosion_risk_management_research_report
         - independent_report
         - research
         - statistics
@@ -584,7 +355,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,3 +1,4 @@
+require "govuk_document_types/translations_railtie" if defined?(Rails)
 require "govuk_document_types/version"
 require "yaml"
 

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.8.0".freeze
+  VERSION = "1.0.0".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.8.0
+  version: 1.0.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-21 00:00:00.000000000 Z
+date: 2021-04-12 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