uncool 1.0.0

data/HISTORY.rdoc

@@ -0,0 +1,10 @@
+= RELEASE HISTORY
+
+== 1.0.0 / 2010-08-10
+
+Yea, wee a new test coveragte tool!
+
+Changes:
+
+* Rapidly coded first version.
+

data/LICENSE

@@ -0,0 +1,204 @@
+.
+                             Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+

data/README.rdoc

@@ -0,0 +1,90 @@
+= Uncool
+
+= DESCRIPTION
+
+Uncool is unit test coverage tool. Units, just to be absoluately clear,
+are methods. So Uncool montiors you test execution and records the methods
+called aganist target classes.
+
+
+= RESOURCES
+
+* home: http://protuils.github.com/uncool
+* code: http://github.com/proutils/uncool
+* talk: http://groups.google.com/group/proutils
+
+
+= SYNOPSIS
+
+Uncool works by setting up a #set_trace_func procedure that records
+all method calls made against a target set of classes. In Uncool parlance
+the methods are called _units_ and the classes are called _targets_ or
+_namespaces_.
+
+Uncool provides a command-line tool called `uncool-ruby`, which can be
+used to get a coverage report on any Ruby script(s).
+
+    $ uncool-ruby script.rb
+
+The command-line tool is useful in limited cases. More useful it the ability
+to require 'uncool', and based on environment variables, uncool will
+setup logging automatically. This is especailly useful for running uncool with
+various test frameworks, as long as they support an `-r` require option.
+
+For example, here is how we could run a KO![http://proutils.github.com/ko]
+test with Uncool coverage.
+
+    ns=Example ko -runcool test/features/example_feature.rb
+
+Where `ns` is the environment variable for setting the targert "namespaces".
+More than one namespace can be given by separating them with commas. By default
+the coverage report will output to `$stdout`. To log the results to disc provide
+the output directory via the `out` environment variable.
+
+    out=log ns=Example ko -runcool test/features/example_feature.rb
+
+This example would then save the output as html under `log/uncool/index.html`.
+
+To setup "profiles" for different uncool runs, you could simply create
+ruby script(s) that set these environment variables.
+
+    # config/uncool.rb
+    ENV['out'] = 'log'
+    ENV['ns']  = 'Example'
+
+Then require that file first.
+
+    $ ko -r./config/uncool.rb -runcool test/features/dummy_feature.rb
+
+Other ways to utilize Uncool for your tests is to invoke the Uncool logger in
+your test helper script.
+
+    # test/test_helper.rb
+    require 'uncool/log'
+    Uncool.log(:output=>'log', :namespaces=>['Example'])
+
+Of course, this will run the Uncool logger exvery time you run a test.
+
+As an alternative you might be able to write your own special runner. For
+instance, with the KO! test framework a special runner command can be written
+as easily as:
+
+    # script/test_with_uncool
+
+    require 'uncool/log'
+    Uncool.log(:output=>'log', :namespaces=>['Example'])
+
+    require 'ko/cli'
+    KO::CLI.run(ARGV)
+
+Then use this script to run tests instead. This provides the most flexability
+too because the script could also pre-processes ARGV to pull out any special
+options for Uncool that we might like to use.
+
+
+= LEGAL
+
+(Apache 2.0 License)
+
+Copyright (c) 2010 Thomas Sawyer
+

data/bin/uncool-ruby

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'uncool/cli'
+Uncool::CLI.run(ARGV)

data/lib/uncool.rb

@@ -0,0 +1,8 @@
+require 'uncool/meta/data'
+
+if ENV['ns']
+  require 'uncool/autolog'
+else
+  require 'uncool/log'
+end
+

data/lib/uncool/analysis.rb

@@ -0,0 +1,94 @@
+require 'uncool/unit'
+require 'uncool/report'
+
+module Uncool
+
+  #
+  class Analysis
+
+    #
+    def initialize(trace, options={})
+      @trace   = trace
+      @private = options[:private]
+    end
+
+    #
+    def log
+      @trace.log
+    end
+    
+    #
+    def targets
+      @trace.targets.map do |t|
+        eval(t, TOPLEVEL_BINDING)
+      end
+    end
+
+    #
+    def private?
+      @private
+    end
+
+    # Returns a list of postive and negative coverage.
+    def coverage
+      covered | checklist
+    end
+
+    # Return a list of units that were covered.
+    def covered
+      @coverage ||= (
+        list = []
+        log.each do |object, method|
+          unit = Unit.new(object.class, method, :covered=>true)
+          list << unit
+        end
+        list
+      )
+    end
+
+    # Returns a list of all possible coverage points.
+    def checklist
+      coverage = []
+      targets.each do |target|
+        target.instance_methods(false).each do |meth|
+          unit = Unit.new(target, meth)
+          coverage << unit
+        end
+
+        target.methods(false).each do |meth|
+          unit = Unit.new(target, meth, :function=>true)
+          coverage << unit
+        end
+
+        if private?
+          target.protected_instance_methods(false).each do |meth|
+            unit = Unit.new(target, meth, :access=>:protected)
+            coverage << unit
+          end
+          target.private_instance_methods(false).each do |meth|
+            unit = Unit.new(target, meth, :access=>:private)
+            coverage << unit
+          end
+
+          target.protected_methods(false).each do |meth|
+            unit = Unit.new(target, meth, :access=>:protected, :function=>true)
+            coverage << unit
+          end
+          target.private_methods(false).each do |meth|
+            unit = Unit.new(target, meth, :access=>:private, :function=>true)
+            coverage << unit
+          end
+        end
+      end
+      coverage
+    end
+
+    #
+    #def save(logdir)
+    #  Report.new(chart).save(logdir)
+    #end
+
+  end
+
+end
+

data/lib/uncool/app.rb

@@ -0,0 +1,85 @@
+require 'uncool/meta/data'
+require 'uncool/trace'
+
+module Uncool
+
+  #
+  class App
+
+    #
+    def initialize(options={})
+      @options    = options
+      @namespaces = options[:namespaces]
+    end
+
+    #
+    attr :namespaces
+
+    #
+    alias_method :targets, :namespaces
+
+    #
+    attr :options
+
+    #
+    #def targets
+    #  @targets ||= namespaces.map{ |ns| eval(ns, TOPLEVEL_BINDING) }
+    #end
+
+    #
+    def trace
+      @trace ||= Trace.new(targets, options)
+    end
+
+    #
+    def analysis
+      @analysis ||= Analysis.new(trace, options)
+    end
+
+    #
+    def report
+      @report ||= Report.new(analysis, options)
+    end
+
+    # This is the main method for activating hte trace and
+    # recording the results.
+    def log(logdir=nil)
+      logdir = logdir || options[:output]
+      trace.setup
+      at_exit {
+        trace.deactivate
+        logdir ? report.save(logdir) : report.display
+      }
+      trace.activate
+    end
+
+    #
+    def generate(scripts)
+      require 'uncool/generator/ko'
+      require 'uncool/generator/qed'
+      require 'uncool/generator/lemon'
+
+      generator = (
+        case options[:framework]
+        when :ko
+          GeneratorKO.new(options)
+        when :qed
+          GeneratorQED.new(options)
+        when :rspec
+          #GeneratorRSpec.new(options)
+        when :cuke, :cucumber
+          #GeneratorCucumber.new(options)
+        else
+          GeneratorLemon.new(options)
+        end
+      )
+
+      scripts.each{ |script| require(script) }
+
+      generator.generate
+    end
+
+  end
+
+end
+