Sha256: 06e80b404dc294e88e68389627e8c7dab8ff13119564f2e2fbae3625c22bba9e

Contents?: true

Size: 1.5 KB

Versions: 2

Compression:

Stored size: 1.5 KB

Contents

## Contracted Interfaces

```ruby
MetricFu.run_dir #=> Dir.pwd
MetricFu.run_dir = some_path
MetricFu.run_path #=> Pathname(Dir.pwd)
MetricFu.root_dir
MetricFu.load_user_configuration
MetricFu.loader.loaded_files
MetricFu.lib_require(base = '',&block)
MetricFu.lib_dir #=> metric_fu/lib
MetricFu.metrics_require(&block)
MetricFu.metrics_dir #=> metric_fu/lib/metrics
MetricFu.formatter_require(&block)
MetricFu.formatter_dir #=> metric_fu/lib/formatter
MetricFu.reporting_require(&block)
MetricFu.reporting_dir #=> metric_fu/lib/reporting
MetricFu.logging_require(&block)
MetricFu.logging_dir   #=> metric_fu/lib/logging
MetricFu.errors_require(&block)
MetricFu.errors_dir    #=> metric_fu/lib/errors
MetricFu.data_structures_require(&block)
MetricFu.data_structures_dir #=> metric_fu/lib/data_structures
MetricFu.tasks_require(&block)
MetricFu.tasks_dir           #=> metric_fu/lib/tasks

MetricFu.configuration #=> MetricFu::Configuration.new
MetricFu.configuration.configure_metrics # for each metric, yield to block or runs enable, activate 
metric = MetricFu.configuration.configure_metric(:flog)
metric.run_options #=> metric.default_run_options.merge(metric.configured_run_options)
metric.enable
metric.enabled = true
metric.activate
metric.activated = true
metric.name #=> :flog
```

## Testing

`bundle exec rspec`

## Forking

## Issues / Pull Requests

* see [CONTRIBUTING](CONTRIBUTING.md)

## Building

`rake build` or `rake install`

## Releasing

1. Update lib/metric_fu/version.rb
2. Update HISTORY.md
3. `rake release`

Version data entries

2 entries across 2 versions & 1 rubygems

Version Path
metric_fu-4.8.0 DEV.md
metric_fu-4.7.4 DEV.md