Darko helps you debug. A great use case for Darko is if you want to know exactly when a piece of data is accessed or mutated. This enables you to quickly get to the bottom of where something is happening.
Just like Frank without the bunny suit.
Add this line to your application's Gemfile:
gem 'darko'And then execute:
$ bundle install
Or install it yourself as:
$ gem install darko
This is a super simple example with watching an instance of class Foo
require 'darko'
# Some class with something you aren't sure why is changing
class Foo
attr_accessor :data
def initialize data
@data = data
end
end
an_object = Foo.new('data')
frank = Darko::Watcher.new(an_object, :@data)
frank.enable! # this will start the object spy
foo.data << 'add some data'
frank.disable! # this will quit spying and put everything back to normal :)# You can log darko data to files too
frank = Darko::Watcher.new(an_object, :@data, true).enable! Another use case is if you are debugging some unfamiliar code, you may be trying to determine where something is being initialized at. You can use an ehancement for this.
some_object
puts some_object.initialized_at => stacktrace showing origin- Darko::Configuration class
- figure out how to follow object reassignment
- watch objects, not only object attributes
- allow watchers on method call
- stats about access
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.
Bug reports and pull requests are welcome on GitHub at https://github.com/prodion23/darko. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
All PR's are welcome :) - before merging you must provide test coverage of the feature. If you plan to do any extreme rewrites or redesigns please open an issue so we can talk about it.
The gem is available as open source under the terms of the MIT License.
TL;DR - Be nice to everyone
Everyone interacting in the Darko project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.