llt-logger 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3c9908c0e92ba93d7fa933e76a41c689a48e0c10
+  data.tar.gz: a9f72b6adc27954be79f791e3541a2265df28e80
+SHA512:
+  metadata.gz: 46757399ff8d8940accf81899d045b3b9f21e93cd46c96817dbd6f535d2673ced898af316f85eb6c8678eb98ec55f3124e648558424a756cc36409758e5598d3
+  data.tar.gz: 8311bfb5dccf5bd9089a9bf3f15b81712f144e6cb9e93b230853ec58761539747d80ed7dbeff96512607de4b747043f5c81aea1d8dab0b25193432df4e0f68a4

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--tty

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in llt-logger.gemspec
+gemspec
+gem 'coveralls', require: false

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 LFDM
+
+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,29 @@
+# LLT::Logger
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'llt-logger'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install llt-logger
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/llt/logger.rb

@@ -0,0 +1,172 @@
+require "llt/logger/version"
+require "colorize"
+
+module LLT
+  class Logger
+    LEVELS = %w{ error info parser cf morph debug }
+    # Numeric vals  0    1    2     3   4     5
+    DEFAULT_LEVEL = 1
+
+    @level = ENV["LLT_DEBUG"] ? normalized_level(ENV["LLT_DEBUG"]) : DEFAULT_LEVEL
+    @loggers = []
+
+    class << self
+      attr_reader :loggers
+
+      def level=(lev)
+        return @level = nil if lev.nil?
+
+        l = normalized_level(lev)
+        unless valid_level?(l)
+          l = @level || DEFAULT_LEVEL # DEFAULT_LEVEL catches invalid levels defined through the env var
+          puts "LOG LEVEL ERROR".red + " #{lev} is unknown - falling back to #{l}"
+        end
+
+        @level = l
+      end
+
+      def level(n = nil)
+        return nil if @level.nil?
+        n ? n <= @level : @level
+      end
+
+      def new(*args)
+        new_logger = super
+        @loggers << new_logger
+        new_logger
+      end
+
+      def clear
+        @loggers.clear
+      end
+
+      def count(mapper = :count)
+        @loggers.map(&mapper).inject(:+)
+      end
+
+      def errors
+        messages.select { |message| message =~ /ERROR!/ }
+      end
+
+      def warnings
+        messages.select { |message| message =~ /WARNING!/ }
+      end
+
+      def messages_that_match(regexp)
+        messages.select { |message| message =~ regexp }
+      end
+
+      def count_errors
+        count(:errors)
+      end
+
+      def count_warnings
+        count(:warnings)
+      end
+
+      def normalized_level(lev)
+        if lev.is_a? Fixnum
+          lev
+        else
+          LEVELS.index(lev.to_s) || -1 # -1 to fail the valid_level? test
+        end
+      end
+
+      private
+
+      def messages
+        @loggers.flat_map(&:logs)
+      end
+
+      def valid_level?(lev)
+        lev.between?(0, 5)
+      end
+    end
+
+    attr_reader :title, :logs, :errors, :warnings
+
+    def initialize(title = "", indent = "", default: :info)
+      @title  = title
+      @indent = to_whitespace(indent)
+      @default = default
+      @logs   = []
+      @errors   = 0
+      @warnings = 0
+    end
+
+    def log(*args)
+      send(@default, *args)
+      # TODO Exception Handling
+    end
+
+    def error(message, indent = "")
+      message = "ERROR! #{message}".light_red
+      if level(0)
+        log_message(message, indent)
+        @errors += 1
+      end
+    end
+
+    def warning(message, indent = "")
+      message = "WARNING! #{message}".yellow
+      if level(1)
+        log_message(message, indent)
+        @warnings += 1
+      end
+    end
+
+    def info(message, indent = "")
+      log_message(message, indent) if level(1)
+    end
+
+    def parser(message, indent = "")
+      log_message(message, indent) if level(2)
+    end
+
+    def cf(message, indent = "")
+      log_message(message, indent) if level(3)
+    end
+
+    def morph(message, indent = "")
+      log_message(message, indent) if level(4)
+    end
+
+    def debug(message, indent = "")
+      log_message(message, indent) if level(5)
+    end
+
+    def bare(message, indent = 0)
+      lev = Logger.normalized_level(@default)
+      puts "#{to_whitespace(indent)}#{message}" if level(lev)
+    end
+
+    def count
+      @logs.count
+    end
+
+    private
+
+    def log_message(message, indent)
+      t = (! @title.empty? ? "#{@title}: " : "")
+      indentation = @indent + to_whitespace(indent)
+      str = "#{indentation}#{t}#{message}"
+
+      @logs << str
+      puts str
+    end
+
+    def level(lev = nil)
+      Logger.level(lev)
+    end
+
+    def to_whitespace(indent)
+      if indent.is_a?(Fixnum)
+        str = ""
+        indent.times { str << " "}
+        str
+      else
+        indent
+      end
+    end
+  end
+end

data/lib/llt/logger/version.rb

@@ -0,0 +1,5 @@
+module LLT
+  class Logger
+    VERSION = "0.0.1"
+  end
+end

data/llt-logger.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'llt/logger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "llt-logger"
+  spec.version       = LLT::Logger::VERSION
+  spec.authors       = ["LFDM"]
+  spec.email         = ["1986gh@gmail.com"]
+  spec.description   = %q{LLT Logger}
+  spec.summary       = %q{LLT Logger}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov", "~> 0.7"
+  spec.add_dependency "colorize"
+end

data/spec/lib/llt/logger_spec.rb

@@ -0,0 +1,286 @@
+require 'spec_helper'
+require 'stringio'
+
+describe LLT::Logger do
+  before :all do
+    string_io = StringIO.new
+    @stdout = $stdout
+    $stdout = string_io
+  end
+
+  it 'should have a version number' do
+    LLT::Logger::VERSION.should_not be_nil
+  end
+
+  let(:logger) { LLT::Logger }
+  describe ".level" do
+    context "with no argument" do
+      it "returns the current logger level" do
+        logger.level.should_not be_nil
+      end
+
+      it "default level is info" do
+        logger.level.should == 1
+      end
+    end
+
+    context "with an argument" do
+      it "returns true if inside of current logger level" do
+        logger.level(1).should be_true
+      end
+
+      it "returns false if outside of current logger level" do
+        logger.level = 2 # morph_debug
+        logger.level(5).should be_false
+      end
+    end
+
+    # don't know how to test that
+    #it "can be set through env var LLT_DEBUG" do
+    #  ENV["LLT_DEBUG"] = "info"
+    #  logger.level.should == "info"
+    #end
+  end
+
+  describe ".level=" do
+    it "sets the logger level" do
+      logger.level = "info"
+      logger.level.should == 1 # info
+    end
+
+    it "needs to be set to a valid level, otherwise an error message is printed and the current level still in use" do
+      old_level = logger.level
+
+      $stdout.should receive(:puts)
+      logger.level = "blabla"
+
+      logger.level.should == old_level
+    end
+
+    it "can be set to nil - Logger will be shut down then" do
+      logger.level = nil
+      a = logger.new
+
+      $stdout.should_not receive(:puts)
+      a.error("")
+      a.debug("")
+
+      logger.level = :info # set back for other tests
+    end
+  end
+
+  describe ".loggers" do
+    it "returns an array of loggers" do
+      logger.loggers.should be_an_instance_of Array
+    end
+  end
+
+  describe ".new" do
+    it "registers the newly created logger in Logger.loggers" do
+      new_logger = logger.new
+      logger.loggers.should include new_logger
+    end
+
+    it "and returns a new logger instance" do
+      logger.new.should be_an_instance_of LLT::Logger
+    end
+  end
+
+  describe ".clear" do
+    it "clears all registered loggers" do
+      5.times { logger.new }
+      logger.loggers.should have_at_least(5).items
+      logger.clear
+      logger.loggers.should be_empty
+    end
+  end
+
+  describe ".count" do
+    it "counts all log messages" do
+      logger.clear
+
+      a = logger.new
+      b = logger.new
+      5.times { a.log("") }
+      5.times { b.error("") }
+
+      logger.count.should == 10
+    end
+  end
+
+  describe ".count_errors" do
+    it "counts all errors present" do
+      logger.clear
+
+      a = logger.new
+      b = logger.new
+      5.times { a.error("") }
+      5.times { b.error("") }
+
+      logger.count_errors.should == 10
+    end
+  end
+
+  describe ".count_warnings" do
+    it "counts all warnings present" do
+      logger.clear
+
+      a = logger.new
+      b = logger.new
+      5.times { a.warning("") }
+      5.times { b.warning("") }
+
+      logger.count_warnings.should == 10
+    end
+  end
+
+  describe ".errors" do
+    it "returns all logged error messages" do
+      logger.clear
+
+      a = logger.new
+      b = logger.new
+      5.times { a.error("") }
+      3.times { b.warning("") }
+
+      logger.errors.should have(5).items
+    end
+  end
+
+  describe ".message_that_match" do
+    it "returns all messages that match a given Regexp" do
+      logger.clear
+
+      a = logger.new
+      b = logger.new
+      5.times { a.log("arma") }
+      3.times { b.log("multa") }
+
+      logger.messages_that_match(/arma/).should have(5).items
+    end
+  end
+
+  describe ".warnings" do
+    it "returns all logged warnings" do
+      logger.clear
+      a = logger.new
+      b = logger.new
+
+      5.times { a.error("") }
+      3.times { b.warning("") }
+
+      logger.warnings.should have(3).items
+    end
+  end
+
+  describe "#initialize" do
+    it "takes title and indentation as arguments" do
+      title = "a"
+      nl = logger.new(title, "  ")
+      nl.title.should == title
+      nl.instance_variable_get("@indent").should == "  "
+    end
+
+    it "takes :default as keyword argument" do
+      nl = logger.new(default: "parser")
+      nl.instance_variable_get("@default").should == "parser"
+    end
+
+    it "default defaults to :info" do
+      a = logger.new
+      a.instance_variable_get("@default").should == :info
+    end
+
+    it "defaults '' and 0" do
+      nl = logger.new
+      nl.title.should == ""
+      nl.instance_variable_get("@indent").should == ""
+    end
+
+    it "indentantion can be set with a Fixnum, converted to n whitespaces" do
+      nl = logger.new("title", 3)
+      nl.instance_variable_get("@indent").should == "   "
+    end
+  end
+
+  describe "#log" do
+    it "delegates to the set default" do
+      a = logger.new(default: "cf")
+      b = logger.new(default: "morph")
+
+      a.should receive(:cf)
+      b.should_not receive(:cf)
+
+      a.log("") and b.log("")
+    end
+
+    it "all log calls take a message and an optional indent level that adds up to the default indentation" do
+      a = logger.new("", 2)
+      $stdout.should receive(:puts).with("    message")
+      a.log("message", 2)
+    end
+
+    it "title is automatically added if present" do
+      a = logger.new("Logger", 2)
+      $stdout.should receive(:puts).with("  Logger: message")
+      a.log("message")
+    end
+  end
+
+  describe "#bare" do
+    it "logs without title, without default intendation level and doesn't store the message" do
+      a = logger.new("Title", 28)
+      $stdout.should receive(:puts).with(" message")
+      a.bare("message", 1)
+      a.logs.should be_empty
+    end
+
+    it "default level matters and decides if anything happens at all" do
+      logger.level = 3 # cf
+      a = logger.new(default: :debug)
+      b = logger.new(default: :info)
+
+      $stdout.should receive(:puts).exactly(:once)
+
+      a.bare("")
+      b.bare("")
+    end
+  end
+
+  describe "#logs" do
+    it "logs are stored" do
+      a = logger.new
+      a.log("message")
+      a.logs.should include "message"
+    end
+  end
+
+  describe "#count" do
+    it "counts number of logs" do
+      a = logger.new
+      5.times { a.log("") }
+      a.count.should == 5
+    end
+  end
+
+  describe "#errors" do
+    it "counts the number of errors" do
+      a = logger.new
+      a.error("")
+      a.errors.should == 1
+    end
+  end
+
+  describe "#warnings" do
+    it "counts the number of warnings" do
+      a = logger.new
+      a.warning("")
+      a.warning("")
+      a.warnings.should == 2
+    end
+  end
+
+  after :all do
+    $stdout = @stdout
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'simplecov'
+require 'coveralls'
+
+Coveralls.wear!
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'llt/logger'

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: llt-logger
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- LFDM
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  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: LLT Logger
+email:
+- 1986gh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/llt/logger.rb
+- lib/llt/logger/version.rb
+- llt-logger.gemspec
+- spec/lib/llt/logger_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.1.5
+signing_key: 
+specification_version: 4
+summary: LLT Logger
+test_files:
+- spec/lib/llt/logger_spec.rb
+- spec/spec_helper.rb