vidazing_logger 0.1.0 → 0.2.0

data/lib/vidazing_logger/appenders/stderr.rb

@@ -1,59 +1,21 @@
-require 'logging'
-
-# Determines how to log messages. Attaches to Logging.logger
-# @api private
-module VidazingLogger::Appenders
-  # Appender writing to STDERR and 'logs/error.log'
-  # @api private
-  module Stderr
-    class << self
-      private
-
-      # ----- BUILD STDERR + LOG -----
-
-      # Logging holds the color scheme reference
-      ERROR_LOG_COLOR_SCHEME = "bright_error"
-      Logging.color_scheme(
-        ERROR_LOG_COLOR_SCHEME,
-        :levels => {
-          :info  => :green,
-          :warn  => :yellow,
-          :error => :red,
-          :fatal => [:white, :on_red]
-        },
-        :date => :red,
-        :logger => :cyan,
-        :message => :magenta
-      )
-
-      def readable_error_layout_pattern
-        Logging.layouts.pattern \
-          :pattern      => '[%d] %-5l %c: %m\n',
-          # ISO8601 without the 'T'
-          :date_pattern => '%Y-%m-%d %H:%M:%S',
-          :color_scheme => ERROR_LOG_COLOR_SCHEME
-      end
-
-      APPENDER_STDERR = "STDERR"
-      def stderr_appender
-        Logging.appenders.stderr \
-          APPENDER_STDERR,
-          :layout => readable_error_layout_pattern,
-          :level  => :error
-      end
-
-      def error_log_appender(log_dir)
-        error_log_path = "#{log_dir}/error.log"
-
-        appender_error_log = error_log_path
-        Logging.appenders.rolling_file \
-          appender_error_log,
-          :layout => readable_error_layout_pattern,
-          :age    => 'daily',
-          :keep   => 7,
-          :level  => :error
-
-        Logging.appenders[appender_error_log]
+# frozen_string_literal: true
+
+require 'vidazing_logger/appender'
+require 'vidazing_logger/color_scheme'
+require 'vidazing_logger/filters/levels'
+
+module VidazingLogger
+  module Appenders
+    # Appender writing to STDERR
+    #
+    # @api private
+    # @since 0.1.0
+    class Stderr < Appender
+      def initialize
+        super \
+          name: self.class.name,
+          color_scheme: ColorScheme.error,
+          filter_levels: Filters::Levels.error
       end
     end
   end

data/lib/vidazing_logger/appenders/stdout.rb

@@ -1,66 +1,21 @@
-require 'logging'
-
-module VidazingLogger::Appenders
-  # Appender writing to STDOUT and 'logs/build.log'
-  # @api private
-  module Stdout
-    class << self
-      private
-
-      #----- BUILD STDOUT + LOG -----
-
-      # Logging holds the color scheme reference
-      LOG_COLOR_SCHEME = "bright"
-      Logging.color_scheme(
-        LOG_COLOR_SCHEME,
-        :levels => {
-          :info  => :green,
-          :warn  => :yellow,
-          :error => :red,
-          :fatal => [:white, :on_red]
-        },
-        :date => :blue,
-        :logger => :cyan,
-        :message => :magenta
-      )
-
-      def readable_layout_pattern
-        Logging.layouts.pattern \
-          :pattern      => '[%d] %-5l %c: %m\n',
-          # ISO8601 without the 'T'
-          :date_pattern => '%Y-%m-%d %H:%M:%S',
-          :color_scheme => LOG_COLOR_SCHEME
-      end
-
-      def stdout_levels
-        Logging::Filters::Level.new \
-          :debug,
-          :info,
-          :warn
-      end
-
-      APPENDER_STDOUT = "STDOUT"
-      def stdout_appender
-        Logging.appenders.stdout \
-          APPENDER_STDOUT,
-          :layout   => readable_layout_pattern,
-          :filters  => stdout_levels
-
-        Logging.appenders[APPENDER_STDOUT]
-      end
-
-      def build_log_appender(log_dir)
-        build_log_path = "#{log_dir}/build.log"
-
-        appender_build_log = build_log_path
-        Logging.appenders.rolling_file \
-          appender_build_log,
-          :layout => readable_layout_pattern,
-          :age    => 'daily',
-          :keep   => 7,
-          :filters  => stdout_levels
-
-        Logging.appenders[appender_build_log]
+# frozen_string_literal: true
+
+require 'vidazing_logger/appender'
+require 'vidazing_logger/color_scheme'
+require 'vidazing_logger/filters/levels'
+
+module VidazingLogger
+  module Appenders
+    # Appender writing to STDOUT
+    #
+    # @api private
+    # @since 0.1.0
+    class Stdout < Appender
+      def initialize
+        super \
+          name: self.class.name,
+          color_scheme: ColorScheme.normal,
+          filter_levels: Filters::Levels.normal
       end
     end
   end

data/lib/vidazing_logger/color_scheme.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module VidazingLogger
+  # Set logging colors
+  #
+  # @api private
+  # @since 0.2.0
+  class ColorScheme
+    attr_reader :name, :scheme
+
+    def initialize(name:, date_color:)
+      @name = name
+
+      @scheme = ColorScheme.basic.dup
+      @scheme[:date] = date_color
+    end
+
+    class << self
+      def normal
+        ColorScheme.new(name: :normal, date_color: :blue)
+      end
+
+      def error
+        ColorScheme.new(name: :error, date_color: :red)
+      end
+
+      def basic
+        {
+          levels: {
+            info: :green,
+            warn: :yellow,
+            error: :red,
+            fatal: %i[white on_red]
+          },
+          logger: :cyan,
+          message: :magenta
+        }
+      end
+    end
+  end
+end

data/lib/vidazing_logger/filters/levels.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'logging'
+
+module VidazingLogger
+  # Filter logs by level severity
+  #
+  # @api private
+  # @since 0.2.0
+  module Filters
+    # Filter log messages strictly by Levels. Levels...
+    #
+    # @see Levels::ALL
+    # @api private
+    # @since 0.2.0
+    module Levels
+      class << self
+        ALL = %i[debug info warn error fatal].freeze
+
+        # Filter for normal messages
+        def normal
+          %i[debug info warn]
+        end
+
+        # Filter for error messages
+        def error
+          %i[error fatal]
+        end
+      end
+    end
+  end
+end

data/lib/vidazing_logger/layout_pattern.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module VidazingLogger
+  # Determines the format for the logger messages
+  #
+  # @api private
+  # @since 0.2.0
+  class LayoutPattern
+    attr_reader :layout
+
+    def initialize(color_scheme_name)
+      @layout = LayoutPattern.basic.dup
+      @layout[:color_scheme] = color_scheme_name
+    end
+
+    class << self
+      def colored(color_scheme_name)
+        LayoutPattern.new(color_scheme_name)
+      end
+
+      def basic
+        {
+          pattern: '[%d] %-5l %c: %m\n',
+          # ISO8601 without the 'T'
+          date_pattern: '%Y-%m-%d %H:%M:%S'
+        }
+      end
+    end
+  end
+end

data/lib/vidazing_logger/logger.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'vidazing_logger/logger_builder'
+
+module VidazingLogger
+  # Core +Logger+ class api. Calling +build+ returns a
+  # logger with 4 +Appender+s attached.
+  #
+  # @since 0.2.0
+  class Logger
+    # Where to write logs to
+    #
+    # @return [String] where to write logs to
+    attr_reader :log_dir
+
+    # Use in Logging.logger
+    #
+    # @return [String] name
+    attr_reader :name
+
+    # Creates the 'logs/' directory
+    #
+    # @param name [String] Logger name used in messages
+    # @param log_dir [String] Directory to write logs in
+    def initialize(log_dir = VidazingLogger::LOG_DIR, name:)
+      @name = name
+      @log_dir = log_dir
+
+      create_log_dir
+    end
+
+    # Deletes the +log_dir+ directory
+    def clean
+      FileUtils.remove_dir(@log_dir, true)
+    end
+
+    # Create a Logger with 4 Appenders.
+    # STDERR + 'logs/error.log'
+    # STDOUT + 'logs/build.log'
+    #
+    # @return [Logging.logger] See https://github.com/TwP/logging/blob/master/lib/logging/logger.rb
+    def build
+      LoggerBuilder.build(name: @name) do |builder|
+        builder
+          .add_stdout
+          .add_build_log(log_dir: @log_dir)
+          .add_stderr
+          .add_error_log(log_dir: @log_dir)
+      end
+    end
+
+    private
+
+    def create_log_dir
+      Dir.mkdir(@log_dir) unless Dir.exist?(@log_dir)
+    end
+  end
+end

data/lib/vidazing_logger/logger_builder.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require 'vidazing_logger/appenders/logging_gem_adapter'
+
+require 'vidazing_logger/appenders/stdout'
+require 'vidazing_logger/appenders/build_log'
+require 'vidazing_logger/appenders/stderr'
+require 'vidazing_logger/appenders/error_log'
+
+require 'logging'
+
+module VidazingLogger
+  # Select where the logger will write to
+  #
+  # @example Building a Logger
+  #   LoggerBuilder.build(name: @name) do |builder|
+  #     builder
+  #       .add_stdout
+  #       .add_build_log(log_dir: @log_dir)
+  #       .add_stderr
+  #       .add_error_log(log_dir: @log_dir)
+  #
+  # @see Logging.logger
+  # @since 0.2.0
+  class LoggerBuilder
+    # The resulting builder logger object
+    #
+    # @return [Logging.logger]
+    attr_reader :logger
+
+    # Create a new LoggerBuilder
+    #
+    # @param name [String] Reference to obtain the logger.
+    # @return [Logging.logger]
+    def self.build(name:)
+      builder = new(name: name)
+      yield(builder)
+      builder.logger
+    end
+
+    # Sets up the underlying Logging.logger reference.
+    #
+    # @param name [String] Reference to obtain the logger.
+    def initialize(name:)
+      # Create a logger before any appenders
+      # Avoids a situation where Filters::Normal levels are nil
+      #
+      # Logging::Filters::Level.new bug:
+      # @filter has nil levels set on the first invocation
+      @logger = Logging.logger[name]
+    end
+
+    # Outputs log messages to STDOUT
+    #
+    # @return nil
+    def add_stdout
+      appender = Appenders::Stdout.new
+      logging_appender_type = Appenders::Type::ID_STDOUT
+
+      add_logging_appender(logging_appender_type, vidazing_appender: appender)
+    end
+
+    # Outputs log messages to STDERR
+    #
+    # @return nil
+    def add_stderr
+      appender = Appenders::Stderr.new
+      logging_appender_type = Appenders::Type::ID_STDERR
+
+      add_logging_appender(logging_appender_type, vidazing_appender: appender)
+    end
+
+    # Adds a VidazingLogger::Appender::BuildLog.
+    # Writes to +log_dir+/build.log
+    #
+    # @param log_dir [String] Directory to write logs in
+    # @return nil
+    def add_build_log(log_dir:)
+      appender = Appenders::BuildLog.new(log_dir: log_dir)
+      add_log(vidazing_appender: appender)
+    end
+
+    # Adds a VidazingLogger::Appender::ErrorLog
+    # Writes to +log_dir+/error.log
+    #
+    # @param log_dir [String] Directory to write logs in
+    # @return nil
+    def add_error_log(log_dir:)
+      appender = Appenders::ErrorLog.new(log_dir: log_dir)
+      add_log(vidazing_appender: appender)
+    end
+
+    private
+
+    def add_log(vidazing_appender:)
+      logging_appender_type = Appenders::Type::ID_ROLLING_FILE
+
+      add_logging_appender \
+        logging_appender_type,
+        vidazing_appender: vidazing_appender
+    end
+
+    def add_logging_appender(logging_appender_type, vidazing_appender:)
+      # Using public_send since ruby methods are not first class
+      adapter = Appenders::LoggingGemAdapter.public_send \
+        logging_appender_type,
+        vidazing_appender: vidazing_appender
+
+      logging_appender = adapter.logging_appender
+      @logger.add_appenders(logging_appender)
+
+      self
+    end
+  end
+end

data/lib/vidazing_logger/version.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
+# @since 0.1.0
 module VidazingLogger
   # [String]
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/vidazing_logger.rb

@@ -1,8 +1,6 @@
-require 'vidazing_logger/version'
-require 'vidazing_logger/appenders/stdout'
-require 'vidazing_logger/appenders/stderr'
+# frozen_string_literal: true
 
-require 'logging'
+require 'vidazing_logger/logger'
 
 # Namespace for the convenience method to create a new logger
 #
@@ -10,18 +8,21 @@ require 'logging'
 # @since 0.1.0
 module VidazingLogger
   class << self
-
     # [String]
-    LOG_DIR = "logs"
-
-    # Creates the 'logs/' directory
-    def initialize
-      Dir.mkdir(LOG_DIR) unless Dir.exists?(LOG_DIR)
-    end
+    LOG_DIR = 'logs'
+    DEFAULT_LOGGER_NAME = 'VidaZing'
 
     # Deletes the 'logs/' directory
-    def clean
-      FileUtils.remove_dir(LOG_DIR, true)
+    #
+    # @param log_dir [String] Directory to delete
+    # @return nil
+    # @since 0.1.0
+    def clean(log_dir = LOG_DIR)
+      @vidazing_logger = VidazingLogger::Logger.new \
+        log_dir,
+        name: DEFAULT_LOGGER_NAME
+
+      @vidazing_logger.clean
     end
 
     # Create a Logger with 4 Appenders.
@@ -29,19 +30,16 @@ module VidazingLogger
     # STDOUT + 'logs/build.log'
     #
     # @param name [String] Logger name used in messages
+    # @param log_dir [String] Directory to write logs in
+    # @see VidazingLogger::Logger#build
     # @return [Logging.logger] See https://github.com/TwP/logging/blob/master/lib/logging/logger.rb
-    def logger(name = 'VidaZing')
-      require 'pry'; binding.pry
-      VidazingLogger.initialize
-
-      log = Logging.logger[name]
-      log.add_appenders \
-        VidazingLogger::Appenders::Stdout.stdout_appender,
-        VidazingLogger::Appenders::Stdout.build_log_appender(LOG_DIR),
-        VidazingLogger::Appenders::Stderr.stderr_appender,
-        VidazingLogger::Appenders::Stderr.error_log_appender(LOG_DIR)
+    # @since 0.2.0
+    def logger(name = DEFAULT_LOGGER_NAME, log_dir = LOG_DIR)
+      @vidazing_logger = VidazingLogger::Logger.new \
+        log_dir,
+        name: name
 
-      log
+      @vidazing_logger.build
     end
   end
 end

data/vidazing_logger.gemspec

@@ -1,32 +1,45 @@
-# -*- encoding: utf-8 -*-
-$LOAD_PATH.push File.expand_path("../lib", __FILE__)
-require "vidazing_logger/version"
+# frozen_string_literal: true
 
-Gem::Specification.new do |s|
-  s.name        = "vidazing_logger"
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+require 'vidazing_logger/version'
+
+Gem::Specification.new do |s| # rubocop:disable Metrics/BlockLength
+  s.name        = 'vidazing_logger'
   s.version     = VidazingLogger::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["VidaZing, Inc."]
+  s.authors     = ['VidaZing, Inc.']
   s.licenses    = ['MIT']
-  s.email       = ["VidaZing@gmail.com"]
-  s.homepage    = "https://github.com/VidaZing/logger_gem"
-  s.summary     = "Custom logging for VidaZing."
+  s.email       = ['VidaZing@gmail.com']
+  s.homepage    = 'https://github.com/VidaZing/logger_gem'
+  s.summary     = 'Custom logging for VidaZing.'
   s.executables << 'vidazing_logger'
 
-  s.rubygems_version = "2.5.2"
-  s.required_ruby_version     = '>= 1.9.3'
+  s.rubygems_version = '2.7.7'
+  s.required_ruby_version = '>= 2.5.1'
 
-  s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec)/}) }
-  s.require_paths = ["lib"]
-  # s.test_files = ["test/test_vidazing_logger.rb"]
+  s.files         = `git ls-files -z`.split("\x0").reject \
+                     { |f| f.match(%r{^(test|spec)/}) }
+  s.require_paths = ['lib']
 
   s.add_runtime_dependency('logging', '2.2.2')
 
-  s.add_development_dependency 'rake', '~> 0'
-  s.add_development_dependency 'rainbow', '3.0.0'
-  s.add_development_dependency 'rspec', '3.8.0'
+  s.add_development_dependency 'awesome_print', '1.8.0'
+  s.add_development_dependency 'byebug', '10.0.2'
+  s.add_development_dependency 'coveralls', '0.8.22'
+  s.add_development_dependency 'flay', '2.12.0'
+  s.add_development_dependency 'flog', '4.6.2'
   s.add_development_dependency 'pry', '0.10.4'
   s.add_development_dependency 'pry-byebug', '3.6.0'
-  s.add_development_dependency 'byebug', '10.0.2'
+  s.add_development_dependency 'pry-rescue', '1.4.5'
+  s.add_development_dependency 'pry-stack_explorer', '0.4.9.2'
+  s.add_development_dependency 'rainbow', '3.0.0'
+  s.add_development_dependency 'rake', '12.3.1'
+  s.add_development_dependency 'rspec', '3.8.0'
+  s.add_development_dependency 'rubocop', '0.58.2'
+  s.add_development_dependency 'simplecov', '0.16.1'
+  s.add_development_dependency 'test-unit', '3.2.8'
   s.add_development_dependency 'yard', '0.9.16'
+
+  # Note: Mocha says to load this after test-unit
+  s.add_development_dependency 'mocha', '1.7.0'
 end