qed 1.0.0

data/lib/qed/script.rb

@@ -0,0 +1,179 @@
+module QED
+  require 'facets/dir/ascend'
+
+  require 'ae'
+
+  require 'qed/reporter/dotprogress'
+  require 'qed/reporter/summary'
+  require 'qed/reporter/verbatim'
+
+  #Assertion   = AE::Assertion
+  Expectation = Assertor
+
+  # New Specification
+  #def initialize(specs, output=nil)
+  #  @specs  = [specs].flatten
+  #end
+
+  # = Script
+  #
+  class Script
+
+    #def self.load(file, output=nil)
+    #  new(File.read(file), output)
+    #end
+
+    attr :file
+    attr :output
+
+    # New Script
+    def initialize(file, output=nil)
+      @file   = file
+      @source = File.read(file)
+      @output = output || Reporter::Verbatim.new #(self)
+    end
+
+    #def convert
+    #  @source.gsub(/^\w/, '# \1')
+    #end
+
+    # Run the script.
+    def run
+      #steps = @source.split(/\n\s*$/)
+      steps.each do |step|
+        output.report_step(step)
+        case step
+        when /^[=#]/
+          output.report_header(step)
+        when /^\S/
+          output.report_comment(step)
+        else
+          run_step(step)
+        end
+      end
+    end
+
+    #
+    def run_step(step, &blk)
+      context.before.call if context.before
+      begin
+        if blk
+          blk.call #eval(step, context._binding)
+        else
+          eval(step, context._binding, @file) # TODO: would be nice to know file and lineno here
+        end
+        output.report_pass(step)
+      rescue Assertion => error
+        output.report_fail(step, error)
+      rescue Exception => error
+        output.report_error(step, error)
+      ensure
+        context.after.call if context.after
+      end
+    end
+
+    # Cut-up script into steps.
+    def steps
+      @steps ||= (
+        code  = false
+        str   = ''
+        steps = []
+        @source.each_line do |line|
+          if /^\s*$/.match line
+            str << line
+          elsif /^[=]/.match line
+            steps << str.chomp("\n")
+            steps << line.chomp("\n")
+            str = ''
+            #str << line
+            code = false
+          elsif /^\S/.match line
+            if code
+              steps << str.chomp("\n")
+              str = ''
+              str << line
+              code = false
+            else
+              str << line
+            end
+          else
+            if code
+              str << line
+            else
+              steps << str
+              str = ''
+              str << line
+              code = true
+            end
+          end
+        end
+        steps << str
+        steps
+      )
+    end
+
+    # The run context.
+    def context
+      @context ||= Context.new(self)
+    end
+
+  end
+
+  #
+  class Context < Module
+
+    def initialize(script)
+      @_script = script
+    end
+
+    def _binding
+      @_binding ||= binding
+    end
+
+    # Set before step.
+    def before(&f)
+      @_before = f if f
+      @_before
+    end
+
+    # Set after step.
+    def after(&f)
+      @_after = f if f
+      @_after
+    end
+
+    # Table-based steps.
+    def table(file=nil, &blk)
+      require 'yaml'
+
+      file ||= File.basename(@_script.file).chomp(File.extname(@_script.file)) + '.yaml'
+
+      Dir.ascend(Dir.pwd) do |path|
+        f1 = File.join(path, file)
+        f2 = File.join(path, 'fixtures', file)
+        fr = File.file?(f1) ? f1 : File.exist?(f2) ? f2 : nil
+        (file = fr; break) if fr
+      end
+
+      tbl = YAML.load(File.new(file))
+      tbl.each do |set|
+        @_script.run_step(set.to_yaml.tabto(2)){ blk.call(set) }
+        #@_script.output.report_table(set)
+      end
+    end
+
+    def fixture(fname, content=nil)
+      raise if File.directory?(fname)
+      if content
+        FileUtils.mkdir_p(File.dirname(fname))
+        File.open(fname, 'w'){ |f| f << content }
+      else
+        raise LoadError, "no such fixture file -- #{fname}" unless File.exist?(fname)
+        File.read(fname)
+      end
+    end
+
+  end
+
+end
+

data/lib/qed/utilities/extract.rb

@@ -0,0 +1,137 @@
+require 'fileutils'
+
+raise "not ready yet"
+
+module QED
+
+  # Extractor is a tool for extracting code from embedded
+  # comment blocks.
+  #
+  # TODO:
+  #   - Should extract_block handle more than the first matching block?
+  #   - How can we handle embedded code in standard comments? Eg. #
+  #
+  module Extract
+
+    extend self
+
+    # Extract unit tests. This task scans every package script
+    # looking for sections of the form:
+    #
+    #     =begin test
+    #       ...
+    #     =end
+    #
+    # With appropriate headers, it copies these sections to files
+    # in your project's test/ dir, which then can be run using the
+    # Ratchet test task. The exact directory layout of the files to
+    # be tested is reflected in the test directory. You can then
+    # use project.rb's test task to run the tests.
+    #
+    #     files      Files to extract ['lib/**/*.rb']
+    #     output     Test directory   ['test/']
+    #
+
+    def test_extract(files=nil)
+      output = 'test/embedded'     # Don't think output should be setable.
+
+      files  = files || 'lib/**/*.rb'
+      files = 'lib/**/*.rb' if TrueClass == files
+      files = [files].flatten.compact
+
+      filelist = files.collect{ |f| Dir.glob(f) }
+      filelist.flatten!
+      if filelist.empty?
+        puts "No scripts found from which to extract tests."
+        return
+      end
+
+      FileUtils.mkdir_p(output) unless File.directory?(output)
+
+      #vrunner = VerbosityRunner.new("Extracting", verbosity?)
+      #vrunner.setup(filelist.size)
+
+      filelist.each do |file|
+        #vrunner.prepare(file)
+
+        testing = extract_test_from_file( file )
+        if testing.strip.empty?
+          status = "[NONE]"
+        else
+          complete_test = create_test(testing, file)
+          libpath = File.dirname(file)
+          testfile = "test_" + File.basename(file)
+          fp = File.join(output, libpath, testfile)
+          unless File.directory?( File.dirname(fp))
+            FileUtils.mkdir_p(File.dirname(fp))
+          end
+          File.open(fp, "w"){ |fw| fw << complete_test }
+          status = "[TEST]"
+        end
+
+        #vrunner.complete(file, status)
+      end
+
+      #vrunner.finish(
+      #  :normal => "#{filelist.size} files had tests extracted.",
+      #  :check => false
+      #)
+    end
+
+    private
+
+    # Extract test from a file's testing comments.
+
+    def extract_test_from_file(file)
+      return nil if ! File.file?(file)
+      tests = ""; inside = false
+      fstr = File.read(file)
+      fstr.split(/\n/).each do |l|
+        if l =~ /^=begin[ ]*test/i
+          tests << "\n"
+          inside = true
+          next
+        elsif inside and l =~ /^=[ ]*end/
+          inside = false
+          next
+        end
+        if inside
+          tests << l << "\n"
+        end
+      end
+      tests
+    end
+
+    # Generate the test.
+
+    def create_test(testing, file)
+      fp = file.split(/[\/]/)
+      if fp[0] == 'lib'
+        reqf = "require '#{fp[1..-1].join('/')}'"
+      else
+        reqf = ''
+      end
+      teststr = []
+      teststr << "#  _____         _"
+      teststr << "# |_   _|__  ___| |_"
+      teststr << "#   | |/ _ \\/ __| __|"
+      teststr << "#   | |  __/\\__ \\ |_"
+      teststr << "#   |_|\\___||___/\\__|"
+      teststr << "#"
+      teststr << "# for #{file}"
+      teststr << "#"
+      teststr << "# Extracted #{Time.now}"
+      teststr << "# Project.rb Test Extraction"
+      teststr << "#"
+      teststr << ""
+      teststr << "#{reqf}"
+      teststr << ""
+      teststr << testing
+      teststr << ""
+      teststr.join("\n")
+    end
+
+  end #module Extract
+
+end #module Quarry
+

data/lib/qed/utilities/monitor.rb

@@ -0,0 +1,23 @@
+BEGIN {
+   module Kernel
+
+     h = Hash.new
+
+     define_method(:requiree) do
+       h
+     end
+
+     r = method :require
+
+     define_method(:require) do |a|
+       r.call(a)
+       h[a] = caller
+     end
+
+   end
+}
+
+
+def p(*args)
+  super *(args << caller[0])
+end

data/meta/authors

@@ -0,0 +1 @@
+Thomas Sawyer <transfire@gmail.com>

data/meta/created

@@ -0,0 +1 @@
+2006-12-16

data/meta/description

@@ -0,0 +1,2 @@
+QED (Quality Enahancing Demos) is a slick Interface-Driven Development
+(IDD) system utilizing Literate Programming concepts.

data/meta/homepage

@@ -0,0 +1 @@
+http://proutils.rubyforge.org/qed

data/meta/package

@@ -0,0 +1 @@
+qed

data/meta/project

@@ -0,0 +1 @@
+proutils

data/meta/requires

@@ -0,0 +1 @@
+ae

data/meta/ruby

@@ -0,0 +1,2 @@
+- 1.8.6
+- 1.8.7

data/meta/summary

@@ -0,0 +1 @@
+Quality Enhanced Demos

data/meta/title

@@ -0,0 +1 @@
+QED

data/meta/version

@@ -0,0 +1 @@
+1.0.0

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification 
+name: qed
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Thomas Sawyer <transfire@gmail.com>
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-04 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ae
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: |-
+  QED (Quality Enahancing Demos) is a slick Interface-Driven Development
+  (IDD) system utilizing Literate Programming concepts.
+email: Thomas Sawyer <transfire@gmail.com>
+executables: 
+- qedoc
+- qed
+extensions: []
+
+extra_rdoc_files: 
+- MANIFEST
+- LICENSE
+- README.rdoc
+- HISTORY
+files: 
+- bin/qed
+- bin/qedoc
+- demo/01_spec.qed
+- demo/01_spec.yaml
+- demo/qed_helper.rb
+- doc/qedoc/index.html
+- doc/qedoc/jquery.js
+- lib/qed/assertion.rb
+- lib/qed/document/jquery.js
+- lib/qed/document/markup.rb
+- lib/qed/document/template.rhtml
+- lib/qed/document.rb
+- lib/qed/doubles/mock.rb
+- lib/qed/doubles/spy.rb
+- lib/qed/doubles/stub.rb
+- lib/qed/expectation.rb
+- lib/qed/grammar/assert.rb
+- lib/qed/grammar/expect.rb
+- lib/qed/grammar/legacy/assert.rb
+- lib/qed/grammar/should.rb
+- lib/qed/reporter/base.rb
+- lib/qed/reporter/dotprogress.rb
+- lib/qed/reporter/summary.rb
+- lib/qed/reporter/verbatim.rb
+- lib/qed/runner.rb
+- lib/qed/script.rb
+- lib/qed/utilities/extract.rb
+- lib/qed/utilities/monitor.rb
+- lib/qed.rb
+- meta/authors
+- meta/created
+- meta/description
+- meta/homepage
+- meta/package
+- meta/project
+- meta/requires
+- meta/ruby
+- meta/summary
+- meta/title
+- meta/version
+- LICENSE
+- README.rdoc
+- HISTORY
+- MANIFEST
+has_rdoc: true
+homepage: http://proutils.rubyforge.org/qed
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --title
+- qed api
+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: proutils
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Quality Enhanced Demos
+test_files: []
+