rspec-kwalify 0.0.1 → 0.0.2

data/.gitignore

@@ -1,4 +1,6 @@
 *.gem
 .bundle
+.yardoc/*
 Gemfile.lock
+doc/*
 pkg/*

data/Gemfile

@@ -2,9 +2,12 @@ source :rubygems
 gemspec
 
 group :development do
+  gem "yard"
+  gem "rdiscount"
   gem "guard"
   gem "guard-bundler"
   gem "guard-rspec"
+  gem "guard-yard"
   gem "ruby_gntp"
   gem "ruby-debug19"
 end

data/Guardfile

@@ -9,3 +9,8 @@ guard :rspec, :version => 2, :cli => "--color --format nested --fail-fast" do
   watch(%r{^spec/.+_spec\.rb})
   watch(%r{^lib/(.+)\.rb})              { |m| "spec/#{m[1]}_spec.rb" }
 end
+
+guard :yard do
+  watch("README.md")
+  watch("lib")
+end

data/README.md

@@ -0,0 +1,44 @@
+# RSpec-Kwalify [ ![travis-ci](https://secure.travis-ci.org/pmenglund/rspec-kwalify.png?branch=master "travis-ci") ](http://travis-ci.org/pmenglund/rspec-kwalify "Travis-CI")
+
+[RSpec-Kwalify](https://github.com/pmenglund/rspec-kwalify) is a custom RSpec matcher to help you use [Kwalify](http://www.kuwata-lab.com/kwalify/ruby/users-guide.html), a [yaml](http://yaml.org/) validation [gem](http://rubygems.org/), in RSpec.
+
+Instead of having tests like this:
+<pre>
+it "should have 2 validation errors" do
+  errors = validator.validate(load_yaml("empty.yml"))
+  errors.size.should == 2
+  errors.each do |error|
+    error.is_a?(Kwalify::ValidationError).should be_true
+  end
+end
+</pre>
+
+You can use the more readable
+<pre>
+it "should have 2 errors" do
+  validator.validate(asset("empty.yml")).should have_validation_error(2)
+end
+</pre>
+
+All you need to do is to add this to your `Gemfile`
+<pre>
+group :development, :test do
+  gem "rspec-kwalify"
+end
+</pre>
+
+## Examples
+
+<pre>
+it "should have 2 errors" do
+  validator.validate(asset("empty.yml")).should have_error(2)
+end
+
+it "should have 'foo' key" do
+  validator.validate(asset("empty.yml")).should have_error(/key 'foo:' is required/)
+end
+
+it "should have validation error" do
+  validator.validate(asset("empty.yml")).should have_validation_error
+end
+</pre>

data/Rakefile

@@ -1,5 +1,6 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'yard'
 
 task :default => [:spec]
 
@@ -7,3 +8,7 @@ desc "run rspec tests"
 RSpec::Core::RakeTask.new do |task|
   task.rspec_opts = "--format documentation --color"
 end
+
+YARD::Rake::YardocTask.new do |task|
+  task.options = %w[--markup markdown]
+end

data/lib/rspec-kwalify.rb

@@ -4,6 +4,7 @@ require "rspec-kwalify/version"
 module RSpec
   module Kwalify
 
+    # @author Martin Englund
     class HaveError
       def initialize(error, base_error=::Kwalify::BaseError)
         @error = error
@@ -43,14 +44,32 @@ module RSpec
   end
 end
 
-# have_error error of type Kwalify::BaseError
-# have_error(Fixnum) number of errors
-# have_error(Regexp) error with a message matching
+# @overload have_error
+#   Matches if it has an error that `is_a?` [Kwalify::BaseError]
+#   @return [RSpec::Kwalify::HaveError]
+# @overload have_error(count)
+#   Matches if the number of errors is equal to `count`
+#   @param [Fixnum] count
+#   @return [RSpec::Kwalify::HaveError]
+# @overload have_error(regexp)
+#   Matches if the error message matches the regexp
+#   @param [Regexp] regexp
+#   @return [RSpec::Kwalify::HaveError]
 def have_error(error=nil)
   RSpec::Kwalify::HaveError.new(error)
 end
 
-# have_validation_error
+# @overload have_validation_error
+#   Matches if it has an error that `is_a?` [Kwalify::ValidationError]
+#   @return [RSpec::Kwalify::HaveError]
+# @overload have_validation_error(count)
+#   Matches if the number of errors is equal to `count`
+#   @param [Fixnum] count
+#   @return [RSpec::Kwalify::HaveError]
+# @overload have_validation_error(regexp)
+#   Matches if the error message matches the regexp
+#   @param [Regexp] regexp
+#   @return [RSpec::Kwalify::HaveError]
 def have_validation_error(error=nil)
   RSpec::Kwalify::HaveError.new(error, ::Kwalify::ValidationError)
 end

data/lib/rspec-kwalify/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module Kwalify
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/rspec-kwalify.gemspec

@@ -7,9 +7,9 @@ Gem::Specification.new do |s|
   s.version     = RSpec::Kwalify::VERSION
   s.authors     = ["Martin Englund"]
   s.email       = ["martin@englund.nu"]
-  s.homepage    = ""
+  s.homepage    = "https://github.com/pmenglund/rspec-kwalify"
   s.summary     = %q{rspec matchers for kwalify}
-  s.description = %q{rspec matchers for kwalify}
+  s.description = %q{rspec matchers for kwalify to help you validate yaml files}
 
   s.rubyforge_project = "rspec-kwalify"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-kwalify
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-17 00:00:00.000000000Z
+date: 2012-04-18 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70193016224180 !ruby/object:Gem::Requirement
+  requirement: &70171027223180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70193016224180
+  version_requirements: *70171027223180
 - !ruby/object:Gem::Dependency
   name: kwalify
-  requirement: &70193016223760 !ruby/object:Gem::Requirement
+  requirement: &70171027222400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,8 +32,8 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70193016223760
-description: rspec matchers for kwalify
+  version_requirements: *70171027222400
+description: rspec matchers for kwalify to help you validate yaml files
 email:
 - martin@englund.nu
 executables: []
@@ -44,7 +44,7 @@ files:
 - .travis.yml
 - Gemfile
 - Guardfile
-- README.textile
+- README.md
 - Rakefile
 - lib/rspec-kwalify.rb
 - lib/rspec-kwalify/version.rb
@@ -54,7 +54,7 @@ files:
 - spec/assets/syntax.yml
 - spec/rspec-kwalify_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/pmenglund/rspec-kwalify
 licenses: []
 post_install_message: 
 rdoc_options: []

data/README.textile

@@ -1,15 +0,0 @@
-h1. RSpec-Kwalify "!https://secure.travis-ci.org/pmenglund/rspec-kwalify.png?branch=master!":http://travis-ci.org/pmenglund/rspec-kwalify
-
-RSpec matchers to help you use Kwalify in RSpec
-
-h1. Examples
-
-<pre>
-  it "should have 2 errors" do
-    validator.validate(asset("empty.yml")).should have_error(2)
-  end
-
-  it "should have validation error" do
-    validator.validate(asset("empty.yml")).should have_validation_error
-  end
-</pre>