piggly 1.2.0 → 1.2.1

data/README.markdown

@@ -1,29 +1,54 @@
-# Piggly - PostgreSQL PL/pgSQL stored procedure code coverage
+# Piggly - PostgreSQL PL/pgSQL stored-procedure code coverage for Ruby
+
+## Purpose
+
+PL/pgSQL doesn't have much in the way of developer tools, and writing automated tests for
+stored procedures can go much better when you know what you haven't tested. Code coverage
+allows you to see which parts of your code haven't been executed.
 
 ## What's Piggly?
-Piggly is like [RCov] [1] for PostgreSQL's PL/pgSQL stored procedures. It reports on code
-coverage to help you identify untested parts of your code.
+
+Piggly is a tool written in Ruby to track code coverage of PostgreSQL's PL/pgSQL stored
+procedures. It reports on code coverage to help you identify untested parts of your code.  You
+write tests in Ruby against your stored procedures and run them with piggly.
+
+## How Does It Work?
+
+Piggly tracks the execution of PostgreSQL's PL/pgSQL stored procedures by recompiling
+the stored procedure with instrumentation code that uses RAISE WARNING to notify the
+client of an execution event (e.g., a branch condition evaluating to true or false).  It records
+these events and generates prettified source code that is annotated with coverage details.
 
 ## Features
+
 * Branch, block, and loop coverage analysis
 * Instrumenting source-to-source compiler
 * Low test execution overhead
 * Reduced compilation times by use of disk caching
-* Readable and easily navigable reports (see example/piggly/reports/index.html)
-* Able to aggregate coverage across multiple runs
+* Readable and easily-navigable reports (see example/piggly/reports/index.html)
+* Possible to aggregate coverage across multiple runs
 * Test::Unit and RSpec compatible
 
 ## Limitations
+
 * Cannot parse aggregate definitions (but helper functions are fine)
 * Cannot parse nested dollar-quoted strings, eg $A$ ... $B$ ... $B$ ... $A$
 * Report generation is resource intensive and slow
+* SQL statements are not instrumented, so their branches (COALESCE, WHERE-clauses, etc) aren't tracked
+* Not all PL/pgSQL grammar is currently supported, but this is easily addressed
 
 ## Requirements
+
 * [Treetop] [2]
-* Stored procedures stored on the filesystem, defined with "CREATE OR REPLACE FUNCTION ..."
+* Stored procedures stored on the filesystem, defined as `CREATE OR REPLACE FUNCTION`
 * The [ruby-pg driver] [3], and for the time being, ActiveRecord (some workaround should be possible)
 
+## How to Install
+
+    $ gem install piggly
+
 ## Usage
+
 Assume your stored procedures are in proc/, and the tests that should be exercising your
 stored procedures are in spec/.
 
@@ -57,16 +82,17 @@ stored procedures are in spec/.
     -rw-r--r-- 1 kputnam kputnam 1.3K 2010-04-19 14:25 piggly/reports/index.html
 
 Note the compilation can be slow on the first run, but on subsequent runs it shouldn't need
-to be compiled again. If a file is added or changed (based on mtime), it will be recompiled.
+to compile everything again. If a file is added or changed (based on mtime), it will be recompiled.
 
 Piggly can also be run from Rake, with a task like:
+    require 'piggly/task'
 
     namespace :spec do
       Piggly::Task.new(:piggly => 'db:test:prepare') do |t|
         t.libs.push 'spec'
 
         t.test_files = FileList['spec/**/*_spec.rb']
-        t.proc_files = FileList['procs/*.sql']
+        t.proc_files = FileList['proc/*.sql']
 
         # this can be used if piggly is frozen in a Rails application
         t.libs.concat Dir['vendor/gems/*/lib/'].sort.reverse
@@ -76,9 +102,15 @@ Piggly can also be run from Rake, with a task like:
 
     $ rake spec:piggly
 
+## Bugs & Issues
+
+Please report any issues on the [github tracker] [4]
+
 ## Author
+
 * Kyle Putnam <putnam.kyle@gmail.com>
 
   [1]: http://github.com/relevance/rcov/
   [2]: http://github.com/nathansobo/treetop
   [3]: http://bitbucket.org/ged/ruby-pg/
+  [4]: http://github.com/kputnam/piggly/issues

data/bin/piggly

@@ -26,6 +26,7 @@ module Piggly
           uninstall_procs(sources)
           create_index(sources)
           create_reports(sources)
+          exit! 0 # avoid running tests again
         end
       end
 
@@ -172,10 +173,12 @@ module Piggly
       end
 
       def execute_tests
-        if defined? Spec::Runner
+        if defined?  Test::Unit::AutoRunner
+          Test::Unit::AutoRunner.run
+        elsif defined? Spec::Runner
           Spec::Runner.run
         else
-          Test::Unit::AutoRunner.run
+          raise "Neither RSpec nor Test::Unit were detected"
         end
       end
 

data/lib/piggly/parser/grammar.tt

@@ -13,7 +13,7 @@ grammar Piggly
     procedureHeader
     name:tIdentifier tSpace?
     parameters:parameterList tSpace
-    procedureReturn tSpace
+    procedureReturn
     return:tType tSpace kwAS tSpace
     procedureBody
     procedureFooter <Procedure>
@@ -24,7 +24,7 @@ grammar Piggly
   end
 
   rule procedureReturn
-    'returns' tSpace 'setof'? <TextNode>
+    'returns' tSpace ( 'setof' tSpace )? <TextNode>
   end
 
   rule procedureBody

data/lib/piggly/parser/parser.rb

@@ -61,32 +61,28 @@ module Piggly
       elements[5]
     end
 
-    def tSpace2
+    def return
       elements[6]
     end
 
-    def return
+    def tSpace2
       elements[7]
     end
 
-    def tSpace3
+    def kwAS
       elements[8]
     end
 
-    def kwAS
+    def tSpace3
       elements[9]
     end
 
-    def tSpace4
-      elements[10]
-    end
-
     def procedureBody
-      elements[11]
+      elements[10]
     end
 
     def procedureFooter
-      elements[12]
+      elements[11]
     end
   end
 
@@ -125,27 +121,23 @@ module Piggly
               r7 = _nt_procedureReturn
               s0 << r7
               if r7
-                r8 = _nt_tSpace
+                r8 = _nt_tType
                 s0 << r8
                 if r8
-                  r9 = _nt_tType
+                  r9 = _nt_tSpace
                   s0 << r9
                   if r9
-                    r10 = _nt_tSpace
+                    r10 = _nt_kwAS
                     s0 << r10
                     if r10
-                      r11 = _nt_kwAS
+                      r11 = _nt_tSpace
                       s0 << r11
                       if r11
-                        r12 = _nt_tSpace
+                        r12 = _nt_procedureBody
                         s0 << r12
                         if r12
-                          r13 = _nt_procedureBody
+                          r13 = _nt_procedureFooter
                           s0 << r13
-                          if r13
-                            r14 = _nt_procedureFooter
-                            s0 << r14
-                          end
                         end
                       end
                     end
@@ -280,6 +272,12 @@ module Piggly
     def tSpace
       elements[1]
     end
+  end
+
+  module ProcedureReturn1
+    def tSpace
+      elements[1]
+    end
 
   end
 
@@ -307,11 +305,24 @@ module Piggly
       r2 = _nt_tSpace
       s0 << r2
       if r2
+        i4, s4 = index, []
         if has_terminal?('setof', false, index)
-          r4 = instantiate_node(SyntaxNode,input, index...(index + 5))
+          r5 = instantiate_node(SyntaxNode,input, index...(index + 5))
           @index += 5
         else
           terminal_parse_failure('setof')
+          r5 = nil
+        end
+        s4 << r5
+        if r5
+          r6 = _nt_tSpace
+          s4 << r6
+        end
+        if s4.last
+          r4 = instantiate_node(SyntaxNode,input, i4...index, s4)
+          r4.extend(ProcedureReturn0)
+        else
+          @index = i4
           r4 = nil
         end
         if r4
@@ -324,7 +335,7 @@ module Piggly
     end
     if s0.last
       r0 = instantiate_node(TextNode,input, i0...index, s0)
-      r0.extend(ProcedureReturn0)
+      r0.extend(ProcedureReturn1)
     else
       @index = i0
       r0 = nil

data/lib/piggly/task.rb

@@ -23,7 +23,7 @@ module Piggly
       @test_files = []
       @proc_files = []
       @ruby_opts  = []
-      @output_dir = 'piggly/output'
+      @report_dir = 'piggly/report'
       @cache_root = 'piggly/cache'
       @piggly_path = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'bin', 'piggly'))
       @piggly_opts = ''
@@ -47,7 +47,7 @@ module Piggly
 
           ruby opts.join(' ') + ' ' +
                @piggly_opts   + ' ' +
-               %{-o #{quote @output_dir} } +
+               %{-o #{quote @report_dir} } +
                %{-c #{quote @cache_root} } +
                proc_files.map{|s| %[-s "#{s}" ] }.join +
                test_files.map{|f| quote(f) }.join(' ')

data/lib/piggly/version.rb

@@ -2,11 +2,11 @@ module Piggly
   module VERSION
     MAJOR = 1
     MINOR = 2
-    TINY  = 0
+    TINY  = 1
 
     STRING = [MAJOR, MINOR, TINY].join('.')
 
-    RELEASE_DATE = '2010-04-19'
+    RELEASE_DATE = '2010-04-22'
 
     def self.to_s
       STRING

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: piggly
 version: !ruby/object:Gem::Version 
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors: 
 - Kyle Putnam
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-19 00:00:00 +00:00
+date: 2010-04-22 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency