testa_logger 0.1.4 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80fa24df1415f3b2f87fb943bfe01ab6d027e4636e54532468b7b732b027a9d5
-  data.tar.gz: d13869b75f2b44dcbdf9bc8a7bb530a895e0e1b1883d626ccb3844ce31d1913b
+  metadata.gz: acf6ac7667563d1af6b7bdc0d5885e1fea8b59edf412aff54a8b1c09d3c94406
+  data.tar.gz: 7030e30e7323f680e1d8ed180c24b485da28ee6fa4560c540df3ddbb14739bb7
 SHA512:
-  metadata.gz: '058bfb47171b98163822fd85b9ecdb1f64a1bac525c8fe579d2d3bd9979d2935bda018054d8d5991964c28824f7acc1fe48b92141446d952be4f745d17dd97ff'
-  data.tar.gz: 92795725d8008739aee95d2c887d499443c871af7bc6742951e830e397b5a051bae25c0c29cc7a59265ff24e72289bf0665328b9ea7611bebc5926104bfb546a
+  metadata.gz: e339844c732ce9f23d20430907fd52c06fa380e83409b0813b5feb6e408af1f6fae5e501b71a99fbde6cb9bea5feafa424afc77e2e7194fa395f52cae36c22ac
+  data.tar.gz: 33d2d5db96d7e6774078b3fa537ba9b1e95d312f3bc6ed6fe7b0dddfe785290d27bac95320e380365b8227edbb2e503b97bf347cce00915ccc4866a8ffeccb59

data/Gemfile.lock

@@ -1,13 +1,12 @@
 PATH
   remote: .
   specs:
-    testa_logger (0.1.4)
+    testa_logger (0.1.7)
       activesupport
       awesome_print
       aws-sdk-s3
       concurrent-ruby
       json
-      ostruct
       securerandom
 
 GEM
@@ -43,7 +42,6 @@ GEM
     jmespath (1.6.1)
     json (2.6.2)
     minitest (5.16.2)
-    ostruct (0.5.5)
     parallel (1.22.1)
     parser (3.1.2.1)
       ast (~> 2.4.1)

data/lib/testa_logger/logger/options.rb

@@ -0,0 +1,78 @@
+module TestaLogger
+  class Logger
+    class Options
+
+      # @return [String,Integer]
+      attr_accessor :shift_age
+
+      # @return [Integer]
+      attr_accessor :level, :tag_length
+
+      # @return [Proc]
+      attr_accessor :default_formatter
+
+      # @return [TrueClass, FalseClass]
+      attr_accessor :live, :persist
+
+      # @return [String, nil]
+      attr_accessor :filepath
+
+      # @return [String]
+      attr_accessor :faye_url, :faye_token
+
+      # @return [Hash]
+      attr_accessor :s3_credentials
+
+      def initialize(app, group, subgroup, options)
+        app_and_groups = format_app_and_groups(app, group, subgroup)
+        @shift_age = "daily"
+        @level = DEBUG
+        @default_formatter = proc do |severity, datetime, _, msg|
+          "#{app_and_groups}[#{datetime.strftime('%Y-%m-%d %H:%M:%S.%L')}]  #{format('%-5.5s', severity)} -- : #{msg}\n"
+        end
+        @live = false
+        @filepath = nil
+        @tag_length = 13
+        @persist = true # requires aws credentials set in env variables
+        @faye_url = ENV["WEB_SOCKET_URL"]
+        @faye_token = ENV["FAYE_TOKEN"]
+        @s3_credentials = {
+          region: ENV["AWS_REGION"],
+          access_key_id: ENV["AWS_ACCESS_KEY_ID"],
+          secret_access_key: ENV["AWS_SECRET_ACCESS_KEY"],
+          bucket_name: ENV["S3_BUCKET_NAME"],
+        }
+
+        handle_user_options(options)
+      end
+
+      def format_app_and_groups(app, group, subgroup)
+        string = "[ #{app} | #{group} "
+        if subgroup.nil?
+          string += "]"
+        else
+          string += "| #{subgroup} ]"
+        end
+        string
+      end
+
+      def handle_user_options(options)
+        options.deep_symbolize_keys!
+        @shift_age = options[:shift_age] unless options[:shift_age].nil?
+        unless options[:level].nil?
+          options[:level] = SEV_LABEL.index(options[:level].to_s.upcase).to_i unless options[:level].is_a?(Integer)
+          @level = options[:level]
+        end
+        @formatter = options[:formatter] unless options[:formatter].nil?
+        @live = options[:live] unless options[:live].nil?
+        @filepath = File.expand_path(options[:filepath]) unless options[:filepath].nil?
+        @tag_length = options[:tag_length] unless options[:tag_length].nil?
+        @persist = options[:persist] unless options[:persist].nil?
+        @faye_url = options[:faye_url] unless options[:faye_url].nil?
+        @faye_token = options[:faye_token] unless options[:faye_token].nil?
+        @s3_credentials = options[:s3_credentials].deep_symbolize_keys if options[:s3_credentials].present?
+      end
+
+    end
+  end
+end

data/lib/testa_logger/logger/persistence.rb

@@ -1,15 +1,13 @@
 module TestaLogger
   class Logger
     module Persistence
-      def self.extended(base)
-        require "aws-sdk-s3"
-        base.init_s3_client
-      end
-
       def init_s3_client
+        require "aws-sdk-s3"
         Aws.config.update(
-          region: options.s3_creds[:region],
-          credentials: Aws::Credentials.new(options.s3_creds[:access_key_id], options.s3_creds[:secret_access_key])
+          region: options.s3_credentials[:region],
+          credentials: Aws::Credentials.new(
+            options.s3_credentials[:access_key_id],
+            options.s3_credentials[:secret_access_key])
         )
         @s3 = Aws::S3::Client.new
         at_exit { persist rescue false }
@@ -47,7 +45,7 @@ module TestaLogger
 
           # stop writing into log file with it is being attached, otherwise checksum integrity will fail.
           response = @s3.put_object(
-            bucket: options.s3_creds[:bucket_name],
+            bucket: options.s3_credentials[:bucket_name],
             key: key,
             body: IO.read(options.filepath)
           )

data/lib/testa_logger/logger.rb

@@ -1,14 +1,18 @@
 require_relative "logger/persistence"
 require_relative "logger/dispatcher"
+require_relative "logger/options"
 
 module TestaLogger
+  # noinspection RubyTooManyMethodsInspection
   class Logger
+    include Persistence
+
     TAG = "TestaLogger"
 
     # @return [String]
     attr_accessor :app, :group, :subgroup
 
-    # @return [OpenStruct]
+    # @return [Options]
     attr_accessor :options
 
     # @return [Thread]
@@ -27,33 +31,17 @@ module TestaLogger
     # An unknown message that should always be logged.
     UNKNOWN = 5
 
+    NO_TAG = "NO-TAG"
+
     def initialize(app, group, subgroup = nil, options = {})
       @app = app
       @group = group
       @subgroup = subgroup
-      handle_options(options)
+      @options = Options.new(app, group, subgroup, options)
       create_log_file
       setup_dispatcher
       start_write_thread
-      self.extend Persistence if @options.persist
-    end
-
-    def handle_options(options)
-      options.deep_symbolize_keys!
-      @options = Logger.default_options
-      @options.shift_age = options[:shift_age] unless options[:shift_age].nil?
-      unless options[:level].nil?
-        options[:level] = SEV_LABEL.index(options[:level].to_s.upcase).to_i unless options[:level].is_a?(Integer)
-        @options.level = options[:level]
-      end
-      @options.formatter = options[:formatter] unless options[:formatter].nil?
-      @options.live = options[:live] unless options[:live].nil?
-      @options.filepath = File.expand_path(options[:filepath]) unless options[:filepath].nil?
-      @options.tag_length = options[:tag_length] unless options[:tag_length].nil?
-      @options.persist = options[:persist] unless options[:persist].nil?
-      @options.faye_url = options[:faye_url] unless options[:faye_url].nil?
-      @options.faye_token = options[:faye_token] unless options[:faye_token].nil?
-      @options.s3_creds = options[:s3_creds].deep_symbolize_keys unless options[:s3_creds].blank?
+      init_s3_client if @options.persist
     end
 
     def create_log_file
@@ -90,33 +78,33 @@ module TestaLogger
       end
     end
 
-    def debug(tag, *args, &block)
+    def debug(tag = NO_TAG, *args, &block)
       add_log_to_queue(DEBUG, tag, args, &block)
     end
 
-    def info(tag, *args, &block)
+    def info(tag = NO_TAG, *args, &block)
       add_log_to_queue(INFO, tag, args, &block)
     end
 
-    def warn(tag, *args, &block)
+    def warn(tag = NO_TAG, *args, &block)
       add_log_to_queue(WARN, tag, args, &block)
     end
 
-    def error(tag, *args, &block)
+    def error(tag = NO_TAG, *args, &block)
       add_log_to_queue(ERROR, tag, args, &block)
     end
 
-    def fatal(tag, *args, &block)
+    def fatal(tag = NO_TAG, *args, &block)
       add_log_to_queue(FATAL, tag, args, &block)
     end
 
-    def unknown(tag, *args, &block)
+    def unknown(tag = NO_TAG, *args, &block)
       add_log_to_queue(UNKNOWN, tag, args, &block)
     end
 
     def level=(severity)
       if severity.is_a?(Integer)
-        @level = severity
+        options.level = severity
       else
         SEV_LABEL.index(severity.to_s.downcase.upcase).to_i
       end
@@ -181,6 +169,14 @@ module TestaLogger
       options.level
     end
 
+    def silence(severity = ERROR, &block)
+      old_level = options.level
+      options.level = severity
+      result = block&.call
+      options.level = old_level
+      result
+    end
+
     class << self
       def default_options
         OpenStruct.new(
@@ -201,12 +197,6 @@ module TestaLogger
           }
         )
       end
-
-      def default_formatter
-        proc do |severity, datetime, _, msg|
-          "[#{datetime.strftime('%Y-%m-%d %H:%M:%S.%L')}]  #{format('%-5.5s', severity)} -- : #{msg}\n"
-        end
-      end
     end
 
     private
@@ -215,6 +205,7 @@ module TestaLogger
       return if level < options.level
 
       time = Time.now
+      tag = extract_tag(tag, args)
       text = create_log_string(tag, args, &block)
       formatted_severity = format_severity(level)
       formatted_text = format_message(formatted_severity, time, "", text)
@@ -223,16 +214,21 @@ module TestaLogger
       @dispatcher.push(level, time, tag, formatted_text) if options.live
     end
 
-    def create_log_string(tag, args, &block)
+    # rails and other applications do not use tags,
+    # therefore, if only 1 argument is provided, that means that the message is in the tag variable
+    # then args array is empty.
+    def extract_tag(tag, args)
       if args.count.zero?
-        if block.nil?
-          "[NO-TAG]: #{tag}"
-        else
-          "[#{padded_tag(tag)}]: #{args_to_string(block.call)}"
-        end
-      else
-        "[#{padded_tag(tag)}]: #{args_to_string(args)}"
+        # if no additional arguments is given, message is in tag variable
+        tag = NO_TAG
+        args.unshift(tag)
       end
+      tag
+    end
+
+    def create_log_string(tag, args, &block)
+      args.push(block.call) if block
+      "[#{padded_tag(tag)}]: #{args_to_string(args.compact)}"
     end
 
     def padded_tag(tag)
@@ -245,7 +241,7 @@ module TestaLogger
         if arg.instance_of?(String)
           arg
         else
-          arg.ai(limit: 1000, plain: true)
+          arg.ai(limit: 1000, plain: false)
         end
       end.join("\n")
     end

data/lib/testa_logger/version.rb

@@ -1,3 +1,3 @@
 module TestaLogger
-  VERSION = "0.1.4"
+  VERSION = "0.1.7"
 end

data/lib/testa_logger.rb

@@ -4,7 +4,6 @@ require_relative "testa_logger/logger"
 require_relative "testa_logger/io_persistence_error"
 require "active_support"
 require "active_support/core_ext/hash"
-require "ostruct"
 require "awesome_print"
 require "concurrent-ruby"
 require "json"

data/logger.iml

@@ -22,7 +22,6 @@
     <orderEntry type="library" scope="PROVIDED" name="jmespath (v1.6.1, RVM: ruby-2.7.6) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="json (v2.6.2, RVM: ruby-2.7.6) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="minitest (v5.16.2, RVM: ruby-2.7.6) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="ostruct (v0.5.5, RVM: ruby-2.7.6) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="parallel (v1.22.1, RVM: ruby-2.7.6) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="parser (v3.1.2.1, RVM: ruby-2.7.6) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rack (v2.2.4, RVM: ruby-2.7.6) [gem]" level="application" />
@@ -43,21 +42,21 @@
     <option name="myRootTask">
       <RakeTaskImpl id="rake">
         <subtasks>
-          <RakeTaskImpl description="Build testa_logger-0.1.1.gem into the pkg directory" fullCommand="build" id="build" />
+          <RakeTaskImpl description="Build testa_logger-0.1.6.gem into the pkg directory" fullCommand="build" id="build" />
           <RakeTaskImpl id="build">
             <subtasks>
-              <RakeTaskImpl description="Generate SHA512 checksum if testa_logger-0.1.1.gem into the checksums directory" fullCommand="build:checksum" id="checksum" />
+              <RakeTaskImpl description="Generate SHA512 checksum if testa_logger-0.1.6.gem into the checksums directory" fullCommand="build:checksum" id="checksum" />
             </subtasks>
           </RakeTaskImpl>
           <RakeTaskImpl description="Remove any temporary products" fullCommand="clean" id="clean" />
           <RakeTaskImpl description="Remove any generated files" fullCommand="clobber" id="clobber" />
-          <RakeTaskImpl description="Build and install testa_logger-0.1.1.gem into system gems" fullCommand="install" id="install" />
+          <RakeTaskImpl description="Build and install testa_logger-0.1.6.gem into system gems" fullCommand="install" id="install" />
           <RakeTaskImpl id="install">
             <subtasks>
-              <RakeTaskImpl description="Build and install testa_logger-0.1.1.gem into system gems without network access" fullCommand="install:local" id="local" />
+              <RakeTaskImpl description="Build and install testa_logger-0.1.6.gem into system gems without network access" fullCommand="install:local" id="local" />
             </subtasks>
           </RakeTaskImpl>
-          <RakeTaskImpl description="Create tag v0.1.1 and build and push testa_logger-0.1.1.gem to rubygems.org" fullCommand="release[remote]" id="release[remote]" />
+          <RakeTaskImpl description="Create tag v0.1.6 and build and push testa_logger-0.1.6.gem to rubygems.org" fullCommand="release[remote]" id="release[remote]" />
           <RakeTaskImpl description="Run tests" fullCommand="test" id="test" />
           <RakeTaskImpl description="" fullCommand="default" id="default" />
           <RakeTaskImpl description="" fullCommand="release" id="release" />

data/testa_logger.gemspec

@@ -23,7 +23,6 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "aws-sdk-s3"
   spec.add_runtime_dependency "concurrent-ruby"
   spec.add_runtime_dependency "json"
-  spec.add_runtime_dependency "ostruct"
   spec.add_runtime_dependency "securerandom"
 
   # Specify which files should be added to the gem when it is released.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: testa_logger
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.7
 platform: ruby
 authors:
 - karlo.razumovic
@@ -80,20 +80,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: ostruct
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: securerandom
   requirement: !ruby/object:Gem::Requirement
@@ -132,6 +118,7 @@ files:
 - lib/testa_logger/log_device/period.rb
 - lib/testa_logger/logger.rb
 - lib/testa_logger/logger/dispatcher.rb
+- lib/testa_logger/logger/options.rb
 - lib/testa_logger/logger/persistence.rb
 - lib/testa_logger/version.rb
 - logger.iml