doctest-rspec 0.0.2 → 0.0.3

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NjA4ZmI2ODE4NTk3NWExOGZhYWFkOWRmZDQwMDY4OGNmMDFkYWRiNA==
-  data.tar.gz: !binary |-
-    ZGE1ODFkZTYwZjU3YzMwY2Y4MmEzYzU1ZWJhMDc5OTFkN2M0MDcxNg==
+SHA1:
+  metadata.gz: e0758bfc9f18e523d3e82493b50283bbc1b678f4
+  data.tar.gz: d418fe09ca4fab05a80f9d8c7b2a5dac447cde62
 SHA512:
-  metadata.gz: !binary |-
-    MWU1NjM0ODExYzdiMWNlYTc0YmYwMDQ1YzMyYzgwNmNiOTY5NzI2YWZlNmE5
-    N2E2NzU0Y2VmZGEyMjRlMWQ5NmUwNTAwOTVhYzc4YmU5Y2NkOWNmOTFmZGUx
-    OGMyYzRkYTAzNjgzMDZlNzMyMDMyZjJkNDkxNTBjMGY5ODU5MTc=
-  data.tar.gz: !binary |-
-    ZmMzZDU1MWFmOGEwNzJmY2E0MTcyNmRjZGQwNTg2ZmNmMTVjNGQ3ODllNTI3
-    NmMyMmZlN2Q5N2U5Y2E2MGNiNzY5NDhjZjJjYmE3M2U1NjJmNDY5MzhmMjI4
-    OTlkMjUwNzc2ZGRiMzM1NmZlNjEyMDg4ZGU0NzE3ZDY1NWViZDU=
+  metadata.gz: f4a60d3d1063416ccef6caf195748c1da846911af9502e364bbb440a2e67d15d8af6833b0d935fe8fc4b38f0864b4af468be460d55161f81857f9c85161ea20a
+  data.tar.gz: e434584fc89504a4bfc7cf5cebc745cb463390812e4831f07ad30ad4bd2e577488962aa10bef2b027628d6b15bbd24d1f5e5d32e884a1e509f29fec0e1974ae3

data/.travis.yml

@@ -1,5 +1,7 @@
 language: ruby
 rvm:
+  - 2.1.1
+  - 2.0.0
   - 1.9.3
   - rbx-19mode
 script: bundle exec rspec spec

data/README.md

@@ -1,9 +1,9 @@
-[![Code Climate](https://codeclimate.com/github/hzeus/doctest-rspec.png)](https://codeclimate.com/github/hzeus/doctest-rspec)
-[![Build Status](https://travis-ci.org/hzeus/doctest-rspec.png)](https://travis-ci.org/hzeus/doctest-rspec)
+[![Code Climate](https://codeclimate.com/github/doctest/doctest-rspec.png)](https://codeclimate.com/github/doctest/doctest-rspec)
+[![Build Status](https://travis-ci.org/doctest/doctest-rspec.png)](https://travis-ci.org/doctest/doctest-rspec)
 
 # Doctest::RSpec
 
-Add doctest to your rspec
+Add [doctests](http://github.com/doctest/doctest-core) to your ruby files and have them executed within a rspec test suite.
 
 ## Installation
 
@@ -21,23 +21,37 @@ Or install it yourself as:
 
 ## Usage
 
-Add doctest-formatted tests to your ruby files (see http://github.com/hzeus/doctest-extractor for syntax examples)
+Add doctest-formatted tests to your ruby files (see http://github.com/doctest/doctest-core for syntax examples)
 
-Configure RSpec:
+Add doctest directives to your rspec suite:
 
 ```ruby
-RSpec.configure do |c|
-  c.extend Doctest::RSpec::DoctestHelpers
+class MyClassWithDoctests
+  # Adds two to a given number
+  #
+  # Usage:
+  #   >> m = MyClassWithDoctests.new
+  #   >> m.plus_two(3)
+  #   => 5
+  def plus_two(x)
+    2 + x
+  end
 end
 ```
-
-Add doctest:
-
+Within the rspec suite:
 ```ruby
-describe 'whatever' do
+require 'doctest/rspec'
+
+describe MyClassWithDoctests do
   doctest MyClassWithDoctests
 end
 ```
+This will lead to one passing spec.
+
+This will parse the given source files for doctest occurrences and add a spec for each instance.
+
+## Alternative Solutions
+* [rubydoctest](https://github.com/tablatom/rubydoctest), [rdoctest](https://github.com/stephencelis/rdoctest): Serve a very similar purpose. However, they do not integrate into rspec, but provide a custom test runner.
 
 ## Contributing
 

data/doctest-rspec.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "rspec"
-  spec.add_dependency "doctest-core"
+  spec.add_dependency "doctest-core", "~> 0.0.2"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

data/lib/doctest/rspec.rb

@@ -9,3 +9,7 @@ module Doctest
   module RSpec
   end
 end
+
+RSpec.configure do |c|
+  c.extend Doctest::RSpec::DoctestHelpers
+end

data/lib/doctest/rspec/be_a_valid_doctest.rb

@@ -4,7 +4,7 @@
     actual.code_evaluation == actual.result_evaluation
   end
 
-  failure_message_for_should do |actual|
+  failure_message do |actual|
     "expected #{actual.code_evaluation} to equal #{actual.result_evaluation}"
   end
 

data/lib/doctest/rspec/doctest_helpers.rb

@@ -6,7 +6,7 @@ module Doctest::RSpec
       context "doctests for #{source}" do
         Doctest::Core.extract_from(source).each do |doctest|
           it "at #{doctest.original_file}:#{doctest.line}" do
-            doctest.should be_a_valid_doctest
+            expect(doctest).to be_a_valid_doctest
           end
         end
       end

data/lib/doctest/rspec/version.rb

@@ -1,5 +1,5 @@
 module Doctest
   module RSpec
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/spec/fixtures/specfile_with_doctests.rb

@@ -7,10 +7,6 @@ class ClassWithDoctests
   end
 end
 
-RSpec.configure do |c|
-  c.extend Doctest::RSpec::DoctestHelpers
-end
-
 describe 'doctest' do
   doctest ClassWithDoctests
 end

data/spec/lib/doctest/rspec/doctest_helpers_spec.rb

@@ -6,9 +6,9 @@ describe 'doctest helper methods' do
 
   it 'performs tests' do
     stdout_str, stderr_str, status = Open3.capture3('rspec spec/fixtures/specfile_with_doctests.rb')
-    stderr_str.should be_empty
-    stdout_str.lines.should include("1 example, 1 failure\n")
-    status.exitstatus.should == 1
+    expect(stderr_str).to be_empty
+    expect(stdout_str.lines).to include("1 example, 1 failure\n")
+    expect(status.exitstatus).to equal 1
   end
 
 end

metadata

@@ -1,97 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: doctest-rspec
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Heiko Zeus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-02 00:00:00.000000000 Z
+date: 2014-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   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: doctest-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !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: guard-rspec
   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: pry
   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: Use doctests in your rspec suite
@@ -101,8 +101,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -116,7 +116,6 @@ files:
 - spec/fixtures/specfile_with_doctests.rb
 - spec/lib/doctest/rspec/be_a_valid_doctest_spec.rb
 - spec/lib/doctest/rspec/doctest_helpers_spec.rb
-- spec/lib/doctest/rspec_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/hzeus/doctest-rspec
 licenses:
@@ -128,17 +127,17 @@ 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.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: This provide elixir-like doctests for your rspec suite
@@ -146,6 +145,4 @@ test_files:
 - spec/fixtures/specfile_with_doctests.rb
 - spec/lib/doctest/rspec/be_a_valid_doctest_spec.rb
 - spec/lib/doctest/rspec/doctest_helpers_spec.rb
-- spec/lib/doctest/rspec_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 

data/spec/lib/doctest/rspec_spec.rb

@@ -1 +0,0 @@
-require 'spec_helper'