rails-quietly 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0901cb57bf4a969bf26c50c04c9ab556bc417d001ab7c794f57bc6bd24d9092a'
-  data.tar.gz: fd3164c23d88f14393649fcec4c1629e983090f681400358b18218a7fc06890a
+  metadata.gz: 8f509c2981017b96905d941f18a91a4f74fc64b33bd7c2ff88c4522d3368dac7
+  data.tar.gz: 0fdf9cb8a0d9055507aaa73df18bcf631afddf1938631d1173be5471436844d3
 SHA512:
-  metadata.gz: 61f548f5607c209a74a1b19e6bb366402a2d2c565646b21d63548963117ca27fe84bd6b3f2df3ba3aae35b6149764ce9c2c71bf7d73f69982fae776c579e7c8c
-  data.tar.gz: 9873cf813444c887e3cba7268466efb5d3291556e448f95cdfa4bb7178c4998b971ed290284587a27fb9a06de7fcec70e376dbe8aa3287b3843e16dff55b7067
+  metadata.gz: af84ab294eb46dc9df87082875ad5635fa70cb8dfd1d46fdb930db35af21433a0cb5dd8a40654323d8a29e309ab1d6101d98d4c3f8a08a0a0f20836f5caca5b5
+  data.tar.gz: 98152a464aca9f84d7760eea57949a00f9c211729134bc9e28ead31bb7d6bc609781a8da85a3a7c9afa7d687c8bdbd9a3c31c81402741445078fd771250f20c8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rails-quietly (0.0.2)
+    rails-quietly (0.0.3)
 
 GEM
   remote: https://rubygems.org/

data/Readme.md

@@ -0,0 +1,52 @@
+# Rails, Quietly
+
+A simple wrapper to suppress logging in various ways in Rails apps.
+
+## Installation
+
+Add this to your Gemfile:
+
+```ruby
+gem 'rails-quietly'
+```
+
+or install directly:
+
+```bash
+gem install rails-quietly
+```
+
+## Inclusion
+
+In `config/applicaiton.rb`, include the following:
+
+```ruby
+require 'quietly'
+include Quietly
+```
+
+This puts the module into global scope.
+
+## Usage
+
+You can either use the `quietly` method with a block:
+
+```ruby
+result_b = quietly do
+  a = ModelA.query
+  ModelB.query(a)
+end
+```
+
+or manually suppress and restore logging:
+
+```ruby
+old_logger = go_quiet
+
+a = ModelA.query
+result_b = ModelB.query(a)
+
+end_quiet(old_logger)
+
+result_b
+```

data/rails-quietly.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'rails-quietly'
-  s.version       = '0.0.2'
+  s.version       = '0.0.3'
   s.date          = '2019-04-08'
   s.summary       = 'Simple wrapper for suppressing logging in Rails'
   s.description   = 'A simple wrapper to suppress logging in various ways in Rails apps.'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-quietly
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Julian Fiander
@@ -18,6 +18,7 @@ extra_rdoc_files: []
 files:
 - Gemfile
 - Gemfile.lock
+- Readme.md
 - lib/quietly.rb
 - rails-quietly.gemspec
 homepage: http://rubygems.org/gems/rails-quietly