trifle-logger 0.0.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f398296489f07bf076bf0bf6775e57156c0cc6b17afd4eb27df7f5d37fc1b89d
-  data.tar.gz: b2a9f30e51212af4e1d659d754e034f9d1adee1c13a8e7f716dea0c906aa3e1d
+  metadata.gz: e01d80c42124d01841fc6319f7ba1e7bb13729291cc9baf2aba7c32d642095f6
+  data.tar.gz: cf44c0949bf5033174a14b4bb4b7e2f0637af77141a840d919b5598c4292c632
 SHA512:
-  metadata.gz: bc98595231311b0a4ef4eaddbbe7ff7440460415b9d9d56e528b39a8b677c1719dc801483f9bfac7add6a945fe1dbca81bed68ddb456233f22c031e7b9771604
-  data.tar.gz: 2f283dd02cb0cd62f403a7e9ae2f1349f644cb714014da9bcdc20084fe249775dd993c85a0535a771afcb011d6f62017c9ed57502bdc2aba9f58f1f68a8e9c56
+  metadata.gz: f6158bebc28ae7f235a8fcfba2b89b05d37e746fb4f23b89a251564e36e4b400bbf1209d2cd3457646ffff1d12cce53a579f1c43d50264c60b3fab0bf335efd4
+  data.tar.gz: 91a2ac72d053ab794bfb6af8b42996a6e56245d48b952afd86795cb85301a3f424041e640c54c3dadecbd379f2d73f40d9c7d42d4c0e30cd07db401e4d86133f

data/Gemfile.lock

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

data/README.md

@@ -31,8 +31,25 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+It saves you from reading through your standard logger
+
+```ruby
+Trifle::Logger.trace('This is important output')
+now = Trifle::Logger.trace('And it\'s important to know it happened at') do
+  Time.now
+end
+```
+
+To being able to say what happened on 25th January 2021.
+
+```ruby
+[
+  {at: 2021-01-25 00:00:00 +0100, message: 'This is important output', state: :success, head: false, meta: false}
+  {at: 2021-01-25 00:00:00 +0100, message: 'And it\'s important to know it happened ', state: :success, head: false, meta: false}
+  {at: 2021-01-25 00:00:00 +0100, message: '=> 2021-01-25 00:00:00 +0100', state: :success, head: false, meta: true}
+]
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/trifle-logger.
+Bug reports and pull requests are welcome on GitHub at https://github.com/trifle-io/trifle-logger.

data/lib/trifle/logger.rb

@@ -32,7 +32,9 @@ module Trifle
     end
 
     def self.trace(*args, **keywords, &block)
-      return unless tracer
+      if tracer.nil?
+        return block_given? ? yield : nil
+      end
 
       tracer.trace(*args, **keywords, &block)
     end
@@ -43,10 +45,22 @@ module Trifle
       tracer.tag(tag)
     end
 
+    def self.artifact(name, path)
+      return unless tracer
+
+      tracer.artifact(name, path)
+    end
+
     def self.fail!
       return unless tracer
 
       tracer.fail!
     end
+
+    def self.ignore!
+      return unless tracer
+
+      tracer.ignore!
+    end
   end
 end

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

@@ -4,14 +4,16 @@ module Trifle
   module Logger
     module Tracer
       class Hash
-        attr_accessor :key, :meta, :data, :tags, :state
+        attr_accessor :key, :meta, :data, :tags, :artifacts, :state, :ignore
 
         def initialize(key:, meta: nil)
           @key = key
           @meta = meta
           @data = []
           @tags = []
+          @artifacts = []
           @state = :success
+          @ignore = false
           @result_prefix = '=> '
 
           trace("Trifle::Trace has been initialized for #{key}")
@@ -38,14 +40,14 @@ module Trifle
         def dump_message(message, head:, state:)
           @data << {
             at: now, message: message,
-            state: state, head: head, meta: false
+            state: state, head: head, meta: false, media: false
           }
         end
 
         def dump_result(result)
           @data << {
             at: now, message: "#{@result_prefix}#{result.inspect}",
-            state: :success, head: false, meta: true
+            state: :success, head: false, meta: true, media: false
           }
         end
 
@@ -57,6 +59,14 @@ module Trifle
           @tags << tag
         end
 
+        def artifact(name, path)
+          @data << {
+            at: now, message: name,
+            state: :success, head: false, meta: false, media: true
+          }
+          @artifacts << path
+        end
+
         def fail!
           @state = :error
         end
@@ -65,8 +75,12 @@ module Trifle
           @state == :success
         end
 
+        def ignore!
+          @ignore = true
+        end
+
         def wrapup
-          Trifle::Logger.default.on_wrapup(self)
+          Trifle::Logger.default.on_wrapup(self) unless @ignore
         end
       end
     end

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

@@ -8,10 +8,14 @@ module Trifle
           yield if block_given?
         end
 
-        def tag(_resource); end
+        def tag(_tag); end
+
+        def artifact(_name, _path); end
 
         def fail!; end
 
+        def ignore!; end
+
         def wrapup; end
       end
     end

data/lib/trifle/logger/version.rb

@@ -2,6 +2,6 @@
 
 module Trifle
   module Logger
-    VERSION = '0.0.1'
+    VERSION = '0.1.3'
   end
 end

data/trifle-logger.gemspec

@@ -6,11 +6,10 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Jozef Vaclavik"]
   spec.email         = ["jozef@hey.com"]
 
-  spec.summary       = 'Simple logger backed by Redis, Postgres, MongoDB, '\
-                       'or whatever'
+  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.homepage      = 'https://trifle.io'
   spec.required_ruby_version = Gem::Requirement.new(">= 2.6")
 
   spec.metadata["homepage_uri"] = spec.homepage

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trifle-logger
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Jozef Vaclavik
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-08 00:00:00.000000000 Z
+date: 2021-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -135,5 +135,5 @@ requirements: []
 rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
-summary: Simple logger backed by Redis, Postgres, MongoDB, or whatever
+summary: Simple logger backed by Hash
 test_files: []