cute_logger 0.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7bb49f4e102b7d0827d84b93296911db889deabb
+  data.tar.gz: 9c5c17882b1d330543ca825de39e016ad4bb19af
+SHA512:
+  metadata.gz: e89de94763e3843f36119cfa5b18af5ab4a7b98a36a794eeb2a109a1b934e8ee31e0afd32553f9f4ba74e59316227df842437ca13c50134af508ce93f1630197
+  data.tar.gz: d5f125d22a65492b02e24179c9749b4e87ac52e0745bef2e5e4e6f13392ed949822eeff1c8bc6a51cfedbb6bf3d96d7c277e7795ae5cf8190b42adee0ff5001f

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cute_logger.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 newint33h
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,53 @@
+# Cute Logger
+
+This gem provides methods to log events in an easy way and accessible from anywhere.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cute_logger'
+```
+
+Or install it yourself as:
+
+    $ gem install cute_logger
+
+## Usage
+
+To use this gem, require it into your application and optionally call the setup function to specify how the information should be stored.
+
+```
+CuteLogger.setup(
+    filename: 'application.log',
+    severity: 'INFO',
+    shift_age: 7, # 7 days
+    shift_size: 1024 * 1024 * 1024 # On gigabyte
+)
+```
+
+To log something you could use the following formats:
+
+```
+log_info('Some text')
+log_info(status: 'Working', value: '123')
+log_debug(my_hash)
+log_debug { 'Delayed evaluation' }
+log_info('MyAppName') { 'Something to log' }
+log_error('Error X', my_exception)
+```
+
+There is an utility script that helps to visualize the contents of the log. For example:
+
+```
+$ cat application.log | cute_log
+$ tail -F application.log | cute_log
+$ tail -F application.log | cute_log --json
+$ grep "ERROR" application.log | cute_log --awesome
+```
+
+## Development
+
+Run `rake test` to run the tests. 
+

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/cute_log

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+require 'colorize'
+require 'json'
+require 'awesome_print'
+require 'cute_logger'
+
+awesome = true
+
+until ARGV.empty?
+  option = ARGV.shift
+  case option
+  when '--awesome', '-a'
+    awesome = true
+  when '--json', '-j'
+    awesome = false
+  when '--help', '-h'
+    $stderr.puts 'CuteLogger - cute_log'
+    $stderr.puts 'Usage: cat application.log | cute_log [-j|--json|-a|--awesome]'
+    $stderr.puts '  -j, --json     Prints the log using JSON pretty print'
+    $stderr.puts '  -a, --awesome  Prints the log using Awesome print'
+    exit
+  else
+    $stderr.puts "Invalid option: #{option}"
+    exit(-1)
+  end
+end
+
+def format_severity(severity)
+  severity.magenta if severity == 'DEBUG'
+  severity.white if severity == 'INFO'
+  severity.light_yellow if severity == 'WARN'
+  severity.light_red
+end
+
+ARGF.each do |line|
+  matches = line.to_utf8.match(/^(.*?),(.*?),(.*?),(.*?),(.*?),(.+)$/)
+  if matches
+    print "#{matches[1]}".white
+    print " #{format_severity(matches[2])}"
+    print " #{matches[3].to_i(16)}-#{matches[4]}".white
+    print " (#{matches[5]})".blue
+    print "\n"
+    begin
+      json_data = JSON.parse("[#{matches[6]}]").first
+      if json_data.is_a?(String)
+        puts json_data.yellow
+      elsif awesome
+        ap(json_data)
+      else
+        puts JSON.pretty_generate(json_data).yellow
+      end
+    rescue
+      puts matches[6].to_s.red
+    end
+  else
+    puts line.red
+  end
+end

data/cute_logger.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cute_logger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cute_logger'
+  spec.version       = CuteLogger::VERSION
+  spec.authors       = ['Jorge Del Rio']
+  spec.email         = ['jdelrios@gmail.com']
+
+  spec.summary       = 'Gem to simplify and centralize the logging process'
+  spec.description   = 'This gem provides methods to log events to an unique place'
+  spec.homepage      = 'https://github.com/newint33h/cute_logger'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'awesome_print', '~> 1'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5'
+end

data/lib/cute_logger.rb

@@ -0,0 +1,114 @@
+require 'cute_logger/version'
+require 'logger'
+require 'json'
+require 'awesome_print'
+require_relative 'utf8_enforcer'
+
+# This module defines the functionality the the CuteLogger gem
+module CuteLogger
+  SEVERITY = {
+    'DEBUG' => Logger::DEBUG,
+    'INFO'  => Logger::INFO,
+    'WARN'  => Logger::WARN,
+    'ERROR' => Logger::ERROR,
+    'FATAL' => Logger::FATAL
+  }
+
+  def self.setup(settings = {})
+    @logger = Logger.new(
+      settings[:filename] || 'application.log',
+      settings[:shift_age] || 7,
+      settings[:shift_size] || 1024 * 1024 * 1024 # One gigabyte
+    )
+    @logger.sev_threshold = severity(settings[:severity])
+    @logger.datetime_format = '%Y-%m-%d %H:%M:%S'
+    @logger.formatter = proc do |severity, datetime, progname, msg|
+      "#{datetime},#{severity},#{Process.pid.to_s(16)},#{Thread.current.object_id.to_s(16)}" \
+      ",#{progname},#{msg}\n"
+    end
+  end
+
+  def self.severity=(text)
+    @logger.sev_threshold = severity(text)
+  end
+
+  def self.severity(text)
+    return Logger::INFO unless text
+    fail("Unknown logger severity: #{text}") unless SEVERITY[text.upcase]
+    SEVERITY[text.upcase]
+  end
+
+  def self.format_message(message)
+    if message.is_a?(Array) && message.count == 1
+      message.first.to_log_format.to_json
+    else
+      message.to_log_format.to_json
+    end
+  end
+
+  def self.log(severity, classname, args, &block)
+    setup unless defined?(@logger)
+    if block_given?
+      @logger.add(severity, nil, (args.first || classname)) { format_message(block.call) }
+    else
+      @logger.add(severity, format_message(args), classname)
+    end
+  end
+
+  def self.logger
+    @logger
+  end
+
+  # Methods to be included as part of the Object class
+  module GeneralMethods
+    def log_debug(*args, &block)
+      CuteLogger.log(Logger::DEBUG, self.class, args, &block)
+    end
+
+    def log_info(*args, &block)
+      CuteLogger.log(Logger::INFO, self.class, args, &block)
+    end
+
+    def log_warn(*args, &block)
+      CuteLogger.log(Logger::WARN, self.class, args, &block)
+    end
+
+    def log_error(*args, &block)
+      CuteLogger.log(Logger::ERROR, self.class, args, &block)
+    end
+
+    def log_fatal(*args, &block)
+      CuteLogger.log(Logger::FATAL, self.class, args, &block)
+    end
+
+    def to_log_format
+      to_s.to_utf8
+    end
+  end
+end
+
+# Add global logging methods to all scopes
+class Object
+  include CuteLogger::GeneralMethods
+end
+
+# Specify and special way of logging exceptions
+class Exception
+  def to_log_format
+    { class: self.class, message: message, backtrace: backtrace }
+  end
+end
+
+# Specify that the arrays must traverse all the children to format the log
+class Array
+  def to_log_format
+    map(&:to_log_format)
+  end
+end
+
+# Specify that the hash must traverse all the children to format the log
+class Hash
+  def to_log_format
+    Hash[map { |key, value| [key.to_log_format, value.to_log_format] }]
+  end
+end

data/lib/cute_logger/version.rb

@@ -0,0 +1,5 @@
+
+# Partial module to define the version of the gem
+module CuteLogger
+  VERSION = '0.1.5'
+end

data/lib/utf8_enforcer.rb

@@ -0,0 +1,27 @@
+# String extensions to convert any encoding to utf8
+class String
+  def try_convert_from_encoding_to_utf8!(encoding)
+    original_encoding = self.encoding
+    begin
+      force_encoding(encoding).encode!(Encoding::UTF_8)
+      true
+    rescue
+      force_encoding(original_encoding)
+      false
+    end
+  end
+
+  def to_utf8!
+    if force_encoding(Encoding::UTF_8).valid_encoding?
+      return encode!(Encoding::UTF_8, invalid: :replace, replace: '?')
+    end
+    return self if try_convert_from_encoding_to_utf8!(Encoding::ISO_8859_1)
+    return self if try_convert_from_encoding_to_utf8!(Encoding::Windows_1252)
+    return self if try_convert_from_encoding_to_utf8!(Encoding::Windows_1252)
+    encode!(Encoding::UTF_8, invalid: :replace, replace: '?')
+  end
+
+  def to_utf8
+    dup.to_utf8!
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: cute_logger
+version: !ruby/object:Gem::Version
+  version: 0.1.5
+platform: ruby
+authors:
+- Jorge Del Rio
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+description: This gem provides methods to log events to an unique place
+email:
+- jdelrios@gmail.com
+executables:
+- cute_log
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/cute_log
+- cute_logger.gemspec
+- lib/cute_logger.rb
+- lib/cute_logger/version.rb
+- lib/utf8_enforcer.rb
+homepage: https://github.com/newint33h/cute_logger
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Gem to simplify and centralize the logging process
+test_files: []