trip 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2d170e305895c49de5afa27d65e21481a42b0647
-  data.tar.gz: d2245ff1028cbe489f101e53ac352c460db424d2
+  metadata.gz: df109bcf001fd8ad968bd27973d20b5034a3c237
+  data.tar.gz: 2e93ecf46b29369798813bba40778f08a68ce080
 SHA512:
-  metadata.gz: 28639d5f905547c812c2696d6451984f2624b7327180e597b15f9891f972693204a179914fd6731caf346a97549a9f9088c0d76f79e4fad11e3722377406fe0c
-  data.tar.gz: c4ae55b130f2bf502a7c3626178065ab97128e44da94a9d16685b410451af9501938236a0500dc1dc3e352d1173e1b2ef0acf07255671c0bbdaed8cfa4a45acf
+  metadata.gz: 1f6a8ddbc84e2fdfaa897fa4d1eea599ea0839bfdbebf7df8ad310722843957dad10ab2c4bb1ee0603c89b3e559d492d50be23e644780f941f5b0d3c2dc93f49
+  data.tar.gz: 3059883e41d771a46821c529808bcaeabbf50ef0a70f473d780bb2a46feefd58645fbbf13e6e65a749b82ed4266df421fc8364a055610170f07d9af772ea8017

data/.gitignore

@@ -3,4 +3,5 @@
 *.rb~
 *.rb#
 pkg/
+.bundle/
 Gemfile.lock

data/.travis.yml

@@ -1,9 +1,9 @@
-install: bundle install
 script: ruby -S rake
 
 rvm:
-  - 1.9.3
-  - 2.1.3
+  - 1.9
+  - 2.1
+  - 2.2
   - ruby-head
 
 notifications:

data/Gemfile

@@ -1,6 +1,9 @@
-source 'https://rubygems.org'
-gemspec
-group :test do
-  gem 'minitest', require: ['minitest', 'minitest/spec']
-end
-
+source 'https://rubygems.org'
+gemspec
+group :dev, :test do
+  gem 'pry', '~> 0.10.1', git: 'https://github.com/pry/pry.git'
+end
+group :test do
+  gem 'minitest', '~> 5.4', require: ['minitest', 'minitest/spec']
+end
+

data/README.md

@@ -1,6 +1,6 @@
 __trip__
 
-[![Build Status](https://travis-ci.org/rpag/trip.svg?branch=master)](https://travis-ci.org/rpag/trip)  
+[![Build Status](https://travis-ci.org/rpag/trip.svg?branch=master)](https://travis-ci.org/rpag/trip)
 [![Code Climate](https://codeclimate.com/github/rpag/trip/badges/gpa.svg)](https://codeclimate.com/github/rpag/trip)
 
 trip is a concurrent tracer for the ruby programming language. It yields control
@@ -10,17 +10,6 @@ It can be useful when building developer tools like a debugger or if you want to
 step through code progmatically at runtime.
 
 
-__Limitations__
-
-trip is implemented with "Thread#set_trace_func". It can be a bottleneck, 
-especially when there are a large number of events being created. I have seen
-ruby grind to a halt when the codepath being traced is busy. It wouldn't be a good
-library to use with something like a production rails application, but it can be 
-useful when building developer tools.
-
-"Thread#set_trace_func" isn't well supported on any ruby implementation but the
-official MRI/CRuby implementations, so jruby+rubinius aren't supported.
-
 __Examples__
 
 __1.__
@@ -68,8 +57,8 @@ e3 = trip.resume  # returns nil (thread exits)
 
 __3.__
 
-Trip::Event#binding can be used to evaluate ruby while the trip 
-thread is sleeping. The example returns the value of the local 
+Trip::Event#binding can be used to evaluate ruby while the trip
+thread is sleeping. The example returns the value of the local
 variable "x" after the add method has been called.
 
 ```ruby
@@ -90,7 +79,7 @@ __Install__
 rubygems:
 
     gem install trip
-	
+
 git:
 
     git clone https://github.com/rpag/trip.git
@@ -98,6 +87,15 @@ git:
 	gem build trip.gemspec
 	gem install *.gem
 
+__Contributing__
+
+1. Fork it ( https://github.com/rpag/trip/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+
 __License__
 
-See MIT-LICENSE.txt file.
+MIT, see LICENSE.txt for details.

data/lib/trip.rb

@@ -1,167 +1,167 @@
-class Trip
-  require 'thread'
-  require_relative 'trip/event'
-  require_relative 'trip/version'
-
-  NotStartedError  = Class.new(RuntimeError)
-  NotFinishedError = Class.new(RuntimeError)
-
-  RUN_STATE   = 'run'
-  SLEEP_STATE = 'sleep'
-  END_STATE   = [nil, false]
-  CALL_E      = ['call', 'c-call']
-  RETURN_E    = ['return', 'c-return']
-  PAUSE_P     = Proc.new { |event|
-    CALL_E.include?(event.name) or RETURN_E.include?(event.name)
-  }
-
-  #
-  #  @param [Proc] &block
-  #    a block of code
-  #
-  #  @return [Trip]
-  #    returns an instance of Trip
-  #
-  def initialize(&block)
-    if block.equal?(nil)
-      raise ArgumentError, 'expected to receive a block but none given'
-    end
-    @thread = nil
-    @block  = block
-    @queue  = nil
-    @pause  = PAUSE_P
-  end
-
-  #
-  # @raise [ArgumentError]
-  #   when no arguments are received
-  #
-  # @param [Proc] callable
-  #   accepts a Proc or a block
-  #
-  # @return [Proc] 
-  #   returns a Proc
-  #
-  def pause?(callable = nil, &block)
-    pause = callable || block
-    if pause.equal?(nil)
-      raise ArgumentError, 'expected to receive a block but none given'
-    end
-    @pause = pause
-  end
-
-  #
-  #  @return [Boolean]
-  #    returns true when a trace has started
-  #
-  def started?
-    @thread != nil
-  end
-
-  #
-  #  @return [Boolean]
-  #    returns true when a tracer thread is running
-  #
-  def running?
-    @thread and @thread.status == RUN_STATE
-  end
-
-  #
-  #  @return [Boolean]
-  #    returns true when a tracer thread has finished
-  #
-  def finished?
-    @thread and END_STATE.include?(@thread.status)
-  end
-
-  #
-  #  @return [Boolean]
-  #    returns true when a tracer thread is sleeping
-  #
-  def sleeping?
-    @thread and @thread.status == SLEEP_STATE
-  end
-
-  #
-  #  resume the tracer
-  #
-  #  @raise [Trip::NotStartedError]
-  #    when the start method has not been called yet
-  #
-  #  @return [Trip::Event, nil]
-  #    returns an event or nil
-  #
-  def resume
-    unless started?
-      raise NotStartedError, 'the tracer has not been started'
-    end
-    if sleeping?
-      @thread.wakeup
-      @queue.deq
-    end
-  end
-
-  #
-  # start the tracer
-  #
-  # @raise [Trip::NotFinishedError]
-  #   when a trace is already in progress
-  #   
-  # @return [Trip::Event, nil]
-  #   returns an event, or nil 
-  #
-  def start
-    if started? and !finished?
-      raise NotFinishedError, 'a trace is still in progress'
-    end
-    @queue = Queue.new
-    @thread = Thread.new do
-      Thread.current.set_trace_func method(:on_event).to_proc
-      @block.call
-      Thread.current.set_trace_func(nil)
-      @queue.enq(nil)
-    end
-    @queue.deq
-  end
-
-  #
-  # stop the tracer
-  #
-  # @return [nil]
-  #   returns nil
-  #
-  def stop
-    if @thread
-      @thread.set_trace_func(nil)
-      @thread.exit
-      @thread.join
-      nil
-    end
-  end
-
-private
-  def on_event(name, file, lineno, method, binding, classname)
-    event = Event.new name, {
-      file:      file, 
-      lineno:    lineno, 
-      module:    classname,
-      method:    method,
-      binding:   binding
-    }
-    if event.file != __FILE__ and @pause.call(event)
-      @queue.enq(event)
-      Thread.stop
-    end
-  rescue Exception => e
-    warn <<-CRASH.each_line.map(&:lstrip)
-    (trip) the tracer has crashed! :(
-
-    #{e.class}:
-    #{e.message}
-
-    BACKTRACE
-    #{e.backtrace.join("\n")}
-    CRASH
-    Thread.current.set_trace_func(nil)
-  end
-end
+class Trip
+  require 'thread'
+  require_relative 'trip/event'
+  require_relative 'trip/version'
+
+  NotStartedError  = Class.new(RuntimeError)
+  NotFinishedError = Class.new(RuntimeError)
+
+  RUN_STATE   = 'run'
+  SLEEP_STATE = 'sleep'
+  END_STATE   = [nil, false]
+  CALL_E      = ['call', 'c-call']
+  RETURN_E    = ['return', 'c-return']
+  PAUSE_P     = Proc.new { |event|
+    CALL_E.include?(event.name) or RETURN_E.include?(event.name)
+  }
+
+  #
+  #  @param [Proc] &block
+  #    a block of code
+  #
+  #  @return [Trip]
+  #    returns an instance of Trip
+  #
+  def initialize(&block)
+    if block.equal?(nil)
+      raise ArgumentError, 'no block given'
+    end
+    @thread = nil
+    @block  = block
+    @queue  = nil
+    @pause  = PAUSE_P
+  end
+
+  #
+  # @raise [ArgumentError]
+  #   when no arguments are received
+  #
+  # @param [Proc] callable
+  #   accepts a Proc or a block
+  #
+  # @return [Proc]
+  #   returns a Proc
+  #
+  def pause?(callable = nil, &block)
+    pause = callable || block
+    if pause.equal?(nil)
+      raise ArgumentError, 'no block given'
+    end
+    @pause = pause
+  end
+
+  #
+  #  @return [Boolean]
+  #    returns true when a trace has started
+  #
+  def started?
+    @thread != nil
+  end
+
+  #
+  #  @return [Boolean]
+  #    returns true when a tracer thread is running
+  #
+  def running?
+    @thread and @thread.status == RUN_STATE
+  end
+
+  #
+  #  @return [Boolean]
+  #    returns true when a tracer thread has finished
+  #
+  def finished?
+    @thread and END_STATE.include?(@thread.status)
+  end
+
+  #
+  #  @return [Boolean]
+  #    returns true when a tracer thread is sleeping
+  #
+  def sleeping?
+    @thread and @thread.status == SLEEP_STATE
+  end
+
+  #
+  #  resume the tracer
+  #
+  #  @raise [Trip::NotStartedError]
+  #    when the start method has not been called yet
+  #
+  #  @return [Trip::Event, nil]
+  #    returns an event or nil
+  #
+  def resume
+    unless started?
+      raise NotStartedError, 'trace not started'
+    end
+    if sleeping?
+      @thread.wakeup
+      @queue.deq
+    end
+  end
+
+  #
+  # start the tracer
+  #
+  # @raise [Trip::NotFinishedError]
+  #   when a trace is already in progress
+  #
+  # @return [Trip::Event, nil]
+  #   returns an event, or nil
+  #
+  def start
+    if started? and !finished?
+      raise NotFinishedError, 'trace not finished'
+    end
+    @queue = Queue.new
+    @thread = Thread.new do
+      Thread.current.set_trace_func method(:on_event).to_proc
+      @block.call
+      Thread.current.set_trace_func(nil)
+      @queue.enq(nil)
+    end
+    @queue.deq
+  end
+
+  #
+  # stop the tracer
+  #
+  # @return [nil]
+  #   returns nil
+  #
+  def stop
+    if @thread
+      @thread.set_trace_func(nil)
+      @thread.exit
+      @thread.join
+      nil
+    end
+  end
+
+private
+  def on_event(name, file, lineno, method, binding, classname)
+    event = Event.new name, {
+      file:    file,
+      lineno:  lineno,
+      mod:     classname,
+      method:  method,
+      binding: binding
+    }
+    if event.file != __FILE__ and @pause.call(event)
+      @queue.enq(event)
+      Thread.stop
+    end
+  rescue Exception => e
+    warn <<-CRASH.each_line.map(&:lstrip)
+    (trip) the tracer has crashed.
+
+    #{e.class}:
+    #{e.message}
+
+    BACKTRACE
+    #{e.backtrace.join("\n")}
+    CRASH
+    Thread.current.set_trace_func(nil)
+  end
+end

data/lib/trip/event.rb

@@ -1,31 +1,30 @@
-class Trip::Event < BasicObject
-  Kernel  = ::Kernel
-  Time    = ::Time
-  CALLS   = %w(call c-call)
-  RETURNS = %w(return c-return)
-
-  attr_reader :name, :created_at
-
-  def initialize(name, event)
-    @name       = name
-    @event      = event
-    @created_at = Time.now
-  end
-
-  [:file, :lineno, :module, :method, :binding].each do |name|
-    define_method(name) { @event[name] }
-  end
-
-  #
-  # @return [Binding]
-  #   returns a binding for an instance of {Trip::Event}
-  #
-  def __binding__
-    Kernel.binding
-  end
-
-  def inspect
-    inspect_m = Kernel.instance_method(:inspect).bind(self)
-    inspect_m.call
-  end
-end
+class Trip::Event < BasicObject
+  Kernel  = ::Kernel
+  Time    = ::Time
+  CALLS   = %w(call c-call)
+  RETURNS = %w(return c-return)
+
+  attr_reader :name, :created_at
+
+  def initialize(name, event)
+    @name = name
+    @created_at = Time.now
+    @event = event
+  end
+
+  [:file, :lineno, :mod, :method, :binding].each do |name|
+    define_method(name) { @event[name] }
+  end
+
+  def inspect
+    "#<Trip::Event:0x#{__id__.to_s(16)} name='#{name}' created_at='#{created_at}' file='#{file}' lineno='#{lineno}' module='#{mod}' method='#{method}' binding=#{binding.inspect}>"
+  end
+
+  #
+  # @return [Binding]
+  #   returns a binding for an instance of {Trip::Event}
+  #
+  def __binding__
+    Kernel.binding
+  end
+end

data/lib/trip/version.rb

@@ -1,3 +1,3 @@
 class Trip
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/spec/setup.rb

@@ -1,3 +1,3 @@
-require 'bundler/setup'
-Bundler.require :default, :test
-Minitest.autorun
+require 'bundler/setup'
+Bundler.require :default, :test
+Minitest.autorun

data/spec/trip_event_spec.rb

@@ -0,0 +1,96 @@
+require_relative 'setup'
+describe Trip::Event do
+  class Y
+    def self.run
+      # ..
+    end
+  end
+
+  let(:trip) do
+    Trip.new { Y.run }
+  end
+
+  let(:event) do
+    trip.start
+  end
+
+  after do
+    trip.stop
+  end
+
+  describe '#name' do
+    describe 'call and return from a method implemented in Ruby' do
+      it 'returns "call"' do
+        e = trip.start
+        assert_equal 'call', e.name
+      end
+
+      it 'returns "return"' do
+        trip.start
+        e = trip.resume
+        assert_equal 'return', e.name
+      end
+    end
+
+    describe 'call and return from a method implemented in C' do
+      let(:trip) do
+        Trip.new { Kernel.print '' }.tap do |trip|
+          trip.pause? { |e| e.mod == Kernel and e.method == :print }
+        end
+      end
+
+      it 'returns "c-call"' do
+        e = trip.start
+        assert_equal 'c-call', e.name
+      end
+
+      it 'returns "c-return"' do
+        trip.start
+        e = trip.resume
+        assert_equal 'c-return', e.name
+      end
+    end
+  end
+
+  describe '#created_at' do
+    it 'returns a Time' do
+      assert_instance_of Time, event.created_at
+    end
+  end
+
+  describe '#mod' do
+    it 'returns a Module' do
+      assert_equal Y, event.mod
+    end
+  end
+
+  describe '#file' do
+    it 'returns __FILE__ from binding' do
+      assert_equal __FILE__, event.file
+    end
+  end
+
+  describe '#lineno' do
+    it 'returns __LINE__ from binding' do
+      assert_equal 4, event.lineno
+    end
+  end
+
+  describe '#method' do
+    it 'returns __method__ from binding' do
+      assert_equal :run, event.method
+    end
+  end
+
+  describe '#binding' do
+    it 'returns a binding' do
+      assert_instance_of Binding, event.binding
+    end
+  end
+
+  describe '#__binding__' do
+    it 'returns a binding for instance of Trip::Event' do
+      assert_equal true, Trip::Event === event.__binding__.eval('self')
+    end
+  end
+end

data/spec/trip_spec.rb

@@ -1,157 +1,114 @@
-require_relative 'setup'
-describe Trip do
-  class Planet
-    def echo(message)
-      return message
-    end
-  end
-
-  before do
-    @planet = Planet.new
-    @trip   = Trip.new { @planet.echo('ping') }
-  end
-
-  after do
-    unless @trip.finished?
-      @trip.stop
-    end
-  end
-
-  describe '#initialize' do
-    it 'raises an ArgumentError without a block' do
-      assert_raises(ArgumentError) { Trip.new }
-    end
-  end
-
-  describe '#start' do
-    it 'returns an instance of Trip::Event' do
-      assert Trip::Event === @trip.start
-    end
-
-    it 'returns nil with a false pause predicate' do
-      @trip.pause? { false }
-      assert_equal nil, @trip.start
-    end
-
-    it 'raises Trip::NotFinishedError' do
-      @trip.start
-      assert_raises(Trip::NotFinishedError) { @trip.start }
-    end
-  end
-
-  describe '#sleeping?' do
-    it 'returns true' do
-      @trip.start
-      assert_equal true, @trip.sleeping?
-    end
-
-    it 'returns false' do
-      @trip.start
-      @trip.resume while @trip.resume
-      assert_equal false, @trip.sleeping?
-    end
-  end
-
-  describe '#started?' do
-    it 'returns true' do
-      @trip.start
-      assert_equal true, @trip.started?
-    end
-
-    it 'returns false' do
-      assert_equal false, @trip.started?
-    end
-  end
-  
-  describe '#resume' do
-    it 'raises Trip::NotStartedError' do
-      assert_raises(Trip::NotStartedError) { @trip.resume }
-    end
-  end
-
-  describe '#pause?' do
-    it 'raises an ArgumentError' do
-      assert_raises(ArgumentError) { @trip.pause? }
-    end
-    
-    it 'accepts a Proc' do
-      obj = Proc.new {}
-      assert_equal obj, @trip.pause?(obj)
-    end
-  end
-
-  describe '#finished?' do
-    it 'returns true' do
-      @trip.start
-      @trip.resume while @trip.resume
-      assert_equal true, @trip.finished?
-    end
-
-    it 'returns false' do
-      @trip.start
-      assert_equal false, @trip.finished? 
-    end
-
-    it 'returns nil' do
-      assert_equal nil, @trip.finished?
-    end
-  end
-
-  describe '#running?' do
-    it 'returns false' do
-      @trip.start
-      @trip.resume while @trip.resume
-      assert_equal false, @trip.running?
-    end
-
-    it 'returns nil' do
-      assert_equal nil, @trip.running?
-    end
-  end
-
-  describe Trip::Event do
-    describe '#module' do
-      it 'returns a Module' do
-        e1 = @trip.start
-        assert_equal Planet, e1.module
-      end
-    end
-
-    describe '#method' do
-      it 'returns a method name' do
-        e1 = @trip.start
-        assert_equal :echo, e1.method
-      end
-    end
-
-    describe '#file' do
-      it 'returns a path' do
-        e1 = @trip.start
-        assert_equal __FILE__, e1.file
-      end
-    end
-
-    describe '#lineno' do
-      it 'returns an Integer' do
-        e1 = @trip.start
-        assert_kind_of Integer, e1.lineno
-      end
-    end
-
-    describe '#binding' do
-      it 'returns a Binding with access to the local variable "message"' do 
-        @trip.pause? { |e| e.name == 'call' or e.name == 'return' }
-        e1 = @trip.start
-        e2 = @trip.resume
-        assert_equal 'ping', e2.binding.eval('message')
-      end
-    end
-
-    describe '#__binding__' do
-      it 'returns a Binding for an instance of Trip::Event' do
-        e1 = @trip.start
-        assert Trip::Event === e1.__binding__.eval('self')
-      end
-    end
-  end
-end
+require_relative 'setup'
+describe Trip do
+  let(:trip) do
+    Trip.new { planet.echo('ping') }
+  end
+
+  let(:planet) do
+    Planet.new
+  end
+
+  class Planet
+    def echo(message)
+      return message
+    end
+  end
+
+  after do
+    unless trip.finished?
+      trip.stop
+    end
+  end
+
+  describe '#initialize' do
+    it 'raises an ArgumentError without a block' do
+      assert_raises(ArgumentError) { Trip.new }
+    end
+  end
+
+  describe '#start' do
+    it 'returns an instance of Trip::Event' do
+      assert Trip::Event === trip.start
+    end
+
+    it 'returns nil with a false pause predicate' do
+      trip.pause? { false }
+      assert_equal nil, trip.start
+    end
+
+    it 'raises Trip::NotFinishedError' do
+      trip.start
+      assert_raises(Trip::NotFinishedError) { trip.start }
+    end
+  end
+
+  describe '#sleeping?' do
+    it 'returns true' do
+      trip.start
+      assert_equal true, trip.sleeping?
+    end
+
+    it 'returns false' do
+      trip.start
+      trip.resume while trip.resume
+      assert_equal false, trip.sleeping?
+    end
+  end
+
+  describe '#started?' do
+    it 'returns true' do
+      trip.start
+      assert_equal true, trip.started?
+    end
+
+    it 'returns false' do
+      assert_equal false, trip.started?
+    end
+  end
+  
+  describe '#resume' do
+    it 'raises Trip::NotStartedError' do
+      assert_raises(Trip::NotStartedError) { trip.resume }
+    end
+  end
+
+  describe '#pause?' do
+    it 'raises an ArgumentError' do
+      assert_raises(ArgumentError) { trip.pause? }
+    end
+    
+    it 'accepts a Proc' do
+      obj = Proc.new {}
+      assert_equal obj, trip.pause?(obj)
+    end
+  end
+
+  describe '#finished?' do
+    it 'returns true' do
+      trip.start
+      trip.resume while trip.resume
+      assert_equal true, trip.finished?
+    end
+
+    it 'returns false' do
+      trip.start
+      assert_equal false, trip.finished? 
+    end
+
+    it 'returns nil' do
+      assert_equal nil, trip.finished?
+    end
+  end
+
+  describe '#running?' do
+    it 'returns false' do
+      trip.start
+      trip.resume while trip.resume
+      assert_equal false, trip.running?
+    end
+
+    it 'returns nil' do
+      assert_equal nil, trip.running?
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trip
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - rpag
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-03 00:00:00.000000000 Z
+date: 2015-01-18 00:00:00.000000000 Z
 dependencies: []
 description: concurrent ruby tracer built with Thread#set_trace_func
 email: rpag@singletonclass.com
@@ -16,11 +16,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".bundle/config"
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
-- MIT-LICENSE.txt
+- LICENSE.txt
 - README.md
 - Rakefile
 - examples/concurrent.rb
@@ -29,6 +28,7 @@ files:
 - lib/trip/event.rb
 - lib/trip/version.rb
 - spec/setup.rb
+- spec/trip_event_spec.rb
 - spec/trip_spec.rb
 - trip.gemspec
 homepage: 

data/.bundle/config

@@ -1,3 +0,0 @@
----
-BUNDLE_PATH: ".gems"
-BUNDLE_DISABLE_SHARED_GEMS: '1'