rspec-system 0.1.3 → 0.1.4

data/lib/rspec-system.rb

@@ -1,5 +1,6 @@
 require 'rspec'
 
+# Root module namespace for +rspec-system+
 module RSpecSystem; end
 
 require 'rspec-system/log'
@@ -7,12 +8,3 @@ require 'rspec-system/helpers'
 require 'rspec-system/node_set'
 require 'rspec-system/prefab'
 require 'rspec-system/node'
-
-RSpec::configure do |c|
-  c.include RSpecSystem::Helpers
-
-  # This provides a path to save vagrant files
-  c.add_setting :system_tmp
-  # Block to execute for environment setup
-  c.add_setting :system_setup_block
-end

data/lib/rspec-system/formatter.rb

@@ -12,10 +12,15 @@ module RSpecSystem
   # has started and finished. It also attempts to use color for visibility
   # as well as listing test case information in a more verbose way.
   class Formatter < RSpec::Core::Formatters::BaseTextFormatter
+    # Initialize formatter
     def initialize(output)
       super(output)
     end
 
+    # Display test start information
+    #
+    # @param count [Fixnum] number of tests to run
+    # @return [void]
     def start(count)
       super(count)
       output << "=================================================================\n\n"
@@ -23,17 +28,29 @@ module RSpecSystem
       output << bold("Total Test Count: ") << color(count, :cyan) << "\n\n"
     end
 
+    # Display output when an example has started
+    #
+    # @param example [RSpec::Core::Example] example that is running
+    # @return [void]
     def example_started(example)
       super(example)
       output << "=================================================================\n\n"
       output << bold("Running test:\n  ") << color(example.full_description, :magenta) << "\n\n"
     end
 
+    # Display output when an example has passed
+    #
+    # @param example [RSpec::Core::Example] example that is running
+    # @return [void]
     def example_passed(example)
       super(example)
       output << "\n" << bold('Result: ') << success_color('passed') << "\n\n"
     end
 
+    # Display output when an example is pending
+    #
+    # @param example [RSpec::Core::Example] example that is running
+    # @return [void]
     def example_pending(example)
       super(example)
       msg = example.execution_result[:pending_message]
@@ -41,6 +58,10 @@ module RSpecSystem
       output << bold("Reason: ") << "#{msg}\n\n"
     end
 
+    # Display output when an example has failed
+    #
+    # @param example [RSpec::Core::Example] example that is running
+    # @return [void]
     def example_failed(example)
       super(example)
       msg = example.execution_result[:exception]
@@ -49,6 +70,10 @@ module RSpecSystem
       output << bold("Reason:\n") << "#{msg}\n\n"
     end
 
+    # Obtains next index value so we can keep a count of what test we are upto
+    #
+    # @api private
+    # @return [Fixnum] index #
     def next_failure_index
       @next_failure_index ||= 0
       @next_failure_index += 1

data/lib/rspec-system/node_set.rb

@@ -2,6 +2,9 @@ module RSpecSystem
   # Factory class for NodeSet.
   class NodeSet
     # Returns a NodeSet object.
+    #
+    # @return [RSpecSystem::NodeSet::Base] returns an object based on the Base
+    #   abstract class.
     def self.create(setname, config, virtual_env)
       case(virtual_env)
       when 'vagrant'

data/lib/rspec-system/prefab.rb

@@ -1,4 +1,5 @@
 module RSpecSystem
+  # This object represents a prefab definition from the prefabs.yml file
   class Prefab
     attr_reader :name
     attr_reader :description

data/lib/rspec-system/rake_task.rb

@@ -1,3 +1,5 @@
+# Include this file to create the spec:* rake tasks
+
 require 'rubygems'
 require "bundler/setup"
 

data/lib/rspec-system/spec_helper.rb

@@ -1,3 +1,6 @@
+# This file provides a require-able entry point for putting at the top of your
+# tests, or in a shared helper.
+
 require 'rspec-system'
 require 'yaml'
 require 'pp'
@@ -5,6 +8,12 @@ require 'tempfile'
 
 RSpec.configure do |c|
   include RSpecSystem::Log
+  c.include RSpecSystem::Helpers
+
+  # This provides a path to save vagrant files
+  c.add_setting :system_tmp
+  # Block to execute for environment setup
+  c.add_setting :system_setup_block
 
   def nodeset
     Pathname.new(File.join(File.basename(__FILE__), '..', '.nodeset.yml'))

data/rspec-system.gemspec

@@ -2,7 +2,7 @@
 Gem::Specification.new do |s|
   # Metadata
   s.name        = "rspec-system"
-  s.version     = "0.1.3"
+  s.version     = "0.1.4"
   s.authors     = ["Ken Barber"]
   s.email       = ["ken@bob.sh"]
   s.homepage    = "https://github.com/kbarber/rspec-system"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-system
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-30 00:00:00.000000000 Z
+date: 2013-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec