govuk-content-schema-test-helpers 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 86714c339ce34aef53a446ed95e78eadf64244b1
-  data.tar.gz: 62f4df66147eb83d8eea6f65a8e72bdcae0a6ef7
+  metadata.gz: a67072ac7856ffad37516d5260a262d4df89f4f7
+  data.tar.gz: 154ca00506f3cdf9516904de41f7e2f7fab8bdf1
 SHA512:
-  metadata.gz: effa83b91f2b77d16df3a9d4eaebabf7eb3b41f1da5ec2d6a20d50e0e362cf6c15313ea7dc353178744265730f07ead1bc5eccdb2746065fed43d1ea34ef9708
-  data.tar.gz: 1c82c0f72755f5350afd4d38edc510fd92a481b49cb217eb284a37cd4d0001a8c985a9527220183b31db3ac6286d5a984ee673d0879f1c45a59f9f21ad73e165
+  metadata.gz: 7f5b0a0f56380d258d247d574c6a69333a6f88611df0682010cf5f044cd1ed86e3b596ac57db77c6977219446fdec2e3e744440413c08854f1f19318d2e5c82c
+  data.tar.gz: 1df29e2bbb33772e624b5ecede8a97c80766e17b41956b3384fc6fa8c1c011a2e7a925a619f4f5791f625d5bbeabf32ec3c8307abf82f38c898cb1df42e56627

data/README.md

@@ -41,6 +41,42 @@ If you are not using Rails, you'll need to set `project_root` differently. Assum
   # => '{ "some": "json" }'
 ```
 
+#### Loading all examples for a given format
+
+
+```ruby
+  GovukContentSchemaTestHelpers::Examples.new.get_all_for_format('case_study')
+  # => ['{ "first": "example"}', '{ "second": "example" }']
+```
+
+This would be useful for checking your app can handle all examples and any that come into existence later:
+
+```ruby
+  def supported_formats
+    %w{
+      case_study
+      coming_soon
+    }
+  end
+
+  def all_examples_for_supported_formats
+    GovukContentSchemaTestHelpers::Examples.new.get_all_for_formats(supported_formats)
+  end
+
+  # In an ActionDispatch::IntegrationTest, for example:
+  test 'that we can handle every example of the formats we support'
+    all_examples_for_supported_formats.each do |example|
+      content_item = JSON.parse(example)
+      content_store_has_item(content_item['base_path'], content_item)
+
+      get content_item['base_path']
+      assert_response 200
+      assert_select 'title', content_item['title']
+    end
+  end
+```
+
+
 #### RSpec matcher
 
 To use the built-in RSpec matcher, add this to spec_helper.rb:

data/lib/govuk-content-schema-test-helpers/examples.rb

@@ -4,22 +4,35 @@ module GovukContentSchemaTestHelpers
       Util.check_govuk_content_schemas_path!
     end
 
-    def get(schema_name, example_name)
-      path = example_path(schema_name, example_name)
+    def get(format, example_name)
+      path = example_path(format, example_name)
       check_example_file_exists!(path)
       File.read(path)
     end
 
+    def get_all_for_format(schema_name)
+      glob_path = example_path(schema_name, '*')
+      Dir.glob(glob_path).map do |path|
+        File.read(path)
+      end
+    end
+
+    def get_all_for_formats(schema_names)
+      schema_names.inject([]) do |memo, schema_name|
+        memo + get_all_for_format(schema_name)
+      end
+    end
+
     def check_example_file_exists!(path)
       if !File.exists?(path)
-        raise ImproperlyConfiguredError, "Schema file not found: #{path}."
+        raise ImproperlyConfiguredError, "Example file not found: #{path}."
       end
     end
 
   private
-    def example_path(schema_name, example_name)
+    def example_path(format, example_name)
       schema_type = GovukContentSchemaTestHelpers.configuration.schema_type
-      File.join(Util.govuk_content_schemas_path, "/formats/#{schema_name}/#{schema_type}/examples/#{example_name}.json").to_s
+      File.join(Util.govuk_content_schemas_path, "/formats/#{format}/#{schema_type}/examples/#{example_name}.json").to_s
     end
   end
 end

data/lib/govuk-content-schema-test-helpers/version.rb

@@ -1,3 +1,3 @@
 module GovukContentSchemaTestHelpers
-  VERSION = '1.0.2'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk-content-schema-test-helpers
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Jamie Cobbett