logging_factory 0.0.1 → 0.0.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MTI3NTEyMWVlMGYyMjY3OWVkNWUwNTEzMWM4NThkYzZmMDQ0MmU0Mw==
+    OTVhM2Q5M2M2ZmU0NjI4OTliM2RjNjQxMWM2YzMyZDQyMDFhOGQ2Mg==
   data.tar.gz: !binary |-
-    NzFiNTBjNjgzMzc1ZjY1OTNlMTg0NDljNjViNmFmOTliNjQwNWI2ZQ==
+    ZmE1MjNhZjY3NGE1NWUwMTI1YTQ2ZjQyZGRlYjQzZDFmYWE3MTNkZA==
 SHA512:
   metadata.gz: !binary |-
-    YTY1NzFhMWZlOGQxOGI5ZDdkMzhjZGVjYTVhOWQwMDY4ZWM3NzQxMzFiNzVh
-    OWYxMzYxMTk0MzUwMjM0MGNhNzNiZTE4NDNjMzI0NDExZjZkNGVmNDU4NTgw
-    MWQ5OGVkNTkyMTU2NzY5MzMxMjM1MWJiMWI5YjQyNTJmOGQyMjY=
+    OWU0YjI1MDI4ZWY1YzdlNGU0NGQxM2YyNDg2NDZiODVmMTUzZmRkZDFjYmM1
+    ODVhZmRjNDZhZWMzZGM5NTk0MDU1YjU2NGQ3NjgyNzk4MjM4YmQzOWE5ZWVl
+    NjJjZGMzOWYwODY1NGJlZTExMGQyNmMyYWM2OThlZjFjNjU3NmM=
   data.tar.gz: !binary |-
-    YzljMGJiNzE0OWQyMzYxMDM5NThlZjI1Y2U4Mzg0ZWM2YTc2MjY1NGQ0ZDlk
-    YTc1ODRjOGYxOTRiZTQ1ZTQ2MTQyYzlmODNlNDliODFkNjU2MmM5ZGFlODg4
-    ZWYwODMyMDMyNjkxYzUwOTc5ZjViOWMxZDI0NzRlNDMwYTJiZjU=
+    NTQ0NDMwOTQwNjEyZTY5YjIzOWIwODUwYWNjNjc0OGI1MmM0Y2FmMWQ4ODcy
+    ODJkNGRhYTA1OTBmNjQwMmVkYjg2ZjJiZDI3NTI4YmNmNGEyNTI0YTg1ZGQ5
+    Mjc0NWMwMmE2MTJlYTAwMGIzZjc5NmFiNzc3NmU3NzZkYjBkNTA=

data/README.md

@@ -54,11 +54,11 @@ This will create an factory that will use the `myproject.log` for logging. Other
 
      
 ## Examples
-See `test/log_example.rb` for an example. 
+See `spec/my_log.log` for an example (run tests to generate this file).
 
 Standard output:
 
-<img src='https://github.va.opower.it/opower/logging_factory/blob/master/img/stdout.png?raw=true' height='130'>
+<img src='https://github.com/nayyara-samuel/logging-factory/blob/master/img/stdout.png?raw=true' height='130'>
 
 Log file:
 

data/Rakefile

@@ -1,2 +1 @@
-require "bundler/gem_tasks"
-require 'opower/nexus/deploy_task'
+require 'bundler/gem_tasks'

data/lib/version.rb

@@ -1,4 +1,4 @@
 module LoggingFactory
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end
 

data/logging_factory.gemspec

@@ -16,6 +16,6 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(spec|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency 'logging'
-  gem.add_dependency 'preconditions'
+  gem.add_dependency 'logging', '~> 1.8.1'
+  gem.add_dependency 'preconditions', '~> 0.3.0'
 end

data/spec/log_stdout_spec.rb

@@ -1,20 +1,38 @@
-require_relative './lib/logging_factory'
-
+require 'spec_helper'
 
 describe LoggingFactory::Logger do
 
-  let(:log) { LoggingFactory::DEFAULT_FACTORY.log('LogExample') }
-  let(:debug_message) { 'This is a debug message' }
-  let(:info_message) { 'This is an info message' }
-  let(:warn_message) { 'This is a warn message' }
-  let(:error_message) { 'This is an error message' }
-  let(:fatal_message) { 'This is a fatal message' }
+  context 'log to file' do
 
-  context 'stdout' do
-    debug_output = capture_stdout { log.debug(debug_message) }
-    puts debug_output
-  end
+    let(:file_accessor) { FileAccessor.new(:spec) }
+    let(:log_file) { 'my_log.log' }
+    let(:log) { LoggingFactory::DEFAULT_FACTORY.log('LogExample', output: file_accessor['my_log.log']) }
+    let(:debug_message) { 'This is a debug message' }
+    let(:info_message) { 'This is an info message' }
+    let(:warn_message) { 'This is a warn message' }
+    let(:error_message) { 'This is an error message' }
+    let(:fatal_message) { 'This is a fatal message' }
+    let(:time_regex) { /\[\d{4}(\-\d{2}){2} \d{2}(\:\d{2}){2}\]/ }
+
+    before do
+      log.debug(debug_message)
+      log.info(info_message)
+      log.warn(warn_message)
+      log.error(error_message)
+      log.fatal(fatal_message)
+    end
 
+    it 'logs messages correctly with log levels' do
+      log_content = file_accessor.read('my_log.log')
+      log_lines = log_content.split("\n")
+      expect(log_lines[0]).to match(/^#{time_regex} DEBUG \[LogExample\] #{debug_message}$/)
+      expect(log_lines[1]).to match(/^#{time_regex} INFO  \[LogExample\] #{info_message}$/)
+      expect(log_lines[2]).to match(/^#{time_regex} WARN  \[LogExample\] #{warn_message}$/)
+      expect(log_lines[3]).to match(/^#{time_regex} ERROR \[LogExample\] #{error_message}$/)
+      expect(log_lines[4]).to match(/^#{time_regex} FATAL \[LogExample\] #{fatal_message}$/)
+    end
+
+  end
 end
 
 

data/spec/spec_helper.rb

@@ -1,20 +1,37 @@
 require 'rspec'
+require 'rspec/mocks'
+require_relative '../lib/logging_factory'
 
+# A class to allow easy reference of files with a given base path
+class FileAccessor
+  attr_accessor :base_path
 
-# To capture stdout contents
-module StdOutCapture
-  def capture_stdout(&block)
-    original_stdout = $stdout
-    $stdout = fake = StringIO.new
-    begin
-      yield
-    ensure
-      $stdout = original_stdout
-    end
-    fake.string
+  # Options should have a list of parts which will be appended together to give the base path
+  def initialize(*options)
+    @base_path = File.join(options.map {|f| f.to_s})
+  end
+
+  # Access specific file in the base path
+  def [](file_name)
+    File.join(@base_path, file_name)
+  end
+
+  # Read the given file
+  def read(file_name)
+    File.read(File.join(@base_path, file_name))
+  end
+
+  # Delete all files in the directory
+  def delete_files(pattern='*.log')
+    FileUtils.rm_rf Dir.glob(File.join(base_path, pattern))
   end
 end
 
 RSpec.configure do |config|
-  config.include StdOutCapture
+
+  config.before(:suite) do
+    file_accessor = FileAccessor.new(:spec)
+    file_accessor.delete_files
+  end
+
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: logging_factory
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Nayyara Samuel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-17 00:00:00.000000000 Z
+date: 2014-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.8.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.8.1
 - !ruby/object:Gem::Dependency
   name: preconditions
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.3.0
 description: A wrapper around logging gem
 email:
 - nayyara.samuel@opower.com
@@ -47,7 +47,6 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
-- LICENSE.txt
 - README.md
 - Rakefile
 - img/stdout.png

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2013 Nayyara Samuel
-
-MIT License
-
-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.