xlog 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd95d2da4868dd8be558341be8c5e8fb6506f1d6e7fb353d22fbc58d1db84c4c
-  data.tar.gz: 334ff24b034fe2c92ed2915b7be4aefae461d9f4d65fa8422a88e005bf83fa86
+  metadata.gz: d164bebc098c5c7b0dbe424397856e92011a53648273d4e8609b5f112d2db9ff
+  data.tar.gz: c8f0cc3eabb68d96bc60dfa12d5a598fe071d7a72de5c53141284254d99dfe56
 SHA512:
-  metadata.gz: 229ac2f213663efeab5e08303df6530c6023c37b9b628d3cb4ec6d9aba452b0833dedba73179e64fae1c20efea10d471447740eebb7fcfbd9c1125755d3da007
-  data.tar.gz: b87ccd85daeab222e3ecdf5d6cee9b279c9995fcf2661a213ae553b6be5d21a01d8df653f2488ba3f4c60fb3716c3e7c0a766a6511a2314494fd3944fffa5b85
+  metadata.gz: e14895a0d31c8db2a23a3b9745d1b43e8230d26f70ac955c64f0da3adcfd188501233ecfd57c9019f9e864203e07edc053803b2ef79b9e4e4a5538d8fa8b28dc
+  data.tar.gz: 69765e968d5a89352cc9ce5fe5f4fd4dfd9a8c610063224b5f738305a39a11b0f9bbc8d01eadfd8821cded84a474afc3ac63d79871c059b127fc31c9105dba29

data/README.md

@@ -1,8 +1,9 @@
-# Xlog v0.0.1
+# Xlog v0.1.5
 
 Xlog - awesome logger for your Rails app. Logs everything you need in well-formatted view with timestamp, caller path and tags.
 
 ## Usage
+##### Standard
 Log any info with `.info` method
 ```ruby
 Xlog.info('Some info text') # [2019-04-30 12:29:13 UTC] [ArtilesController.show] [info] Message: Some info text
@@ -35,6 +36,29 @@ The only difference between `Xlog.error` and `Xlog.and_raise_error` is that seco
 Xlog automatically defines Rails application name and environment.
 It writes logs into `log/xlog_[environement].log`
 
+Xlog also supports custom tags
+```ruby
+Xlog.tag_logger('custom_tag')
+Xlog.info('Some text') # [2019-04-30 12:29:13 UTC] [ArtilesController.show] [info] [custom_tag] Message: Some info text
+```
+
+Clear tags with: 
+```ruby
+Xlog.clear_tags
+```
+##### Middleware
+From version 0.1.4 Xlog could be used as Rails middleware. It catches `StandardError` using `Xlog.and_raise_error`.
+```ruby
+# /config/application.rb
+ module MyApp
+   class Application < Rails::Application
+     # some configs...
+
+     config.middleware.use Xlog::Middleware
+   end
+ end
+```
+
 ## Configuration
 Xlog is ready to use right out of the box, but it's possible to reconfigure default logger. Default logger is simple `Logger.new`. Add this code to `config/initializers/xlog.rb` and set any custom logger you want.
 
@@ -78,7 +102,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/OrestF/xlog. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/coaxsoft/xlog. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -86,7 +110,7 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Xlog project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/OrestF/xlog/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Xlog project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/coaxsoft/xlog/blob/master/CODE_OF_CONDUCT.md).
 
 ## Idea
 Initially designed and created by [Orest Falchuk (OrestF)](https://github.com/OrestF)

data/lib/xlog.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
 require 'rails'
-require 'xlog/xlogger'
-require 'xlog/version'
+require_relative 'xlog/xlogger'
+require_relative 'xlog/version'
+require_relative 'xlog/middleware'
 
 module Xlog
   class << self
@@ -12,6 +13,10 @@ module Xlog
       config.xlogger.tag_logger(tags)
     end
 
+    def clear_tags
+      config.xlogger.clear_tags
+    end
+
     def info(message, data: nil)
       config.xlogger.info(message, data)
     end

data/lib/xlog/middleware.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Xlog
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      @status, @headers, @response = @app.call(env)
+    rescue StandardError => e
+      Xlog.and_raise_error(e, data: { request_params: Rack::Request.new(env).params, status: @status, headers: @headers, response: @response })
+    end
+  end
+end

data/lib/xlog/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Xlog
-  VERSION = '0.1.0'
+  VERSION = '0.1.5'.freeze
 end

data/lib/xlog/xlogger.rb

@@ -17,6 +17,10 @@ module Xlog
       @tags = tags
     end
 
+    def clear_tags
+      @tags = nil
+    end
+
     def log(type, text)
       tags = [time_stamp, called_from(type), type] + Array.wrap(@tags)
       @base_logger.tagged(tags.compact) { @base_logger.send(type, text) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xlog
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.5
 platform: ruby
 authors:
 - OrestF
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-30 00:00:00.000000000 Z
+date: 2020-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +66,22 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Xlog is just awesome logger
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: Xlog - awesome logger for your Rails app. Logs everything you need in
+  well-formatted view with timestamp, caller path and tags.
 email:
 - falchuko@gmail.com
 executables: []
@@ -75,9 +90,10 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/xlog.rb
+- lib/xlog/middleware.rb
 - lib/xlog/version.rb
 - lib/xlog/xlogger.rb
-homepage: https://github.com/OrestF/xlog
+homepage: https://github.com/coaxsoft/xlog
 licenses:
 - MIT
 metadata: {}
@@ -96,8 +112,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Xlog is just awesome logger
+summary: Xlog - awesome logger for your Rails app. Logs everything you need in well-formatted
+  view with timestamp, caller path and tags.
 test_files: []