rspec-xsd 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69134355a1c7aed6f984afb046fc4b857680460b
-  data.tar.gz: b52cc858ab9edefba1288e977517a465da2a638a
+  metadata.gz: e0fe3718567bcdac88f56e9cc9c59b92b4540ef5
+  data.tar.gz: a864ab660751c4ecc0f83562a4205578520f8f3d
 SHA512:
-  metadata.gz: 0c697f05bd3a34f5c4b07998760ea7da200d99104959794cd7cc0ee3c24309de860147184696d04e1b02def4b56809e75dfa150f21a4b5553fbd192c29555b06
-  data.tar.gz: c63bc6bbc3b4a88b7db15f47dc50b0d8366c7ece0e123f9aa5f5734a625485cd0d10ed7c08c183b1047ae26d9836a4ecc919e86344b3ff5adeada35d0cb42794
+  metadata.gz: a3df860d28e80108a1cb22a23e3082d536c77e7a9f85d1071aa44d872177d826e1913ff1b20c5575be520dab3f68904cda1070f5667db31a42bdc956cd00eb86
+  data.tar.gz: 895b73b12973deb9cd52df615f462254270b983ac9b3d08dc7a8eab644bb545a27219b52925c3c5d8b64fe5d3f5451c4455700e9b64888e19c9b2bb63e7bc29e

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
+cache: bundler
 rvm:
   - 2.1.3
   - jruby-19mode

data/README.md

@@ -1,43 +1,69 @@
-# Rspec::Xsd
+# RSpec::XSD
 
 [![Build Status](https://travis-ci.org/invisiblelines/rspec-xsd.svg)](https://travis-ci.org/invisiblelines/rspec-xsd)
 [![Code Climate](https://codeclimate.com/github/invisiblelines/rspec-xsd/badges/gpa.svg)](https://codeclimate.com/github/invisiblelines/rspec-xsd)
 
 ## Overview
 
-Rspec matcher for ensuring XML validates against a given XSD
+RSpec matcher for ensuring XML validates against a given XSD
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    group :test do
-      gem 'rspec-xsd'
-    end
+```ruby
+group :test do
+  gem 'rspec-xsd'
+end
+```
 
 And then execute:
 
-    $ bundle
+```
+$ bundle
+```
 
-Or install it yourself as:
+Or install it yourself with:
 
-    $ gem install rspec-xsd
+```
+$ gem install rspec-xsd
+```
 
 ## Usage
 
 Require the gem in your spec_helper
 
-    require 'rspec-xsd'
+```ruby
+require 'rspec/xsd'
+```
 
 Now include the matcher in your specs
 
-    RSpec.configure do |config|
-      config.include Rspec::Xsd
-    end
+```ruby
+RSpec.configure do |config|
+  config.include RSpec::XSD
+end
+```
 
-You can now check that XML validates against a given schema
+You can validate either an XML string or a Nokogiri::XML::Document.
 
-    expect(xml).to pass_validation(/path/to/schema.xsd)
+You can check that XML validates against a given schema by passing in a Nokogiri::XML::Schema object
+
+```ruby
+expect(xml).to pass_validation(xsd)
+```
+
+or by passing in the path to your XSD
+
+```ruby
+expect(xml).to pass_validation('/path/to/schema.xsd')
+```
+
+If you wish to give your XSD a more descriptive name you can pass this in as an optional argument
+
+```ruby
+expect(xml).to pass_validation('/path/to/schema.xsd', 'My Complex XSD')
+```
 
 You can pass either a string or file as the XML document
 

data/lib/rspec/xsd.rb

@@ -3,12 +3,12 @@ require "nokogiri"
 require "rspec/xsd/version"
 require 'rspec/xsd/matcher'
 
-module Rspec
+module RSpec
 
-  module Xsd
+  module XSD
 
-    def pass_validation(schema_path)
-      Matcher.new(schema_path)
+    def pass_validation(schema, schema_name = nil)
+      Matcher.new(schema, schema_name)
     end
 
   end

data/lib/rspec/xsd/matcher.rb

@@ -1,19 +1,34 @@
-module Rspec
+module RSpec
 
-  module Xsd
+  module XSD
 
     class Matcher
 
-      def initialize(schema_path)
-        @schema_path = schema_path
-        @schema      = File.basename(schema_path)
+      def initialize(schema, schema_name)
+        @schema_name = schema_name
+        case schema
+        when Nokogiri::XML::Schema
+          @xsd      = schema
+          @schema_name = "In Memory Schema" if @schema_name.nil?
+        else
+          @schema_path = schema
+          @schema_name = File.basename(@schema_path) if @schema_name.nil?
+        end
         @errors      = []
       end
 
       def matches?(xml)
-        File.open(@schema_path) do |f|
-          xsd     = Nokogiri::XML::Schema(f)
-          @errors = xsd.validate(Nokogiri::XML(xml))
+        if @xsd.nil?
+          File.open(@schema_path) do |f|
+            @xsd     = Nokogiri::XML::Schema(f)
+          end
+        end
+
+        case xml
+        when Nokogiri::XML::Document
+          @errors = @xsd.validate(xml)
+        else
+          @errors = @xsd.validate(Nokogiri::XML(xml))
         end
 
         @errors.map! { |e| e }
@@ -22,15 +37,15 @@ module Rspec
       end
 
       def failure_message
-        "expected that XML would validate against #{@schema}\r\n\r\n#{@errors.join("\r\n")}"
+        "expected that XML would validate against #{@schema_name}\r\n\r\n#{@errors.join("\r\n")}"
       end
 
       def failure_message_when_negated
-        "expected that XML would not validate against #{@schema}"
+        "expected that XML would not validate against #{@schema_name}"
       end
 
       def description
-        "validate against #{@schema}"
+        "validate against #{@schema_name}"
       end
 
     end

data/lib/rspec/xsd/version.rb

@@ -1,5 +1,5 @@
-module Rspec
-  module Xsd
-    VERSION = "0.0.1"
+module RSpec
+  module XSD
+    VERSION = "0.1.0"
   end
 end

data/rspec-xsd.gemspec

@@ -5,7 +5,7 @@ require 'rspec/xsd/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "rspec-xsd"
-  spec.version       = Rspec::Xsd::VERSION
+  spec.version       = RSpec::XSD::VERSION
   spec.authors       = ["Kieran Johnson"]
   spec.email         = ["hello@invisiblelines.com"]
   spec.summary       = %q{Rspec matcher for ensuring XML validates against a given XSD}

data/spec/lib/rspec/xsd/matcher_spec.rb

@@ -1,10 +1,10 @@
 require 'spec_helper'
 
-describe Rspec::Xsd::Matcher do
+describe RSpec::XSD::Matcher do
   let(:path)        { File.join(File.expand_path(File.dirname(__FILE__)), '..', '..', '..', 'fixtures') }
   let(:schema_path) { File.join(path, 'schema.xsd') }
 
-  let(:matcher) { Rspec::Xsd::Matcher.new(schema_path) }
+  let(:matcher) { RSpec::XSD::Matcher.new(schema_path, File.basename(schema_path)) }
 
   describe '#matches?' do
     let(:xml) { File.read(File.join(path, 'valid.xml')) }
@@ -15,6 +15,12 @@ describe Rspec::Xsd::Matcher do
       end
     end
 
+    context 'with XML object' do
+      it 'returns true' do
+        expect(matcher.matches?(Nokogiri::XML(xml))).to be(true)
+      end
+    end
+
     context 'with invalid XML' do
       let(:xml) { File.read(File.join(path, 'invalid.xml')) }
 
@@ -22,6 +28,13 @@ describe Rspec::Xsd::Matcher do
         expect(matcher.matches?(xml)).to be(false)
       end
     end
+
+    context 'with schema object' do
+      it 'returns true' do
+        schema = Nokogiri::XML::Schema(File.read(schema_path))
+        expect(RSpec::XSD::Matcher.new(schema, File.basename(schema_path)).matches?(xml)).to be(true)
+      end
+    end
   end
 
   describe '#description' do

data/spec/lib/rspec/xsd_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Rspec::Xsd do
+describe RSpec::XSD do
   let(:path)        { File.join(File.expand_path(File.dirname(__FILE__)), '..', '..', 'fixtures') }
   let(:schema_path) { File.join(path, 'schema.xsd') }
 

data/spec/spec_helper.rb

@@ -1,9 +1,12 @@
-require 'simplecov'
-require 'codeclimate-test-reporter'
+if ENV['CODECLIMATE_REPO_TOKEN']
+  require 'codeclimate-test-reporter'
 
-SimpleCov.start
+  CodeClimate::TestReporter.start
+else
+  require 'simplecov'
 
-CodeClimate::TestReporter.start
+  SimpleCov.start
+end
 
 require 'rspec'
 require 'rspec/xsd'
@@ -13,5 +16,5 @@ RSpec.configure do |config|
     c.syntax = :expect
   end
 
-  config.include Rspec::Xsd
+  config.include RSpec::XSD
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-xsd
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Kieran Johnson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-25 00:00:00.000000000 Z
+date: 2014-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -205,3 +205,4 @@ test_files:
 - spec/lib/rspec/xsd/matcher_spec.rb
 - spec/lib/rspec/xsd_spec.rb
 - spec/spec_helper.rb
+has_rdoc: