formatted-metrics 0.0.2 → 0.0.3

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode
+  - rbx-19mode
+script: bundle exec rake

data/README.md

@@ -1,5 +1,7 @@
 # Formatted Metrics
 
+[![Build Status](https://travis-ci.org/remind101/formatted-metrics.png)](https://travis-ci.org/remind101/formatted-metrics) [![Code Climate](https://codeclimate.com/github/remind101/formatted-metrics.png)](https://codeclimate.com/github/remind101/formatted-metrics)
+
 Easily produce metrics that can be consumed by [l2met](https://github.com/ryandotsmith/l2met).
 
 ## Installation
@@ -18,7 +20,7 @@ You're done!
 
 ### Rack
 
-Call `Metrics.setup` when you app boots.
+Call `Metrics.subscribe` when your app boots.
 
 ### Instrument
 

data/formatted-metrics.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'formatted-metrics/version'
+require 'metrics/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "formatted-metrics"

data/lib/formatted-metrics.rb

@@ -1 +1 @@
-require 'formatted-metrics/metrics'
+require 'metrics'

data/lib/metrics/instrumentable.rb

@@ -0,0 +1,72 @@
+require 'active_support/concern'
+
+module Metrics
+  module Instrumentable
+    extend ActiveSupport::Concern
+
+    # Public: See Metrics.instrument.
+    #
+    # Returns nothing.
+    def instrument(*args)
+      Metrics.instrument(*args)
+    end
+
+    module ClassMethods
+
+      # Internal: Used internally to specify the namespace for method
+      # instrumentation.
+      #
+      # Override this in your class if you need it to be something different.
+      #
+      # Example
+      #
+      # module Some
+      #   class Namespace
+      #     include Metrics::Instrumentable
+      #
+      #     def long_method; end
+      #     instrument :long_method
+      #   end
+      # end
+      #
+      # Some::Namespace.metric_namespace
+      # # => 'some.namespace'
+      #
+      # Some::Namespace.new.long_method
+      # # => 'source=app measure.some.namespace.long_method=10s'
+      #
+      # Returns a String namespace for the metric.
+      def metric_namespace
+        to_s.gsub(/::/, '.').downcase
+      end
+
+      # Public: Wraps the method with a call to instrument the duration of the
+      # method. Fancy!
+      #
+      # Example
+      #
+      #   def some_method
+      #     do_something_taxing
+      #   end
+      #
+      #   instrument :some_method
+      #   # => 'source=app measure.some_method=10s'
+      #
+      # Returns nothing.
+      def instrument(*methods)
+        methods.each do |name|
+          visibility = %w[public private protected].find { |visibility| send :"#{visibility}_method_defined?", name }
+          method = instance_method(name)
+          define_method name do |*args, &block|
+            method = method.bind(self)
+            instrument [self.class.metric_namespace, name].join('.') do
+              method.call(*args, &block)
+            end
+          end
+          send visibility, name
+        end
+      end
+
+    end
+  end
+end

data/lib/{formatted-metrics → metrics}/version.rb

@@ -1,3 +1,3 @@
 module FormattedMetrics
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/lib/{formatted-metrics/metrics.rb → metrics.rb}

@@ -1,12 +1,16 @@
 require 'active_support/notifications'
 require 'active_support/core_ext/array/extract_options'
+require 'active_support/dependencies/autoload'
 
-require 'formatted-metrics/railtie' if defined?(Rails)
+require 'metrics/railtie' if defined?(Rails)
 
 module Metrics
-  autoload :Configuration, 'formatted-metrics/configuration'
-  autoload :Handler,       'formatted-metrics/handler'
-  autoload :Formatter,     'formatted-metrics/formatter'
+  extend ActiveSupport::Autoload
+
+  autoload :Configuration
+  autoload :Handler
+  autoload :Formatter
+  autoload :Instrumentable
 
   class << self
 
@@ -33,11 +37,18 @@ module Metrics
     # Returns nothing.
     def instrument(metric, *args, &block)
       options = args.extract_options!
-      measure = !args.empty? ? args.first : true
-      ActiveSupport::Notifications.instrument \
+
+      measure = if args.empty?
+        block_given? ? true : 1
+      else
+        args.first
+      end
+
+      ActiveSupport::Notifications.instrument(
         metric,
         options.merge(measure: measure, source: options[:source]),
         &block
+      )
     end
 
     # Public: Subscribe to all ActiveSupport::Notifications events. Only events

data/spec/metrics/instrumentable_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe Metrics::Instrumentable do
+  let(:klass) do
+    Class.new do
+      include Metrics::Instrumentable
+
+      def self.to_s
+        'Some::Module'
+      end
+
+      def initialize
+        @foo = 'foo'
+      end
+
+      def long_method
+        @foo
+      end
+
+      def protected_method; end
+      def private_method; end
+
+      protected :protected_method
+      private :private_method
+
+      instrument :long_method, :protected_method, :private_method
+    end
+  end
+
+  describe '#instrument' do
+    it 'instruments the duration of the method' do
+      klass.any_instance.should_receive(:instrument).with('some.module.long_method').and_yield
+      expect(klass.new.long_method).to eq 'foo'
+    end
+
+    it 'sets the visibility of protected methods' do
+      expect(klass.public_method_defined?(:long_method)).to be_true
+    end
+
+    it 'sets the visibility of protected methods' do
+      expect(klass.protected_method_defined?(:protected_method)).to be_true
+    end
+
+    it 'sets the visibility of private methods' do
+      expect(klass.private_method_defined?(:private_method)).to be_true
+    end
+  end
+end

data/spec/{formatted-metrics/metrics_spec.rb → metrics_spec.rb}

@@ -31,5 +31,12 @@ describe Metrics do
         Metrics.instrument 'rack.request', 10, source: 'foo'
       end
     end
+
+    context 'with empty no block and no measurement' do
+      it 'instruments with a measurement of 1' do
+        instrumenter.should_receive(:instrument).with('exception', measure: 1, source: nil)
+        Metrics.instrument 'exception'
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: formatted-metrics
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-30 00:00:00.000000000 Z
+date: 2013-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -84,21 +84,24 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - formatted-metrics.gemspec
 - lib/formatted-metrics.rb
-- lib/formatted-metrics/configuration.rb
-- lib/formatted-metrics/formatter.rb
-- lib/formatted-metrics/handler.rb
-- lib/formatted-metrics/metrics.rb
-- lib/formatted-metrics/railtie.rb
-- lib/formatted-metrics/version.rb
-- spec/formatted-metrics/formatter_spec.rb
-- spec/formatted-metrics/handler_spec.rb
-- spec/formatted-metrics/metrics_spec.rb
+- lib/metrics.rb
+- lib/metrics/configuration.rb
+- lib/metrics/formatter.rb
+- lib/metrics/handler.rb
+- lib/metrics/instrumentable.rb
+- lib/metrics/railtie.rb
+- lib/metrics/version.rb
+- spec/metrics/formatter_spec.rb
+- spec/metrics/handler_spec.rb
+- spec/metrics/instrumentable_spec.rb
+- spec/metrics_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/remind101/formatted-metrics
 licenses:
@@ -115,7 +118,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4022766637914995296
+      hash: -3422730749197559336
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -124,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4022766637914995296
+      hash: -3422730749197559336
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -132,7 +135,8 @@ signing_key:
 specification_version: 3
 summary: Easily output formatted metrics to stdout
 test_files:
-- spec/formatted-metrics/formatter_spec.rb
-- spec/formatted-metrics/handler_spec.rb
-- spec/formatted-metrics/metrics_spec.rb
+- spec/metrics/formatter_spec.rb
+- spec/metrics/handler_spec.rb
+- spec/metrics/instrumentable_spec.rb
+- spec/metrics_spec.rb
 - spec/spec_helper.rb