doctest-core 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ODJmYWE0ZjE4Yjc4MTNkNDE4Y2UzOWI4YThhY2NlY2IwMTA3NDk1Yg==
+  data.tar.gz: !binary |-
+    NzUxYTc5YWQyNTZmOTAyZGE1MTk4MWJiZDVjNGRkNTAxZGExZTk0MQ==
+SHA512:
+  metadata.gz: !binary |-
+    MTE5MTAyMWQxMGZmNTE4NDY1ZmQ4YzNhM2U1MThlMzBjNmRmNzNjYThiMGQz
+    MGExZGE3ODQzZWQxMzE5Y2FkNjdiNDYxMjY0ZWRlYzljNTlkMzRkZGVlMTgz
+    YmVhMGQ2N2MyZWM0MmU3MDU1ZmEyYzM0MDZiMWIwYTQ2ZTdjOGE=
+  data.tar.gz: !binary |-
+    NDE0NGYyODM1ZWJjYzQ3YjBiYTU5OWFiODU5ZmM0MTlhYjVmMWQ0ZThkMjI1
+    ZmQzN2Y3Y2M2M2FkM2ZhZDNiNWU2MzAyZWRiNzA3MTIxYjk4N2YzM2ViMjhi
+    Y2MwMzIwNWE4NmQ2OThlZTlkNjgxOGY2YmFjOGE5MmI1YmIwMTE=

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,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - jruby-19mode
+  - rbx-19mode
+script: bundle exec rspec spec

data/Gemfile

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

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,69 @@
+[![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)
+
+# Doctest::Core
+
+Extract doctests from your ruby files
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'doctest-core'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install doctest-core
+
+## Usage
+
+Add doctest-comments to your ruby files:
+
+```ruby
+class ClassWithDoctests
+
+  # Always returns 'a'
+  #
+  # >> ClassWithDoctests.a
+  # => 'a'
+  def self.a
+    'a'
+  end
+
+  # Always returns 'b'
+  #
+  # >> ClassWithDoctests.b
+  # => 'b'
+  def self.b
+    'b'
+  end
+
+end
+```
+
+You can then run
+```ruby
+Doctest::Core.extract_from(ClassWithDoctests)
+```
+
+to get a simple array of doctest occurrences. Those contain
+* ```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
+* ```line```: The line number of the doctest occurrence
+
+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.
+
+## 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-core.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'doctest/core/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "doctest-core"
+  spec.version       = Doctest::Core::VERSION
+  spec.authors       = ["Heiko Zeus"]
+  spec.email         = ["heiko.zeus@zweitag.de"]
+  spec.description   = %q{Extract doctests from ruby files}
+  spec.summary       = %q{This aims to provide the basis for elixir-like doctests. It should be used by test-framework-specific gems}
+  spec.homepage      = "https://github.com/hzeus/doctest-core"
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "pry"
+end

data/lib/doctest/core/base.rb

@@ -0,0 +1,75 @@
+module Doctest
+  module Core
+    class Base
+
+      def self.analyze(str)
+        self.new(str).analyze
+      end
+
+      CODE_REGEXP   = /^\s*#\s*>>\s*(?<code>.*)/
+      RESULT_REGEXP = /#\s*=>\s*(?<result>.*)$/
+
+      def initialize(source)
+        if File.exists?(source)
+          @filename = source
+          @str = File.read(source)
+        else
+          @filename = nil
+          @str = source
+        end
+        @state   = :no_match
+        @current = nil
+        @doctests = []
+      end
+
+      def analyze
+        @str.lines.with_index do |line, index|
+          case line
+          when CODE_REGEXP
+            handle_code(Regexp.last_match['code'])
+          when RESULT_REGEXP
+            handle_result(Regexp.last_match['result'], index)
+          else
+            handle_no_doctest
+          end
+        end
+
+        @doctests
+      end
+
+      private
+
+      def add_doctest(code_lines, result, line_index)
+        @doctests << Doctest.new(code_lines.join(';'), result, @filename, line_index + 1)
+      end
+
+      def handle_code(code)
+        case @state
+        when :no_match
+          @current_code = [code]
+          @state = :match
+        when :match
+          @current << code
+        end
+      end
+
+      def handle_result(result, line_index)
+        case @state
+        when :match
+          add_doctest(@current_code, result, line_index)
+          reset
+        end
+      end
+
+      def handle_no_doctest
+        reset
+      end
+
+      def reset
+        @state = :no_match
+        @current
+      end
+
+    end
+  end
+end

data/lib/doctest/core/doctest.rb

@@ -0,0 +1,15 @@
+module Doctest
+  module Core
+    class Doctest < Struct.new(:code_string, :result_string, :original_file, :line)
+
+      def result_evaluation
+        eval(result_string)
+      end
+
+      def code_evaluation
+        eval(code_string)
+      end
+
+    end
+  end
+end

data/lib/doctest/core/source.rb

@@ -0,0 +1,34 @@
+module Doctest
+  module Core
+    module Source
+
+      def self.to_filenames(source)
+        case source
+        when Class
+          constant_filenames(source)
+        else
+          [ source ]
+        end
+      end
+
+      def self.constant_filenames(constant)
+        (filenames_of_instance_methods(constant) + filenames_of_methods(constant)).uniq
+      end
+
+      def self.filenames_of_instance_methods(constant)
+        constant.
+          instance_methods(false).
+          map{|m| constant.instance_method(m).source_location}.
+          map(&:first)
+      end
+
+      def self.filenames_of_methods(constant)
+        constant.
+          methods(false).
+          map{|m| constant.method(m).source_location}.
+          map(&:first)
+      end
+
+    end
+  end
+end

data/lib/doctest/core/version.rb

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

data/lib/doctest/core.rb

@@ -0,0 +1,15 @@
+require "doctest/core/version"
+require "doctest/core/base"
+require "doctest/core/doctest"
+require "doctest/core/source"
+
+module Doctest
+  module Core
+
+    def self.extract_from(source)
+      Source.to_filenames(source).
+        flat_map{|code_location| Base.analyze(code_location)}
+    end
+
+  end
+end

data/spec/fixtures/class_with_doctests.rb

@@ -0,0 +1,19 @@
+class ClassWithDoctests
+
+  # Always returns 'a'
+  #
+  # >> ClassWithDoctests.a
+  # => 'a'
+  def self.a
+    'a'
+  end
+
+  # Always returns 'b'
+  #
+  # >> ClassWithDoctests.b
+  # => 'b'
+  def self.b
+    'b'
+  end
+
+end

data/spec/fixtures/simple_class.rb

@@ -0,0 +1,4 @@
+class SimpleClass
+  def first_method; end
+  def second_method; end
+end

data/spec/fixtures/simple_class_reopened.rb

@@ -0,0 +1,3 @@
+class SimpleClass
+  def third_method; end
+end

data/spec/fixtures/simple_file.rb

@@ -0,0 +1 @@
+# This is just a simple file

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

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Doctest::Core::Base do
+
+  it 'extracts simple code samples' do
+    str = <<-END.gsub(/^ {6}/, '')
+      # >> 3 + 2
+      # => 5
+    END
+    analyzer = Doctest::Core::Base.new(str)
+
+    doctests = analyzer.analyze
+    doctests.should have(1).entries
+
+    doctests[0].should == Doctest::Core::Doctest.new("3 + 2", "5", nil, 2)
+  end
+
+  it 'extracts multiple samples from a string' do
+    str = <<-END.gsub(/^ {6}/, '')
+      # >> 3 + 2
+      # => 5
+      def foo
+      end
+      # >> 4 + 2
+      # => 6
+    END
+    analyzer = Doctest::Core::Base.new(str)
+
+    doctests = analyzer.analyze
+    doctests.should have(2).entries
+
+    doctests[0].should == Doctest::Core::Doctest.new("3 + 2", "5", nil, 2)
+    doctests[1].should == Doctest::Core::Doctest.new("4 + 2", "6", nil, 6)
+  end
+
+end

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

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+module Doctest::Core
+  describe Doctest do
+
+    def self.doctest(source)
+      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
+          end
+        end
+      end
+    end
+
+    require fixture('class_with_doctests.rb')
+    doctest ClassWithDoctests
+
+    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
+      end
+
+      it 'evaluates the code string' do
+        Doctest.new("a = 3\na + 2", nil, nil, nil).code_evaluation.should == 5
+      end
+
+    end
+
+  end
+end

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

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require fixture('simple_class.rb')
+require fixture('simple_class_reopened.rb')
+
+module Doctest::Core
+  describe 'Source' do
+
+    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') ]
+      end
+
+      it 'resolves the filenames of a ruby class' do
+        Source.to_filenames(SimpleClass).should == [
+          fixture('simple_class.rb'),
+          fixture('simple_class_reopened.rb')
+        ]
+      end
+
+    end
+
+  end
+end

data/spec/lib/doctest/core_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+require fixture('class_with_doctests.rb')
+
+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
+
+    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)
+  end
+
+end

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: doctest-core
+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: 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
+email:
+- heiko.zeus@zweitag.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- doctest-core.gemspec
+- lib/doctest/core.rb
+- lib/doctest/core/base.rb
+- lib/doctest/core/doctest.rb
+- lib/doctest/core/source.rb
+- lib/doctest/core/version.rb
+- spec/fixtures/class_with_doctests.rb
+- spec/fixtures/simple_class.rb
+- spec/fixtures/simple_class_reopened.rb
+- spec/fixtures/simple_file.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
+homepage: https://github.com/hzeus/doctest-core
+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 aims to provide the basis for elixir-like doctests. It should be used
+  by test-framework-specific gems
+test_files:
+- spec/fixtures/class_with_doctests.rb
+- spec/fixtures/simple_class.rb
+- spec/fixtures/simple_class_reopened.rb
+- spec/fixtures/simple_file.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: