docu 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/EXAMPLE_README.md

@@ -0,0 +1,5 @@
+Example
+=======
+
+1 + 2
+#=> 3

data/EXAMPLE_README.md.docu

@@ -0,0 +1,7 @@
+Example
+=======
+
+:example:
+1 + 2
+#=> 3
+:end:

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in docu.gemspec
+gemspec

data/README.md

@@ -0,0 +1,34 @@
+docu
+====
+
+Executes code examples you may have in your readme files!
+
+Example README.md.docu
+----------------------
+
+```
+Hello!
+======
+
+:example:
+1 + 1000
+#=> 1001
+:end:
+```
+
+This file will generate a README.md that looks like this:
+
+```
+Hello!
+======
+
+1 + 1000
+#=> 1001
+```
+
+It will also fail if any assertions don't match up.
+
+Usage
+-----
+gem install docu
+docu README.md.docu

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+Rake::TestTask.new(:spec) do |task|
+  task.test_files = FileList['spec/**/*_spec.rb']
+end

data/bin/docu

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require "docu"
+Docu::ExecutesExamples.new(Kernel).execute(ARGV.first)

data/docu.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "docu/version"
+
+Gem::Specification.new do |s|
+  s.name        = "docu"
+  s.version     = Docu::VERSION
+  s.authors     = ["Andrew Vos"]
+  s.email       = ["andrew.vos@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{}
+  s.description = %q{}
+
+  s.rubyforge_project = "docu"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "minitest"
+end

data/lib/docu.rb

@@ -0,0 +1,3 @@
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__))))
+require "docu/version"
+require "docu/executes_examples"

data/lib/docu/executes_examples.rb

@@ -0,0 +1,38 @@
+module Docu
+  class ExecutesExamples
+    def initialize output
+      @output = output
+    end
+
+    def execute path
+      @output.puts "Executing Examples"
+      errors = []
+      successes = 0
+
+      contents = File.read(path)
+      contents.scan(/:example:((?:(?!^:end:).)*)/m).flatten.each do |example|
+        if example.include?("#=>")
+            expected = example.scan(/#=>\s*(.*)/).first.first
+            actual = eval(example).inspect
+          if actual == expected
+            successes += 1
+          else
+            errors << "Assertion does not match example. Expected \"#{actual}\" to equal \"#{expected}\""
+          end
+        end
+      end
+
+      @output.puts "#{errors.size} example(s) failed, #{successes} example(s) passed"
+
+      if errors.any?
+        errors.each do |error|
+          @output.puts error
+        end
+      else
+        File.open(path.chomp(File.extname(path)), "w") do |file|
+          file.write contents.gsub(":example:\n", "").gsub(":end:\n", "")
+        end
+      end
+    end
+  end
+end

data/lib/docu/version.rb

@@ -0,0 +1,3 @@
+module Docu
+  VERSION = "0.0.1"
+end

data/spec/docu/executes_examples_spec.rb

@@ -0,0 +1,85 @@
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "../../lib")))
+require "docu"
+
+require "minitest/pride"
+require "minitest/autorun"
+require "minitest/spec"
+
+module Docu
+  class OutputSpy
+    attr_accessor :output
+    def puts(*a)
+      @output ||= []
+      a.each do |i|
+        @output << i
+      end
+    end
+  end
+
+  describe ExecutesExamples do
+    after do
+      File.delete("TEST_README.md") if File.exist?("TEST_README.md")
+      File.delete("TEST_README.md.docu") if File.exist?("TEST_README.md.docu")
+    end
+
+    it "writes out some text" do
+      output_spy = OutputSpy.new
+      File.open("TEST_README.md.docu", "w") do |file|
+        file.puts
+      end
+      Docu::ExecutesExamples.new(output_spy).execute("TEST_README.md.docu")
+      output_spy.output.must_include "Executing Examples"
+    end
+
+    describe "one failing example and one passing example" do
+      before do
+        File.open("TEST_README.md.docu", "w") do |file|
+          file.puts ":example:"
+          file.puts "1 + 1"
+          file.puts "#=> 23"
+          file.puts ":end:"
+
+          file.puts ":example:"
+          file.puts "1 + 1"
+          file.puts "#=> 2"
+          file.puts ":end:"
+        end
+      end
+
+      it "mentions failure and success" do
+        output_spy = OutputSpy.new
+        Docu::ExecutesExamples.new(output_spy).execute("TEST_README.md.docu")
+        output_spy.output.must_include "1 example(s) failed, 1 example(s) passed"
+      end
+
+      it "outputs errors" do
+        output_spy = OutputSpy.new
+        Docu::ExecutesExamples.new(output_spy).execute("TEST_README.md.docu")
+        output_spy.output.must_include "Assertion does not match example. Expected \"2\" to equal \"23\""
+      end
+
+      it "does not write the file" do
+        File.exist?("TEST_README.md").must_equal false
+      end
+    end
+
+    describe "one passing example" do
+      before do
+        File.open("TEST_README.md.docu", "w") do |file|
+          file.puts ":example:"
+          file.puts "1 + 1"
+          file.puts "#=> 2"
+          file.puts ":end:"
+        end
+      end
+
+      it "writes out the file removing all :example: and :end: markers" do
+        output_spy = OutputSpy.new
+        Docu::ExecutesExamples.new(output_spy).execute("TEST_README.md.docu")
+        File.exist?("TEST_README.md").must_equal true
+        contents = File.read("TEST_README.md").to_s
+        contents.must_equal "1 + 1\n#=> 2\n"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: docu
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Andrew Vos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-23 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70328576592840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70328576592840
+description: ''
+email:
+- andrew.vos@gmail.com
+executables:
+- docu
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- EXAMPLE_README.md
+- EXAMPLE_README.md.docu
+- Gemfile
+- README.md
+- Rakefile
+- bin/docu
+- docu.gemspec
+- lib/docu.rb
+- lib/docu/executes_examples.rb
+- lib/docu/version.rb
+- spec/docu/executes_examples_spec.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: docu
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: ''
+test_files:
+- spec/docu/executes_examples_spec.rb