percy-common 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a652130076a2b0813f00bb165c51b299824510bc
-  data.tar.gz: 9fb9173c1160f0ce954d90fd28c58b00aa1e027f
+  metadata.gz: 843bb5ade878a82fa046f8024a37273a363310f0
+  data.tar.gz: 36f86e902963f0b3f209836b980428ef21e76334
 SHA512:
-  metadata.gz: 508907f4ae23369340fd5f34a03dbf98c2b51eb12fcf0931575b1c8fa9d506525fa502939ba46bf48c8cbc2ffe51d9fab8f8a62a80b770b54a9d33fa2b1385f8
-  data.tar.gz: f06831d5d30151b47fa2c60f98cd520e4a036845a7a52c2ad98e27e900a00bab568e8b70bbe0ba382eee97aa15d1f2e873c3b325d20e350e66ab18bff46bb06e
+  metadata.gz: bef3758204d4b3ca170ca2b7c49636f54d623f8c26c2f8d5bb53d41feda0fb62068f92f52a26439f2ddb179839d3256644c34e68fbc39ac3b34b88df92218514
+  data.tar.gz: 2104a221fc389ddccd5a9c2e0efaed5e74c97733725e714f5b6e2527c92838bdc5820b6cffe89018f1fbc3b10ea79d4dec01520bdf5392eb2fbfbd090a678834

data/README.md

@@ -2,7 +2,39 @@
 
 Server-side common library for Percy.
 
-## Percy::KeywordStruct
+## Installation
+
+Add this line to your application's Gemfile:
+
+```
+gem 'percy-common'
+```
+
+Or, for a Ruby library, add this to your gemspec:
+
+```ruby
+spec.add_development_dependency 'percy-common'
+```
+
+And then run:
+
+```bash
+$ bundle install
+```
+
+### Setup in a Rails app
+
+If including in a Rails app, add the following to your `application.rb`:
+
+```ruby
+require 'percy/common/engine'
+```
+
+This enables Rails to autoload the constants from this library without more `require` lines.
+
+## Usage
+
+### Percy::KeywordStruct
 
 A simple struct that can be used when you need to return a simple value object.
 
@@ -19,7 +51,7 @@ foo.qux  # --> nil
 foo.fake # --> raises NoMethodError
 ```
 
-## Percy.logger
+### Percy.logger
 
 ```ruby
 require 'percy/logger'
@@ -32,9 +64,9 @@ 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
+### Percy::ProcessHelpers
 
-### `gracefully_kill(pid[, grace_period_seconds: 10])`
+#### `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.
 
@@ -46,7 +78,7 @@ 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
+### Percy::Stats
 
 Client for recording Datadog metrics and automatically setting up Percy-specific environment tags.
 

data/lib/percy/common/engine.rb

@@ -0,0 +1,7 @@
+module Percy
+  module Common
+    class Engine < ::Rails::Engine
+      config.autoload_paths += Dir["#{config.root}/lib/**/"]
+    end
+  end
+end

data/lib/percy/common/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: percy-common
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Perceptual Inc.
@@ -125,6 +125,7 @@ files:
 - README.md
 - Rakefile
 - lib/percy/common.rb
+- lib/percy/common/engine.rb
 - lib/percy/common/version.rb
 - lib/percy/keyword_struct.rb
 - lib/percy/logger.rb
@@ -150,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Server-side common library for Percy.