json_ruby_logger 0.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d54a10d53e83e69e49606a42420dea9540cfd30c078afe1a9b34b6ae2640380a
+  data.tar.gz: 13b3b25e9bf946155f6ffcfacb57b07c9ae0926af755da273fd1647683f3b95f
+SHA512:
+  metadata.gz: e3b15e905b9fbfa963f1d822d1d583ba32649dc0c67a778b237ce557e90e7ce651bbe03e011aa3a52c3705c02412e73249c4bc3ea729fe33738a90f8c7179374
+  data.tar.gz: 76593234c12c2fc24215dc722665e7a972e24eff331b3cecc90ad582594f1b02ded2b9edac7df313d857c18b52295e29d2b3ea422c2a7c5e1f4345195fe6c502

data/.editorconfig

@@ -0,0 +1,11 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+max_line_length = 110

data/.pre-commit-config.yaml

@@ -0,0 +1,32 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/gitleaks/gitleaks
+    rev: v8.16.1
+    hooks:
+      - id: gitleaks
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+    # - id: no-commit-to-branch
+    #   args: ['--branch', 'main']
+    - id: trailing-whitespace
+    - id: end-of-file-fixer
+    - id: check-yaml
+    - id: check-json
+    - id: check-added-large-files
+    - id: detect-private-key
+    - id: check-executables-have-shebangs
+    - id: check-merge-conflict
+    - id: mixed-line-ending
+      args:
+        - "--fix=lf"
+    - id: pretty-format-json
+      args:
+        - "--autofix"
+        - "--indent=4"
+        - "--no-sort-keys"
+  - repo: https://github.com/mattlqx/pre-commit-ruby
+    rev: v1.3.5
+    hooks:
+    - id: rubocop

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,20 @@
+require:
+  - rubocop-performance
+
+AllCops:
+  TargetRubyVersion: <%= RUBY_VERSION[/^\d+\.\d+/, 0] %>
+
+  # Disable all cops for now. Only notify on DeprecatedClassMethods
+  DisabledByDefault: true
+Layout/LineLength:
+  Max: 300
+
+Lint/DeprecatedClassMethods:
+  Enabled: true
+Style/StringLiterals:
+  Enabled: true
+
+Style/HashSyntax:
+  Enabled: false
+Style/GuardClause:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-07-05
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in json_ruby_logger.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,68 @@
+PATH
+  remote: .
+  specs:
+    json_ruby_logger (0.1.5)
+      json (~> 2.6)
+      logger (~> 1.5)
+      time (~> 0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    date (3.3.3)
+    diff-lcs (1.5.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    logger (1.5.3)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.1)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.54.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    time (0.2.2)
+      date
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  json_ruby_logger!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.4.13

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 do-i-need-a-username
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 ml
+
+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,205 @@
+# JsonRubyLogger
+
+A simpe ruby [logger](https://ruby-doc.org/3.2.2/stdlibs/logger/Logger.html) that logs in json format with the below information.
+
+```json
+{
+  "date":"2023-07-06T11:59:51+10:00",
+  "file_name":"test_logging.rb",
+  "calling_class":"LogTest::TestLogging",
+  "function_name":"call",
+  "lineno":8,
+  "severity":"INFO",
+  "pid":"27365",
+  "message":"Hello World call from LogTest::TestLogging"
+}
+```
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [Examples](##examples)
+- [Example 1 - Single file](#example-1)
+- [Example 2 - Multiple files file](#example-2)
+
+## Installation
+
+gem install:
+
+```bash
+gem install json_ruby_logger
+```
+
+bundler install:
+
+```Gemfile
+gem 'json_ruby_logger'
+```
+
+## Usage
+
+### Examples
+
+#### Example 1
+
+Example 1 - Single function in a single file called `test_logging.rb`:
+
+
+```ruby
+include Logging
+def test
+  logger.info { "Hello World call from #{self.class.name}" }
+end
+
+test
+```
+
+Run `ruby test_logging.rb`
+
+Output from example 1:
+
+```json
+{"date":"2023-07-06T15:10:24+10:00","file_name":"test_logger.rb","calling_class":"Object","function_name":"test","lineno":31,"severity":"INFO","pid":44665,"message":"Hello World call from Object"}
+```
+
+Example 2 in a single files called `test_logging.rb`:
+
+```ruby
+require 'json_ruby_logger'
+
+module LogTest
+  class TestLogging
+    include JsonRubyLogger
+
+    def call
+      logger.info { "Hello World call from #{self.class.name}" }
+      call2
+    end
+
+    def call2
+      logger.info { "Hello World call2 from #{self.class.name}" }
+    end
+  end
+end
+
+
+class TestLogging2
+  include JsonRubyLogger
+
+  def call
+    logger.info { "Hello World call from #{self.class.name}" }
+    call2
+  end
+
+  def call2
+    logger.info { "Hello World call2 from #{self.class.name}" }
+  end
+end
+
+LogTest::TestLogging.new.call
+TestLogging2.new.call
+```
+
+Run `ruby test_logging.rb`
+
+Output from example 2:
+
+```json
+{"date":"2023-07-06T11:59:51+10:00","file_name":"test_logging.rb","calling_class":"LogTest::TestLogging","function_name":"call","lineno":8,"severity":"INFO","pid":"#27365","message":"Hello World call from LogTest::TestLogging"}
+{"date":"2023-07-06T11:59:51+10:00","file_name":"test_logging.rb","calling_class":"LogTest::TestLogging","function_name":"call2","lineno":13,"severity":"INFO","pid":"#27365","message":"Hello World call2 from LogTest::TestLogging"}
+{"date":"2023-07-06T11:59:51+10:00","file_name":"test_logging.rb","calling_class":"TestLogging2","function_name":"call","lineno":23,"severity":"INFO","pid":"#27365","message":"Hello World call from TestLogging2"}
+{"date":"2023-07-06T11:59:51+10:00","file_name":"test_logging.rb","calling_class":"TestLogging2","function_name":"call2","lineno":28,"severity":"INFO","pid":"#27365","message":"Hello World call2 from TestLogging2"}
+```
+
+#### Example 3
+
+Example 3 multi files in sub folders:
+
+File `./lib/another_class.rb`
+
+```ruby
+require 'json_ruby_logger'
+
+class AnotherClass
+  include JsonRubyLogger
+
+  def another_class_call
+    logger.info { "AnotherClass Hello World call from #{self.class.name}" }
+    another_class
+  end
+
+  def another_class
+    logger.info { "Hello World call2 from #{self.class.name}" }
+  end
+end
+```
+
+File `./test_logging.rb`
+
+```ruby
+require_relative 'lib/another_class'
+require 'json_ruby_logger'
+
+class TestLogging
+  include JsonRubyLogger
+
+  def call
+    logger.info { "Hello World call from #{self.class.name}" }
+    another_class
+  end
+
+  def another_class
+    logger.info { "Hello World call2 from #{self.class.name}" }
+    AnotherClass.new.another_class_call
+  end
+end
+
+TestLogging.new.call
+```
+
+Run `ruby test_logging.rb`
+
+Output from example 3:
+
+```json
+{"date":"2023-07-06T12:08:48+10:00","file_name":"test_logger.rb","calling_class":"TestLogging","function_name":"call","lineno":8,"severity":"INFO","pid":"#29554","message":"Hello World call from TestLogging"}
+{"date":"2023-07-06T12:08:48+10:00","file_name":"test_logger.rb","calling_class":"TestLogging","function_name":"another_class","lineno":13,"severity":"INFO","pid":"#29554","message":"Hello World call2 from TestLogging"}
+{"date":"2023-07-06T12:08:48+10:00","file_name":"another_class.rb","calling_class":"AnotherClass","function_name":"another_class_call","lineno":7,"severity":"INFO","pid":"#29554","message":"AnotherClass Hello World call from AnotherClass"}
+{"date":"2023-07-06T12:08:48+10:00","file_name":"another_class.rb","calling_class":"AnotherClass","function_name":"another_class","lineno":12,"severity":"INFO","pid":"#29554","message":"Hello World call2 from AnotherClass"}
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Creating a Gem
+
+### Create a Gem Skeleton
+
+```bash
+bundle gem json_ruby_logger \
+--mit \
+--linter=rubocop \
+--test=rspec \
+--ci=github \
+--no-coc
+```
+
+### Build the gem
+
+```bash
+  gem build json_ruby_logger.gemspec
+```
+
+### push the gem to rubygems.org
+
+```bash
+  gem push json_ruby_logger-0.1.0.gem
+```
+
+## Revoke/yank a gem
+
+```bash
+  gem yank json_ruby_logger -v 0.1.0
+```

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/json_ruby_logger.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "lib/json_ruby_logger/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "json_ruby_logger"
+  spec.version = JsonRubyLogger::VERSION
+  spec.authors = ["ml"]
+  spec.email = ["redacted@gmail.com"]
+
+  spec.summary = "Simple JSON logging for Ruby, including classnames, filenames, linenos, timestamps, and log levels."
+  spec.description = "Simple JSON logging for Ruby"
+  spec.homepage = "https://github.com/do-i-need-a-username/json_ruby_logger"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .github .circleci appveyor])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency 'logger', '~> 1.5'
+  spec.add_dependency 'json', '~> 2.6'
+  spec.add_dependency 'time', '~> 0.2'
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/json_ruby_logger/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module JsonRubyLogger
+  VERSION = "0.1.5"
+end

data/lib/json_ruby_logger.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+require 'logger'
+require 'json'
+require 'time'
+
+require_relative "json_ruby_logger/version"
+
+module JsonRubyLogger
+  class Error < StandardError; end
+  # Your code goes here...
+
+  # This is the magical bit that gets mixed into your classes
+  def logger
+    # caller_locations returns an array of Thread::Backtrace::Location
+    JsonRubyLogger.logger(self.class.name, caller_locations.first)
+  end
+
+  # Global, memoized, lazy initialised instance of a logger
+  def self.logger(calling_class, caller_info)
+    logger = Logger.new(STDOUT)
+
+    logger.formatter = proc do |severity, datetime, progname, msg|
+      date_format = datetime.iso8601
+      JSON.dump(
+        date: date_format,
+        file_name: caller_info.path.split('/').last,
+        calling_class: calling_class,
+        function_name: caller_info.label.split(' ').last,
+        lineno: caller_info.lineno,
+        severity: severity,
+        pid: Process.pid,
+        message: msg
+      ) + "\n"
+    end
+
+    logger.level = ENV.fetch('LOG_LEVEL', 'INFO').upcase
+    logger
+  end
+end

data/sig/json_ruby_logger.rbs

@@ -0,0 +1,4 @@
+module JsonRubyLogger
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: json_ruby_logger
+version: !ruby/object:Gem::Version
+  version: 0.1.5
+platform: ruby
+authors:
+- ml
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-07-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: time
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: Simple JSON logging for Ruby
+email:
+- redacted@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".pre-commit-config.yaml"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- json_ruby_logger.gemspec
+- lib/json_ruby_logger.rb
+- lib/json_ruby_logger/version.rb
+- sig/json_ruby_logger.rbs
+homepage: https://github.com/do-i-need-a-username/json_ruby_logger
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/do-i-need-a-username/json_ruby_logger
+  source_code_uri: https://github.com/do-i-need-a-username/json_ruby_logger
+  changelog_uri: https://github.com/do-i-need-a-username/json_ruby_logger
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.13
+signing_key:
+specification_version: 4
+summary: Simple JSON logging for Ruby, including classnames, filenames, linenos, timestamps,
+  and log levels.
+test_files: []