log_method 1.0.0.pre.beta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bc351505c3fb62a69bc4f0f98a31335a212026dcec15f8644d7a0265bece1d16
+  data.tar.gz: 825b0e8dd2243d002e1c2c792e3e3f1b70b780b95d9719d236779e99327bc675
+SHA512:
+  metadata.gz: 5ee91a5b361300c00b7fe13d2ff87a7722e54031ddd20c3c16365c940155f8870444485f51ab0406926bea062c3afb19ab2932f9f9b15159798e2687a814e216
+  data.tar.gz: 82e25bef7a840a873aae5e0e1afce8bd92d8f4dfa4831479dabe7ebd67f45919f5bf81ac28212ec54949a4522fef7a00a15210a70f33b46aa7cc97b5998a60ac

data/.circleci/config.yml

@@ -0,0 +1,35 @@
+version: 2.1
+orbs:
+  # See https://circleci.com/developer/orbs/orb/circleci/ruby
+  ruby: circleci/ruby@1.2.0
+jobs:                # keyword
+  test:              # my name for the job
+    parameters:      # keyword
+      ruby-version:  # my parameter name
+        type: string # type is a keyword
+    docker:          # keyword
+      - image: cimg/base:stable
+    steps:                                       # keyword
+      - checkout                                 # magic name
+      - ruby/install:                            # ruby/ is from the orb name, install is a command in that orb
+          version: << parameters.ruby-version >> # magic nonsense for param subst
+      - run:
+          command: "bin/setup"
+      - run:
+          name: "Create the test results directory because you can't just store_test_results with a file and if you do you do not get any sort of error because wtf is with this platform?"
+          command: mkdir -p /tmp/test-results
+      - run:
+          command: bin/ci /tmp/test-results/rspec_results.xml
+      - store_test_results:                      # store_test_results is magic from circle
+          path: /tmp/test-results                # path is a param to store_test_results and it must be a directory not a file
+      - store_artifacts:                         # store_artifacts is magic from circle
+          path: /tmp/test-results                # path is the param to store_artifacts
+workflows:              # keyword
+  all-rubies:           # my name for the workflow
+    jobs:               # keyword
+      - test:           # my name for the job
+          matrix:       # keyword
+            parameters: # keyword
+              # All rubies being maintained per this page:
+              # https://www.ruby-lang.org/en/downloads/branches/
+              ruby-version: [ "2.5", "2.6", "2.7", "3.0" ]

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+3.0.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at davetron5000 (at) gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+

data/CONTRIBUTING.md

@@ -0,0 +1,5 @@
+# Contributing
+
+* Code changes for style, cleanliness, eleganance, or other aesthetic stuff will not be accepted.
+* All proposed changes must have a clear problem statement and be based on a real-world scenario. Imagined problems will not be solved.
+* Tests are appreciated with all pull requests.

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in with_clues.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/LICENSE.md

@@ -0,0 +1,33 @@
+[log_method] Copyright (2021) (David Copeland)(“Licensor”)
+
+Hippocratic License Version Number: 2.1.
+
+Purpose. The purpose of this License is for the Licensor named above to permit the Licensee (as defined below) broad permission, if consistent with Human Rights Laws and Human Rights Principles (as each is defined below), to use and work with the Software (as defined below) within the full scope of Licensor’s copyright and patent rights, if any, in the Software, while ensuring attribution and protecting the Licensor from liability.
+
+Permission and Conditions. The Licensor grants permission by this license (“License”), free of charge, to the extent of Licensor’s rights under applicable copyright and patent law, to any person or entity (the “Licensee”) obtaining a copy of this software and associated documentation files (the “Software”), to do everything with the Software that would otherwise infringe (i) the Licensor’s copyright in the Software or (ii) any patent claims to the Software that the Licensor can license or becomes able to license, subject to all of the following terms and conditions:
+
+* Acceptance. This License is automatically offered to every person and entity subject to its terms and conditions. Licensee accepts this License and agrees to its terms and conditions by taking any action with the Software that, absent this License, would infringe any intellectual property right held by Licensor.
+
+* Notice. Licensee must ensure that everyone who gets a copy of any part of this Software from Licensee, with or without changes, also receives the License and the above copyright notice (and if included by the Licensor, patent, trademark and attribution notice). Licensee must cause any modified versions of the Software to carry prominent notices stating that Licensee changed the Software. For clarity, although Licensee is free to create modifications of the Software and distribute only the modified portion created by Licensee with additional or different terms, the portion of the Software not modified must be distributed pursuant to this License. If anyone notifies Licensee in writing that Licensee has not complied with this Notice section, Licensee can keep this License by taking all practical steps to comply within 30 days after the notice. If Licensee does not do so, Licensee’s License (and all rights licensed hereunder) shall end immediately.
+
+* Compliance with Human Rights Principles and Human Rights Laws.
+
+    1. Human Rights Principles.
+
+        (a) Licensee is advised to consult the articles of the United Nations Universal Declaration of Human Rights and the United Nations Global Compact that define recognized principles of international human rights (the “Human Rights Principles”). Licensee shall use the Software in a manner consistent with Human Rights Principles.
+
+        (b) Unless the Licensor and Licensee agree otherwise, any dispute, controversy, or claim arising out of or relating to (i) Section 1(a) regarding Human Rights Principles, including the breach of Section 1(a), termination of this License for breach of the Human Rights Principles, or invalidity of Section 1(a) or (ii) a determination of whether any Law is consistent or in conflict with Human Rights Principles pursuant to Section 2, below, shall be settled by arbitration in accordance with the Hague Rules on Business and Human Rights Arbitration (the “Rules”); provided, however, that Licensee may elect not to participate in such arbitration, in which event this License (and all rights licensed hereunder) shall end immediately. The number of arbitrators shall be one unless the Rules require otherwise.
+
+        Unless both the Licensor and Licensee agree to the contrary: (1) All documents and information concerning the arbitration shall be public and may be disclosed by any party; (2) The repository referred to under Article 43 of the Rules shall make available to the public in a timely manner all documents concerning the arbitration which are communicated to it, including all submissions of the parties, all evidence admitted into the record of the proceedings, all transcripts or other recordings of hearings and all orders, decisions and awards of the arbitral tribunal, subject only to the arbitral tribunal's powers to take such measures as may be necessary to safeguard the integrity of the arbitral process pursuant to Articles 18, 33, 41 and 42 of the Rules; and (3) Article 26(6) of the Rules shall not apply.
+
+    2. Human Rights Laws. The Software shall not be used by any person or entity for any systems, activities, or other uses that violate any Human Rights Laws.  “Human Rights Laws” means any applicable laws, regulations, or rules (collectively, “Laws”) that protect human, civil, labor, privacy, political, environmental, security, economic, due process, or similar rights; provided, however, that such Laws are consistent and not in conflict with Human Rights Principles (a dispute over the consistency or a conflict between Laws and Human Rights Principles shall be determined by arbitration as stated above).  Where the Human Rights Laws of more than one jurisdiction are applicable or in conflict with respect to the use of the Software, the Human Rights Laws that are most protective of the individuals or groups harmed shall apply.
+
+    3. Indemnity. Licensee shall hold harmless and indemnify Licensor (and any other contributor) against all losses, damages, liabilities, deficiencies, claims, actions, judgments, settlements, interest, awards, penalties, fines, costs, or expenses of whatever kind, including Licensor’s reasonable attorneys’ fees, arising out of or relating to Licensee’s use of the Software in violation of Human Rights Laws or Human Rights Principles.
+
+* Failure to Comply. Any failure of Licensee to act according to the terms and conditions of this License is both a breach of the License and an infringement of the intellectual property rights of the Licensor (subject to exceptions under Laws, e.g., fair use). In the event of a breach or infringement, the terms and conditions of this License may be enforced by Licensor under the Laws of any jurisdiction to which Licensee is subject. Licensee also agrees that the Licensor may enforce the terms and conditions of this License against Licensee through specific performance (or similar remedy under Laws) to the extent permitted by Laws. For clarity, except in the event of a breach of this License, infringement, or as otherwise stated in this License, Licensor may not terminate this License with Licensee.
+
+* Enforceability and Interpretation. If any term or provision of this License is determined to be invalid, illegal, or unenforceable by a court of competent jurisdiction, then such invalidity, illegality, or unenforceability shall not affect any other term or provision of this License or invalidate or render unenforceable such term or provision in any other jurisdiction; provided, however, subject to a court modification pursuant to the immediately following sentence, if any term or provision of this License pertaining to Human Rights Laws or Human Rights Principles is deemed invalid, illegal, or unenforceable against Licensee by a court of competent jurisdiction, all rights in the Software granted to Licensee shall be deemed null and void as between Licensor and Licensee. Upon a determination that any term or provision is invalid, illegal, or unenforceable, to the extent permitted by Laws, the court may modify this License to affect the original purpose that the Software be used in compliance with Human Rights Principles and Human Rights Laws as closely as possible. The language in this License shall be interpreted as to its fair meaning and not strictly for or against any party.
+
+* Disclaimer. TO THE FULL EXTENT ALLOWED BY LAW, THIS SOFTWARE COMES “AS IS,” WITHOUT ANY WARRANTY, EXPRESS OR IMPLIED, AND LICENSOR AND ANY OTHER CONTRIBUTOR SHALL NOT BE LIABLE TO ANYONE FOR ANY DAMAGES OR OTHER LIABILITY ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THIS LICENSE, UNDER ANY KIND OF LEGAL CLAIM.
+
+This Hippocratic License is an Ethical Source license (https://ethicalsource.dev) and is offered for use by licensors and licensees at their own risk, on an “AS IS” basis, and with no warranties express or implied, to the maximum extent permitted by Laws.

data/README.md

@@ -0,0 +1,196 @@
+# log\_method - a better way to log better stuff
+
+[![<sustainable-rails>](https://circleci.com/gh/sustainable-rails/log_method.svg?style=shield)](https://app.circleci.com/pipelines/github/sustainable-rails/log_method)
+
+Instead of `Rails.logger.info`, use `log «method_name»,«context object»,«message»`, and the following will be logged:
+
+* Your log message
+* The class where `log` was called
+* The method name you pass in
+* The class and id of the context object
+* Any trace or request id you have configured
+* Any current user id you have configured
+
+This will result in more useful log messages that are easier to construct.
+
+## Install
+
+1. Add to your `Gemfile`:
+
+   ```ruby
+   # Gemfile
+   gem "log_method"
+   ```
+2. `bundle install`
+3. Optionally create a configuration in `config/initializers` (see below)
+
+## Usage
+
+```ruby
+class SomeClass
+  include LogMethod::Log
+
+  def some_method(some_active_record)
+    log :some_method, some_active_record, "Beginning the operation"
+  end
+end
+```
+
+Assuming you have configured trace ids and current user id (see below for how), this is what your log message will look like (assuming the id of `some_active_record` is 42):
+
+```
+[SomeClass#some_method](via LogMethod::Log) trace_id:7efa5401-08d8-44e3-b101-d5806563a3da current_user_id:42 [User:7889]: Beginnging the operation
+```
+
+Let's break down each part and understand why it's there, which will help you understand why you should use this gem:
+
+* `[SomeClass#some_method]` - this gives the class and method where the log statement originated. Super helpful when looking at log output and
+trying to find what code generated that log message.
+* `(via LogMethod::Log)` - This makes it clear that *this* gem produced this output. If you don't see this, it means something else is generating
+log output, too.  Very handy for understanding the source of your log statements.
+* `trace_id:7efa5401-08d8-44e3-b101-d5806563a3da` - If you set a trace id at the start of a web request, or when you queue a background job, you
+can then trace all log statements related to that request. SUPER handy for understanding what all happened in a given request you are looking at.
+* `current_user_id:42` - System behavior often depends on who is logged in or who the "current actor" is. So you want this in your log.
+* `[SomeActiveRecord:7889]:` - Almost always, code is operating on some object or operating in the context of some object.  It's nice to know
+exactly which one.
+* `Beginnging the operation` - And, of course, your log message
+
+### `log` method, explained
+
+There are two ways to call the `log` method:
+
+* `log :some_method, "Some string-based message"` - this is the closest to `Rails.logger.info` and will include `:some_method`, the current class, the message you passed, and, if configured, trace id and current user id.
+* `log :some_method, some_object, "Some string-based message"` - In this form, `some_object` is included in the log message.  What is included
+depends on what `some_object` is:
+  - If you have configured an `external_id` and this object responds to it, the object's class and the value of the external id are included in the log message
+  - If `some_object` is an Active Record, its class and the value of its `id` are included.
+  - Otherwise, the class and the value of `inspect` are included in the log message
+
+The second form is the one you should prefer whenever you have an Active Record in context, because that's how you can automatically get the class
+and ID into the log so you know what data was being operated on.
+
+### Cool, but I gotta put that `include` in every class?
+
+I would recommend putting the `include` line in:
+
+* `ApplicationController`
+* `ApplicationJob`
+* Whatever base class you use for your service layer (you should be using one).
+* Any other "base" class for logic.
+
+If you are putting business logic in your Active Records, you probably want to use the `include` line in `ApplicationRecord` as well. If you are
+not putting business logic in Active Records, there's nothing to log, so I would not include this.
+
+## Why can't I just `Rails.logger.info`?
+
+Almost every operation in your Rails app is operating on some piece of data, so it's extremely useful to know what that piece of data was.  It's
+also extremely useful to know where in the codebase the message originated.  Lastly, the entire point of request ids/trace ids is to put them in
+log messages *and* it's nice to know who was logged in doing the operation.
+
+And it's really hard to remember to put all this into the string when calling `Rails.logger.info`.
+
+### But shouldn't we be using Observability or something?
+
+Probably, but let's be real: not everyone has the time, bandwidth, money, or expertise to set up a true observability platform.  But we *do* have
+the time to deal with logs, because those are pretty easy.  Why not make it easier?
+
+## Configuration
+
+If you want to change some of the behavior of the `log` method, create `config/initializers/log_method.rb`.  Here is an example configuration.
+Following the example is an explanation of each option:
+
+```ruby
+LogMethod.config do |c|
+  c.external_identifier_method = :external_id
+  c.current_actor_proc = ->() { PaperTrail.request.whodunnit }
+  c.current_actor_id_label = "user_id"
+  c.after_log_proc = ->(class_thats_logging_name, method_name, object_id, object_class_name, trace_id, current_actor_id) {
+    Bugsnag.leave_breadcrumb method_name.to_s[0..29], {
+      class: class_thats_logging_name,
+      object_id: object_id,
+      object_class: object_class_name,
+      trace_id: trace_id,
+      admin_user_id: current_actor_id
+    }, Bugsnag::Breadcrumbs::LOG_BREADCRUMB_TYPE
+  }
+  c.trace_id_proc = ->() { Thread.current.thread_variable_get("request_id") }
+end
+```
+
+### Options
+
+* `after_log_proc` This is a proc/lambda to be called after each log message has been sent to `Rails.logger.info`.  In the example above, we're using this to send a breadcrumb to Bugsnag so that if there is an error with this request, we can see what log messages were logged for that request.  It will be given these arguments:
+   - `class_thats_logging_name` - The class where `log` was called
+   - `method_name` - The method name passed to `log`
+   - `object_id` - The id of the object passed to `log`, if it had one
+   - `object_class_name` - The class name of the object passed to log, if one was passed
+   - `trace_id` - The trace id returned by `trace_id_proc`, or `nil` if that isn't configured.
+   - `current_actor_id` - The value returned by; `current_actor_proc`, or `nil` if that isn't configured.
+* `current_actor_id_label` - If a current actor is logged, this is the label that will precede it in the logs
+* `current_actor_proc` - Called to retrieve an identifier of the current actor executing the code, such as the current user.
+* `external_identifier_method` - If you are using external ids on your objects, this is the name of that method. If an object is passed in that responds to this method, it will be used instead of `id` when creating the log message.
+* `trace_id_proc` - returns the current request's request ID, trace ID, or cross-request ID.  This is useful to tie various log messages together that were all part of a single request.
+
+### Helper Procs
+
+This gem also includes some helper procs to connect `log` with some common gems and uses cases.
+
+#### Bugsnag Breadcrumbs
+
+In the example above, we use `after_log_proc` to send a breadcrumb to Bugsnag.  This means that if we get an error in a request, Bugsnag will show
+all of our log statements as breadcrumbs, which can help understand what data and state was involved in the error.
+
+This proc is included in this gem and you can use it like so:
+
+```ruby
+# config/initializers/log_method.rb
+require "log_method/bugsnag_after_log"
+LogMethod.config do |c|
+  c.after_log_proc = LogMethod::BugsnagAfterLog
+end
+```
+
+#### PaperTrail whodunnit
+
+The [PaperTrail gem](https://github.com/paper-trail-gem/paper_trail) has support for storing an actor or user along with versions created on
+changes to the database.  It's common to unify your current user (e.g. from Devise) to the Paper Trail "whodunnit" so that you can always call
+`PaperTrail.request.whodunnit` to get the current actor or user.
+
+To use this for logging, this gem includes `LogMethod::PaperTrailCurrentActor` that you can set up like so:
+
+```ruby
+# config/initializers/log_method.rb
+require "log_method/paper_trail_current_actor"
+LogMethod.config do |c|
+  c.current_actor_proc = LogMethod::PaperTrailCurrentActor
+end
+```
+
+### External IDs explained
+
+A useful pattern is to have your Active Records manage a unique external ID that is not used by the database for foreign key constraints or other
+lookups.  Suppose you call it `external_id`:
+
+```
+> record = SomeRecord.first
+> record.id
+42
+> record.external_id
+srec_2489089024u893huiefgjlhkdfg
+```
+
+There are many reasons to do this, but if you *do* do this, you will probably want these values in the log and not the database primary keys.
+
+## Philosophy
+
+I have tried to avoid excessive meta programming and stack navigation, resulting in something that is, I think, more predictable and easier to
+follow.  The code for `log` is relatively straightforward and verbose.  I think that's what you want out of your logging and infrastructure code.
+
+## Contributing
+
+While I'm interested in fixing bugs and making this library better, I would highly encourage you to run your proposed changes in your production
+environment for a while to make sure they are useful to you and don't cause other issues.
+
+If you do that, please open a PR with clear problem statement and I'd love to check it out!
+
+Please do not open PRs for things like coding style, because I do not want to change the coding style :)

data/Rakefile

@@ -0,0 +1,3 @@
+require "fileutils"
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/ci

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+set -e
+echo "[bin/ci] Running tests"
+if [ -z $1 ]; then
+  bin/rspec --format=doc
+else
+  echo "[bin/ci] Generating JUnit XML output to $1"
+  bin/rspec --format RspecJunitFormatter --out $1 --format=doc
+fi

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "with_clues"
+
+# 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/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle check || bundle install

data/lib/log_method/bugsnag_after_log.rb

@@ -0,0 +1,12 @@
+class LogMethod::BugsnagAfterLog
+  def self.call(class_thats_logging_name, method_name, object_id, object_class_name, trace_id, current_actor_id)
+    Bugsnag.leave_breadcrumb method_name.to_s[0..29], {
+      class: class_thats_logging_name,
+      object_id: object_id,
+      object_class: object_class_name,
+      trace_id: trace_id,
+      admin_user_id: current_actor_id
+    }, Bugsnag::Breadcrumbs::LOG_BREADCRUMB_TYPE
+  end
+end
+

data/lib/log_method/config.rb

@@ -0,0 +1,23 @@
+class LogMethod::Config
+  attr_accessor :after_log_proc,
+                :current_actor_id_label,
+                :current_actor_proc,
+                :external_identifier_method,
+                :trace_id_proc
+
+  def initialize
+    reset!
+  end
+
+  def reset!
+    @after_log_proc             = NO_OP
+    @current_actor_id_label     = "current_actor_id"
+    @current_actor_proc         = NO_OP
+    @external_identifier_method = nil
+    @trace_id_proc              = NO_OP
+  end
+
+private
+
+  NO_OP = ->(*) {}
+end

data/lib/log_method/log.rb

@@ -0,0 +1,47 @@
+module LogMethod::Log
+  def logging_external_identifier_method
+    @logging_external_identifier_method ||=  LogMethod.config.external_identifier_method
+  end
+
+  def log(method, message_or_object, message=nil)
+
+    trace_id         = LogMethod.config.trace_id_proc.()
+    current_actor_id = LogMethod.config.current_actor_proc.()
+
+    message = if message.nil?
+                message_or_object
+              else
+                object_id,object_class = if !logging_external_identifier_method.nil? &&
+                                            message_or_object.respond_to?(logging_external_identifier_method)
+
+                                           [message_or_object.send(logging_external_identifier_method), message_or_object.class]
+
+                                         elsif message_or_object.kind_of?(ActiveRecord::Base)
+
+                                           [message_or_object.id, message_or_object.class]
+
+                                         else
+
+                                           [message_or_object.inspect, message_or_object.class]
+
+                                         end
+                "[#{object_class}/#{object_id}]: #{message}"
+              end
+
+    Rails.logger.info("[#{self.class}##{method}](via LogMethod::Log)#{format_trace_id(trace_id)}#{format_current_actor_id(current_actor_id)}: #{message}")
+
+    LogMethod.config.after_log_proc.(self.class.name, method, object_id, object_class&.name, trace_id, current_actor_id)
+  end
+
+private
+
+  def format_trace_id(trace_id)
+    return nil if trace_id.nil?
+    " trace_id:#{trace_id} "
+  end
+
+  def format_current_actor_id(current_actor_id)
+    return nil if current_actor_id.nil?
+    " #{LogMethod.config.current_actor_id_label}:#{current_actor_id} "
+  end
+end

data/lib/log_method/paper_trail_current_actor.rb

@@ -0,0 +1,6 @@
+class LogMethod::PaperTrailCurrentActor
+  def self.call
+    PaperTrail.request.whodunnit
+  end
+end
+

data/lib/log_method/version.rb

@@ -0,0 +1,3 @@
+module LogMethod
+  VERSION="1.0.0-beta1"
+end

data/lib/log_method.rb

@@ -0,0 +1,15 @@
+module LogMethod
+end
+
+require_relative "log_method/config"
+require_relative "log_method/log"
+
+module LogMethod
+  def self.config(&block)
+    @config ||= LogMethod::Config.new
+    if !block.nil?
+      block.(@config)
+    end
+    @config
+  end
+end

data/log_method.gemspec

@@ -0,0 +1,27 @@
+require_relative "lib/log_method/version"
+
+Gem::Specification.new do |spec|
+  spec.name     = "log_method"
+  spec.version  = LogMethod::VERSION
+  spec.authors  = ["Dave Copeland"]
+  spec.email    = ["davec@naildrivin5.com"]
+  spec.summary  = %q{A nice log method for your Rails app that provides a ton of useful context in each message!}
+  spec.homepage = "https://github.com/sustainable-rails/log_method"
+  spec.license  = "Hippocratic"
+
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/sustainable-rails/log_method"
+  spec.metadata["changelog_uri"] = "https://github.com/sustainable-rails/log_method/releases"
+
+  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("rspec")
+  spec.add_development_dependency("rspec_junit_formatter")
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: log_method
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre.beta1
+platform: ruby
+authors:
+- Dave Copeland
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: rspec_junit_formatter
+  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'
+description:
+email:
+- davec@naildrivin5.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/ci
+- bin/console
+- bin/rspec
+- bin/setup
+- lib/log_method.rb
+- lib/log_method/bugsnag_after_log.rb
+- lib/log_method/config.rb
+- lib/log_method/log.rb
+- lib/log_method/paper_trail_current_actor.rb
+- lib/log_method/version.rb
+- log_method.gemspec
+homepage: https://github.com/sustainable-rails/log_method
+licenses:
+- Hippocratic
+metadata:
+  homepage_uri: https://github.com/sustainable-rails/log_method
+  source_code_uri: https://github.com/sustainable-rails/log_method
+  changelog_uri: https://github.com/sustainable-rails/log_method/releases
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.2.29
+signing_key:
+specification_version: 4
+summary: A nice log method for your Rails app that provides a ton of useful context
+  in each message!
+test_files: []