informed 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 400cde4d28ec801fa0a3673a51ceee479ccaaf75
-  data.tar.gz: 0a4cf3e450db47d356741563f05e427628567bc2
+  metadata.gz: ba5433e00f3520fb5d488f0597c86df6a260a57f
+  data.tar.gz: c8cdfb9e6130b1c503204062c5b09b03e2b69167
 SHA512:
-  metadata.gz: ead6a13f3a4453df836f2ad3bf11f74265c3d57ef71be3ad56ab7fea4a5d1366c8e09108d6c59e480a1163c5eef73bb9f62f0a2922520148a4e23b84b821dedb
-  data.tar.gz: c50e3655490c233aac89b6f0d02e70bdc40ea535c6c99d753eb2794073cbd4a108bd07b1c0a7bab197b2b0afa1ca953cced1a1733c65a711473d2e3ab062a0ef
+  metadata.gz: 0bed52a50511a9201dc57fbd52f8cf52e1c954f5e5dc28657dc20cd6d7ffb527d94fbb61b972f3df94b94446e110d2d063296515a7176bc44a4bf074558d924f
+  data.tar.gz: f35acc7f08150778f5808ff033eabb777232e0745182f74dcaf2db8ef5f816679b4a348963c10cf06596318f344f46be6c17de64bf8859841e79d6b5bfe78932

data/.travis.yml

@@ -4,6 +4,6 @@ rvm:
   - 2.1.10
   - 2.2.7
   - 2.3.4
-  - 2.4.1
-before_install: gem install bundler -v 1.14.6
+  - 2.4.2
+before_install: gem install bundler -v 1.15.4
 script: ruby test/informed_test.rb --documentation

data/README.md

@@ -1,12 +1,32 @@
 # Informed
