sidekiq-statsd 0.1.0 → 0.1.1

data/.yardopts

@@ -1,3 +1,3 @@
---title 'Sidekiq::Throttler Documentation'
+--title 'Sidekiq::Statsd Documentation'
 --charset utf-8
 --markup markdown

data/README.md

@@ -31,12 +31,16 @@ Sidekiq::Statsd to your server middleware:
 ```ruby
 Sidekiq.configure_server do |config|
   config.server_middleware do |chain|
-    chain.add Sidekiq::Statsd, env: "production", prefix: "worker", host: "localhost", port: 8125
+    chain.add Sidekiq::Statsd::ServerMiddleware, env: "production", prefix: "worker", host: "localhost", port: 8125
   end
 end
-```
 
-## Usage
+# @param [Hash] options The options to initialize the StatsD client.
+# @option options [String] :env ("production") The env to segment the metric key (e.g. env.prefix.worker_name.success|failure).
+# @option options [String] :prefix ("worker") The prefix to segment the metric key (e.g. env.prefix.worker_name.success|failure).
+# @option options [String] :host ("localhost") The StatsD host.
+# @option options [String] :port ("8125") The StatsD port.
+```
 
 ## Contributing
 
@@ -48,4 +52,4 @@ end
 
 ## License
 
-MIT Licensed. See LICENSE.txt for details.
+MIT Licensed. See LICENSE.txt for details.

data/lib/sidekiq/statsd/client.rb

@@ -8,17 +8,17 @@ module Sidekiq::Statsd
     # Initializes StatsD client with options.
     #
     # @param [Hash] options The options to initialize the StatsD client.
-    # @option options [String] :env ("production")
-    # @option options [String] :prefix ("worker")
-    # @option options [String] :host ("localhost")
-    # @option options [String] :port ("8125")
+    # @option options [String] :env ("production") The env to segment the metric key (e.g. env.prefix.worker_name.success|failure).
+    # @option options [String] :prefix ("worker") The prefix to segment the metric key (e.g. env.prefix.worker_name.success|failure).
+    # @option options [String] :host ("localhost") The StatsD host.
+    # @option options [String] :port ("8125") The StatsD port.
     def initialize options={}
-      @options = { "env"    => "production",
-                   "prefix" => "worker",
-                   "host"   => "localhost",
-                   "port"   => 8125 }.merge options
+      @options = { env:    "production",
+                   prefix: "worker",
+                   host:   "localhost",
+                   port:   8125 }.merge options
 
-      @statsd_client = ::Statsd.new @options["host"], @options["port"]
+      @statsd_client = ::Statsd.new @options[:host], @options[:port]
     end
 
     ##
@@ -28,7 +28,7 @@ module Sidekiq::Statsd
     #
     # @param key [String] The key to be incremented.
     def increment key
-      @statsd_client.increment [@options["env"], @options["prefix"], key].join(".")
+      @statsd_client.increment [@options[:env], @options[:prefix], key].join(".")
     end
   end
 end

data/lib/sidekiq/statsd/server_middleware.rb

@@ -9,12 +9,12 @@ module Sidekiq::Statsd
     # Initializes the middleware with options.
     #
     # @param [Hash] options The options to initialize the StatsD client.
-    # @option options [String] :env ("production")
-    # @option options [String] :prefix ("worker")
-    # @option options [String] :host ("localhost")
-    # @option options [String] :port ("8125")
+    # @option options [String] :env ("production") The env to segment the metric key (e.g. env.prefix.worker_name.success|failure).
+    # @option options [String] :prefix ("worker") The prefix to segment the metric key (e.g. env.prefix.worker_name.success|failure).
+    # @option options [String] :host ("localhost") The StatsD host.
+    # @option options [String] :port ("8125") The StatsD port.
     def initialize options={}
-      @options = options
+      @statsd = Sidekiq::Statsd::Client.new options
     end
 
     ##
@@ -24,13 +24,12 @@ module Sidekiq::Statsd
     # @param msg [Hash] The job message.
     # @param queue [String] The current queue.
     def call worker, msg, queue
-      stastd = Sidekiq::Statsd::Client.new @options
       yield
-      stastd.increment [worker.class.name, "success"].join(".")
+      @statsd.increment [worker.class.name, "success"].join(".")
     rescue => e
-      stastd.increment [worker.class.name, "failure"].join(".")
+      @statsd.increment [worker.class.name, "failure"].join(".")
       raise e
     end
-  end # Statsd
+  end # ServerMiddleware
 end # Sidekiq
 

data/lib/sidekiq/statsd/version.rb

@@ -1,6 +1,6 @@
 module Sidekiq
   module Statsd
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end
 

data/spec/sidekiq/statsd/client_spec.rb

@@ -9,24 +9,24 @@ describe Sidekiq::Statsd::Client do
 
   context "user defined options" do
     let(:options) do
-      { "prefix" => "super",
-        "env"    => "man",
-        "host"   => "lobster",
-        "port"   => 6666 }
+      { prefix: "super",
+        env:    "man",
+        host:   "lobster",
+        port:   6666 }
     end
 
     subject(:statsd) { described_class.new options }
 
     describe "#initialize" do
       it "initializes Statsd client" do
-        ::Statsd.should_receive(:new).with options["host"], options["port"]
+        ::Statsd.should_receive(:new).with options[:host], options[:port]
         statsd
       end
     end
 
     describe "#increment" do
       it "increments counter" do
-        statsd_client.should_receive(:increment).with [options["env"], options["prefix"], worker_name].join(".")
+        statsd_client.should_receive(:increment).with [options[:env], options[:prefix], worker_name].join(".")
         statsd.increment worker_name
       end
     end

data/spec/spec_helper.rb

@@ -8,6 +8,7 @@ unless ENV["CI"]
   require "simplecov"
   SimpleCov.start do
     add_filter "/spec/"
+    add_filter "/vendor/"
   end
 end
 

data/vendor/ruby/1.9.1/bin/yard

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#!/Users/pablo/.rvm/rubies/ruby-1.9.3-p392/bin/ruby
 #
 # This file was generated by RubyGems.
 #

data/vendor/ruby/1.9.1/bin/yardoc

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#!/Users/pablo/.rvm/rubies/ruby-1.9.3-p392/bin/ruby
 #
 # This file was generated by RubyGems.
 #

data/vendor/ruby/1.9.1/bin/yri

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#!/Users/pablo/.rvm/rubies/ruby-1.9.3-p392/bin/ruby
 #
 # This file was generated by RubyGems.
 #

data/vendor/ruby/1.9.1/gems/yard-0.8.6.1/lib/yard/tags/default_factory.rb

@@ -0,0 +1,176 @@
+module YARD
+  module Tags
+    class DefaultFactory
+      TYPELIST_OPENING_CHARS = '[({<'
+      TYPELIST_CLOSING_CHARS = '>})]'
+
+      # Parses tag text and creates a new tag with descriptive text
+      #
+      # @param tag_name        the name of the tag to parse
+      # @param [String] text   the raw tag text
+      # @return [Tag]          a tag object with the tag_name and text values filled
+      def parse_tag(tag_name, text)
+        Tag.new(tag_name, text.strip)
+      end
+
+      # Parses tag text and creates a new tag with a key name and descriptive text
+      #
+      # @param tag_name        the name of the tag to parse
+      # @param [String] text   the raw tag text
+      # @return [Tag]          a tag object with the tag_name, name and text values filled
+      def parse_tag_with_name(tag_name, text)
+        name, text = *extract_name_from_text(text)
+        Tag.new(tag_name, text, nil, name)
+      end
+
+      # Parses tag text and creates a new tag with formally declared types and
+      # descriptive text
+      #
+      # @param tag_name        the name of the tag to parse
+      # @param [String] text   the raw tag text
+      # @return [Tag]          a tag object with the tag_name, types and text values filled
+      def parse_tag_with_types(tag_name, text)
+        name, types, text = *extract_types_and_name_from_text(text)
+        raise TagFormatError, "cannot specify a name before type list for '@#{tag_name}'" if name
+        Tag.new(tag_name, text, types)
+      end
+
+      # Parses tag text and creates a new tag with formally declared types, a key
+      # name and descriptive text
+      #
+      # @param tag_name        the name of the tag to parse
+      # @param [String] text   the raw tag text
+      # @return [Tag]          a tag object with the tag_name, name, types and text values filled
+      def parse_tag_with_types_and_name(tag_name, text)
+        name, types, text = *extract_types_and_name_from_text(text)
+        name, text = *extract_name_from_text(text) unless name
+        Tag.new(tag_name, text, types, name)
+      end
+
+      # Parses tag text and creates a new tag with formally declared types, a title
+      # on the first line and descriptive text
+      #
+      # @param tag_name        the name of the tag to parse
+      # @param [String] text   the raw tag text
+      # @return [Tag]          a tag object with the tag_name, name, types and text values filled
+      def parse_tag_with_types_and_title(tag_name, text)
+        name, types, text = *extract_types_and_name_from_text_unstripped(text)
+        if name
+          title, desc = name, text
+        else
+          title, desc = *extract_title_and_desc_from_text(text)
+        end
+        Tag.new(tag_name, desc, types, title)
+      rescue TagFormatError
+        Tag.new(tag_name, '', types, nil)
+      end
+
+      def parse_tag_with_title_and_text(tag_name, text)
+        title, desc = *extract_title_and_desc_from_text(text)
+        Tag.new(tag_name, desc, nil, title)
+      end
+
+      def parse_tag_with_types_name_and_default(tag_name, text)
+        # Can't allow () in a default tag, otherwise the grammar is too ambiguous when types is omitted.
+        open, close = TYPELIST_OPENING_CHARS.gsub('(', ''), TYPELIST_CLOSING_CHARS.gsub(')', '')
+        name, types, text = *extract_types_and_name_from_text(text, open, close)
+        name, text = *extract_name_from_text(text) unless name
+        if text =~ /\A\(/
+          _, default, text = *extract_types_and_name_from_text(text, '(', ')')
+          DefaultTag.new(tag_name, text, types, name, default)
+        else
+          DefaultTag.new(tag_name, text, types, name, nil)
+        end
+      end
+
+      def parse_tag_with_options(tag_name, text)
+        name, text = *extract_name_from_text(text)
+        OptionTag.new(tag_name, name, parse_tag_with_types_name_and_default(tag_name, text))
+      end
+
+      private
+
+      # Extracts the name from raw tag text returning the name and remaining value
+      #
+      # @param [String] text the raw tag text
+      # @return [Array] an array holding the name as the first element and the
+      #                 value as the second element
+      def extract_name_from_text(text)
+        text.strip.split(/\s+/, 2)
+      end
+
+      def extract_title_and_desc_from_text(text)
+        raise TagFormatError if text.nil? || text.empty?
+        title, desc = nil, nil
+        if text =~ /\A[ \t]\n/
+          desc = text
+        else
+          text = text.split(/\r?\n/)
+          title = text.shift.squeeze(' ').strip
+          desc = text.join("\n")
+        end
+        [title, desc]
+      end
+
+      # Parses a [], <>, {} or () block at the beginning of a line of text
+      # into a list of comma delimited values.
+      #
+      # @example
+      #   obj.parse_types('[String, Array<Hash, String>, nil]') # => [nil, ['String', 'Array<Hash, String>', 'nil'], ""]
+      #   obj.parse_types('b<String> A string') # => ['b', ['String'], 'A string']
+      #
+      # @return [Array(String, Array<String>, String)] the text before the type
+      #   list (or nil), followed by the type list parsed into an array of
+      #   strings, followed by the text following the type list.
+      def extract_types_and_name_from_text(text, opening_types = TYPELIST_OPENING_CHARS, closing_types = TYPELIST_CLOSING_CHARS)
+        before, list, text = *extract_types_and_name_from_text_unstripped(text, opening_types, closing_types)
+        if list.nil?
+          [nil, nil, text.strip]
+        else
+          [before ? before.strip : nil, list.map {|e| e.strip }, text.strip]
+        end
+      end
+
+      def extract_types_and_name_from_text_unstripped(text, opening_types = TYPELIST_OPENING_CHARS, closing_types = TYPELIST_CLOSING_CHARS)
+        s, e = 0, 0
+        before = ''
+        list, level, seen_space, i = [''], 0, false, 0
+        last_seen = ''
+        while i < text.length
+          c = text[i, 1]
+          if level > 0 && c == '#' && text[i+1..-1] =~ CodeObjects::METHODNAMEMATCH
+            list.last << c + $&
+            i += $&.length + 1
+            next
+          elsif opening_types.include?(c)
+            list.last << c if level > 0
+            s = i if level == 0
+            level += 1
+          elsif closing_types.include?(c)
+            level -= 1 unless last_seen == '=' && c == '>'
+            break e = i if level == 0
+            list.last << c
+          elsif c == ',' && level == 1
+            list.push ''
+          elsif c =~ /\S/ && level == 0
+            break e = i if seen_space && list == ['']
+            before << c
+          elsif c =~ /\s/ && level == 0 && !before.empty?
+            seen_space = true
+          elsif level >= 1
+            list.last << c
+          end
+          last_seen = c
+          i += 1
+        end
+
+        before = before.empty? ? nil : before
+        if list.size == 1 && list.first == ''
+          [nil, nil, text]
+        else
+          [before, list, text[(e+1)..-1]]
+        end
+      end
+    end
+  end
+end

data/vendor/ruby/1.9.1/gems/yard-0.8.6.1/lib/yard/tags/default_tag.rb

@@ -0,0 +1,12 @@
+module YARD
+  module Tags
+    class DefaultTag < Tag
+      attr_reader :defaults
+
+      def initialize(tag_name, text, types = nil, name = nil, defaults = nil)
+        super(tag_name, text, types, name)
+        @defaults = defaults
+      end
+    end
+  end
+end