erudite 0.1.0 → 0.2.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    MmMyNDJiNGZhYjc3YmY5NDJmNjA1ZWY2OWZmNDRkMDdiYjAwMzA0MQ==
-  data.tar.gz: !binary |-
-    NjA3YjdkZWY3OTVjMDM2OTI2NTUzZWU2YzRhNTViMjI5NmE4NjkxOQ==
+SHA1:
+  metadata.gz: 2dcd8553e0a52b455a6437a4fc7f339e744bc4cf
+  data.tar.gz: 0bf967f16cc6422116ba59cbbb263b1753c90c8e
 SHA512:
-  metadata.gz: !binary |-
-    NjllZjIyNjdkMWE2YjQwNGJmNmUxZTQyYTA5ODFhNmI5OGIxYTllYTU4NDNh
-    OWM5M2Y2N2ZhMWM0YzIxNzI4NzdjOTI3MTQ0YTFlNjdlNzU2ZjhhMjNmZDE4
-    ZDhhMWU1NTc5NzUwY2Q0ZWIxYzVmNDEzZjQzOGE1OWMxNzY4OTU=
-  data.tar.gz: !binary |-
-    MThjNzM2YTllMTY2NzBkNGY4ZjYwZTRmODljMGE1YTkzOGNmYmMzYzQzMDg4
-    N2Y1YzIwY2I4Y2JiMmJmNGVmMTBiMWQwMTY4YjIzZDcxMzk5NmJmZWQ4ZDFh
-    YjhlMGMyOTBmMjVkOTYyYzZkZTI3YTY1NWU1MDI4YzRlMGY2NzY=
+  metadata.gz: 38b880bc0c05e713911ce85df61a43082db3446cd8a63093b0c85a338eb46aa4190590712b76d7136f924de874a610293e88a21812897b3dbb4d5d566e98f2cf
+  data.tar.gz: 79c25e231334d1d254f7f88fcb8803ed9273ca150d745babe1876cb3d0e3e8009fb65cf187840bcc759844b41b7d2968c2bd790d2f3e01bab09fc8a97277642c

data/CHANGELOG.md

@@ -1 +1,9 @@
 # Changelog
+
+## v0.2.0 (2014-09-18)
+
+- Create an executable.
+
+## v0.1.0 (2014-08-24)
+
+- Initial release.

data/LICENSE.md

@@ -1,18 +1,18 @@
-Copyright (c) 2014 Taylor Fausak <taylor@fausak.me>
-
-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.
+Copyright (c) 2014 Taylor Fausak <taylor@fausak.me>
+
+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

@@ -1,9 +1,36 @@
 # [Erudite][1]
 
+[![Gem version][2]][3]
+[![Build status][4]][5]
+[![Code coverage][6]][7]
+[![Code quality][8]][9]
+[![Dependency status][10]][11]
+
 Executable documentation.
 
+- [Installation](#installation)
+- [Usage](#usage)
+
+## Installation
+
+Add it to your Gemfile:
+
 ``` rb
-examples = Erudite::Parser.parse(<<-'RUBY')
+gem 'erudite', '~> 0.2.0'
+```
+
+Or install it manually:
+
+``` sh
+$ gem install erudite --version 0.2.0
+```
+
+This project uses [Semantic Versioning][12].
+
+## Usage
+
+``` irb
+# example.irb
 >> 1 + 2
 => 3
 
@@ -21,8 +48,8 @@ hello world
 oh noes
 => nil
 
->> fail 'catastrophe!'
-RuntimeError: catastrophe!
+>> fail 'catastrophe'
+RuntimeError: catastrophe
 
 >> puts 'chunky
 .. bacon'
@@ -35,19 +62,30 @@ bacon
 .. end
 >> double(3)
 => 6
-RUBY
-
-examples.each do |example|
-  if example.pass?
-    puts 'PASS'
-  else
-    puts 'FAIL'
-    puts " expected : #{example.expected.result.inspect}"
-    puts "          : #{example.expected.output.inspect}"
-    puts " actual   : #{example.actual.result.inspect}"
-    puts "          : #{example.actual.output.inspect}"
-  end
-end
+```
+
+``` sh
+$ erudite example.irb
+- PASS
+- PASS
+- PASS
+- PASS
+- PASS
+- PASS
+- PASS
+- PASS
+- PASS
 ```
 
 [1]: https://github.com/tfausak/erudite
+[2]: https://badge.fury.io/rb/erudite.svg
+[3]: http://rubygems.org/gems/erudite
+[4]: https://travis-ci.org/tfausak/erudite.svg
+[5]: https://travis-ci.org/tfausak/erudite
+[6]: https://img.shields.io/coveralls/tfausak/erudite.svg
+[7]: https://coveralls.io/r/tfausak/erudite
+[8]: https://codeclimate.com/github/tfausak/erudite/badges/gpa.svg
+[9]: https://codeclimate.com/github/tfausak/erudite
+[10]: https://gemnasium.com/tfausak/erudite.svg
+[11]: https://gemnasium.com/tfausak/erudite
+[12]: http://semver.org/spec/v2.0.0.html

data/bin/erudite

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+
+require 'erudite'
+
+Erudite::Executable.run(ARGF)

data/lib/erudite.rb

@@ -1,9 +1,10 @@
-# coding: utf-8
-
-require 'erudite/example'
-require 'erudite/outcome'
-require 'erudite/parser'
-
-# Executable documentation.
-module Erudite
-end
+# coding: utf-8
+
+require 'erudite/example'
+require 'erudite/executable'
+require 'erudite/outcome'
+require 'erudite/parser'
+
+# Executable documentation.
+module Erudite
+end

data/lib/erudite/example.rb

@@ -1,79 +1,82 @@
-# coding: utf-8
-
-require 'stringio'
-
-module Erudite
-  # Code to be run and compared against its expected outcome.
-  class Example
-    attr_reader :source
-    attr_reader :expected
-    attr_writer :binding
-
-    def initialize(source, result = nil, output = nil)
-      @source = source
-      @expected = Outcome.new(result, output)
-    end
-
-    def binding
-      @binding ||= TOPLEVEL_BINDING.dup
-    end
-
-    def run!
-      binding.eval(source, __FILE__, __LINE__)
-    end
-
-    def run
-      [run!, nil]
-    rescue Exception => exception # rubocop:disable Lint/RescueException
-      [nil, exception]
-    end
-
-    def self.without_stdio
-      stdin, stdout, stderr = $stdin, $stdout, $stderr
-      $stdin = $stdout = $stderr = io = StringIO.new
-      [yield, io]
-    ensure
-      $stdin, $stdout, $stderr = stdin, stdout, stderr
-    end
-
-    def self.format_exception(exception)
-      "#{exception.class.name}: #{exception.message}"
-    end
-
-    def actual
-      return @actual if defined?(@actual)
-
-      result, io = self.class.without_stdio do
-        result, exception = run
-        warn(self.class.format_exception(exception)) if exception
-        result.inspect
-      end
-
-      @actual = Outcome.new(result, io.string)
-    end
-
-    def self.pattern(string)
-      Regexp.new(Regexp.escape(string).gsub('\.\.\.', '.*?'))
-    end
-
-    def valid_result?
-      return true unless expected.result
-      self.class.pattern(expected.result).match(actual.result)
-    end
-
-    def valid_output?
-      return true unless expected.output
-      self.class.pattern(expected.output).match(actual.output)
-    end
-
-    def pass?
-      actual
-      valid_result? && valid_output?
-    end
-
-    def ==(other)
-      source == other.source &&
-        expected == other.expected
-    end
-  end
-end
+# coding: utf-8
+
+require 'English'
+require 'stringio'
+
+module Erudite
+  # Code to be run and compared against its expected outcome.
+  class Example
+    attr_reader :source
+    attr_reader :expected
+    attr_writer :binding
+
+    def initialize(source, result = nil, output = nil)
+      @source = source
+      @expected = Outcome.new(result, output)
+    end
+
+    def binding
+      @binding ||= TOPLEVEL_BINDING.dup
+    end
+
+    def run!
+      binding.eval(source, __FILE__, __LINE__)
+    end
+
+    def run
+      [run!, nil]
+    rescue Exception => exception # rubocop:disable Lint/RescueException
+      [nil, exception]
+    end
+
+    def self.without_stdio
+      stdin, stdout, stderr, argv = $stdin, $stdout, $stderr, $ARGV.dup
+      io = $stdin = $stdout = $stderr = StringIO.new
+      $ARGV.clear
+      [yield, io]
+    ensure
+      $stdin, $stdout, $stderr = stdin, stdout, stderr
+      $ARGV.replace(argv)
+    end
+
+    def self.format_exception(exception)
+      "#{exception.class.name}: #{exception.message}"
+    end
+
+    def actual
+      return @actual if defined?(@actual)
+
+      result, io = self.class.without_stdio do
+        result, exception = run
+        warn(self.class.format_exception(exception)) if exception
+        result.inspect
+      end
+
+      @actual = Outcome.new(result, io.string)
+    end
+
+    def self.pattern(string)
+      Regexp.new(Regexp.escape(string).gsub('\.\.\.', '.*?'))
+    end
+
+    def valid_result?
+      return true unless expected.result
+      self.class.pattern(expected.result).match(actual.result)
+    end
+
+    def valid_output?
+      return true unless expected.output
+      self.class.pattern(expected.output).match(actual.output)
+    end
+
+    def pass?
+      actual
+      valid_result? && valid_output?
+    end
+
+    def ==(other)
+      source == other.source &&
+        expected == other.expected
+    end
+  end
+end

data/lib/erudite/executable.rb

@@ -0,0 +1,35 @@
+# coding: utf-8
+
+module Erudite
+  # Parses, runs, and outputs examples.
+  class Executable
+    def self.run(io)
+      Parser.parse(io).each { |example| puts format_example(example) }
+    end
+
+    def self.format_example(example)
+      if example.pass?
+        format_passing_example(example)
+      else
+        format_failing_example(example)
+      end
+    end
+
+    def self.format_passing_example(_example)
+      '- PASS'
+    end
+
+    def self.format_failing_example(example)
+      <<-TXT
+- FAIL
+  Source: #{example.source}
+  Expected:
+    Output: #{example.expected.output.inspect}
+    Result: #{example.expected.result.inspect}
+  Actual:
+    Output: #{example.actual.output.inspect}
+    Result: #{example.actual.result.inspect}
+      TXT
+    end
+  end
+end

data/lib/erudite/outcome.rb

@@ -1,19 +1,19 @@
-# coding: utf-8
-
-module Erudite
-  # Information about an expected or actual outcome.
-  class Outcome
-    attr_reader :result
-    attr_reader :output
-
-    def initialize(result, output)
-      @result = result
-      @output = output
-    end
-
-    def ==(other)
-      result == other.result &&
-        output == other.output
-    end
-  end
-end
+# coding: utf-8
+
+module Erudite
+  # Information about an expected or actual outcome.
+  class Outcome
+    attr_reader :result
+    attr_reader :output
+
+    def initialize(result, output)
+      @result = result
+      @output = output
+    end
+
+    def ==(other)
+      result == other.result &&
+        output == other.output
+    end
+  end
+end

data/lib/erudite/parser.rb

@@ -1,54 +1,54 @@
-# coding: utf-8
-
-module Erudite
-  # Parses IRB output into examples.
-  class Parser
-    def self.parse(string)
-      group(string).map { |lines| exemplify(lines) }
-    end
-
-    def self.group(string)
-      buffer = []
-
-      groups = string.each_line.each_with_object([]) do |line, array|
-        if line.start_with?('>> ') && !buffer.empty?
-          array.push(buffer)
-          buffer = []
-        end
-
-        buffer.push(line)
-      end
-
-      buffer.empty? ? groups : groups.push(buffer)
-    end
-
-    def self.exemplify(lines)
-      source = extract_source(lines)
-      result = extract_result(lines)
-      output = extract_output(lines)
-
-      Example.new(source, result, output)
-    end
-
-    def self.extract_source(lines)
-      source = lines
-        .select { |line| line.start_with?('>> ', '.. ') }
-        .map { |line| line[3..-1].chomp }
-      source.join("\n") unless source.empty?
-    end
-
-    def self.extract_result(lines)
-      result = lines
-        .select { |line| line.start_with?('=> ') }
-        .map { |line| line[3..-1].chomp }
-      result.join("\n") unless result.empty?
-    end
-
-    def self.extract_output(lines)
-      output = lines
-        .reject { |line| line.start_with?('>> ', '.. ', '=> ') }
-        .map { |line| line.chomp }
-      output.join("\n") unless output.empty?
-    end
-  end
-end
+# coding: utf-8
+
+module Erudite
+  # Parses IRB output into examples.
+  class Parser
+    def self.parse(string)
+      group(string).map { |lines| exemplify(lines) }
+    end
+
+    def self.group(string)
+      buffer = []
+
+      groups = string.each_line.each_with_object([]) do |line, array|
+        if line.start_with?('>> ') && !buffer.empty?
+          array.push(buffer)
+          buffer = []
+        end
+
+        buffer.push(line)
+      end
+
+      buffer.empty? ? groups : groups.push(buffer)
+    end
+
+    def self.exemplify(lines)
+      source = extract_source(lines)
+      result = extract_result(lines)
+      output = extract_output(lines)
+
+      Example.new(source, result, output)
+    end
+
+    def self.extract_source(lines)
+      source = lines
+        .select { |line| line.start_with?('>> ', '.. ') }
+        .map { |line| line[3..-1].chomp }
+      source.join("\n") unless source.empty?
+    end
+
+    def self.extract_result(lines)
+      result = lines
+        .select { |line| line.start_with?('=> ') }
+        .map { |line| line[3..-1].chomp }
+      result.join("\n") unless result.empty?
+    end
+
+    def self.extract_output(lines)
+      output = lines
+        .reject { |line| line.start_with?('>> ', '.. ', '=> ') }
+        .map(&:chomp)
+      output.join("\n") unless output.empty?
+    end
+  end
+end