empezar 0.0.2 → 0.1.0

data/.gitignore

@@ -17,3 +17,4 @@ test/version_tmp
 tmp
 log/*
 config/*
+sample/log/*

data/README.md

@@ -8,9 +8,33 @@ A simple Ruby library to enforce a convention for configuration, logging and exe
 
 ## Usage
 
+To start, you must create a `config` directory containing at least a `main.yaml` file with at least one configuration. Currently Empezar supports the `verbosity` flag, which can be setted to `silent` and the application's log will not be echoed in command line (otherwise it will be):
+
+```yaml
+#config/main.yaml
+verbosity: normal # `silent` will silence stdout
+```
+
+Then create a ruby script anywhere in the folder and run it
+
 ```ruby
+# script.rb
 require 'empezar'
 
 Runner.run        # Maps config/main.yaml to Configuration as SymbolMatrix
                   # Gets ready Log as a logger in log/main.log
-```
+
+Log.info "This will be logged and written in the shell"
+
+Configuration.each do |key, value|
+  Log.debug "#{key}: #{value}"
+end
+```
+
+...and then 
+
+    ruby script.rb
+
+You can find this sample in the `sample` folder in this repo.
+
+This is really short, so here, [have a picture of a monkey](http://i.dailymail.co.uk/i/pix/2011/07/04/article-2011051-0CDC0F0900000578-739_634x894.jpg) . Enjoy

data/empezar.gemspec

@@ -13,6 +13,7 @@ Gem::Specification.new do |gem|
   gem.homepage      = "http://github.com/Fetcher/empezar"
 
   gem.add_dependency 'symbolmatrix'
+  gem.add_dependency 'term-ansicolor'
 
   gem.add_development_dependency 'rspec'
 

data/lib/empezar.rb

@@ -1,9 +1,11 @@
 require 'singleton'
 require 'symbolmatrix'
+require 'term/ansicolor'
 require 'logger'
 
 require 'empezar/version'
 require 'empezar/exceptions'
 require 'empezar/configuration'
 require 'empezar/runner'
+require 'empezar/echoing_formatter'
 require 'empezar/log'

data/lib/empezar/configuration.rb

@@ -6,8 +6,8 @@ end
 
 class Configuration
   class << self
-    def method_missing *args
-      Empezar::Configuration.instance.send *args
+    def method_missing *args, &block
+      Empezar::Configuration.instance.send *args, &block
     end
   end
 end

data/lib/empezar/echoing_formatter.rb

@@ -0,0 +1,28 @@
+module Empezar
+  class EchoingFormatter
+    attr_accessor :wrapee
+
+    def initialize wrapee
+      @wrapee = wrapee
+    end
+
+    def call severity, datetime, progname, message
+      case severity
+        when Logger::Severity::FATAL, "FATAL"
+          $stdout.puts Term::ANSIColor.bold Term::ANSIColor.red message
+        when Logger::Severity::ERROR, "ERROR"
+          $stdout.puts Term::ANSIColor.red message
+        when Logger::Severity::WARN, "WARN"
+          $stdout.puts Term::ANSIColor.yellow message
+        when Logger::Severity::INFO, "INFO"
+          $stdout.puts Term::ANSIColor.blue message
+        when Logger::Severity::DEBUG, "DEBUG"
+          $stdout.puts Term::ANSIColor.dark message
+        when Logger::Severity::UNKNOWN, "UNKNOWN"
+          $stdout.puts message
+      end
+
+      wrapee.call severity, datetime, progname, message
+    end
+  end
+end

data/lib/empezar/log.rb

@@ -3,11 +3,11 @@ module Empezar
     include Singleton
 
     def self.instance
-      @logger
+      @@logger
     end
 
     def self.start logger
-      @logger = logger
+      @@logger = logger
     end
   end
 end

data/lib/empezar/runner.rb

@@ -1,8 +1,8 @@
 module Empezar
   class Runner
     def self.run argument = 'config/main.yaml'
-      self.start_logger
       self.start_configuration argument
+      self.start_logger
     end
 
     def self.start_configuration argument
@@ -15,6 +15,10 @@ module Empezar
     def self.start_logger
       Dir.mkdir 'log' unless Dir.exist? 'log'
       Empezar::Log.start Logger.new 'log/main.log', 'daily'
+      if Empezar::Configuration.instance.has_key? :verbosity and Empezar::Configuration.instance.verbosity == 'silent'
+      else
+        Empezar::Log.instance.formatter = EchoingFormatter.new Logger::Formatter.new
+      end
     end
   end
 end

data/lib/empezar/version.rb

@@ -1,3 +1,3 @@
 module Empezar
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/sample/config/main.yaml

@@ -0,0 +1,2 @@
+#config/main.yaml
+verbosity: normal # `silent` will silence stdout

data/sample/script.rb

@@ -0,0 +1,11 @@
+# script.rb
+require 'empezar'
+
+Runner.run        # Maps config/main.yaml to Configuration as SymbolMatrix
+                  # Gets ready Log as a logger in log/main.log
+
+Log.info "This will be logged and written in the shell"
+
+Configuration.each do |key, value|
+  Log.debug "#{key}: #{value}"
+end

data/spec/empezar/echoing_formatter_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+describe Empezar::EchoingFormatter do
+  before do 
+    @formatter_stub = stub 'formatter'
+  end
+
+  describe '#initialize' do 
+    it 'should receive a Formatter as an argument and store it as the wrapee' do
+      my_formatter = Empezar::EchoingFormatter.new @formatter_stub
+      my_formatter.wrapee.should == @formatter_stub
+    end
+  end
+
+  describe '#call' do 
+    context 'fatal error' do 
+      it 'should puts to stdout with a bold red message' do 
+        @formatter_stub.stub :call
+        $stdout.should_receive(:puts).with Term::ANSIColor.bold Term::ANSIColor.red "message"
+
+        formatter = Empezar::EchoingFormatter.new @formatter_stub
+        formatter.call "FATAL", nil, nil, "message"
+      end
+    end
+
+    context 'error' do 
+      it 'should puts to stdout with a red message' do 
+        @formatter_stub.stub :call
+        $stdout.should_receive(:puts).with Term::ANSIColor.red "message"
+
+        formatter = Empezar::EchoingFormatter.new @formatter_stub
+        formatter.call "ERROR", nil, nil, "message"
+      end
+    end
+
+    context 'warn' do
+      it 'should puts to stdout with a yellow message' do 
+        @formatter_stub.stub :call
+        $stdout.should_receive(:puts).with Term::ANSIColor.yellow "message"
+
+        formatter = Empezar::EchoingFormatter.new @formatter_stub
+        formatter.call "WARN", nil, nil, "message"
+      end
+    end
+
+    context 'info' do 
+      it 'should puts to stdout with a blue message' do 
+        @formatter_stub.stub :call
+        $stdout.should_receive(:puts).with Term::ANSIColor.blue "message"
+
+        formatter = Empezar::EchoingFormatter.new @formatter_stub
+        formatter.call "INFO", nil, nil, "message"
+      end
+    end
+
+    context 'unknown' do 
+      it 'should puts to stdout with the message' do 
+        @formatter_stub.stub :call
+        $stdout.should_receive(:puts).with "message"
+
+        formatter = Empezar::EchoingFormatter.new @formatter_stub
+        formatter.call "UNKNOWN", nil, nil, "message"
+      end
+    end
+
+    context 'debug' do 
+      it 'should puts to stdout with a dark message' do 
+        @formatter_stub.stub :call
+        $stdout.should_receive(:puts).with Term::ANSIColor.dark "message"
+
+        formatter = Empezar::EchoingFormatter.new @formatter_stub
+        formatter.call "DEBUG", nil, nil, "message"
+      end
+    end
+
+    it 'should call the #call of the wrapee with all the arguments' do 
+      arg1 = stub; arg2 = stub; arg3 = stub; arg4 = stub
+      @formatter_stub.should_receive(:call).with arg1, arg2, arg3, arg4
+
+      formatter = Empezar::EchoingFormatter.new @formatter_stub
+      formatter.call arg1, arg2, arg3, arg4
+    end
+  end
+end

data/spec/empezar/runner_spec.rb

@@ -26,23 +26,51 @@ describe Empezar::Runner do
   end
 
   describe '.start_logger' do 
-    it 'should initialize the log as logger pointing to log/main.log, daily' do 
-      Dir.should_receive(:exist?).with('log').and_return true
-      demo_logger = stub 'logger'
-      Logger.should_receive(:new).with('log/main.log', 'daily').and_return demo_logger
-      Empezar::Log.should_receive(:start).with demo_logger
+    before do 
+      @demo_logger = stub 'demo logger'
+      Logger.should_receive(:new).with('log/main.log', 'daily').and_return @demo_logger
+    end
+
+    context 'normal conditions of pressure and temperature' do 
+      it 'should initialize the log as logger pointing to log/main.log, daily with the EchoingFormatter' do 
+        formatter = stub 'formatter'
+        echoing_formatter = stub 'echoing formatter'
+
+        Dir.should_receive(:exist?).with('log').and_return true
+        Empezar::Configuration.instance.should_receive(:has_key?).with(:verbosity).and_return false
+
+        Logger::Formatter.should_receive(:new).and_return formatter
+        Empezar::EchoingFormatter.should_receive(:new).with(formatter).and_return echoing_formatter
+        @demo_logger.should_receive(:formatter=).with echoing_formatter
 
-      Empezar::Runner.start_logger
+        Empezar::Log.should_receive(:start).with @demo_logger
+        Empezar::Log.should_receive(:instance).and_return @demo_logger
+
+        Empezar::Runner.start_logger
+      end
+    end
+
+    context 'the verbosity level is set to silent' do 
+      it 'should not set the formatter as an echoing formatter' do 
+        Empezar::EchoingFormatter.should_not_receive :new
+
+        Empezar::Configuration.instance.should_receive(:has_key?).with(:verbosity).and_return true
+        Empezar::Configuration.instance.should_receive(:verbosity).and_return 'silent'
+
+        Empezar::Log.should_receive(:start).with @demo_logger
+
+        Empezar::Runner.start_logger        
+      end
     end
 
     context 'the dir log does not exist' do
       it 'should create the dir log' do 
+        Empezar::Configuration.instance.should_receive(:has_key?).with(:verbosity).and_return true
+        Empezar::Configuration.instance.should_receive(:verbosity).and_return 'silent'
         Dir.should_receive(:exist?).with('log').and_return false
         Dir.should_receive(:mkdir).with('log')
 
-        demo_logger = stub 'logger'
-        Logger.should_receive(:new).with('log/main.log', 'daily').and_return demo_logger
-        Empezar::Log.should_receive(:start).with demo_logger
+        Empezar::Log.should_receive(:start).with @demo_logger
 
         Empezar::Runner.start_logger
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: empezar
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-30 00:00:00.000000000 Z
+date: 2012-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: symbolmatrix
@@ -27,6 +27,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: term-ansicolor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -59,12 +75,16 @@ files:
 - empezar.gemspec
 - lib/empezar.rb
 - lib/empezar/configuration.rb
+- lib/empezar/echoing_formatter.rb
 - lib/empezar/exceptions.rb
 - lib/empezar/log.rb
 - lib/empezar/runner.rb
 - lib/empezar/version.rb
+- sample/config/main.yaml
+- sample/script.rb
 - spec/configuration_spec.rb
 - spec/empezar/configuration_spec.rb
+- spec/empezar/echoing_formatter_spec.rb
 - spec/empezar/log_spec.rb
 - spec/empezar/runner_spec.rb
 - spec/log_spec.rb
@@ -98,6 +118,7 @@ summary: A simple Ruby library to enforce a convention for configuration, loggin
 test_files:
 - spec/configuration_spec.rb
 - spec/empezar/configuration_spec.rb
+- spec/empezar/echoing_formatter_spec.rb
 - spec/empezar/log_spec.rb
 - spec/empezar/runner_spec.rb
 - spec/log_spec.rb