yell 0.3.3 → 0.4.0

data/.gitignore

@@ -5,3 +5,7 @@ pkg/*
 
 # bundler
 Gemfile.lock
+
+# vim
+*.swp
+**/*.swp

data/lib/yell/adapters.rb

@@ -1,10 +1,5 @@
 # encoding: utf-8
 
-require 'yell/adapters/base'
-require 'yell/adapters/io'
-require 'yell/adapters/file'
-require 'yell/adapters/datefile'
-
 module Yell #:nodoc:
 
   # NoSuchAdapter is raised whenever you want to instantiate an 
@@ -15,44 +10,46 @@ module Yell #:nodoc:
   # the logger. You should not have to call the corresponding classes
   # directly.
   module Adapters
+    @@adapters = {}
 
     class << self
+
+      # Register your own adapter here
+      #
+      # @example
+      #   Yell::Adapters.register( :myadapter, MyAdapter )
+      def register( name, klass )
+        @@adapters[name] = klass
+      end
+
       # Returns an instance of the given processor type.
       #
       # @example A simple file adapter
       #   Yell::Adapters.new( :file )
-      def new( type, options = {}, &block )
-        # return type if type.instance_of?(Yell::Adapters::)
-
-        if type.instance_of?( ::IO )
-          # should apply to STDOUT, STDERR, File, etc
-          Yell::Adapters::Io.new( type, options, &block )
-        else
-          # any other type
-          adapter = case type
-            when String, Symbol then self.const_get( camelize(type.to_s) )
-            else type
-          end
-
-          adapter.new( options, &block )
-        end
-      end
+      def new( name, options = {}, &block )
+        return name if name.is_a?( Yell::Adapters::Base )
 
+        adapter = case name
+          when STDOUT then @@adapters[:stdout]
+          when STDERR then @@adapters[:stderr]
+          else @@adapters[name]
+        end
 
-      private
+        raise NoSuchAdapter.new( name ) unless adapter
 
-      # Simple camelcase converter.
-      #
-      # @example
-      #   camelize("file")
-      #   #=> "File"
-      #
-      #   camelize("date_file")
-      #   #=> "DateFile"
-      def camelize( str )
-        str.capitalize.gsub( /(_\w)/ ) { |match| match.reverse.chop.upcase }
+        adapter.new( options, &block )
       end
+
     end
 
   end
 end
+
+require 'yell/adapters/base'
+
+# IO based adapters
+require 'yell/adapters/io'
+require 'yell/adapters/streams'
+require 'yell/adapters/file'
+require 'yell/adapters/datefile'
+

data/lib/yell/adapters/base.rb

@@ -6,9 +6,15 @@ module Yell #:nodoc:
     # This class provides the basic interface for all allowed 
     # operations on any adapter implementation.
     #
-    # Other adapters should include it for the base methods used 
+    # Other adapters should inherit from it for the methods used 
     # by the {Yell::Logger}.
-    module Base
+    class Base
+
+      def initialize( options = {}, &block )
+        level options[:level]
+
+        instance_eval( &block ) if block
+      end
 
       # The main method for calling the adapter.
       #
@@ -36,6 +42,7 @@ module Yell #:nodoc:
         @level = Yell::Level.new( severity )
       end
 
+
       private
 
       # The perform the actual write.
@@ -49,9 +56,9 @@ module Yell #:nodoc:
       # Determine whether to write at the given severity.
       #
       # @example
-      #   write? :error
+      #   write? Yell::Event.new( 'INFO', 'Hwllo Wold!' )
       #
-      # @param [String,Symbol,Integer] severity The severity to ask if to write or not.
+      # @param [Yell::Event] event The log event
       #
       # @return [Boolean] true or false
       def write?( event )

data/lib/yell/adapters/datefile.rb

@@ -18,7 +18,7 @@ module Yell #:nodoc:
 
         @date = nil # default; do not override --R
 
-        super( options, &block )
+        super
       end
 
       # @overload Reset the file handle
@@ -61,5 +61,7 @@ module Yell #:nodoc:
 
     end
 
+    register( :datefile, Yell::Adapters::Datefile )
+
   end
 end

data/lib/yell/adapters/file.rb

@@ -8,7 +8,7 @@ module Yell #:nodoc:
     class File < Yell::Adapters::Io
 
       def initialize( options = {}, &block )
-        super( nil, options, &block )
+        super
 
         @filename = options.fetch(:filename, default_filename)
       end
@@ -27,6 +27,8 @@ module Yell #:nodoc:
 
     end
 
+    register( :file, Yell::Adapters::File )
+
   end
 end
 

data/lib/yell/adapters/io.rb

@@ -1,8 +1,7 @@
 module Yell
   module Adapters
 
-    class Io
-      include Yell::Adapters::Base
+    class Io < Yell::Adapters::Base
 
       # The possible unix log colors
       Colors = {
@@ -15,19 +14,27 @@ module Yell
         'DEFAULT' => "\e[0m"      # NONE
       }
 
-      # Accessor to the io stream
-      attr_reader :stream
 
+      def initialize( options = {}, &block )
+        format options[:format]
+        colorize options.fetch(:colorize, false)
 
-      def initialize( stream, options = {}, &block )
-        @stream   = stream
-        @options  = options
+        super
+      end
 
-        level options.fetch(:level, nil)
-        format options.fetch(:format, nil)
-        colorize options.fetch(:colorize, false)
+      # The IO stream
+      #
+      # Adapter classes should provide their own implementation 
+      # of this method.
+      def stream
+        raise 'Not implemented'
+      end
+
+      # Close the io stream
+      def close
+        @stream.close if @stream.respond_to? :close
 
-        instance_eval( &block ) if block
+        @stream = nil
       end
 
       # Set the format for your message.
@@ -44,11 +51,6 @@ module Yell
         @colorize = color
       end
 
-      def close
-        @stream.close if @stream.respond_to? :close
-
-        @stream = nil
-      end
 
       private
 

data/lib/yell/adapters/streams.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+module Yell #:nodoc:
+  module Adapters #:nodoc:
+
+    class Stdout < Yell::Adapters::Io
+
+      # @overload Lazily open the STDOUT stream
+      def stream
+        @stream ||= $stdout.clone
+      end
+    end
+
+    class Stderr < Yell::Adapters::Io
+
+      # @overload Lazily open the STDERR stream
+      def stream
+        @stream ||= $stderr.clone
+      end
+    end
+
+    register( :stdout, Yell::Adapters::Stdout )
+    register( :stderr, Yell::Adapters::Stderr )
+
+  end
+end
+

data/lib/yell/event.rb

@@ -1,7 +1,7 @@
 module Yell #:nodoc:
 
   class Event
-    CallerRegexp = /^(.+?):(\d+)(?::in `(.*)')?/
+    CallerRegexp = /^(.+?):(\d+)(?::in `(.+)')?/
 
     # Accessor to the log level
     attr_reader :level

data/lib/yell/level.rb

@@ -47,7 +47,7 @@ module Yell #:nodoc:
       @severities = Yell::Severities.map { true } # all levels allowed by default
 
       case severity
-        when Array then severity.each { |s| at(s) }
+        when Array then at( *severity )
         when Range then gte(severity.first).lte(severity.last)
         when Integer, String, Symbol then gte(severity)
       end
@@ -64,8 +64,8 @@ module Yell #:nodoc:
       index.nil? ? false : @severities[index]
     end
 
-    def at( severity ) #:nodoc:
-      calculate! :==, severity
+    def at( *severities ) #:nodoc:
+      severities.each { |severity| calculate! :==, severity }
       self
     end
 

data/lib/yell/logger.rb

@@ -82,8 +82,6 @@ module Yell #:nodoc:
       end
 
       @adapters << Yell::Adapters.new( type, options, &block )
-    rescue NameError
-      raise Yell::NoSuchAdapter, type
     end
 
     # Set the minimum log level.

data/lib/yell/version.rb

@@ -1,4 +1,4 @@
 module Yell #:nodoc:
-  VERSION = "0.3.3"
+  VERSION = "0.4.0"
 
 end

data/spec/yell/level_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper'
+
+describe Yell::Level do
+
+  context "default" do
+    let( :level ) { Yell::Level.new }
+
+    it { level.at?(:debug).should be_true }
+    it { level.at?(:info).should be_true }
+    it { level.at?(:warn).should be_true }
+    it { level.at?(:error).should be_true }
+    it { level.at?(:fatal).should be_true }
+  end
+
+  context "given a Symbol" do
+    let( :level ) { Yell::Level.new(subject) }
+
+    context :debug do
+      subject { :debug }
+
+      it { level.at?(:debug).should be_true }
+      it { level.at?(:info).should be_true }
+      it { level.at?(:warn).should be_true }
+      it { level.at?(:error).should be_true }
+      it { level.at?(:fatal).should be_true }
+    end
+
+    context :info do
+      subject { :info }
+
+      it { level.at?(:debug).should be_false }
+      it { level.at?(:info).should be_true }
+      it { level.at?(:warn).should be_true }
+      it { level.at?(:error).should be_true }
+      it { level.at?(:fatal).should be_true }
+    end
+
+    context :warn do
+      subject { :warn }
+
+      it { level.at?(:debug).should be_false }
+      it { level.at?(:info).should be_false }
+      it { level.at?(:warn).should be_true }
+      it { level.at?(:error).should be_true }
+      it { level.at?(:fatal).should be_true }
+    end
+
+    context :error do
+      subject { :error }
+
+      it { level.at?(:debug).should be_false }
+      it { level.at?(:info).should be_false }
+      it { level.at?(:warn).should be_false }
+      it { level.at?(:error).should be_true }
+      it { level.at?(:fatal).should be_true }
+    end
+
+    context :fatal do
+      subject { :fatal }
+
+      it { level.at?(:debug).should be_false }
+      it { level.at?(:info).should be_false }
+      it { level.at?(:warn).should be_false }
+      it { level.at?(:error).should be_false }
+      it { level.at?(:fatal).should be_true }
+    end
+  end
+
+  context "given an Array" do
+    let( :level ) { Yell::Level.new(subject) }
+
+    subject { [:debug, :warn, :fatal] }
+
+    it { level.at?(:debug).should be_true }
+    it { level.at?(:info).should be_false }
+    it { level.at?(:warn).should be_true }
+    it { level.at?(:error).should be_false }
+    it { level.at?(:fatal).should be_true }
+  end
+
+  context "given a Range" do
+    let( :level ) { Yell::Level.new(subject) }
+
+    subject { (1..3) }
+
+    it { level.at?(:debug).should be_false }
+    it { level.at?(:info).should be_true }
+    it { level.at?(:warn).should be_true }
+    it { level.at?(:error).should be_true }
+    it { level.at?(:fatal).should be_false }
+  end
+
+end

metadata

@@ -1,34 +1,28 @@
 --- !ruby/object:Gem::Specification 
 name: yell
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 3
-  - 3
-  version: 0.3.3
+  prerelease: 
+  version: 0.4.0
 platform: ruby
 authors: 
-- Rudolf Schmidt
+  - Rudolf Schmidt
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2012-03-24 00:00:00 +01:00
-default_executable: 
+date: 2012-03-27 00:00:00 Z
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rr
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id001
+  - !ruby/object:Gem::Dependency 
+    name: rr
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: "0"
+    type: :development
+    version_requirements: *id001
 description: An easy to use logging library to log into files and any other self-defined adapters
 email: 
 executables: []
@@ -38,38 +32,38 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- .gitignore
-- .travis.yml
-- Gemfile
-- LICENSE.txt
-- README.md
-- Rakefile
-- examples/001-basic-usage.rb
-- examples/002.1-log-level-basics.rb
-- examples/002.2-log-level-on-certain-severities-only.rb
-- examples/002.3-log-level-within-range.rb
-- examples/003.1-formatting-DefaultFormat.rb
-- examples/003.2-formatting-BasicFormat.rb
-- examples/003.3-formatting-ExtendedFormat.rb
-- examples/003.4-formatting-on-your-own.rb
-- lib/yell.rb
-- lib/yell/adapters.rb
-- lib/yell/adapters/.file.rb.swp
-- lib/yell/adapters/base.rb
-- lib/yell/adapters/datefile.rb
-- lib/yell/adapters/file.rb
-- lib/yell/adapters/io.rb
-- lib/yell/event.rb
-- lib/yell/formatter.rb
-- lib/yell/level.rb
-- lib/yell/logger.rb
-- lib/yell/version.rb
-- spec/spec_helper.rb
-- spec/yell/event_spec.rb
-- spec/yell/formatter_spec.rb
-- spec/yell_spec.rb
-- yell.gemspec
-has_rdoc: true
+  - .gitignore
+  - .travis.yml
+  - Gemfile
+  - LICENSE.txt
+  - README.md
+  - Rakefile
+  - examples/001-basic-usage.rb
+  - examples/002.1-log-level-basics.rb
+  - examples/002.2-log-level-on-certain-severities-only.rb
+  - examples/002.3-log-level-within-range.rb
+  - examples/003.1-formatting-DefaultFormat.rb
+  - examples/003.2-formatting-BasicFormat.rb
+  - examples/003.3-formatting-ExtendedFormat.rb
+  - examples/003.4-formatting-on-your-own.rb
+  - lib/yell.rb
+  - lib/yell/adapters.rb
+  - lib/yell/adapters/base.rb
+  - lib/yell/adapters/datefile.rb
+  - lib/yell/adapters/file.rb
+  - lib/yell/adapters/io.rb
+  - lib/yell/adapters/streams.rb
+  - lib/yell/event.rb
+  - lib/yell/formatter.rb
+  - lib/yell/level.rb
+  - lib/yell/logger.rb
+  - lib/yell/version.rb
+  - spec/spec_helper.rb
+  - spec/yell/event_spec.rb
+  - spec/yell/formatter_spec.rb
+  - spec/yell/level_spec.rb
+  - spec/yell_spec.rb
+  - yell.gemspec
 homepage: http://rubygems.org/gems/yell
 licenses: []
 
@@ -77,30 +71,26 @@ post_install_message:
 rdoc_options: []
 
 require_paths: 
-- lib
+  - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
 requirements: []
 
 rubyforge_project: yell
-rubygems_version: 1.3.6
+rubygems_version: 1.8.9
 signing_key: 
 specification_version: 3
 summary: Yell - Your Extensible Logging Library
-test_files: 
-- spec/spec_helper.rb
-- spec/yell/event_spec.rb
-- spec/yell/formatter_spec.rb
-- spec/yell_spec.rb
+test_files: []
+
+has_rdoc: