peck 0.2.1 → 0.3.0

data/README.md

@@ -127,7 +127,39 @@ specifications:
       should.disallow.get :show
     end
 
-## Documentation
+### Flavors
+
+You can either require parts of Peck you're using for your test suite or
+require an entire flavor. Flavors are pre-built configurations for common
+use cases. Right now there are three flavors:
+
+#### Vanilla
+
+    require 'peck/flavors/vanilla'
+
+Reports running specs with dots and ends with a short report.
+
+#### Quiet
+
+    require 'peck/flavors/quiet'
+
+Runs your specs but doesn't report the results. This is useful when testing
+Peck itself or your extensions for Peck.
+
+If you want to learn more about testing Peck itself read `examples/preamble.rb`.
+
+In the quiet flavor we do keep a counter, so you could write your own formatter using `Peck.counter`.
+
+##### Documentation
+
+The documentation runner is based on various other ‘documentation’ runners which are generally used for running on CI. This flavor reports the entire label for a spec and colored output. It also shows the runtime for a spec and can report slow specs.
+
+You can configure the report cutoff for slow specs. By default it's configured at 500ms.
+
+    require 'peck/notifiers/documentation'
+    Peck::Notifiers::Documentation.runtime_report_cutoff = 20 # milliseconds
+
+## Assertions
 
 Peck is still very much in flux and will probably change a lot in the coming
 months. Currently we support a small number of assertions:

data/lib/peck/flavors/documentation.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+require 'peck'
+require 'peck/delegates'
+require 'peck/counter'
+require 'peck/context'
+require 'peck/specification'
+require 'peck/expectations'
+require 'peck/notifiers/documentation'
+
+Peck::Notifiers::Documentation.use
+Peck.run_at_exit

data/lib/peck/notifiers/documentation.rb

@@ -0,0 +1,85 @@
+# encoding: utf-8
+
+require 'peck/notifiers/default'
+
+class Peck
+  class Notifiers
+    class Documentation < Peck::Notifiers::Default
+      class << self
+        # The cutoff point beyond which a test is reported as being slow.
+        # Expressed in milliseconds. Default is 500ms.
+        attr_accessor :runtime_report_cutoff
+      end
+      self.runtime_report_cutoff = 500
+
+      # Keeps all the labels, start, and end times for the specs
+      attr_accessor :details
+
+      # A FIFO queue of all the started specs being first on the queue means
+      # the spec has been reported as started. Being on the queue means the
+      # spec still needs to be reported as being finished.
+      attr_accessor :running
+
+      # Mutex to synchronize the access of the global data structures
+      attr_accessor :semaphore
+
+      def initialize
+        self.details = {}
+        self.running = []
+        self.semaphore = Mutex.new
+      end
+
+      def started_specification(spec)
+        self.semaphore.synchronize do
+          spec_id = spec.object_id
+          self.running.push(spec_id)
+          self.details[spec_id] ||= {}
+          self.details[spec_id][:started_at] = Time.now
+          self.details[spec_id][:label] = spec.label
+          write_documentation
+        end
+      end
+
+      def finished_specification(spec)
+        self.semaphore.synchronize do
+          spec_id = spec.object_id
+          self.details[spec_id][:finished_at] = Time.now
+          self.details[spec_id][:passed] = spec.passed?
+          write_documentation
+        end
+      end
+
+      protected
+
+      def write_spec_started(details)
+        $stdout.write(details[:label])
+      end
+
+      def write_spec_finished(details)
+        elapsed_time = ((details[:finished_at] - details[:started_at]) * 1000).round
+        color = self.class.runtime_report_cutoff < elapsed_time ? "\e[35m" : ''
+        if details[:passed]
+          $stdout.puts " \e[32m✓\e[0m #{color}(#{elapsed_time} ms)\e[0m"
+        else 
+          $stdout.puts " \e[31m✗ [FAILED]\e[0m"
+        end
+      end
+
+      def write_documentation
+        spec_id = self.running.first
+        details = self.details[spec_id]
+
+        unless details[:start_reported]
+          write_spec_started(details)
+          details[:start_reported] = true
+        end
+
+        if details[:finished_at]
+          write_spec_finished(details)
+          self.details.delete(spec_id)
+          self.running.shift
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: peck
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-08 00:00:00.000000000 Z
+date: 2013-08-12 00:00:00.000000000 Z
 dependencies: []
 description: ! '    Concurrent spec framework.
 
@@ -26,10 +26,12 @@ files:
 - lib/peck/delegates.rb
 - lib/peck/error.rb
 - lib/peck/expectations.rb
+- lib/peck/flavors/documentation.rb
 - lib/peck/flavors/quiet.rb
 - lib/peck/flavors/vanilla.rb
 - lib/peck/notifiers/base.rb
 - lib/peck/notifiers/default.rb
+- lib/peck/notifiers/documentation.rb
 - lib/peck/specification.rb
 - lib/peck.rb
 - COPYING