logz 1.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7398c68219adac50a2a7b95f4adb156b62447465ff8d9c01a02491d4c1cc940d
+  data.tar.gz: 6f88d5bb98b1b97280332194c85f2e25fbe9cdf393da4216822dd4c3de453a69
+SHA512:
+  metadata.gz: 6ad4d67f314dd164a3971b396d62fe793169a67152ff41282ab1f35f17dbf132b18edad676cd68a03db41c108ed017ca9062e5b6a4ff6d39c7d6628659cfd72d
+  data.tar.gz: 3ebfad24973360068c317b9178343fca0ee43213337ffbf2cf305ac29e11bf58fadeaec5cf9e959c61f332b7befe0e251cacec2e073e0bae99c295d27781b6e8

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/log/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    logz (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  logz!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) Ivan Tumanov
+
+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,137 @@
+# Logz
+
+## Key features:
+- Manage all your log files
+- Easy and lightweight, no other gems required
+- Write in two streams: STDOUT and log file when you need it
+- Set level of all logs just in single method
+- Add and remove 
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```
+gem 'logz'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install using rubygems:
+
+    $ gem install logz
+
+### Basic usage
+
+```
+require 'logz'
+
+logz = Logz.new
+
+You can use this logger just as regular Logger class in Ruby:
+
+# default logger outputs to STDOUT
+logz.debug 'Foo'
+logz.info 'Bar'
+logz.warn 'Warning'
+logz.error 'Error'
+```
+
+## Add logger
+
+```
+logz.add 'server'
+# same as:
+logz.add 'server', 'log/server', to_stdout: true, to_file: true
+# Usage:
+logz.server.info 'test'
+```
+
+This new logger will be created in the default folder, with the same name (server.log). By default, it writes both to STDOUT and log file.
+
+## Select STDOUT or file logger
+
+```
+logz.add 'client', to_stdout: true, to_file: false
+logz.client.info 'test client' # writes to STDOUT only
+```
+
+```
+logz.add 'server', to_stdout: false, to_file: true
+logz.server.info 'test server' # writes to log file only
+```
+
+
+### Add multiple loggers
+
+```
+logz.add ['server', 'client']
+logz.server.warn "Foo"
+logz.client.info "Bar"
+# or
+logz[:server].warn "Foo"
+logz[:client].info "Bar"
+```
+
+### Iterate as using array
+
+```
+logz.each do |logger|
+  logger.level = Logger::WARN
+end
+```
+
+Or do the same:
+```
+logz.global_level = Logger::WARN
+```
+
+### Configuration
+
+Config file is optional. Default params:
+
+```
+Logz.configuration do |config|
+  # Set to nil to turn off default logger
+  config.default = 'stdout'
+
+  # Set loggers
+  config.loggers = [] # example: %w(server client important)
+
+  # Write to STDOUT by default (may be disabled on production)
+  config.output_to_stdout = true
+
+  # Write to log file by default (may be disabled on development)
+  config.output_to_file = true
+
+  # Log file default extension
+  config.extension = 'log'
+
+  # Default folder is ./log. You may also specify absolute path: '/var/log'
+  config.folder = 'log'
+
+  # Suffix for log filename
+  config.suffix = ''
+
+  # Prefix for log filename
+  config.prefix = ''
+end
+```
+
+### Extra tips:
+
+Set up custom formatter for all logs:
+```
+logger.each do |l|
+  l.formatter = proc do |severity, datetime, progname, msg|
+    "[#{datetime}] [#{severity}] #{msg}\n"
+  end
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/vizakenjack/logz. This project is intended to be a safe, welcoming space for collaboration.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/logz/multi_io.rb

@@ -0,0 +1,21 @@
+module Logz
+  class MultiIO
+    attr_reader :targets
+
+    def initialize(*targets)
+      @targets = targets
+    end
+
+    def write(*args)
+      targets.each {|t| t.write(*args); t.flush }
+    end
+
+    def flush
+      targets.each(&:flush)
+    end
+
+    def close
+      targets.each(&:close)
+    end
+  end
+end

data/lib/logz/multi_logger.rb

