comment_tester 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 434c90a0584ec6c3ee606397de58c52db244dbcd
+  data.tar.gz: 4ee6fbc6a304e54052f6b6c2bb4ee1c352c04b6d
+SHA512:
+  metadata.gz: d569191b50f972b1b6d10e36ffc4361d0542cc116ee0509aaf60993c135055eedce02d155fae27fe167aa39e3cf32d75342f4b7575fded706ad5f15b845e52e8
+  data.tar.gz: e0781e070b027bd05ad850aac33a3ab14c4ed2782cc8aa3189c2c1573a08a9c974064905f6d91ff8b2f91df69984ed8feda5f998fc093aa7e6e09cf95df39b70

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2013, Michael H. Buselli
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ''AS IS'' AND ANY
+EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README

@@ -0,0 +1,42 @@
+# Copyright (c) 2013, Michael H. Buselli
+# See LICENSE for details.  All other rights reserved.
+#
+# ruby_comment_tester works by auto-generating Ruby test-unit files from
+# the comments of a Ruby program.  The idea is that you mimic what you
+# would type into irb that could provide a test.  In doing so, you write
+# both a test and document the behavior of your program or method in the
+# same place.  Some example test comments are as follows:
+
+# Code and assertions in the same comment block are grouped into
+# a single test.
+#
+# irb> a = "123"
+# irb> b = a.split(/2/)
+# => ["1", "3"]
+#
+# irb> b.map(&:to_i).inject(0) { |s, x| s + x } + 38
+# => 42
+
+# Variables are not sticky between tests, and you can also test for
+# exceptions or thrown objects with raises=> and throws=>.
+#
+# irb> a
+# raises=> NameError
+# irb> throw :catch_me
+# throws=> :catch_me
+
+# Sometimes you have to initialize something for your code or tests to
+# work.  Use irb-setup> for that.
+#
+# irb-setup> puts "This runs outside the tests before code or tests are loaded."
+# irb> [:hello, :world].map { |s| s.to_s.capitalize }.join(" ")
+# => "Hello World"
+
+# You can comment out tests with double hashes of any sort.
+#
+# # irb> this won't run
+# # => foo
+## irb> neither does this
+## => bar
+
+# You can run the above tests by running this program on itself.

data/bin/ruby_comment_tester

@@ -0,0 +1,145 @@
+#!/usr/bin/env ruby
+#
+# Copyright (c) 2013, Michael H. Buselli
+# See LICENSE for details.  All other rights reserved.
+#
+# ruby_comment_tester works by auto-generating Ruby test-unit files from
+# the comments of a Ruby program.  The idea is that you mimic what you
+# would type into irb that could provide a test.  In doing so, you write
+# both a test and document the behavior of your program or method in the
+# same place.  Some example test comments are as follows:
+
+# Code and assertions in the same comment block are grouped into
+# a single test.
+#
+# irb> a = "123"
+# irb> b = a.split(/2/)
+# => ["1", "3"]
+#
+# irb> b.map(&:to_i).inject(0) { |s, x| s + x } + 38
+# => 42
+
+# Variables are not sticky between tests, and you can also test for
+# exceptions or thrown objects with raises=> and throws=>.
+#
+# irb> a
+# raises=> NameError
+# irb> throw :catch_me
+# throws=> :catch_me
+
+# Sometimes you have to initialize something for your code or tests to
+# work.  Use irb-setup> for that.
+#
+# irb-setup> puts "This runs outside the tests before code or tests are loaded."
+# irb> [:hello, :world].map { |s| s.to_s.capitalize }.join(" ")
+# => "Hello World"
+
+# You can comment out tests with double hashes of any sort.
+#
+# # irb> this won't run
+# # => foo
+## irb> neither does this
+## => bar
+
+# You can run the above tests by running this program on itself.
+
+require "pp" if ENV["DEBUG"]
+
+class CommentTester
+  class << self
+    def run (argv)
+      argv.each { |filename| run_one(filename) }
+    end
+
+    private
+
+    def run_one (filename)
+      eval(make_test_file(filename))
+      load(filename) unless filename == $0
+    end
+
+    def make_test_file (filename)
+      comment_groups = comment_extraction(filename)
+      test_file = %'require "test/unit"\nclass CommentTesterTestClass < Test::Unit::TestCase\n'
+
+      test_file << comment_groups.map do |cg|
+        comment_group_to_test_case(cg)
+      end.join
+
+      (test_file << "end\n").tap { |x| puts x if ENV["DEBUG"] }
+    end
+
+    def comment_extraction (filename)
+      comment_groups = []
+      last_line = :code
+      # or :comment, :test_setup, :test_code, :assertion, :assert_raise, :assert_throw
+
+      # Read the Ruby code file.
+      File.open(filename, "r") do |fh|
+        fh.each_line do |line|
+          if line =~ /\A\s*#/
+            if last_line == :code
+              comment_groups << []
+            end
+
+            if line =~ /\A\s*#\s*irb-setup>\s*(.*)\Z/
+              comment_groups[-1] << {test_setup: $1.chomp}
+              last_line = :test_setup
+            elsif line =~ /\A\s*#\s*irb>\s*(.*)\Z/
+              comment_groups[-1] << {test_code: $1.chomp}
+              last_line = :test_code
+            elsif line =~ /\A\s*#\s*=>\s*(.*)\Z/
+              raise "you can only use => after irb>" if last_line != :test_code
+              comment_groups[-1] << {assertion: $1.chomp}
+              last_line = :assertion
+            elsif line =~ /\A\s*#\s*raises=>\s*(.*)\Z/
+              raise "you can only use raises=> after irb>" if last_line != :test_code
+              comment_groups[-1][-1][:assert_raise] = $1.chomp
+              last_line = :assert_raise
+            elsif line =~ /\A\s*#\s*throws=>\s*(.*)\Z/
+              raise "you can only use throws=> after irb>" if last_line != :test_code
+              comment_groups[-1][-1][:assert_throw] = $1.chomp
+              last_line = :assert_throw
+            else
+              last_line = :comment
+            end
+          else
+            last_line = :code
+          end
+        end
+      end
+
+      comment_groups.reject { |a| a.size == 0 }.tap { |x| pp x if ENV["DEBUG"] }
+    end
+
+    def comment_group_to_test_case (comment_group)
+      @test_cases_made ||= 0
+      @test_cases_made += 1
+
+      test_body = comment_group.map do |comment_line_data|
+        raise_code = comment_line_data.delete(:assert_raise)
+        throw_code = comment_line_data.delete(:assert_throw)
+        line_type = comment_line_data.keys[0]
+        code = comment_line_data.values[0]
+
+        if line_type == :test_setup
+          Object.class_eval(code)
+        elsif line_type == :test_code
+          if raise_code
+            "assert_raise(#{raise_code}) { #{code} }"
+          elsif throw_code
+            "assert_throws(#{throw_code}) { #{code} }"
+          else
+            "@result_for_assertion = #{code}"
+          end
+        else
+          "assert_equal(#{code}, @result_for_assertion)"
+        end
+      end.join("\n    ")
+
+      "  def test_#{@test_cases_made}\n    #{test_body}\n  end\n"
+    end
+  end
+end
+
+CommentTester.run(ARGV)

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: comment_tester
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Michael H. Buselli
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-10 00:00:00.000000000 Z
+dependencies: []
+description: |
+  Write and run tests from your code comments
+email: cosine@cosine.org
+executables:
+- ruby_comment_tester
+extensions: []
+extra_rdoc_files: []
+files:
+- README
+- LICENSE
+- bin/ruby_comment_tester
+homepage: http://github.com/cosine/ruby_comment_tester
+licenses:
+- BSD
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: comment_tester
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Write and run tests from your code comments
+test_files: []