logsly 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
----
-SHA1:
-  metadata.gz: 2dfa76f82b146db11ebe7e52e8ac9bb51f0fc9c8
-  data.tar.gz: 9dbc80bdfe08dce4f6acacf50f29aca0b90965ea
-SHA512:
-  metadata.gz: 1629d93cc3f4b0f8979ac796ef219ccf05aecc85750829029f20c1f5c48d8dd05117b65e27112ca7509530152dbec2a01ad04b068b127e7a41ce513667bb16c8
-  data.tar.gz: 0abc0262c174e4e12a31c8a81f659888379ce5ec9538bbbbffab0c2d4efd1b0b414c3b27befa7a15a7be6c9dbdfbb02075bff6d4cdeac44858511c22272d2518
+--- 
+SHA1: 
+  metadata.gz: 873d513fcda4a6f898be9fbea3fe557f36e25174
+  data.tar.gz: ed137cb5edb8b14102f43cdbc60bcfef30968007
+SHA512: 
+  metadata.gz: 30f4de19dc9c57407713ab504f727fe309e83632e52f46b548aa1b39bfcf4b5cff8def086a8e7599d5818b04f4377756022c8a9641df6b9ae4f86a3675c8624a
+  data.tar.gz: fb1fae8744f5e4652bf8252a08e50fe15f403e5e437686c2d5e836b06e67d03cff52ccd366cb59491a46c758b1c94651a8556042d3159ed19916b4ca627ff05d

data/Gemfile

@@ -2,5 +2,4 @@ source "https://rubygems.org"
 
 gemspec
 
-gem 'rake', "~> 10.4.0"
 gem 'pry', "~> 0.9.0"

data/lib/logsly/colors.rb

@@ -1,6 +1,3 @@
-require 'ostruct'
-require 'ns-options'
-
 # This class provides a DSL for setting color scheme values and lazy eval's
 # the DSL to generate a Logging color scheme object.
 # See https://github.com/TwP/logging/blob/master/lib/logging/color_scheme.rb
@@ -8,6 +5,10 @@ require 'ns-options'
 
 module Logsly
 
+  class NullColors
+    def to_scheme(*args); nil;  end
+  end
+
   class Colors
 
     attr_reader :name, :build
@@ -24,51 +25,135 @@ module Logsly
 
   end
 
-  class NullColors < OpenStruct
-    def to_scheme(*args); nil;  end
-  end
-
   class ColorsData
-    include NsOptions::Proxy
-
-    # color for the level text only
-    option :debug
-    option :info
-    option :warn
-    option :error
-    option :fatal
-
-    # color for the entire log message based on the value of the log level
-    option :debug_line
-    option :info_line
-    option :warn_line
-    option :error_line
-    option :fatal_line
-
-    option :logger      # [%c] name of the logger that generate the log event
-    option :date        # [%d] datestamp
-    option :message     # [%m] the user supplied log message
-    option :pid         # [%p] PID of the current process
-    option :time        # [%r] the time in milliseconds since the program started
-    option :thread      # [%T] the name of the thread Thread.current[:name]
-    option :thread_id   # [%t] object_id of the thread
-    option :file        # [%F] filename where the logging request was issued
-    option :line        # [%L] line number where the logging request was issued
-    option :method_name # [%M] method name where the logging request was issued
 
     def initialize(*args, &build)
       self.instance_exec(*args, &build)
 
-      @properties     = properties.map{|p| self.send(p)}
+      @properties     = properties.map{ |p| self.send(p) }
       @method         = self.method_name
-      @level_settings = levels.map{|l| self.send(l)}
-      @line_settings  = levels.map{|l| self.send("#{l}_line")}
+      @level_settings = levels.map{ |l| self.send(l) }
+      @line_settings  = levels.map{ |l| self.send("#{l}_line") }
 
       if has_level_settings? && has_line_settings?
         raise ArgumentError, "can't set line and level settings in the same scheme"
       end
     end
 
+    # color for the level text only
+
+    def debug(value = nil)
+      @debug = value if !value.nil?
+      @debug
+    end
+
+    def info(value = nil)
+      @info = value if !value.nil?
+      @info
+    end
+
+    def warn(value = nil)
+      @warn = value if !value.nil?
+      @warn
+    end
+
+    def error(value = nil)
+      @error = value if !value.nil?
+      @error
+    end
+
+    def fatal(value = nil)
+      @fatal = value if !value.nil?
+      @fatal
+    end
+
+    # color for the entire log message based on the value of the log level
+
+    def debug_line(value = nil)
+      @debug_line = value if !value.nil?
+      @debug_line
+    end
+
+    def info_line(value = nil)
+      @info_line = value if !value.nil?
+      @info_line
+    end
+
+    def warn_line(value = nil)
+      @warn_line = value if !value.nil?
+      @warn_line
+    end
+
+    def error_line(value = nil)
+      @error_line = value if !value.nil?
+      @error_line
+    end
+
+    def fatal_line(value = nil)
+      @fatal_line = value if !value.nil?
+      @fatal_line
+    end
+
+    # [%c] name of the logger that generate the log event
+    def logger(value = nil)
+      @logger = value if !value.nil?
+      @logger
+    end
+
+    # [%d] datestamp
+    def date(value = nil)
+      @date = value if !value.nil?
+      @date
+    end
+
+    # [%m] the user supplied log message
+    def message(value = nil)
+      @message = value if !value.nil?
+      @message
+    end
+
+    # [%p] PID of the current process
+    def pid(value = nil)
+      @pid = value if !value.nil?
+      @pid
+    end
+
+    # [%r] the time in milliseconds since the program started
+    def time(value = nil)
+      @time = value if !value.nil?
+      @time
+    end
+
+    # [%T] the name of the thread Thread.current[:name]
+    def thread(value = nil)
+      @thread = value if !value.nil?
+      @thread
+    end
+
+    # [%t] object_id of the thread
+    def thread_id(value = nil)
+      @thread_id = value if !value.nil?
+      @thread_id
+    end
+
+    # [%F] filename where the logging request was issued
+    def file(value = nil)
+      @file = value if !value.nil?
+      @file
+    end
+
+    # [%L] line number where the logging request was issued
+    def line(value = nil)
+      @line = value if !value.nil?
+      @line
+    end
+
+    # [%M] method name where the logging request was issued
+    def method_name(value = nil)
+      @method_name = value if !value.nil?
+      @method_name
+    end
+
     def to_scheme_opts
       Hash.new.tap do |opts|
         # set general properties

data/lib/logsly/outputs.rb

@@ -0,0 +1,151 @@
+require 'logging'
+require 'syslog'
+
+module Logsly; end
+module Logsly::Outputs
+
+  ## NULL
+
+  class Null
+    def to_appender(*args); nil; end
+    def to_layout(*args);   nil; end
+  end
+
+  ## BASE
+
+  class Base
+
+    attr_reader :build
+
+    def initialize(&build)
+      @build = build || Proc.new{}
+    end
+
+    def to_appender(*args)
+      self.instance_exec(*args, &@build)
+      self.colors_obj.run_build(*args)
+      self
+    end
+
+    def to_layout(data)
+      Logging.layouts.pattern(data.to_pattern_opts)
+    end
+
+    def to_appender(*args)
+      raise NotImplementedError
+    end
+
+  end
+
+  class BaseData
+
+    def initialize(*args, &build)
+      @pattern = '%m\n'
+      @colors  = nil
+
+      @args = args
+      self.instance_exec(*@args, &(build || Proc.new{}))
+    end
+
+    def pattern(value = nil)
+      @pattern = value if !value.nil?
+      @pattern
+    end
+
+    def colors(value = nil)
+      @colors = value if !value.nil?
+      @colors
+    end
+
+    def to_pattern_opts
+      Hash.new.tap do |opts|
+        opts[:pattern] = self.pattern if self.pattern
+
+        if scheme_name = colors_obj.to_scheme(*@args)
+          opts[:color_scheme] = scheme_name
+        end
+      end
+    end
+
+    private
+
+    def colors_obj
+      Logsly.colors(self.colors)
+    end
+
+  end
+
+  ## STDOUT
+
+  class Stdout < Base
+
+    def to_appender(*args)
+      data = BaseData.new(*args, &self.build)
+      Logging.appenders.stdout(:layout => self.to_layout(data))
+    end
+
+  end
+
+  ## FILE
+
+  class File < Base
+
+    def to_appender(*args)
+      data = FileData.new(*args, &self.build)
+      Logging.appenders.file(data.path, :layout => self.to_layout(data))
+    end
+
+  end
+
+  class FileData < BaseData
+
+    def path(value = nil)
+      @path = value if !value.nil?
+      @path
+    end
+
+  end
+
+  ## SYSLOG
+
+  class Syslog < Base
+
+    def to_appender(*args)
+      ::Syslog.close if ::Syslog.opened?
+
+      data = SyslogData.new(*args, &self.build)
+      Logging.appenders.syslog(data.identity, {
+        :logopt   => data.log_opts,
+        :facility => data.facility,
+        :layout   => self.to_layout(data)
+      })
+    end
+
+  end
+
+  class SyslogData < BaseData
+
+    def initialize(*args, &build)
+      super
+      @log_opts = (::Syslog::LOG_PID | ::Syslog::LOG_CONS)
+      @facility = ::Syslog::LOG_LOCAL0
+    end
+
+    def identity(value = nil)
+      @identity = value if !value.nil?
+      @identity
+    end
+
+    def log_opts(value = nil)
+      @log_opts = value if !value.nil?
+      @log_opts
+    end
+
+    def facility(value = nil)
+      @facility = value if !value.nil?
+      @facility
+    end
+
+  end
+
+end

data/lib/logsly/version.rb

@@ -1,3 +1,3 @@
 module Logsly
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/lib/logsly.rb

@@ -1,63 +1,57 @@
-require 'ns-options'
+require 'much-plugin'
 require 'logging'
 require 'logsly/version'
 require 'logsly/colors'
-require 'logsly/base_output'
+require 'logsly/outputs'
 
 module Logsly
+  include MuchPlugin
 
-  def self.included(receiver)
-    receiver.class_eval do
-      attr_reader :log_type, :level, :outputs, :logger
-      include LoggerMethods
-    end
-  end
-
-  module Settings
-    include NsOptions::Proxy
+  plugin_included do
+    include InstanceMethods
 
-    option :colors,  ::Hash, :default => ::Hash.new(NullColors.new)
-    option :outputs, ::Hash, :default => ::Hash.new(NullOutput.new)
   end
 
   def self.reset
-    Settings.reset
+    @settings = nil
     Logging.reset
   end
 
+  def self.settings
+    @settings ||= Settings.new
+  end
+
   def self.colors(name, &block)
-    require 'logsly/colors'
-    Settings.colors[name.to_s] = Colors.new(name, &block) if !block.nil?
-    Settings.colors[name.to_s]
+    settings.colors[name.to_s] = Colors.new(name, &block) if !block.nil?
+    settings.colors[name.to_s]
   end
 
   def self.stdout(name, &block)
-    require 'logsly/stdout_output'
-    Settings.outputs[name.to_s] = StdoutOutput.new(&block)
+    settings.outputs[name.to_s] = Outputs::Stdout.new(&block)
   end
 
   def self.file(name, &block)
-    require 'logsly/file_output'
-    Settings.outputs[name.to_s] = FileOutput.new(&block)
+    settings.outputs[name.to_s] = Outputs::File.new(&block)
   end
 
   def self.syslog(name, &block)
-    require 'logsly/syslog_output'
-    Settings.outputs[name.to_s] = SyslogOutput.new(&block)
+    settings.outputs[name.to_s] = Outputs::Syslog.new(&block)
   end
 
   def self.outputs(name)
-    Settings.outputs[name.to_s]
+    settings.outputs[name.to_s]
   end
 
-  module LoggerMethods
+  module InstanceMethods
 
-    def initialize(log_type, opts_hash=nil)
-      opts = NsOptions::Struct.new(opts_hash) do
-        option :level,   String, :default => 'info'
-        option :outputs, Array,  :default => []
-      end
-      @log_type, @level, @outputs = log_type.to_s, opts.level, opts.outputs
+    attr_reader :log_type, :level, :outputs, :logger
+
+    def initialize(log_type, opts = nil)
+      opts ||= {}
+
+      @log_type = log_type.to_s
+      @level    = (opts[:level]  || opts['level']   || 'info').to_s
+      @outputs  = opts[:outputs] || opts['outputs'] || []
 
       unique_name   = "#{self.class.name}-#{@log_type}-#{self.object_id}"
       @logger       = Logging.logger[unique_name]
@@ -119,4 +113,13 @@ module Logsly
 
   end
 
+  class Settings
+    attr_reader :colors, :outputs
+
+    def initialize
+      @colors  = ::Hash.new(NullColors.new)
+      @outputs = ::Hash.new(Outputs::Null.new)
+    end
+  end
+
 end

data/logsly.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |gem|
   gem.version     = Logsly::VERSION
   gem.authors     = ["Kelly Redding", "Collin Redding"]
   gem.email       = ["kelly@kellyredding.com", "collin.redding@me.com"]
-  gem.description = %q{Create custom loggers.}
   gem.summary     = %q{Create custom loggers.}
+  gem.description = %q{Create custom loggers.}
   gem.homepage    = "http://github.com/redding/logsly"
   gem.license     = 'MIT'
 
@@ -18,9 +18,9 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_development_dependency("assert", ["~> 2.15"])
+  gem.add_development_dependency("assert", ["~> 2.16.1"])
 
-  gem.add_dependency("ns-options",  ["~> 1.1"])
+  gem.add_dependency("much-plugin", ["~> 0.2.0"])
   gem.add_dependency("logging",     ["~> 1.7"])
 
 end

data/test/unit/colors_tests.rb

@@ -22,7 +22,7 @@ class Logsly::Colors
     end
 
     should "know its build" do
-      build_proc = Proc.new {}
+      build_proc = Proc.new{}
       out = Logsly::Colors.new 'test', &build_proc
 
       assert_same build_proc, out.build
@@ -90,21 +90,21 @@ class Logsly::Colors
         method_name :white
         info        :blue
       end
-      expected = {
+      exp = {
         :date    => :blue,
         :message => :cyan,
         :method  => :white,
         :levels  => {:info  => :blue},
       }
 
-      assert_equal expected, general_only.to_scheme_opts
+      assert_equal exp, general_only.to_scheme_opts
     end
 
     should "only include :levels and :lines if at least one is set" do
       no_levels_lines = Logsly::ColorsData.new { date :blue }
-      expected = { :date => :blue }
+      exp = { :date => :blue }
 
-      assert_equal expected, no_levels_lines.to_scheme_opts
+      assert_equal exp, no_levels_lines.to_scheme_opts
     end
 
   end

data/test/unit/logsly_tests.rb

@@ -2,6 +2,8 @@ require 'assert'
 require 'logsly'
 
 require 'logging'
+require 'logsly/colors'
+require 'logsly/outputs'
 require 'test/support/logger'
 
 module Logsly
@@ -20,7 +22,7 @@ module Logsly
     end
 
     should "return a NullOutput obj when requesting an output that isn't defined" do
-      assert_kind_of NullOutput, Logsly.outputs('not_defined_yet')
+      assert_kind_of Outputs::Null, Logsly.outputs('not_defined_yet')
     end
 
     should "add a named color scheme using the `colors` method" do
@@ -31,27 +33,27 @@ module Logsly
     end
 
     should "add a named stdout output using the `stdout` method" do
-      assert_kind_of NullOutput, Logsly.outputs('test_stdout')
+      assert_kind_of Outputs::Null, Logsly.outputs('test_stdout')
       Logsly.stdout('test_stdout') {}
 
       assert_not_nil Logsly.outputs('test_stdout')
-      assert_kind_of StdoutOutput, Logsly.outputs('test_stdout')
+      assert_kind_of Outputs::Stdout, Logsly.outputs('test_stdout')
     end
 
     should "add a named file output using the `file` method" do
-      assert_kind_of NullOutput, Logsly.outputs('test_file')
+      assert_kind_of Outputs::Null, Logsly.outputs('test_file')
       Logsly.file('test_file') {}
 
       assert_not_nil Logsly.outputs('test_file')
-      assert_kind_of FileOutput, Logsly.outputs('test_file')
+      assert_kind_of Outputs::File, Logsly.outputs('test_file')
     end
 
     should "add a named syslog output using the `syslog` method" do
-      assert_kind_of NullOutput, Logsly.outputs('test_syslog')
+      assert_kind_of Outputs::Null, Logsly.outputs('test_syslog')
       Logsly.syslog('test_syslog') {}
 
       assert_not_nil Logsly.outputs('test_syslog')
-      assert_kind_of SyslogOutput, Logsly.outputs('test_syslog')
+      assert_kind_of Outputs::Syslog, Logsly.outputs('test_syslog')
     end
 
     should "convert non-string setting names to string" do
@@ -71,10 +73,10 @@ module Logsly
 
     should "overwrite same-named outputs settings" do
       Logsly.stdout('something') {}
-      assert_kind_of StdoutOutput, Logsly.outputs('something')
+      assert_kind_of Outputs::Stdout, Logsly.outputs('something')
 
       Logsly.file('something') {}
-      assert_kind_of FileOutput, Logsly.outputs('something')
+      assert_kind_of Outputs::File, Logsly.outputs('something')
     end
 
   end
@@ -86,14 +88,14 @@ module Logsly
       Logsly.stdout('test_stdout') {}
     end
 
-    should "reset the Settings" do
-      assert_kind_of Colors,       Logsly.colors('test_colors')
-      assert_kind_of StdoutOutput, Logsly.outputs('test_stdout')
+    should "reset the settings" do
+      assert_kind_of Colors,          Logsly.colors('test_colors')
+      assert_kind_of Outputs::Stdout, Logsly.outputs('test_stdout')
 
       Logsly.reset
 
-      assert_kind_of NullColors, Logsly.colors('test_colors')
-      assert_kind_of NullOutput, Logsly.outputs('test_stdout')
+      assert_kind_of NullColors,    Logsly.colors('test_colors')
+      assert_kind_of Outputs::Null, Logsly.outputs('test_stdout')
     end
 
   end
@@ -129,8 +131,8 @@ module Logsly
     end
 
     should "create the Logging::Logger with a unique name" do
-      expected = "#{subject.class.name}-testy_log_logger-#{subject.object_id}"
-      assert_equal expected, subject.logger.name
+      exp = "#{subject.class.name}-testy_log_logger-#{subject.object_id}"
+      assert_equal exp, subject.logger.name
     end
 
     should "set the logger's level" do