trifle-logger 0.1.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a70cfb4b0863b2ac9fff7a44addd56264090c463ba53504cbcb2534ac74c09e
-  data.tar.gz: 759fb8c95b1df65a8571290809e9c6ffdd23bd6f835d722613a87e8da3900402
+  metadata.gz: a66e51428a8489d5edc94ab57d8350199d5bb17ca69478dc7075910d82c5b51c
+  data.tar.gz: cf8fe7cda52c6ff20b50152b83d9f42719d140b8e10f94b415532ffe289c652b
 SHA512:
-  metadata.gz: 7fd33b88c7a6c4ba9b87802af9eddbbe9884bef360d2b5c0a173b4ae3e830a679197adbea94e12ca0b6984e05949d745bf4b155db04ec1a4324cb6bdd8468aa7
-  data.tar.gz: 40e67bc2924dc8ebc424cc54415970683b4edd38d73eb373f97d4f9854fd3febeb75399b17f8d1f920dd062c0525506213568e8ec9a5beaabcf57445d80c1882
+  metadata.gz: be7209a804399fa1b02a8c6dd13e20415aa843b2784048904328100102dca07e9855386d1ba7507151e25253fc5a7cbe8775a625be2bd6e717d5f95c944a9003
+  data.tar.gz: 5a536d5d6c741719eb6b5eb20e989747f873815f59edac421c6ff667a9ab3190f4e7314f8fcbe244ce613e751b865726661ef5cece265fb61746752db1ae9804

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,22 @@
+## [Unreleased]
+
+## [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.1.4)
+    trifle-logger (0.3.0)
 
 GEM
   remote: https://rubygems.org/

data/lib/trifle/logger/configuration.rb

@@ -3,17 +3,28 @@
 module Trifle
   module Logger
     class Configuration
-      attr_accessor :tracer_klass, :callbacks
+      attr_accessor :tracer_class, :callbacks, :bump_every
 
       def initialize
-        @tracer_klass = Trifle::Logger::Tracer::Hash
-        @callbacks = {
-          wrapup: []
-        }
+        @tracer_class = Trifle::Logger::Tracer::Hash
+        @callbacks = { liftoff: [], bump: [], wrapup: [] }
+        @bump_every = 15.seconds
+      end
+
+      def on_liftoff(tracer)
+        @callbacks.fetch(:liftoff, []).map do |c|
+          c.call(tracer)
+        end
+      end
+
+      def on_bump(tracer)
+        @callbacks.fetch(:bump, []).map do |c|
+          c.call(tracer)
+        end
       end
 
       def on_wrapup(tracer)
-        @callbacks.fetch(:wrapup, []).each do |c|
+        @callbacks.fetch(:wrapup, []).map do |c|
           c.call(tracer)
         end
       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

@@ -4,19 +4,29 @@ module Trifle
   module Logger
     module Tracer
       class Hash
-        attr_accessor :key, :meta, :data, :tags, :artifacts, :state, :ignore
+        attr_accessor :key, :meta, :data, :tags, :artifacts, :state, :ignore, :reference
 
-        def initialize(key:, meta: nil)
+        def initialize(key:, meta: nil, config: nil)
           @key = key
           @meta = meta
+          @config = config
+          set_defaults!
+
+          trace("Tracer has been initialized for #{key}")
+          @reference = liftoff.first
+        end
+
+        def set_defaults!
           @data = []
           @tags = []
           @artifacts = []
-          @state = :success
+          @state = :running
           @ignore = false
           @result_prefix = '=> '
+        end
 
-          trace("Trifle::Trace has been initialized for #{key}")
+        def config
+          @config || Trifle::Logger.default
         end
 
         def keys
@@ -24,7 +34,7 @@ module Trifle
           parts.count.times.map { |i| parts[0..i].join('/') }
         end
 
-        def trace(message, state: :success, head: false)
+        def trace(message, state: :success, head: false) # rubocop:disable Metrics/MethodLength
           result = yield if block_given?
         rescue => e # rubocop:disable Style/RescueStandardError
           raise e
@@ -34,6 +44,7 @@ module Trifle
             head: head, state: block_given? && result.nil? || e ? :error : state
           )
           dump_result(result) if block_given?
+          bump
           result
         end
 
@@ -57,6 +68,8 @@ module Trifle
 
         def tag(tag)
           @tags << tag
+          bump
+          tag
         end
 
         def artifact(name, path)
@@ -65,6 +78,8 @@ module Trifle
             state: :success, head: false, meta: false, media: true
           }
           @artifacts << path
+          bump
+          path
         end
 
         def fail!
@@ -75,16 +90,37 @@ module Trifle
           @state = :warning
         end
 
+        def success!
+          @state = :success
+        end
+
         def success?
           @state == :success
         end
 
+        def running?
+          @state == :running
+        end
+
         def ignore!
           @ignore = true
         end
 
+        def liftoff
+          @bumped_at = now
+          config.on_liftoff(self)
+        end
+
+        def bump
+          return unless @bumped_at && @bumped_at <= now - config.bump_every
+
+          @bumped_at = now
+          config.on_bump(self)
+        end
+
         def wrapup
-          Trifle::Logger.default.on_wrapup(self) unless @ignore
+          success! if running?
+          config.on_wrapup(self)
         end
       end
     end

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

@@ -18,6 +18,10 @@ module Trifle
 
         def ignore!; end
 
+        def liftoff; end
+
+        def bump; end
+
         def wrapup; end
       end
     end

data/lib/trifle/logger/version.rb

@@ -2,6 +2,6 @@
 
 module Trifle
   module Logger
-    VERSION = '0.1.4'
+    VERSION = '0.3.0'
   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.1.4
+  version: 0.3.0
 platform: ruby
 authors:
 - Jozef Vaclavik
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-18 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: