logging_factory 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MTI3NTEyMWVlMGYyMjY3OWVkNWUwNTEzMWM4NThkYzZmMDQ0MmU0Mw==
+  data.tar.gz: !binary |-
+    NzFiNTBjNjgzMzc1ZjY1OTNlMTg0NDljNjViNmFmOTliNjQwNWI2ZQ==
+SHA512:
+  metadata.gz: !binary |-
+    YTY1NzFhMWZlOGQxOGI5ZDdkMzhjZGVjYTVhOWQwMDY4ZWM3NzQxMzFiNzVh
+    OWYxMzYxMTk0MzUwMjM0MGNhNzNiZTE4NDNjMzI0NDExZjZkNGVmNDU4NTgw
+    MWQ5OGVkNTkyMTU2NzY5MzMxMjM1MWJiMWI5YjQyNTJmOGQyMjY=
+  data.tar.gz: !binary |-
+    YzljMGJiNzE0OWQyMzYxMDM5NThlZjI1Y2U4Mzg0ZWM2YTc2MjY1NGQ0ZDlk
+    YTc1ODRjOGYxOTRiZTQ1ZTQ2MTQyYzlmODNlNDliODFkNjU2MmM5ZGFlODg4
+    ZWYwODMyMDMyNjkxYzUwOTc5ZjViOWMxZDI0NzRlNDMwYTJiZjU=

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+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.

data/README.md

@@ -0,0 +1,77 @@
+# LoggingFactory
+
+A wrapper around the [`logging` gem](https://github.com/TwP/logging) that makes instantiating logs easier. Also has a number of presets for file and standard output logging. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'logging_factory'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install logging_factory
+
+## Usage
+By default all output is written to standard output. To use in your project:
+
+     public class MyClass
+        def initialize()
+           log = LoggingFactory::DEFAULT_FACTORY.log(self.class)
+        end
+     end
+
+This will instantiate a log with the default configuration, specified by `LoggingFactory::DEFAULT_LOG_CONFIGURATION`:
+
+      {
+         output: 'STDOUT',
+         truncate: false,
+         level: :debug,
+         format: '[%d] %-5l [%c]: %m\n'
+     }
+     
+To override this configuration you can modify a log instance like this:
+
+     public class MyClass
+        def initialize()
+           log = LoggingFactory::DEFAULT_FACTORY.log(self.class, output: 'myproject.log')
+        end
+     end
+
+Or create a new factory instant for use in your project:
+
+
+     MY_LOG_FACTORY = LoggingFactory.create (
+         output: 'myproject.log'
+     )
+
+
+This will create an factory that will use the `myproject.log` for logging. Other options which are no supplied will fall back to the default unless explicitly overridden.
+
+     
+## Examples
+See `test/log_example.rb` for an example. 
+
+Standard output:
+
+<img src='https://github.va.opower.it/opower/logging_factory/blob/master/img/stdout.png?raw=true' height='130'>
+
+Log file:
+
+    [2013-09-19 23:12:18] DEBUG [LogExample] This is a debug message
+    [2013-09-19 23:12:18] INFO  [LogExample] This is an informational message
+    [2013-09-19 23:12:18] WARN  [LogExample] This is an warning message
+    [2013-09-19 23:12:18] ERROR [LogExample] This is an error message
+    [2013-09-19 23:12:18] FATAL [LogExample] This is a fatal message
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/lib/logging_factory.rb

@@ -0,0 +1,108 @@
+require 'version'
+require 'preconditions'
+require 'logging'
+
+#
+# This class that contains code for initializing logs.
+# @author: Nayyara Samuel (mailto: nayyara.samuel@opower.com)
+#
+# Patch so that certain checks can be gotten on a class using `include Preconditions`
+module Preconditions
+  def self.included(receiver)
+    receiver.send :include, PreconditionMixinMethods
+    receiver.send :include, PreconditionModuleClassMethods
+  end
+end
+
+# Logging factory for logs
+module LoggingFactory
+
+  DEFAULT_LOG_CONFIGURATION = {
+      output: 'STDOUT',
+      truncate: false,
+      level: :debug,
+      format: '[%d] %-5l [%c] %m\n'
+  }
+
+  # Create a new logging factory
+  def self.create(*params)
+    Logger.new(*params)
+  end
+
+  # Main logger class
+  class Logger
+    include Preconditions
+
+    attr_reader :log_configuration
+
+    # Initializes this logger instance with teh format specified
+    def initialize(config={})
+      @log_configuration = DEFAULT_LOG_CONFIGURATION.merge(config)
+    end
+
+    # Returns a new log for the calling class with the supplied configuration
+    def log(caller, config={})
+      log_configuration = @log_configuration.merge(config)
+      log = Logging.logger[caller]
+      add_appenders(log, log_configuration)
+      log
+    end
+
+    private
+    def add_appenders(log, log_configuration)
+      destination = log_configuration[:output]
+      truncate = log_configuration[:truncate]
+      level = log_configuration[:level].to_sym
+      fmt = log_configuration[:format]
+
+      if (destination == 'STDOUT')
+        append_stdout_format(log, fmt)
+      else
+        append_file_format(log, destination, fmt, truncate)
+      end
+
+      valid_levels = [:debug, :error, :fatal, :warn, :info]
+      check(level) do
+        satisfies("Logging level must be one of {#{valid_levels.join(',')}}") do
+          valid_levels.include?(level)
+        end
+      end
+      log.level = level
+      log
+    end
+
+    def append_file_format(log, destination, fmt, truncate=false)
+      Logging.appenders.file(destination,
+                             {
+                                 file_name: destination,
+                                 truncate: truncate ? true : false,
+                                 layout: Logging.layouts.pattern(pattern: fmt)
+                             })
+      log.add_appenders(destination)
+    end
+
+    def append_stdout_format(log, fmt)
+      Logging.color_scheme('bright',
+                           levels: {
+                               debug: :magenta,
+                               info: :green,
+                               warn: :yellow,
+                               error: :red, fatal: [:white, :on_red]
+                           },
+                           date: :blue, logger: :cyan)
+      Logging.appenders.stdout(
+          'stdout',
+          layout: Logging.layouts.pattern(
+              pattern: fmt,
+              color_scheme: 'bright'))
+      log.add_appenders 'stdout'
+    end
+  end
+
+  DEFAULT_FACTORY = LoggingFactory.create
+end
+
+
+
+
+

data/lib/version.rb

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

data/logging_factory.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'logging_factory'
+  gem.version       = LoggingFactory::VERSION
+  gem.authors       = ['Nayyara Samuel']
+  gem.email         = ['nayyara.samuel@opower.com']
+  gem.description   = %q{A wrapper around logging gem}
+  gem.summary       = %q{A wrapper around logging gem}
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(spec|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'logging'
+  gem.add_dependency 'preconditions'
+end

data/spec/log_stdout_spec.rb

@@ -0,0 +1,20 @@
+require_relative './lib/logging_factory'
+
+
+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 'stdout' do
+    debug_output = capture_stdout { log.debug(debug_message) }
+    puts debug_output
+  end
+
+end
+
+

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'rspec'
+
+
+# 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
+  end
+end
+
+RSpec.configure do |config|
+  config.include StdOutCapture
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: logging_factory
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nayyara Samuel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logging
+  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: preconditions
+  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'
+description: A wrapper around logging gem
+email:
+- nayyara.samuel@opower.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- img/stdout.png
+- lib/logging_factory.rb
+- lib/version.rb
+- logging_factory.gemspec
+- spec/log_stdout_spec.rb
+- spec/spec_helper.rb
+homepage: 
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A wrapper around logging gem
+test_files:
+- spec/log_stdout_spec.rb
+- spec/spec_helper.rb
+has_rdoc: