logzomg 0.1.0 → 0.1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c62b72556a339925393753589f92925d63347584
-  data.tar.gz: 11dedeeb8b5f4bc2d36c821aeff053228ab66497
+  metadata.gz: aff1c4e5aeec14f295006eb33123760bb05e2787
+  data.tar.gz: cf5b53019762166d1072d8fb6f49fc2c9187d515
 SHA512:
-  metadata.gz: 8d029c7328cc8ea4373fc1b1bc2c143cd6018a87f4ed10a4e53a963ceb0eccbd0c6d11c02348636f0e1c857fce4b32305b0bbfd842cbdd7480cde596de0de158
-  data.tar.gz: 43d4917e4f3df95db18d322e672aed5c095d76489bf485e8e0a6b79be654ed3c68253eda029beedba49dc4c18f27d7d8a429de64e98f2113fd694f124830879e
+  metadata.gz: b3f3db722dd5bde85de0a881615a4122d6255eae4d22577e68aa503493c51d61685a688740dbce6f311395937929b4cf48dcad8ac4e0e91a26d4cff07d9ec160
+  data.tar.gz: 62a13c97056e402e2f86caaac96d098f3a0706e0be4472f2dfa4564009155dc3308e27bd1552762845e232bc2fe348e6bf59c84b971bb0d9af12a0e771505eec

data/README.md

@@ -4,7 +4,7 @@
 
 An easy to use and lightweight logging gem for Ruby.
 
-![Terminal output](http://i.imgur.com/reu3xof.png)
+![Terminal output](http://i.imgur.com/dsQyWNo.png)
 
 Logzomg currently supports varying levels of severity.
 
@@ -26,26 +26,40 @@ Fatal
 
 ## Usage
 
+The logger takes a hash in and formats the key-value pairs. The key msg will always be displayed last.
+
 You can instantiate the logger and use it like so:
 
 ```ruby
 def log
   l = Logzomg::Logger.new
   l.log({
-          "msg": "Frank took the last coffee and forgot to make some new. Fire him?", 
-          "level": "info",                    # Optional. Sets log level. Default is warning
-          "file": "frank.txt"                 # Optional. Sets name of file to log to. Default is log.txt
+          number: 3,
+          entity: "Acro-yoga enthusiasts",
+          wild: true,
+          msg: "Have been spotted!", 
+          damn: "son",
+          level: "info",                       # Optional. Sets log level. Default is warning
+          file: "help.txt"                     # Optional. Sets name of file to log to. Default is log.txt
         })
 end  
 ```
 
+Giving this result:
+![Terminal output](http://i.imgur.com/IvprMBS.png)
+
 By default Logzomg color codes the logging levels when viewed in a terminal. If you want to turn this off you can instead pass a TextFormatter when instantiating the logger.
 
 The TextFormatter takes a hash of options.
 
-`
-  Logzomg::Logger.new(TextFormatter.new({with_colors: false}))
-`
+```ruby
+def logger
+  Logzomg::Logger.new(formatter: TextFormatter.new { |f|
+      f.with_color = true
+      f.short_date  = true
+  })
+end
+```
 
 Currently Logzomg only supports logging as plaintext. Soon it will support logging as JSON as well.
 

data/lib/formatters/text_formatter.rb

@@ -4,27 +4,57 @@ require 'date'
 # Allows color output to logfile
 
 class TextFormatter
+  MAX_CHAR = 150
+  MAX_CHAR_FLOAT = 145.00   # There's some problems with float decimal precision. Keep this 5 below MAX_CHAR
+  COLORS = {
+    info:     "96",
+    warning:  "33", 
+    debug:    "34",
+    error:    "91",
+    fatal:    "31"
+  }
 
-  def initialize(init_hash = Hash.new)
-    @color =  init_hash.has_key?(:with_color) ? init_hash[:with_color] : true
-    puts "Init color: " + @color.to_s
+  attr_accessor :with_color, :short_date
+
+  def initialize
+    if block_given?
+      yield(self)
+    end
   end
 
   # Split the message into 145 char chunks. 
   # Prepend level. Append DateTime
-  def format_msg(msg, level)
-    @level = level
-    str = ""
-    s_msg = split_msg(msg)                                # Split message incase it's 150+ chars
-    count = 0                                             # Use to indent on 2nd+ iteration
+  def format_msg(hash, level)
+    @level = level                                        # Log level
+    str = ""                                              # Final String we return. This is the one we add to
+    str_keys_values = ""                                  # One long String in format "key: value  | key2: value2"
+    s_msg = []                                            # Each index in this Array is the maximum allowed amount of chars on the screen
+    
+    str_keys_values += hash[:msg].to_s + "  |  "          # Add msg first
+
+    # We loop over every key in the hash and format the key/value in the string format we want    
+    hash.each do |key, value|
+      if !key.to_s.eql?("level") && !key.to_s.eql?("msg") && !key.to_s.eql?("file")
+        key = "#{add_color_key(key)} :" if with_color     # Add color to keys if with_color is set to true
+        str_keys_values += "#{key}: #{value}  "
+      end
+    end
+
+    s_msg = split_msg(str_keys_values)                    # Split message incase it's MAX_CHAR+ chars
     
+    s_msg.each do |n|
+      puts n
+    end
+
+    count = 0                                             # Use to indent on 2nd+ iteration
+
     s_msg.each do |n|
       str += add_msg_identifier(str)
-      text = count >= 1 ? "  " + n : n                    # Indent if 2nd+ iteration
+      text = count >= 1 ? " " + n : n                     # Indent if 2nd+ iteration
       str += text
       indented = count >= 1                               # Set indented to determine space amount
-      str += right_align_date(n, indented)
-      str += " | " + DateTime.now.to_s + "\n"
+      str += right_align_date(n, hash, count+1, s_msg)
+      str += " | " + add_date(count) + "\n"
       count += 1
     end
     
@@ -33,49 +63,70 @@ class TextFormatter
 
 
   private
+    def add_date(count)
+      date = short_date ? DateTime.now.strftime('%b-%e %H:%M:%S') : DateTime.now.to_s
+      count > 0 ? "" : date
+    end
+
     # Adds spaces to right align date depending on str length and row number
-    def right_align_date(msg, indented)
-      indented ? s = 60 : s = 58
-      " " * (s - msg.length)  
+    # 
+    # Since we add colouring to each key we're adding invisible characters
+    # Each colour adds 9 extra characters so we have to handle this
+    def right_align_date(msg, hash, itr, full_msgs)
+      extra = 0
+      # If msg is first don't right_align since there's always a line 2
+      if with_color
+        if msg == full_msgs.first && full_msgs.size > 1     # Triggers on first line of multiline
+          extra = 0
+          puts "#{msg} #{itr} triggered 1"
+        elsif itr == 1                                      # Triggers on first itr if it's one-line with args
+          extra = 9 * get_size(hash)
+          puts "#{msg} #{itr} triggered 2"
+        elsif itr == full_msgs.length && get_size(hash) > 0 # Triggers on last line of multiline msg
+          extra = 9
+          puts "#{msg} #{itr} triggered 3"
+        end
+      end
+
+      s = itr > 1 ? MAX_CHAR - 2 : MAX_CHAR - 1
+      " " * (s - msg.length + extra)
+    end
+
+    # Returns size but without certain keys that wont be displayed
+    def get_size(hash)
+      size = 0
+      hash.keys.each do |n|
+        size += 1 unless n.to_s.eql?("file") || n.to_s.eql?("level") || n.to_s.eql?("msg")
+      end
+      size
     end
 
     # Adds log level to start of log
     # Add color if color is true
     def add_msg_identifier(str)
-      if @level == 'debug'
-        str += "DBUG"
-      elsif @level == 'info' 
-        str += "INFO"
-      elsif @level == 'warning'
-        str += "WARN"
-      elsif @level == 'error'
-        str += "ERRO"
-      elsif @level == 'fatal'
-        str += "FATA"
-      end 
-      str = add_color(str) if @color
+      # Need a check since debug has a different identifier than the rest
+      str = @level == 'debug' ? 'DBUG' : @level[0..3].upcase
+      str = add_color_level(str) if with_color
       str += + " | "
     end 
 
-    # Adds color if color is true
-    def add_color(str)
-      colors = {debug: "\e[34m", info: "\e[96m", warning: "\e[33m", error: "\e[91m", fatal: "\e[31m"}
+    # Adds color to level if color is true
+    def add_color_level(str)
       close_color = "\e[0m"
-      str.prepend(colors[@level.to_sym])
+      str.prepend("\033[" + COLORS[@level.to_sym] + "m")
       str += close_color
     end
 
-    # Splits the message every 150 chars to make everything look prettier
+    # Adds color to hash key
+    def add_color_key(key)
+      "\033[" + COLORS[@level.to_sym] + "m" + key.to_s + "\e[0m"
+    end
+
+    # Splits the message
+    # Substring using MAX_CHAR - 5 but not if in middle of a word
     def split_msg(msg)
-      arr = []
-      start = 0
-      ending = 145
-      c = msg.length > 150 ? ((msg.length).to_f/150.00).ceil : 1
-      (1..c).each do |n|
-        arr << msg[start,ending]
-        start += 146
-        ending += 145
-      end
-      arr  
+      sub_end = MAX_CHAR - 5
+      # Goes back to start of word if matches inside a word. If it matches inside a coloured key go back to start of word before colour
+      msg.scan(/.{0,#{Regexp.escape(sub_end.to_s)}}[^\\033\[33m\]a-z\\e\[0m$a-z.!?,;](?:\b|$)/mi)
     end 
 end

data/lib/logzomg/version.rb

@@ -1,3 +1,3 @@
 module Logzomg
-  VERSION = "0.1.0"
+  VERSION = "0.1.0.1"
 end

data/lib/logzomg.rb

@@ -10,9 +10,14 @@ module Logzomg
     UnsupportedType = Class.new(StandardError)
     UnsupportedLevel = Class.new(StandardError)
 
-    def initialize(formatter=TextFormatter.new)
-      @level = 'warning'
-      @formatter = formatter
+    def initialize(**args, &block)
+      # Set some default values
+      @level = args[:level] ? args[:level] : "warning"
+      @formatter = args[:formatter] ? args[:formatter] : TextFormatter.new {|f| f.with_color = true}
+      if block_given?
+        yield(self)
+        return
+      end
     end 
 
     # First set level -> 
@@ -21,7 +26,7 @@ module Logzomg
     def log(hash)
       raise UnsupportedType, "Must be of type Hash" unless valid_hash?(hash)
       level(hash[:level]) if hash.has_key?(:level)        # Use default if not included
-      msg = @formatter.format_msg(hash[:msg], @level)
+      msg = @formatter.format_msg(hash, @level)
       write(hash, msg)
     end 
 
@@ -34,33 +39,55 @@ module Logzomg
 
     # REMOVE AFTER DONE CODING
     def test
-      l = Logzomg::Logger.new
-      l.log({
-              "msg": "Something is on the horizon!", 
-              "level": "debug"
-            })
-      #l.log({
-      #        "msg": "This is a really really really really really really really really really " +
-      #                "really really really really really really really really really really really " +
-      #                "really really really really really really debug message", 
-      #        "level": "debug"
-      #      })
-      l.log({
-              "msg": "Three wild acro-yoga enthusiasts have been spotted!", 
-              "level": "info"
-            })
-      l.log({
-              "msg": "They are coming closer!", 
-              "level": "warning"
-            })
-      l.log({
-              "msg": "I don\'t know how to handle them!!", 
-              "level": "error"
-            })
-      l.log({
-              "msg": "You have died", 
-              "level": "fatal"
-            })
+      self.log({
+                msg:      "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam ipsum dui, luctus ac velit nec, imperdiet elementum turpis." +
+                "Pellentesque velit tellus, ultricies non mauris at, semper rhoncus enim. Duis blandit arcu aliquam, sollicitudin leo quis, feugiat orci." + 
+                "Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Sed et tortor vel lectus convallis posuere ac vel lacus." + 
+                "Praesent vestibulum cursus ipsum vel elementum. Fusce elit enim, sollicitudin id sem consequat, molestie accumsan mi. Aliquam vehicula urna tortor," + 
+                "sit amet laoreet lacus pulvinar eu. Ut imperdiet vitae neque eu consectetur. Nam ac lacus finibus, fringilla neque ac, maximus ligula. Duis ullamcorper," + 
+                "felis sit amet luctus vehicula, sapien est dictum lorem, nec blandit nunc mi id enim. Curabitur quis laoreet erat. Maecenas varius cursus blandit." + 
+                "felis sit amet luctus vehicula, sapien est dictum lorem, nec blandit nunc mi id enim. Curabitur quis laoreet erat. Maecenas varius cursus blandit." + 
+                "felis sit amet luctus vehicula, sapien est dictum lorem, nec blandit nunc mi id enim. Curabitur quis laoreet erat. Maecenas varius cursus blandit." + 
+                "felis sit amet luctus vehicunec blandit nunc mi id enim. Curabitur quis laoreet erat. Maecenas varius cursus blandit." + 
+                "felis sit amet luctus vehicula, sapien est dictum lorem, nec blandit nunc mi id enim. Curabitur quis laoreet erat. Maecenas varius cursus blandit." + 
+                "felis sit amet luctus vehicula, sapien est ditur quis laoreet erat. Maecenas varius cursus blandit." + 
+                "felis sit amet luctus vehicula, sapien est dictum lorem, nec blandit nunc mi id enim. Curabitur quis laoreet erat. Maecenas varius cursus blandit." + 
+                "felis sit amet luctus vehicula, sapien est dictum lorem, nec blandit nunc mi id enim. Curabitur quis laoreet erat. Maecenas varius cursus blandit." + 
+                "felis sit amet luctus vehicula, sapien est dictum lorem, nec blandit nunc mi id enim. Curabitur quis laoreet erat. Maecenas varius cursus blandit." + 
+                "felis sit amet luctus vehicula, sapien est dictum lorem, nec blandit nunc mi id enim. Curabitur quis laoreet erat. Maecenas varius cursus blandit." + 
+                "felis sit amet luctus vehicula, sapien est dictum lorem, nec blandit nunc mi id enim. Curabitur quis laoreet erat. Maecenas varius cursus blandit." + 
+                "Aliquam eleifend mauris ut nisl mollis, quis placerat nisi bibendum.",
+                long:     true,
+                level:    "debug"
+              })
+      self.log({
+                msg:      "Something is on the horizon!", 
+                spotted:  "unknown",
+                level:    "debug"
+              })
+      self.log({
+                number: 3,
+                entity:   "Acro-yoga enthusiasts",
+                wild:     true,
+                msg:      "Have been spotted!", 
+                damn:     "son",
+                level:    "info"              
+              })
+      self.log({
+                msg:      "They are coming closer!", 
+                speed:    "5km/t",
+                level:    "warning"
+              })
+      self.log({
+                msg:      "I don't know how to handle them!!", 
+                omg:      true,
+                level:    "error"
+              })
+      self.log({
+                dead:     true,
+                msg:      "You have died", 
+                level:    "fatal"
+              })
     end  
   
     private
@@ -81,4 +108,4 @@ module Logzomg
         return !level.nil? && LEVELS.any? { |l| l == level.downcase }
       end 
   end
-end
+end

data/logzomg.gemspec

@@ -8,6 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = Logzomg::VERSION
   spec.authors       = ["Rasmus"]
   spec.email         = ["Rasmusbreiler@gmail.com"]
+  spec.description   = "An easy to use, lightweight logging gem for Ruby applications"
 
   spec.summary       = %q{Logging gem with Asana API integration}
   spec.homepage      = "https://github.com/Evilbits/logzomg"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logzomg
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.0.1
 platform: ruby
 authors:
 - Rasmus
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-01 00:00:00.000000000 Z
+date: 2017-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 
+description: An easy to use, lightweight logging gem for Ruby applications
 email:
 - Rasmusbreiler@gmail.com
 executables: []
@@ -71,6 +71,7 @@ files:
 - lib/formatters/text_formatter.rb
 - lib/logzomg.rb
 - lib/logzomg/version.rb
+- logzomg-0.1.0.gem
 - logzomg.gemspec
 homepage: https://github.com/Evilbits/logzomg
 licenses: