twiglet 2.2.0 → 2.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 356d8c7fec6c41823029cc36bef1cc49bacae6157342b251e9b57f49dcb8151f
-  data.tar.gz: bd58a67b48daa9bf6108dc78098f46ad0204f98ca600c29bacd713f6cb54ea2e
+  metadata.gz: 566cfbc6b21d6429cbdc6554befd8e4b721af7bde6f44de190e883bdbc2f2c17
+  data.tar.gz: 5202227657bcc217a0d2bac7b523f09887cc8b5f3449a6d94d1670a54bb5d549
 SHA512:
-  metadata.gz: 4bc443482b93b1bba853fbe67605d9b0673830726cf1ef89e941860bc7f832d1efb5f82d5890197ae279b9edf97bf19edf8dc2d8bf61d56d082d6e641f94a245
-  data.tar.gz: 8d5e178fca01957147dca807aab4117958b18514d568440e72f53cfc8931aad62035a71633646776368f4409d9be48ab8598c66aad4347edd59f79a0bfc281ae
+  metadata.gz: e21fdf10a73403d168464f0186f88072549b9770d6b0456848e75dc5a445aecbfd9758f98e3cb1ba83ba2216ce74a8e37ce68a523aa888f35cadc90d53981f34
+  data.tar.gz: 38ed9e4fa093acd5f2e974b3a61bfa1543831320f5b2687b3e35a235048c068dadf06d2d5b7e7078eeb3803f111037d8a5358e19a5b3cf0485b3d5a547c50bc2

data/.github/CODEOWNERS

@@ -1,3 +1,4 @@
 # Add your project owners info here
 # More information: https://help.github.com/articles/about-codeowners/
-* @simplybusiness/application-tooling
+* @simplybusiness/silversmiths 
+

data/.github/workflows/gem-publish.yml

@@ -0,0 +1,26 @@
+name: Publish Ruby Gem
+
+on:
+  push:
+    branches: [ master ]
+
+jobs:
+  build:
+    name: Build and Publish
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby 2.6
+        uses: actions/setup-ruby@v1
+        with:
+          version: 2.6.x
+      - name: Publish to RubyGems
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+        env:
+          GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}

data/.github/workflows/ruby.yml

@@ -3,8 +3,6 @@ name: Ruby CI
 on:
   push:
     branches:
-      - '*'         # matches every branch
-      - '*/*'       # matches every branch containing a single '/'
 
 jobs:
   build:
@@ -30,3 +28,6 @@ jobs:
     - name: Run all tests
       run: bundle exec rake test
       shell: bash
+    - name: Run example_app
+      run: bundle exec ruby example_app.rb
+      shell: bash

data/.gitignore

@@ -1,4 +1,5 @@
 *.gem
+Gemfile.lock
 *.rbc
 /.config
 /coverage/

data/README.md

@@ -22,7 +22,9 @@ A hash can optionally be passed in as a keyword argument for `default_properties
 
 You may also provide an optional `output` keyword argument which should be an object with a `puts` method - like `$stdout`.
 
-Lastly, you can provide another optional keyword argument called `now`, which should be a function returning a `Time` string in ISO8601 format.
+In addition, you can provide another optional keyword argument called `now`, which should be a function returning a `Time` string in ISO8601 format.
+
+Lastly, you may provide the optional keyword argument `level` to initialize the logger with a severity threshold. Alternatively, the threshold can be updated at runtime by calling the `level` instance method.
 
 The defaults for both `output` and `now` should serve for most uses, though you may want to override them for testing as we have done [here](test/logger_test.rb).
 

data/lib/twiglet/formatter.rb

@@ -63,6 +63,7 @@ module Twiglet
         .deep_merge(@default_properties.to_nested)
         .deep_merge(message.to_nested)
         .to_json
+        .concat("\n")
     end
   end
 end

data/lib/twiglet/logger.rb

@@ -3,7 +3,7 @@
 require 'logger'
 require 'time'
 require 'json'
-require 'twiglet/formatter'
+require_relative 'formatter'
 require_relative '../hash_extensions'
 
 module Twiglet
@@ -14,17 +14,19 @@ module Twiglet
       service_name,
       default_properties: {},
       now: -> { Time.now.utc },
-      output: $stdout
+      output: $stdout,
+      level: Logger::DEBUG
     )
       @service_name = service_name
       @now = now
       @output = output
+      @level = level
 
       raise 'Service name is mandatory' \
         unless service_name.is_a?(String) && !service_name.strip.empty?
 
       formatter = Twiglet::Formatter.new(service_name, default_properties: default_properties, now: now)
-      super(output, formatter: formatter)
+      super(output, formatter: formatter, level: level)
     end
 
     def error(message = {}, error = nil, &block)
@@ -45,7 +47,8 @@ module Twiglet
       Logger.new(@service_name,
                  default_properties: default_properties,
                  now: @now,
-                 output: @output)
+                 output: @output,
+                 level: @level)
     end
 
     alias_method :warning, :warn

data/lib/twiglet/version.rb

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

data/test/logger_test.rb

@@ -3,6 +3,7 @@
 require 'minitest/autorun'
 require_relative '../lib/twiglet/logger'
 
+# rubocop:disable Metrics/BlockLength
 describe Twiglet::Logger do
   before do
     @now = -> { Time.utc(2020, 5, 11, 15, 1, 1) }
@@ -130,6 +131,21 @@ describe Twiglet::Logger do
       assert_equal 'Guinea pigs arrived', log[:message]
     end
 
+    it "should log multiple messages properly" do
+      @logger.debug({message: 'hi'})
+      @logger.info({message: 'there'})
+
+      expected_output =
+        '{"@timestamp":"2020-05-11T15:01:01.000Z",'\
+        '"service":{"name":"petshop"},"log":{"level":"debug"},"message":"hi"}'\
+        "\n"\
+        '{"@timestamp":"2020-05-11T15:01:01.000Z",'\
+        '"service":{"name":"petshop"},"log":{"level":"info"},"message":"there"}'\
+        "\n"\
+
+      assert_equal expected_output, @buffer.string
+    end
+
     it 'should be able to convert dotted keys to nested objects' do
       @logger.debug({
                       "trace.id": '1c8a5fb2-fecd-44d8-92a4-449eb2ce4dcb',
@@ -289,6 +305,10 @@ describe Twiglet::Logger do
         assert_equal args[:level], @logger.level
       end
     end
+
+    it 'initializes the logger with the provided level' do
+      assert_equal Logger::WARN, Twiglet::Logger.new('petshop', level: :warn).level
+    end
   end
 
   private
@@ -298,3 +318,4 @@ describe Twiglet::Logger do
     JSON.parse(buffer.read, symbolize_names: true)
   end
 end
+# rubocop:enable Metrics/BlockLength

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twiglet
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.4
 platform: ruby
 authors:
 - Simply Business
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-22 00:00:00.000000000 Z
+date: 2020-07-06 00:00:00.000000000 Z
 dependencies: []
 description: Like a log, only smaller.
 email:
@@ -18,13 +18,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/CODEOWNERS"
+- ".github/workflows/gem-publish.yml"
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".ruby-version"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - RATIONALE.md
 - README.md
@@ -57,7 +57,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Twiglet

data/Gemfile.lock

@@ -1,62 +0,0 @@
-GIT
-  remote: https://github.com/simplybusiness/simplycop.git
-  revision: 02b417277e3ff9eeab34d6b7c30a95a17d876731
-  specs:
-    simplycop (0.5.4)
-      rubocop (~> 0.80.0)
-      rubocop-rails
-      rubocop-rspec
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (6.0.3.1)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    ast (2.4.0)
-    concurrent-ruby (1.1.6)
-    i18n (1.8.2)
-      concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.4)
-    minitest (5.14.0)
-    parallel (1.19.1)
-    parser (2.7.1.3)
-      ast (~> 2.4.0)
-    rack (2.2.2)
-    rainbow (3.0.0)
-    rake (13.0.1)
-    rexml (3.2.4)
-    rubocop (0.80.1)
-      jaro_winkler (~> 1.5.1)
-      parallel (~> 1.10)
-      parser (>= 2.7.0.1)
-      rainbow (>= 2.2.2, < 4.0)
-      rexml
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    rubocop-rails (2.5.2)
-      activesupport
-      rack (>= 1.1)
-      rubocop (>= 0.72.0)
-    rubocop-rspec (1.39.0)
-      rubocop (>= 0.68.1)
-    ruby-progressbar (1.10.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.6.1)
-    zeitwerk (2.3.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  minitest
-  rake
-  simplycop!
-
-BUNDLED WITH
-   2.1.4