KalibroClient is a Ruby gem intended to be an interface for Ruby applications who want to use the open source code analysis webservice Kalibro (http://gitorious.org/kalibro/kalibro).
Add this line to your application's Gemfile:
gem 'kalibro_client'
And then execute:
$ bundle
Or install it yourself as:
$ gem install kalibro_client
KalibroClient is intended to be an easy interface that encapsulates the usage of all the Kalibro service's endpoints. So have a look at the available entities at lib/kalibro_client/entities.
All the entities are subclasses from Model, so have a good look at it. Specially notice that all the entities have methods:
saveexists?finddestroy
These four methods should be useful.
We hope to make available soon a full documentation on RDoc that will make easier to understand all this.
A good example on how to get everything from KalibroClient should be Mezuro. So, have a look there for some examples.
Acceptance tests with the Kalibro webservice can be painful. But we've created cucumber hooks that make it easy.
Just add to your env.rb the following:
require 'kalibro_client/kalibro_cucumber_helpers/hooks.rb'
The test configurations available are:
- database
- user
- password
- psql_file_path
- query_file_path
- kalibro_home
- tomcat_user
- tomcat_group
- tomcat_restart_command
An example on how to change them is:
KalibroClient::KalibroCucumberHelpers.configure do |config|
config.database = "kalibro_test"
end
We hope to make available soon an YAML parser for test configurations.
- Install RVM (rvm.io)
- Fork it
- Run
bundle install - Create your feature branch (
git checkout -b my-new-feature) - Make your modifications and changes
- Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request