statsd-instrument-rspec 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 43ce3873f066781c87998d613937950216ef3fd7
+  data.tar.gz: 1c269cb4eb1342c1d566a628cfa6d02517979be6
+SHA512:
+  metadata.gz: a590d7da0d387abf3607b1b76350e6294348bf93ed97e2c6f1bb9870473f72a0d519dc68e60952abf0ffac65f2e7891e3874689735331a06add1c2365483b01d
+  data.tar.gz: 1720db21798407b3f08e37fe7c8dead815574a0b8cfefd26f5d14a2969474d2443ab59c10599fd6b4eebd4770a3560705a92c11aa4eac271606c28d538fda6a9

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,17 @@
+require: rubocop-rspec
+
+AllCops:
+  DisplayCopNames: true
+  Exclude:
+    - bin/* # autogenerated files
+    - vendor/**/* # 3rd party gems
+
+Documentation:
+  Enabled: false
+LineLength:
+  Max: 120
+StringLiterals:
+  EnforcedStyle: double_quotes
+Style/RegexpLiteral:
+  Exclude:
+    - "statsd-instrument-rspec.gemspec" # Bundler defaults

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+sudo: false
+cache: bundler
+rvm:
+  - 2.2
+  - 2.1
+  - 2.0
+before_install: gem update bundler

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased][unreleased]
+### Added
+- Add support for testing increments.

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in statsd-instrument-rspec.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Blacklane GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,66 @@
+# statsd-instrument-rspec
+
+[![Build Status](https://travis-ci.org/blacklane/statsd-instrument-rspec.svg?branch=master)](https://travis-ci.org/blacklane/statsd-instrument-rspec) [![Coverage Status](https://coveralls.io/repos/blacklane/statsd-instrument-rspec/badge.svg?branch=master)](https://coveralls.io/r/blacklane/statsd-instrument-rspec?branch=master) [![Code Climate](https://codeclimate.com/github/blacklane/statsd-instrument-rspec/badges/gpa.svg)](https://codeclimate.com/github/blacklane/statsd-instrument-rspec) [![Dependency Status](https://gemnasium.com/blacklane/statsd-instrument-rspec.svg)](https://gemnasium.com/blacklane/statsd-instrument-rspec)
+
+RSpec 3 matchers for `statsd-instrument`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "statsd-instrument-rspec"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install statsd-instrument-rspec
+
+## Usage
+
+Configure RSpec and StatsD (e.g. via the `spec_helper.rb`):
+
+```ruby
+require "statsd/instrument/rspec"
+
+RSpec.configure do |config|
+  config.include Statsd::Instrument::Rspec # Enable StatsD matchers
+
+  config.before(:suite) do
+    StatsD.backend = StatsD::Instrument::Backends::CaptureBackend.new # Use CaptureBackend
+  end
+
+  config.after do
+    StatsD.backend.reset # Reset collected metrics after each example
+  end
+end
+```
+
+### Matchers
+
+#### Increment
+
+```ruby
+expect { StatsD.increment(:foo) }.to increment_statsd(:foo)
+expect { StatsD.increment(:bar) }.not_to increment_statsd(:foo)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+Run the tests with `bundle exec rake`.
+
+## Contributing
+
+1. Fork it ( https://github.com/blacklane/statsd-instrument-rspec/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

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: %i(rubocop spec)

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "statsd/instrument/rspec"
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/statsd/instrument/rspec.rb

@@ -0,0 +1,35 @@
+require "rspec/expectations"
+require "statsd-instrument"
+require "statsd/instrument/rspec/version"
+
+module Statsd
+  module Instrument
+    module Rspec
+      extend RSpec::Matchers::DSL
+
+      matcher :increment_statsd do |key|
+        match do |block|
+          block.call
+          metric_captured?(:c, key)
+        end
+
+        failure_message do |_block|
+          "Expected that block would increase StatsD metric '#{key}'."
+        end
+
+        failure_message_when_negated do |_block|
+          "Expected that block would not increase StatsD metric '#{key}'."
+        end
+
+        def supports_block_expectations?
+          true
+        end
+      end
+
+      def metric_captured?(type, key)
+        metrics = StatsD.backend.collected_metrics
+        metrics.any? { |metric| metric.type == type && metric.name == key }
+      end
+    end
+  end
+end

data/lib/statsd/instrument/rspec/version.rb

@@ -0,0 +1,7 @@
+module Statsd
+  module Instrument
+    module Rspec
+      VERSION = "0.1.0"
+    end
+  end
+end

data/statsd-instrument-rspec.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "statsd/instrument/rspec/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "statsd-instrument-rspec"
+  spec.version       = Statsd::Instrument::Rspec::VERSION
+  spec.authors       = ["Philipp Preß"]
+  spec.email         = ["philipp.press@blacklane.com"]
+
+  spec.summary       = "RSpec 3 matchers for statsd-instrument."
+  spec.homepage      = "https://github.com/blacklane/statsd-instrument-rspec"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 2.0"
+
+  spec.add_runtime_dependency "rspec",             "~> 3.0"
+  spec.add_runtime_dependency "statsd-instrument", "~> 2.0"
+
+  spec.add_development_dependency "bundler",           "~> 1.8"
+  spec.add_development_dependency "coveralls",         "~> 0.7"
+  spec.add_development_dependency "pry",               "~> 0.10"
+  spec.add_development_dependency "rake",              "~> 10.0"
+  spec.add_development_dependency "rubocop",           "~> 0.29"
+  spec.add_development_dependency "rubocop-rspec",     "~> 1.0"
+  spec.add_development_dependency "simplecov",         "~> 0.9"
+end

metadata

@@ -0,0 +1,183 @@
+--- !ruby/object:Gem::Specification
+name: statsd-instrument-rspec
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Philipp Preß
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: statsd-instrument
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.29'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.29'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: 
+email:
+- philipp.press@blacklane.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/statsd/instrument/rspec.rb
+- lib/statsd/instrument/rspec/version.rb
+- statsd-instrument-rspec.gemspec
+homepage: https://github.com/blacklane/statsd-instrument-rspec
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: RSpec 3 matchers for statsd-instrument.
+test_files: []