em_logger 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 032c8a3cd33d96de73fb75b23c08cad8a60ee8e3
+  data.tar.gz: e241e3b0bedbd54d6bc87e044cc820d837a7c0f5
+SHA512:
+  metadata.gz: ed8f34da9959074d17935d17f81c66a39f3b5d76d31acf5e9ed785476cc51e407067365ecdd3d009d7cb72e3a9baa5ca76a9d58e3c3b079f95a0676de56e4721
+  data.tar.gz: 77f2ec37dd4f176edcc8dbecaa3e69cb56a99fffb06f534e6758aa0ca42428306a45184c4f6c8b26364bbf92e1162178b2c7260a64c274d27b1d0371233a2e64

data/.gitignore

@@ -0,0 +1,2 @@
+.idea/
+coverage

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format=progress
+--backtrace

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+gem 'yard'
+
+group :test do
+  gem 'rspec'
+  gem 'simplecov'
+end
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    em_logger (1.0)
+      eventmachine (>= 0.12.10)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    eventmachine (1.0.9.1)
+    json (1.8.3)
+    rake (10.5.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.1)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    simplecov (0.11.1)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    yard (0.8.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  em_logger!
+  rake
+  rspec
+  simplecov
+  yard
+
+BUNDLED WITH
+   1.10.6

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) Valery Mayatsky
+
+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,36 @@
+# EventMachine Logger
+
+EM::Logger is a simple async wrapper around the ruby logger class. It responds to all the log levels you are familiar with 
+from existing loggers (info, debug, warn, etc.). The only difference is that it's instantiated by passing an existing logger in when initializing.
+
+Getting started
+---------------
+1. Add SimpleCov to your `Gemfile` and `bundle install`:
+
+    ```ruby
+    gem 'em_logger'
+    ```
+    
+2. Require it in code and use:    
+
+    ```ruby
+    require 'eventmachine'
+    require 'logger'
+    require 'em_logger'
+        
+    logger = EM::Logger.new(Logger.new(STDOUT))
+
+    EM.run do
+      logger.debug('Wow!')
+
+      EM.stop
+    end
+    ```
+    
+3. How does it work?
+
+It pushes all your log requests into queue and the separate thread pops them and delegates to the standard Ruby logger.
+
+## Copyright
+
+Copyright (c) Valery Mayatsky. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+task :test => :spec
+
+require 'yard'
+namespace :doc do
+  YARD::Rake::YardocTask.new do |task|
+    task.files   = ['LICENSE.md', 'lib/**/*.rb']
+    task.options = ['--markup', 'markdown']
+  end
+end

data/em_logger.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'em_logger/version'
+
+Gem::Specification.new do |gem|
+  gem.name        = 'em_logger'
+  gem.version     = EventMachine::Logger::VERSION
+  gem.homepage    = 'https://github.com/Arugin/em_logger'
+
+  gem.author      = 'Valery Mayatsky'
+  gem.email       = 'valerymayatsky@gmail.com'
+  gem.description = 'An async wrapper for ruby logger for EventMachine applications.'
+  gem.summary     = 'An async wrapper for ruby logger for EventMachine applications.'
+
+  gem.add_dependency 'eventmachine', '>= 0.12.10'
+  gem.add_development_dependency 'bundler', '~> 1.0'
+
+  gem.executables = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
+  gem.files       = `git ls-files`.split("\n")
+  gem.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  gem.require_paths = ['lib']
+end

data/lib/em_logger.rb

@@ -0,0 +1 @@
+require 'em_logger/logger'

data/lib/em_logger/logger.rb

@@ -0,0 +1,111 @@
+require 'eventmachine'
+require 'logger'
+
+module EventMachine
+  class LogMessage
+    attr_accessor :severity, :message, :progname
+
+    def initialize(severity, message = nil, progname = nil)
+      @severity = severity
+      @message = message
+      @progname = progname
+    end
+
+  end
+
+  class Logger
+
+    attr_reader :logger
+    attr_reader :logger_queue
+
+    def self.logger(logger = nil)
+      @logger ||= new(logger || ::Logger.new(STDOUT))
+    end
+
+    def initialize(logger)
+      @logger = logger
+      @logger_queue = ::Queue.new
+
+      start_worker
+
+      EM.add_shutdown_hook { drain } if EM.reactor_running?
+    end
+
+    def add(severity, message = nil, progname = nil)
+      return true if severity < @logger.level
+      if message.nil?
+        if block_given?
+          message = yield
+        else
+          message = progname
+          progname = @logger.progname
+        end
+      end
+      @logger_queue.push(LogMessage.new(severity, message, progname))
+      @worker.wakeup
+    end
+
+    alias log add
+
+    def debug(progname = nil, &block)
+      add(::Logger::DEBUG, nil, progname, &block)
+    end
+
+    def info(progname = nil, &block)
+      add(::Logger::INFO, nil, progname, &block)
+    end
+
+    def warn(progname = nil, &block)
+      add(::Logger::WARN, nil, progname, &block)
+    end
+
+    def error(progname = nil, &block)
+      add(::Logger::ERROR, nil, progname, &block)
+    end
+
+    def fatal(progname = nil, &block)
+      add(::Logger::FATAL, nil, progname, &block)
+    end
+
+    def unknown(progname = nil, &block)
+      add(::Logger::UNKNOWN, nil, progname, &block)
+    end
+
+    def <<(data)
+      @logger_queue.push(LogMessage.new(nil, data))
+    end
+
+    def method_missing(method, *args, &block)
+      return super unless @logger.respond_to?(method)
+      @logger.send(method, *args, &block)
+    end
+
+    def respond_to?(method, include_private = false)
+      @logger.respond_to?(method, include_private) || super(method, include_private)
+    end
+
+    private
+
+    def drain
+      until @worker.stop?
+
+      end
+    end
+
+    def start_worker
+      @worker = Thread.new do
+
+        loop do
+          until @logger_queue.empty?
+            log_message = @logger_queue.pop(true)
+            @logger.add(log_message.severity, log_message.message, log_message.progname)
+          end
+          Thread.stop
+        end
+
+      end
+      @worker.abort_on_exception = true
+    end
+
+  end
+end

data/lib/em_logger/version.rb

@@ -0,0 +1,5 @@
+module EventMachine
+  class Logger
+    VERSION = '1.0.0'
+  end
+end

data/spec/logger_spec.rb

@@ -0,0 +1,111 @@
+require 'spec_helper'
+
+describe EventMachine::Logger do
+  let(:logger) { ::Logger.new(STDOUT) }
+
+  describe 'creating' do
+    subject { EventMachine::Logger.new(logger) }
+
+    it 'instantiates with a logger' do
+      EM.run_block do
+        expect(subject.logger).to eq(logger)
+      end
+    end
+
+    it 'adds a shutdown hook when the reactor is running' do
+      EM.run_block do
+        expect(EM).to receive(:add_shutdown_hook).and_yield
+        subject
+      end
+    end
+
+    it 'starts the queue worker' do
+      expect(logger).to receive('add').once
+
+      EM.run_block do
+        subject.debug('this is a test')
+        EM.stop
+      end
+    end
+  end
+
+  describe 'log statements' do
+    let(:em_logger) { EventMachine::Logger.new(logger) }
+
+    %w(debug info warn error fatal).each do |l|
+      describe "##{l}" do
+        it 'pushes the log message onto the logger_queue' do
+          expect(em_logger.logger_queue).to receive('push').once
+          em_logger.send("#{l}", 'this is a test')
+        end
+      end
+    end
+
+    describe '#unknown' do
+      it 'pushes the log message onto the logger_queue' do
+        expect(em_logger.logger_queue).to receive('push').once
+        em_logger.unknown('this is a test')
+      end
+    end
+
+    describe '#<<' do
+      it 'pushes the log message onto the logger_queue' do
+        expect(em_logger.logger_queue).to receive('push').once
+        em_logger << 'this is a test'
+      end
+    end
+  end
+
+  describe 'queuing' do
+    describe '#add' do
+      context 'when logging below the defined level' do
+        it 'pushes the log message onto the logger_queue' do
+          logger.level = ::Logger::WARN
+          em_logger = EventMachine::Logger.new(logger)
+          expect(em_logger.logger_queue).to_not receive('push')
+          expect(em_logger.add(::Logger::INFO, 'this is a test')).to be_truthy
+        end
+      end
+
+      context 'when logging above the defined level' do
+        it 'pushes the log message onto the logger_queue' do
+          em_logger = EventMachine::Logger.new(logger)
+          expect(em_logger.logger_queue).to receive('push').once
+          em_logger.add(::Logger::INFO, 'this is a test')
+        end
+      end
+
+      context 'when using a block' do
+        it 'evaluates the block' do
+          em_logger = EventMachine::Logger.new(logger)
+          expect(em_logger.logger_queue).to receive('push').once
+          em_logger.add(::Logger::INFO) { 'ohai' }
+        end
+      end
+    end
+  end
+
+  describe 'delegating to logger' do
+    describe 'method_missing' do
+      it 'passes through to the underlying logger' do
+        em_logger = EventMachine::Logger.new(logger)
+        expect(logger).to receive('level').once
+        em_logger.level
+      end
+
+      it 'returns the underlying loggers value' do
+        logger.level = ::Logger::WARN
+        em_logger = EventMachine::Logger.new(logger)
+        expect(em_logger.level).to eq(::Logger::WARN)
+      end
+    end
+
+    describe 'respond_to?' do
+      it 'responds to methods defined on the logger' do
+        em_logger = EventMachine::Logger.new(logger)
+        expect(em_logger.respond_to?('level')).to be_truthy
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'em_logger'
+require 'rspec'
+require 'logger'

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: em_logger
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Valery Mayatsky
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.10
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: An async wrapper for ruby logger for EventMachine applications.
+email: valerymayatsky@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- em_logger.gemspec
+- lib/em_logger.rb
+- lib/em_logger/logger.rb
+- lib/em_logger/version.rb
+- spec/logger_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Arugin/em_logger
+licenses: []
+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.4.8
+signing_key: 
+specification_version: 4
+summary: An async wrapper for ruby logger for EventMachine applications.
+test_files: []
+has_rdoc: