busted 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca3f17fb6e19fab0e2e5604ff88570507f8c1224
-  data.tar.gz: 15884ecda376d2f29feabd868d7d41de6bc25024
+  metadata.gz: 798beba5202a28ac6f4267be4c81248596a16dae
+  data.tar.gz: a698056e415519ddef76442a3a87c403102e3e05
 SHA512:
-  metadata.gz: d76855a302daf921cc84681c5a006872616671aa0ca0eb6e4490ef967c738112191f25a1efcbea25496e5c6d2e4e545ff769bffe85561be84a9c1d1fc33a0625
-  data.tar.gz: 95305e22d2ad4168d506ca83d501e7cb55a0ab90337c0dbd8a2e1843f8661c1f8adccc83f28570f1f9e07138d4577de05614d440a702f5fab5496def07ae1c38
+  metadata.gz: b83f103bf02c10778f518bf10a6628bff8b42e98322a710bf7500ce5755f54f345162390e10c49ff0ced896746cbdda1e06f37e93a2d3bba3a10fb41d4246bb6
+  data.tar.gz: 455e19287871c565b23d5d5cf10f4b08c1fb49b37b50846bd8ef6e715be790014ef6d2b39767977b919daaee169671d52fca635eb5f1c3824d0a4a23a915b6cc

data/README.md

@@ -26,6 +26,12 @@ Busted.run do
   end
 end
 #=> {:invalidations=>{:method=>0, :constant=>1}}
+
+Busted.start
+class Pie
+end
+Busted.finish
+#=> {:invalidations=>{:method=>0, :constant=>1}}
 ```
 
 *Method Cache*
@@ -41,7 +47,19 @@ Busted.method_cache_invalidations do
   def pizza
   end
 end
-#=> 3
+#=> 1
+
+Busted.run do
+  def pie
+  end
+end
+#=> {:invalidations=>{:method=>1, :constant=>0}}
+
+Busted.start
+def smoothie
+end
+Busted.finish
+#=> {:invalidations=>{:method=>1, :constant=>0}}
 ```
 
 *Constant Cache*
@@ -56,6 +74,16 @@ Busted.constant_cache_invalidations do
   CHEESE = "cheese"
 end
 #=> 1
+
+Busted.run do
+  PIE = "pumpkin"
+end
+#=> {:invalidations=>{:method=>0, :constant=>1}}
+
+Busted.start
+SMOOTHIE = "blueberry"
+Busted.finish
+#=> {:invalidations=>{:method=>0, :constant=>1}}
 ```
 
 *No Cache Busted*
@@ -70,6 +98,11 @@ Busted.run do
   pizza = "pizza"
 end
 #=> {:invalidations=>{:method=>0, :constant=>0}}
+
+Busted.start
+pie = "pie"
+Busted.finish
+#=> {:invalidations=>{:method=>0, :constant=>0}}
 ```
 
 ## Advanced Usage
@@ -81,7 +114,8 @@ require "busted"
 require "pp"
 
 report = Busted.run(trace: true) do
-  def cookie; end
+  def cookie
+  end
 end
 pp report
 ```
@@ -108,6 +142,25 @@ $ ruby trace.rb
   {:method=>[{:class=>"global", :sourcefile=>"trace.rb", :lineno=>"5"}]}}
 ```
 
+*start_finish_trace.rb*
+```ruby
+require "busted"
+require "pp"
+
+Busted.start trace: true
+def ice_cream
+end
+pp Busted.finish
+```
+
+```bash
+$ ruby start_finish_trace.rb
+{:invalidations=>{:method=>1, :constant=>0},
+ :traces=>
+  {:method=>
+    [{:class=>"global", :sourcefile=>"start_finish_trace.rb", :lineno=>"5"}]}}
+```
+
 Busted includes an [example `dtrace` probe](/dtrace/probes/examples/method-cache-clear.d) for use on the command line or an application.  See the [probe](/dtrace/probes/examples/method-cache-clear.d) for usage.
 
 ## Installation

data/busted.gemspec

@@ -33,6 +33,7 @@ Gem::Specification.new do |spec|
     lib/busted/current_process.rb
     lib/busted/profiler.rb
     lib/busted/profiler/default.rb
+    lib/busted/profiler/sandwich.rb
     lib/busted/traceable.rb
     lib/busted/tracer.rb
     lib/busted/version.rb

data/lib/busted/profiler/default.rb

@@ -7,6 +7,10 @@ module Busted
 
       attr_reader :trace, :block, :report
 
+      def self.run(options = {}, &block)
+        new(options, &block).run
+      end
+
       def initialize(options = {}, &block)
         fail LocalJumpError, "no block given" unless block
 

data/lib/busted/profiler/sandwich.rb

@@ -0,0 +1,59 @@
+require "singleton"
+
+module Busted
+  module Profiler
+    class Sandwich
+
+      include Singleton
+
+      include Busted::Traceable
+      include Busted::Countable
+
+      VALID_ACTIONS = [:start, :finish].freeze
+
+      attr_accessor :action
+      attr_reader :trace, :report
+
+      def self.run(options = {})
+        action = options.fetch :action, false
+        trace = options.fetch :trace, false
+
+        unless VALID_ACTIONS.include? action
+          fail ArgumentError, "profiler requires start or finish action"
+        end
+
+        sandwich = instance
+
+        sandwich.action = action
+        sandwich.trace = trace
+        sandwich.run
+      end
+
+      def run
+        send action
+      end
+
+      def trace=(trace)
+        @trace = trace if start?
+      end
+
+      private
+
+      def start?
+        action == :start
+      end
+
+      def start
+        @report = {}
+        start_tracer
+        start_counter
+      end
+
+      def finish
+        finish_counter
+        finish_tracer
+        report
+      end
+    end
+  end
+end

data/lib/busted/profiler.rb

@@ -2,14 +2,16 @@ require "busted/counter"
 require "busted/countable"
 require "busted/tracer"
 require "busted/traceable"
-require "busted/profiler/default"
 
 module Busted
   module Profiler
     extend self
 
+    autoload :Default, "busted/profiler/default"
+    autoload :Sandwich, "busted/profiler/sandwich"
+
     def run(options, &block)
-      klass(options.fetch :profiler, :default).new(options, &block).run
+      klass(options.fetch :profiler, :default).run(options, &block)
     end
 
     private

data/lib/busted/version.rb

@@ -1,3 +1,3 @@
 module Busted
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/busted.rb

@@ -7,6 +7,14 @@ module Busted
     Profiler.run options, &block
   end
 
+  def start(options = {})
+    Profiler.run({ profiler: :sandwich, action: :start }.merge options)
+  end
+
+  def finish(options = {})
+    Profiler.run({ profiler: :sandwich, action: :finish }.merge options)
+  end
+
   def method_cache_invalidations(&block)
     run(&block)[:invalidations][:method]
   end

data/test/busted_test.rb

@@ -8,6 +8,13 @@ class BustedTest < MiniTest::Unit::TestCase
     assert_equal "profiler `pizza' does not exist", error.message
   end
 
+  def test_invalid_profiler_action_exception
+    error = assert_raises ArgumentError do
+      Busted.start profiler: :sandwich, action: :pizza
+    end
+    assert_equal "profiler requires start or finish action", error.message
+  end
+
   def test_cache_invalidations_requires_block
     assert_raises LocalJumpError do
       Busted.run
@@ -54,6 +61,14 @@ class BustedTest < MiniTest::Unit::TestCase
     assert_equal 0, Busted.constant_cache_invalidations { 1 + 1 }
   end
 
+  def test_start_finish_with_addition
+    Busted.start
+    1 + 1
+    report = Busted.finish
+    assert_equal 0, report[:invalidations][:method]
+    assert_equal 0, report[:invalidations][:constant]
+  end
+
   def test_cache_invalidations_with_new_constant
     report = Busted.run { self.class.const_set :"CHEESE", "cheese" }
     assert_equal 0, report[:invalidations][:method]
@@ -74,6 +89,14 @@ class BustedTest < MiniTest::Unit::TestCase
     assert_equal 1, invalidations
   end
 
+  def test_start_finish_with_new_constant
+    Busted.start
+    self.class.const_set :"PEPPERONI", "pepperoni"
+    report = Busted.finish
+    assert_equal 0, report[:invalidations][:method]
+    assert_equal 1, report[:invalidations][:constant]
+  end
+
   def test_cache_invalidations_with_new_method
     report = Busted.run { Object.class_exec { def cheese; end } }
     assert_equal 1, report[:invalidations][:method]
@@ -94,6 +117,14 @@ class BustedTest < MiniTest::Unit::TestCase
     assert_equal 0, invalidations
   end
 
+  def test_start_finish_with_new_method
+    Busted.start
+    Object.class_exec { def pepperoni; end }
+    report = Busted.finish
+    assert_equal 1, report[:invalidations][:method]
+    assert_equal 0, report[:invalidations][:constant]
+  end
+
   def test_cache_invalidations_with_new_class
     report = Busted.run { Object.class_eval "class ThreeCheese; end" }
     assert_equal 0, report[:invalidations][:method]
@@ -114,6 +145,14 @@ class BustedTest < MiniTest::Unit::TestCase
     assert_equal 1, invalidations
   end
 
+  def test_start_finish_with_new_class
+    Busted.start
+    Object.class_eval "class Pepperoni; end"
+    report = Busted.finish
+    assert_equal 0, report[:invalidations][:method]
+    assert_equal 1, report[:invalidations][:constant]
+  end
+
   def test_cache_predicate_requires_block
     assert_raises LocalJumpError do
       Busted.cache?
@@ -200,7 +239,18 @@ class BustedTest < MiniTest::Unit::TestCase
       assert_equal 0, report[:invalidations][:constant]
       assert_equal "global", report[:traces][:method][0][:class]
       assert_match /test\/busted_test.rb\z/, report[:traces][:method][0][:sourcefile]
-      assert_equal "198", report[:traces][:method][0][:lineno]
+      assert_equal "237", report[:traces][:method][0][:lineno]
+    end
+
+    def test_start_finish_and_traces_with_new_method
+      Busted.start trace: true
+      Object.class_exec { def candy; end }
+      report = Busted.finish
+      assert_equal 1, report[:invalidations][:method]
+      assert_equal 0, report[:invalidations][:constant]
+      assert_equal "global", report[:traces][:method][0][:class]
+      assert_match /test\/busted_test.rb\z/, report[:traces][:method][0][:sourcefile]
+      assert_equal "247", report[:traces][:method][0][:lineno]
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: busted
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Simeon F. Willbanks
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-19 00:00:00.000000000 Z
+date: 2013-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -60,6 +60,7 @@ files:
 - lib/busted/current_process.rb
 - lib/busted/profiler.rb
 - lib/busted/profiler/default.rb
+- lib/busted/profiler/sandwich.rb
 - lib/busted/traceable.rb
 - lib/busted/tracer.rb
 - lib/busted/version.rb