-![build status](https://travis-ci.org/zincmade/informed.svg?branch=primary)
+![build status](https://api.travis-ci.org/wecohere/informed.svg?branch=primary)
+
+Informed improves application debuggability by:
+* Logging which methods were called.
+* Aggregating useful data, such as the result of the call, keyword arguments provided, or the result of related instance methods
+* Exposing when a method starts and finishes
+
+Informed does *not*:
+* Format logs. It provides a hash to the logger you provide, and it's up to you
+  to format your logs in a useful manner. This will depend on what log
+  aggregation system you are using.
+* Store logs. You will need to configure your applications logger correctly to
+  ensure logs will actually reach your log aggregator.
+* Provide useful analytics or performance tuning data. Logs are for informing
+  your incident detection system, debugging, and auditing. While one may get
+  *some* amount of metrics utility out of them, products oriented towards
+  exposing the insights you are looking for are generally better equipped for
+  that.
 
-## Installation
+
+## Usage
+
+### Install
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'informed'
+gem 'informed', '~> 1.0'
 ```
 
 And then execute:
@@ -17,11 +37,7 @@ Or install it yourself as:
 
     $ gem install informed
 
-## Usage
-
-Informed, when included, makes it easy to log method calls when they start and
-finish. It provides a means to log additional data, such as the result of said
-calls, keyword arguments, or other instance methods.
+### Instrument
 
 ```
 
@@ -56,23 +72,36 @@ class FancyService
 end
 
 FancyService.new(fanciness: 12).do_something
-#  I, [2017-04-04T19:46:05.256753 #29957]  INFO -- : {:method=>:do_something, :values=>{:fancy?=>true, :fanciness=>12}, :status=>:starting}
-#  I, [2017-04-04T19:46:05.256896 #29957]  INFO -- : {:method=>:do_something, :values=>{:fancy?=>true, :fanciness=>12}, :status=>:done, :result=>"so fancy"}
+#  I, [2017-07-05T18:27:13.431695 #3297]  INFO -- : {:method=>:do_something, :class=>"FancyService", :values=>{:fancy?=>true, :fanciness=>12}, :status=>:starting}
+#  I, [2017-07-05T18:27:13.431780 #3297]  INFO -- : {:method=>:do_something, :class=>"FancyService", :values=>{:fancy?=>true, :fanciness=>12}, :status=>:done, :result=>"so fancy"}
 #  => "so fancy"
 FancyService.new(fanciness: 12).do_something(force: true)
-#  I, [2017-04-04T19:46:09.043051 #29957]  INFO -- : {:method=>:do_something, :values=>{:fancy?=>true, :force=>true, :fanciness=>12}, :status=>:starting}
-#  I, [2017-04-04T19:46:09.043159 #29957]  INFO -- : {:method=>:do_something, :values=>{:fancy?=>true, :force=>true, :fanciness=>12}, :status=>:done, :result=>"so fancy"}
+#  I, [2017-07-05T18:27:57.612778 #3297]  INFO -- : {:method=>:do_something, :class=>"FancyService", :values=>{:fancy?=>true, :force=>true, :fanciness=>12}, :status=>:starting}
+#  I, [2017-07-05T18:27:57.612853 #3297]  INFO -- : {:method=>:do_something, :class=>"FancyService", :values=>{:fancy?=>true, :force=>true, :fanciness=>12}, :status=>:done, :result=>"so fancy"}
 #  => "so fancy"
 FancyService.new(fanciness: 8).do_something(force: true)
-#  I, [2017-04-04T19:46:17.968960 #29957]  INFO -- : {:method=>:do_something, :values=>{:fancy?=>false, :force=>true, :fanciness=>8}, :status=>:starting}
-#  I, [2017-04-04T19:46:17.969066 #29957]  INFO -- : {:method=>:do_something, :values=>{:fancy?=>false, :force=>true, :fanciness=>8}, :status=>:done, :result=>"so fancy"}
+#  I, [2017-07-05T18:28:35.282196 #3297]  INFO -- : {:method=>:do_something, :class=>"FancyService", :values=>{:fancy?=>false, :force=>true, :fanciness=>8}, :status=>:starting}
+#  I, [2017-07-05T18:28:35.282272 #3297]  INFO -- : {:method=>:do_something, :class=>"FancyService", :values=>{:fancy?=>false, :force=>true, :fanciness=>8}, :status=>:done, :result=>"so fancy"}
 #  => "so fancy"
 FancyService.new(fanciness: 8).do_something(force: false)
-#  I, [2017-04-04T19:49:10.485462 #29957]  INFO -- : {:method=>:do_something, :values=>{:fancy?=>false, :force=>false, :fanciness=>8}, :status=>:starting}
-#  I, [2017-04-04T19:49:10.485596 #29957]  INFO -- : {:method=>:do_something, :values=>{:fancy?=>false, :force=>false, :fanciness=>8}, :status=>:done, :result=>"so plain"}
-# => "so plain"
+#  I, [2017-07-05T18:29:13.319488 #3297]  INFO -- : {:method=>:do_something, :class=>"FancyService", :values=>{:fancy?=>false, :force=>false, :fanciness=>8}, :status=>:starting}
+#  I, [2017-07-05T18:29:13.319560 #3297]  INFO -- : {:method=>:do_something, :class=>"FancyService", :values=>{:fancy?=>false, :force=>false, :fanciness=>8}, :status=>:done, :result=>"so plain"}
+#  => "so plain"
 ```
 
+### Configure
+
+While we default to logging to standard out, Informed is Logger-agnostic. You
+may provide a logger to informed that is interface compatible with the Logger
+class in the Ruby standard library.
+
+To do so either:
+* Set `Informed.logger` to your application logger. (Rails Example:
+  `Informed.logger = Rails.logger`)
+* Define an instance method `logger` on the informed upon class and have it
+  return whatever logger you want.
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run

data/lib/informed/version.rb

@@ -1,3 +1,3 @@
 module Informed
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/informed.rb

@@ -91,8 +91,12 @@ module Informed
     def inform_on(method, level:, also_log: {})
       alias_method :"unwatched_#{method}", method
       informant = Informant.new(method: method, also_log: also_log, level: level)
-      define_method method do |*arguments, **keyword_arguments|
-        informant.inform_on(informee: self, logger: logger, arguments: arguments, keyword_arguments: keyword_arguments)
+      define_method method do |*arguments, **keyword_arguments, &block|
+        informant.inform_on(informee: self,
+                            logger: logger,
+                            arguments: arguments,
+                            keyword_arguments: keyword_arguments,
+                            block: block)
       end
     end
   end
@@ -145,17 +149,17 @@ module Informed
     #                                 be logged if specified in the :values
     #                                 array in {#also_log}.
     # @return the result of the informed upon method.
-    def inform_on(logger:, arguments:, keyword_arguments:, informee:)
+    def inform_on(logger:, arguments:, keyword_arguments:, informee:, block: nil)
       method_context = { keyword_arguments: keyword_arguments, method: method, also_log: also_log, informee: informee }
       log(logger: logger, type: StartingMessage, method_context: method_context)
       result = if arguments.empty? && keyword_arguments.empty?
-                 informee.send(:"unwatched_#{method}")
+                 informee.send(:"unwatched_#{method}", &block)
                elsif arguments.empty? && !keyword_arguments.empty?
-                 informee.send(:"unwatched_#{method}", **keyword_arguments)
+                 informee.send(:"unwatched_#{method}", **keyword_arguments, &block)
                elsif !arguments.empty? && keyword_arguments.empty?
-                 informee.send(:"unwatched_#{method}", *arguments)
+                 informee.send(:"unwatched_#{method}", *arguments, &block)
                elsif !arguments.empty? && !keyword_arguments.empty?
-                 informee.send(:"unwatched_#{method}", *arguments, **keyword_arguments)
+                 informee.send(:"unwatched_#{method}", *arguments, **keyword_arguments, &block)
                end
       log(logger: logger, type: DoneMessage, method_context: method_context.merge(result: result))
       result
@@ -189,7 +193,7 @@ module Informed
       # depends on {#also_log}
       # @return [Hash]
       def to_h
-        message = { method: method }
+        message = { method: method, class: informee.class.name }
         if also_log[:values]
           message[:values] = {}
           also_log[:values].each do |local|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: informed
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Zee Spencer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-22 00:00:00.000000000 Z
+date: 2017-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -124,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Informs on method calls so you know what your app is doing and why