Tutorial

Setting a New Configuration

Requisites

In order to create a Configuration, you must:

Have <%= link_to("signed up", new_user_registration_path) %> to the platform
Be <%= link_to("signed in", new_user_session_path) %>
Have already created at least one Reading Group

Introduction

In order to process a repository, Mezuro uses configurations which you specify on the <%= link_to "repository creation", tutorials_path('analyzing') %>. Here you will be briefly introduced to all the components of a configuration and then guided through the steps to create one.

Configuration components

Configuration: just a high level container for the remaining components association
Metrics: specification of which metric will be collected during the processing and how to interpret its results

Weight: for each module is given a grade which is a weighted average of all the metrics collected for the module. This is the weight of this given metric on the final grade
Aggregation Form: Not all the metrics can be collected for every module. So, if this metric can't get collected for one module, it will aggregate the children values accordingly to what this field specifies
Reading Group: specifies which set of interpretations (called readings) will be available for this metric

Reading Group: just a high level container for the readings (interpretations)

Reading: interpretation for a given value providing label, grade (this is the grade used for the weighted average mentioned above) and colour

Range: Associates number intervals to the readings of a given metric

Steps

Configuration creation

Click on "Configuration" on the upper menu
Click on "New Configuration" on the upper menu

Fill in the form with a name that must be unique
Fill in the form with a description which is not required
Click on "Save" and you should be at the configuration page now

Metric addition

From the configuration page
Click on "Add Metric"
Select one collector from the accordions, and click on the metric that you want to add

Fill in the form with a "Weight", used to calculate the final grade
Select the "Aggregation Form" that will be used for this metric
Select the "Reading Group" which will provide the interpretations for this metric
Click on "Save" and you should be at the configuration page now with the new metric added

Ranges creation

From the configuration page
Click on "Show" for the metric which you want to create ranges to
Click on "Add Range"

Fill in the form with the "Beginning" and "End" values for the interval
Fill in the form with the "Comments" which will be displayed if the metric value matches the interval
Select the "Reading" which will be used to calculate the grade, set the label and colour for this metric
Click on "Save" and you should be at the metric page now with the new range added, congratulations!