README.md in loba-2.0.0 vs README.md in loba-2.1.0
- old
+ new
@@ -5,11 +5,11 @@
[](https://codeclimate.com/github/rdnewman/loba)
[](https://codeclimate.com/github/rdnewman/loba/coverage)
-Easy tracing for debugging: handy methods for adding trace lines to output or Rails logs.
+Easy tracing for debugging: handy methods for adding trace lines to output (or logs).
(Installation is pretty much what you'd expect for a gem, but read Environment Notes below first.)
## Overview
@@ -18,23 +18,23 @@
1. Is this spot of code being reached (or is it reached in the order I think it is)?
1. What is the value of this variable?
Loba statements are intended to be terse to minimize typing.
-Loba statements are intended to be minimally invasive and atomic. They should not have any (much) more impact than regular `puts` or `Rails.logger.debug` statements.
+Loba statements are intended to be minimally invasive and atomic. They should have negligible impact over regular `puts` or logging statements.
Loba statements are expected to be removed when you're done with them. No point in cluttering up production code.
-Loba will always write to STDOUT (i.e., `puts`).
+Loba will generally always write to `$stdout` (i.e., `puts`). In addition to `$stdout`, Loba can also be made to write to a log (:debug). Writing to `$stdout` can be overridden.
-Loba will work equally well with or without Rails. If Rails is present, in addition to STDOUT, Loba will also always write to `Rails.logger.debug`.
+Loba will work equally well with or without Rails. If Rails is present and writing to a log is wanted, it will use the Rails log (e.g., `Rails.logger.debug`).
Loba uses the [rainbow gem](https://rubygems.org/gems/rainbow) to help make trace statements more visible.
## Usage
-My advice is to align Loba statements to the far left in your source code (a la `=begin` or `=end`) so they're easy to see and remove when you're done.
+Aligning Loba statements to the far left in your source code (a la `=begin` or `=end`) will make them easier to see and remove when you're done. You may though find this somewhat annoying to do if your editor auto-indents.
#### Timestamp notices: `Loba.ts`
Outputs a timestamped notice, useful for quick traces to see the code path and easier than, say, [Kernel#set_trace_func](http://ruby-doc.org/core-2.2.3/Kernel.html#method-i-set_trace_func). Also does a simple elapsed time check since the previous timestamp notice to help with quick, minimalist profiling.
@@ -54,11 +54,11 @@
You can read [more detail](readme/ts.md) on this command.
#### Variable or method return inspection: `Loba.val`
-Inserts line to Rails.logger.debug (or to STDOUT if Rails.logger not available) showing value with method and class identification
+Writes line to `$stdout` (or optionally to a log, `logger.debug`) showing value with method and class identification.
```ruby
Loba.val :var_sym # the :var_sym argument is the variable or method name given as a symbol
```
@@ -68,10 +68,20 @@
[Target.some_calculation] my_var: 54 (in /home/usracct/src/myapp/app/models/target.rb:55:in `some_calculation')
```
You can read [more detail](readme/val.md) on this command.
+#### Output and logging options
+
+There are several options to control where Loba writes its output:
+* `out`: controls whether `puts` to `$stdout` occurs (default: `true`)
+* `log`: controls whether logging occurs (default: `false`)
+* `logger`: controls which logger is used
+* `logdev`: in non-Rails environments, another way to direct where logging occurs
+
+You can read [more detail](readme/log.md) about how to use these options.
+
#### Snippet example
```ruby
require 'loba' # not generally necessary in Rails projects
class HelloWorld
@@ -105,31 +115,31 @@
The expectation is that Loba statements are just for development or test trace statements. Generally, it's a bad idea to leave diagnostic code in Rails production; still, it can happen. And, occasionally, it can be useful to have trace statements in production too if you have an issue that is difficult to reproduce.
`Loba.ts` and `Loba.val` try to protect against timestamp or value notice requests being accidentally left in the code by checking for the Rails environment Loba is being invoked under. If in production, `Loba.ts` and `Loba.val` will normally just return immediately without attempting to render anything to help minimize any impact on production code.
-However, that behavior can be overridden by using the options hash with `:production => true` as an additional last argument to output a notice even when in the production environment. Note also behavior of the `log` option which defaults to `false` (introduced in v2.0.0). In general, enabling in production should be avoided. We're consenting adults.
+However, that behavior can be overridden by using the option `production: true` as an additional argument to output a notice even when in the production environment. Note also behavior of the `log` option, which defaults to `false` (introduced in v2.0.0). In general, enabling in production should not be done, but we're consenting adults.
-WARNING: this gem depends on the [binding_of_caller gem](https://rubygems.org/gems/binding_of_caller) -- use `:production => true` with their warning in mind:
+WARNING: this gem depends on the [binding_of_caller gem](https://rubygems.org/gems/binding_of_caller) -- use `production: true` with their warning in mind:
> **Recommended for use only in debugging situations. Do not use this in production apps.**
-These considerations also have an impact on how you install the Loba gem when using `bundler`. If you only install the gem for :development and :test, then any Loba statements left in the code when it goes to production will cause an error because the statements wouldn't be recognized. That's usually a Good Thing, if you never want them left in.
+These considerations also have an impact on how you install the Loba gem when using `bundler`. If you only install the gem for `:development` and `:test`, then any Loba statements left in the code when it goes to production will cause an error because the statements wouldn't be recognized. That can be a good thing if you never want them left in.
-If you simply install the gem for all environments, then Loba will be available in production, but you may not notice as easily if some Loba calls are unintentionally left in. Of course, if you want those statements to work in production, then you should install the gem for all environments.
+If you simply install the gem for all environments, then Loba will be available in production, but you may not notice as easily if some Loba calls are unintentionally left in. Of course, if you want Loba statements to possibly work in production, then you should install the gem for all environments.
The following is the code example snippet but always logging even in Rails production environments:
```ruby
class HelloWorld
def initialize
@x = 42
-Loba.ts production: true
+Loba.ts log: true, production: true
@y = "Charlie"
end
def hello
-Loba.val :@x, production: true
+Loba.val :@x, log: true, production: true
puts "Hello, #{@y}" if @x == 42
Loba.ts true
end
end
HelloWorld.new.hello
@@ -160,10 +170,10 @@
```
And then execute:
```bash
-bundle
+bundle install
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.