nunes 0.2.0 → 0.3.0

data/Changelog.md

@@ -1,3 +1,9 @@
+# 0.3.0
+
+## Backwards Compatibility Break
+
+* Cleaning action view template and partial paths before sending to adapter. Prior to this change, action view metrics looked like: action_view.template.app.views.posts.post.html.erb. They now look like: action_view.template.app_views_posts_post_html_erb. The reason is that "." is typically a namespace in most metric services, which means really deep nesting of metrics, especially for views rendered from engines in gems. This keeps shallows up the nesting. Thanks to @dewski for reporting.
+
 # 0.2.0
 
 ## Backwards Compatibility Break

data/README.md

@@ -16,6 +16,10 @@ Or install it yourself as:
 
     $ gem install nunes
 
+## Compatibility
+
+* >= Ruby 1.9
+
 ## Usage
 
 nunes works out of the box with [instrumental app](http://instrumentalapp.com) (my person favorite) and [statsd](https://github.com/reinh/statsd). All you need to do is subscribe using an instance of statsd or instrumental's agent and you are good to go.

data/lib/nunes/adapter.rb

@@ -57,19 +57,17 @@ module Nunes
     # Private: The default metric namespace separator.
     Separator = "."
 
-    RegexSeparator = Regexp.escape(Separator)
-
-    # Private: Regex to match metric ending with separator.
-    StartsOrEndsWithSeparator = /\A#{RegexSeparator}|#{RegexSeparator}\Z/
-
     # Private
     Nothing = ""
 
     # Private: Prepare a metric name before it is sent to the adapter's client.
-    def prepare(metric)
-      metric = metric.to_s.gsub(ReplaceRegex, Separator)
-      metric.squeeze!(Separator)
-      metric.gsub!(StartsOrEndsWithSeparator, Nothing)
+    def prepare(metric, replacement = Separator)
+      escaped = Regexp.escape(replacement)
+      replace_begin_end_regex = /\A#{escaped}|#{escaped}\Z/
+
+      metric = metric.to_s.gsub(ReplaceRegex, replacement)
+      metric.squeeze!(replacement)
+      metric.gsub!(replace_begin_end_regex, Nothing)
       metric
     end
   end

data/lib/nunes/subscribers/action_view.rb

@@ -29,14 +29,17 @@ module Nunes
         end
       end
 
+      # Private: What to replace file separators with.
+      FileSeparatorReplacement = "_"
+
       # Private: Converts an identifier to a metric name. Strips out the rails
       # root from the full path.
       #
       # identifier - The String full path to the template or partial.
       def identifier_to_metric(kind, identifier)
-        rails_root = ::Rails.root.to_s + File::SEPARATOR
-        view_path = identifier.gsub(rails_root, '')
-        "action_view.#{kind}.#{view_path}" if view_path
+        view_path = identifier.to_s.gsub(::Rails.root.to_s, "")
+        metric = adapter.prepare(view_path, FileSeparatorReplacement)
+        "action_view.#{kind}.#{metric}"
       end
     end
   end

data/lib/nunes/version.rb

@@ -1,3 +1,3 @@
 module Nunes
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/test/adapter_test.rb

@@ -106,11 +106,11 @@ class AdapterTest < ActiveSupport::TestCase
     end
   end
 
-  test "prepare does not modify original metric" do
+  test "prepare does not modify original metric object" do
     adapter = Nunes::Adapter.new(nil)
-    original = "app/views/posts"
+    original = "app.views.posts"
     result = adapter.prepare("original")
 
-    assert_equal "app/views/posts", original
+    assert_equal "app.views.posts", original
   end
 end

data/test/view_instrumentation_test.rb

@@ -18,13 +18,13 @@ class ViewInstrumentationTest < ActionController::TestCase
     get :index
 
     assert_response :success
-    assert_timer "action_view.template.app.views.posts.index.html.erb"
+    assert_timer "action_view.template.app_views_posts_index_html_erb"
   end
 
   test "render_partial" do
     get :index
 
     assert_response :success
-    assert_timer "action_view.partial.app.views.posts._post.html.erb"
+    assert_timer "action_view.partial.app_views_posts_post_html_erb"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nunes
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-23 00:00:00.000000000 Z
+date: 2013-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler