MAN-1325 replace ajv with json schema validate method

- Remove ajv from project - Incorporate JSON::Validator.validate into specs - Downgrade custom schemas to JSON schema Draft-06 because Ruby json-schema gem does not support Draft-07 or later.
tulibraries · Sep 26, 2023 · 18ba3d6 · 18ba3d6
1 parent 43c7efd
commit 18ba3d6
Show file tree

Hide file tree

Showing 19 changed files with 19 additions and 33 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -78,12 +78,6 @@ jobs:
             sudo psql -c "create role manifold with createdb login password 'password';" -U postgres -h localhost
             RAILS_ENV=test bundle exec rake db:setup
 
-      - run:
-          name: Install node packages required for tests
-          command: | 
-            sudo npm install -g [email protected]
-            sudo npm install -g [email protected]
-
       - run:
           name: Install ImageMagick
           command: |

diff --git a/README.md b/README.md
@@ -34,14 +34,6 @@ cd manifold
 bundle install
 ```
 
-* Install JSON validation tool
-
-```
-sudo apt-get -y install npm
-sudo npm install -g [email protected]
-sudo npm install -g [email protected]
-```
-
 * Create database tables
 
 ```

diff --git a/app/schemas/alert_schema.json b/app/schemas/alert_schema.json
@@ -1,6 +1,6 @@
 {
 	"definitions": {},
-	"$schema": "http://json-schema.org/draft-07/schema#",
+	"$schema": "http://json-schema.org/draft-06/schema#",
 	"$id": "http://example.com/root.json",
 	"type": "object",
 	"title": "The Root Schema",

diff --git a/app/schemas/blog_schema.json b/app/schemas/blog_schema.json
@@ -1,6 +1,6 @@
 {
 	"definitions": {},
-	"$schema": "http://json-schema.org/draft-07/schema#",
+	"$schema": "http://json-schema.org/draft-06/schema#",
 	"$id": "http://example.com/root.json",
 	"type": "object",
 	"title": "The Root Schema",

diff --git a/app/schemas/building_schema.json b/app/schemas/building_schema.json
@@ -1,6 +1,6 @@
 {
 	"definitions": {},
-	"$schema": "http://json-schema.org/draft-07/schema#",
+	"$schema": "http://json-schema.org/draft-06/schema#",
 	"$id": "http://example.com/root.json",
 	"type": "object",
 	"title": "The Root Schema",

diff --git a/app/schemas/category_schema.json b/app/schemas/category_schema.json
@@ -1,6 +1,6 @@
 {
 	"definitions": {},
-	"$schema": "http://json-schema.org/draft-07/schema#",
+	"$schema": "http://json-schema.org/draft-06/schema#",
 	"$id": "http://example.com/root.json",
 	"type": "object",
 	"title": "The Root Schema",

diff --git a/app/schemas/collection_schema.json b/app/schemas/collection_schema.json
@@ -1,6 +1,6 @@
 {
 	"definitions": {},
-	"$schema": "http://json-schema.org/draft-07/schema#",
+	"$schema": "http://json-schema.org/draft-06/schema#",
 	"$id": "http://example.com/root.json",
 	"type": "object",
 	"title": "The Root Schema",

diff --git a/app/schemas/event_schema.json b/app/schemas/event_schema.json
@@ -1,6 +1,6 @@
 {
   "definitions": {},
-  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$schema": "http://json-schema.org/draft-06/schema#",
   "$id": "http://example.com/root.json",
   "type": "object",
   "title": "The Root Schema",

diff --git a/app/schemas/exhibition_schema.json b/app/schemas/exhibition_schema.json
@@ -1,6 +1,6 @@
 {
 	"definitions": {},
-	"$schema": "http://json-schema.org/draft-07/schema#",
+	"$schema": "http://json-schema.org/draft-06/schema#",
 	"$id": "http://example.com/root.json",
 	"type": "object",
 	"title": "The Root Schema",

diff --git a/app/schemas/finding_aid_schema.json b/app/schemas/finding_aid_schema.json
@@ -1,6 +1,6 @@
 {
 	"definitions": {},
-	"$schema": "http://json-schema.org/draft-07/schema#",
+	"$schema": "http://json-schema.org/draft-06/schema#",
 	"$id": "http://example.com/root.json",
 	"type": "object",
 	"title": "The Root Schema",

diff --git a/app/schemas/group_schema.json b/app/schemas/group_schema.json
@@ -1,6 +1,6 @@
 {
 	"definitions": {},
-	"$schema": "http://json-schema.org/draft-07/schema#",
+	"$schema": "http://json-schema.org/draft-06/schema#",
 	"$id": "http://example.com/root.json",
 	"type": "object",
 	"title": "The Root Schema",

diff --git a/app/schemas/highlight_schema.json b/app/schemas/highlight_schema.json
@@ -1,6 +1,6 @@
 {
 	"definitions": {},
-	"$schema": "http://json-schema.org/draft-07/schema#",
+	"$schema": "http://json-schema.org/draft-06/schema#",
 	"$id": "http://example.com/root.json",
 	"type": "object",
 	"title": "The Root Schema",

diff --git a/app/schemas/person_schema.json b/app/schemas/person_schema.json
@@ -1,6 +1,6 @@
 {
   "definitions": {},
-  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$schema": "http://json-schema.org/draft-06/schema#",
   "$id": "http://example.com/root.json",
   "type": "object",
   "title": "The Root Schema",

diff --git a/app/schemas/policy_schema.json b/app/schemas/policy_schema.json
@@ -1,6 +1,6 @@
 {
 	"definitions": {},
-	"$schema": "http://json-schema.org/draft-07/schema#",
+	"$schema": "http://json-schema.org/draft-06/schema#",
 	"$id": "http://example.com/root.json",
 	"type": "object",
 	"title": "The Root Schema",

diff --git a/app/schemas/service_schema.json b/app/schemas/service_schema.json
@@ -1,6 +1,6 @@
 {
 	"definitions": {},
-	"$schema": "http://json-schema.org/draft-07/schema#",
+	"$schema": "http://json-schema.org/draft-06/schema#",
 	"$id": "http://example.com/root.json",
 	"type": "object",
 	"title": "The Root Schema",

diff --git a/app/schemas/space_schema.json b/app/schemas/space_schema.json
@@ -1,6 +1,6 @@
 {
 	"definitions": {},
-	"$schema": "http://json-schema.org/draft-07/schema#",
+	"$schema": "http://json-schema.org/draft-06/schema#",
 	"$id": "http://example.com/root.json",
 	"type": "object",
 	"title": "The Root Schema",

diff --git a/app/schemas/webpage_schema.json b/app/schemas/webpage_schema.json
@@ -1,6 +1,6 @@
 {
 	"definitions": {},
-	"$schema": "http://json-schema.org/draft-07/schema#",
+	"$schema": "http://json-schema.org/draft-06/schema#",
 	"$id": "http://example.com/root.json",
 	"type": "object",
 	"title": "The Root Schema",

diff --git a/spec/support/serializable_spec.rb b/spec/support/serializable_spec.rb
@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "spec_helper"
+require "json-schema"
 
 RSpec.shared_examples "serializable" do
   imageClasses = ["person", "event"]
@@ -19,9 +20,8 @@
     Tempfile.open(["serialized_#{factory_model.class.to_s.underscore.downcase}-", ".json"]) do |serialized|
       serialized.write(response.body)
       serialized.close
-      args = %W[validate -s app/schemas/#{factory_model.class.to_s.underscore.downcase}_schema.json -d #{serialized.path}]
 
-      expect(system("ajv", *args)).to be
+      expect(JSON::Validator.validate("app/schemas/#{factory_model.class.to_s.underscore.downcase}_schema.json", serialized.path)).to be
     end
   end
 

diff --git a/spec/support/serializer_spec.rb b/spec/support/serializer_spec.rb
@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "spec_helper"
+require "json-schema"
 
 RSpec.shared_examples "serializer" do
   let(:model) { described_class.to_s.split("Serializer").first.underscore.downcase.singularize.to_sym } # the class that includes the concern
@@ -11,8 +12,7 @@
     Tempfile.open(["serialized_#{model}", ".json"]) do |tempfile|
       tempfile.write(serialized.to_json)
       tempfile.close
-      args = %W[validate -s app/schemas/#{model}_schema.json -d #{tempfile.path}]
-      expect(system("ajv", *args)).to be
+      expect(JSON::Validator.validate!("app/schemas/#{model}_schema.json", tempfile.path)).to be
     end
   end