performance_tester 0.0.7 → 0.0.8

data/lib/performance_tester.rb

@@ -3,3 +3,15 @@ require 'performance_tester/runner'
 require 'performance_tester/scenario'
 require 'performance_tester/version'
 require 'performance_tester/logger'
+
+module PerformanceTester
+  module_function
+
+  def build_scenario(&block)
+    Scenario.new(&block)
+  end
+
+  def run_scenario(scenario, options = {})
+    Runner.new(options).run(scenario)
+  end
+end

data/lib/performance_tester/csv_logger.rb

@@ -2,6 +2,7 @@
 require 'csv'
 
 module PerformanceTester
+  # Writes or appends csv data to the filesystem
   class CsvLogger < Logger
     def path
       options.fetch(:path) { 'performance_test.csv' }

data/lib/performance_tester/logger.rb

@@ -17,6 +17,7 @@ module PerformanceTester
     raise ArgumentError, "Unregistered logger: #{name}"
   end
 
+  # Base logger with a stub log method
   class Logger
     attr_reader :run_name, :outcome, :options
 

data/lib/performance_tester/outcome.rb

@@ -32,6 +32,7 @@ module PerformanceTester
       error ? error.to_s : requests.map(&:to_s).inspect
     end
 
+    # Models an executed http request
     class Request
       attr_reader :url, :request_time, :response, :host_aliases
 
@@ -86,6 +87,7 @@ module PerformanceTester
         NullResponse.new(request_time, 0, '')
       end
 
+      # Models the odd case where a request has no response parts
       class NullResponse < Struct.new(:time, :status, :content_type); end
     end
   end

data/lib/performance_tester/puts_aggregate_logger.rb

@@ -1,13 +1,18 @@
 # encoding: UTF-8
 
 module PerformanceTester
+  # Prints summary data to stdout
   class PutsAggregateLogger < Logger
     def log
       puts "Test run: #{run_name}"
       puts "Success: #{outcome.success?}"
       puts "Number of requests: #{number_of_requests}"
-      puts "Sum of request times: #{sprintf("%.02f", sum_of_times_of_all_requests)}"
-      puts "Total time elapsed: #{sprintf("%.02f", total_time_elapsed)}"
+      puts "Sum of request times: #{d(sum_of_times_of_all_requests)}"
+      puts "Total time elapsed: #{d(total_time_elapsed)}"
+    end
+
+    def d(value)
+      sprintf("%.02f", value)
     end
 
     def total_time_elapsed

data/lib/performance_tester/runner.rb

@@ -84,6 +84,7 @@ module PerformanceTester
       options.fetch(:driver) { Capybara::Poltergeist::Driver }
     end
 
+    # Provides an execution context for scenarios
     class Context
       include Capybara::DSL
 

data/lib/performance_tester/version.rb

@@ -1,3 +1,3 @@
 module PerformanceTester
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: performance_tester
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors: