lemon 0.5

data/COPYING.LESSER

@@ -0,0 +1,166 @@
+= GNU LESSER GENERAL PUBLIC LICENSE
+
+Version 3, 29 June 2007
+
+Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+Everyone is permitted to copy and distribute verbatim copies
+of this license document, but changing it is not allowed.
+
+This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+== 0. Additional Definitions.
+
+As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the
+GNU General Public License.
+
+"The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+== 1. Exception to Section 3 of the GNU GPL.
+
+You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+== 2. Conveying Modified Versions.
+
+If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+a) under this License, provided that you make a good faith effort to
+ensure that, in the event an Application does not supply the
+function or data, the facility still operates, and performs
+whatever part of its purpose remains meaningful, or
+
+b) under the GNU GPL, with none of the additional permissions of
+this License applicable to that copy.
+
+== 3. Object Code Incorporating Material from Library Header Files.
+
+The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+a) Give prominent notice with each copy of the object code that the
+Library is used in it and that the Library and its use are
+covered by this License.
+
+b) Accompany the object code with a copy of the GNU GPL and this
+license document.
+
+== 4. Combined Works.
+
+You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+a) Give prominent notice with each copy of the Combined Work that
+the Library is used in it and that the Library and its use are
+covered by this License.
+
+b) Accompany the Combined Work with a copy of the GNU GPL and this
+license document.
+
+c) For a Combined Work that displays copyright notices during
+execution, include the copyright notice for the Library among
+these notices, as well as a reference directing the user to the
+copies of the GNU GPL and this license document.
+
+d) Do one of the following:
+
+d.0) Convey the Minimal Corresponding Source under the terms of
+this License, and the Corresponding Application Code in a form
+suitable for, and under terms that permit, the user to
+recombine or relink the Application with a modified version of
+the Linked Version to produce a modified Combined Work, in the
+manner specified by section 6 of the GNU GPL for conveying
+Corresponding Source.
+
+d.1) Use a suitable shared library mechanism for linking with the
+Library.  A suitable mechanism is one that (a) uses at run time
+a copy of the Library already present on the user's computer
+system, and (b) will operate properly with a modified version
+of the Library that is interface-compatible with the Linked
+Version.
+
+e) Provide Installation Information, but only if you would otherwise
+be required to provide such information under section 6 of the
+GNU GPL, and only to the extent that such information is
+necessary to install and execute a modified version of the
+Combined Work produced by recombining or relinking the
+Application with a modified version of the Linked Version. (If
+you use option 4d0, the Installation Information must accompany
+the Minimal Corresponding Source and Corresponding Application
+Code. If you use option 4d1, you must provide the Installation
+Information in the manner specified by section 6 of the GNU GPL
+for conveying Corresponding Source.)
+
+== 5. Combined Libraries.
+
+You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+a) Accompany the combined library with a copy of the same work based
+on the Library, uncombined with any other library facilities,
+conveyed under the terms of this License.
+
+b) Give prominent notice with the combined library that part of it
+is a work based on the Library, and explaining where to find the
+accompanying uncombined form of the same work.
+
+== 6. Revised Versions of the GNU Lesser General Public License.
+
+The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.
+

data/HISTORY

@@ -0,0 +1,13 @@
+= RELEASE HISTORY
+
+== 0.5 / 2009-12-31
+
+This is the initial public release of Lemon. Lemon is
+still under development and should be considered betaware,
+but it's API is stable and the system usable enough to 
+warrant a release.
+
+Changes:
+
+* Happy First Release Day!
+

data/MANIFEST