@@ -0,0 +1,115 @@
+module Logz
+  class MultiLogger
+    include Enumerable
+    attr_accessor :folder, :loggers
+
+    def initialize(folder = nil)
+      @folder = set_folder(folder)
+      @loggers = {}
+
+      FileUtils.mkdir_p(@folder)  unless File.directory?(@folder)
+
+      add(Logz.configuration.default)
+      Logz.configuration.loggers.each { |logger_name| add(logger_name) }  if Logz.configuration.loggers.any?
+    end
+
+    def add(name, path = '', to_stdout: nil, to_file: nil)
+      to_stdout = Logz.configuration.output_to_stdout  if to_stdout == nil
+      to_file   = Logz.configuration.output_to_file    if to_file == nil
+
+      if !name || name.blank?
+        return false
+      elsif name == STDOUT || name == 'stdout'
+        name = 'stdout'
+        to_stdout = true
+        to_file = false
+      end
+
+      if name.is_a?(Array)
+        name.each { |n| add(n, path, to_stdout: to_stdout, to_file: to_file) }
+      else
+        log_path      = set_log_path(path, name)
+        output_stream = set_output_stream(log_path, to_stdout, to_file)
+
+        @loggers[name.to_sym] = Logger.new(output_stream)
+      end
+    end
+
+    def <<(name, path = '')
+      add(name, path)
+    end
+
+    def remove(name)
+      @loggers[name.to_sym].close
+      @loggers.delete(name.to_sym)
+    end
+    alias_method :delete, :remove
+
+    def each
+      loggers.each do |name, logger|
+        yield(logger)
+      end
+    end
+
+    def [](name)
+      loggers[name.to_sym]
+    end
+
+    def global_level=(level)
+      loggers.each { |name, logger| logger.level = level }
+    end
+
+    def default_logger
+      loggers[Logz.configuration.default&.to_sym]
+    end
+
+    def method_missing(m, *args, &block)
+      if loggers.has_key?(m)
+        if args.empty?
+          loggers[m]
+        else
+          puts "Invalid method for logger '#{m}': #{args.join(', ')}"
+        end
+      elsif default_logger.respond_to?(m)
+        default_logger.send(m, *args)
+      else
+        puts "Logger '#{m}' not found. Current loggers: #{loggers.keys.join(', ')}"
+      end
+    end
+
+    private
+
+    def set_folder(folder)
+      folder ||= Logz.configuration.folder
+
+      if !folder || folder.empty? || folder == '.' || folder == './'
+        Dir.pwd
+      elsif folder.start_with?('/')
+        folder
+      else
+        File.join(Dir.pwd, folder)
+      end
+    end
+
+    def set_log_path(path, name)
+      file_extension = Logz.configuration.extension.to_s.strip.empty? ? '' : ".#{Logz.configuration.extension}"
+      log_folder_path = path.start_with?('/') ? path : File.join(folder, path)
+      log_file_path = "/#{Logz.configuration.prefix}#{name}#{Logz.configuration.suffix}#{file_extension}"
+
+      File.join(log_folder_path, log_file_path)
+    end
+
+    def set_output_stream(log_path, to_stdout, to_file)
+      if to_stdout && to_file
+        MultiIO.new(STDOUT, File.open(log_path, 'a+'))
+      elsif to_stdout
+        STDOUT
+      elsif to_file
+        File.open(log_path, 'a+')
+      else
+        '/dev/null'
+      end
+    end
+
+  end
+end

data/lib/logz/version.rb

@@ -0,0 +1,3 @@
+module Logz
+  VERSION = "1.2.1"
+end

data/lib/logz.rb

@@ -0,0 +1,36 @@
+require 'logger'
+require 'logz/version'
+require 'logz/multi_io'
+require 'logz/multi_logger'
+
+module Logz
+  class Configuration
+    attr_accessor :folder, :output_to_stdout, :output_to_file,
+                  :default, :suffix, :prefix, :loggers, :extension
+
+    def initialize
+      @output_to_stdout = true
+      @output_to_file = true
+      @default = 'stdout'
+      @folder = 'log'
+      @extension = 'log'
+      @loggers = []
+      @suffix = ''
+      @prefix = ''
+    end
+  end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.new(*params)
+    configure
+    MultiLogger.new(*params)
+  end
+  
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)  if block_given?
+  end
+end

data/logz.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "logz/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "logz"
+  spec.version       = Logz::VERSION
+  spec.authors       = ["Ivan Tumanov"]
+  spec.email         = ["vizakenjack@gmail.com"]
+  spec.licenses      = ['MIT']
+  spec.summary       = %q{Simple and lightweight logger tool}
+  spec.description   = %q{Output to STDOUT and log file at the same time. Support for multiple log files.}
+  spec.homepage      = "https://github.com/vizakenjack/logz"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: logz
+version: !ruby/object:Gem::Version
+  version: 1.2.1
+platform: ruby
+authors:
+- Ivan Tumanov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-21 00:00:00.000000000 Z
+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: Output to STDOUT and log file at the same time. Support for multiple
+  log files.
+email:
+- vizakenjack@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/logz.rb
+- lib/logz/multi_io.rb
+- lib/logz/multi_logger.rb
+- lib/logz/version.rb
+- logz-1.1.0.gem
+- logz.gemspec
+homepage: https://github.com/vizakenjack/logz
+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.3
+signing_key: 
+specification_version: 4
+summary: Simple and lightweight logger tool
+test_files: []