assert_json 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 84984fa4a3256eeeb0fd478682aaac73edf8ce6e
-  data.tar.gz: 735eb857f7c81ee55bfe0d24bc7283713768396c
+  metadata.gz: 9c2af8b07b97f74fe288a7a3aebe27d2686e62f3
+  data.tar.gz: 66167cec3df9aa3c630735e9c0c8cda0780d341b
 SHA512:
-  metadata.gz: 065d1b029be8512f5f6676e91b4596aa2e41f1ff220d8d35c9b2e45e11ed0ddfe3b61988c7afeebf8484ff3f12eabb9b579d895fdd75cda8063762810f178597
-  data.tar.gz: ee97759d3a65474fce2ce15f43cd3bf2b10025437136167c07d638a0a18b319e47095559825561089dc42a8e09a02f1ec0b1ff606d569593786414963d8bbf54
+  metadata.gz: c05feb7f9aeb5302113627b02123ba240438143e7f38b4ffa48b84db5ff2a083214b7d40fada36841819ec39c3cc16acf63bdb15b9a1fda11632ec280436a135
+  data.tar.gz: a88d567254d842c0778c789609cbc65a7b3f08e90bd64dcc357d44bbf9520e7491eb24f73d284578d122a4ad11204282713aee5f7b0811aa8454c219d90ca402

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 0.3.0
+
+ * add support for `has_only` (to test that objects have the declared set of properties and nothing more) (thanks to [@derek-watson](https://github.com/derek-watson), see [issue 8](https://github.com/alto/assert_json/pull/8))
+
 ## 0.2.3
 
  * bugfix for itemised nested arrays (see [issue 7](https://github.com/alto/assert_json/issues/7))

data/README.md

@@ -58,6 +58,26 @@ assert_json '[{"id":1, "key":"test", "name":"test"}, {"id":2, "key":"test", "nam
 end
 ```
 
+To test that objects have the declared set of properties and nothing more,
+include `has_only` at any level, like this
+
+```ruby
+assert_json '[{"id":1, "key":"test", "name":"test"}, {"id":2, "key":"test", "name":"test"}, {"id":3, "key":"test", "name":"test"}]' do
+  has_only
+  item 0 do
+    has :id, 1
+    has :key, 'test'
+    has :name, 'test'
+  end
+  item 1 do
+    has 'id', 2
+    has 'key', 'test'
+  end
+end
+
+# Failure: element 1 has unexpected keys: name
+```
+
 
 ## Changelog ##
 

data/lib/assert_json/assert_json.rb

@@ -5,6 +5,7 @@ module AssertJson
       @json = AssertJson::Json.new(json_string)
       # json.instance_exec(json, &block)
       yield @json
+      @json.test_for_unexpected_keys('root')
     end
   end
 
@@ -20,19 +21,31 @@ module AssertJson
     @json.has_not(*args, &block)
   end
 
+  def has_only
+    @json.has_only
+  end
+
   class Json
 
     def initialize(json_string)
       @decoded_json = ActiveSupport::JSON.decode(json_string)
+      @expected_keys = []
+      @only = false
     end
 
     def item(index, &block)
+      only_in_scope = @only
+      expected_keys_in_scope = @expected_keys
+      @expected_keys = []
       decoded_json_in_scope = @decoded_json
       @decoded_json = @decoded_json[index]
       begin
         yield if block_given?
+        test_for_unexpected_keys(index)
       ensure
         @decoded_json = decoded_json_in_scope
+        @expected_keys = expected_keys_in_scope
+        @only = only_in_scope
       end
     end
 
@@ -79,8 +92,13 @@ module AssertJson
         flunk
       end
 
+      @expected_keys.push arg
+
       if block_given?
         begin
+          only_in_scope = @only
+          expected_keys_in_scope = @expected_keys
+          @expected_keys = []
           decoded_json_in_scope = @decoded_json
           @decoded_json = case token
                           when Hash
@@ -89,11 +107,13 @@ module AssertJson
                             token
                           end
           yield
+          test_for_unexpected_keys(arg)
         ensure
+          @expected_keys = expected_keys_in_scope
+          @only = only_in_scope
           @decoded_json = decoded_json_in_scope
         end
       end
-
     end
     alias has element
 
@@ -109,6 +129,22 @@ module AssertJson
     end
     alias has_not not_element
 
+    def only
+      @only = true
+    end
+    alias has_only only
+
+    def test_for_unexpected_keys(name = 'root')
+      return unless @only
+
+      if @decoded_json.is_a?(Hash)
+        unexpected_keys = @decoded_json.keys - @expected_keys
+        if unexpected_keys.count > 0
+          raise_error("element #{name} has unexpected keys: #{unexpected_keys.join(', ')}")
+        end
+      end
+    end
+
     private
 
       def raise_error(message)

data/lib/assert_json/version.rb

@@ -1,3 +1,3 @@
 module AssertJson
-  VERSION = "0.2.3"
+  VERSION = "0.3.0"
 end

data/test/assert_json_has_only_test.rb

@@ -0,0 +1,94 @@
+require_relative './test_helper'
+
+class AssertJsonHasNoUnexpectedKeysTest < Minitest::Test
+  include AssertJson
+
+  def test_on_root_object
+    assert_json '{"keyA":"value","keyB":"value"}' do
+      has_only
+      has 'keyA'
+      has 'keyB'
+    end
+  end
+
+  def test_on_root_object_failure
+    err = assert_raises(MiniTest::Assertion) do
+      assert_json '{"keyA":"value","keyB":"value"}' do
+        has_only
+        has 'keyA', 'value'
+      end
+    end
+    assert_equal 'element root has unexpected keys: keyB', err.message
+  end
+
+  def test_on_root_object_with_sub_object
+    assert_json '{"keyA":{"subKeyA":"value","subKeyB":"value"},"keyB":"value"}' do
+      has_only
+      has 'keyA' do
+        has 'subKeyA'
+        has 'subKeyB'
+      end
+      has 'keyB'
+    end
+  end
+
+  def test_on_root_object_with_sub_object_failure
+    err = assert_raises(MiniTest::Assertion) do
+      assert_json '{"keyA":{"subKeyA":"value","subKeyB":"value"},"keyB":"value"}' do
+        has_only
+        has 'keyA' do
+          has 'subKeyA'
+          has 'subKeyB'
+        end
+      end
+    end
+    assert_equal 'element root has unexpected keys: keyB', err.message
+  end
+
+  def test_on_sub_object
+    assert_json '{"keyA":{"subKeyA":"value","subKeyB":"value"},"keyB":"value"}' do
+      has 'keyA' do
+        has_only
+        has 'subKeyA'
+        has 'subKeyB'
+      end
+    end
+  end
+
+  def test_on_sub_object_failure
+    err = assert_raises(MiniTest::Assertion) do
+      assert_json '{"keyA":{"subKeyA":"value","subKeyB":"value"},"keyB":"value"}' do
+        has 'keyA' do
+          has_only
+          has 'subKeyA'
+        end
+      end
+    end
+    assert_equal 'element keyA has unexpected keys: subKeyB', err.message
+  end
+
+  def test_on_root_array_of_objects
+    assert_json '[{"id":1, "key":"test", "name":"test"}, {"id":2, "key":"test", "name":"test"}, {"id":3, "key":"test", "name":"test"}]' do
+      has_only
+      item 0 do
+        has :id, 1
+        has :key, 'test'
+        has :name, 'test'
+      end
+    end
+  end
+
+  def test_on_root_array_of_objects_failure
+    err = assert_raises(MiniTest::Assertion) do
+      assert_json '[{"id":1, "key":"test", "name":"test"}, {"id":2, "key":"test", "name":"test"}, {"id":3, "key":"test", "name":"test"}]' do
+        has_only
+        item 0 do
+          has :id, 1
+          has :key, 'test'
+        end
+      end
+    end
+    assert_equal 'element 0 has unexpected keys: name', err.message
+  end
+
+end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: assert_json
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Thorsten Böttger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-14 00:00:00.000000000 Z
+date: 2015-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   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'
 - !ruby/object:Gem::Dependency
   name: minitest
   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: A gem to test JSON strings.
@@ -58,8 +58,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - MIT-LICENSE
@@ -69,6 +69,7 @@ files:
 - lib/assert_json.rb
 - lib/assert_json/assert_json.rb
 - lib/assert_json/version.rb
+- test/assert_json_has_only_test.rb
 - test/assert_json_new_dsl_test.rb
 - test/assert_json_test.rb
 - test/test_helper.rb
@@ -82,21 +83,22 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: A gem to test JSON strings.
 test_files:
+- test/assert_json_has_only_test.rb
 - test/assert_json_new_dsl_test.rb
 - test/assert_json_test.rb
 - test/test_helper.rb