CommentUnit 0.0.1

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2008 Blaine Buxton
+
+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

@@ -0,0 +1,43 @@
+### Comment Unit Tests
+### Author:: Blaine Buxton  (mailto:altodorado@blainebuxton.com)
+### Copyright:: Copyright (c) 2008
+### License::   See LICENSE
+###
+### This is a simple framework that hooks into Test::Unit and RDoc. 
+### It allows you to write arbitrary bits of code in comments that can be 
+### executed and then verified via Test::Unit. It uses the RDoc parser to obtain
+### the comments.
+###
+### Any comments are appreciated (pun not intended)
+###
+### To invoke:
+### require 'comment_unit'
+### class YourTest < Test::Unit::TestCase
+###    def self.suite
+###     suite=super
+###     suite << RUnitComment.on($0)
+###     suite
+###   end
+### end
+###
+### Examples:
+### >>> 3 + 4
+### >>= 7
+###
+### >>> 42
+### >>= 42
+###
+### >>> a='i'
+### >>> b=' love '
+### >>> c='michelle'
+### >>> a + b + c
+### >>= 'i love michelle'
+###
+### >>> a + ', robot will never die'
+### >>= 'i, robot will never die'
+###
+### >>> a = 5
+### >>> b = 4 + 1
+### >>? a == b
+###
+### >>> puts 'Comments Ran'

data/lib/assert_equal_result_part.rb

@@ -0,0 +1,12 @@
+module CommentUnit
+  class AssertEqualResultPart < ExecutablePart
+    def self.prefix()
+    '>>='
+    end
+    
+    private
+    def assert(test_case, expected, actual)
+      test_case.assert_equal(expected, actual, failure_text())
+    end
+  end
+end

data/lib/assert_result_part.rb

@@ -0,0 +1,12 @@
+module CommentUnit
+  class AssertResultPart < ExecutablePart
+    def self.prefix()
+    '>>?'
+    end
+    
+    private
+    def assert(test_case, expected, actual)
+      test_case.assert(actual, failure_text())
+    end
+  end
+end

data/lib/comment_part.rb

@@ -0,0 +1,91 @@
+module CommentUnit
+  class CommentPart
+    @@mapping=nil
+    @@matcher=nil
+    @@subclasses=[]
+    
+    attr_reader :content
+    
+    public
+    def self.parse(comment_string)
+      previous_part = nil
+      comment_string.inject([]) do |results, line|
+        part = parse_part(line)
+        if (!previous_part.nil? && previous_part.can_combine?(part))
+          previous_part.combine_with(part)
+        else 
+          unless part.nil?
+            results << part 
+            previous_part = part
+          end
+        end
+        results
+      end
+    end
+    
+    def to_s
+    "#{self.class}[#{@content}]"
+    end
+    
+    def can_combine?(another)
+      false
+    end
+    
+    def combine_with(another)
+      @content << ';' << another.content
+    end
+    
+    private
+    def self.parse_part(line)
+      match = self.matcher.match(line)
+      if (match)
+        create_part(match[1], match[2])
+      else
+        nil
+      end
+    end
+    
+    def self.create_part(prefix, content)
+      klass = self.mapping[prefix]
+      klass.new(content) unless klass.nil?
+    end
+    
+    def self.inherited(new_class)
+      super
+      @@mapping=nil
+      @@matcher=nil
+      @@subclasses << new_class
+    end
+    
+    def self.mapping()
+      @@mapping unless @@mapping.nil?
+      @@mapping = @@subclasses.inject({}) do |result, each| 
+        result[each.prefix]=each unless each.prefix.nil?
+        result
+      end
+    end
+    
+    def self.matcher()
+      @@matcher unless @@matcher.nil?
+      first=true
+      matcher_string = @@subclasses.inject('\s*(') do |result, each| 
+        result << '|' unless first
+        unless each.prefix.nil?
+          result << each.prefix.gsub(/[\?]/) { |each| "\\" + each }
+          first = false
+        end
+        result
+      end
+      matcher_string << ')\s*(.*)'
+      @@matcher = Regexp.new(matcher_string)
+    end
+    
+    def self.prefix()
+      nil
+    end
+    
+    def initialize(content)
+      @content=content
+    end
+  end
+end

data/lib/comment_unit.rb

@@ -0,0 +1,58 @@
+###
+### Comment Unit Tests
+### Author:: Blaine Buxton  (mailto:altodorado@blainebuxton.com)
+### Copyright:: Copyright (c) 2005-2006
+### License::   Distributes under MIT License (See LICENSE file)
+###
+### This is a simple framework that hooks into Test::Unit and RDoc. 
+### It allows you to write arbitrary bits of code in comments that can be 
+### executed and then verified via Test::Unit. It uses the RDoc parser to obtain
+### the comments.
+###
+### Any comments are appreciated (pun not intended)
+###
+### To invoke:
+### require 'comment_unit'
+### class YourTest < Test::Unit::TestCase
+###    def self.suite
+###     suite=super
+###     suite << RUnitComment.on($0)
+###     suite
+###   end
+### end
+###
+### Examples:
+### >>> 3 + 4
+### >>= 7
+###
+### >>> 42
+### >>= 42
+###
+### >>> a='i'
+### >>> b=' love '
+### >>> c='michelle'
+### >>> a + b + c
+### >>= 'i love michelle'
+###
+### >>> a + ', robot will never die'
+### >>= 'i, robot will never die'
+###
+### >>> a = 5
+### >>> b = 4 + 1
+### >>? a == b
+###
+### >>> puts 'Comments Ran'
+
+require 'rdoc/rdoc'
+require 'test/unit'
+
+
+
+require 'comments'
+require 'comment_part'
+require 'executable_part'
+require 'run_part'
+require 'assert_equal_result_part'
+require 'assert_result_part'
+require 'extensions'
+require 'runit_comment'

data/lib/comments.rb

@@ -0,0 +1,21 @@
+module CommentUnit
+  class Comments
+    public
+    def self.parse(comment_string)
+      new(CommentPart.parse(comment_string))
+    end
+    
+    def run_tests(test_case)
+      test_binding=blank_binding()
+      @parts.inject(nil) {|previous, every| every.run(test_case, previous, test_binding) }
+    end
+    
+    private
+    def new(*arguments)
+      super
+    end
+    def initialize(parts)
+      @parts=parts
+    end
+  end
+end

data/lib/executable_part.rb

@@ -0,0 +1,21 @@
+module CommentUnit
+  class ExecutablePart < CommentPart
+    def run(test_case, expected, test_binding=blank_binding())
+      result = execute(test_binding)
+      assert(test_case, expected, result)
+      result
+    end
+    
+    private
+    def assert(test_case, expected, actual)
+    end
+    
+    def execute(my_binding=blank_binding())
+      eval(@content, my_binding)
+    end
+    
+    def failure_text()
+    "Failure in #{self.class.prefix} #{@content}"
+    end
+  end
+end

data/lib/extensions.rb

@@ -0,0 +1,24 @@
+module RDoc
+  class Context
+    def each_comment(&proc)
+      super
+      comment_proc=lambda do |each|
+        each.each_comment(&proc) unless each.nil?
+      end
+      each_classmodule(&comment_proc)
+      each_method(&comment_proc)
+      each_attribute(&comment_proc)
+      each_constant(&comment_proc)
+    end
+  end
+  
+  class CodeObject
+    def each_comment(&proc)
+      proc.call(self.comment) unless self.comment.nil? || self.comment.empty?
+    end
+  end
+end
+
+def blank_binding()
+  binding().clone()
+end

data/lib/run_part.rb

@@ -0,0 +1,11 @@
+module CommentUnit
+  class RunPart < ExecutablePart
+    def self.prefix()
+    '>>>'
+    end
+    
+    def can_combine?(another)
+      another.is_a? self.class
+    end
+  end
+end

data/lib/runit_comment.rb

@@ -0,0 +1,31 @@
+class RUnitComment < Test::Unit::TestCase
+  attr_accessor :file_name
+  
+  def self.on(file_name)
+    result = self.new(:execute_all_comments)
+    result.file_name = file_name
+    result
+  end
+  
+  def run(result)
+    return if self.file_name.nil?
+    super
+  end
+  
+  def execute_all_comments
+    self.parse_comments unless @top_level
+    @top_level.each_comment do |each|
+      CommentUnit::Comments.parse(each).run_tests(self)
+    end
+  end
+  
+  def parse_comments
+    @top_level=RDoc::TopLevel.new(self.file_name)
+    stats=RDoc::Stats.new
+    options=Options.instance
+    options.instance_eval { @tab_width = 2 }
+    content=File.open(file_name, 'r') { |file| file.read }
+    parser = RDoc::ParserFactory.parser_for(@top_level, self.file_name, content, options, stats)
+    parser.scan
+  end
+end

data/tests/comment_part_test.rb

@@ -0,0 +1,40 @@
+module CommentUnit
+  class CommentPartTest < Test::Unit::TestCase
+    def test_simple
+      comment = <<DOC
+#blah blah
+#>>>3 + 4
+#>>=7
+#>>?42 == 42
+DOC
+      comments = CommentPart.parse(comment)
+      assert_equal('3 + 4', comments[0].content)
+      assert(comments[0].is_a?(RunPart))
+      assert_equal(7, comments[0].run(self, nil))
+      assert_equal('7', comments[1].content)
+      assert(comments[1].is_a?(AssertEqualResultPart))
+      assert_equal(7, comments[1].run(self, 7))
+      assert_equal('42 == 42', comments[2].content)
+      assert(comments[2].is_a?(AssertResultPart))
+      assert_equal(true, comments[2].run(self, nil))
+    end
+    
+    def test_combine
+      comment = <<DOC
+#>>>a = 3
+#Noise here
+#>>>b = 4
+#>>>a + b
+#the result is here
+#>>=7
+DOC
+      comments = CommentPart.parse(comment)
+      assert_equal('a = 3;b = 4;a + b', comments[0].content)
+      assert(comments[0].is_a?(RunPart))
+      assert_equal(7, comments[0].run(self, nil))
+      assert_equal('7', comments[1].content)
+      assert(comments[1].is_a?(AssertEqualResultPart))
+      comments[1].run(self, 7)
+    end
+  end
+end

data/tests/comment_unit_test_suite.rb

@@ -0,0 +1,24 @@
+MY_DIR = File.expand_path(File.dirname(__FILE__))
+
+def lib_require(name)
+  begin
+    require name
+  rescue LoadError
+    $LOAD_PATH << File.expand_path(File.join(MY_DIR, '..', 'lib'))
+    require name
+  end
+end
+
+def tests_require(name)
+  begin
+    require name
+  rescue LoadError
+    $LOAD_PATH << MY_DIR
+    require name
+  end
+end
+
+lib_require 'comment_unit'
+tests_require 'comment_part_test'
+tests_require 'comments_test'
+tests_require 'rdoc_test'

data/tests/comments_test.rb

@@ -0,0 +1,19 @@
+module CommentUnit
+  class CommentsTest < Test::Unit::TestCase
+    def test_simple()
+      comment = <<DOC
+#>>>a=3
+#>>=3
+#
+#>>>b=4
+#>>=4
+#
+#>>>a + b
+#>>=7
+#>>?(a + b) == 7
+DOC
+      comments = Comments.parse(comment)
+      comments.run_tests(self)
+    end
+  end
+end

data/tests/rdoc_test.rb

@@ -0,0 +1,13 @@
+class RDocTest < Test::Unit::TestCase
+  def test_placebo
+  end
+  
+  def self.suite
+    suite=super
+    my_dir=File.dirname(__FILE__)
+    to_run=File.join(my_dir, '..', 'lib', 'comment_unit.rb')
+    to_run=File.expand_path(to_run)
+    suite << RUnitComment.on(to_run)
+    suite
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: CommentUnit
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Blaine Buxton
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-06-20 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: 
+email: altodorado@blainebuxton
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+files: 
+- tests/comment_part_test.rb
+- tests/comment_unit_test_suite.rb
+- tests/comments_test.rb
+- tests/rdoc_test.rb
+- lib/assert_equal_result_part.rb
+- lib/assert_result_part.rb
+- lib/comment_part.rb
+- lib/comment_unit.rb
+- lib/comments.rb
+- lib/executable_part.rb
+- lib/extensions.rb
+- lib/run_part.rb
+- lib/runit_comment.rb
+- README
+- LICENSE
+has_rdoc: true
+homepage: http://commentunit.rubyforge.org/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: commentunit
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Write RUnit Tests in Comments
+test_files: 
+- tests/comment_unit_test_suite.rb