object_context_logger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9c60c8e6f07f7663d2ca51237cd090911b8e336fccfa8e76d6eda5e2a05c2785
+  data.tar.gz: 5652ab2439a59e1cc1d8aaed2d5a7f732af7d6821666ca759b3e32535974264e
+SHA512:
+  metadata.gz: 75aeb98838e3ac10b8b6eb3552190b8b7224018526411b899adf70153fa387a8e214c55fc1e64e4c9b89c0df1b916019de68784f1635a30ff20d628a5633b003
+  data.tar.gz: 542fc2c2b45c117f80acf68d0f6df8293844d8fe26d9714c11d12d7aeed26d218cff033131a6b29ce8b3b011adeedbed627a157e0d3adca17d8f8f56d46ae73f

data/.ruby-gemset

@@ -0,0 +1 @@
+object_context_logger

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in object_context_logger.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+gem "awesome_print"

data/Gemfile.lock

@@ -0,0 +1,23 @@
+PATH
+  remote: .
+  specs:
+    object_context_logger (0.1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    awesome_print (1.9.2)
+    minitest (5.19.0)
+    rake (13.0.6)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  awesome_print
+  minitest (~> 5.0)
+  object_context_logger!
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.4.10

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Daniel P. Zepeda
+
+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 Daniel P Zepeda
+
+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,93 @@
+# ObjectContextLogger
+
+ObjectContextLogger is as simple utility that automatically prepends a given log message with the context that it was 
+called from.
+
+This utility was born out of the frustration of reading logs to debug a problem, finding a useful message,
+then wishing I knew which instance of a class/object or other context it was called from.
+Being lazy, instead of trying to remember to always include that 
+context in the log message, I wrote this little bit of code. 
+
+## Installation
+
+### Bundler 
+
+    gem 'error_extractor', '~> 0.1.0'
+
+### Gem install
+
+    $ gem install object_context_logger
+
+## Configuration
+
+### Rails
+
+If you'll be using this in a Rails app, then you can generate the configuration initializer with this:
+
+    $ rails generate object_context_logger_initializer
+
+### Manually
+
+If you'll be using this outside of a Rails app, you'll need to proved the configuration manually: 
+
+```
+      ObjectContextLogger.configure do |config|
+        # config.logger = Rails.logger # must respond to logger methods like :info, :debug
+        # config.default_log_method = :info 
+        # config.default_object_identifier_method = :to_gid  
+        # config.log_to_stdout = false 
+      end
+
+```
+
+### Configuration Items 
+
+* `logger` - The only required setting, provide a logger object that must at least respond to `:info`
+* `default_log_method` - This is the method sent to the logger object to register a log. 
+* `default_object_identifier_method` - By default, ObjectContextLogger uses [GlobalID](https://github.com/rails/globalid),
+ if you are outside of a Rails project or dealing with objects that do not respond to `to_gid` by default, you'll
+ want to use a different default identifier method, like `to_s`, appropriately defined on the objects you are logging
+ from. 
+* `log_to_stdout` - Sometimes useful when debugging scripts.  
+
+## Usage
+
+The whole idea of this utility is to make logging with context simple: 
+
+### In the context of an instance of User (id 1)
+
+    ctx_log "Your very informative log message"
+    #=> gid://gem-host/User/1: Your very informative message
+
+If you want to use a particular logger facility, you can specify it: 
+
+    ctx_log "Your very informative log message", :debug
+    #=> gid://gem-host/User/1: Your very informative message
+
+If the object/class you are logging from requires some special identifier, you can specify it: 
+
+    ctx_log "Your very informative log message", object_identifier: "some string or method call"
+    #=> some string or method call: Your very informative log message
+
+### In the context of a class User 
+
+    ctx_log "Your very informative log message"
+    #=> User: Your very informative message
+
+Finally, there is a helper method to use if you want to add context to exceptions: 
+
+    raise "#{ctx_log_prefix}: Your very informative exception message"
+    #=> User: Your very informative exception message
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. 
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/duskhacker/object-context-logger.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/lib/generators/object_context_logger_initializer_generator.rb

@@ -0,0 +1,12 @@
+class ObjectContextLoggerInitializerGenerator < Rails::Generators::Base
+  def create_initializer_file
+    create_file "config/initializers/object_context_logger.rb", <<~RUBY
+      ObjectContextLogger.configure do |config|
+        # config.logger = Rails.logger # must respond to logger methods like :info, :debug
+        # config.default_log_method = :info 
+        # config.default_object_identifier_method = :to_gid  
+        # config.log_to_stdout = false 
+      end
+    RUBY
+  end
+end

data/lib/object_context_logger/version.rb

@@ -0,0 +1,3 @@
+module ObjectContextLogger
+  VERSION = "0.1.0"
+end

data/lib/object_context_logger.rb

@@ -0,0 +1,64 @@
+require_relative "object_context_logger/version"
+
+module ObjectContextLogger
+  class Error < StandardError; end
+
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  def ctx_log(message, method = :info, object_identifier: nil)
+    self.class.ctx_log(
+      message,
+      method,
+      object_identifier: object_identifier || obj_id
+    )
+  end
+
+  def ctx_log_prefix(object_identifier = nil)
+    self.class.ctx_log_prefix(object_identifier || obj_id)
+  end
+
+  module ClassMethods
+    def ctx_log(message, method = nil, object_identifier: nil)
+      config = ObjectContextLogger.configuration
+      m = "#{ctx_log_prefix(object_identifier)}: #{message}"
+      puts m if config.log_to_stdout
+      if config.logger.nil? || config.logger == ""
+        raise "ObjectContextLogger: logger is not configured, use ObjectContextLogger.configure to set it"
+      end
+      config.logger.send(method || config.default_log_method, m)
+    end
+
+    def ctx_log_prefix(object_identifier = nil)
+      return object_identifier unless object_identifier.nil? || object_identifier.to_s == ""
+      "#{self.class == Class ? self : self.class}"
+    end
+  end
+
+  class << self
+    attr_accessor :configuration
+
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+    end
+  end
+
+  class Configuration
+    attr_accessor :logger, :log_to_stdout, :default_object_identifier_method, :default_log_method
+
+    def initialize
+      @default_object_identifier_method = :to_gid
+      @default_log_method = :info
+    end
+  end
+
+  private
+
+  def obj_id
+    send(ObjectContextLogger.configuration.default_object_identifier_method.to_s) rescue nil
+  end
+end
+
+include ObjectContextLogger

data/object_context_logger.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "lib/object_context_logger/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "object_context_logger"
+  spec.version = ObjectContextLogger::VERSION
+  spec.authors = ["Daniel P Zepeda"]
+  spec.email = ["daniel@zepeda.ws"]
+
+  spec.summary = "Logging helper that prefixes the object context it was called from into the log message"
+  spec.description = "Logging helper that prefixes the object context it was called from into the log message"
+  spec.homepage = "https://github.com/duskhacker/object-context-logger"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_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 .circleci appveyor])
+    end
+  end
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: object_context_logger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel P Zepeda
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-08-23 00:00:00.000000000 Z
+dependencies: []
+description: Logging helper that prefixes the object context it was called from into
+  the log message
+email:
+- daniel@zepeda.ws
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/object_context_logger_initializer_generator.rb
+- lib/object_context_logger.rb
+- lib/object_context_logger/version.rb
+- object_context_logger.gemspec
+homepage: https://github.com/duskhacker/object-context-logger
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/duskhacker/object-context-logger
+  source_code_uri: https://github.com/duskhacker/object-context-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.0.3.1
+signing_key: 
+specification_version: 4
+summary: Logging helper that prefixes the object context it was called from into the
+  log message
+test_files: []