timed_report 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8121bacc016d30f43c763990475d37b1c679a6ff
-  data.tar.gz: 5d905cf04ede060e761982336270d2e4deb2351c
+  metadata.gz: 145a3cc0df83810fe9e9195f3c75fe1986e69e9c
+  data.tar.gz: c59286e6190f37a445560b42ae9d246fc59eccf6
 SHA512:
-  metadata.gz: 1bc300f56cc6dc5aff930e74b4b80fdb88c7657cac840e0b2706edc14d2964431d555021b9ccab207f6bf51a74c8730efdda9b276d1785d02d3cc05bf9825ed8
-  data.tar.gz: b292258ebc5498190c7354230c13e034d009de323dd943c8cb69e25415a110c8254fbebf45709b66faeaa83fdddc7b53180c4feb4286ce97124c2229107f97f7
+  metadata.gz: 988b2b12d3f521042d8770074f782de7866f05afdc0c3660e1ce38dc61b0c82c6af3e4ad498783701ab7e187b6363b2a58a3329f6033becd869e9fd28eb5149b
+  data.tar.gz: 1cfa0523a979b40c19128a3c6626a6e66293c2b0d53613b1a4d4414617ec0897c9b0cf4168dcfdb44523293cd91020ae9ed640b9cafd729af1593848d5517307

data/example/simple_example.rb

@@ -20,4 +20,5 @@ tr.time_step()
 tr.add('sleep 0.5 with time_step()')
 
 # Export the report to the standard puts and the added method
-tr.finish()
+tr.finish()
+

data/lib/timed_report.rb

@@ -9,12 +9,15 @@ class TimedReport
   #
   # Arguments:
   #   named: (String)
-  def initialize named = nil
+  #   enabled: (boolean)
+  def initialize named = nil, enabled = true
+    @enabled = enabled
+    @groups = {}
     @intermediate_output = false
-    
+
     @start_time = Time.now
     @step_time = Time.now
-    
+
     @output = "\n=========================="
     
     if named != nil
@@ -30,6 +33,7 @@ class TimedReport
   # Arguments:
   #   val: (Boolean)
   def intermediate_output val = @intermediate_output
+    return nil unless @enabled
     @intermediate_output = val
     val
   end
@@ -44,6 +48,7 @@ class TimedReport
   # Arguments:
   #   method: (Proc or lambda)
   def add_output_method method
+    return nil unless @enabled
     @output_methods.push method
   end
 
@@ -52,6 +57,7 @@ class TimedReport
   # Example:
   #   >> tr.time_step()
   def time_step
+    return nil unless @enabled
     @step_time = Time.now
     "❤"
   end
@@ -65,6 +71,7 @@ class TimedReport
   #   txt: (String)
   #   with_time: (Boolean)
   def add txt, with_time = true
+    return nil unless @enabled
     if with_time
       timing_info = "%.5f: " % (Time.now - @step_time)
       time_step()
@@ -78,11 +85,36 @@ class TimedReport
     "❤"
   end
 
+  # Adds a time count with key between the last #add or #add_g or #time_step.
+  #
+  # Example:
+  #   >> tr.add_g("one step")
+  # 
+  # Arguments:
+  #   group: (String)
+  #   with_time: (Boolean)
+  def add_g group, with_time = true
+    return nil unless @enabled
+    @groups[group.to_sym] ||= 0
+
+    if with_time
+      @groups[group.to_sym] += (Time.now - @step_time)
+      time_step()
+    end
+
+    "❤"
+  end
+
   # Finish the report. Call this add the end to print the report!
   # 
   # Example:
   #   >> tr.finish()
   def finish
+    return nil unless @enabled
+    @output += "\n--------------------------" if @groups.length > 0
+    @groups.each do |k,v|
+      @output += "\n#{k}: %.5f" % v
+    end
     @output += "\n--------------------------"
     @output += "\nTotal time: %.5f" % (Time.now-@start_time)
     @output += "\n=========================="

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: timed_report
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Tom Aizenberg