piggly 1.2.1 → 2.0.0

metadata

@@ -1,121 +1,164 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: piggly
-version: !ruby/object:Gem::Version 
-  version: 1.2.1
+version: !ruby/object:Gem::Version
+  version: 2.0.0
 platform: ruby
-authors: 
-- Kyle Putnam
+authors:
+- Kvle Putnam
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-04-22 00:00:00 +00:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2016-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: treetop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.14
   type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.14
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.4
 description: PostgreSQL PL/pgSQL stored procedure code coverage
-email: putnam.kyle@gmail.com
-executables: 
+email: putnam.kvle@gmail.com
+executables:
 - piggly
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- README.markdown
+files:
+- README.md
 - Rakefile
-- spec/profile_spec.rb
-- spec/grammar/expression_spec.rb
-- spec/grammar/tokens/datatype_spec.rb
-- spec/grammar/tokens/identifier_spec.rb
-- spec/grammar/tokens/label_spec.rb
-- spec/grammar/tokens/lval_spec.rb
-- spec/grammar/tokens/keyword_spec.rb
-- spec/grammar/tokens/sqlkeywords_spec.rb
-- spec/grammar/tokens/whitespace_spec.rb
-- spec/grammar/tokens/number_spec.rb
-- spec/grammar/tokens/string_spec.rb
-- spec/grammar/tokens/literal_spec.rb
-- spec/grammar/tokens/comment_spec.rb
-- spec/grammar/statements/assignment_spec.rb
-- spec/grammar/statements/loop_spec.rb
-- spec/grammar/statements/if_spec.rb
-- spec/grammar/statements/sql_spec.rb
-- spec/grammar/statements/exception_spec.rb
-- spec/parser_spec.rb
-- spec/fixtures/snippets.sql
-- spec/filecache_spec.rb
-- spec/reporter/html_spec.rb
-- spec/config_spec.rb
-- spec/compiler/tags_spec.rb
-- spec/compiler/queue_spec.rb
-- spec/compiler/cache_spec.rb
-- spec/compiler/rewrite_spec.rb
-- spec/compiler/trace_spec.rb
-- spec/compiler/pretty_spec.rb
-- spec/spec_suite.rb
-- spec/spec_helper.rb
+- bin/piggly
 - lib/piggly.rb
-- lib/piggly/util.rb
-- lib/piggly/version.rb
-- lib/piggly/parser/treetop_ruby19_patch.rb
-- lib/piggly/parser/traversal.rb
-- lib/piggly/parser/grammar.tt
-- lib/piggly/parser/nodes.rb
-- lib/piggly/parser/parser.rb
-- lib/piggly/reporter.rb
+- lib/piggly/command.rb
+- lib/piggly/command/base.rb
+- lib/piggly/command/report.rb
+- lib/piggly/command/test.rb
+- lib/piggly/command/trace.rb
+- lib/piggly/command/untrace.rb
 - lib/piggly/compiler.rb
-- lib/piggly/reporter/html.rb
-- lib/piggly/reporter/piggly.css
-- lib/piggly/reporter/sortable.js
-- lib/piggly/compiler/pretty.rb
-- lib/piggly/compiler/trace.rb
-- lib/piggly/compiler/cache.rb
-- lib/piggly/compiler/tags.rb
-- lib/piggly/compiler/queue.rb
-- lib/piggly/filecache.rb
-- lib/piggly/task.rb
+- lib/piggly/compiler/cache_dir.rb
+- lib/piggly/compiler/coverage_report.rb
+- lib/piggly/compiler/trace_compiler.rb
 - lib/piggly/config.rb
-- lib/piggly/parser.rb
+- lib/piggly/dumper.rb
+- lib/piggly/dumper/index.rb
+- lib/piggly/dumper/qualified_name.rb
+- lib/piggly/dumper/qualified_type.rb
+- lib/piggly/dumper/reified_procedure.rb
+- lib/piggly/dumper/skeleton_procedure.rb
 - lib/piggly/installer.rb
+- lib/piggly/parser.rb
+- lib/piggly/parser/grammar.tt
+- lib/piggly/parser/nodes.rb
+- lib/piggly/parser/traversal.rb
+- lib/piggly/parser/treetop_ruby19_patch.rb
 - lib/piggly/profile.rb
-- bin/piggly
-has_rdoc: true
+- lib/piggly/reporter.rb
+- lib/piggly/reporter/base.rb
+- lib/piggly/reporter/html_dsl.rb
+- lib/piggly/reporter/index.rb
+- lib/piggly/reporter/procedure.rb
+- lib/piggly/reporter/resources/highlight.js
+- lib/piggly/reporter/resources/piggly.css
+- lib/piggly/reporter/resources/sortable.js
+- lib/piggly/tags.rb
+- lib/piggly/task.rb
+- lib/piggly/util.rb
+- lib/piggly/util/blankslate.rb
+- lib/piggly/util/cacheable.rb
+- lib/piggly/util/enumerable.rb
+- lib/piggly/util/file.rb
+- lib/piggly/util/process_queue.rb
+- lib/piggly/util/thunk.rb
+- lib/piggly/version.rb
+- spec/examples/compiler/cacheable_spec.rb
+- spec/examples/compiler/report_spec.rb
+- spec/examples/compiler/trace_spec.rb
+- spec/examples/config_spec.rb
+- spec/examples/dumper/index_spec.rb
+- spec/examples/dumper/procedure_spec.rb
+- spec/examples/grammar/expression_spec.rb
+- spec/examples/grammar/statements/assignment_spec.rb
+- spec/examples/grammar/statements/declaration_spec.rb
+- spec/examples/grammar/statements/exception_spec.rb
+- spec/examples/grammar/statements/if_spec.rb
+- spec/examples/grammar/statements/loop_spec.rb
+- spec/examples/grammar/statements/sql_spec.rb
+- spec/examples/grammar/tokens/comment_spec.rb
+- spec/examples/grammar/tokens/datatype_spec.rb
+- spec/examples/grammar/tokens/identifier_spec.rb
+- spec/examples/grammar/tokens/keyword_spec.rb
+- spec/examples/grammar/tokens/label_spec.rb
+- spec/examples/grammar/tokens/literal_spec.rb
+- spec/examples/grammar/tokens/lval_spec.rb
+- spec/examples/grammar/tokens/number_spec.rb
+- spec/examples/grammar/tokens/sqlkeywords_spec.rb
+- spec/examples/grammar/tokens/string_spec.rb
+- spec/examples/grammar/tokens/whitespace_spec.rb
+- spec/examples/installer_spec.rb
+- spec/examples/parser/nodes_spec.rb
+- spec/examples/parser/traversal_spec.rb
+- spec/examples/parser_spec.rb
+- spec/examples/profile_spec.rb
+- spec/examples/reporter/html/dsl_spec.rb
+- spec/examples/reporter/html/index_spec.rb
+- spec/examples/reporter/html_spec.rb
+- spec/examples/reporter_spec.rb
+- spec/examples/tags_spec.rb
+- spec/examples/task_spec.rb
+- spec/examples/util/cacheable_spec.rb
+- spec/examples/util/enumerable_spec.rb
+- spec/examples/util/file_spec.rb
+- spec/examples/util/process_queue_spec.rb
+- spec/examples/util/thunk_spec.rb
+- spec/examples/version_spec.rb
+- spec/issues/007_spec.rb
+- spec/issues/008_spec.rb
+- spec/issues/018_spec.rb
+- spec/spec_helper.rb
+- spec/spec_suite.rb
 homepage: http://github.com/kputnam/piggly
-licenses: []
-
+licenses:
+- BSD-2-Clause
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 2.5.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: PL/pgSQL code coverage tool
 test_files: []
-

data/README.markdown

@@ -1,116 +0,0 @@
-# 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 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)
-* 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 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/.
-
-    $ cd piggly/example/
-    $ ../bin/piggly -s 'proc/*.sql' 'spec/**/*_spec.rb'
-    Loading 1 test files
-     > Completed in 0.30 seconds
-    Compiling 1 files
-    Compiling /home/kputnam/wd/piggly/example/proc/iterate.sql
-     > Completed in 0.09 seconds
-    Installing 1 proc files
-     > Completed in 0.02 seconds
-    Clearing previous run's profile
-     > Completed in 0.00 seconds
-    ...........
-
-    Finished in 0.025061 seconds
-
-    11 examples, 0 failures
-    Storing coverage profile
-     > Completed in 0.00 seconds
-    Removing trace code
-     > Completed in 0.00 seconds
-    Creating index
-     > Completed in 0.00 seconds
-    Creating reports
-     > Completed in 0.02 seconds
-     > Completed in 0.65 seconds
-
-    $ ls -alh piggly/reports/index.html
-    -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 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['proc/*.sql']
-
-        # this can be used if piggly is frozen in a Rails application
-        t.libs.concat Dir['vendor/gems/*/lib/'].sort.reverse
-        t.piggly_path = Dir['vendor/gems/piggly-*/bin/piggly'].sort.last
-      end
-    end
-
-    $ 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/lib/piggly/compiler/cache.rb

@@ -1,151 +0,0 @@
-module Piggly
-  module CompilerCache
-    def self.included(subclass)
-      subclass.extend(ClassMethods)
-    end
-
-    #
-    # Each cache unit (any group of data that should be expired and created
-    # together) can be broken apart, to prevent unmarshaling a huge block of
-    # data all at once.
-    #
-    # The interface works like a Hash, so the compile method should return a
-    # hash of objects. Each object is writen to a different file (named by the
-    # hash key) within the same directory. String objects are (usually) read
-    # and written directly to disk, while all other objects are (un-)Marshal'd
-    #
-    # Cache invalidation is done by comparing mtime timestamps on the cached
-    # object's file to all the "source" files (ruby libs, input files, etc)
-    # required to regenerate the data.
-    #
-    class FileCache
-      # Non-printable ASCII char indicates data should be Marshal'd
-      HINT = /[\000-\010\016-\037\177-\300]/
-
-      class << self
-        def lookup(cachedir, data={})
-          store[cachedir] ||= new(cachedir, data)
-        end
-
-        def dump(cachedir, hash)
-          FileUtils.mkdir(cachedir) unless File.exists?(cachedir)
-          FileUtils.touch(cachedir)
-
-          for key, data in hash
-            File.open(File.join(cachedir, key.to_s), 'wb') do |f|
-              if data.is_a?(String) and data[0,2] !~ HINT
-                # even Strings will be Marshal'd if the first two bytes contain non-ASCII
-                f.write data
-              else
-                Marshal.dump(data, f)
-              end
-            end
-          end
-
-          return hash
-        end
-
-        def load(cachedir, key)
-          File.open(File.join(cachedir, key.to_s)) do |io|
-            # detect Marshal'd data
-            if io.read(2) !~ HINT
-              io.rewind
-              io.read
-            else
-              io.rewind
-              Marshal.load(io)
-            end
-          end
-        end
-
-        # Creates cachedir (if missing) and destroys its contents
-        def clean(cachedir)
-          FileUtils.mkdir(cachedir) unless File.exists?(cachedir)
-          FileUtils.touch(cachedir)
-          FileUtils.rm(Dir["#{cachedir}/*"])
-        end
-
-        def store
-          @store ||= {}
-        end
-      end
-
-      # Destroys any existing cached data and write the given data to disk if data is not empty
-      def initialize(cachedir, data={})
-        @dir  = cachedir
-        @data = {}
-        replace(data) unless data.empty?
-      end
-
-      # Load +key+ from file system if needed
-      def [](key)
-        @data[key.to_s] ||= self.class.load(@dir, key)
-      end
-
-      # Writes through to file system
-      def []=(key, value)
-        @data[key.to_s] = value
-        self.class.dump(@dir, key.to_s => value)
-      end
-
-      # Writes through to file system
-      def update(hash)
-        hash.each do |key,value|
-          self[key] = value
-        end
-      end
-
-      def keys
-        Dir[@dir + '/*'].map{|e| File.basename(e) } | @data.keys
-      end
-
-      private
-
-      # Clears entire cache and replaces contents
-      def replace(data)
-        self.class.clean(@dir)
-        self.class.dump(@dir, data)
-
-        for key, value in data
-          # stringify keys
-          @data[key.to_s] = data
-        end
-      end
-    end
-
-    #
-    # Base class should define self.compiler_path and self.compile(tree, ...)
-    #
-    module ClassMethods
-      def cache_sources
-        [compiler_path, Parser.grammar_path, Parser.parser_path, Parser.nodes_path]
-      end
-
-      def stale?(source)
-        File.stale?(cache_path(source), source, *cache_sources)
-      end
-
-      # returns FileCache instance 
-      def cache(source, args={}, &block)
-        Parser.parser # load libraries
-        cachedir = cache_path(source)
-
-        if stale?(source)
-          begin
-            tree = Parser.cache(source)
-            data = compile(tree, args.update(:path => source), &block)
-            
-            # replaces old cached data with new data
-            FileCache.lookup(cachedir, data)
-          rescue Piggly::Parser::Failure
-            FileCache.clean(cachedir)
-            raise
-          end
-        else
-          FileCache.lookup(cachedir)
-        end
-      end
-    end
-
-  end
-end