logger_json 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ef3a03e03cd1d2cc20c4b86979b6636f3b0b4d6ca00a08d2f28842066c00bff
-  data.tar.gz: d6489546e27a6d5025b6301348734a112d9e65f233f58c96e06b9edf7b0f77fc
+  metadata.gz: d77ed01ffa4b6b2efca7dc90bf13728c8c55c9610657c1dee14e0aa8d75429f3
+  data.tar.gz: 3050046c3bb5c23dc8d78dc9ed99358f1e326ac838fa3cf9299906ce6a2a439a
 SHA512:
-  metadata.gz: b34570f3fccf06e99a0e6d6da2fbf2130c6ae335f6a5f1ba5c877c479b8d25cb9bd94647f12c52d466195dab949f77eb5e456ba146f352c2192ccc3a09c22b06
-  data.tar.gz: 84553f4d59f33d11f597073684883ffb00b923e9c7df014234070135c877a55704d0ab993a257209a11d5b0afaa447c9a68911eb5cd3c9e49e388fa483791efe
+  metadata.gz: f0cbead5a1bc8c32cb7b80e9119d113491cb38ccbf6eba8a0619e776bb3173da0ceb8f7b9dbea8e104cac9b3e7c9ecbe903f355d134282e028f1769798fef032
+  data.tar.gz: c4d2e187fda88afca2144740298e8c348e304e3e3e3b05f0092ee191fce4c753784107970f7f8f8d9de33e5d3a37f087828509880f46ec99213a061b2ffd5603

data/.gitignore

@@ -0,0 +1 @@
+/logs

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+ruby '>= 1.9.0'
+
+gem 'rubocop', require: false
+gem 'pry', '~> 0.12.2'
+gem "minitest"

data/Gemfile.lock

@@ -0,0 +1,38 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    coderay (1.1.2)
+    jaro_winkler (1.5.4)
+    method_source (0.9.2)
+    minitest (5.14.0)
+    parallel (1.19.1)
+    parser (2.7.0.2)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rainbow (3.0.0)
+    rubocop (0.79.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.6.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest
+  pry (~> 0.12.2)
+  rubocop
+
+RUBY VERSION
+   ruby 2.4.9p362
+
+BUNDLED WITH
+   1.17.3

data/MIT-LICENSE

@@ -0,0 +1 @@
+Copyright 2020 .

data/README.md

@@ -0,0 +1,73 @@
+**LoggerJson** is a gem written in Ruby that adds new functionality, without changing the function of the Logger class methods, which creates the logs in the json format.
+
+**Getting started**
+
+LoggerJson's installation is pretty standard:
+
+```bash
+gem install logger_json
+```
+
+Add the following line to your  `Gemfile`:
+
+```ruby
+gem 'logger_json'
+```
+
+Then run `bundle install`
+
+Just initialize the gem and watch the magic happen
+
+```ruby
+require 'logger_json'
+```
+
+**Parameters**
+
+```ruby
+      {
+        date: "2020-02-05T13:46:11.026134758+00:00", #iso8601
+        host: "https://www.r7.com/",
+        thread: 'current_thread',
+        methods: ['create_json'],
+        level: 'info',
+        message: 'LoggerJson is a gem written in Ruby that ...'
+      }
+```
+
+**To add parameters in the json logger**
+
+```ruby
+more_params = {key1: data, key2: data ... keyN: data}
+Logger.new('output').warn(message, more_params)
+```
+
+**Compatibility**
+
+- Ruby 1.9+
+
+**Running tests**
+
+LoggerJson uses [Mini Test](https://github.com/seattlerb/minitest) as test framework.
+
+* Ruby version > 2.0
+
+* Running all tests:
+
+  ```bash
+  ruby test/test.rb
+  ```
+
+* Runnin tests for an specific file:
+
+  ```bash
+  ruby test/create_file_spec.rb
+  ```
+
+**Changelog**
+
+LoggerJson changelog is available [here](https://gitlab.ir7.com.br/r7/logger-json/blob/master/CHANGELOG.md).
+
+**Copyright**
+
+Copyright (c) 2020

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "logger_json"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/logger_json/json/debug.rb

@@ -0,0 +1,9 @@
+class Logger
+  alias_method :old_debug, :debug
+
+  def debug(*args, &block)
+    create_file args, :debug
+    return send :old_debug, args[0] { block } if block_given?
+    send :old_debug, args[0]
+  end
+end

data/lib/logger_json/json/error.rb

@@ -0,0 +1,9 @@
+class Logger
+  alias_method :old_error, :error
+
+  def error(*args, &block)
+    create_file args, :error
+    return send :old_error, args[0] { block } if block_given?
+    send :old_error, args[0]
+  end
+end

data/lib/logger_json/json/fatal.rb

@@ -0,0 +1,9 @@
+class Logger
+  alias_method :old_fatal, :fatal
+
+  def fatal(*args, &block)
+    create_file args, :fatal
+    return send :old_fatal, args[0] { block } if block_given?
+    send :old_fatal, args[0]
+  end
+end

data/lib/logger_json/json/info.rb

@@ -0,0 +1,9 @@
+class Logger
+  alias_method :old_info, :info
+
+  def info(*args, &block)
+    create_file args
+    return send :old_info, args[0] { block } if block_given?
+    send :old_info, args[0]
+  end
+end

data/lib/logger_json/json/model.rb

@@ -0,0 +1,50 @@
+module LoggerJson
+  class Model
+    attr_accessor :json
+
+    def initialize(message, type)
+      @type = type
+      @json = convert_to_json message
+    end
+
+    private
+
+    def convert_to_json(msg)
+      return log(msg[0]).to_json if msg[1].nil?
+      return (log(msg[0]).merge(msg[1])).to_json if msg[1].is_a? Hash
+      return add_array_in_log msg if msg[1].is_a? Array
+      add_string_in_log msg
+    end
+
+    def log(message)
+      {
+        date: DateTime.now.iso8601(9),
+        host: IO.popen('hostname').readlines[0].strip,
+        thread: Thread.current,
+        methods: methods,
+        level: @type,
+        message: message
+      }
+    end
+
+    def add_array_in_log(msg)
+      logs = log msg[0]
+      msg[1].select.with_index {|val, index| logs[index] = val}
+      logs.to_json
+    end
+
+    def methods
+      array = []
+      caller.join('\n').scan(/\`([a-z_-]*)\'/) do |match|
+        array << match[0] unless array.include? match[0]
+      end
+      array
+    end
+
+    def add_string_in_log(msg)
+      logs = log msg[0]
+      logs[:log] = msg[1]
+      logs.to_json
+    end
+  end
+end

data/lib/logger_json/json/warn.rb

@@ -0,0 +1,9 @@
+class Logger
+  alias_method :old_warn, :warn
+
+  def warn(*args, &block)
+    create_file args, :warn
+    return send :old_warn, args[0] { block } if block_given?
+    send :old_warn, args[0]
+  end
+end

data/lib/logger_json/logger.rb

@@ -0,0 +1,21 @@
+class Logger
+  class << self
+    def json_path
+      LoggerJson::Text::PATH
+    end
+  end
+
+  private
+
+  def create_file(message, type=:info)
+    path = filename || Logger.json_path
+    json = LoggerJson::Model.new(message, type).json
+    LoggerJson::Writter.logger_json(path, json)
+  end
+
+  def filename
+    path = instance_variable_get("@logdev").filename
+    return if path.nil?
+    path.gsub(".log","-json.log")
+  end
+end

data/lib/logger_json/text.rb

@@ -0,0 +1,6 @@
+module LoggerJson
+  module Text
+    LOGGER_JSON = 'From now on every log will generate a json'.freeze
+    PATH = 'logs/user-logs.log'
+  end
+end

data/lib/logger_json/version.rb

@@ -0,0 +1,3 @@
+module LoggerJson
+  VERSION = "1.0.2".freeze
+end

data/lib/logger_json/writter.rb

@@ -0,0 +1,8 @@
+module LoggerJson
+  class Writter
+    def self.logger_json(path, json)
+      return puts json if path.nil?
+      open(path, 'a') { |f| f.puts json}
+    end
+  end
+end

data/logger_json.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "logger_json/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "logger_json"
+  spec.version       = LoggerJson::VERSION.dup
+  spec.authors       = ["Vinicius Freire"]
+  spec.email         = ["vfoliveira@rederecord.com.br"]
+
+  spec.summary       = "Flexible Json Logger solution for Ruby"
+  spec.description   = "LoggerJson is a gem written in Ruby that adds new functionality, without changing the function of the Logger class methods, which creates the logs in the json format."
+  spec.homepage      = "https://gitlab.ir7.com.br/r7/logger-json"
+  spec.license       = "MIT"
+  spec.required_ruby_version = '>= 1.9.0'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -1,24 +1,86 @@
 --- !ruby/object:Gem::Specification
 name: logger_json
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Vinicius Freire
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
 date: 2020-02-05 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
 description: LoggerJson is a gem written in Ruby that adds new functionality, without
   changing the function of the Logger class methods, which creates the logs in the
   json format.
-email: vfoliveira@rederecord.com.br
+email:
+- vfoliveira@rederecord.com.br
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.md
+- bin/console
+- bin/setup
 - lib/logger_json.rb
+- lib/logger_json/json/debug.rb
+- lib/logger_json/json/error.rb
+- lib/logger_json/json/fatal.rb
+- lib/logger_json/json/info.rb
+- lib/logger_json/json/model.rb
+- lib/logger_json/json/warn.rb
+- lib/logger_json/logger.rb
+- lib/logger_json/text.rb
+- lib/logger_json/version.rb
+- lib/logger_json/writter.rb
+- logger_json.gemspec
 homepage: https://gitlab.ir7.com.br/r7/logger-json
 licenses:
 - MIT