twiglet 2.4.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9eac4966bd34b02389637e38100f843f842fc115bad74d9480dc5b87a1dcad2
-  data.tar.gz: 3fb45d8d76a99246f4a215e42fa15dfa52b3f8f7cd8821edf8590653a114514c
+  metadata.gz: a3d278f5c152781abb779db8f28f7297f52c4d76db5358a78f13e784475f4851
+  data.tar.gz: bd8e3ae4b640ade3cb57489216cbdc7aec383f5535946c328352cc350057474c
 SHA512:
-  metadata.gz: 276587b79e63ad48de407c26ad113e64c6fb2819c991622f3f6ea50abe583853991a7f32ceafa4fc2008dff2a4ff4216766c53d0910ff8538ad26430474573f5
-  data.tar.gz: a963f5d218c7c8c327400245b122f83873201191c01828efa125418ea6e0b08d21c86a53ab791aedc9fb900a8642cb0e1130a835516388e922da6b00ccf83880
+  metadata.gz: ef689b0df5314da2ddb0e5ed95a724d25f0f5c93f2f9647478d7f9eb60acb60b7b712c731b4118087d28f32685cc91bdb032f73e7438a822ad8fc7be7e742dd4
+  data.tar.gz: 2bc88df6d4f6a7cd4c0304eeafa199384054c58cc6f39629daec456605c72397302a49380f8bf681645654b030bc59b7d458ac45ca42091558711ea9980b6580

data/.github/workflows/ruby.yml

@@ -16,7 +16,7 @@ jobs:
 
     strategy:
       matrix:
-        ruby-version: [2.5, 2.6, 2.7]
+        ruby-version: [2.6, 2.7]
 
     steps:
     - uses: actions/checkout@v2

data/.rubocop.yml

@@ -2,7 +2,7 @@ inherit_gem:
   simplycop: .simplycop.yml
 
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.6
   Rails:
     Enabled: false
   Documentation:

data/Gemfile

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 source 'https://rubygems.org'
-gem 'simplycop', git: 'https://github.com/simplybusiness/simplycop.git'
 group :development, :test do
   gem 'minitest'
   gem 'rake'
   gem 'simplecov', '0.17.1'
+  gem 'simplycop'
 end

data/example_app.rb

@@ -8,27 +8,27 @@ logger = Twiglet::Logger.new('petshop')
 
 # Start our petshop
 logger.info({
-              event: {
-                action: 'startup'
-              },
-              message: "Ready to go, listening on port #{PORT}",
-              server: {
-                port: PORT
-              }
-            })
+  event: {
+    action: 'startup'
+  },
+  message: "Ready to go, listening on port #{PORT}",
+  server: {
+    port: PORT
+  }
+})
 
 # Use text logging
 logger.info("Ready to go, listening on port #{PORT}")
 #
 # We get a request
 request_logger = logger.with({
-                               event: {
-                                 action: 'HTTP request'
-                               },
-                               trace: {
-                                 id: '126bb6fa-28a2-470f-b013-eefbf9182b2d'
-                               }
-                             })
+  event: {
+    action: 'HTTP request'
+  },
+  trace: {
+    id: '126bb6fa-28a2-470f-b013-eefbf9182b2d'
+  }
+})
 
 # Oh noes!
 db_err = StandardError.new('Connection timed-out')
@@ -37,16 +37,16 @@ request_logger.error({ message: 'DB connection failed.' }, db_err) if db_err
 
 # We return an error to the requester
 request_logger.info({
-                      message: 'Internal Server Error',
-                      http: {
-                        request: {
-                          method: 'get'
-                        },
-                        response: {
-                          status_code: 500
-                        }
-                      }
-                    })
+  message: 'Internal Server Error',
+  http: {
+    request: {
+      method: 'get'
+    },
+    response: {
+      status_code: 500
+    }
+  }
+})
 
 # Logging with an empty message is an anti-pattern and is therefore forbidden
 # Both of the following lines would throw an error

data/lib/hash_extensions.rb

@@ -22,8 +22,8 @@ module HashExtensions
 
   def build_nested_object(key, val)
     key.to_s
-      .split('.')
-      .reverse
-      .reduce(val) { |nested, key_part| Hash[key_part.to_sym, nested] }
+       .split('.')
+       .reverse
+       .reduce(val) { |nested, key_part| Hash[key_part.to_sym, nested] }
   end
 end

data/lib/twiglet/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Twiglet
-  VERSION = '2.4.0'
+  VERSION = '3.0.0'
 end

data/test/logger_test.rb

@@ -3,6 +3,16 @@
 require 'minitest/autorun'
 require_relative '../lib/twiglet/logger'
 
+LEVELS = [
+  { method: :debug, level: 'debug' },
+  { method: :info, level: 'info' },
+  { method: :warning, level: 'warn' },
+  { method: :warn, level: 'warn' },
+  { method: :critical, level: 'fatal' },
+  { method: :fatal, level: 'fatal' },
+  { method: :error, level: 'error' }
+].freeze
+
 # rubocop:disable Metrics/BlockLength
 describe Twiglet::Logger do
   before do
@@ -13,16 +23,6 @@ describe Twiglet::Logger do
                                   output: @buffer)
   end
 
-  LEVELS = [
-    { method: :debug, level: 'debug' },
-    { method: :info, level: 'info' },
-    { method: :warning, level: 'warn' },
-    { method: :warn, level: 'warn' },
-    { method: :critical, level: 'fatal' },
-    { method: :fatal, level: 'fatal' },
-    { method: :error, level: 'error' }
-  ].freeze
-
   it 'should throw an error with an empty service name' do
     assert_raises RuntimeError do
       Twiglet::Logger.new('  ')
@@ -105,16 +105,16 @@ describe Twiglet::Logger do
     it "should be able to add properties with '.with'" do
       # Let's add some context to this customer journey
       purchase_logger = @logger.with({
-                                       trace: {id: '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb'},
-                                       customer: {full_name: 'Freda Bloggs'},
-                                       event: {action: 'pet purchase'}
-                                     })
+        trace: {id: '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb'},
+        customer: {full_name: 'Freda Bloggs'},
+        event: {action: 'pet purchase'}
+      })
 
       # do stuff
       purchase_logger.info({
-                             message: 'customer bought a dog',
-                             pet: {name: 'Barker', species: 'dog', breed: 'Bitsa'}
-                           })
+        message: 'customer bought a dog',
+        pet: {name: 'Barker', species: 'dog', breed: 'Bitsa'}
+      })
 
       log = read_json @buffer
 
@@ -285,12 +285,12 @@ describe Twiglet::Logger do
   describe 'dotted keys' do
     it 'should be able to convert dotted keys to nested objects' do
       @logger.debug({
-                      "trace.id": '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb',
-                      message: 'customer bought a dog',
-                      "pet.name": 'Barker',
-                      "pet.species": 'dog',
-                      "pet.breed": 'Bitsa'
-                    })
+        "trace.id": '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb',
+        message: 'customer bought a dog',
+        "pet.name": 'Barker',
+        "pet.species": 'dog',
+        "pet.breed": 'Bitsa'
+      })
       log = read_json(@buffer)
 
       assert_equal '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb', log[:trace][:id]
@@ -302,11 +302,11 @@ describe Twiglet::Logger do
 
     it 'should be able to mix dotted keys and nested objects' do
       @logger.debug({
-                      "trace.id": '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb',
-                      message: 'customer bought a dog',
-                      pet: {name: 'Barker', breed: 'Bitsa'},
-                      "pet.species": 'dog'
-                    })
+        "trace.id": '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb',
+        message: 'customer bought a dog',
+        pet: {name: 'Barker', breed: 'Bitsa'},
+        "pet.species": 'dog'
+      })
       log = read_json(@buffer)
 
       assert_equal '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb', log[:trace][:id]

data/twiglet.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |gem|
   gem.test_files            = `git ls-files -- {test}/*`.split("\n")
 
   gem.require_paths         = ['lib']
-  gem.required_ruby_version = '>= 2.5'
+  gem.required_ruby_version = '>= 2.6'
 
   gem.license               = 'Copyright SimplyBusiness'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twiglet
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Simply Business
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-04 00:00:00.000000000 Z
+date: 2020-12-22 00:00:00.000000000 Z
 dependencies: []
 description: Like a log, only smaller.
 email:
@@ -59,14 +59,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Twiglet