synthesis 0.2.0 → 0.2.1

data/{README → README.rdoc}

@@ -34,6 +34,8 @@ Synthesis can be setup to ignore certain classes or modules when collecting expe
 
 If +pattern+ is not specified, it will default to <tt>test/**/*_test.rb</tt>
 
+As of version 0.2.0, Synthesis has a +DOT+ formatter which, when used, will output text in the DOT graph description language, producing system visualizations as specified by the simulated interactions in the system's tests. The output of the +DOT+ formatter can be used with tools like Graphviz( http://www.graphviz.org/ ).
+
 == Usage examples
 
 To use with Test::Unit and Mocha, ignoring Array and Hash:
@@ -54,7 +56,7 @@ To use with RSpec, running all specs in the <tt>spec</tt> directory:
     t.pattern = 'spec/**/*_spec.rb'
   end
 
-To use with Expectations, redirecting output to a file
+To use with Expectations, redirecting output to a file:
 
   require "synthesis/task"
 	
@@ -62,6 +64,29 @@ To use with Expectations, redirecting output to a file
     t.adapter = :expectations
     t.out = File.new "synthesis.test.txt", "a"
   end
+  
+To output a DOT graph, first make sure you have sexp_processor installed:
+
+  sudo gem install sexp_processor
+
+Then, to output a file called "synthesis.dot", do (if formatter_out is not specified, the default ouput is STDOUT):
+
+  require "synthesis/task"
+	
+  Synthesis::Task.new do |t|
+    t.formatter = :dot
+    t.formatter_out = "synthesis.dot"
+  end
+
+To use Synthesis with Rails:
+
+  require "synthesis/task"
+
+  Synthesis::Task.new do |t|
+    RAILS_ENV = "test"
+    Rake::Task['environment'].invoke # This loads the Rails environment, which may make your build slower. Use only if needed
+    t.pattern = 'test/**/*_test.rb'
+  end
 
 == Utilities
 

data/Rakefile

@@ -13,7 +13,7 @@ task :test => %w[test:core test:mocha test:spec]
 
 desc "Run core tests"
 Rake::TestTask.new('test:core') do |t|
-  t.pattern = 'test/synthesis/*_test.rb'
+  t.pattern = '{test/synthesis/,test/synthesis/formatter/}*_test.rb'
 end
 
 desc "Run Mocha adapter tests"

data/lib/synthesis/formatter/dot.rb

@@ -4,22 +4,24 @@ require "sexp_processor"
 
 module Synthesis
   class DotFormatter < Formatter
-    def initialize
+    def initialize(out)
+      super
       Expectation::Expectation.send(:include, ExpectationReportFormat::Dot)
     end
     
     def digraph
-      puts "digraph synthesis_expectations {"
-      puts "  rankdir=LR;"
-      puts "  size=\"8,10\";"
-      puts "  ratio=\"fill\";"
-      puts "  node [shape = circle];"
-      puts "  edge [color = green]"
+      @out.puts "digraph synthesis_expectations {"
+      @out.puts "  rankdir=LR;"
+      @out.puts "  size=\"10,10\";"
+      @out.puts "  ratio=\"fill\";"
+      @out.puts "  remincross=\"true\";"
+      @out.puts "  node [shape = circle];"
+      @out.puts "  edge [color = green]"
       report_tested_expectations
-      puts
-      puts "  edge [color = red]"
+      @out.puts
+      @out.puts "  edge [color = red]"
       report_untested_expectations
-      puts "}"
+      @out.puts "}"
     end
     alias format_failure digraph
     alias format_success digraph
@@ -85,6 +87,13 @@ module Synthesis
           @klazz = @ancestors * '::' if name == method.to_sym
           s(:defn, name, process(exp.shift), process(exp.shift))
         end
+
+        def process_defs(exp)
+          selff = exp.shift
+          name = exp.shift
+          @klazz = @ancestors * '::' if name == method.to_sym
+          s(:defs, selff, name, process(exp.shift), process(exp.shift))
+        end
       end
     end
   end

data/lib/synthesis/formatter/text.rb

@@ -2,22 +2,27 @@ module Synthesis
   class TextFormatter < Formatter
     include Logging
     
-    def initialize
+    def initialize(out)
+      super
       Expectation::Expectation.send(:include, ExpectationReportFormat::Text)
     end
     
     def format_success
-      log; log "Verified #{ExpectationRecord.expectations.size} expectations"
-      log "SUCCESS."
+      @out.puts "[Synthesis] "
+      @out.puts "[Synthesis] Verified #{ExpectationRecord.expectations.size} expectations"
+      @out.puts "[Synthesis] SUCCESS."
     end
 
     def format_failure
-      log; log "Tested Expectations: "
+      @out.puts "[Synthesis] "
+      @out.puts "[Synthesis] Tested Expectations: "
       report_tested_expectations
-      log; log "Untested Expectations: "
+      @out.puts "[Synthesis] "
+      @out.puts "[Synthesis] Untested Expectations: "
       report_untested_expectations
-      log "Ignoring: #{ExpectationRecord.ignored.to_a * ', '}"
-      log; log "FAILED."
+      @out.puts "[Synthesis] Ignoring: #{ExpectationRecord.ignored.to_a * ', '}"
+      @out.puts "[Synthesis] "
+      @out.puts "[Synthesis] FAILED."
     end
   end
   

data/lib/synthesis/formatter.rb

@@ -1,16 +1,20 @@
 module Synthesis
   class Formatter
+    def initialize(out)
+      @out = out
+    end
+    
     def report_tested_expectations
-      ExpectationRecord.tested_expectations.each { |e| puts e.to_report }
+      ExpectationRecord.tested_expectations.each { |e| @out.puts e.to_report }
     end
     
     def report_untested_expectations
-      ExpectationRecord.untested_expectations.each { |e| puts e.to_report }
+      ExpectationRecord.untested_expectations.each { |e| @out.puts e.to_report }
     end
     
     class << self
-      def load
-        @formatter.new
+      def load(out)
+        @formatter.new(out)
       end
     
       def inherited(subclass)

data/lib/synthesis/reporter.rb

@@ -1,13 +1,25 @@
 module Synthesis
   class Reporter
-    def self.report
-      formatter = Formatter.load
-      if ExpectationRecord.has_untested_expectations?
-        formatter.format_failure
-        return -1
+    def self.report(format, formatter_out)
+      begin
+        require "synthesis/formatter/#{format}"
+      rescue LoadError
+        raise "Invalid format: #{format}"
       end
-      formatter.format_success
-      0
+      out = formatter_out ? File.open(formatter_out, 'w') : STDOUT
+      result = 0
+      begin
+        formatter = Formatter.load(out)
+        if ExpectationRecord.has_untested_expectations?
+          formatter.format_failure
+          result = -1
+        else
+          formatter.format_success
+        end
+      ensure
+        out.close unless out == STDOUT
+      end
+      return result
     end
   end
 end

data/lib/synthesis/runner.rb

@@ -1,10 +1,13 @@
 module Synthesis
   class Runner
-    def self.run(adapter, pattern, formatter)
-      require "synthesis/adapter/#{adapter}"
-      require "synthesis/formatter/#{formatter}"
+    def self.run(adapter, pattern, formatter, formatter_out)
+      begin
+        require "synthesis/adapter/#{adapter}"
+      rescue LoadError
+        raise "Invalid adapter: #{adapter}"
+      end
       Adapter.load(pattern).run
-      at_exit { Reporter.report unless $! }
+      at_exit { Reporter.report(formatter, formatter_out) unless $! }
     end    
   end
 end

data/lib/synthesis/task.rb

@@ -7,7 +7,7 @@ module Synthesis
   class Task < Rake::TaskLib
     include Logging
     attr_accessor :verbose, :pattern, :ruby_opts
-    attr_accessor :adapter, :out, :ignored, :libs, :formatter
+    attr_accessor :adapter, :out, :ignored, :libs, :formatter, :formatter_out
 
     def initialize(name='synthesis:test')
       @name, @ignored, @libs = name, [], []
@@ -39,7 +39,7 @@ module Synthesis
           require File.dirname(__FILE__) + "/../synthesis/runner"
           Synthesis::Logging.const_set(:OUT, @out) if @out
           Synthesis::ExpectationRecord.ignore(*@ignored)
-          Synthesis::Runner.run(@adapter, @pattern, @formatter)
+          Synthesis::Runner.run(@adapter, @pattern, @formatter, @formatter_out)
         end
       end
       self

data/synthesis.gemspec

@@ -1,19 +1,19 @@
 GEMSPEC =Gem::Specification.new do |s|
   s.name = 'synthesis'
-  s.version = '0.2.0'
+  s.version = '0.2.1'
   s.platform = Gem::Platform::RUBY
   s.rubyforge_project = "synthesis"
   s.summary, s.description = 'A tool for Synthesized Testing'
-  s.authors = 'Stuart Caborn, George Malamidis'
+  s.authors = 'Stuart Caborn, George Malamidis, Danilo Sato'
   s.email = 'george@nutrun.com'
   s.homepage = 'http://synthesis.rubyforge.org'
   s.has_rdoc = true
-  s.rdoc_options += ['--quiet', '--title', 'Synthesis', '--main', 'README', '--inline-source']
-  s.extra_rdoc_files = ['README', 'COPYING']
+  s.rdoc_options += ['--quiet', '--title', 'Synthesis', '--main', 'README.rdoc', '--inline-source']
+  s.extra_rdoc_files = ['README.rdoc', 'COPYING']
   s.files = [
     "COPYING",
     "Rakefile",
-    "README",
+    "README.rdoc",
     "synthesis.gemspec",
     "lib/synthesis/adapter/expectations.rb",
     "lib/synthesis/adapter/mocha.rb",

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: synthesis
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
-- Stuart Caborn, George Malamidis
+- Stuart Caborn, George Malamidis, Danilo Sato
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2008-11-01 00:00:00 +00:00
+date: 2008-11-13 00:00:00 +00:00
 default_executable: 
 dependencies: []
 
@@ -20,12 +20,12 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README
+- README.rdoc
 - COPYING
 files: 
 - COPYING
 - Rakefile
-- README
+- README.rdoc
 - synthesis.gemspec
 - lib/synthesis/adapter/expectations.rb
 - lib/synthesis/adapter/mocha.rb
@@ -60,7 +60,7 @@ rdoc_options:
 - --title
 - Synthesis
 - --main
-- README
+- README.rdoc
 - --inline-source
 require_paths: 
 - lib