erudite 0.1.0 → 0.2.0

data/spec/erudite/executable_spec.rb

@@ -0,0 +1,76 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+describe Erudite::Executable do
+  let(:example) { Erudite::Example.new(source, example_result) }
+  let(:source) { '' }
+  let(:example_result) { nil }
+
+  describe '.run' do
+    subject(:result) { described_class.run(io) }
+    let(:io) { StringIO.new(input) }
+    let(:input) { '' }
+
+    before { @stdout, $stdout = $stdout, StringIO.new }
+    after { $stdout = @stdout }
+
+    it 'returns an array' do
+      expect(result).to be_an(Array)
+    end
+
+    context 'with input' do
+      let(:input) { ">> p(true)\ntrue\n=> true\n" }
+
+      it 'returns the example' do
+        expect(result).to_not be_empty
+        result.each do |example|
+          expect(example).to be_an(Erudite::Example)
+        end
+      end
+
+      it 'prints the results' do
+        result
+        expect($stdout.string).to eql("- PASS\n")
+      end
+    end
+  end
+
+  describe '.format_example' do
+    subject(:result) { described_class.format_example(example) }
+
+    context 'passing' do
+      let(:source) { 'true' }
+      let(:example_result) { 'true' }
+
+      it 'starts with "- PASS"' do
+        expect(result).to start_with('- PASS')
+      end
+    end
+
+    context 'failing' do
+      let(:source) { 'true' }
+      let(:example_result) { 'false' }
+
+      it 'starts with "- FAIL"' do
+        expect(result).to start_with('- FAIL')
+      end
+    end
+  end
+
+  describe '.format_passing_example' do
+    subject(:result) { described_class.format_passing_example(example) }
+
+    it 'starts with "- PASS"' do
+      expect(result).to start_with('- PASS')
+    end
+  end
+
+  describe '.format_failing_example' do
+    subject(:result) { described_class.format_failing_example(example) }
+
+    it 'starts with "- FAIL"' do
+      expect(result).to start_with('- FAIL')
+    end
+  end
+end

data/spec/erudite/outcome_spec.rb

@@ -1,53 +1,53 @@
-# coding: utf-8
-
-require 'spec_helper'
-
-describe Erudite::Outcome do
-  it 'requires a result' do
-    expect { described_class.new }.to raise_error(ArgumentError)
-  end
-
-  it 'requires some output' do
-    expect { described_class.new(nil) }.to raise_error(ArgumentError)
-  end
-
-  it 'can be initialized' do
-    expect(described_class.new(nil, nil)).to be_a(described_class)
-  end
-
-  it 'sets the result' do
-    result = double
-    outcome = described_class.new(result, nil)
-    expect(outcome.result).to eql(result)
-  end
-
-  it 'sets the output' do
-    output = double
-    outcome = described_class.new(nil, output)
-    expect(outcome.output).to eql(output)
-  end
-
-  describe '#==' do
-    it 'returns true if they have the same result and output' do
-      result = 'some'
-      output = 'thing'
-      a = described_class.new(result, output)
-      b = described_class.new(result, output)
-      expect(a).to eq(b)
-    end
-
-    it "returns false if they don't have the same result" do
-      output = 'something'
-      a = described_class.new('a', output)
-      b = described_class.new('b', output)
-      expect(a).to_not eq(b)
-    end
-
-    it "returns false if they don't have the same output" do
-      result = 'something'
-      a = described_class.new(result, 'a')
-      b = described_class.new(result, 'b')
-      expect(a).to_not eq(b)
-    end
-  end
-end
+# coding: utf-8
+
+require 'spec_helper'
+
+describe Erudite::Outcome do
+  it 'requires a result' do
+    expect { described_class.new }.to raise_error(ArgumentError)
+  end
+
+  it 'requires some output' do
+    expect { described_class.new(nil) }.to raise_error(ArgumentError)
+  end
+
+  it 'can be initialized' do
+    expect(described_class.new(nil, nil)).to be_a(described_class)
+  end
+
+  it 'sets the result' do
+    result = double
+    outcome = described_class.new(result, nil)
+    expect(outcome.result).to eql(result)
+  end
+
+  it 'sets the output' do
+    output = double
+    outcome = described_class.new(nil, output)
+    expect(outcome.output).to eql(output)
+  end
+
+  describe '#==' do
+    it 'returns true if they have the same result and output' do
+      result = 'some'
+      output = 'thing'
+      a = described_class.new(result, output)
+      b = described_class.new(result, output)
+      expect(a).to eq(b)
+    end
+
+    it "returns false if they don't have the same result" do
+      output = 'something'
+      a = described_class.new('a', output)
+      b = described_class.new('b', output)
+      expect(a).to_not eq(b)
+    end
+
+    it "returns false if they don't have the same output" do
+      result = 'something'
+      a = described_class.new(result, 'a')
+      b = described_class.new(result, 'b')
+      expect(a).to_not eq(b)
+    end
+  end
+end

data/spec/erudite/parser_spec.rb

@@ -1,104 +1,104 @@
-# coding: utf-8
-
-require 'spec_helper'
-
-# Monkey patch String to add ability to strip leading whitespace.
-class String
-  def dedent
-    gsub(/^#{self[/\A\s*/]}/, '')
-  end
-end
-
-describe Erudite::Parser do
-  describe '.parse' do
-    it 'parses an example without output or a result' do
-      examples = described_class.parse(<<-'RUBY'.dedent)
-        >> :something
-      RUBY
-      expect(examples).to eq([
-        Erudite::Example.new(':something')])
-    end
-
-    it 'parses an example with a result' do
-      examples = described_class.parse(<<-'RUBY'.dedent)
-        >> :something
-        => :something
-      RUBY
-      expect(examples).to eq([
-        Erudite::Example.new(':something', ':something')])
-    end
-
-    it 'parses an example with output' do
-      examples = described_class.parse(<<-'RUBY'.dedent)
-        >> puts :something
-        something
-      RUBY
-      expect(examples).to eq([
-        Erudite::Example.new('puts :something', nil, 'something')])
-    end
-
-    it 'handles STDIN' do
-      examples = described_class.parse(<<-'RUBY'.dedent)
-        >> gets
-        => nil
-      RUBY
-      expect(examples).to eq([
-        Erudite::Example.new('gets', 'nil')])
-    end
-
-    it 'handles STDOUT' do
-      examples = described_class.parse(<<-'RUBY'.dedent)
-        >> puts :something
-        something
-        => nil
-      RUBY
-      expect(examples).to eq([
-        Erudite::Example.new('puts :something', 'nil', 'something')])
-    end
-
-    it 'handles STDERR' do
-      examples = described_class.parse(<<-'RUBY'.dedent)
-        >> warn :something
-        something
-        => nil
-      RUBY
-      expect(examples).to eq([
-        Erudite::Example.new('warn :something', 'nil', 'something')])
-    end
-
-    it 'handles exceptions' do
-      examples = described_class.parse(<<-'RUBY'.dedent)
-        >> fail 'something'
-        RuntimeError: something
-      RUBY
-      expect(examples).to eq([
-        Erudite::Example.new(
-          "fail 'something'", nil, 'RuntimeError: something')])
-    end
-
-    it 'handles multi-line source and output' do
-      examples = described_class.parse(<<-'RUBY'.dedent)
-        >> puts 'some
-        .. thing'
-        some
-        thing
-        => nil
-      RUBY
-      expect(examples).to eq([
-        Erudite::Example.new("puts 'some\nthing'", 'nil', "some\nthing")])
-    end
-
-    it 'handles multiple examples' do
-      examples = described_class.parse(<<-'RUBY'.dedent)
-        >> def some
-        ..   :thing
-        .. end
-        >> some
-        => :thing
-      RUBY
-      expect(examples).to eq([
-        Erudite::Example.new("def some\n  :thing\nend"),
-        Erudite::Example.new('some', ':thing')])
-    end
-  end
-end
+# coding: utf-8
+
+require 'spec_helper'
+
+# Monkey patch String to add ability to strip leading whitespace.
+class String
+  def dedent
+    gsub(/^#{self[/\A\s*/]}/, '')
+  end
+end
+
+describe Erudite::Parser do
+  describe '.parse' do
+    it 'parses an example without output or a result' do
+      examples = described_class.parse(<<-'RUBY'.dedent)
+        >> :something
+      RUBY
+      expect(examples).to eq([
+        Erudite::Example.new(':something')])
+    end
+
+    it 'parses an example with a result' do
+      examples = described_class.parse(<<-'RUBY'.dedent)
+        >> :something
+        => :something
+      RUBY
+      expect(examples).to eq([
+        Erudite::Example.new(':something', ':something')])
+    end
+
+    it 'parses an example with output' do
+      examples = described_class.parse(<<-'RUBY'.dedent)
+        >> puts :something
+        something
+      RUBY
+      expect(examples).to eq([
+        Erudite::Example.new('puts :something', nil, 'something')])
+    end
+
+    it 'handles STDIN' do
+      examples = described_class.parse(<<-'RUBY'.dedent)
+        >> gets
+        => nil
+      RUBY
+      expect(examples).to eq([
+        Erudite::Example.new('gets', 'nil')])
+    end
+
+    it 'handles STDOUT' do
+      examples = described_class.parse(<<-'RUBY'.dedent)
+        >> puts :something
+        something
+        => nil
+      RUBY
+      expect(examples).to eq([
+        Erudite::Example.new('puts :something', 'nil', 'something')])
+    end
+
+    it 'handles STDERR' do
+      examples = described_class.parse(<<-'RUBY'.dedent)
+        >> warn :something
+        something
+        => nil
+      RUBY
+      expect(examples).to eq([
+        Erudite::Example.new('warn :something', 'nil', 'something')])
+    end
+
+    it 'handles exceptions' do
+      examples = described_class.parse(<<-'RUBY'.dedent)
+        >> fail 'something'
+        RuntimeError: something
+      RUBY
+      expect(examples).to eq([
+        Erudite::Example.new(
+          "fail 'something'", nil, 'RuntimeError: something')])
+    end
+
+    it 'handles multi-line source and output' do
+      examples = described_class.parse(<<-'RUBY'.dedent)
+        >> puts 'some
+        .. thing'
+        some
+        thing
+        => nil
+      RUBY
+      expect(examples).to eq([
+        Erudite::Example.new("puts 'some\nthing'", 'nil', "some\nthing")])
+    end
+
+    it 'handles multiple examples' do
+      examples = described_class.parse(<<-'RUBY'.dedent)
+        >> def some
+        ..   :thing
+        .. end
+        >> some
+        => :thing
+      RUBY
+      expect(examples).to eq([
+        Erudite::Example.new("def some\n  :thing\nend"),
+        Erudite::Example.new('some', ':thing')])
+    end
+  end
+end

data/spec/erudite_spec.rb

@@ -3,5 +3,4 @@
 require 'spec_helper'
 
 describe Erudite do
-  pending
 end

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
 # coding: utf-8
 
+require 'coveralls'
+Coveralls.wear!
+
 require 'erudite'

metadata

@@ -1,60 +1,75 @@
 --- !ruby/object:Gem::Specification
 name: erudite
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Taylor Fausak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-25 00:00:00.000000000 Z
+date: 2014-09-18 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 10.3.2
+        version: '10.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 10.3.2
+        version: '10.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.25.0
+        version: '0.26'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.25.0
+        version: '0.26'
 description: Executable documentation.
 email: taylor@fausak.me
-executables: []
+executables:
+- erudite
 extensions: []
 extra_rdoc_files: []
 files:
@@ -62,11 +77,14 @@ files:
 - CONTRIBUTING.md
 - LICENSE.md
 - README.md
+- bin/erudite
 - lib/erudite.rb
 - lib/erudite/example.rb
+- lib/erudite/executable.rb
 - lib/erudite/outcome.rb
 - lib/erudite/parser.rb
 - spec/erudite/example_spec.rb
+- spec/erudite/executable_spec.rb
 - spec/erudite/outcome_spec.rb
 - spec/erudite/parser_spec.rb
 - spec/erudite_spec.rb
@@ -81,12 +99,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -97,6 +115,7 @@ specification_version: 4
 summary: Executable documentation.
 test_files:
 - spec/erudite/example_spec.rb
+- spec/erudite/executable_spec.rb
 - spec/erudite/outcome_spec.rb
 - spec/erudite/parser_spec.rb
 - spec/erudite_spec.rb