govuk_schemas 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b6cda522703d0896cf14a762388caa66fbca5c0
-  data.tar.gz: ca5ca470c2662ba182b283584c58ede459465720
+  metadata.gz: ac6896c57c2532adcb41b53a7299bc0199aee11e
+  data.tar.gz: 8aae891ff22402cff6c858b33490edaaaf326a7b
 SHA512:
-  metadata.gz: 761d1a395fcd5c9051f162d68398d9ff88861493cf0947eb50292d333561ca591d37261b7668c52403c7bce3cc8b4b346f659285350291753a41f1a5d01560a0
-  data.tar.gz: 8a11fcaed55550bec45183185789c09a0394db87d2ab9b6656b2b84c29b20c3044002487043ec20aca08af479d7012694a1a3aa89a5f3ad049fc924a2e9f4916
+  metadata.gz: fb53487240a352345f504c932aee0b4895ae5aa8fb71aa91709563983fa3a6c0a06767009f8798dc126952655d865e4cff39ab1a242cba294e05d0b19ed97ad1
+  data.tar.gz: dd87037cb8ea2887b1397ecf55ccdbe45654067b4d834c3a854c7cab36eb9cc54260d64b0e43a31d6abdc302e47bdcfcbe507952722aaac6fbfa8ec979b77fb9

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 2.1.0
+
+* Add `Schema.schema_names` to return all schema names
+* Add functionality to work with examples
+
 # 2.0.0
 
 * Change GovukSchemas::Schema.find to take { links_schema: 'detailded_guide' }

data/lib/govuk_schemas/example.rb

@@ -0,0 +1,25 @@
+module GovukSchemas
+  class Example
+    # Find all examples for a schema
+    #
+    # @param schema_name [String] like "detailed_guide", "policy" or "publication"
+    # @return [Array] array of example content items
+    def self.find_all(schema_name)
+      Dir.glob("#{GovukSchemas::CONTENT_SCHEMA_DIR}/formats/#{schema_name}/frontend/examples/*.json").map do |filename|
+        json = File.read(filename)
+        JSON.parse(json)
+      end
+    end
+
+    # Find an example by name
+    #
+    # @param schema_name [String] like "detailed_guide", "policy" or "publication"
+    # @param example_name [String] the name of the example JSON file
+    # @return [Hash] the example content item
+    def self.find(schema_name, example_name:)
+      path = "/formats/#{schema_name}/frontend/examples/#{example_name}.json"
+      json = File.read("#{GovukSchemas::CONTENT_SCHEMA_DIR}#{path}")
+      JSON.parse(json)
+    end
+  end
+end

data/lib/govuk_schemas/random_example.rb

@@ -65,15 +65,25 @@ module GovukSchemas
     # @param [Hash] hash The hash to merge the random content with
     # @return [Hash] A content item
     # @raise [GovukSchemas::InvalidContentGenerated]
-    def merge_and_validate(hash)
-      item = payload.merge(Utils.stringify_keys(hash))
-      errors = validation_errors_for(item)
+    def merge_and_validate(user_defined_values)
+      random_payload = @random_generator.payload
+      item_merged_with_user_input = random_payload.merge(Utils.stringify_keys(user_defined_values))
 
+      errors = validation_errors_for(item_merged_with_user_input)
       if errors.any?
-        raise InvalidContentGenerated, error_message_custom(item, hash, errors)
+
+        errors_on_random_payload = validation_errors_for(random_payload)
+        if errors_on_random_payload.any?
+          # The original item was invalid when it was generated, so it's not
+          # the users fault.
+          raise InvalidContentGenerated, error_message(random_payload, errors)
+        else
+          # The random item was valid, but it was merged with something invalid.
+          raise InvalidContentGenerated, error_message_custom(item_merged_with_user_input, user_defined_values, errors)
+        end
       end
 
-      item
+      item_merged_with_user_input
     end
 
   private

data/lib/govuk_schemas/schema.rb

@@ -35,6 +35,15 @@ module GovukSchemas
       all(schema_type: schema_type).values.sample
     end
 
+    # Return all schema names
+    #
+    # @return [Array] all the schema names
+    def self.schema_names
+      Dir.glob("#{GovukSchemas::CONTENT_SCHEMA_DIR}/dist/formats/*").map do |directory|
+        File.basename(directory)
+      end
+    end
+
     # @private
     def self.location_for_schema_name(schema)
       type, schema_name = schema.to_a.flatten

data/lib/govuk_schemas/version.rb

@@ -1,4 +1,4 @@
 module GovukSchemas
   # @private
-  VERSION = "2.0.0".freeze
+  VERSION = "2.1.0".freeze
 end

data/lib/govuk_schemas.rb

@@ -2,6 +2,7 @@ require "govuk_schemas/version"
 require "govuk_schemas/schema"
 require "govuk_schemas/utils"
 require "govuk_schemas/random_example"
+require "govuk_schemas/example"
 
 module GovukSchemas
   # @private

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_schemas
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-04 00:00:00.000000000 Z
+date: 2016-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json-schema
@@ -146,6 +146,7 @@ files:
 - jenkins-schema.sh
 - jenkins.sh
 - lib/govuk_schemas.rb
+- lib/govuk_schemas/example.rb
 - lib/govuk_schemas/random.rb
 - lib/govuk_schemas/random_example.rb
 - lib/govuk_schemas/random_item_generator.rb