itz_logger 0.2.10 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 752da29c81d20b8e1126b8c6d217cba564c2f54651be5d028fb2e0b7ac74d7d3
-  data.tar.gz: 6aabe0d9fe4051fb07a166af621e19792123494f9103889e721cf125f4ace368
+  metadata.gz: 2814d878b3037ce6e88598e31ad83aea5715f1f39d0432d80c40d90bf33a566d
+  data.tar.gz: b7e119a2dc786bfa20248bbf2cce3c6bd62415b699d910c76f114fb73b6672ee
 SHA512:
-  metadata.gz: 223b9715ba89415fcd70ffa7032e4f9889e62750071dcf1cc049dbc7b1747e99f03107f1e76c725a3177f51d9fad044998816a1e6ffe88c4a578f2b3ac3278e4
-  data.tar.gz: e2c2a5873f9ab04014bc4c6a8246c2576bf5bc340a0173f8dacc0a1b5d850189153a570c6a659ca05c4154090cf4897ec8d0150f1fd889a2f8fb367c71ce6f04
+  metadata.gz: 4a03ddc86fa7806148a9f4de1b8689cb0aed9d1a755e1e53f87caa68c09fe7a4a76cdc4a2fc1ed8c9e65eb9a1ae88ff8a228efac6db33d2479a388c836eede5d
+  data.tar.gz: 06027edb5392e3a31b8af7d67312471eadc441c008eb8918edf437ffed89c84a88bc0197a5de68fdc46a165c68690a5a1ffc31e290a82d250420b1c120de5e3f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    itz_logger (0.2.9)
+    itz_logger (0.2.10)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -5,7 +5,7 @@ ItzLogger is the N+1 log gem. Following the rule, that at least once in a life t
 This log gem supports multiple output channels:
 
 1. log to the terminal (stdout only)
-2. log to a file (not yet implemented)
+2. log to a file 
 3. log to a RabbitMQ service (not yet implemented)
 
 
@@ -52,7 +52,9 @@ log_level = :info
 log_target = :log_terminal
 
 # create a logger
-logger = ItzLogger::Logger.new(log_level, log_target)
+logger = ItzLogger::Logger.new(
+  log_level: log_level,
+  log_strategy: log_target)
 
 # now go ahead
 logger.info("foo")
@@ -64,6 +66,50 @@ logger.debug("baz")
 logger.verbose("foo bar baz")
 ```
 
+### Log to a file
+
+First things first - install the gem. Take a look in the installation section.
+
+The logger checks the existance of the log file. If the file exists and 
+is writable, the logger uses this the file.
+If the file does not exist, the logger tries to create the file.
+
+If both fails (creation and/or usage), the logger silently ignores it and does
+write any logs.
+
+A simple example:
+
+```ruby
+require 'itz_logger'
+
+...
+
+# you can choose the log_level from from
+# - :info
+# - :warn
+# - :debug
+# - :verbose
+log_level = :info
+
+# you can choose the target from
+# - :log_terminal
+log_target = :log_file
+
+# create a logger
+logger = ItzLogger::Logger.new(
+  log_level: log_level,
+  log_strategy: log_target,
+  log_file: "/tmp/my_log_file.log")
+
+# now go ahead
+logger.info("foo")
+
+logger.warn("bar")
+
+logger.debug("baz")
+
+logger.verbose("foo bar baz")
+```
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/itz_logger/formatter.rb

@@ -9,7 +9,7 @@ module ItzLogger
   class Formatter
 
     def self.format(id, message)
-      printf(
+      sprintf(
         "%-19s %-s8 %-#{message.type.length}s %s\n",
         message.created_at.strftime("%b %d %H:%M:%S UTC"),
         id,

data/lib/itz_logger/log_file.rb

@@ -1,4 +1,8 @@
 
+# Log file writer
+#
+# This class encapsulate the file writer of the itz_logger project.
+
 require_relative "./message"
 require_relative "./formatter"
 
@@ -6,22 +10,42 @@ module ItzLogger
   class LogFile
 
     @log_level = nil
+    @log_id = nil
+    @log_file_handle = nil
+
+    @error_flag = false
+    @error_reason = nil
 
     attr_reader :log_level
 
     def initialize(
       log_level = ItzLogger::MessageType::INFO,
-      log_file = "/tmp/logfile.log")
+      log_file = '/tmp/logfile.log',
+      log_id = nil)
 
       @log_level = log_level
+      @log_id = log_id
+
+      create_and_open_log_file(log_file)
+      check_error
     end
 
-    def write(_log_level, _message)
-      puts "not yet implemented"
-      # return nil if !ItzLogger::MessageType.equals(@log_level, log_level)
+    def write(log_level, message)
+
+      # stop here, iff there is no file to write into
+      return nil if check_error
+
+      # stop here, iff the message is not importand enough
+      return nil if !ItzLogger::MessageType.equals(@log_level, log_level)
+
+      log_message = ItzLogger::Message.new(message, log_level)
 
-      # message = ItzLogger::Message.new(message, log_level)
-      # ItzLogger::Formatter.format(message)
+      File.write(
+        @log_file_handle,
+        ItzLogger::Formatter.format(
+          @log_id,
+          log_message),
+        mode: 'a')
     end
 
     def log_level=(log_level)
@@ -29,5 +53,66 @@ module ItzLogger
         @log_level = log_level
       end
     end
+
+    private
+
+    def check_error
+      if @error_reason == true
+        STDERR.puts @error_reason
+      end
+
+      @error_flag
+    end
+
+
+    # create or/and open the log file
+    def create_and_open_log_file(log_file)
+      # check existance of the given file
+      # and do we have permission to write
+      if File.exist?(log_file)
+        if File.writable_real?(log_file)
+          @log_file_handle = File.open(log_file, 'a')
+          @log_file_handle.sync = true
+        else
+          @error_flag = true
+          @error_reason = "[ERROR] can't open log file for writing!"
+        end
+      else
+        path = File.dirname(log_file)
+        _filename = File.basename(log_file)
+
+        # check whether the path to the log file exists and is writable
+        #
+        # if not, try to create the path
+        if Dir.exist?(path)
+
+          if File.writable_real?(path)
+            begin
+              @log_file_handle = File.open(log_file, 'w')
+              @log_file_handle.sync = true
+            rescue
+              @error_flag = true
+              @error_reason = "[error] can't create log file"
+            end
+
+          else
+            @error_flag = true
+            @error_reason = "[error] can't create log file #{log_file}"
+          end
+
+        else
+
+          begin
+            FileUtils.mkdir_p(path)
+            @log_file_handle = File.open(log_file)
+            @log_file_handle.sync = true
+          rescue
+            @error_flag = true
+            @error_reason = "[error] can't create log file #{log_file}"
+          end
+
+        end
+      end
+    end
   end
 end

data/lib/itz_logger/log_strategy.rb

@@ -4,6 +4,7 @@ module ItzLogger
   class LogStrategy
 
     LOG_TERMINAL = :log_terminal
+    LOG_FILE = :log_file
     LOG_REDIS_MAIL = :log_redis_mail
     LOG_RABBITMQ = :log_rabbitmq
 

data/lib/itz_logger/log_terminal.rb

@@ -18,8 +18,8 @@ module ItzLogger
 
     def write(log_level, message)
       return nil if !ItzLogger::MessageType.equals(@log_level, log_level)
-      message = ItzLogger::Message.new(message, log_level)
-      ItzLogger::Formatter.format(@log_id, message)
+      log_message = ItzLogger::Message.new(message, log_level)
+      puts ItzLogger::Formatter.format(@log_id, log_message)
     end
 
     def log_level=(log_level)

data/lib/itz_logger/logger.rb

@@ -1,5 +1,6 @@
 
 require_relative "./log_terminal"
+require_relative "./log_file"
 require_relative "./log_strategy"
 
 require 'securerandom'
@@ -9,21 +10,21 @@ module ItzLogger
   class Logger
 
     @log_strategy = nil
-    @id = nil
+    @log_id = nil
 
     def initialize(options = {})
 
       log_level = options.fetch(:log_level, ItzLogger::MessageType::INFO)
       log_strategy = options.fetch(:log_strategy, ItzLogger::LogStrategy::LOG_TERMINAL)
-      _log_file = options.fetch(:log_file, "./log/logfile.log")
-      @id = SecureRandom.hex(4)
+      log_file = options.fetch(:log_file, "./log/logfile.log")
+      @log_id = SecureRandom.hex(4)
 
       @log_strategy =
         case log_strategy
         when ItzLogger::LogStrategy::LOG_TERMINAL
-          ItzLogger::LogTerminal.new(log_level, @id)
+          ItzLogger::LogTerminal.new(log_level, @log_id)
         when ItzLogger::LogStrategy::LOG_FILE
-          ItzLogger::LogFile.new(log_level)
+          ItzLogger::LogFile.new(log_level, log_file, @log_id)
         end
     end
 
@@ -56,7 +57,7 @@ module ItzLogger
     end
 
     def id
-      @id
+      @log_id
     end
 
   end

data/lib/itz_logger/version.rb

@@ -1,3 +1,3 @@
 module ItzLogger
-  VERSION = "0.2.10"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: itz_logger
 version: !ruby/object:Gem::Version
-  version: 0.2.10
+  version: 0.3.0
 platform: ruby
 authors:
 - Michael Schaarschmidt
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-23 00:00:00.000000000 Z
+date: 2018-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler