0.0
No commit activity in last 3 years
No release in over 3 years
Adds logging to your application without cluttering your code with logger calls
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.12
~> 2.1
~> 10.0
~> 3.0
~> 0.4
~> 0.1
~> 0.8
~> 0.9
 Project Readme

LogSyringe

Build Status Code Climate Test Coverage Gem Version

Add logging to your application without cluttering your code with logger calls.

Installation

Add this line to your application's Gemfile:

gem 'log_syringe'

And then execute:

$ bundle

Or install it yourself as:

$ gem install log_syringe

Usage

Write your code:

class MyClass
  def some_method(an_argument)
    do_something
  end
end

Set up a logger for LogSyringe:

LogSyringe.logger = Logger.new(STDOUT)

Inject logging with LogSyringe:

LogSyringe.define(MyClass) do
  log_method(:some_method) do |logger, instance, stats|
    logger.info(
      "some_method was called in #{instance} with params #{stats[:params]}"
    )
  end
end

For full documentation see http://www.rubydoc.info/github/meso-unimpressed/log_syringe/master

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.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then 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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/meso-unimpressed/log_syringe.