qed 1.3 → 2.0.0

data/Syckfile

@@ -1,70 +0,0 @@
----
-stats:
-  service  : Stats
-  title    : ~
-  loadpath : ~
-  exclude  : ~
-  output   : ~
-  active   : true
-
-box:
-  service: Box
-  active : true
-  types  : [ gem, tar ]
-  spec   : true
-  include: [ bin, demo, doc, lib, meta, test, "[A-Z]*" ]
-  exclude: [ doc/rdoc, doc/ri ]
-
-dnote:
-  service  : DNote
-  loadpath : ~
-  labels   : ~
-  output   : ~
-  format   : ~
-  active   : true
-
-email:
-  service : Email
-  file    : ~
-  subject : ~
-  mailto  :
-    - ruby-talk@ruby-lang.org
-    - proutils@googlegroups.com
-  from    : <%= ENV['EMAIL_ACCOUNT'] %>
-  server  : <%= ENV['EMAIL_SERVER'] %>
-  port    : <%= ENV['EMAIL_PORT'] %>
-  account : <%= ENV['EMAIL_ACCOUNT'] %>
-  domain  : <%= ENV['EMAIL_DOMAIN'] %>
-  login   : <%= ENV['EMAIL_LOGIN'] %>
-  secure  : <%= ENV['EMAIL_SECURE'] %>
-  active  : true
-
-ridoc:
-  service: RIDoc
-  include: ~
-  exclude: ~
-  active : true
-
-syntax:
-  service  : Syntax
-  loadpath : ~
-  exclude  : ~
-  active   : false
-
-testrb:
-  service  : TestUnit
-  tests    : ~
-  exclude  : ~
-  loadpath : ~
-  requires : ~
-  live     : false   
-  active   : false
-
-vclog:
-  service  : VClog
-  format   : html   # xml, txt
-  layout   : rel    # gnu
-  typed    : false
-  output   : ~
-  active   : false
-

data/demo/01_spec.qed

@@ -1,175 +0,0 @@
-= Standard Sections
-
-QED demos are light-weight specification documents, highly suitable
-to interface-driven design. The documents are divided up into
-clauses separated by blank lines. Clauses that are flush to the 
-left margin are always explanation or comment clauses. Indented
-clauses are always executable code.
-
-Each code section is executed in order of appearance, within a
-rescue wrapper that captures any failures or errors. If neither
-a failure or error occur then the code gets a "pass".
-
-For example, the following passes:
-
-    (2 + 2).assert == 4
-
-While the following would "fail", as indicated by the raising of 
-an Assertion error:
-
-    expect Assertion do
-      (2 + 2).assert == 5
-    end
-
-And this would have raised a NameError:
-
-    expect NameError do
-      nobody_knows_method
-    end
-
-= Neutral Code
-
-There is no means of specifying that a code clause is neutral code,
-i.e. that it should be executed but not tested. Thus far, such a
-feature has proven to be a YAGNI.
-
-= Defining Custom Assertions
-
-The context in which the QED code is run is a self-extended module, thus
-reusable macros can be created simply by defining a method.
-
-    def assert_integer(x)
-      x.assert.is_a? Integer
-    end
-
-Now lets try out our new macro definition.
-
-    assert_integer(4)
-
-Let's prove that it can also fail:
-
-    expect Assertion do
-      assert_integer("IV")
-    end
-
-= Helper File
-
-Helpers can be defined at the bottom of any QED document by placing the code
-after a triple-dash divider (ie. "---"). You can use that to load optional
-AE features, or define your own specialized assertion methods. Helpers
-can be defined in a separate files using +require+ or +load+ in the bottom
-section to import them. The bottom section is run first, before any the steps.
-
-= Before and After Clauses
-
-QED supports *before* and *after* clauses in a specification
-through the use of before and after code blocks. Before and after
-clauses are executed at the beginning and at the end of each
-subsequent step.
-
-We use a *before* clause if we want to setup some code at the
-start of each step.
-
-    a, z = nil, nil
-
-    Before do
-      a = "BEFORE"
-    end
-
-And an *after* clause to teardown objects after a step.
-
-    After do
-      z = "AFTER"
-    end
-
-Notice we assigned +a+ and +z+ before the block. This was to ensure
-their visibility in the scope later. Now, lets verify that the *before*
-and *after* clauses work.
-
-    a.assert == "BEFORE"
-
-    a = "A"
-    z = "Z"
-
-And now.
-
-    z.assert == "AFTER"
-
-There can only be one before or after clause at a time. So if we
-define a new *before* or *after* clause later in the document,
-it will replace the current clause(s) in use.
-
-As a demonstration of this:
-
-    Before do
-      a = "BEFORE AGAIN"
-    end
-
-We will see it is the case.
-
-    a.assert == "BEFORE AGAIN"
-
-Only use *before* and *after* clauses when necessary --specifications
-are generally more readable without them. Indeed, some developers
-make a policy of avoiding them altogether. YMMV.
-
-= External Data
-
-When creating testable demonstrations, there are times when sizable
-chunks of data are needed. It is convenient to store such data in
-a separate file. The +Data+ method makes is easy to load such files.
-
-    Data('data.txt').assert =~ /dolor/
-
-All files are found relative to the location of current document.
-
-= Tabular Steps
-
-The +Table+ method is similar to the +Data+ method except that it
-expects a YAML file, and it can take a block to iterate the data over.
-This makes it easy to test tables of examples.
-
-The arity of the table block corresponds to the number of columns in
-each row of the table. Each row is assigned in turn and run through
-the coded step. Consider the following example:
-
-Every row in the {table.yml table}[table.yml] will be assigned to
-the block parameters and run through the subsequent assertion.
-
-    Table 'table.yml' do |x, y|
-      x.upcase.assert == y
-    end
-
-= Comment Triggers
-
-QED also supports comment match triggers. With the +When+ method one can
-define setup and teardown procedures by matching against comment text.
-For example:
-
-    When 'given a setting @a equal to (((\d+)))' do |n|
-      @a = n.to_i
-    end
-
-Now, @a will be set to 1 whenever a comment like this one contains,
-"given a setting @a equal to 1".
-
-    @a.assert == 1
-
-A string pattern is translated into a regular expression. In fact, you can
-use a regular expression if you need more control over the match. When
-using a string all spaces are converted to <tt>\s+</tt> and anything within
-double-parenthesis is treated as raw regular expression. Since the above
-example has (((\d+))), the actual regular expression contains <tt>(\d+)</tt>,
-so any number can be used. For example, "given a setting @a equal to 2".
-
-    @a.assert == 2
-
-Typically you will want to put triggers is helper files, rather then
-place them directly in the demonstration document.
-
-This concludes the basic overview of QED's specification system, which
-is itself a QED document. Yes, we eat our own dog food.
-
----
-1[helper.rb] Helper
-

data/demo/02_err.qed

@@ -1,18 +0,0 @@
-= Examples of Failure
-
-This document is here simply to demonstrate what
-a failed step looks like.
-
-  1.assert == 2
-
-And this step demonstrates an error.
-
-  raise "just because"
-
-When run with the -v (verbatim) option, +qed+ will
-highlight these in red and give a brief error
-message.
-
----
-1[sample.rb] Sample Helper
-

data/demo/data.txt

@@ -1 +0,0 @@
-Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

data/demo/helpers/sample.rb

@@ -1,4 +0,0 @@
-#require 'ae/should'
-puts "This is just here to demonstrate that helpers are loaded."
-puts
-

data/demo/table.yml

@@ -1,5 +0,0 @@
----
-- [ try  , TRY ]
-- [ me   , ME  ]
-- [ mc   , MC  ]
-

data/lib/qed/extract.rb

@@ -1,137 +0,0 @@
-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/reporter/ditto.rb

@@ -1,72 +0,0 @@
-module QED
-module Reporter #:nodoc:
-
-  require 'qed/reporter/base'
-
-  # = DotProgress Reporter
-  #
-  class Ditto < BaseClass
-
-    #
-    def report_intro
-      #@start_time = Time.now
-      #io.puts "Started"
-    end
-
-    #
-    def report_step(step)
-      super
-      #if step.code
-        io.print "."
-        #str = "(%s) %s" % [count.join('.'), str.tab(6).strip]
-        #puts "* #{step.text.tab(2).strip}"
-        #puts "\n#{step.code}\n" if $VERBOSE
-      #else
-        #puts "\n#{step.text}"
-      #end
-    end
-
-    #def report(str)
-    #  count[-1] += 1 unless count.empty?
-    #  str = str.chomp('.') + '.'
-    #  str = count.join('.') + ' ' + str
-    #  puts str.strip
-    #end
-
-    def report_summary
-      io.puts "\nFinished in #{Time.now - @start_time} seconds.\n\n"
-
-      @error.each do |step, exception|
-        backtrace = clean_backtrace(exception.backtrace[0])
-        io.puts ANSICode.red("***** ERROR *****")
-        io.puts "#{exception}"
-        io.puts ":#{backtrace}:"
-        #io.puts ":#{exception.backtrace[1]}:"
-        #io.puts exception.backtrace[1..-1] if $VERBOSE
-        io.puts
-      end
-
-      @fail.each do |step, assertion|
-        backtrace = clean_backtrace(assertion.backtrace[0])
-        io.puts ANSICode.red("***** FAIL *****")
-        io.puts ANSICode.bold("#{assertion}")
-        io.puts ":#{backtrace}:"
-        #io.puts assertion if $VERBOSE
-        io.puts
-      end
-
-      io.puts "%s demos, %s steps, %s failures, %s errors" % [@demos, @steps, @fail.size, @error.size] #, @pass.size ]
-    end
-
-    private
-
-    #
-    def clean_backtrace(btrace)
-      btrace.chomp(":in `_binding'")
-    end
-
-  end#class DotProgress
-
-end#module Reporter
-end#module QED
-