@@ -0,0 +1,37 @@
+COPYING
+COPYING.LESSER
+HISTORY
+README.rdoc
+bin/lemon
+lib/lemon
+lib/lemon.rb
+lib/lemon/command.rb
+lib/lemon/coverage.rb
+lib/lemon/kernel.rb
+lib/lemon/reporter.rb
+lib/lemon/reporters
+lib/lemon/reporters.rb
+lib/lemon/reporters/dotprogress.rb
+lib/lemon/reporters/verbose.rb
+lib/lemon/runner.rb
+lib/lemon/test
+lib/lemon/test/case.rb
+lib/lemon/test/concern.rb
+lib/lemon/test/suite.rb
+lib/lemon/test/unit.rb
+meta/author
+meta/contact
+meta/copyright
+meta/description
+meta/homepage
+meta/license
+meta/name
+meta/repository
+meta/suite
+meta/summary
+meta/title
+meta/version
+test/cases
+test/cases/coverage_case.rb
+test/cases/testcase_case.rb
+test/demos

data/README.rdoc

@@ -0,0 +1,108 @@
+= Lemon
+
+* http://proutils.github.com/lemon
+* http://github.com/proutils/lemon
+
+
+== DESCRIPTION
+
+Lemon is a Unit Testing Framework that enforces a testcase 
+construction mirroring the class or module and method design
+of the target system. Arguably this promotes the proper
+technique for unit testing, since it helps ensure good test
+coverage.
+
+The difference between unit testing and functional testing, and
+all other forms of testing for that matter, lies in where the
+*concern* lies. The concern of unit testing are the concerns
+of unit tests.
+
+
+== HOW TO USE
+
+Say our library consists of the class X:
+
+  class X
+    def a; "a"; end
+  end
+
+The simplist test case would be written as follows:
+
+  TestCase X do
+    Unit :a => "method #a does something expected" do
+      x = X.new
+      x.a.assert.is_a? String
+    end
+  end
+
+As tests grow, we need to organize them into concerns. For this
+Lemon provides the #Concern method.
+
+  TestCase X do
+    Concern "Description of a concern that the following unit",
+            "tests address."
+
+    Unit :a => "method #a does something expected" do
+      x = X.new
+      x.a.assert.is_a? String
+    end
+  end
+
+To run tests use the +lemon+ command-line utility.
+
+  $ lemon test/cases/name_case.rb
+
+Normal output is typical <i>dot-progress</i>. For verbose output, use the <tt>--verbose</tt>
+or <tt>-v</tt> option.
+
+  $ lemon -v test/cases/name_case.rb
+
+
+== Checking Test Coverage
+
+Lemon can check test coverage by loading your target system and 
+comparing it to your tests.
+
+  $ lemon --coverage -Ilib -rmyapp test/cases/
+
+
+== Generating Test Skeletons
+
+NOTE: This feature is not yet fully implemented!
+
+Because of the one to one correspondance of case-unit to class-method, Lemon can
+also generate test scaffolding for previously written code. To do this, use the
+<tt>--generate</tt> option and provide the lib location, or files, of the
+scripts for which to generate test scaffolding, and the output location for
+the test scripts.
+
+  $ lemon --generate -rlib/ test/cases/
+
+Generating test case scaffodling from code will undoubtedly strike test-driven developers
+as a case of putting the cart before the horse. However, it is not unreasonable to argue
+that high-level, behavior-driven, functional testing frameworks, such as Q.E.D. and
+Cucumber are better suited to test-first methodologies. While test-driven development
+can obviously be done with Lemon, unit-testing is more appropriate for testing specific,
+critical protions of code, or for achieving full test coverage for mission critical
+applications.
+
+
+== COPYRIGHT
+
+(LGPL License)
+
+Copyright (c) 2009 Thomas Sawyer
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the Lesser General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+Lesser General Public License for more details.
+
+You should have received a copy of the Lesser General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
+

data/Syckfile

@@ -0,0 +1,68 @@
+---
+box:
+  service: Box
+  active : true
+  types  : [gem, gz]
+  include: [bin, lib, meta, test, "[A-Z]*"]
+  exclude: [Syckfile]
+  master : true
+
+email:
+  service : Email
+  file    : ~
+  subject : ~
+  mailto  : ruby-talk@ruby-lang.org
+  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
+
+dnote:
+  service  : DNote
+  loadpath : ~
+  labels   : ~
+  output   : ~
+  active   : true
+
+ridoc:
+  service: RIDoc
+  include: ~
+  exclude: [Syckfile]
+  ignore : ~
+  active : true
+
+stats:
+  service  : Stats
+  title    : ~
+  loadpath : ~
+  exclude  : ~
+  output   : ~
+  active   : true
+
+testrb:
+  service  : Testrb
+  tests    : ~
+  exclude  : ~
+  loadpath : ~
+  requires : ~
+  live     : false   
+  active   : false
+
+vclog:
+  service  : VClog
+  format   : html   # xml, txt
+  layout   : rel    # gnu
+  typed    : false
+  output   : ~
+  active   : false
+
+syntax:
+  service  : Syntax
+  loadpath : ~
+  exclude  : ~
+  active   : false
+

data/bin/lemon

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'lemon/command'
+Lemon::Command.run

data/lib/lemon.rb

@@ -0,0 +1 @@
+require 'lemon/runner'

data/lib/lemon/command.rb

@@ -0,0 +1,125 @@
+#!/usr/bin/env ruby
+
+require 'lemon'
+require 'lemon/coverage'
+require 'optparse'
+require 'yaml'
+
+module Lemon
+
+  # Lemon Command-line tool.
+  class Command
+
+    # Initialize and run.
+    def self.run
+      new.run
+    end
+
+    attr_accessor :command
+    attr_accessor :format
+    attr_accessor :requires
+    attr_accessor :includes
+    attr_accessor :public_only
+
+    # New Command instance.
+    def initialize
+      @format   = nil
+      @requires = []
+      @includes = []
+      @public_only = false
+    end
+
+    # Instance of OptionParser.
+    def parser
+      @parser ||= OptionParser.new do |opt|
+        opt.on('--verbose', '-v', "select verbose report format") do |type|
+          self.format = :verbose
+        end
+        #opt.on('--format', '-f [TYPE]', "select alternate report format") do |type|
+        #  self.format = type
+        #end
+        opt.on('--coverage', '-c', 'produce a coverage report') do
+          self.command = :coverage
+        end
+        opt.on('--generate', '-g', 'generate test skeletons') do
+          self.command = :generate
+        end
+        opt.on('--public', '-p', "only include public methods (for -c and -g)") do
+          self.public_only = true
+        end
+        opt.on("-I [PATH]" , 'include in $LOAD_PATH') do |path|
+          self.includes = path
+        end
+        opt.on("-r [FILES]" , 'library files to require') do |files|
+          self.requires = files
+        end
+        opt.on("--debug" , 'turn on debugging mode') do
+          $DEBUG = true
+        end
+        opt.on_tail('--help', '-h', 'show this help message') do
+          puts opt
+          exit
+        end
+      end
+    end
+
+    #
+    def public_only?
+      @public_only
+    end
+
+    #
+    def requires=(paths)
+      @requires = paths.split(/[:;]/)
+    end
+
+    #
+    def includes=(paths)
+      @includes = paths.split(/[:;]/)
+    end
+
+    #
+    def run
+      parser.parse!
+
+      includes.each do |path|
+        $LOAD_PATHS.unshift(path)
+      end
+
+      tests = ARGV
+
+      case command
+      when :coverage
+        coverage(tests)
+      when :generate
+        generate(tests)
+      else
+        test(tests)
+      end
+    end
+
+    # Check test coverage.
+    def coverage(tests)
+      cover  = Lemon::Coverage.new(requires, :public => public_only?)
+      suite  = Lemon::Test::Suite.new(tests)
+      puts cover.coverage(suite).to_yaml
+    end
+
+    # Generate test skeletons.
+    def generate(tests)
+      cover  = Lemon::Coverage.new(requires, :public => public_only?)
+      #suite  = Lemon::Test::Suite.new(tests)
+      puts cover.generate #(suite).to_yaml
+    end
+
+    # Run unit tests.
+    def test(tests)
+      requires.each{ |path| require(path) }
+      suite  = Lemon::Test::Suite.new(tests)
+      runner = Lemon::Runner.new(suite, format)
+      runner.run
+    end
+
+  end
+
+end