funit 0.9.0

data/History.txt

@@ -0,0 +1,10 @@
+=== 0.1.3 / 2006-06-21
+
+* 1 bug fix
+  * Do not remove unit tests! (Thanks to Sebastian Hanigk and James Quirk.)
+
+=== 0.1.2 / 2006-05-16
+
+* 1 major enhancement
+  * 1st public release!
+

data/License.txt

@@ -0,0 +1,263 @@
+== License
+
+ NASA OPEN SOURCE AGREEMENT VERSION 1.3
+
+ THIS OPEN SOURCE AGREEMENT ("AGREEMENT") DEFINES THE RIGHTS OF USE,
+ REPRODUCTION, DISTRIBUTION, MODIFICATION AND REDISTRIBUTION OF CERTAIN
+ COMPUTER SOFTWARE ORIGINALLY RELEASED BY THE UNITED STATES GOVERNMENT
+ AS REPRESENTED BY THE GOVERNMENT AGENCY LISTED BELOW ("GOVERNMENT
+ AGENCY").  THE UNITED STATES GOVERNMENT, AS REPRESENTED BY GOVERNMENT
+ AGENCY, IS AN INTENDED THIRD-PARTY BENEFICIARY OF ALL SUBSEQUENT
+ DISTRIBUTIONS OR REDISTRIBUTIONS OF THE SUBJECT SOFTWARE.  ANYONE WHO
+ USES, REPRODUCES, DISTRIBUTES, MODIFIES OR REDISTRIBUTES THE SUBJECT
+ SOFTWARE, AS DEFINED HEREIN, OR ANY PART THEREOF, IS, BY THAT ACTION,
+ ACCEPTING IN FULL THE RESPONSIBILITIES AND OBLIGATIONS CONTAINED IN
+ THIS AGREEMENT.
+
+ Government Agency: NASA Langley Research Center
+ Government Agency Original Software Designation: LAR-17081-1
+ Government Agency Original Software Title: fUnit
+ User Registration Requested: please see clause 3.F.
+ Government Agency Point of Contact: funit-support@rubyforge.org
+
+ 1. DEFINITIONS
+
+ A. "Contributor" means Government Agency, as the developer of the
+ Original Software, and any entity that makes a Modification.
+
+ B. "Covered Patents" mean patent claims licensable by a Contributor
+ that are necessarily infringed by the use or sale of its Modification
+ alone or when combined with the Subject Software.
+
+ C. "Display" means the showing of a copy of the Subject Software,
+ either directly or by means of an image, or any other device.
+
+ D. "Distribution" means conveyance or transfer of the Subject
+ Software, regardless of means, to another.
+
+ E. "Larger Work" means computer software that combines Subject
+ Software, or portions thereof, with software separate from the Subject
+ Software that is not governed by the terms of this Agreement.
+
+ F. "Modification" means any alteration of, including addition to or
+ deletion from, the substance or structure of either the Original
+ Software or Subject Software, and includes derivative works, as that
+ term is defined in the Copyright Statute, 17 USC 101.  However, the
+ act of including Subject Software as part of a Larger Work does not in
+ and of itself constitute a Modification.
+
+ G. "Original Software" means the computer software first released
+ under this Agreement by Government Agency with Government Agency
+ designation NASA and entitled fUnit, including source code,
+ object code and accompanying documentation, if any.
+
+ H. "Recipient" means anyone who acquires the Subject Software under
+ this Agreement, including all Contributors.
+
+ I. "Redistribution" means Distribution of the Subject Software after a
+ Modification has been made.
+
+ J. "Reproduction" means the making of a counterpart, image or copy of
+ the Subject Software.
+
+ K. "Sale" means the exchange of the Subject Software for money or
+ equivalent value.
+
+ L. "Subject Software" means the Original Software, Modifications, or
+ any respective parts thereof.
+
+ M. "Use" means the application or employment of the Subject Software
+ for any purpose.
+
+ 2. GRANT OF RIGHTS
+
+ A. Under Non-Patent Rights: Subject to the terms and conditions of
+ this Agreement, each Contributor, with respect to its own contribution
+ to the Subject Software, hereby grants to each Recipient a
+ non-exclusive, world-wide, royalty-free license to engage in the
+ following activities pertaining to the Subject Software:
+
+  1. Use
+  2. Distribution
+  3. Reproduction
+  4. Modification
+  5. Redistribution
+  6. Display
+
+ B. Under Patent Rights: Subject to the terms and conditions of this
+ Agreement, each Contributor, with respect to its own contribution to
+ the Subject Software, hereby grants to each Recipient under Covered
+ Patents a non-exclusive, world-wide, royalty-free license to engage in
+ the following activities pertaining to the Subject Software:
+
+  1. Use
+  2. Distribution
+  3. Reproduction
+  4. Sale
+  5. Offer for Sale
+
+ C. The rights granted under Paragraph B. also apply to the combination
+ of a Contributor's Modification and the Subject Software if, at the
+ time the Modification is added by the Contributor, the addition of
+ such Modification causes the combination to be covered by the Covered
+ Patents.  It does not apply to any other combinations that include a
+ Modification.
+
+ D. The rights granted in Paragraphs A. and B. allow the Recipient to
+ sublicense those same rights.  Such sublicense must be under the same
+ terms and conditions of this Agreement.
+
+ 3. OBLIGATIONS OF RECIPIENT
+
+ A. Distribution or Redistribution of the Subject Software must be made
+ under this Agreement except for additions covered under paragraph 3H.
+
+ 1. Whenever a Recipient distributes or redistributes the Subject
+     Software, a copy of this Agreement must be included with each copy
+     of the Subject Software; and
+
+ 2. If Recipient distributes or redistributes the Subject Software in
+     any form other than source code, Recipient must also make the
+     source code freely available, and must provide with each copy of
+     the Subject Software information on how to obtain the source code
+     in a reasonable manner on or through a medium customarily used for
+     software exchange.
+
+ B. Each Recipient must ensure that the following copyright notice
+ appears prominently in the Subject Software:
+
+  Copyright 2006-2007 United States Government as represented by
+  NASA Langley Research Center. No copyright is claimed in
+  the United States under Title 17, U.S. Code. All Other Rights
+  Reserved.
+
+ C. Each Contributor must characterize its alteration of the Subject
+ Software as a Modification and must identify itself as the originator
+ of its Modification in a manner that reasonably allows subsequent
+ Recipients to identify the originator of the Modification.  In
+ fulfillment of these requirements, Contributor must include a file
+ (e.g., a change log file) that describes the alterations made and the
+ date of the alterations, identifies Contributor as originator of the
+ alterations, and consents to characterization of the alterations as a
+ Modification, for example, by including a statement that the
+ Modification is derived, directly or indirectly, from Original
+ Software provided by Government Agency. Once consent is granted, it
+ may not thereafter be revoked.
+
+ D. A Contributor may add its own copyright notice to the Subject
+ Software.  Once a copyright notice has been added to the Subject
+ Software, a Recipient may not remove it without the express permission
+ of the Contributor who added the notice.
+
+ E. A Recipient may not make any representation in the Subject Software
+ or in any promotional, advertising or other material that may be
+ construed as an endorsement by Government Agency or by any prior
+ Recipient of any product or service provided by Recipient, or that may
+ seek to obtain commercial advantage by the fact of Government Agency's
+ or a prior Recipient's participation in this Agreement.
+
+ F. In an effort to track usage and maintain accurate records of the
+ Subject Software, each Recipient, upon receipt of the Subject Software,
+ is requested to provide Government Agency, by e-mail to the Government
+ Agency Point of Contact listed in clause 5.F., the following information:
+ name, institution (if applicable), postal code, and country.
+ Recipient's name and personal information shall be used for statistical
+ purposes only. Once a Recipient makes a Modification available, it is
+ requested that the Recipient inform Government Agency, by e-mail to the
+ Government Agency Point of Contact listed in clause 5.F., how to
+ access the Modification.
+
+ G. Each Contributor represents that that its Modification is believed
+ to be Contributor's original creation and does not violate any
+ existing agreements, regulations, statutes or rules, and further that
+ Contributor has sufficient rights to grant the rights conveyed by this
+ Agreement.
+
+ H. A Recipient may choose to offer, and to charge a fee for, warranty,
+ support, indemnity and/or liability obligations to one or more other
+ Recipients of the Subject Software.  A Recipient may do so, however,
+ only on its own behalf and not on behalf of Government Agency or any
+ other Recipient.  Such a Recipient must make it absolutely clear that
+ any such warranty, support, indemnity and/or liability obligation is
+ offered by that Recipient alone.  Further, such Recipient agrees to
+ indemnify Government Agency and every other Recipient for any
+ liability incurred by them as a result of warranty, support, indemnity
+ and/or liability offered by such Recipient.
+
+ I. A Recipient may create a Larger Work by combining Subject Software
+ with separate software not governed by the terms of this agreement and
+ distribute the Larger Work as a single product. In such case, the
+ Recipient must make sure Subject Software, or portions thereof,
+ included in the Larger Work is subject to this Agreement.
+
+ J. Notwithstanding any provisions contained herein, Recipient is
+ hereby put on notice that export of any goods or technical data from
+ the United States may require some form of export license from the
+ U.S. Government.  Failure to obtain necessary export licenses may
+ result in criminal liability under U.S. laws.  Government Agency
+ neither represents that a license shall not be required nor that, if
+ required, it shall be issued.  Nothing granted herein provides any
+ such export license.
+
+ 4. DISCLAIMER OF WARRANTIES AND LIABILITIES; WAIVER AND INDEMNIFICATION
+
+ A. No Warranty: THE SUBJECT SOFTWARE IS PROVIDED "AS IS" WITHOUT ANY
+ WARRANTY OF ANY KIND, EITHER EXPRESSED, IMPLIED, OR STATUTORY,
+ INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY THAT THE SUBJECT SOFTWARE
+ WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR FREEDOM FROM
+ INFRINGEMENT, ANY WARRANTY THAT THE SUBJECT SOFTWARE WILL BE ERROR
+ FREE, OR ANY WARRANTY THAT DOCUMENTATION, IF PROVIDED, WILL CONFORM TO
+ THE SUBJECT SOFTWARE. THIS AGREEMENT DOES NOT, IN ANY MANNER,
+ CONSTITUTE AN ENDORSEMENT BY GOVERNMENT AGENCY OR ANY PRIOR RECIPIENT
+ OF ANY RESULTS, RESULTING DESIGNS, HARDWARE, SOFTWARE PRODUCTS OR ANY
+ OTHER APPLICATIONS RESULTING FROM USE OF THE SUBJECT SOFTWARE.
+ FURTHER, GOVERNMENT AGENCY DISCLAIMS ALL WARRANTIES AND LIABILITIES
+ REGARDING THIRD-PARTY SOFTWARE, IF PRESENT IN THE ORIGINAL SOFTWARE,
+ AND DISTRIBUTES IT "AS IS."
+
+ B. Waiver and Indemnity: RECIPIENT AGREES TO WAIVE ANY AND ALL CLAIMS
+ AGAINST THE UNITED STATES GOVERNMENT, ITS CONTRACTORS AND
+ SUBCONTRACTORS, AS WELL AS ANY PRIOR RECIPIENT.  IF RECIPIENT'S USE OF
+ THE SUBJECT SOFTWARE RESULTS IN ANY LIABILITIES, DEMANDS, DAMAGES,
+ EXPENSES OR LOSSES ARISING FROM SUCH USE, INCLUDING ANY DAMAGES FROM
+ PRODUCTS BASED ON, OR RESULTING FROM, RECIPIENT'S USE OF THE SUBJECT
+ SOFTWARE, RECIPIENT SHALL INDEMNIFY AND HOLD HARMLESS THE UNITED
+ STATES GOVERNMENT, ITS CONTRACTORS AND SUBCONTRACTORS, AS WELL AS ANY
+ PRIOR RECIPIENT, TO THE EXTENT PERMITTED BY LAW.  RECIPIENT'S SOLE
+ REMEDY FOR ANY SUCH MATTER SHALL BE THE IMMEDIATE, UNILATERAL
+ TERMINATION OF THIS AGREEMENT.
+
+ 5. GENERAL TERMS
+
+ A. Termination: This Agreement and the rights granted hereunder will
+ terminate automatically if a Recipient fails to comply with these
+ terms and conditions, and fails to cure such noncompliance within
+ thirty (30) days of becoming aware of such noncompliance.  Upon
+ termination, a Recipient agrees to immediately cease use and
+ distribution of the Subject Software.  All sublicenses to the Subject
+ Software properly granted by the breaching Recipient shall survive any
+ such termination of this Agreement.
+
+ B. Severability: If any provision of this Agreement is invalid or
+ unenforceable under applicable law, it shall not affect the validity
+ or enforceability of the remainder of the terms of this Agreement.
+
+ C. Applicable Law: This Agreement shall be subject to United States
+ federal law only for all purposes, including, but not limited to,
+ determining the validity of this Agreement, the meaning of its
+ provisions and the rights, obligations and remedies of the parties.
+
+ D. Entire Understanding: This Agreement constitutes the entire
+ understanding and agreement of the parties relating to release of the
+ Subject Software and may not be superseded, modified or amended except
+ by further written agreement duly executed by the parties.
+
+ E. Binding Authority: By accepting and using the Subject Software
+ under this Agreement, a Recipient affirms its authority to bind the
+ Recipient to all terms and conditions of this Agreement and that that
+ Recipient hereby agrees to all terms and conditions herein.
+
+ F. Point of Contact: Any Recipient contact with Government Agency is
+ to be directed to the designated representative as follows:
+ funit-support@rubyforge.org.

data/Manifest.txt

@@ -0,0 +1,25 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/funit
+examples/CFD/FluxFunctions.f90
+examples/CFD/FluxFunctions.fun
+examples/CFD/Gammas.f90
+examples/CFD/GasModel.f90
+examples/CFD/GasModel.fun
+examples/ReadData/time_series_data.f90
+examples/ReadData/time_series_data.fun
+examples/StopWatch/StopWatch.f90
+examples/StopWatch/StopWatch.fun
+lib/funit.rb
+lib/funit/assertions.rb
+lib/funit/compiler.rb
+lib/funit/functions.rb
+lib/funit/testsuite.rb
+test/test_compiler.rb
+test/test_functions.rb
+test/test_funit.rb
+test/test_testsuite.rb
+utils/funit-mode.el

data/README.txt

@@ -0,0 +1,124 @@
+FUnit
+
+* http://rubyforge.org/projects/funit
+* http://funit.rubyforge.org
+* mailto:funit-support@rubyforge.org
+
+== DESCRIPTION:
+  
+FUnit is a unit testing framework for Fortran modules.
+
+Unit tests are written as Fortran fragments that use a small
+set of testing-specific keywords and functions.  FUnit transforms
+these fragments into valid Fortran code, compiles, links, and
+runs them against the module under test.
+
+FUnit is {opinionated software}[http://www.oreillynet.com/pub/a/network/2005/08/30/ruby-rails-david-heinemeier-hansson.html], which values convention over
+configuration. Specifically, FUnit,
+
+* requires a Fortran 95 compiler,
+* only supports testing routines contained in modules,
+* requires tests to be stored along side the code under test, and
+* requires test files to be named appropriately.
+
+== FEATURES/PROBLEMS:
+
+* Enables the Scientific Method for software by making unit testing
+  Fortran fun and easy.
+* Encourages cohesive, yet decoupled code paired with
+  <em>executable</em> documentation.
+
+== SYNOPSIS:
+
+Suppose <tt>gas_physics.f90</tt> has a routine that returns
+viscosity as a function of temperature, e.g.,
+
+ module gas_physics
+ contains
+   function viscosity(temperature)
+     real :: viscosity, temperature
+     viscosity = 2.0e-3 * temperature**1.5
+   end function
+ end module
+
+Tests of this module would be contained in <tt>gas_physics.fun</tt>,
+dkfand might contain a test like,
+
+ beginTest viscosity_varies_as_temperature
+  IsRealEqual( 0.0, viscosity(0.0) )
+  IsEqualWithin( 0.7071, viscosity(50.0), 1e-3 )
+ endTest
+
+This brief fragment is all you need.  The framework provides the rest
+of the trappings to turn this into valid Fortran code.
+
+You would run this unit test with the command,
+
+ funit gas_physics
+
+which would transform your fragments contained in <tt>gas_physics.fun</tt>
+into valid Fortran code, create a test runner program, compile everything,
+and run the tests, viz,
+
+ parsing gas_physics.fun
+ computing dependencies
+ locating associated source files and sorting for compilation
+ g95 -o TestRunner
+   gas_physics.f90 \
+   gas_physics_fun.f90 \
+   TestRunner.f90
+
+ gas_physics test suite:
+ Passed 2 of 2 possible asserts comprising 1 of 1 tests.
+
+This and other examples come with the FUnit distribution in the
+<tt>examples</tt> directory.  There is also an emacs mode in
+the <tt>utils</tt> directory.  If you installed the FUnit via Rubygems,
+these directories can be found in your Rubygems library directory, e.g., <tt>/usr/local/lib/ruby/gems</tt>.
+
+== REQUIREMENTS:
+
+* Fortran 90/95/2003 compiler
+* Ruby with Rubygems
+* fortran Ruby Gem
+
+== INSTALL:
+
+* <tt>sudo gem install funit</tt>
+* Set FC environment variable to point to a Fortran compiler:
+  * <tt>export FC=/path/of/Fortran/compiler</tt> (sh)
+  * <tt>setenv FC /path/of/Fortran/compiler</tt> (csh)
+
+== LICENSE:
+
+FUnit is released under the NASA Open Source Agreement -- see License.txt[link:files/License_txt.html] for details.
+
+== ORIGIN:
+
+On October 4, 2001, Mike Hill (then of {Object Mentor}[http://www.objectmentor.com/],
+now of {Industrial Logic}[http://www.industriallogic.com]) visited {NASA Langley Research Center}[http://www.larc.nasa.gov]
+in Hampton, Virginia and gave a test-first design talk at
+the {Institute for Computer and Applied Sciences and Engineering (ICASE)}[http://www.icase.edu].
+Copies of his slides are available at {icase.edu/series/MPP}[http://www.icase.edu/series/MPP/].
+
+Mike spent the afternoon with Bil Kleb, Bill Wood, Karen Bibb, and
+Mike Park reasoning out how we might create a testing framework
+for Fortran 90 to use during FUN3D[http://fun3d.larc.nasa.gov] code development.
+By the end of the afternoon we had a working prototype based
+on the macro expansion techniques employed in Mike Hill's cpptestkit[http://sourceforge.net/projects/cpptestkit].
+We quickly found C-preprocessor macros to be too restrictive and
+rewrote the framework in Ruby[http://www.ruby-lang.org].
+
+== TODO:
+
+* Rename assertions to more consistent with other xUnits.
+* Use <tt>test</tt> keyword instead of <tt>beginTest</tt> business.
+* To avoid Fortran's 32-character limit, don't add test name during translation.
+* Add some command line options (especially <tt>clean</tt>), possibly
+  using CmdParse[http://cmdparse.rubyforge.org].
+* Add assertions that capture stops, warning messages, and other exits.
+* For compilation, use internal rake task instead of a single, ordered command line.
+* Allow users to specify dependency search paths (currently hardwired).
+* To increase portability, create stand-alone executables with Erik Veenstra's
+  RubyScript2Exe[http://www.erikveen.dds.nl/rubyscript2exe/].
+* Make FUnit self-tests fail gracefully if Fortran compiler is not found.

data/Rakefile

@@ -0,0 +1,21 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+$:.unshift File.join( File.dirname(__FILE__), 'lib' )
+require 'funit'
+
+Hoe.new('funit', Funit::VERSION) do |p|
+  p.rubyforge_name = 'nasarb'
+  p.extra_deps << [ 'fortran', '>= 1.0.0' ]
+  p.author = ['Karen Bibb','Bil Kleb','Beth Lee-Rausch','Mike Park','Bill Wood']
+  p.email = 'funit-support@rubyforge.org'
+  p.summary = 'A Fortran unit testing framework.'
+  p.description = p.paragraphs_of('README.txt', 2..3).join("\n\n")
+  p.url = p.paragraphs_of('README.txt', 1).first.gsub(/^\* /, '').split(/\n/)
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.remote_rdoc_dir = '' # release webpages to root (otherwise dropped in rubyforge_name subdir)
+  p.clean_globs.concat %w( **/*_fun.f90 examples/**/TestRunner* **/*.o **/*.mod **/*.MOD )
+  p.rsync_args << ' --exclude=statsvn/'
+end

data/bin/funit

@@ -0,0 +1,22 @@
+# Main fUnit routine
+
+begin
+  require 'funit'
+rescue LoadError
+  require 'rubygems'
+  require 'funit'
+end
+
+include Funit
+
+Funit::run_tests
+
+#--
+# Copyright 2006-2007 United States Government as represented by
+# NASA Langley Research Center. No copyright is claimed in
+# the United States under Title 17, U.S. Code. All Other Rights
+# Reserved.
+#
+# This file is governed by the NASA Open Source Agreement.
+# See License.txt for details.
+#++