<commit_before># Away

[![CI Status](http://img.shields.io/travis/<NAME>/Away.svg?style=flat)](https://travis-ci.org/<NAME>/away)
[![Version](https://img.shields.io/cocoapods/v/Away.svg?style=flat)](http://cocoapods.org/pods/)
[![License](https://img.shields.io/cocoapods/l/Away.svg?style=flat)](http://cocoapods.org/pods/)
[![Platform](https://img.shields.io/cocoapods/p/Away.svg?style=flat)](http://cocoapods.org/pods/)

## About

Away is a library to generate CLLocations with distance constraints, we build this pod while developing an application that uses core location library and needed to unit-test some features.

At that point we didn't encounter something that would provide fake locations with distance constaints, so we decide to start working in Away while developing our app.

## Usage

There are 2 main functions inside Away: `buildLocation` and `buildTrip`

### buildLocation

Build location propose is to generate a single location that is some distance away from a `from` base location.

```Swift
  Away.buildLocation(3.miles(), from: baseLocation)
  Away.buildLocation(3.kilometers(), from: baseLocation)
```

It returns a CLLocation.

### buildTrip<commit_msg>[doc] adding some documentation about the bearing<commit_after># Away

[![CI Status](http://img.shields.io/travis/<NAME>/Away.svg?style=flat)](https://travis-ci.org/<NAME>/away)
[![Version](https://img.shields.io/cocoapods/v/Away.svg?style=flat)](http://cocoapods.org/pods/)
[![License](https://img.shields.io/cocoapods/l/Away.svg?style=flat)](http://cocoapods.org/pods/)
[![Platform](https://img.shields.io/cocoapods/p/Away.svg?style=flat)](http://cocoapods.org/pods/)

## About

Away is a library to generate CLLocations with distance constraints, we build this pod while developing an application that uses core location library and needed to unit-test some features.

At that point we didn't encounter something that would provide fake locations with distance constaints, so we decide to start working in Away while developing our app.

## Usage

There are 2 main functions inside Away: `buildLocation` and `buildTrip`

### buildLocation

Build location propose is to generate a single location that is some distance away from a `from` base location.
It also receives a `bearing` parameter that indicates the degree Away uses for the new location.

```Swift
  Away.buildLocation(3.miles(), from: baseLocation)
  Away.buildLocation(3.kilometers(), from: baseLocation)
  Away.buildLocation(3.kilometers(), from: baseLocation, bearing: 10)
```

This method returns an instance of CLLocation with a possible deviation minor than 0.2 meters.

### buildTrip
{'fraction_non_alphanumeric': 0.12741751990898748, 'fraction_numerical': 0.004171406901782328, 'mean_word_length': 5.26603325415677, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 8, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1803737', 'n_tokens_mistral': 849, 'n_tokens_neox': 800, 'n_words': 251}