trifle-logger 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f398296489f07bf076bf0bf6775e57156c0cc6b17afd4eb27df7f5d37fc1b89d
+  data.tar.gz: b2a9f30e51212af4e1d659d754e034f9d1adee1c13a8e7f716dea0c906aa3e1d
+SHA512:
+  metadata.gz: bc98595231311b0a4ef4eaddbbe7ff7440460415b9d9d56e528b39a8b677c1719dc801483f9bfac7add6a945fe1dbca81bed68ddb456233f22c031e7b9771604
+  data.tar.gz: 2f283dd02cb0cd62f403a7e9ae2f1349f644cb714014da9bcdc20084fe249775dd993c85a0535a771afcb011d6f62017c9ed57502bdc2aba9f58f1f68a8e9c56

data/.github/workflows/ruby.yml

@@ -0,0 +1,37 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '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

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+/.byebug_history

data/.gitpod.yml

@@ -0,0 +1,18 @@
+image:
+  file: .gitpod/Dockerfile
+tasks:
+  - init: bundle install
+    command: ./bin/console
+  - command: redis-server
+github:
+  prebuilds:
+    # enable for the master/default branch (defaults to true)
+    master: true
+    # enable for all branches in this repo (defaults to false)
+    branches: false
+    # enable for pull requests coming from this repo (defaults to true)
+    pullRequests: true
+    # add a check to pull requests (defaults to true)
+    addCheck: true
+    # add a "Review in Gitpod" button as a comment to pull requests (defaults to false)
+    addComment: false

data/.gitpod/Dockerfile

@@ -0,0 +1 @@
+FROM trifle/gitpod:0.1.0

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,15 @@
+inherit_mode:
+  merge:
+    - Exclude
+
+AllCops:
+  TargetRubyVersion: '2.6'
+  Exclude:
+    - 'bin/**/*'
+    - 'Rakefile'
+    - 'spec/**/*'
+    - 'Gemfile'
+    - trifle-logger.gemspec
+
+Style/Documentation:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.0.0

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.0.0

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in trifle-logger.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    trifle-logger (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    byebug (11.1.3)
+    diff-lcs (1.4.4)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (2.0.3)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.0.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+  x86_64-darwin-20
+
+DEPENDENCIES
+  bundler (~> 2.1)
+  byebug
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rubocop (= 1.0.0)
+  trifle-logger!
+
+BUNDLED WITH
+   2.2.3

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Jozef Vaclavik
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+# Trifle::Logger
+
+[![Gem Version](https://badge.fury.io/rb/trifle-logger.svg)](https://badge.fury.io/rb/trifle-logger)
+![Ruby](https://github.com/trifle-io/trifle-logger/workflows/Ruby/badge.svg?branch=main)
+[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/trifle-io/trifle-logger)
+
+
+Simple logger backed by Redis, Postgres, MongoDB, or whatever.
+
+`Trifle::Logger` is a way too simple timeline logger that helps you track custom outputs. Ideal for any code from blackbox category (aka background-job-that-talks-to-API-and-works-every-time-when-you-run-it-manually-but-never-when-in-production type of jobs)
+
+## Documentation
+
+You can find guides and documentation at https://trifle.io/docs/logger
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'trifle-logger'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install trifle-logger
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/trifle-logger.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "trifle/logger"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/trifle/logger.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'trifle/logger/configuration'
+require 'trifle/logger/tracer/hash'
+require 'trifle/logger/tracer/null'
+require 'trifle/logger/middleware/rack'
+require 'trifle/logger/middleware/rails_controller'
+require 'trifle/logger/middleware/sidekiq'
+require 'trifle/logger/version'
+
+module Trifle
+  module Logger
+    class Error < StandardError; end
+    # Your code goes here...
+
+    def self.default
+      @default ||= Configuration.new
+    end
+
+    def self.configure
+      yield(default)
+
+      default
+    end
+
+    def self.tracer=(tracer)
+      Thread.current[:trifle_tracer] = tracer
+    end
+
+    def self.tracer
+      Thread.current[:trifle_tracer]
+    end
+
+    def self.trace(*args, **keywords, &block)
+      return unless tracer
+
+      tracer.trace(*args, **keywords, &block)
+    end
+
+    def self.tag(tag)
+      return unless tracer
+
+      tracer.tag(tag)
+    end
+
+    def self.fail!
+      return unless tracer
+
+      tracer.fail!
+    end
+  end
+end

data/lib/trifle/logger/configuration.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Trifle
+  module Logger
+    class Configuration
+      attr_accessor :tracer_klass, :callbacks
+
+      def initialize
+        @tracer_klass = Trifle::Logger::Tracer::Hash
+        @callbacks = {
+          wrapup: []
+        }
+      end
+
+      def on_wrapup(tracer)
+        @callbacks.fetch(:wrapup, []).each do |c|
+          c.call(tracer)
+        end
+      end
+
+      def on(event, &block)
+        @callbacks[event] << block
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Trifle
+  module Logger
+    module Middleware
+      class Rack
+        def initialize(app)
+          @app = app
+        end
+
+        def call(env)
+          # Trifle::Logger.tracer = Trifle::Logger::Tracer::Hash.new
+          @status, @headers, @response = @app.call(env)
+        rescue => e # rubocop:disable Style/RescueStandardError
+          Trifle::Logger.tracer&.trace("Exception: #{e}", state: :error)
+          Trifle::Logger.tracer&.fail!
+          raise e
+        ensure
+          Trifle::Logger.tracer&.wrapup
+          [@status, @headers, @response]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Trifle
+  module Logger
+    module Middleware
+      module RailsController
+        def self.included(base)
+          base.extend ClassMethods
+          base.include InstanceMethods
+        end
+
+        module ClassMethods
+          def with_trifle_logger(options = {})
+            around_action :with_trifle_logger, options
+          end
+        end
+
+        module InstanceMethods
+          def with_trifle_logger
+            Trifle::Logger.tracer = Trifle::Logger::Tracer::Hash.new(
+              key: trace_key, meta: trace_meta
+            )
+            yield
+          rescue => e # rubocop:disable Style/RescueStandardError
+            Trifle::Logger.tracer.trace("Exception: #{e}", state: :error)
+            Trifle::Logger.tracer.fail!
+            raise e
+          ensure
+            Trifle::Logger.tracer.wrapup
+          end
+
+          def trace_key
+            "#{params[:controller]}/#{params[:action]}"
+          end
+
+          def trace_meta
+            [params[:id]].compact
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Trifle
+  module Logger
+    module Middleware
+      class Sidekiq
+        def call(_worker, job, _queue)
+          Trifle::Logger.tracer = tracer_for(job: job)
+          yield
+        rescue => e # rubocop:disable Style/RescueStandardError
+          Trifle::Logger.tracer&.trace("Exception: #{e}", state: :error)
+          Trifle::Logger.tracer&.fail!
+          raise e
+        ensure
+          Trifle::Logger.tracer&.wrapup
+        end
+
+        def tracer_for(job:)
+          return nil unless job['logger_key']
+
+          Trifle::Logger.default.tracer_klass.new(
+            key: job['logger_key'], meta: job['args']
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Trifle
+  module Logger
+    module Tracer
+      class Hash
+        attr_accessor :key, :meta, :data, :tags, :state
+
+        def initialize(key:, meta: nil)
+          @key = key
+          @meta = meta
+          @data = []
+          @tags = []
+          @state = :success
+          @result_prefix = '=> '
+
+          trace("Trifle::Trace has been initialized for #{key}")
+        end
+
+        def keys
+          parts = key.split('/')
+          parts.count.times.map { |i| parts[0..i].join('/') }
+        end
+
+        def trace(message, state: :success, head: false)
+          result = yield if block_given?
+        rescue => e # rubocop:disable Style/RescueStandardError
+          raise e
+        ensure
+          dump_message(
+            message,
+            head: head, state: block_given? && result.nil? || e ? :error : state
+          )
+          dump_result(result) if block_given?
+          result
+        end
+
+        def dump_message(message, head:, state:)
+          @data << {
+            at: now, message: message,
+            state: state, head: head, meta: false
+          }
+        end
+
+        def dump_result(result)
+          @data << {
+            at: now, message: "#{@result_prefix}#{result.inspect}",
+            state: :success, head: false, meta: true
+          }
+        end
+
+        def now
+          Time.now.to_i
+        end
+
+        def tag(tag)
+          @tags << tag
+        end
+
+        def fail!
+          @state = :error
+        end
+
+        def success?
+          @state == :success
+        end
+
+        def wrapup
+          Trifle::Logger.default.on_wrapup(self)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Trifle
+  module Logger
+    module Tracer
+      class Null
+        def log(_message, **_keywords)
+          yield if block_given?
+        end
+
+        def tag(_resource); end
+
+        def fail!; end
+
+        def wrapup; end
+      end
+    end
+  end
+end

data/lib/trifle/logger/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Trifle
+  module Logger
+    VERSION = '0.0.1'
+  end
+end

data/trifle-logger.gemspec

@@ -0,0 +1,33 @@
+require_relative 'lib/trifle/logger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "trifle-logger"
+  spec.version       = Trifle::Logger::VERSION
+  spec.authors       = ["Jozef Vaclavik"]
+  spec.email         = ["jozef@hey.com"]
+
+  spec.summary       = 'Simple logger backed by Redis, Postgres, MongoDB, '\
+                       'or whatever'
+  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.metadata["homepage_uri"] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/trifle-io/trifle-logger'
+
+  # 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.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency('bundler', '~> 2.1')
+  spec.add_development_dependency('byebug', '>= 0')
+  spec.add_development_dependency('rake', '~> 13.0')
+  spec.add_development_dependency('rspec', '~> 3.2')
+  spec.add_development_dependency('rubocop', '1.0.0')
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: trifle-logger
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jozef Vaclavik
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-02-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: Trifle::Logger is a way too simple timeline logger that helps you track
+  custom outputs.
+email:
+- jozef@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".gitpod.yml"
+- ".gitpod/Dockerfile"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".tool-versions"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/trifle/logger.rb
+- lib/trifle/logger/configuration.rb
+- lib/trifle/logger/middleware/rack.rb
+- lib/trifle/logger/middleware/rails_controller.rb
+- lib/trifle/logger/middleware/sidekiq.rb
+- lib/trifle/logger/tracer/hash.rb
+- lib/trifle/logger/tracer/null.rb
+- lib/trifle/logger/version.rb
+- trifle-logger.gemspec
+homepage: https://trifle.io
+licenses: []
+metadata:
+  homepage_uri: https://trifle.io
+  source_code_uri: https://github.com/trifle-io/trifle-logger
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Simple logger backed by Redis, Postgres, MongoDB, or whatever
+test_files: []