shoulda_render_json 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fe7eea331763e3fd06b7087a3559d028d878ecb8
+  data.tar.gz: 6c40596a0536786361d6851fbfcef87af00d1999
+SHA512:
+  metadata.gz: 3e12b950d64609a53a34684d6dce5023d41a3746ed77edb339ed2ba051e0723ad3069556177ed0c6b5fa07c1081db6aec761ff08205b0ce9cc0c637101ac7c29
+  data.tar.gz: 2f34610282d32c4883730e769af5785bc99acb58f006e7aaaf4c63566709bf41360f04cb42d1f2c61d36408b1258702d72281279be7292da2c697a40e55253c4

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.DS_Store

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in shoulda_render_json.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 RSL
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,69 @@
+# Shoulda RenderJson
+
+Shoulda macros for making very basic assertions about JSON responses
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'shoulda_render_json', group: :test
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shoulda_render_json
+
+## Usage
+
+I'm going to presume you're already familiar with using Shoulda macros.
+The most basic assertion for `render_json` will be that your response's content-type is
+'application/json' (Rails' default JSON content-type) and that there is a root-level node
+named "foo" in the JSON. 
+
+```ruby
+should render_json('foo')
+```
+
+Voilà! That's probably not too useful on its own though. Let's add some child node checks!
+
+```ruby
+should render_json('foo', required: 'bar', forbidden: 'baz')
+```
+
+Predictably this adds two additional assertions to that base assertion. First, that the node for
+"foo" is required to have a child node named "bar". Second, that the node for "foo" is prohibited
+from having a child node named "baz". Both of these values can be arrays as well as strings as seen
+below.
+
+```ruby
+should render_json('foo', required: %w{bar baz})
+```
+
+Sometimes, you may need to make assertions on Arrays inside JSON responses and not just Hash/Objects.
+I've got you covered there too. 
+
+```ruby
+should render_json('foo', type: Array)
+```
+
+If you need to make assertions on the members of that Array, you can use the same `required` and 
+`forbidden` options but be aware these assertions will be expected to be true for *every* member
+of the Array. If you've got members that violate this, you'll probably be better off writing custom
+assertions anyhow.
+
+That's it!
+
+## TODO
+
+1. Test coverage. I've extracted this from one of my own test suites so there's no tests.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/shoulda_render_json/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/shoulda_render_json/version.rb

@@ -0,0 +1,3 @@
+module ShouldaRenderJson
+  VERSION = "0.0.2"
+end

data/lib/shoulda_render_json.rb

@@ -0,0 +1,8 @@
+require 'shoulda_render_json/version'
+require 'shoulda_render_json_object_matcher'
+require 'shoulda_render_json_array_matcher'
+require 'shoulda_render_json_test_integration'
+
+if defined?(ActionController)
+  ActionController::TestCase.__send__ :extend, ShouldaRenderJsonTestIntegration
+end

data/lib/shoulda_render_json_array_matcher.rb

@@ -0,0 +1,15 @@
+class ShouldaRenderJsonArrayMatcher < ShouldaRenderJsonObjectMatcher
+  def description
+    "render JSON array for #{@root}"
+  end
+
+private
+
+  def expected_root_class
+    Array
+  end
+
+  def present?(key)
+    json[root].all?{|node| node.has_key?(key)}
+  end
+end

data/lib/shoulda_render_json_object_matcher.rb

@@ -0,0 +1,95 @@
+class ShouldaRenderJsonObjectMatcher
+  attr_reader :options, :context, :root, :keys, :response, :failure_message, :negative_failure_message
+
+  def initialize(root, options = {})
+    @options = options
+    # Coercing types root: Symbol, keys: Array of Symbols
+    @root = root.to_s
+    @keys = {
+      required: massage_options(:required),
+      forbidden: massage_options(:forbidden),
+    }
+  end
+
+  def description
+    "render JSON Hash/Object for #{@root}"
+  end
+
+  def matches?(controller)
+    @response = controller.response
+    matches_content_type? &&
+      matches_root? &&
+      has_required_keys? &&
+      has_no_forbidden_keys?
+  end
+
+private
+
+  def matches_content_type?
+    content_type = response.content_type
+    set_failure_message "Expected content type to be 'application/json' but was '#{content_type}' instead"
+    set_negative_failure_message "Expected content type not to be '#{content_type}'"
+    content_type == 'application/json'
+  end
+
+  def root_matches_expected_type?
+    matches_root? ? root_is_expected_type? : false
+  end
+
+  def matches_root?
+    klass = json[root].class
+    set_failure_message "Expected root level node '#{root}' as Hash/Object but it was not found [class was #{klass}]"
+    set_negative_failure_message "Did not expect to contain root level node '#{root}' but it was present as #{klass}"
+    json.has_key?(root) && json[root].is_a?(expected_root_class)
+  end
+
+  def has_required_keys?
+    return true unless keys[:required]
+    set_failure_message "Expected child nodes for #{format_keys(missing_keys)} but there were none"
+    set_negative_failure_message "Expected no child nodes for #{format_keys(missing_keys)} but they were present"
+    missing_keys.empty?
+  end
+
+  def has_no_forbidden_keys?
+    return true unless keys[:forbidden]
+    set_failure_message "Expected no child nodes for #{format_keys(forbidden_keys)} but they were present"
+    # Negative failure here makes no sense since they are expected to not be present
+    forbidden_keys.empty?
+  end
+
+  def missing_keys
+    @missing_keys ||= keys[:required].reject{|key| present?(key)}
+  end
+
+  def forbidden_keys
+    @forbidden_keys ||= keys[:forbidden].select{|key| present?(key)}
+  end
+
+  def set_negative_failure_message(message)
+    @negative_failure_message = message
+  end
+
+  def set_failure_message(message)
+    @failure_message = message
+  end
+
+  def format_keys(keys)
+    keys.map{|key| "'#{key}'"}.join(', ')
+  end
+
+  def json
+    @json ||= JSON.parse(response.body)
+  end
+
+  def expected_root_class
+    Hash
+  end
+
+  def massage_options(key)
+    [options[key]].flatten.compact.map(&:to_s)
+  end
+
+  def present?(key)
+    json[root].has_key?(key)
+  end
+end

data/lib/shoulda_render_json_test_integration.rb

@@ -0,0 +1,10 @@
+module ShouldaRenderJsonTestIntegration
+  def render_json(key, options = {})
+    klass = if options[:type] == Array
+      ShouldaRenderJsonArrayMatcher
+    else
+      ShouldaRenderJsonObjectMatcher
+    end
+    klass.new key, options
+  end
+end

data/shoulda_render_json.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shoulda_render_json/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "shoulda_render_json"
+  spec.version       = ShouldaRenderJson::VERSION
+  spec.authors       = ["RSL"]
+  spec.email         = ["sconds@gmail.com"]
+  spec.summary       = %q{Shoulda macros for making very basic assertions about JSON responses}
+  spec.description   = %q{Shoulda macros for making very basic assertions about JSON responses}
+  spec.homepage      = "https://github.com/rsl/shoulda_render_json"
+  spec.license       = "MIT"
+
+  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.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: shoulda_render_json
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- RSL
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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'
+description: Shoulda macros for making very basic assertions about JSON responses
+email:
+- sconds@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/shoulda_render_json.rb
+- lib/shoulda_render_json/version.rb
+- lib/shoulda_render_json_array_matcher.rb
+- lib/shoulda_render_json_object_matcher.rb
+- lib/shoulda_render_json_test_integration.rb
+- shoulda_render_json.gemspec
+homepage: https://github.com/rsl/shoulda_render_json
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Shoulda macros for making very basic assertions about JSON responses
+test_files: []