Skip to content

Commit 8eca628

Browse files
leogdionleogdion
authored
Merge pull request #8 from brightdigit/release/0.1.0
Release/0.1.0
2 parents a54156c + b05cc24 commit 8eca628

File tree

49 files changed

+805
-62
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+805
-62
lines changed

‎.github/workflows/macOS.yml‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,9 @@ jobs:
2929
- name: Build Documentation
3030
run: sourcedocs generate --spm-module ${{ env.PACKAGE_NAME }}
3131
- name: Verify Valid Swift Package
32-
run: swift package dump-package | jq -e ".products | length > 0"
32+
run: curl -s https://raw.githubusercontent.com/daveverwer/SwiftPMLibrary/master/script.sh | bash -s -- mine
3333
- name: CocoaPods Action
3434
run: pod lib lint
35-
- name: Upload to CodeCov.io
36-
run: bash <(curl https://codecov.io/bash) -F github -F macos -n ${{ github.sha }}
37-
env:
38-
CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
3935
- name: Commit files
4036
run: |
4137
git config --local user.email "action@github.com"

‎.github/workflows/ubuntu.yml‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,18 +12,18 @@ jobs:
1212

1313
steps:
1414
- uses: actions/checkout@v2
15-
- name: Download Swift 5.1.3
16-
run: wget -q https://swift.org/builds/swift-5.1.3-release/ubuntu1804/swift-5.1.3-RELEASE/swift-5.1.3-RELEASE-ubuntu18.04.tar.gz
17-
- name: Extract Swift 5.1.3
18-
run: tar xzf swift-5.1.3-RELEASE-ubuntu18.04.tar.gz
15+
- name: Download Swift 5.2
16+
run: wget -q https://swift.org/builds/swift-5.2-release/ubuntu1804/swift-5.2-RELEASE/swift-5.2-RELEASE-ubuntu18.04.tar.gz
17+
- name: Extract Swift 5.2
18+
run: tar xzf swift-5.2-RELEASE-ubuntu18.04.tar.gz
1919
- name: Add Path
20-
run: echo "::add-path::$GITHUB_WORKSPACE/swift-5.1.3-RELEASE-ubuntu18.04/usr/bin"
20+
run: echo "::add-path::$GITHUB_WORKSPACE/swift-5.2-RELEASE-ubuntu18.04/usr/bin"
2121
- name: Build
2222
run: swift build
2323
- name: Run tests
24-
run: swift test --enable-code-coverage
24+
run: swift test --enable-test-discovery --enable-code-coverage
2525
- name: Prepare Code Coverage
26-
run: llvm-cov export -format="lcov" .build/x86_64-unknown-linux/debug/${{ env.PACKAGE_NAME }}PackageTests.xctest -instr-profile .build/debug/codecov/default.profdata > info.lcov
26+
run: llvm-cov export -format="lcov" .build/x86_64-unknown-linux-gnu/debug/${{ env.PACKAGE_NAME }}PackageTests.xctest -instr-profile .build/debug/codecov/default.profdata > info.lcov
2727
- name: Upload to CodeCov.io
2828
run: bash <(curl https://codecov.io/bash) -F github -F bionic -n ${{ github.sha }}
2929
env:

‎Brewfile‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
brew "swiftformat"
22
brew "swiftlint"
33
brew "sourcedocs"
4-
brew "carthage"
5-
brew "jq"
4+
brew "carthage"

‎Documentation/Reference/README.md‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@
66
- [AnalyticsParameterEncoderProtocol](protocols/AnalyticsParameterEncoderProtocol.md)
77
- [AnalyticsParameterable](protocols/AnalyticsParameterable.md)
88
- [AnalyticsRequestBuilderProtocol](protocols/AnalyticsRequestBuilderProtocol.md)
9+
- [AnalyticsResultDecoderProtocol](protocols/AnalyticsResultDecoderProtocol.md)
910
- [AnalyticsSessionManagerProtocol](protocols/AnalyticsSessionManagerProtocol.md)
1011
- [AnalyticsTimingProtocol](protocols/AnalyticsTimingProtocol.md)
1112
- [AnalyticsTrackable](protocols/AnalyticsTrackable.md)
1213
- [AnalyticsTrackerProtocol](protocols/AnalyticsTrackerProtocol.md)
13-
- [AnalyticsValidationProtocol](protocols/AnalyticsValidationProtocol.md)
1414
- [Request](protocols/Request.md)
1515
- [Session](protocols/Session.md)
1616
- [URLSessionable](protocols/URLSessionable.md)
@@ -21,17 +21,25 @@
2121
- [AnalyticsConfiguration](structs/AnalyticsConfiguration.md)
2222
- [AnalyticsEvent](structs/AnalyticsEvent.md)
2323
- [AnalyticsException](structs/AnalyticsException.md)
24+
- [AnalyticsHitParsingResult](structs/AnalyticsHitParsingResult.md)
2425
- [AnalyticsParameterEncoder](structs/AnalyticsParameterEncoder.md)
2526
- [AnalyticsRequestBuilder](structs/AnalyticsRequestBuilder.md)
27+
- [AnalyticsResultDecoder](structs/AnalyticsResultDecoder.md)
2628
- [AnalyticsSessionManager](structs/AnalyticsSessionManager.md)
2729
- [AnalyticsTiming](structs/AnalyticsTiming.md)
2830
- [AnalyticsTracker](structs/AnalyticsTracker.md)
2931
- [AnalyticsURLSession](structs/AnalyticsURLSession.md)
3032
- [AnalyticsURLs](structs/AnalyticsURLs.md)
33+
- [AnalyticsValidation](structs/AnalyticsValidation.md)
3134
- [StringEncodingError](structs/StringEncodingError.md)
3235

36+
## Classes
37+
38+
- [AnalyticsHitParserMessage](classes/AnalyticsHitParserMessage.md)
39+
3340
## Enums
3441

42+
- [AnalyticsHitParserMessageType](enums/AnalyticsHitParserMessageType.md)
3543
- [AnalyticsHitType](enums/AnalyticsHitType.md)
3644
- [AnalyticsParameterKey](enums/AnalyticsParameterKey.md)
3745

@@ -41,6 +49,7 @@
4149
- [AnalyticsEventProtocol](extensions/AnalyticsEventProtocol.md)
4250
- [AnalyticsExceptionProtocol](extensions/AnalyticsExceptionProtocol.md)
4351
- [AnalyticsResult](extensions/AnalyticsResult.md)
52+
- [AnalyticsResultDecoderProtocol](extensions/AnalyticsResultDecoderProtocol.md)
4453
- [AnalyticsTimingProtocol](extensions/AnalyticsTimingProtocol.md)
4554
- [AnalyticsTrackerProtocol](extensions/AnalyticsTrackerProtocol.md)
4655
- [NSException](extensions/NSException.md)

‎Documentation/Reference/classes/AnalyticsHitParserMessage.md‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
**CLASS**
2+
3+
# `AnalyticsHitParserMessage`
4+
5+
```swift
6+
public class AnalyticsHitParserMessage: Codable, Equatable
7+
```
8+
9+
## Properties
10+
### `messageType`
11+
12+
```swift
13+
public let messageType: AnalyticsHitParserMessageType
14+
```
15+
16+
> Type of message.
17+
18+
### `description`
19+
20+
```swift
21+
public let description: String
22+
```
23+
24+
> Additional details or steps to fix the validation issue.
25+
26+
### `messageCode`
27+
28+
```swift
29+
public let messageCode: String?
30+
```
31+
32+
> The message code of the issue.
33+
34+
### `parameter`
35+
36+
```swift
37+
public let parameter: String?
38+
```
39+
40+
> The parameter (if applicable) causing the validation issue.
41+
42+
## Methods
43+
### `==(_:_:)`
44+
45+
```swift
46+
public static func == (lhs: AnalyticsHitParserMessage, rhs: AnalyticsHitParserMessage) -> Bool
47+
```
48+
49+
#### Parameters
50+
51+
| Name | Description |
52+
| ---- | ----------- |
53+
| lhs | A value to compare. |
54+
| rhs | Another value to compare. |
55+
56+
### `init(messageType:description:messageCode:parameter:)`
57+
58+
```swift
59+
public init(messageType: AnalyticsHitParserMessageType, description: String, messageCode: String? = nil, parameter: String? = nil)
60+
```

‎Documentation/Reference/enums/AnalyticsHitParserMessageType.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
**ENUM**
2+
3+
# `AnalyticsHitParserMessageType`
4+
5+
```swift
6+
public enum AnalyticsHitParserMessageType: String, Codable, CaseIterable
7+
```
8+
9+
> The message type of each `AnalyticsHitParserMessage`.
10+
11+
## Cases
12+
### `info`
13+
14+
```swift
15+
case info = "INFO"
16+
```
17+
18+
### `warn`
19+
20+
```swift
21+
case warn = "WARN"
22+
```
23+
24+
### `error`
25+
26+
```swift
27+
case error = "ERROR"
28+
```

‎Documentation/Reference/extensions/AnalyticsResultDecoderProtocol.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
**EXTENSION**
2+
3+
# `AnalyticsResultDecoderProtocol`
4+
5+
## Methods
6+
### `decode(_:_:)`
7+
8+
```swift
9+
func decode(_ data: Data?, _ error: Error?) -> AnalyticsResult
10+
```

‎Documentation/Reference/extensions/URLSession.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,12 @@
33
# `URLSession`
44

55
## Methods
6-
### `dataTask(with:_:)`
6+
### `dataTask(with:decodeWith:_:)`
77

88
```swift
9-
public func dataTask(with request: URLRequest, _ completion: @escaping (AnalyticsResult) -> Void) -> URLSessionableDataTask
9+
public func dataTask(with request: URLRequest,
10+
decodeWith decoder: AnalyticsResultDecoderProtocol,
11+
_ completion: @escaping (AnalyticsResult) -> Void) -> URLSessionableDataTask
1012
```
1113

1214
#### Parameters

‎Documentation/Reference/protocols/AnalyticsResultDecoderProtocol.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
**PROTOCOL**
2+
3+
# `AnalyticsResultDecoderProtocol`
4+
5+
```swift
6+
public protocol AnalyticsResultDecoderProtocol
7+
```
8+
9+
## Methods
10+
### `decode(_:)`
11+
12+
```swift
13+
func decode(_ data: Data) -> AnalyticsResult
14+
```

‎Documentation/Reference/protocols/AnalyticsValidationHitProtocol.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
**PROTOCOL**
2+
3+
# `AnalyticsValidationHitProtocol`
4+
5+
```swift
6+
public protocol AnalyticsValidationHitProtocol
7+
```

0 commit comments

Comments
 (0)