trifle-logger 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6df3b5ac2c9be39829e661fb9793383abdb61999e3fdec1a749f8127736d9fd
-  data.tar.gz: 45645936044b84f02911c731ae346c402ca586368ebe18e1a21705ba5df2bdc7
+  metadata.gz: 3ddb2f2292c349fdd346a0cf28889e4e2b6d0e6ae1afd81ca5a490724644147b
+  data.tar.gz: c2e6ad94f1fbc2f2b35e2620594030daed6d64db5b0319c68c4d4ed6be22bd33
 SHA512:
-  metadata.gz: b38fa3326d9e49f32a0831556775a47df90082837ce5764e5388b2adce820f4b55e198a8660c899662ab3adff503b8434b2253699930a377785a65cced634079
-  data.tar.gz: 14e02a5990b21aed720a7ffc348e71d67cc21e1080069628c2299cee2793260ab8afc002d78f4c1557dec8b82561d5c1e8d8fa6554398e4ee76040a404979203
+  metadata.gz: fdc7dd705f38e2876fde06657c189e70abf4d4f5dffa6698862e0d9f2967592a1eb84c6660912da5ab609e1b055ec43ae1d477e928a6349f7295e7b571119a01
+  data.tar.gz: b1f8a8398a4b9b732a4b1378875866468e5115412cca3b0d93999cce7d00ac56fa36819fe2bc0987f5f29ea7945e4d0a88b95ccf0e976260ed7b4c21e9eea94a

data/.github/workflows/ruby.yml

@@ -9,29 +9,28 @@ name: Ruby
 
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
-    branches: [ main ]
+    branches: [main]
 
 jobs:
   test:
-
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.6', '2.7', '3.0']
+        ruby-version: ["3.0"]
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
-    # change this to (see https://github.com/ruby/setup-ruby#versioning):
-    # uses: ruby/setup-ruby@v1
-      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-    - name: Rspec
-      run: bundle exec rspec
-    - name: Rubocop
-      run: bundle exec rubocop
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+        # change this to (see https://github.com/ruby/setup-ruby#versioning):
+        # uses: ruby/setup-ruby@v1
+        uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Rspec
+        run: bundle exec rspec
+      - name: Rubocop
+        run: bundle exec rubocop

data/CHANGELOG.md

@@ -0,0 +1,26 @@
+## [Unreleased]
+
+## [0.3.1] - 2022-01-11
+
+- Feat: Allow reference to be passed into the Tracer directly
+
+## [0.3.0] - 2022-01-11
+
+- Feat: Rename tracer_klass to tracer_class and use it consistently through middlewares
+
+## [0.2.2] - 2022-01-11
+
+- Feat: Allow tracer to accept custom configuration
+
+## [0.2.1] - 2021-06-11
+
+- Chore: Update license
+- Chore: Drop ruby 2.x
+
+## [0.2.0] - 2021-06-1
+
+- Feat: Add callbacks
+
+## [0.1.x] - 2021-03-29
+
+- Chore: Bunch of initial commits :)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    trifle-logger (0.2.0)
+    trifle-logger (0.3.1)
 
 GEM
   remote: https://rubygems.org/

data/lib/trifle/logger/configuration.rb

@@ -3,10 +3,10 @@
 module Trifle
   module Logger
     class Configuration
-      attr_accessor :tracer_klass, :callbacks, :bump_every
+      attr_accessor :tracer_class, :callbacks, :bump_every
 
       def initialize
-        @tracer_klass = Trifle::Logger::Tracer::Hash
+        @tracer_class = Trifle::Logger::Tracer::Hash
         @callbacks = { liftoff: [], bump: [], wrapup: [] }
         @bump_every = 15.seconds
       end

data/lib/trifle/logger/middleware/rack.rb

@@ -9,7 +9,8 @@ module Trifle
         end
 
         def call(env)
-          # Trifle::Logger.tracer = Trifle::Logger::Tracer::Hash.new
+          # TODO: set up key
+          # Trifle::Logger.tracer = Trifle::Logger.default.tracer_class.new
           @status, @headers, @response = @app.call(env)
         rescue => e # rubocop:disable Style/RescueStandardError
           Trifle::Logger.tracer&.trace("Exception: #{e}", state: :error)

data/lib/trifle/logger/middleware/rails_controller.rb

@@ -17,7 +17,7 @@ module Trifle
 
         module InstanceMethods
           def with_trifle_logger
-            Trifle::Logger.tracer = Trifle::Logger::Tracer::Hash.new(
+            Trifle::Logger.tracer = Trifle::Logger.default.tracer_class.new(
               key: trace_key, meta: trace_meta
             )
             yield

data/lib/trifle/logger/middleware/sidekiq.rb

@@ -18,7 +18,7 @@ module Trifle
         def tracer_for(job:)
           return nil unless job['logger_key']
 
-          Trifle::Logger.default.tracer_klass.new(
+          Trifle::Logger.default.tracer_class.new(
             key: job['logger_key'], meta: job['args']
           )
         end

data/lib/trifle/logger/tracer/hash.rb

@@ -6,18 +6,27 @@ module Trifle
       class Hash
         attr_accessor :key, :meta, :data, :tags, :artifacts, :state, :ignore, :reference
 
-        def initialize(key:, meta: nil)
+        def initialize(key:, reference: nil, meta: nil, config: nil)
           @key = key
           @meta = meta
+          @config = config
+          set_defaults!
+
+          trace("Tracer has been initialized for #{key}")
+          @reference = reference || liftoff.first
+        end
+
+        def set_defaults!
           @data = []
           @tags = []
           @artifacts = []
           @state = :running
           @ignore = false
           @result_prefix = '=> '
+        end
 
-          trace("Trifle::Trace has been initialized for #{key}")
-          @reference = liftoff.first
+        def config
+          @config || Trifle::Logger.default
         end
 
         def keys
@@ -99,19 +108,19 @@ module Trifle
 
         def liftoff
           @bumped_at = now
-          Trifle::Logger.default.on_liftoff(self)
+          config.on_liftoff(self)
         end
 
         def bump
-          return unless @bumped_at && @bumped_at <= now - Trifle::Logger.default.bump_every
+          return unless @bumped_at && @bumped_at <= now - config.bump_every
 
           @bumped_at = now
-          Trifle::Logger.default.on_bump(self)
+          config.on_bump(self)
         end
 
         def wrapup
           success! if running?
-          Trifle::Logger.default.on_wrapup(self)
+          config.on_wrapup(self)
         end
       end
     end

data/lib/trifle/logger/version.rb

@@ -2,6 +2,6 @@
 
 module Trifle
   module Logger
-    VERSION = '0.2.0'
+    VERSION = '0.3.1'
   end
 end

data/trifle-logger.gemspec

@@ -1,28 +1,30 @@
 require_relative 'lib/trifle/logger/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "trifle-logger"
+  spec.name          = 'trifle-logger'
   spec.version       = Trifle::Logger::VERSION
-  spec.authors       = ["Jozef Vaclavik"]
-  spec.email         = ["jozef@hey.com"]
+  spec.authors       = ['Jozef Vaclavik']
+  spec.email         = ['jozef@hey.com']
 
   spec.summary       = 'Simple logger backed by Hash'
   spec.description   = 'Trifle::Logger is a way too simple timeline logger '\
                        'that helps you track custom outputs.'
   spec.homepage      = 'https://trifle.io'
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.6")
+  spec.licenses      = ['MIT']
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6')
 
-  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/trifle-io/trifle-logger'
+  spec.metadata['changelog_uri'] = 'https://github.com/trifle-io/trifle-logger/blob/main/CHANGELOG.md'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
   spec.add_development_dependency('bundler', '~> 2.1')
   spec.add_development_dependency('byebug', '>= 0')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trifle-logger
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Jozef Vaclavik
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-01 00:00:00.000000000 Z
+date: 2022-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -96,6 +96,7 @@ files:
 - ".rubocop.yml"
 - ".ruby-version"
 - ".tool-versions"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -113,10 +114,12 @@ files:
 - lib/trifle/logger/version.rb
 - trifle-logger.gemspec
 homepage: https://trifle.io
-licenses: []
+licenses:
+- MIT
 metadata:
   homepage_uri: https://trifle.io
   source_code_uri: https://github.com/trifle-io/trifle-logger
+  changelog_uri: https://github.com/trifle-io/trifle-logger/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths: