doctest-core 0.0.1 → 0.0.2

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ODJmYWE0ZjE4Yjc4MTNkNDE4Y2UzOWI4YThhY2NlY2IwMTA3NDk1Yg==
-  data.tar.gz: !binary |-
-    NzUxYTc5YWQyNTZmOTAyZGE1MTk4MWJiZDVjNGRkNTAxZGExZTk0MQ==
+SHA1:
+  metadata.gz: 5d5df458235fdf44570f12f2f231464e157333f8
+  data.tar.gz: 41f9d7e562a06bc4a5c4c87c25e15e17bea76a57
 SHA512:
-  metadata.gz: !binary |-
-    MTE5MTAyMWQxMGZmNTE4NDY1ZmQ4YzNhM2U1MThlMzBjNmRmNzNjYThiMGQz
-    MGExZGE3ODQzZWQxMzE5Y2FkNjdiNDYxMjY0ZWRlYzljNTlkMzRkZGVlMTgz
-    YmVhMGQ2N2MyZWM0MmU3MDU1ZmEyYzM0MDZiMWIwYTQ2ZTdjOGE=
-  data.tar.gz: !binary |-
-    NDE0NGYyODM1ZWJjYzQ3YjBiYTU5OWFiODU5ZmM0MTlhYjVmMWQ0ZThkMjI1
-    ZmQzN2Y3Y2M2M2FkM2ZhZDNiNWU2MzAyZWRiNzA3MTIxYjk4N2YzM2ViMjhi
-    Y2MwMzIwNWE4NmQ2OThlZTlkNjgxOGY2YmFjOGE5MmI1YmIwMTE=
+  metadata.gz: efc87512029a259d72cdfdcde0737d904e3f4f52ec720c9a1cd811ee6f450dcad647234abc0d514cf885f3812fb939cb5b3e97e6611ffa028ae91aadf4c978fe
+  data.tar.gz: a2e42d00c021188399bad1a2223ae8694cbafc233d5e5fb587d347f95834a90364f141905d407800a4ffef101b7bae4db140ae630f0981c693925bee8488399e

data/.travis.yml

@@ -1,5 +1,7 @@
 language: ruby
 rvm:
+  - 2.1.1
+  - 2.0.0
   - 1.9.3
   - jruby-19mode
   - rbx-19mode

data/README.md

@@ -1,5 +1,5 @@
-[![Code Climate](https://codeclimate.com/github/hzeus/doctest-core.png)](https://codeclimate.com/github/hzeus/doctest-core)
-[![Build Status](https://travis-ci.org/hzeus/doctest-core.png)](https://travis-ci.org/hzeus/doctest-core)
+[![Code Climate](https://codeclimate.com/github/doctest/doctest-core.png)](https://codeclimate.com/github/doctest/doctest-core)
+[![Build Status](https://travis-ci.org/doctest/doctest-core.png)](https://travis-ci.org/doctest/doctest-core)
 
 # Doctest::Core
 
@@ -49,8 +49,24 @@ You can then run
 ```ruby
 Doctest::Core.extract_from(ClassWithDoctests)
 ```
+to get a collection of doctest instances.
 
-to get a simple array of doctest occurrences. Those contain
+### Syntax
+
+This searches for doctests within the source files of the given class. It checks for the following syntax:
+
+```ruby
+# >> ruby_expression
+```
+for a test command,
+```ruby
+# => ruby_expression
+````
+for a test result. A doctest consists of one or more consecutive test commands and one result line. There must be no empty lines between, but you can add any number of spaces before and after the ```#``` at the beginning of the comment line.
+
+### Doctest instances
+
+A doctest instance consists of
 * ```code_string```: The source code string (`'ClassWithDoctests.a'`)
 * ```result_string```: The result code string (`'b'`)
 * ```original_file```: The source location of the file that contains the doctest
@@ -58,7 +74,7 @@ to get a simple array of doctest occurrences. Those contain
 
 You can also access ```code_evaluation``` and ```result_evaluation``` for the results of the both code blocks.
 
-Those results can be used to implement test framework-specific gems.
+Those instances can be used to implement test framework-specific gems.
 
 ## Contributing
 

data/lib/doctest/core/base.rb

@@ -23,7 +23,7 @@ module Doctest
       end
 
       def analyze
-        @str.lines.with_index do |line, index|
+        @str.lines.each.with_index do |line, index|
           case line
           when CODE_REGEXP
             handle_code(Regexp.last_match['code'])
@@ -49,7 +49,7 @@ module Doctest
           @current_code = [code]
           @state = :match
         when :match
-          @current << code
+          @current_code << code
         end
       end
 

data/lib/doctest/core/source.rb

@@ -4,7 +4,7 @@ module Doctest
 
       def self.to_filenames(source)
         case source
-        when Class
+        when Class, Module
           constant_filenames(source)
         else
           [ source ]

data/lib/doctest/core/version.rb

@@ -1,5 +1,5 @@
 module Doctest
   module Core
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/spec/fixtures/class_with_doctests.rb

@@ -1,3 +1,8 @@
+# Sample multi-line code
+#
+# >> a = 3
+# >> a + 2
+# => 5
 class ClassWithDoctests
 
   # Always returns 'a'

data/spec/fixtures/simple_module.rb

@@ -0,0 +1,3 @@
+module SimpleModule
+  def first_method; end
+end

data/spec/lib/doctest/core/base_spec.rb

@@ -10,9 +10,9 @@ describe Doctest::Core::Base do
     analyzer = Doctest::Core::Base.new(str)
 
     doctests = analyzer.analyze
-    doctests.should have(1).entries
+    expect(doctests.length).to equal 1
 
-    doctests[0].should == Doctest::Core::Doctest.new("3 + 2", "5", nil, 2)
+    expect(doctests[0]).to eql Doctest::Core::Doctest.new("3 + 2", "5", nil, 2)
   end
 
   it 'extracts multiple samples from a string' do
@@ -27,10 +27,10 @@ describe Doctest::Core::Base do
     analyzer = Doctest::Core::Base.new(str)
 
     doctests = analyzer.analyze
-    doctests.should have(2).entries
+    expect(doctests.length).to equal 2
 
-    doctests[0].should == Doctest::Core::Doctest.new("3 + 2", "5", nil, 2)
-    doctests[1].should == Doctest::Core::Doctest.new("4 + 2", "6", nil, 6)
+    expect(doctests[0]).to eql Doctest::Core::Doctest.new("3 + 2", "5", nil, 2)
+    expect(doctests[1]).to eql Doctest::Core::Doctest.new("4 + 2", "6", nil, 6)
   end
 
 end

data/spec/lib/doctest/core/doctest_spec.rb

@@ -7,7 +7,7 @@ module Doctest::Core
       context "doctests for #{source}" do
         ::Doctest::Core.extract_from(source).each do |doctest|
           it "at #{doctest.original_file}:#{doctest.line}" do
-            doctest.code_evaluation.should == doctest.result_evaluation
+            expect(doctest.code_evaluation).to eql doctest.result_evaluation
           end
         end
       end
@@ -19,12 +19,12 @@ module Doctest::Core
     context 'evaluation' do
 
       it 'evaluates the result string' do
-        Doctest.new(nil, '5', nil, nil).result_evaluation.should == 5
-        Doctest.new(nil, '3 + 2', nil, nil).result_evaluation.should == 5
+        expect(Doctest.new(nil, '5', nil, nil).result_evaluation).to equal 5
+        expect(Doctest.new(nil, '3 + 2', nil, nil).result_evaluation).to equal 5
       end
 
       it 'evaluates the code string' do
-        Doctest.new("a = 3\na + 2", nil, nil, nil).code_evaluation.should == 5
+        expect(Doctest.new("a = 3\na + 2", nil, nil, nil).code_evaluation).to equal 5
       end
 
     end

data/spec/lib/doctest/core/source_spec.rb

@@ -1,6 +1,7 @@
 require 'spec_helper'
 require fixture('simple_class.rb')
 require fixture('simple_class_reopened.rb')
+require fixture('simple_module.rb')
 
 module Doctest::Core
   describe 'Source' do
@@ -8,16 +9,22 @@ module Doctest::Core
     context 'to_code_locations' do
 
       it 'wraps a filename in an array' do
-        Source.to_filenames(fixture('simple_file.rb')).should == [ fixture('simple_file.rb') ]
+        expect(Source.to_filenames(fixture('simple_file.rb'))).to eql [ fixture('simple_file.rb') ]
       end
 
       it 'resolves the filenames of a ruby class' do
-        Source.to_filenames(SimpleClass).should == [
+        expect(Source.to_filenames(SimpleClass)).to eql [
           fixture('simple_class.rb'),
           fixture('simple_class_reopened.rb')
         ]
       end
 
+      it 'resolves the filenames of a ruby module' do
+        expect(Source.to_filenames(SimpleModule)).to eql [
+          fixture('simple_module.rb'),
+        ]
+      end
+
     end
 
   end

data/spec/lib/doctest/core_spec.rb

@@ -6,10 +6,11 @@ describe Doctest::Core do
   it 'extracts doctests from ruby classes' do
     orig_file = fixture('class_with_doctests.rb')
     doctests = Doctest::Core.extract_from(ClassWithDoctests)
-    doctests.should have(2).entries
+    expect(doctests.length).to equal 3
 
-    doctests[0].should == Doctest::Core::Doctest.new("ClassWithDoctests.a", "'a'", orig_file, 6)
-    doctests[1].should == Doctest::Core::Doctest.new("ClassWithDoctests.b", "'b'", orig_file, 14)
+    expect(doctests[0]).to eql Doctest::Core::Doctest.new("a = 3;a + 2", "5", orig_file, 5)
+    expect(doctests[1]).to eql Doctest::Core::Doctest.new("ClassWithDoctests.a", "'a'", orig_file, 11)
+    expect(doctests[2]).to eql Doctest::Core::Doctest.new("ClassWithDoctests.b", "'b'", orig_file, 19)
   end
 
 end

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: doctest-core
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Heiko Zeus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-01 00:00:00.000000000 Z
+date: 2014-10-11 00:00:00.000000000 Z
 dependencies:
 - !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: 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: 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: Extract doctests from ruby files
@@ -87,8 +87,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -104,6 +104,7 @@ files:
 - spec/fixtures/simple_class.rb
 - spec/fixtures/simple_class_reopened.rb
 - spec/fixtures/simple_file.rb
+- spec/fixtures/simple_module.rb
 - spec/lib/doctest/core/base_spec.rb
 - spec/lib/doctest/core/doctest_spec.rb
 - spec/lib/doctest/core/source_spec.rb
@@ -119,17 +120,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 aims to provide the basis for elixir-like doctests. It should be used
@@ -139,9 +140,9 @@ test_files:
 - spec/fixtures/simple_class.rb
 - spec/fixtures/simple_class_reopened.rb
 - spec/fixtures/simple_file.rb
+- spec/fixtures/simple_module.rb
 - spec/lib/doctest/core/base_spec.rb
 - spec/lib/doctest/core/doctest_spec.rb
 - spec/lib/doctest/core/source_spec.rb
 - spec/lib/doctest/core_spec.rb
 - spec/spec_helper.rb
-has_rdoc: