doctest-rspec 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NzMxNzlmNjFkMmU5MTdjYzljMDIwM2UxM2NkODkxMGUzZTU5NTM4MQ==
+  data.tar.gz: !binary |-
+    NWM2YjYyNTE3ZWU0N2U5Y2Q4YjZjZmM1ODIyOWI4ZDQzNWFhOTZjMg==
+SHA512:
+  metadata.gz: !binary |-
+    YjNkNzkwNTA1MzQzMDA0ZWVjOTlmNjQ3YjgxNGQ4YWI1MjBlY2UxMDAyZWNh
+    N2Y0MTcxNzM5MGYzNzM1MzIzMzBhODczZDBiMzAzMTExNGM3NjVmZjRlZWZh
+    YjljMTI1NzNjOGYyYjg0MzVhMjFkOWE2NDA0ZmRmNTk3ZDBmNjE=
+  data.tar.gz: !binary |-
+    ZDExZWViZjE2NGI3MjBmNWNjMmQ0MjRmZDMyMDg4NjcwMTJmYzExNGZiYWQ3
+    OGEyYWIwNWM0Mjk3ZTc0ZThjZDFiNmNiNmQ1YTQwZGQ3NWIyYzc5ODU2MDMy
+    MTY5ZjA1ZGFkYTEyYjZhMDRhZjgzZWE2NGExZTNjYTczYmJkMDE=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in doctest-rspec.gemspec
+gemspec
+
+gem 'doctest-core', github: 'hzeus/doctest-core'

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Heiko Zeus
+
+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,48 @@
+[![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)
+
+# Doctest::RSpec
+
+Add doctest to your rspec
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'doctest-rspec'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install doctest-rspec
+
+## Usage
+
+Add doctest-formatted tests to your ruby files (see http://github.com/hzeus/doctest-extractor for syntax examples)
+
+Configure RSpec:
+
+```ruby
+RSpec.configure do |c|
+  c.extend Doctest::RSpec::DoctestHelpers
+end
+```
+
+Add doctest:
+
+```ruby
+describe 'whatever' do
+  doctest MyClassWithDoctests
+end
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/doctest-rspec.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'doctest/rspec/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "doctest-rspec"
+  spec.version       = Doctest::RSpec::VERSION
+  spec.authors       = ["Heiko Zeus"]
+  spec.email         = ["heiko.zeus@zweitag.de"]
+  spec.description   = %q{Use doctests in your rspec suite}
+  spec.summary       = %q{This provide elixir-like doctests for your rspec suite}
+  spec.homepage      = "https://github.com/hzeus/doctest-rspec"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency "rspec"
+  spec.add_dependency "doctest-core"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "pry"
+
+end

data/lib/doctest/rspec/be_a_valid_doctest.rb

@@ -0,0 +1,11 @@
+::RSpec::Matchers.define :be_a_valid_doctest do |expected|
+
+  match do |actual|
+    actual.code_evaluation == actual.result_evaluation
+  end
+
+  failure_message_for_should do |actual|
+    "expected #{actual.code_evaluation} to equal #{actual.result_evaluation}"
+  end
+
+end

data/lib/doctest/rspec/doctest_helpers.rb

@@ -0,0 +1,17 @@
+module Doctest::RSpec
+
+  module DoctestHelpers
+
+    def doctest(source)
+      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
+          end
+        end
+      end
+    end
+
+  end
+
+end

data/lib/doctest/rspec/version.rb

@@ -0,0 +1,5 @@
+module Doctest
+  module RSpec
+    VERSION = "0.0.1"
+  end
+end

data/lib/doctest/rspec.rb

@@ -0,0 +1,8 @@
+require "doctest/rspec/version"
+require "doctest/rspec/be_a_valid_doctest"
+require "doctest/rspec/doctest_helpers"
+
+module Doctest
+  module RSpec
+  end
+end

data/spec/fixtures/specfile_with_doctests.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+class ClassWithDoctests
+  # >> ClassWithDoctests.a
+  # => 'a'
+  def self.a
+  end
+end
+
+RSpec.configure do |c|
+  c.extend Doctest::RSpec::DoctestHelpers
+end
+
+describe 'doctest' do
+  doctest ClassWithDoctests
+end

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

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+module Doctest::RSpec
+
+  describe 'expect(doctest).to be_a_valid_doctest' do
+
+    let(:valid_doctest){ Doctest::Core::Doctest.new("5", "5", nil, nil) }
+    let(:invalid_doctest){ Doctest::Core::Doctest.new("4", "5", nil, nil) }
+
+    it 'passes if the doctest is valid' do
+      expect(valid_doctest).to be_a_valid_doctest
+    end
+
+    it 'fails if the doctest is invalid' do
+      expect {
+        expect(invalid_doctest).to be_a_valid_doctest
+      }.to raise_error("expected 4 to equal 5")
+    end
+
+  end
+
+end

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

@@ -0,0 +1,14 @@
+require 'spec_helper'
+require 'open3'
+require 'pry'
+
+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
+  end
+
+end

data/spec/lib/doctest/rspec_spec.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'bundler/setup'
+
+Bundler.require(:default)
+
+require 'doctest/rspec'
+
+def fixture(filename)
+  File.join(Gem::Specification.find_by_name('doctest-rspec').gem_dir, 'spec', 'fixtures', filename)
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: doctest-rspec
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Heiko Zeus
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-01 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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
+email:
+- heiko.zeus@zweitag.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- doctest-rspec.gemspec
+- lib/doctest/rspec.rb
+- lib/doctest/rspec/be_a_valid_doctest.rb
+- lib/doctest/rspec/doctest_helpers.rb
+- lib/doctest/rspec/version.rb
+- 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:
+- 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.1.5
+signing_key: 
+specification_version: 4
+summary: This provide elixir-like doctests for your rspec suite
+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: