Refactor Scrolls #71
Merged
Refactor Scrolls #71
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit breaks backwards compatability for Scrolls. It is a rework/refactor of the initial work done in the following PR: #54 - The `global_context` is no longer mutable, instead we instantiate a class internally inside Scrolls::Logger that contains the `global_context`. This is to avoid various bad thread behaviors, that previous to Ruby 2.0, were allowed. - The result of the above change removes `#add_global_context`. - Currently Scrolls needs to be instantiated to be used (`Scrolls.init(options)`) however I'd like to work on a method for allowing one to just use `Scrolls.log` and get sane defaults. - Due to this massive change I moved to "single line exceptions" by default since it lowers the amount of data produced by Scrolls when using `#log_exception` without losing the information.
|
This evening I worked to clean up a lot of the refactor, simplify some areas (especially around streams, facilities and structure). Next I want to bring in any other PRs that existed, make sure they are well tested, appropriate and then work on updating all of the documentation. Then I think this is ready for a proper release. |
I also added some common log level abbreviations to make this easier to use. Tests included.
This was referenced Aug 30, 2017
Closes #67. Add an option to Scrolls#init "escape_keys" that escapes various characters in keys. Implementation is based off how Rack escapes html. I started there, but we can extend the character range further if need be. Also some code cleanup, restructuring and comments.
Fixes #61 In Ruby 2.1 setting thread local values changed. This updates our usage.
This not only makes more sense but "bare" hashes are not allowed for arguments in recent versions of Ruby so this will break anyways.
This was referenced Aug 31, 2017
Closed
|
Alright, I've updated docs, cleaned up the code, added some tests and overall is am ready to merge this and release 0.9.0. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit breaks backwards compatibility for Scrolls. It is a rework/refactor of the initial work done in the following PR: #54
#global_contextis no longer mutable, instead we instantiate a class internally inside Scrolls::Logger that contains theglobal_context. This is to avoid various bad thread behaviors, that previous to Ruby 2.0, were allowed.#add_global_context.Scrolls.init(options)) however I'd like to work on a method for allowing one to just useScrolls.logand get sane defaults.#log_exceptionwithout losing the information.NOTE: I don't have a great setup right now to test everything here. I'm testing against Ruby 2.4.1 and all tests pass. Please test if you can. I'm going to cut a release of this version, 0.9.0.pre. I'm jumping versions here since we break backward compatibility. I'm hopeful with this and subsequent versions we can get to a place where a version 1.0 is a reality.
Please test this version as much as possible!