docu 0.0.2 → 0.0.3

data/README.md

@@ -35,3 +35,18 @@ Usage
 gem install docu
 docu README.md.docu
 ```
+
+Rake Task
+---------
+
+```ruby
+require "docu/rake/task"
+
+Docu::Rake::Task.new do |task|
+  task.file = "README.md.docu"
+end
+```
+
+```
+rake docu
+```

data/bin/docu

@@ -2,4 +2,4 @@
 $:.unshift(File.dirname(__FILE__) + '/../lib')
 
 require "docu"
-Docu::ExecutesExamples.new(Kernel).execute(ARGV.first)
+Docu::ExecutesExamples.new.execute(ARGV.first)

data/lib/docu/executes_examples.rb

@@ -1,12 +1,11 @@
 module Docu
   class ExecutesExamples
-    def initialize output, kernel = Kernel
-      @output = output
+    def initialize kernel = Kernel
       @kernel = kernel
     end
 
     def execute path
-      @output.puts "Executing Examples"
+      @kernel.puts "Executing Examples"
       errors = []
       successes = 0
 
@@ -25,11 +24,11 @@ module Docu
         end
       end
 
-      @output.puts "#{errors.size} example(s) failed, #{successes} example(s) passed"
+      @kernel.puts "#{errors.size} example(s) failed, #{successes} example(s) passed"
 
       if errors.any?
         errors.each do |error|
-          @output.puts error
+          @kernel.puts error
         end
         @kernel.exit 1
       else

data/lib/docu/rake/task.rb

@@ -0,0 +1,24 @@
+$:.unshift(File.dirname(__FILE__) + '/../../')
+
+require "rake"
+require "rake/tasklib"
+require "docu"
+
+module Docu
+  module Rake
+    class Task < ::Rake::TaskLib
+      include ::Rake::DSL if defined?(::Rake::DSL)
+
+      attr_accessor :name, :file
+
+      def initialize(*args)
+        @name = args.shift || :docu
+        desc "Execute examples in documentation"  unless ::Rake.application.last_comment
+        yield self if block_given?
+        task name do
+          ExecutesExamples.new.execute(file)
+        end
+      end
+    end
+  end
+end

data/lib/docu/version.rb

@@ -1,3 +1,3 @@
 module Docu
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/docu/executes_examples_spec.rb

@@ -6,18 +6,16 @@ require "minitest/autorun"
 require "minitest/spec"
 
 module Docu
-  class OutputSpy
-    attr_accessor :output
+  class SpyKernel
+    attr_accessor :output, :exit_status
+
     def puts(*a)
       @output ||= []
       a.each do |i|
         @output << i
       end
     end
-  end
 
-  class SpyKernel
-    attr_accessor :exit_status
     def exit status
       @exit_status = status
     end
@@ -34,12 +32,11 @@ module 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, kernel).execute("TEST_README.md.docu")
-      output_spy.output.must_include "Executing Examples"
+      Docu::ExecutesExamples.new(kernel).execute("TEST_README.md.docu")
+      kernel.output.must_include "Executing Examples"
     end
 
     describe "one failing example and one passing example" do
@@ -58,27 +55,22 @@ module Docu
       end
 
       it "mentions failure and success" do
-        output_spy = OutputSpy.new
-        Docu::ExecutesExamples.new(output_spy, kernel).execute("TEST_README.md.docu")
-        output_spy.output.must_include "1 example(s) failed, 1 example(s) passed"
+        Docu::ExecutesExamples.new(kernel).execute("TEST_README.md.docu")
+        kernel.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, kernel).execute("TEST_README.md.docu")
-        output_spy.output.must_include "Assertion does not match example. Expected \"2\" to equal \"23\""
+        Docu::ExecutesExamples.new(kernel).execute("TEST_README.md.docu")
+        kernel.output.must_include "Assertion does not match example. Expected \"2\" to equal \"23\""
       end
 
       it "does not write the file" do
-        output_spy = OutputSpy.new
-        Docu::ExecutesExamples.new(output_spy, kernel).execute("TEST_README.md.docu")
+        Docu::ExecutesExamples.new(kernel).execute("TEST_README.md.docu")
         File.exist?("TEST_README.md").must_equal false
       end
 
       it "exits with non-zero exit status" do
-        output_spy = OutputSpy.new
-        executes_examples = Docu::ExecutesExamples.new(output_spy, kernel)
-        Docu::ExecutesExamples.new(output_spy, kernel).execute("TEST_README.md.docu")
+        Docu::ExecutesExamples.new(kernel).execute("TEST_README.md.docu")
         kernel.exit_status.must_equal 1
       end
     end
@@ -94,8 +86,7 @@ module Docu
       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")
+        Docu::ExecutesExamples.new(kernel).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"

data/spec/docu/rake/task_spec.rb

@@ -0,0 +1,41 @@
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "../../lib")))
+require "minitest/pride"
+require "minitest/autorun"
+require "minitest/spec"
+require "rake"
+require "docu/rake/task"
+
+module Docu
+  module Rake
+    describe Task do
+      before do
+        File.delete "TEST-README.md.docu" if File.exist? "TEST-README.md.docu"
+        File.delete "TEST-README.md" if File.exist? "TEST-README.md"
+      end
+
+      it "has a default name" do
+        Task.new.name.must_equal :docu
+      end
+
+      it "can have any name" do
+        Task.new(:execute_scripts).name.must_equal :execute_scripts
+      end
+
+      it "yields self" do
+        yielded_task = nil
+        task = Task.new do |t|
+          yielded_task = t
+        end
+        yielded_task.must_equal task
+      end
+
+      it "executes documentation" do
+        task = Task.new(:docu_test)
+        task.file = "TEST-README.md.docu"
+        File.open("TEST-README.md.docu", "w") { |f| f.write("example") }
+        ::Rake::Task[:docu_test].invoke
+        File.exist?("TEST-README.md").must_equal true
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docu
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-11-24 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70235153514700 !ruby/object:Gem::Requirement
+  requirement: &70339569711840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70235153514700
+  version_requirements: *70339569711840
 description: ''
 email:
 - andrew.vos@gmail.com
@@ -40,8 +40,10 @@ files:
 - docu.gemspec
 - lib/docu.rb
 - lib/docu/executes_examples.rb
+- lib/docu/rake/task.rb
 - lib/docu/version.rb
 - spec/docu/executes_examples_spec.rb
+- spec/docu/rake/task_spec.rb
 homepage: ''
 licenses: []
 post_install_message: 
@@ -68,3 +70,4 @@ specification_version: 3
 summary: ''
 test_files:
 - spec/docu/executes_examples_spec.rb
+- spec/docu/rake/task_spec.rb