filum 1.0.3 → 2.0.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NDM1NGQzMzc1YzgzN2RhNWEyMjkwYmM3MGRkOTAyM2E1OWExNmQzMQ==
-  data.tar.gz: !binary |-
-    MmIyNzE3ZTg4MmNjZmI4ODliYmQwZGViYWRkZjUzMDlkM2U4OTk5OQ==
+SHA1:
+  metadata.gz: 426959005772065dfb25532dc64f4e9a947ac84b
+  data.tar.gz: 54089585bc896384ad9125ac370073433e842f5e
 SHA512:
-  metadata.gz: !binary |-
-    YjUyYWY5NjM1ZGQzMjg3MzBkZTNiODI0N2MyODZhOWMzMGY1OTFkY2E1ZWU5
-    OGRiZTg4NTMwOGZmMTdhNWUwMGJlZGZjZGI5ZjE4Nzk0YTQ0M2U2ODYzOWFk
-    ODJhNjIxZDFlMDM0YTI3NTIyY2E5NzQyYjhkMTc2OWZmZDQ1Njc=
-  data.tar.gz: !binary |-
-    ZmQzNTlkZGE0OWY3OGZlMjMzN2ZhY2FhMmU2MzMzZmUyZGJmZjRjZmI1NTY5
-    ZjZhZTE1MjQ1NDA3YTFkYzI2NTU0YzQ1NDA2NTY3Y2RlZDAxMGRlYjRhYjNi
-    OTZlOTdjZTJhMGYxZjhkY2UwNzI2YWI4NWY4OTEzNjI4ZmFlNjE=
+  metadata.gz: ba784e9ac29471e59f74186630f125042abb96a85d6bba4af164bc5953f5fec245ccf084fd3b39d8ce9ba9074f811dd22d153761c019507ca737b24b4760d7d1
+  data.tar.gz: e79a649b039a704ed1fc6cb7884c089c750a1d5908754d6544bfed40cb724744b8b36ffe820b552b4a78b1599a56cbc4c2f33ce79c59f34120669ae7fa334242

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+log/

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+2.0.0 / 2014-02-22
+[FEATURE] Remove config and add Filum.setup
+
 1.0.3 / 2013-12-17
 [FEATURE] Tidy up formatting to have positional padding 
 

data/lib/filum.rb

@@ -1,29 +1,20 @@
 require "filum/version"
 require "filum/filum_error"
-require "filum/configuration"
 require "filum/log_formatter"
 require "filum/logger"
 
 module Filum
 
-  # Filum configuration settings.
+  # Filum setup method
   #
-  # Settings should be set in an initializer or using some
-  # other method that insures they are set before any
-  # Filum code is used. They can be set as followed:
+  # This must be called before Filum.logger is used.
   #
-  #   Filum.config.logfile = "/var/log/mylogfile.log"
+  # Options can be
+  # * <tt>:config.context_id_length</tt> Defaults to 6
+  # * <tt>:filename_length</tt> Defaults to 20
   #
-  # The following settings are allowed:
-  #
-  # * <tt>:logfile</tt> - The logfile
-  def self.config
-    @config ||= Configuration.new
-    if block_given?
-      yield @config
-    else
-      @config
-    end
+  def self.setup(logfile, options = {})
+    @logger = Filum::Logger.new(logfile, options)
   end
 
   # Filum logger.
@@ -33,15 +24,7 @@ module Filum
   #   Filum.logger.info "Log this"
   #
   def self.logger
-    logfile = Filum.config.logfile
-    dir = File.dirname(logfile)
-    unless File.directory?(dir)
-      FileUtils.mkdir_p(dir)
-    end
-
-    @logger ||= Filum::Logger.new(logfile, shift_age='daily')
-    @logger.level = Logger::INFO
+    raise FilumError.new("Filum is not setup. Please call Filum#setup") unless @logger
     @logger
   end
-
 end

data/lib/filum/log_formatter.rb

@@ -2,13 +2,18 @@ require 'logger'
 
 module Filum
   class LogFormatter < Logger::Formatter
+    def initialize(options = {})
+      @context_id_length = options.fetch(:context_id_length, 6)
+      @filename_length = options.fetch(:filename_length, 20)
+    end
+
     def call(severity, timestamp, progname, msg)
       "#{timestamp} #{formatted_thread_id} [#{formatted_context_id}] #{severity.to_s.ljust(5)} | #{formatted_calling_file_and_line} | #{msg}\n"
     end
 
     private
     def formatted_context_id
-      context_id.ljust(Filum.config.context_id_length)
+      context_id.ljust(@context_id_length)
     end
 
     def context_id
@@ -16,14 +21,14 @@ module Filum
     end
 
     def formatted_calling_file_and_line
-      filename_length = Filum.config.filename_length
+      filename_length = @filename_length
       truncated_filename_length = filename_length - 3
 
       _, file, line = calling_code.match(/([\w\.]+)\:(\d+)\:in /).to_a
-      file = "#{file[0,truncated_filename_length]}..." if file.length >= filename_length 
+      file = "#{file[0,truncated_filename_length]}..." if file.length >= filename_length
       "#{file}:#{line.ljust(3)}".ljust(filename_length + 4)
     end
-    
+
     def formatted_thread_id
       "t-#{thread_id}".ljust(12)
     end

data/lib/filum/logger.rb

@@ -3,13 +3,26 @@ require 'logger'
 module Filum
   class Logger < ::Logger
 
-    def initialize(*args)
-      super
-      self.formatter = Filum::LogFormatter.new
+    attr_reader :logfile
+    def initialize(logfile, options = {})
+      @logfile = logfile
+      create_log_directory
+
+      super(logfile, shift_age='daily')
+      self.formatter = Filum::LogFormatter.new(options)
+      self.level = Logger::INFO
     end
 
     def context_id=(context_id)
       Thread.current[:context_id] = context_id
     end
+
+    private
+    def create_log_directory
+      dir = File.dirname(@logfile)
+      unless File.directory?(dir)
+        FileUtils.mkdir_p(dir)
+      end
+    end
   end
 end

data/lib/filum/version.rb

@@ -1,3 +1,3 @@
 module Filum
-  VERSION = "1.0.3"
+  VERSION = "2.0.0"
 end

data/test/integration/integration_test.rb

@@ -5,10 +5,7 @@ module Filum
   class IntegrationTest < Minitest::Test
     def setup
       super
-
-      Filum.config do |config|
-        config.logfile = "/tmp/log/filum_test_#{Time.now.to_i}.log"
-      end
+      Filum.setup("/tmp/log/filum_test_#{Time.now.to_i}.log")
     end
   end
-end
+end

data/test/integration/logger_test.rb

@@ -38,7 +38,7 @@ module Filum
       Filum.logger.info "Foobar #{random_string}"
       assert_logged(/Foobar #{random_string}$/)
     end
-    
+
     def test_caller_line_is_correct
       expected_file = 'logger_test.rb'
       expected_line = __LINE__+1
@@ -48,7 +48,7 @@ module Filum
 
     private
     def assert_logged(regex)
-      assert File.readlines(Filum.config.logfile).grep(regex).size == 1
+      assert File.readlines(Filum.logger.logfile).grep(regex).size == 1
     end
   end
 end

data/test/test_helper.rb

@@ -12,6 +12,6 @@ require "filum"
 class Minitest::Test
   def setup
     super
-    Filum.instance_variable_set(:@config, nil)
+    Filum.instance_variable_set(:@logger, nil)
   end
 end

data/test/unit/filum_test.rb

@@ -0,0 +1,24 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+module Filum
+  class FilumTest < Minitest::Test
+    def test_setup_proxies_correctly
+      logfile = "foobar"
+      options = {foo: 'bar'}
+      Filum::Logger.expects(:new).with(logfile, options)
+      Filum.setup(logfile, options)
+    end
+
+    def test_logger_returns_logger
+      logfile = "./log/test.log"
+      logger = Filum.setup(logfile)
+      assert_equal logger, Filum.logger
+    end
+
+    def test_call_to_loquor_without_setup_raises
+      assert_raises(FilumError) do
+        Filum.logger
+      end
+    end
+  end
+end

data/test/unit/log_formatter_test.rb

@@ -1,9 +1,9 @@
 require File.expand_path('../../test_helper', __FILE__)
 
 module Filum
-  
+
   class LogFormatterTest < Minitest::Test
-    
+
     def test_string_format_contains_correct_when_padding_stripped_out
       formatter = Filum::LogFormatter.new
       severity = "SEV123"
@@ -19,7 +19,7 @@ module Filum
       desired = "#{timestamp} t-#{object_id} [#{context_id}] #{severity} | #{file_and_line} | #{msg}\n"
       assert_equal desired, output.gsub(/[ ]+/, ' ')
     end
-    
+
     def test_severity_should_pad_to_5_chars
       formatter = Filum::LogFormatter.new
       severity = "SEV"
@@ -29,17 +29,17 @@ module Filum
       actual_severity_field = output.match(/SEV\s+\|/)[0]
       assert_equal "SEV   |", actual_severity_field
     end
-    
+
     def test_can_format_with_nil_severity
       formatter = Filum::LogFormatter.new
       formatter.call(nil, "timestamp", nil, "msg")
     end
-    
+
     def test_can_format_with_nil_timestamp
       formatter = Filum::LogFormatter.new
       formatter.call("SEV", nil, nil, "msg")
     end
-    
+
     def test_can_format_with_nil_msg
       formatter = Filum::LogFormatter.new
       formatter.call("SEV", "timestamp", nil, nil)
@@ -52,10 +52,9 @@ module Filum
     end
 
     def test_formatted_context_id_uses_config
-      Filum.config.context_id_length = 20
       context_id = "12345"
       Thread.current[:context_id] = context_id
-      formatter = Filum::LogFormatter.new
+      formatter = Filum::LogFormatter.new(context_id_length: 20)
       output = formatter.send(:formatted_context_id)
       assert_equal "#{context_id}               ", output
     end
@@ -91,10 +90,9 @@ module Filum
     end
 
     def test_formatted_calling_file_and_line_uses_config
-      Filum.config.filename_length = 40
       filename = "abcdefghij"
       line = "/Users/iHiD/Projects/meducation/filum/lib/filum/#{filename}:30:in `formatted_calling_file_and_line'"
-      formatter = Filum::LogFormatter.new
+      formatter = Filum::LogFormatter.new(filename_length: 40)
       formatter.stubs(calling_code: line)
       output = formatter.send(:formatted_calling_file_and_line)
       assert_equal "#{filename}:30 #{" " * 30}", output
@@ -117,26 +115,26 @@ module Filum
       output = formatter.send(:formatted_calling_file_and_line)
       assert_equal "foobar.txt:30           ", output
     end
-    
+
     def test_call_calls_formatted_thread_id
       formatter = Filum::LogFormatter.new
       formatter.expects(:formatted_thread_id)
       formatter.call("", "", "", "")
     end
-    
+
     def test_formatted_thread_id_should_pad
       formatter = Filum::LogFormatter.new
       formatter.stubs(thread_id: "0123456")
       output = formatter.send(:formatted_thread_id)
       assert_equal "t-0123456   ", output
     end
-    
+
     def test_formatted_thread_id_should_overflow_not_trim
       formatter = Filum::LogFormatter.new
       formatter.stubs(thread_id: "01234567890")
       output = formatter.send(:formatted_thread_id)
       assert_equal "t-01234567890", output
     end
-    
+
   end
-end
+end

data/test/unit/logger_test.rb

@@ -0,0 +1,22 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+module Filum
+  class FilumTest < Minitest::Test
+    def test_initializer_stores_logfile
+      logfile = "./log/test.log"
+      logger = Filum::Logger.new(logfile)
+      assert_equal logfile, logger.logfile
+    end
+
+    def test_initializer_proxies_to_formatter_correctly
+      options = {foo: 'bar'}
+      Filum::LogFormatter.expects(:new).with(options)
+      Filum::Logger.new("./log/test.log", options)
+    end
+
+    def test_initializer_sets_level
+      logger = Filum::Logger.new("./log/test.log")
+      assert_equal Logger::INFO, logger.level
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: filum
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 2.0.0
 platform: ruby
 authors:
 - MalcyL
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-17 00:00:00.000000000 Z
+date: 2014-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,42 +28,42 @@ dependencies:
   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: mocha
   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: yard
   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
@@ -95,7 +95,6 @@ files:
 - Rakefile
 - filum.gemspec
 - lib/filum.rb
-- lib/filum/configuration.rb
 - lib/filum/filum_error.rb
 - lib/filum/log_formatter.rb
 - lib/filum/logger.rb
@@ -103,8 +102,9 @@ files:
 - test/integration/integration_test.rb
 - test/integration/logger_test.rb
 - test/test_helper.rb
-- test/unit/configuration_test.rb
+- test/unit/filum_test.rb
 - test/unit/log_formatter_test.rb
+- test/unit/logger_test.rb
 homepage: ''
 licenses:
 - AGPL3
@@ -115,12 +115,12 @@ 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: []
@@ -133,6 +133,7 @@ test_files:
 - test/integration/integration_test.rb
 - test/integration/logger_test.rb
 - test/test_helper.rb
-- test/unit/configuration_test.rb
+- test/unit/filum_test.rb
 - test/unit/log_formatter_test.rb
+- test/unit/logger_test.rb
 has_rdoc: 

data/lib/filum/configuration.rb

@@ -1,18 +0,0 @@
-module Filum
-
-  class FilumConfigurationError < FilumError
-  end
-
-  class Configuration
-
-    SETTINGS = [ :logfile, :context_id_length, :filename_length ]
-    attr_accessor *SETTINGS
-
-    def initialize
-      self.context_id_length = 6
-      self.filename_length   = 20
-    end
-
-  end
-end
-

data/test/unit/configuration_test.rb

@@ -1,29 +0,0 @@
-require File.expand_path('../../test_helper', __FILE__)
-
-module Filum
-  class ConfigurationTest < Minitest::Test
-
-    def setup
-      Filum.instance_variable_set("@config", nil)
-    end
-
-    def test_obtaining_singletion
-      refute Filum.config.nil?
-    end
-
-    def test_block_syntax
-      test_logfile = "/tmp/filum.log"
-      Filum.config do |config|
-        config.logfile = test_logfile
-      end
-      assert_equal test_logfile, Filum.config.logfile
-    end
-
-    def test_logfile
-      test_logfile = "/tmp/filum.log"
-      Filum.config.logfile = test_logfile
-      assert_equal test_logfile, Filum.config.logfile
-    end
-  end
-end
-