ruby-usdt 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 465f1aa47fc3e1464824f95cec1bfc9ffab8fd29
-  data.tar.gz: af101a5e965a3aa2f235b5fe7f95eff573e6d622
+  metadata.gz: f317c8c2e8649772970b6ecc02f34f01c6a54aea
+  data.tar.gz: 7a8d37a898136fbc684920926e0df8f29690ce46
 SHA512:
-  metadata.gz: 836df20d76b44ae9e03952af0016e08bd1fbfbb46ca72624e29a9f73120499c59785b700eb900a33f8d45aa625772f9f6bb376aa7858c5a896cea8e193ace051
-  data.tar.gz: 6844f06f4be41aa88d9b3901f3fd0b2cfe1e9ceb4e021d4edd240183512f8110239fe4d84a8dd620f89e33b4a7382bd88725824f4483e9858835422d5b669650
+  metadata.gz: 42b69e212820428a4b511ac9918ccb7632cda0e2e31e03b87d4eb7056d6c40996c3a83a9f04b7b28c9a14c3d877ced4c7f32a84d719aea0c1c3105c972df474f
+  data.tar.gz: 822f30d495eaee483624c0e877054459bce2a960ee5d5e531e7118e0b44dad46ad70b0cac4c7bbe18fe354ccc7c2b54955c3220f4c9528522befc60152be13cc

data/README.md

@@ -70,6 +70,13 @@ probe.name      => :probe
 probe.arguments => [:string, :string, :integer]
 ```
 
+## Interoperability
+
+On systems with DTrace, this gem will compile C extensions that hook into USDT.
+On systems without DTrace, the gem should install with a noop implementation,
+so that probes can be added to projects without losing the ability to deploy to
+non-dtraceable platforms.
+
 ## Additional Resources
 
 - [User-Level-Statically Defined Tracing](http://www.solarisinternals.com/wiki/index.php/DTrace_Topics_USDT#USDT)

data/ext/usdt/extconf.rb

@@ -1,9 +1,11 @@
 require 'mkmf'
 
-have_library("dtrace", "dtrace_open", "/usr/include/dtrace.h")
-system("cd ../libusdt && make")
-system("cp ../libusdt/usdt.h ../libusdt/*.a ./")
-have_library('usdt')
-have_header('usdt.h')
-
-create_makefile('usdt')
+if have_library("dtrace", "dtrace_open", "/usr/include/dtrace.h")
+  system("cd ../libusdt && make")
+  system("cp ../libusdt/usdt.h ../libusdt/*.a ./")
+  have_header('usdt.h')
+  have_library('usdt')
+  create_makefile('usdt', 'real')
+else
+  create_makefile('usdt', 'stubs')
+end

data/ext/usdt/stubs/usdt.c

@@ -0,0 +1,3 @@
+#include <ruby.h>
+
+void Init_usdt() {}

data/lib/usdt.rb

@@ -1,2 +1,3 @@
 require "usdt/version"
 require 'usdt/usdt'
+require 'usdt/stubs' unless defined?(USDT::Provider)

data/lib/usdt/stubs.rb

@@ -0,0 +1 @@
+require 'usdt/stubs/provider'

data/lib/usdt/stubs/probe.rb

@@ -0,0 +1,19 @@
+module USDT
+  class Probe
+    attr_reader :function, :name, :arguments
+
+    def initialize(function, name, *args)
+      @function = function.to_sym
+      @name = name.to_sym
+      @arguments = args
+    end
+
+    def enabled?
+      false
+    end
+
+    def fire(*args)
+      false
+    end
+  end
+end

data/lib/usdt/stubs/provider.rb

@@ -0,0 +1,28 @@
+require 'usdt/stubs/probe'
+
+module USDT
+  class Provider
+    attr_reader :provider, :mod
+
+    def self.create(provider, mod)
+      new(provider, mod)
+    end
+
+    def initialize(provider, mod)
+      @provider = provider
+      @mod = mod
+    end
+
+    def enable
+      true
+    end
+
+    def disable
+      true
+    end
+
+    def probe(*args)
+      USDT::Probe.new(*args)
+    end
+  end
+end

data/lib/usdt/version.rb

@@ -1,3 +1,3 @@
 module USDT
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)

data/spec/stubs/probe_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+require 'usdt/stubs/probe'
+
+describe USDT::Probe do
+  let(:probe) { USDT::Probe.new(:fn, :name, :string, :integer) }
+
+  describe 'initialization' do
+    context 'with symbols' do
+      let(:probe) { USDT::Probe.new(:fn, :name, :string, :integer) }
+
+      it 'sets attributes' do
+        expect(probe.function).to eq(:fn)
+        expect(probe.name).to eq(:name)
+        expect(probe.arguments).to eq([:string, :integer])
+      end
+    end
+
+    context 'with strings' do
+      let(:probe) { USDT::Probe.new('fn', 'name', :string, :integer) }
+
+      it 'symbolizes attributes' do
+        expect(probe.function).to eq(:fn)
+        expect(probe.name).to eq(:name)
+        expect(probe.arguments).to eq([:string, :integer])
+      end
+    end
+  end
+
+  describe 'enabled?' do
+    it 'is false' do
+      expect(probe.enabled?).to be false
+    end
+  end
+
+  describe 'fire' do
+    it 'is false' do
+      expect(probe.fire('thing', 'blah', 0, 1)).to be false
+    end
+  end
+end

data/spec/stubs/provider_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+require 'usdt/stubs'
+
+describe USDT::Provider do
+  let(:provider) { USDT::Provider.create :ruby, :test }
+
+  describe 'initialization' do
+    it 'sets provider' do
+      expect(provider.provider).to eq(:ruby)
+    end
+
+    it 'sets module' do
+      expect(provider.mod).to eq(:test)
+    end
+  end
+
+  describe 'enable' do
+    it 'succeeds' do
+      expect(provider.enable).to be true
+    end
+  end
+
+  describe 'disable' do
+    it 'succeeds' do
+      expect(provider.disable).to be true
+    end
+  end
+
+  describe 'probe' do
+    let(:probe) { provider.probe(:fn, :name, :string, :string) }
+
+    it 'creates a probe' do
+      expect(probe).to be_a(USDT::Probe)
+    end
+
+    it 'sets probe function' do
+      expect(probe.function).to eq(:fn)
+    end
+
+    it 'sets probe name' do
+      expect(probe.name).to eq(:name)
+    end
+
+    it 'sets probe arguments' do
+      expect(probe.arguments).to eq([:string, :string])
+    end
+  end
+end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: ruby-usdt
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Kevin Chan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-12 00:00:00.000000000 Z
-dependencies: []
+date: 2014-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - kevin@yinkei.com
@@ -18,6 +46,9 @@ extensions:
 - ext/usdt/extconf.rb
 extra_rdoc_files: []
 files:
+- lib/usdt/stubs/probe.rb
+- lib/usdt/stubs/provider.rb
+- lib/usdt/stubs.rb
 - lib/usdt/version.rb
 - lib/usdt.rb
 - ext/libusdt/LICENCE
@@ -36,10 +67,14 @@ files:
 - ext/libusdt/usdt_tracepoints_i386.s
 - ext/libusdt/usdt_tracepoints_x86_64.s
 - ext/usdt/extconf.rb
+- ext/usdt/real/usdt.c
+- ext/usdt/stubs/usdt.c
 - ext/usdt/test.rb
-- ext/usdt/usdt.c
 - README.md
 - LICENSE.md
+- spec/spec_helper.rb
+- spec/stubs/probe_spec.rb
+- spec/stubs/provider_spec.rb
 homepage: http://github.com/kevinykchan/ruby-usdt
 licenses: []
 metadata: {}
@@ -64,5 +99,7 @@ rubygems_version: 2.0.5
 signing_key: 
 specification_version: 4
 summary: Native DTrace probes for ruby.
-test_files: []
-has_rdoc: 
+test_files:
+- spec/spec_helper.rb
+- spec/stubs/probe_spec.rb
+- spec/stubs/provider_spec.rb