percy-common 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d5a79133a1c95ae793cb30e7135badb17b59db1
-  data.tar.gz: 1c4a63b4f4998e03f4500b99212e6968b565a7c1
+  metadata.gz: a652130076a2b0813f00bb165c51b299824510bc
+  data.tar.gz: 9fb9173c1160f0ce954d90fd28c58b00aa1e027f
 SHA512:
-  metadata.gz: b2efd0479f2da30ff271cd09376a9910055f1d381b9538a6808939e3e1313130aa344370b076e2585e432f73a541cf04b5cb3b8818a961e08b26ecbe603a3f27
-  data.tar.gz: a2205abeed0c19bad7669d6bccd840c16242d3b9bd966cff4a5683ab1347a14dde8abb5288ddae44f572665d96930bf2ac05264bb65c72e2e0122893f09a9b6e
+  metadata.gz: 508907f4ae23369340fd5f34a03dbf98c2b51eb12fcf0931575b1c8fa9d506525fa502939ba46bf48c8cbc2ffe51d9fab8f8a62a80b770b54a9d33fa2b1385f8
+  data.tar.gz: f06831d5d30151b47fa2c60f98cd520e4a036845a7a52c2ad98e27e900a00bab568e8b70bbe0ba382eee97aa15d1f2e873c3b325d20e350e66ab18bff46bb06e

data/.rspec

@@ -1,3 +1,3 @@
---color
 --require spec_helper
+--color
 --format d

data/.rubocop.yml

@@ -0,0 +1,7 @@
+inherit_gem:
+  percy-style:
+    - default.yml
+
+RSpec/DescribeClass:
+  Exclude:
+    - spec/percy/logger_spec.rb

data/.travis.yml

@@ -2,8 +2,10 @@ language: ruby
 sudo: false
 cache: bundler
 rvm:
-  - 2.2.2
+  - 2.2.5
   - ruby-head
 before_install:
   - gem update bundler
-script: bundle exec rspec
+script:
+  - bundle exec rubocop -D
+  - bundle exec rspec

data/Guardfile

@@ -0,0 +1,16 @@
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/README.md

@@ -1,3 +1,99 @@
 # percy-common
 
 Server-side common library for Percy.
+
+## Percy::KeywordStruct
+
+A simple struct that can be used when you need to return a simple value object.
+
+```ruby
+require 'percy/keyword_struct'
+
+class Foo < Percy::KeywordStruct.new(:bar, :baz, :qux)
+end
+
+foo = Foo.new(bar: 123, baz: true)
+foo.bar  # --> 123
+foo.baz  # --> true
+foo.qux  # --> nil
+foo.fake # --> raises NoMethodError
+```
+
+## Percy.logger
+
+```ruby
+require 'percy/logger'
+
+Percy.logger.debug { 'debug log' }
+Percy.logger.info { 'info log' }
+Percy.logger.warn { 'warning log' }
+Percy.logger.error { 'error message' }
+```
+
+Prefer the block form usage `Percy.logger.debug { 'message' }` over `Percy.logger.debug('message')` because it is slightly more efficient when the log will be excluded by the current logging level. For example, if the log level is currently `info`, then a `debug` log in block form will never evaluate or allocate the message string itself.
+
+## Percy::ProcessHelpers
+
+### `gracefully_kill(pid[, grace_period_seconds: 10])`
+
+Returns `true` if the process was successfully killed, or `false` if the process did not exist or its exit status was already collected.
+
+```ruby
+require 'percy/process_helpers'
+
+Percy::ProcessHelpers.gracefully_kill(pid)
+```
+
+This will send `SIGTERM` to the process, wait up to 10 seconds, then send `SIGKILL` if it has not already shut down.
+
+## Percy::Stats
+
+Client for recording Datadog metrics and automatically setting up Percy-specific environment tags.
+
+This class is a wrapper for [Datadog::Statsd](https://github.com/DataDog/dogstatsd-ruby), an extended client for DogStatsD, which extends the StatsD metric server for Datadog.
+
+Basic usage includes:
+
+```ruby
+require 'percy/stats'
+
+stats = Percy::Stats.new
+
+# Increment a counter.
+stats.increment('page.views')
+
+# Record a gauge 50% of the time.
+stats.gauge('users.online', 123, sample_rate: 0.5)
+
+# Sample a histogram.
+stats.histogram('file.upload.size', 1234)
+
+# Time a block of code.
+stats.time('page.render') do
+  render_page('home.html')
+end
+
+# Send several metrics at the same time.
+# All metrics will be buffered and sent in one packet when the block completes.
+stats.batch do |s|
+  s.increment('page.views')
+  s.gauge('users.online', 123)
+end
+
+# Tag a metric.
+stats.histogram('query.time', 10, tags: ['version:1'])
+```
+
+See the [Datadog::Statsd](https://github.com/DataDog/dogstatsd-ruby) docs for more usage.
+
+Our wrapper adds support for a non-block based `start_timing` and `stop_timing` methods:
+
+```ruby
+require 'percy/stats'
+
+stats = Percy::Stats.new
+
+stats.start_timing
+account.activate!
+stats.stop_timing('account.activate')
+```

data/Rakefile

@@ -3,4 +3,4 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/lib/percy/common/version.rb

@@ -1,5 +1,5 @@
 module Percy
   module Common
-    VERSION = '1.1.0'
+    VERSION = '1.2.0'.freeze
   end
 end

data/lib/percy/keyword_struct.rb

@@ -0,0 +1,21 @@
+# A struct that only allows keyword arguments.
+# For example, this should be used to create value objects that are returned from service methods,
+# instead of just returning a hash.
+#
+# Usage:
+#   class Foo < Percy::KeywordStruct.new(:bar, :baz, :qux)
+#   end
+#
+#   foo = Foo.new(bar: 123, baz: true)
+#   foo.bar  # --> 123
+#   foo.baz  # --> true
+#   foo.qux  # --> nil
+#   foo.fake # --> raises NoMethodError
+module Percy
+  class KeywordStruct < Struct
+    def initialize(**kwargs)
+      super(kwargs.keys)
+      kwargs.each { |k, v| self[k] = v }
+    end
+  end
+end

data/lib/percy/process_helpers.rb

@@ -0,0 +1,27 @@
+require 'timeout'
+
+module Percy
+  class ProcessHelpers
+    DEFAULT_TERM_GRACE_SECONDS = 10
+
+    def self.gracefully_kill(pid, grace_period_seconds: DEFAULT_TERM_GRACE_SECONDS)
+      begin
+        Process.kill('TERM', pid)
+        Timeout.timeout(grace_period_seconds) do
+          Process.wait(pid)
+        end
+      rescue Errno::ESRCH
+        # No such process.
+        return false
+      rescue Errno::ECHILD
+        # Status has already been collected, perhaps by a Process.detach thread.
+        return false
+      rescue Timeout::Error
+        Process.kill('KILL', pid)
+        # Collect status so it doesn't stick around as zombie process.
+        Process.wait(pid, Process::WNOHANG)
+      end
+      true
+    end
+  end
+end

data/lib/percy/stats.rb

@@ -20,7 +20,7 @@ module Percy
     end
 
     def stop_timing(stat, options = {})
-      raise 'no timing started' if !@_timing_start  # Programmer mistake, so raise an error.
+      raise 'no timing started' unless @_timing_start # Programmer mistake, so raise an error.
       time_since(stat, @_timing_start, options)
       @_timing_start = nil
       true

data/percy-common.gemspec

@@ -19,7 +19,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'dogstatsd-ruby', '~> 1.6'
   spec.add_dependency 'syslog-logger', '~> 1.6'
 
-  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'bundler', '~> 1.15'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7'
+  spec.add_development_dependency 'percy-style'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: percy-common
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Perceptual Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-23 00:00:00.000000000 Z
+date: 2017-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dogstatsd-ruby
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +80,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: percy-style
+  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:
 - team@percy.io
@@ -89,14 +117,18 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
+- Guardfile
 - LICENSE
 - README.md
 - Rakefile
 - lib/percy/common.rb
 - lib/percy/common/version.rb
+- lib/percy/keyword_struct.rb
 - lib/percy/logger.rb
+- lib/percy/process_helpers.rb
 - lib/percy/stats.rb
 - percy-common.gemspec
 homepage: ''