mimi-logger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 69b1d63b51fc0bc2a4b205a10c71dda4c33674ba
+  data.tar.gz: d3809569ef0c86aba1368243cbbcefec5b1b8c62
+SHA512:
+  metadata.gz: 869c7890e0923162a8fb7d20a7910c6e0d488a5fb7dc6b7b5a38e9c8600146f36f4b6269253ffcfdbd81ecb0c986c218e975b56901c67c8af95e878a28e0e70c
+  data.tar.gz: a0703736c7f5764b70073f750426be8793598137495613cdc844feae89835e264b7ef29685ff0547321eb6f0ca6b4e31566a2ecb774b0630c17c29a63be7c733

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at alex@kukushk.in. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'mimi-core', path: '/mimi-core'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Alex Kukushkin
+
+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,41 @@
+# mimi-logger
+
+A pre-configured logger for microservice applications.
+
+[in development]
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mimi-logger'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mimi-logger
+
+## Usage
+
+```ruby
+require 'mimi/logger'
+
+logger = Mimi::Logger.new
+
+logger.info 'I am a banana!' # outputs "I, I am a banana!" to STDOUT
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kukushkin/mimi-logger. 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](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'mimi/logger'
+
+require 'pry'
+Pry.start

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/mimi/logger.rb

@@ -0,0 +1,102 @@
+require 'forwardable'
+require 'logger'
+require 'mimi/core'
+
+module Mimi
+  #
+  # Mimi::Logger is a preconfigured logger which outputs log messages to STDOUT.
+  #
+  class Logger
+    extend Forwardable
+    include Mimi::Core::Module
+
+    attr_reader :logger_instance
+    delegate [
+      :debug, :info, :warn, :error, :fatal, :unknown,
+      :debug?, :info?, :warn?, :error?, :fatal?,
+      :<<, :add, :log
+    ] => :logger_instance
+
+    default_options(
+      level: 'info'
+    )
+
+    # Creates a new Logger instance
+    #
+    # @param [IO] io An IO object to output log messages to, defaults to STDOUT
+    # @param [Hash] opts
+    # @option [String,Symbol,Integer] :level Initial log level, e.g. 'info'
+    #
+    # @example
+    #   logger = Mimi::Logger.new
+    #   logger.info 'I am a banana!' # outputs "I, I am a banana!" to the STDOUT
+    #
+    #   logger = Mimi::Logger.new(level: :debug)
+    #   logger.debug 'blabla' # => "D, blabla"
+    #
+    def initialize(*args)
+      io = args.shift if args.first.is_a?(IO)
+      io ||= STDOUT
+      opts = args.shift if args.first.is_a?(Hash)
+      opts ||= {}
+      raise ArgumentError, '(io, opts) are expected as parameters' unless args.empty?
+
+      opts = self.class.module_options.deep_merge(opts)
+      @logger_instance = ::Logger.new(io)
+      @logger_instance.level = self.class.level_from_any(opts[:level])
+      io.sync if io.respond_to?(:sync)
+      @logger_instance.formatter = self.class.formatter
+    end
+
+    # Returns the current log level
+    #
+    # @return [Fixnum]
+    #
+    def level
+      logger_instance.level
+    end
+
+    # Sets the log level.
+    # Allows setting the log level from a String or a Symbol, in addition to the standard ::Logger::INFO etc.
+    #
+    # @param [String,Symbol,Fixnum] value
+    #
+    def level=(value)
+      logger_instance.level = self.class.level_from_any(value)
+    end
+
+    # Returns the log level inferred from value
+    #
+    # @param value [String,Symbol,Fixnum]
+    #
+    def self.level_from_any(value)
+      return value if value.is_a?(Fixnum)
+      case value.to_s.downcase.to_sym
+      when :debug
+        ::Logger::DEBUG
+      when :info
+        ::Logger::INFO
+      when :warn
+        ::Logger::WARN
+      when :error
+        ::Logger::ERROR
+      when :fatal
+        ::Logger::FATAL
+      when :unknown
+        ::Logger::UNKNOWN
+      else
+        raise ArgumentError, "Invalid value for the log level: '#{value}'"
+      end
+    end
+
+    def self.formatter
+      proc do |severity, _datetime, _progname, message|
+        "#{severity.to_s[0]}, #{message}\n"
+      end
+    end
+  end # class Logger
+end # module Mimi
+
+require_relative 'logger/version'
+require_relative 'logger/null_logger'
+require_relative 'logger/instance'

data/lib/mimi/logger/instance.rb

@@ -0,0 +1,27 @@
+module Mimi
+  class Logger
+    #
+    # A mixin to include into your classes and modules.
+    # Makes methods #logger and .logger available, referring to one global instance:
+    #
+    # class MyApp
+    #   include Mimi::Logger::Instance
+    #
+    #   def something
+    #     logger.info 'Doing something...'
+    #   end
+    # end
+    #
+    module Instance
+      def self.included(base)
+        # puts "Module #{self} included into #{base}"
+        base.send(:define_method, :logger) { Mimi::Logger::Instance.instance }
+        base.send(:define_singleton_method, :logger) { Mimi::Logger::Instance.instance }
+      end
+
+      def self.instance
+        @logger ||= Mimi::Logger.new
+      end
+    end # module Instance
+  end # class Logger
+end # module Mimi

data/lib/mimi/logger/null_logger.rb

@@ -0,0 +1,27 @@
+module Mimi
+  class Logger
+    class NullLogger
+      def initialize(*)
+      end
+
+      def debug(*)
+      end
+
+      def info(*)
+      end
+
+      def warn(*)
+      end
+
+      def error(*)
+      end
+
+      def fatal(*)
+      end
+
+      def level; end
+
+      def level=(*); end
+    end # class NullLogger
+  end # class Logger
+end # module Mimi

data/lib/mimi/logger/version.rb

@@ -0,0 +1,5 @@
+module Mimi
+  class Logger
+    VERSION = '0.1.0'.freeze
+  end
+end

data/mimi-logger.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mimi/logger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mimi-logger'
+  spec.version       = Mimi::Logger::VERSION
+  spec.authors       = ['Alex Kukushkin']
+  spec.email         = ['alex@kukushk.in']
+
+  spec.summary       = 'A pre-configured logger for microservice applications'
+  spec.description   = 'A pre-configured logger for microservice applications'
+  spec.homepage      = 'https://github.com/kukushkin/mimi-logger'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'mimi-core'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry', '~> 0.10'
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: mimi-logger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alex Kukushkin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mimi-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: A pre-configured logger for microservice applications
+email:
+- alex@kukushk.in
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mimi/logger.rb
+- lib/mimi/logger/instance.rb
+- lib/mimi/logger/null_logger.rb
+- lib/mimi/logger/version.rb
+- mimi-logger.gemspec
+homepage: https://github.com/kukushkin/mimi-logger
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: A pre-configured logger for microservice applications
+test_files: []