rf_logger 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 76a7e84c1a3d1bd7e71eaf197030c475c25b0652
-  data.tar.gz: 5a8c78e3ae4826e0d497bced3d13f57e2a188b11
+  metadata.gz: b595e7d05f3277b9c9835fa966c9c3a4a1e6fec9
+  data.tar.gz: aecb196b1dbd862dffab3ec5dc341ab68ec1e31b
 SHA512:
-  metadata.gz: b7c5dd2ad6cbc9b713e143b081d0724ec56f770bee49f663605d354bc9dff3f9b232881d7cf449308d49c46efc1938dd8f80d69aa7fb2dd65f4e8b3b3a56cc4d
-  data.tar.gz: 1915d7b1ca6d099d387a15b583b9bbb64790871dfddbaba509234d9b02edcc85c80df179cb2490d21b74dc74430844165d94ac64dd76dc9d586d4ac2d84a6afa
+  metadata.gz: 6b16adcfce60a563371920d59b2bfc05b701c5c74a0572bdaace67bf747914b95ae6128142f8f51eb4e3530c6d3768af99223d65877c7e563ad0fed2e7bd6d22
+  data.tar.gz: 96c307c32bb8880a67b3a159713d6734f990bd63a3ac2e1ea6c76235177ecac1a2b8add190331cb8e90eb0d70710c5bf615de914edab98bd05f0f130e662bc39

data/README.md

@@ -16,16 +16,16 @@ The API provides helper methods for each severity (i.e. `Logger.debug`).  In add
 
 This gem includes RfLogger::SimpleLogger, RfLogger::Sequel::Logger and RfLogger::ActiveRecord::Logger loggers as options that adhere to this API.  The fields above should be passed into helper methods as a hash.
 
-##Integration##
+## Integration
 Integrating RfLogger into your project requires the following steps:
 * Include the rf_logger code in your project
 * Create a migration 
 * Add a model
 
-#### Including rf_logger ####
-Currently, RfLogger is included from the Github repo. Place the following in your Gemfile:
+#### Including rf_logger
+Place the following in your Gemfile:
 
-```gem 'rf_logger', :github => 'renewablefunding/rf_logger' , :tag => "0.3.0"```
+```gem 'rf_logger', "0.3"```
 
 Also make sure you include rf_logger and the logger you're going to be using:
 
@@ -42,7 +42,16 @@ Alters Rails.logger to append `request_id=89f25715-3e5d-4d85-9352-843a1aeec7d0`
 
 #### Rory Requirements
 
-Support Rory => `0.7`
+Support Rory => `0.8`
+
+
+#### Debug Framework detection and loading plug-ins
+
+Will puts to STDOUT frameworks detected and any errors.
+
+```ruby
+ENV["RF_LOGGER_LOAD_DEBUG"] = "true"
+```
 
 #### RfLogger::RequestHeaders
 
@@ -69,7 +78,7 @@ RfLogger::RequestHeaders.new(accepts: "application/json").to_hash
 
 #### Migration
 Assuming your logger will persist to a database, you'll need to create a table. While the api should make it pretty easy to determine which fields you'll need, here are the guts of what you'd need for both the SequelLogger and RailsLogger:
-######Sequel
+###### Sequel
 ```
 create_table :logs do
     primary_key :id
@@ -99,20 +108,20 @@ end
 #### Model
 Again, assuming you'll be using the SequelLogger or RailsLogger (or some other logger that persists to a datasource), you'll want to create a Model that wraps your logger. This is as simple as creating a class that inherits from your logger (though you can make it more complex as your project needs dictate):
 
-######Sequel
+###### Sequel
 ```
 class Log < RfLogger::Sequel::Logger
 end
 ```
 
-######ActiveRecord
+###### ActiveRecord
 ```
 class Log < RfLogger::ActiveRecord::Logger
 end
 ```
 
 
-##Configuration##
+## Configuration
 Configuration mostly sets up additional notifications beyond the actual logging.
 
 ```ruby
@@ -131,7 +140,7 @@ end
 
 As you see above, you can specify different notifications for different levels or environments when you log an event.
 
-##Notification##
+## Notification
 While you have to implement notifiers yourself, the API is fairly simple.  The class must respond to .send_notification.  The argument passed in is an object that includes a #subject (which can be defined in the configuration (see above), and #details, which is the metadata in YAML format.  Future versions of this may allow for other transformations of the log data.
 
 Example:

data/lib/rf_logger.rb

@@ -4,10 +4,10 @@ module RfLogger
   def self.try_to_load(file)
     begin
       require file
-      yield
       puts "RfLogger: Detected #{file}." if ENV["RF_LOGGER_LOAD_DEBUG"]
-    rescue LoadError
-      puts "RfLogger: #{file} not detected." if ENV["RF_LOGGER_LOAD_DEBUG"]
+      yield
+    rescue LoadError => e
+      puts "RfLogger: #{file} not detected.\n\t#{e.to_s}" if ENV["RF_LOGGER_LOAD_DEBUG"]
     end
   end
 end
@@ -15,4 +15,4 @@ end
 RfLogger.try_to_load("rails")         { require "rf_logger/rails" }
 RfLogger.try_to_load("active_record") { require "rf_logger/active_record" }
 RfLogger.try_to_load("rory")          { require "rf_logger/rory" }
-RfLogger.try_to_load("sequel")        { require "rf_logger/sequel" }
+RfLogger.try_to_load("sequel")        { puts "RfLogger: require 'rf_logger/sequel'; before inheriting from RfLogger::Sequel::Logger" if ENV["RF_LOGGER_LOAD_DEBUG"] }

data/lib/rf_logger/active_record.rb

@@ -1 +1,2 @@
+puts "RfLogger: ActiveRecord version #{ActiveRecord::VERSION::STRING}" if ENV["RF_LOGGER_LOAD_DEBUG"]
 require "rf_logger/active_record/logger"

data/lib/rf_logger/rails.rb

@@ -1,5 +1,8 @@
 require "rf_logger/rails/rails_compatibility"
 require "rails/version"
-RfLogger::RailsCompatibility.new.call { require "rf_logger/rails/key_value_tagged_logging" }
+puts "RfLogger: Rails version #{Rails::VERSION::STRING}" if ENV["RF_LOGGER_LOAD_DEBUG"]
+RfLogger::RailsCompatibility.new.call {
+  require "rf_logger/rails/key_value_tagged_logging"
+}
 require "rf_logger/request/request_headers"
 require "rf_logger/rails/initialize_request_middleware"

data/lib/rf_logger/rails/rails_compatibility.rb

@@ -1,7 +1,7 @@
 module RfLogger
   class RailsCompatibility
-    MAX = "5.0.99"
-    MIN = "3.2"
+    MAX          = "5.0.99"
+    MIN          = "3.2"
     Incompatible = Class.new(StandardError)
 
     def initialize(rails_version: Gem::Version.new(::Rails::VERSION::STRING))
@@ -21,7 +21,8 @@ module RfLogger
     attr_reader :rails_version
 
     def rails_not_support_message
-      raise Incompatible, "These patches change Rails private methods and are only known to work for Rails #{MIN} through #{MAX}"
+      return unless ENV["RF_LOGGER_LOAD_DEBUG"] = "true"
+      puts "RfLogger: These patches change Rails private methods and are only known to work for Rails #{MIN} through #{MAX}. Current version #{rails_version}"
     end
 
     def rails_supported?

data/lib/rf_logger/rory.rb

@@ -1,2 +1,9 @@
-require "rf_logger/rory/initialize_request_middleware"
-require "rf_logger/request/request_headers"
+require "rory/version"
+
+if Gem::Version.new(Rory::VERSION) >= Gem::Version.new("0.8")
+  puts "RfLogger: Rory version #{Rory::VERSION}" if ENV["RF_LOGGER_LOAD_DEBUG"]
+  require "rf_logger/rory/initialize_request_middleware"
+  require "rf_logger/request/request_headers"
+else
+  puts "RfLogger: requires Rory 0.8 or greater. Version #{Rory::VERSION} is not support." if ENV["RF_LOGGER_LOAD_DEBUG"]
+end

data/lib/rf_logger/rory/initialize_request_middleware.rb

@@ -1,9 +1,5 @@
 require "rf_logger/request/request_middleware"
-require "rory/version"
 
-unless Gem::Version.new(Rory::VERSION) >= Gem::Version.new("0.8")
-  raise "RfLogger require Rory 0.8 or greater. Version #{Rory::VERSION} is not support."
-end
 Rory::Application.initializers.insert_after "rory.request_middleware", "rf_logger.request_middleware" do |app|
   app.middleware.insert_after Rory::RequestId, RfLogger::RequestMiddleware
 end

data/lib/rf_logger/sequel.rb

@@ -1,2 +1,3 @@
+puts "RfLogger: Sequel version #{Sequel::VERSION}" if ENV["RF_LOGGER_LOAD_DEBUG"]
 require "rf_logger/sequel/base"
-require "rf_logger/sequel/model"
+require "rf_logger/sequel/logger"

data/lib/rf_logger/version.rb

@@ -1,3 +1,3 @@
 module RfLogger
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

data/spec/lib/rf_logger/log_for_notification_spec.rb

@@ -1,3 +1,5 @@
+require "rf_logger/log_for_notification"
+
 describe RfLogger::LogForNotification do
   subject { described_class.new(
     :actor => 'fruit_cocktail',

data/spec/lib/rf_logger/rails/rails_compatibility_spec.rb

@@ -7,12 +7,12 @@ RSpec.describe RfLogger::RailsCompatibility do
 
   context "far left" do
     let(:rails_version) { 2.9 }
-    it { expect { subject.call }.to raise_error(described_class::Incompatible) }
+    it { expect { |b| subject.call(&b) }.to_not yield_control }
   end
 
   context "edge left" do
     let(:rails_version) { 3.1 }
-    it { expect { subject.call }.to raise_error(described_class::Incompatible) }
+    it { expect { |b| subject.call(&b) }.to_not yield_control }
   end
 
   context "middle edge left" do
@@ -32,11 +32,11 @@ RSpec.describe RfLogger::RailsCompatibility do
 
   context "edge right" do
     let(:rails_version) { 5.1 }
-    it { expect { subject.call }.to raise_error(described_class::Incompatible) }
+    it { expect { |b| subject.call(&b) }.to_not yield_control }
   end
 
   context "far right" do
     let(:rails_version) {6.0}
-    it { expect { subject.call }.to raise_error(described_class::Incompatible) }
+    it { expect { |b| subject.call(&b) }.to_not yield_control }
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rf_logger
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Dustin Zeisler