debug_logging 3.1.8 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12a45427d0ca5aea996bd2ddce9da4ae3f763afe2e5b0abefea2173f6765ff61
-  data.tar.gz: 1a9d1a08b5f49daaa6f01c10c48b3a5345794a46f9b62f25243f13e6ebacd694
+  metadata.gz: 80eec636fd64a69b41aaf67704b79c784bc5ffa989e181c51106bc908bc645c8
+  data.tar.gz: 8feca3ec5aadd298bc0da9f75631834f4a16bd73aa9d39572c8caf72ec2834b4
 SHA512:
-  metadata.gz: f55f81ffe673ec404dd49fc26db2778abf3311a3f7f148a85c5030369cb469b8570c8728db5526b838caf2e09b22e04ad314ab27c462b8b246905e00945b2d9a
-  data.tar.gz: c5bc397f5b50d19551d7db9b6d7fe9cafa034ff36cbac2551d9c2a52d0e9a9f70992d0efb49a46fabf6830f76818b15eaf6653be9fee38aad415af9d2f92510a
+  metadata.gz: bd13ad1dca5706140626730a48dc4e9133efc5e3db3d55f64b4c79f3a0bb21765d82a237c2a021d93ec2b4d0632d4a0a4bc5a3c28ef2bad088de9de37d6fdc3e
+  data.tar.gz: 9be10f369557ed872853e387870528c0a64df4981c854b3df6b27d22f0d24eac741d51e69beec9c6e6cfd2398748838d47ac5955df951d906d77378f60d4331a

data/CHANGELOG.md

@@ -0,0 +1,160 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+### Added
+### Changed
+### Fixed
+### Removed
+
+## [4.0.0] - unreleased
+### Added
+- Class method DSL:
+    - `logged`
+- Instance method DSL:
+    - `i_logged`
+### Changed
+- Class method DSL renamed:
+  - `notifies` => `notified`
+- Instance method DSL renamed:
+  - `i_notifies` => `i_notified`
+- Disambiguated class method log output send message separator:
+  - `.` => `::`, because `.` is ambiguous; same call syntax used for instance method calls
+### Fixed
+- Per method config for every decorated method
+### Removed
+- Support for `include DebugLogging::InstanceLogger.new(...)`
+- Support for `include DebugLogging::InstanceNotifier.new(...)`
+
+## [3.1.9] - 2023-10-31
+### Fixed
+- Maximum Ruby version is 2.7. Versions 3.x are not compatible with Ruby >= 3
+
+## [3.1.8] - 2020-12-19
+
+## [3.1.7] - 2020-12-19
+
+## [3.1.6] - tagged, but unreleased
+
+## [3.1.5] - 2020-12-18
+
+## [3.1.4] - 2020-12-18
+
+## [3.1.3] - 2020-12-18
+
+## [3.1.2] - 2020-12-10
+
+## [3.1.1] - 2020-12-09
+
+## [3.1.0] - 2020-10-24
+
+## [3.0.0] - 2020-10-07
+
+## [2.0.0] - 2020-10-06
+
+## [1.0.17] - 2018-09-10
+
+## [1.0.16] - 2018-01-16
+
+## [1.0.15] - 2017-10-17
+
+## [1.0.14] - 2017-10-09
+
+## [1.0.13] - 2017-10-08
+
+## [1.0.12] - 2017-10-08
+
+## [1.0.11] - 2017-10-06
+
+## [1.0.10] - 2017-09-26
+
+## [1.0.9] - 2017-09-06
+
+## [1.0.8] - 2017-09-06
+
+## [1.0.7] - 2017-09-06
+
+## [1.0.6] - 2017-09-05
+
+## [1.0.5] ([tag][1.0.1t]) - 2017-03-31
+
+## [1.0.4] ([tag][1.0.4t]) - 2017-03-31
+
+## [1.0.3] ([tag][1.0.3t]) - 2017-03-31
+
+## [1.0.2] ([tag][1.0.2t]) - 2017-03-30
+
+## [1.0.1] ([tag][1.0.1t]) - 2017-03-29
+
+## [1.0.0] ([tag][1.0.0t]) - 2017-03-26
+
+## [0.1.0] ([tag][0.1.0t]) - 2017-03-25
+- Initial release
+
+[Unreleased]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/compare/v3.1.9...HEAD
+[3.1.9t]: https://gitlab.com/pboling/debug_logging/-/tags/v3.1.9
+[3.1.9]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/compare/v3.1.8...v3.1.9
+[3.1.8t]: https://gitlab.com/pboling/debug_logging/-/tags/v3.1.8
+[3.1.8]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/compare/v3.1.7...v3.1.8
+[3.1.7t]: https://gitlab.com/pboling/debug_logging/-/tags/v3.1.7
+[3.1.7]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/compare/v3.1.6...v3.1.7
+[3.1.6t]: https://gitlab.com/pboling/debug_logging/-/tags/v3.1.6
+[3.1.6]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/compare/v3.1.5...v3.1.6
+[3.1.5t]: https://gitlab.com/pboling/debug_logging/-/tags/v3.1.5
+[3.1.5]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/compare/v3.1.4...v3.1.5
+[3.1.4t]: https://gitlab.com/pboling/debug_logging/-/tags/v3.1.4
+[3.1.4]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/compare/v3.1.3...v3.1.4
+[3.1.3t]: https://gitlab.com/pboling/debug_logging/-/tags/v3.1.3
+[3.1.3]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/compare/v3.1.2...v3.1.3
+[3.1.2t]: https://gitlab.com/pboling/debug_logging/-/tags/v3.1.2
+[3.1.2]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/compare/v3.1.1...v3.1.2
+[3.1.1t]: https://gitlab.com/pboling/debug_logging/-/tags/v3.1.1
+[3.1.1]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/compare/v3.1.0...v3.1.1
+[3.1.0t]: https://gitlab.com/pboling/debug_logging/-/tags/v3.1.0
+[3.1.0]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/compare/v3.0.0...v3.1.0
+[3.0.0t]: https://gitlab.com/pboling/debug_logging/-/tags/v3.0.0
+[3.0.0]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/compare/v2.0.0...v3.0.0
+[2.0.0t]: https://gitlab.com/pboling/debug_logging/-/tags/v2.0.0
+[2.0.0]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/compare/v1.0.17...v2.0.0
+[1.0.17t]: https://gitlab.com/pboling/debug_logging/-/tags/v1.0.17
+[1.0.17]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/compare/v1.0.16...v1.0.17
+[1.0.16t]: https://gitlab.com/pboling/debug_logging/-/tags/v1.0.16
+[1.0.16]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/compare/v1.0.15...v1.0.16
+[1.0.15t]: https://gitlab.com/pboling/debug_logging/-/tags/v1.0.15
+[1.0.15]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/compare/v1.0.14...v1.0.15
+[1.0.14t]: https://gitlab.com/pboling/debug_logging/-/tags/v1.0.14
+[1.0.14]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/compare/v1.0.13...v1.0.14
+[1.0.13t]: https://gitlab.com/pboling/debug_logging/-/tags/v1.0.13
+[1.0.13]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/compare/v1.0.12...v1.0.13
+[1.0.12t]: https://gitlab.com/pboling/debug_logging/-/tags/v1.0.12
+[1.0.12]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/compare/v1.0.11...v1.0.12
+[1.0.11t]: https://gitlab.com/pboling/debug_logging/-/tags/v1.0.11
+[1.0.11]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/compare/v1.0.10...v1.0.11
+[1.0.10t]: https://gitlab.com/pboling/debug_logging/-/tags/v1.0.10
+[1.0.10]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/compare/v1.0.9...v1.0.10
+[1.0.9t]: https://gitlab.com/pboling/debug_logging/-/tags/v1.0.9
+[1.0.9]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/compare/v1.0.8...v1.0.9
+[1.0.8t]: https://gitlab.com/pboling/debug_logging/-/tags/v1.0.8
+[1.0.8]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/compare/v1.0.7...v1.0.8
+[1.0.7t]: https://gitlab.com/pboling/debug_logging/-/tags/v1.0.7
+[1.0.7]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/compare/v1.0.6...v1.0.7
+[1.0.6t]: https://gitlab.com/pboling/debug_logging/-/tags/v1.0.6
+[1.0.6]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/compare/v1.0.5...v1.0.6
+[1.0.5t]: https://gitlab.com/pboling/debug_logging/-/tags/v1.0.5
+[1.0.5]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/compare/v1.0.4...v1.0.5
+[1.0.4t]: https://gitlab.com/pboling/debug_logging/-/tags/v1.0.4
+[1.0.4]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/compare/v1.0.3...v1.0.4
+[1.0.3t]: https://gitlab.com/pboling/debug_logging/-/tags/v1.0.3
+[1.0.3]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/compare/v1.0.2...v1.0.3
+[1.0.2t]: https://gitlab.com/pboling/debug_logging/-/tags/v1.0.2
+[1.0.2]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/compare/v1.0.1...v1.0.2
+[1.0.1t]: https://gitlab.com/pboling/debug_logging/-/tags/v1.0.1
+[1.0.1]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/compare/v1.0.0...v1.0.1
+[1.0.0t]: https://gitlab.com/pboling/debug_logging/-/tags/v1.0.0
+[1.0.0]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/compare/v0.1.0...v1.0.0
+[0.1.0t]: https://gitlab.com/pboling/debug_logging/-/tags/v0.1.0
+[0.1.0]: https://gitlab.com/pboling/debug_logging/-/compare/f648ea6832aa85232d320b4c4acc4a84e44a83d3...v0.1.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible 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.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at peter.boling@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/CONTRIBUTING.md

@@ -0,0 +1,47 @@
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/pboling/debug_logging][🚎src-main]
+. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to
+the [code of conduct][🤝conduct].
+
+To submit a patch, please fork the project and create a patch with tests. Once you're happy with it send a pull request
+and post a message to the [gitter chat][🏘chat].
+
+## Release
+
+To release a new version:
+
+1. Run `bin/setup && bin/rake` as a tests, coverage, & linting sanity check
+2. Update the version number in `version.rb`
+3. Run `bin/setup && bin/rake` again as a secondary check, and to update `Gemfile.lock`
+4. Run `git commit -am "🔖 Prepare release v<VERSION>"` to commit the changes
+5. Run `git push` to trigger the final CI pipeline before release, & merge PRs
+   a. NOTE: Remember to [check the build][🧪build]!
+6. Run `git checkout main` (Or whichever branch is considered `trunk`, e.g. `master`)
+7. Run `git pull origin main` to ensure you will release the latest trunk code.
+8. Set `SOURCE_DATE_EPOCH` so `rake build` and `rake release` use same timestamp, and generate same checksums
+   a. Run `export SOURCE_DATE_EPOCH=$EPOCHSECONDS`
+9. Run `bundle exec rake build`
+10. Run [`bin/checksums`](https://github.com/rubygems/guides/pull/325) to create SHA-256 and SHA-512 checksums
+   a. Checksums will be committed automatically by the script, but not pushed
+11. Run `bundle exec rake release` which will create a git tag for the version,
+   push git commits and tags, and push the `.gem` file to [rubygems.org][💎rubygems]
+
+NOTE: You will need to have a public key in `certs/`, and list your cert in the
+`gemspec`, in order to sign the new release.
+See: [RubyGems Security Guide][🔒️rubygems-security-guide]
+
+## Contributors
+
+[![Contributors](https://contrib.rocks/image?repo=pboling/debug_logging)][🖐contributors]
+
+Made with [contributors-img][🖐contrib-rocks].
+
+[🧪build]: https://github.com/pboling/debug_logging/actions
+[🏘chat]: https://matrix.to/#/%23pboling_debug_logging:gitter.im
+[🤝conduct]: https://github.com/pboling/debug_logging/blob/main/CODE_OF_CONDUCT.md
+[🖐contrib-rocks]: https://contrib.rocks
+[🖐contributors]: https://github.com/pboling/debug_logging/graphs/contributors
+[💎rubygems]: https://rubygems.org
+[🔒️rubygems-security-guide]: https://guides.rubygems.org/security/#building-gems
+[🚎src-main]: https://github.com/pboling/debug_logging

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017-2024 Peter Boling (railsbling.com)
+
+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.