json_validator 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53df7dd58f70876c93e8d4289db52ed1639a0a50
-  data.tar.gz: 61f4c218b92cf98902b4298248955f94f2588131
+  metadata.gz: 58260c1220dfc3554bbb0cdc9bae74eef8be77b3
+  data.tar.gz: 980b78f82e9c9b8364aeae6c9c4d0f433e83bda3
 SHA512:
-  metadata.gz: eb4f3e30be96038c7be8501593b1b463bbe7dc89200a8df5885ece06ca136e0b05945caf571d4d9386c1f44b73215eabf0f7252369166c5e6b43ca47ef08ff98
-  data.tar.gz: 5f5b5674b0cfbf1191f087ca7dd91059d5eea73565c2ec8c44b827c3f6dfbf985c1be6605e0fbd77350daa7e1b93c666e26c8800dfe23987a90fa8c22799a11d
+  metadata.gz: c349848ed5105462d6079f49f6b949fd80f876ff4224ea701ebfc2e4b5cf88cf6d9b400dd9aaf77dfd3add75bb916f147304a47905250f0da93d87cfef36277f
+  data.tar.gz: ab6563f6110fb58a38d0ad8f9538fc12879d700b659dd5f8ddcbad44ff48e5acf082994516160730e38a98ab45587c9e3079d515b7aad4130b913550fb7d837b

data/README.md

@@ -1,8 +1,10 @@
 # JsonValidator
 
+[![Gem Version](http://img.shields.io/gem/v/json_validator.svg)](https://rubygems.org/gems/json_validator)
 [![Build Status](http://img.shields.io/travis/iainbeeston/json_validator/master.svg)](https://travis-ci.org/iainbeeston/json_validator)
 [![Code Climate](http://img.shields.io/codeclimate/github/iainbeeston/json_validator.svg)](https://codeclimate.com/github/iainbeeston/json_validator)
 
+
 JsonValidator is an ActiveModel validator that validates any hash field against [JSONSchema](http://json-schema.org), returning errors in the model's own `errors` attribute.
 
 This gem was originally written to provide deep validation of JSON attributes, which are available alongside primative types in recent versions of [PostgreSQL](http://www.postgresql.org), but it works equally well with ActiveModel objects.
@@ -13,22 +15,38 @@ Most of the functionality is dependent on the wonderful [json-schema](https://gi
 
 If you're using Ruby on Rails and ActiveRecord, add a validation to your model like this:
 
-    class Foo < ActiveRecord::Base
-      validates :bar, json: {
-        schema: {
-          '$schema' => 'http://json-schema.org/schema#',
-          'title': 'Universal spoons schema',
-          'properties': {
-		    'handleSize': {
-			  'type': 'integer',
-			  'minimum': 0
-			}
-	      },
-          'required': ['handleSize']
-        }
-      }
-    end
-
-Then whenever an instance of `Foo` is saved, `Foo.bar` (assumed to be a hash) will be validated against the JSON schema specified. In this case, `Foo.new(bar: { handleSize: -10 })` would be invalid, but `Foo.new(bar: { handleSize: 10 })` would be valid.
+~~~ruby
+class Foo < ActiveRecord::Base
+  validates :bar, json: {
+    schema: JSON.parse(File.read('foo_schema.json'))
+  }
+end
+~~~
+
+And you have a schema file (ie. `foo_schema.json`) like this:
+
+~~~json
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "Universal spoons schema",
+    "properties": {
+      "handleSize": {
+      "type": "integer",
+      "minimum": 0
+    }
+  },
+  "required": ["handleSize"]
+}
+~~~
+
+Then whenever an instance of `Foo` is saved, `Foo.bar` (assumed to be a hash) will be validated against the JSON schema specified. So, for example:
+
+~~~ruby
+
+f = Foo.new(bar: { handleSize: -10 })
+f.valid? # false
+f.errors.full_messages # ["Bar is invalid (the property '#/handleSize' did not have a minimum value of 0, inclusively)"]
+
+~~~
 
 The attribute being validated can be either a hash or a string (which will be parsed as JSON). The schema can be either a hash or a Proc that returns a hash (if you'd like to decide on the schema at runtime), and there's no reason why you could not load your schema from a .json file.

data/json_validator.gemspec

@@ -14,9 +14,11 @@ Gem::Specification.new do |spec|
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.test_files    = spec.files.grep(%r{^spec/})
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = ">= 1.9.3"
+
   spec.add_dependency "activesupport", ">= 3.2"
   spec.add_dependency "activemodel", ">= 3.2"
   spec.add_dependency "json-schema"

data/lib/json_validator.rb

@@ -37,6 +37,10 @@ class JsonValidator < ActiveModel::EachValidator
   def translate_message(msg)
     # remove suffix
     msg.gsub!(/ in schema .*$/, '')
+    # lowercase first letter (eg. 'The' becomes 'the')
+    msg.gsub!(/^./) { |m| m.downcase }
+    # prefix with 'is invalid'
+    msg.gsub!(/^(.*)$/, 'is invalid (\1)')
   end
 
   def check_validity!

data/lib/json_validator_meta.rb

@@ -1,4 +1,4 @@
 # can't put this in a JsonValidator module because ActiveModel expects JsonValidator to be a class
 module JsonValidatorMeta
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/spec/lib/json_validator_spec.rb

@@ -52,7 +52,7 @@ describe JsonValidator do
           {}
         ).to(
           {
-            json_data: ["The property '#/' did not contain a required property of 'soup'"]
+            json_data: ["is invalid (the property '#/' did not contain a required property of 'soup')"]
           }
         )
       end
@@ -90,7 +90,7 @@ describe JsonValidator do
           {}
         ).to(
           {
-            json_data: ["The property '#/menu' was not of a minimum string length of 200"]
+            json_data: ["is invalid (the property '#/menu' was not of a minimum string length of 200)"]
           }
         )
       end
@@ -150,7 +150,7 @@ describe JsonValidator do
 
     it 'translates json-schema messages to slightly more readable ones' do
       msg = "The property '#/menu' was not of a minimum string length of 200 in schema 40148e2f-45d6-51b7-972a-179bd9de61d6#"
-      expect(subject.translate_message(msg)).to eq("The property '#/menu' was not of a minimum string length of 200")
+      expect(subject.translate_message(msg)).to eq("is invalid (the property '#/menu' was not of a minimum string length of 200)")
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_validator
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Iain Beeston
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-14 00:00:00.000000000 Z
+date: 2014-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -143,7 +143,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="