xlog 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fd95d2da4868dd8be558341be8c5e8fb6506f1d6e7fb353d22fbc58d1db84c4c
+  data.tar.gz: 334ff24b034fe2c92ed2915b7be4aefae461d9f4d65fa8422a88e005bf83fa86
+SHA512:
+  metadata.gz: 229ac2f213663efeab5e08303df6530c6023c37b9b628d3cb4ec6d9aba452b0833dedba73179e64fae1c20efea10d471447740eebb7fcfbd9c1125755d3da007
+  data.tar.gz: b87ccd85daeab222e3ecdf5d6cee9b279c9995fcf2661a213ae553b6be5d21a01d8df653f2488ba3f4c60fb3716c3e7c0a766a6511a2314494fd3944fffa5b85

data/README.md

@@ -0,0 +1,92 @@
+# Xlog v0.0.1
+
+Xlog - awesome logger for your Rails app. Logs everything you need in well-formatted view with timestamp, caller path and tags.
+
+## Usage
+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
+```
+Log important info with `.warn` method
+```ruby
+Xlog.warn('Validation failed') # [2019-04-30 12:29:13 UTC] [ArticlesController.update] [warn] Message: Validation failed
+```
+
+Xlog has awesome `.error` and `.and_raise_error` methods
+```ruby
+def index
+  10 / 0  
+  @orders = Order.all  
+  rescue StandardError => e
+    Xlog.and_raise_error(e, data: { params: params }, message: 'Some message text here')
+end
+```
+...and the output
+```
+[2019-04-30 11:48:33 UTC] [Admin::OrdersController.index] [error] ZeroDivisionError: divided by 0. 
+  | Message: Some message text here
+  | Data: {:params=><ActionController::Parameters {"controller"=>"admin/orders", "action"=>"index"} permitted: false>} 
+  | Error backtrace: 
+  | /home/me/test_app/app/controllers/admin/orders_controller.rb:7:in `/'
+  | /home/me/test_app/app/controllers/admin/orders_controller.rb:7:in `index'
+```
+The only difference between `Xlog.error` and `Xlog.and_raise_error` is that second one raises error after logging.
+
+Xlog automatically defines Rails application name and environment.
+It writes logs into `log/xlog_[environement].log`
+
+## 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.
+
+```ruby
+Xlog.configure do |config|
+  config.custom_logger = Logger.new(STDOUT) # or Logger.new('foo.log', 10, 1024000) or any other
+end
+```
+It's possible to set third-party logger like Logentries(r7rapid)
+```ruby
+require 'le'
+
+Xlog.configure do |config|
+  config.custom_logger = Le.new(logentries_key, 'eu', tag: true)
+end
+```
+
+Look [here](https://ruby-doc.org/stdlib-2.4.0/libdoc/logger/rdoc/Logger.html) to know more about `Logger` configuration.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'xlog'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install xlog
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## 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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## 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).
+
+## Idea
+Initially designed and created by [Orest Falchuk (OrestF)](https://github.com/OrestF)

data/lib/xlog/version.rb

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

data/lib/xlog/xlogger.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Xlog
+  class Xlogger
+    include Singleton
+
+    attr_accessor :app_name, :app_root, :base_logger
+    def initialize
+      @base_logger = ActiveSupport::TaggedLogging.new(Logger.new("log/xlog_#{Rails.env}.log"))
+
+      @app_name = Rails.application.class.to_s.split('::')[0].underscore
+      @app_root = Rails.root.to_s
+      @folder_names_to_remove = Dir.glob('app/*').map { |f| f.gsub('app/', '') }
+    end
+
+    def tag_logger(*tags)
+      @tags = tags
+    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) }
+    end
+
+    def info(message, data)
+      log(:info, compose_log(message, data))
+    end
+
+    def warn(message, data)
+      log(:warn, compose_log(message, data))
+    end
+
+    # do NOT refactor error and and_raise_error
+    def error(e, message, data)
+      # they MUST BE NOT DRY in order to log correct backtrace
+      log(:error, "#{e.class}: #{e.try(:message)}. \n #{compose_log(message, data)} \n Error backtrace: \n#{backtrace(e)}")
+    end
+
+    def and_raise_error(e, message, data)
+      log(:error, "#{e.class}: #{e.try(:message)}. #{newline} #{compose_log(message, data)} #{newline} Error backtrace: #{newline} #{backtrace(e)}")
+      message.present? ? raise(e, message) : raise(e)
+    end
+
+    def custom_logger=(logger)
+      @base_logger = ActiveSupport::TaggedLogging.new(logger)
+    end
+
+    private
+
+    def newline
+      "\n  |"
+    end
+
+    def time_stamp
+      Time.zone&.now || Time.current
+    end
+
+    def compose_log(message, data)
+      message = "Message: #{message}"
+      message += "#{newline} Data: #{data.try(:inspect)}" if data.present?
+      message
+    end
+
+    def backtrace(e)
+      backtrace_cleaner.clean(e.try(:backtrace)).try(:join, "#{newline} ")
+    end
+
+    def backtrace_cleaner
+      return @backtrace_cleaner if @backtrace_cleaner.present?
+
+      bc = ActiveSupport::BacktraceCleaner.new
+      bc.add_filter   { |line| line.gsub(app_root, '') }
+      bc.add_silencer { |line| line =~ /puma|rubygems|gems/ }
+      @backtrace_cleaner = bc
+    end
+
+    def called_from(type)
+      caller_position = type == :error ? 5 : 4
+      caller(caller_position..caller_position)[0]
+        .split("/#{app_name}/*")[-1]
+        .split('.rb')[0]
+        .remove(*@folder_names_to_remove)
+        .split('//')[-1]
+        .camelize
+        .concat(".#{caller_locations(caller_position, caller_position + 1)[0].label}")
+    end
+  end
+end

data/lib/xlog.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'rails'
+require 'xlog/xlogger'
+require 'xlog/version'
+
+module Xlog
+  class << self
+    attr_accessor :config, :app_name, :app_root, :base_logger, :xlogger
+
+    def tag_logger(*tags)
+      config.xlogger.tag_logger(tags)
+    end
+
+    def info(message, data: nil)
+      config.xlogger.info(message, data)
+    end
+
+    def warn(message, data: nil)
+      config.xlogger.warn(message, data)
+    end
+
+    def error(e, message: nil, data: nil)
+      config.xlogger.error(e, message, data)
+    end
+
+    def and_raise_error(e, message: nil, data: nil)
+      config.xlogger.and_raise_error(e, message, data)
+    end
+  end
+
+  def self.configure
+    self.config ||= Config.new
+    yield(config)
+  end
+
+  class Config
+    attr_accessor :xlogger
+
+    def initialize
+      @xlogger = Xlogger.instance
+    end
+
+    def custom_logger=(logger)
+      xlogger.custom_logger = logger
+    end
+  end
+
+  configure {}
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: xlog
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- OrestF
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  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 is just awesome logger
+email:
+- falchuko@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/xlog.rb
+- lib/xlog/version.rb
+- lib/xlog/xlogger.rb
+homepage: https://github.com/OrestF/xlog
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Xlog is just awesome logger
+test_files: []