deployable-log 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9de861a529291094dcc61ce6ff06050407bd065e
+  data.tar.gz: 504ee51401e2349290d49da172696945e7a126f3
+SHA512:
+  metadata.gz: 98f522f9b89869d8940d7957b224298f75442c025079921ffb7f2d05d76768e59f55e76918df0c27c92b830e2ac34bcd2f74a57b40624d0d3cbfddb3e1067206
+  data.tar.gz: 42016b87b2c7d6b78ae160219cc29f84e5f3b11d244d11a0b3fe73f43b834d8e94b2c4353b89510e80febd62a7f730b7e0ac87148be766a4da7dafcf5a5ca139

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 deployable
+
+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,37 @@
+# Deployable::Log
+
+Deployable::Log creates a singleton log instance that will be accessible
+via the `log` function where ever you require `deployable/log`
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'deployable-log'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself
+
+    $ gem install deployable-log
+
+## Usage
+
+    require 'deplyoable/log'
+
+    include Deployable::Log
+
+    log.info "all the information"
+
+
+## Contributing
+
+1. Fork it ( https://github.com/deployable/deployable-log/fork )
+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 a new Pull Request

data/Rakefile

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

data/changelog.md

@@ -0,0 +1,5 @@
+# Deployable::Log Changes
+=========================
+
+*0.5* - changed some of the generic names for helper methods that are brought into the class so we are not clashing into other method names. `.log` is still there though.
+http://supervisord.org/xmlrpc.html

data/deployable-log.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'deployable/log/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "deployable-log"
+  spec.version       = Deployable::Log::VERSION
+  spec.authors       = ["deployable"]
+  spec.email         = ["matt@deployable.co"]
+  spec.summary       = %q{Log singleton}
+  spec.description   = %q{Log singleton}
+  spec.homepage      = "http://deployable.co"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_development_dependency "pry-byebug", "~> 2.0"
+end

data/lib/deployable/log.rb

@@ -0,0 +1,245 @@
+require "deployable/log/version"
+require 'logger'
+
+### Log - a global logger instance for classes
+#
+# Allows you to call a single logger instance easily from your classes
+#
+#     class Yours
+#       include Log
+#       def method
+#         log.info 'something'
+#       end
+#     end
+
+module Deployable
+
+
+  # Create a custom instance of the Ruby `logger`. 
+  # We add a bunch of hlper log methods
+  class Logger < Logger
+
+    # Add on TRACE to the logger class
+    TRACE = -1
+    module Severity;
+      TRACE = -1
+    end
+    include Severity
+    def trace( progname = nil, &block )
+      add( TRACE, nil, progname, &block )
+    end
+    def trace?; @level <= TRACE; end
+
+
+
+    def trace_each tag, iter #, &block
+      return if @level > TRACE
+      iter.each do |m|
+        add( TRACE, nil, "#{tag} #{m}" )
+      end
+    end
+
+    def debug_each tag, iter #, &block
+      return if @level > DEBUG
+      iter.each do |m|
+        add( DEBUG, nil, "#{tag} #{m}" )
+      end
+    end
+
+    def info_each tag, iter #, &block
+      return if @level > INFO
+      iter.each do |m|
+        add( INFO, nil, "#{tag} #{m}" )
+      end
+    end
+
+    def error_each tag, iter #, &block
+      return if @level > ERROR
+      iter.each do |m|
+        add( ERROR, nil, "#{tag} #{m}" )
+      end
+    end
+
+    def fatal_each tag, iter #, &block
+      return if @level > FATAL
+      iter.each do |m|
+        add( FATAL, nil, "#{tag} #{m}" )
+      end
+    end
+
+
+    # Var loggers
+    def trace_var *args, &block
+      return if @level > TRACE
+      message = block_given? ? build_var(yield) : build_var(*args)
+      add( TRACE, nil, message )
+    end
+
+    def debug_var *args, &block
+      return if @level > DEBUG
+      message = block_given? ? build_var(yield) : build_var(*args)
+      add( DEBUG, nil, message )
+    end
+
+    def info_var *args, &block
+      return if @level > INFO
+      message = block_given? ? build_var(yield) : build_var(*args)
+      add( INFO, nil, message )
+    end
+
+    def warn_var *args, &block
+      return if @level > WARN
+      message = block_given? ? build_var(yield) : build_var(*args)
+      add( WARN, nil, message )
+    end
+
+    def error_var *args, &block
+      return if @level > ERROR
+      message = block_given? ? build_var(yield) : build_var(*args)
+      add( ERROR, nil, message )
+    end
+
+    def fatal_var *args, &block
+      return if @level > FATAL
+      message = block_given? ? build_var(yield) : build_var(*args)
+      add( FATAL, nil, message )
+    end
+
+
+    # Pair loggers
+    def trace_pair *args, &block
+      return if @level > TRACE
+      message = block_given? ? build_pair(yield) : build_pair(*args)
+      add( TRACE, nil, message )
+    end
+
+    def debug_pair *args, &block
+      return if @level > DEBUG
+      message = block_given? ? build_pair(yield) : build_pair(*args)
+      add( DEBUG, nil, message )
+    end
+
+    def info_pair *args, &block
+      return if @level > INFO
+      message = block_given? ? build_pair(yield) : build_pair(*args)
+      add( INFO, nil, message )
+    end
+
+    def warn_pair *args, &block
+      return if @level > WARN
+      message = block_given? ? build_pair(yield) : build_pair(*args)
+      add( WARN, nil, message )
+    end
+
+    def error_pair *args, &block
+      return if @level > ERROR
+      message = block_given? ? build_pair(yield) : build_pair(*args)
+      add( ERROR, nil, message )
+    end
+
+    def fatal_pair *args, &block
+      return if @level > FATAL
+      message = block_given? ? build_pair(yield) : build_pair(*args)
+      add( FATAL, nil, message )
+    end
+
+
+    # Fatal and error to raise
+    def fatal_raise error, *args, &block
+      return if @level > FATAL
+      message = block_given? ? build_pair(yield) : build_pair(*args)
+      add( FATAL, nil, message )
+      raise error, message
+    end
+
+    def error_raise error, *args, &block
+      return if @level > ERROR
+      message = block_given? ? build_pair(yield) : build_pair(*args)
+      add( ERROR, nil, message )
+      raise error, message
+    end
+
+  private
+
+    # Creates a string of vars log:
+    #    message text [var1] [var2] [var3]
+    def build_var *args
+      line =  "#{args[0]}"
+      # bracket [] any additional arguments
+      line << " [#{args[1...args.length].join('] [')}]" if args.length > 1
+      line
+    end
+
+    # Creates a string of pairs to log (useful for hashes too)
+    #    var1 [val1] var2 [val2]
+    def build_pair *args
+      args = args.to_a unless args.respond_to? :each_slice
+      args.each_slice(2).map{|name,var| "#{name} [#{var}]" }.join(' ')
+    end
+
+  end
+
+
+  # A singleton interface to the Deployable logger
+  # 
+  module Log
+
+    # Default output
+    #DefaultIO = STDOUT
+    DefaultIO = $stdout
+
+
+    class << self
+
+      # create a new logger
+      # Doesn't impact the singleton
+      def create_log io = DefaultIO, level = ::Deployable::Logger::INFO
+        l = ::Deployable::Logger.new io
+        l.level = level
+        l
+      end
+
+      # Replace the singleton logger with a new target/level
+      def replace_log io = DefaultIO, level = @log.level
+        l = ::Deployable::Logger.new io, level
+        #l.level = @log.level
+        @log = l
+      end
+
+      # Set the level for the logger
+      def log_level level
+        level = Deployable::Logger.const_get level.upcase unless 
+          level.kind_of? ::Fixnum
+
+        @log.level = level
+      end
+
+      # Add `.log` to the instance of the class
+      # Return the singleton or create it
+      def log 
+        @log #||= Log.create
+      end
+
+      # Add `.log` to the class instance on include
+      def included base
+        class << base
+          def log
+            Deployable::Log.log
+          end
+        end
+      end
+
+    end
+
+    # Module instance variable to hold the singleton logger instance
+    @log = create_log
+
+    # Adds `.log` method to the class instance to return the singleton
+    def log
+      ::Deployable::Log.log
+    end
+
+  end
+
+
+end

data/lib/deployable/log/version.rb

@@ -0,0 +1,5 @@
+module Deployable
+  module Log
+    VERSION = "0.5.0"
+  end
+end

data/spec/deployable/log_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe Deployable::Log do
+
+
+  describe 'initial' do
+
+    it 'has a version number' do
+      expect(Deployable::Log::VERSION).not_to be nil
+    end
+
+    
+  end
+
+
+  describe 'module include' do
+
+    it 'can get a log instance' do
+      expect( Deployable::Log.log ).not_to be nil
+    end
+
+    it 'gets the same instance' do
+      expect( Deployable::Log.log ).to be Deployable::Log.log
+    end
+
+    it 'log_level' do
+      expect( Deployable::Log.log_level(1) ).to be 1
+    end
+
+    it 'log_level name' do
+      expect( Deployable::Log.log_level :DEBUG ).to be 0
+    end
+
+    it 'log_level via symbol' do
+      expect( Deployable::Log.log_level 'DEBUG' ).to be 0
+    end
+
+  end
+
+end

data/spec/deployable/logger_spec.rb

@@ -0,0 +1,143 @@
+require 'spec_helper'
+
+describe Deployable::Logger do
+
+  describe 'simple' do
+
+    before :each do
+      @io  = StringIO.new
+      @log = Deployable::Log.create_log @io
+    end
+
+    it 'trace' do
+      @log.level = Deployable::Logger::TRACE
+      @log.trace 'testt'
+      expect( @io.string ).to  end_with ": testt\n"
+    end
+
+    it 'debug' do
+      @log.level = Deployable::Logger::DEBUG
+      @log.debug 'testd'
+      expect( @io.string ).to  end_with ": testd\n"
+    end
+    
+    it 'info' do
+      @log.level = Deployable::Logger::INFO
+      @log.info 'testi'
+      expect( @io.string ).to  end_with ": testi\n"
+    end
+
+    it 'warn' do
+      @log.level = Deployable::Logger::WARN
+      @log.warn 'testw'
+      expect( @io.string ).to  end_with ": testw\n"
+    end
+
+    it 'error' do
+      @log.level = Deployable::Logger::ERROR
+      @log.error 'teste'
+      expect( @io.string ).to  end_with ": teste\n"
+    end
+    
+    it 'fatal' do
+      @log.level = Deployable::Logger::FATAL
+      @log.fatal 'testf'
+      expect( @io.string ).to  end_with ": testf\n"
+    end
+    
+  end
+
+
+  describe 'var' do
+
+    before :each do
+      @io  = StringIO.new
+      @log = Deployable::Log.create_log @io
+    end
+
+    it 'trace' do
+      @log.level = Deployable::Logger::TRACE
+      @log.trace_var 'test',1
+      expect( @io.string ).to  end_with ": test [1]\n"
+    end
+
+    it 'debug' do
+      @log.level = Deployable::Logger::DEBUG
+      @log.debug_var 'test',2
+      expect( @io.string ).to  end_with ": test [2]\n"
+    end
+    
+    it 'info' do
+      @log.level = Deployable::Logger::INFO
+      @log.info_var 'test',3
+      expect( @io.string ).to  end_with ": test [3]\n"
+    end
+
+    it 'warn' do
+      @log.level = Deployable::Logger::WARN
+      @log.warn_var 'test',4
+      expect( @io.string ).to  end_with ": test [4]\n"
+    end
+
+    it 'error' do
+      @log.level = Deployable::Logger::ERROR
+      @log.error_var 'test',5
+      expect( @io.string ).to  end_with ": test [5]\n"
+    end
+    
+    it 'fatal' do
+      @log.level = Deployable::Logger::FATAL
+      @log.fatal_var 'test',6
+      expect( @io.string ).to  end_with ": test [6]\n"
+    end
+
+  end
+
+
+  describe 'pair' do
+
+    before :each do
+      @io  = StringIO.new
+      @log = Deployable::Log.create_log @io
+    end
+
+    it 'trace' do
+      @log.level = Deployable::Logger::TRACE
+      @log.trace_pair 'test', 1, 2,3
+      expect( @io.string ).to  end_with ": test [1] 2 [3]\n"
+    end
+
+    it 'debug' do
+      @log.level = Deployable::Logger::DEBUG
+      @log.debug_pair 'test', 2,3,4
+      expect( @io.string ).to  end_with ": test [2] 3 [4]\n"
+    end
+    
+    it 'info' do
+      @log.level = Deployable::Logger::INFO
+      @log.info_pair 'test', 3,4,5
+      expect( @io.string ).to  end_with ": test [3] 4 [5]\n"
+    end
+
+    it 'warn' do
+      @log.level = Deployable::Logger::WARN
+      @log.warn_pair 'test', 4,5,6
+      expect( @io.string ).to  end_with ": test [4] 5 [6]\n"
+    end
+
+    it 'error' do
+      @log.level = Deployable::Logger::ERROR
+      @log.error_pair 'test', 5,6,7
+      expect( @io.string ).to  end_with ": test [5] 6 [7]\n"
+    end
+    
+    it 'fatal' do
+      @log.level = Deployable::Logger::FATAL
+      @log.fatal_pair 'test', 6,7,8
+      expect( @io.string ).to  end_with ": test [6] 7 [8]\n"
+    end
+
+  end
+
+
+end

data/spec/deployable/module_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe 'Deployable::Log module include' do
+
+  describe 'simple' do
+
+    before :all do
+
+      class TestThis
+        # logger for instance of this class and the class instance itself
+        include Deployable::Log
+      end
+
+      @io  = StringIO.new
+      @log = Deployable::Log.log
+      Deployable::Log.replace_log @io
+    end
+
+    it 'has a class logger' do
+      expect( TestThis.log ).to  be_a Deployable::Logger 
+    end
+
+    it 'has an instance logger' do
+      expect( TestThis.new.log ).to  be_a Deployable::Logger 
+    end
+
+    it 'class logger goes into instance logger' do
+      TestThis.new.log.info 'something'
+      TestThis.log.info 'otherthing'
+      expect( @io.string ).to  match( /.+?: something\n.+?: otherthing\n/m  )
+    end
+
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'deployable/log'
+require 'pry-byebug'

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: deployable-log
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- deployable
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Log singleton
+email:
+- matt@deployable.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- changelog.md
+- deployable-log.gemspec
+- lib/deployable/log.rb
+- lib/deployable/log/version.rb
+- spec/deployable/log_spec.rb
+- spec/deployable/logger_spec.rb
+- spec/deployable/module_spec.rb
+- spec/spec_helper.rb
+homepage: http://deployable.co
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Log singleton
+test_files:
+- spec/deployable/log_spec.rb
+- spec/deployable/logger_spec.rb
+- spec/deployable/module_spec.rb
+- spec/spec_helper.rb