ougai-formatters-customizable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 64f9b36ed7779caff3e9ce05fe6062d1f6c0ab7e7754b55463a3475147bc1b27
+  data.tar.gz: 62c6c4db4205f4faea3a3c5f6cc5cb1c1b3cdbf6849f1cf3085636eb5e5e19b0
+SHA512:
+  metadata.gz: 445010e474a5863bf5311395b474857825962a67b7f2f72ad030656f46e8e99b339264dff77057d06e2f8bde3eda75ce661c620fd7afade58f94461b0a2393db
+  data.tar.gz: 7b06933a749c5632e87d7828f6009145c4d21ec3e01a23696d982e160bc96bd1fa8854a71c8a142d5e400deac0becbe2264055c9c17005855f50cbd1a448509a

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Al-un
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# Ougai::Formatters::Customizable
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ougai/formatters/customizable`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ougai-formatters-customizable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ougai-formatters-customizable
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ougai-formatters-customizable.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/ougai/formatters/colors.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Ougai
+  module Formatters
+    # List of useful ANSI escape sequences for terminal font formatting. Source
+    # is https://gist.github.com/chrisopedia/8754917.
+    module Colors
+      # -- Comments compared to Ougai initial coloring --
+      # Non-bold font colors do not use \e[0;{value}m because it seems to be
+      # incompatible with background colors: \e[41m\e[0;34mtext\e[0m does not print
+      # background red while \e[41m\e[34mtext\e[0m works. However, to put font in
+      # bold/bright mode, \e[41m\e[1;34mtext\e[0m works
+      # => Tested on Windows PowerShell and MinGW64
+      #
+      # Colors values cannot be frozen as .concat is called upon them
+
+      # Reset formatting. To be appended after every formatted text
+      RESET             = "\e[0m"
+      # Foreground colors
+      BLACK             = "\e[30m"
+      RED               = "\e[31m"
+      GREEN             = "\e[32m"
+      YELLOW            = "\e[33m"
+      BLUE              = "\e[34m"
+      PURPLE            = "\e[35m"
+      CYAN              = "\e[36m"
+      WHITE             = "\e[37m"
+      BOLD_RED          = "\e[1;31m"
+      BOLD_GREEN        = "\e[1;32m"
+      BOLD_YELLOW       = "\e[1;33m"
+      BOLD_BLUE         = "\e[1;34m"
+      BOLD_MAGENTA      = "\e[1;35m"
+      BOLD_CYAN         = "\e[1;36m"
+      BOLD_WHITE        = "\e[1;37m"
+      # Background colors
+      BG_BLACK          = "\e[40m"
+      BG_RED            = "\e[41m"
+      BG_GREEN          = "\e[42m"
+      BG_YELLOW         = "\e[43m"
+      BG_BLUE           = "\e[44m"
+      BG_MAGENTA        = "\e[45m"
+      BG_CYAN           = "\e[46m"
+      BG_WHITE          = "\e[47m"
+
+      class << self
+        # Color a text by prepending a font styling escape sequence and
+        # appending a reset sequence. This method does a pure String concatenation
+        # and does not check the values are properly escaped. This allows
+        # customization, depending on user's terminal, to use custom escape
+        # sequences.
+        # 
+        # @param [String] color color to prepend. Color can be from the list
+        #         above or have a complete custom String value depending on the
+        #         terminal. If +nil+, text is not modified.
+        # @param [String] text text to be colored
+        # @param [String] reset reset font styling escape sequence. Default
+        #         to +\e[0m+
+        def color_text(color, text, reset = Ougai::Formatters::Colors::RESET)
+          return text if color.nil?
+
+          # .concat is preferred in Ruby:
+          # https://coderwall.com/p/ac5j9g/or-concat-what-is-faster-for-appending-string-in-ruby
+          ''.dup.concat(color).concat(text).concat(reset)
+        end
+      end
+
+    end
+  end
+end

data/lib/ougai/formatters/colors/configuration.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require 'ougai/formatters/colors'
+
+module Ougai
+  module Formatters
+    module Colors
+      # Handle the colorization of output, mainly aimed at console formatting.
+      # The configuration,split by subject such as +level+, +msg+,
+      # or +datetime+ is basically a Hash: +config+ with the subject as key
+      # and values. Values can be have three types:
+      #   - String: the color escape sequence for the subject
+      #   - Hash: the color escape sequence per severity. If not all severities
+      #     are defined, a +:default+ value must be defined
+      #   - Symbol: refers to another key and same coloring is applied
+      class Configuration
+        class << self
+          # list default color configuration
+          # @note 'any' severity label decided in 
+          #       +Ougai::Logging::Severity#to_label+
+          # @note values are copied from +Ougai::Formatters::Readable+ coloring
+          #       values
+          def default_configuration
+            {
+              severity: {
+                trace:  Ougai::Formatters::Colors::BLUE,
+                debug:  Ougai::Formatters::Colors::WHITE,
+                info:   Ougai::Formatters::Colors::CYAN,
+                warn:   Ougai::Formatters::Colors::YELLOW,
+                error:  Ougai::Formatters::Colors::RED,
+                fatal:  Ougai::Formatters::Colors::PURPLE,
+                any:    Ougai::Formatters::Colors::GREEN
+              }
+            }
+          end
+        end
+
+        # @param [Hash] configuration Color configuration mapping. Cannot be nil
+        # @param [Boolean] load_default_config If true, then default configuration
+        #         values is fetched to fill missing value from the provided 
+        #         configuration. Default is true.
+        def initialize(configuration = {})
+          # check if loading or not from default configuration
+          if configuration.fetch(:load_default_config) { true }
+            @config = Configuration.default_configuration
+          else
+            @config = {}
+          end
+
+          configuration.each do |key, val|
+            default_val = @config[key]
+            # default value is a Hash AND input value is a Hash => merge
+            if val.is_a?(Hash) && default_val.is_a?(Hash)
+              @config[key] = default_val.merge(val)
+            # Input value is assigned because one of the follow
+            # 1) input value is not defined in default configuration
+            # 2) input value is not a Hash which overrides the default value
+            # 3) default value is not a Hash and input is a Hash => Arbitrary
+            else
+              @config[key] = val
+            end
+          end
+        end
+
+        # @param [Symbol] subject_key to fetch the color to color the text
+        # @param [String] text to be colored text
+        # @param [Symbol] severity log level
+        # @return a colored text depending on the subject
+        def color(subject_key, text, severity)
+          color = get_color_for(subject_key, severity)
+          Ougai::Formatters::Colors.color_text(color, text)
+        end
+
+        # Return the color for a given suject and a given severity. This color
+        # can then be applied to any text via
+        # +Ougai::Formatters::Colors.color_text+
+        #
+        # +get_color_for+ handles color inheritance: if a subject inherit color
+        # from another subject, subject value is the symbol refering to the
+        # other subject.
+        # !!WARNING!!: Circular references are not checked and lead to infinite
+        # loop  
+        #
+        # @param [Symbol] subject_key: to define the color to color the text
+        # @param [Symbol] severity: log level
+        # @return requested color String value or +nil+ if not colored
+        def get_color_for(subject_key, severity)
+          # no colorization
+          return nil unless @config.key?(subject_key)
+
+          # no severity dependence nor inheritance
+          color = @config[subject_key]
+          return color if color.is_a? String
+
+          # inheritance from another subject
+          return get_color_for(color, severity) if color.is_a? Symbol
+
+          # severity dependent but not inherited value or return +nil+ if
+          # configuration is incorrect
+          severity = severity.downcase.to_sym
+          color.fetch(severity) { color[:default] }
+        end
+
+      end
+
+    end
+  end
+end

data/lib/ougai/formatters/customizable.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+require 'ougai/formatters/base'
+require 'ougai/formatters/colors/configuration'
+
+module Ougai
+  module Formatters
+    # Ougai log printing can be split in three components:
+    # 1. Main log message: usually with timestamp, log severity and a single
+    #    line message
+    # 2. Log data: the structured logging component. Can be represented by
+    #    a Hash
+    # 3. Errors: errors require specific log formatting
+    #
+    # Customizable offers a flexible way to handle each component
+    # independently with three procs:
+    # +format_msg+    Format message. Proc arguments are
+    #                 +|level, datetime, progname, data|+. This block must
+    #                 remove the key +:msg+ from +data+
+    # +format_data+   Format data. Proc argument is +|data|+.
+    # +format_err+    Format err. Proc argument is +|data|+. The proc must
+    #                 remove the key +:err+
+    class Customizable < Ougai::Formatters::Base
+      class << self
+        # Define the default main log message formatting to use.
+        # @param [Ougai::Formatters::Colors::Configuration] color_config: the
+        #         color configuration to use. Cannot be null but can have an
+        #         empty +config+ hash meaning that there is no colorization
+        def default_msg_format(color_config)
+          proc do |severity, datetime, _progname, data|
+            msg = data.delete(:msg)
+            severity = color_config.color(:severity, severity, severity)
+
+            "[#{datetime}] #{severity}: #{msg}"
+          end
+        end
+
+        # Define the default error formatting to use.
+        # @param [Array<Symbol>] excluded_fields list of key to exclude from
+        #         +data+ before printing logs
+        # @param [Boolean] plain parameter to define if Awesome-Print renders
+        #         in plain mode or not
+        def default_data_format(excluded_fields, plain)
+          proc do |data|
+            excluded_fields.each { |field| data.delete(field) }
+            next nil if data.empty?
+
+            data.ai(plain: plain)
+          end
+        end
+
+        # Define the default error formatting to use.
+        # @param [Integer] trace_indent space indentation to prepend before
+        #         trace content
+        def default_err_format(trace_indent = 4)
+          proc do |data|
+            next nil unless data.key?(:err)
+
+            err = data.delete(:err)
+            err_str = "  #{err[:name]} (#{err[:message]}):"
+            err_str += "\n" + (' ' * trace_indent) + err[:stack] if err.key?(:stack)
+            err_str
+          end
+        end
+      end
+
+      # Intialize a formatter
+      #
+      # @param [String] app_name application name (execution program name if nil)
+      # @param [String] hostname hostname (hostname if nil)
+      # @param [Hash] opts the initial values of attributes
+      # @option opts [String] :trace_max_lines (100) the value of trace_max_lines attribute
+      # @option opts [String] :plain (false) the value of plain attribute
+      # @option opts [String] :excluded_fields ([]) the value of excluded_fields attribute
+      # @option opts [Ougai::Formatters::Colors::Configuration] :color_config
+      #         assign a color configuration. Takes predecence over :colors
+      # @option opts [Proc] :format_msg main message formatter
+      # @option opts [Proc] :format_data data formatter
+      # @option opts [Proc] :format_err error formatter
+      def initialize(app_name = nil, hostname = nil, opts = {})
+        aname, hname, opts = Base.parse_new_params([app_name, hostname, opts])
+        super(aname, hname, opts)
+
+        # Message logging
+        color_config = opts.fetch(:color_config) {
+          color_config = Ougai::Formatters::Colors::Configuration.new({})
+        }
+        @format_msg = opts.fetch(:format_msg) {
+          Customizable.default_msg_format(color_config)
+        }
+
+        # Data logging
+        plain = opts.fetch(:plain) { false }
+        excluded_fields = opts[:excluded_fields] || []
+        @format_data = opts.fetch(:format_data) {
+          Customizable.default_data_format(excluded_fields, plain)
+        }
+
+        # Error logging
+        trace_indent = opts.fetch(:trace_indent) { 4 }
+        @format_err = opts.fetch(:format_err) {
+          Customizable.default_err_format(trace_indent)
+        }
+
+        # Ensure dependency are present
+        load_dependent
+      end
+
+      # Format a log entry
+      #
+      # @param [String] severity log severity, in capital letters
+      # @param [Time] time timestamp of the log. Is formatted by +strftime+
+      # @param [String] progname optional program name
+      # @param [Hash] data log data. Main message is stored under the key +:msg+
+      #         while errors are logged under the key +:err+.
+      def _call(severity, time, progname, data)
+        strs = ''.dup
+        # Main message
+        dt =  format_datetime(time)
+        msg_str = @format_msg.call(severity, dt, progname, data)
+        strs.concat(msg_str)
+
+        # Error: displayed before additional data
+        err_str = @format_err.call(data)
+        strs.concat("\n").concat(err_str) unless err_str.nil?
+
+        # Additional data
+        data_str = @format_data.call(data)
+        strs.concat("\n").concat(data_str) unless data_str.nil?
+
+        strs.concat("\n")
+      end
+
+      protected
+
+      # Ensure `awesompe_print` is loaded
+      def load_dependent
+        require 'awesome_print'
+      rescue LoadError
+        puts 'You must install the awesome_print gem to use this output.'
+        raise
+      end
+    end
+  end
+end

data/lib/ougai/formatters/customizable/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Ougai
+  module Formatters
+    CUSTOMIZABLE_VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: ougai-formatters-customizable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Al-un
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: ougai
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |2
+      This library aims at providing a fully flexible formatter compatible with the
+      Ougai library. Customization is about colorization and log formatting.
+email:
+- alun.sng@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/ougai/formatters/colors.rb
+- lib/ougai/formatters/colors/configuration.rb
+- lib/ougai/formatters/customizable.rb
+- lib/ougai/formatters/customizable/version.rb
+homepage: https://github.com/Al-un/ougai-formatters-customizable
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Customizable formatter for Ougai library
+test_files: []