Merge pull request #27 from brightdigit/release/0.1.0

Release/0.1.0

.github/workflows/macOS.yml

@@ -27,20 +27,16 @@ jobs:
       env:
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
     - name: Build Documentation
-      run: sourcedocs generate --spm-module ${{ env.PACKAGE_NAME }} --output-folder docs
+      run: sourcedocs generate --spm-module ${{ env.PACKAGE_NAME }}
     - name: Verify Valid Swift Package
       run: swift package dump-package | jq -e ".products | length > 0"
     - name: CocoaPods Action
       run: pod lib lint
-    - name: Upload to CodeCov.io
-      run: bash <(curl https://codecov.io/bash) -F github -F macos -n ${{ github.sha }}
-      env:
-          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
     - name: Commit files
       run: |
         git config --local user.email "[email protected]"
         git config --local user.name "GitHub Action"
         git status
-        git add docs
+        git add Documentation
         git diff-index --quiet HEAD || git commit -m "[github action] Update Docs"
         git push

.github/workflows/ubuntu.yml

@@ -12,18 +12,18 @@ jobs:
 
     steps:
     - uses: actions/checkout@v2
-    - name: Download Swift 5.1.3
-      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
-    - name: Extract Swift 5.1.3
-      run: tar xzf swift-5.1.3-RELEASE-ubuntu18.04.tar.gz
+    - name: Download Swift 5.2
+      run: wget -q https://swift.org/builds/swift-5.2-release/ubuntu1804/swift-5.2-RELEASE/swift-5.2-RELEASE-ubuntu18.04.tar.gz
+    - name: Extract Swift 5.2
+      run: tar xzf swift-5.2-RELEASE-ubuntu18.04.tar.gz
     - name: Add Path
-      run: echo "::add-path::$GITHUB_WORKSPACE/swift-5.1.3-RELEASE-ubuntu18.04/usr/bin"
+      run: echo "::add-path::$GITHUB_WORKSPACE/swift-5.2-RELEASE-ubuntu18.04/usr/bin"
     - name: Build
       run: swift build
     - name: Run tests
-      run: swift test --enable-code-coverage
+      run: swift test --enable-test-discovery --enable-code-coverage
     - name: Prepare Code Coverage
-      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
+      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
     - name: Upload to CodeCov.io
       run: bash <(curl https://codecov.io/bash) -F github -F bionic -n ${{ github.sha }}
       env:

.gitignore

@@ -168,3 +168,6 @@ Tests/AssetLibTests/Data/**/*.pdf
 Pods
 *.lcov
 Brewfile.lock.json
+
+Example/Templates/Assets.xcassets/*.imageset/Contents.json
+Example/Templates/Assets.xcassets/*.appiconset/Contents.json

docs/README.md → Documentation/Reference/README.md

@@ -8,10 +8,16 @@
 -   [AssetSpecificationMetadataProtocol](protocols/AssetSpecificationMetadataProtocol.md)
 -   [AssetSpecificationPropertiesProtocol](protocols/AssetSpecificationPropertiesProtocol.md)
 -   [AssetSpecificationProtocol](protocols/AssetSpecificationProtocol.md)
+-   [AssetURLIntializerProtocol](protocols/AssetURLIntializerProtocol.md)
 -   [ISDeviceIdiomProviderProtocol](protocols/ISDeviceIdiomProviderProtocol.md)
 -   [IdiomAppIconSpecProvider](protocols/IdiomAppIconSpecProvider.md)
 -   [IdiomScaleProviderProtocol](protocols/IdiomScaleProviderProtocol.md)
 -   [ImageIdiomDisplayGamutProtocol](protocols/ImageIdiomDisplayGamutProtocol.md)
+-   [TemplateDecoder](protocols/TemplateDecoder.md)
+-   [TemplateEncoder](protocols/TemplateEncoder.md)
+-   [TemplateResultParserProtocol](protocols/TemplateResultParserProtocol.md)
+-   [TemplateTypeParserProtocol](protocols/TemplateTypeParserProtocol.md)
+-   [TemplateWriterProtocol](protocols/TemplateWriterProtocol.md)
 
 ## Structs
 
@@ -24,13 +30,18 @@
 -   [AssetSpecificationDocument](structs/AssetSpecificationDocument.md)
 -   [AssetSpecificationMetadata](structs/AssetSpecificationMetadata.md)
 -   [AssetSpecificationProperties](structs/AssetSpecificationProperties.md)
+-   [AssetURLInitializer](structs/AssetURLInitializer.md)
 -   [ISDeviceIdiomProvider](structs/ISDeviceIdiomProvider.md)
 -   [IdiomAppIconSpecMap](structs/IdiomAppIconSpecMap.md)
 -   [IdiomScaleProvider](structs/IdiomScaleProvider.md)
 -   [ImageIdiomDisplayGamut](structs/ImageIdiomDisplayGamut.md)
 -   [ImageSetTemplate](structs/ImageSetTemplate.md)
 -   [ImageSetTemplateBuilder](structs/ImageSetTemplateBuilder.md)
 -   [Size](structs/Size.md)
+-   [TemplateDetails](structs/TemplateDetails.md)
+-   [TemplateResultParser](structs/TemplateResultParser.md)
+-   [TemplateTypeParser](structs/TemplateTypeParser.md)
+-   [TemplateWriter](structs/TemplateWriter.md)
 -   [ValuedAppearance](structs/ValuedAppearance.md)
 
 ## Enums
@@ -51,11 +62,17 @@
 -   [Luminosity](enums/Luminosity.md)
 -   [Memory](enums/Memory.md)
 -   [RenderingIntent](enums/RenderingIntent.md)
+-   [Scales](enums/Scales.md)
 -   [SizeClass](enums/SizeClass.md)
+-   [Sizes](enums/Sizes.md)
+-   [TemplateResult](enums/TemplateResult.md)
 -   [TemplateScaling](enums/TemplateScaling.md)
+-   [TemplateType](enums/TemplateType.md)
 
 ## Extensions
 
+-   [Appearance](extensions/Appearance.md)
+-   [DecodingError](extensions/DecodingError.md)
 -   [String](extensions/String.md)
 
 # Reference Documentation

docs/enums/AppleWatchScreenWidth.md → Documentation/Reference/enums/AppleWatchScreenWidth.md

@@ -6,27 +6,37 @@
 public enum AppleWatchScreenWidth: String, Codable, CaseIterable
 ```
 
+> A different version of an image for each Apple Watch screen size.
+
 ## Cases
 ### `size38`
 
 ```swift
 case size38 = "<=145"
 ```
 
+> 38mm Apple Watch.
+
 ### `size40`
 
 ```swift
 case size40 = ">161"
 ```
 
+> 40mm Apple Watch.
+
 ### `size42`
 
 ```swift
 case size42 = ">145"
 ```
 
+> 42mm Apple Watch.
+
 ### `size44`
 
 ```swift
 case size44 = ">183"
 ```
+
+> 44mm Apple Watch.

Documentation/Reference/enums/Contrast.md

@@ -0,0 +1,27 @@
+**ENUM**
+
+# `Contrast`
+
+```swift
+public enum Contrast: String, AppearanceValue
+```
+
+> Apperance Value for providing images with greater visual separation between adjoining colors.
+> https://developer.apple.com/documentation/uikit/uiimage/providing_images_for_different_appearances
+
+## Cases
+### `high`
+
+```swift
+case high
+```
+
+> Apperance Value for providing images with greater visual separation between adjoining colors.
+> https://developer.apple.com/documentation/uikit/uiimage/providing_images_for_different_appearances
+
+## Properties
+### `appearanceValue`
+
+```swift
+public var appearanceValue: String
+```

docs/enums/DeviceSubType.md → Documentation/Reference/enums/DeviceSubType.md

@@ -46,3 +46,5 @@ case size44 = "44mm"
 ```swift
 case macCatalyst = "mac-catalyst"
 ```
+
+> For ImageSets which will be used in mac Catalyst apps.

docs/enums/DisplayGamut.md → Documentation/Reference/enums/DisplayGamut.md

@@ -6,15 +6,21 @@
 public enum DisplayGamut: String, Codable, CaseIterable
 ```
 
+> The color gamut of the device display.
+
 ## Cases
 ### `sRGB`
 
 ```swift
 case sRGB
 ```
 
+> The image uses the standard sRGB color space.
+
 ### `displayP3`
 
 ```swift
 case displayP3 = "display-P3"
 ```
+
+> The image uses a wide gamut color space.

docs/enums/GraphicsFeatureSet.md → Documentation/Reference/enums/GraphicsFeatureSet.md

@@ -6,6 +6,8 @@
 public enum GraphicsFeatureSet: String, Codable
 ```
 
+> The graphics feature set required for the item.
+
 ## Cases
 ### `metal1v2`
 
@@ -68,3 +70,5 @@ case metal4v1
 ```swift
 case apple6
 ```
+
+> The item requires features in MTLGPUFamilyApple6

docs/enums/ImageSetDevice.md → Documentation/Reference/enums/ImageSetDevice.md

@@ -70,3 +70,5 @@ case car
 ```swift
 case macCatalyst
 ```
+
+> The image for an mac Catalyst app.

Documentation/Reference/enums/LanguageDirection.md

@@ -0,0 +1,29 @@
+**ENUM**
+
+# `LanguageDirection`
+
+```swift
+public enum LanguageDirection: String, Codable
+```
+
+> The horizontal display direction for the image.
+
+## Cases
+### `leftToRight`
+
+```swift
+case leftToRight = "left-to-right"
+```
+
+>
+> The image is used for display in left-to-right languages.
+> The image is mirrored in right-to-left languages unless a right-to-left version of the image is provided.
+
+### `rightToLeft`
+
+```swift
+case rightToLeft = "right-to-left"
+```
+
+> The image is used for display in right-to-left languages.
+> The image is mirrored in left-to-right languages unless a left-to-right version of the image is provided.

docs/enums/Luminosity.md → Documentation/Reference/enums/Luminosity.md

@@ -6,19 +6,25 @@
 public enum Luminosity: String, AppearanceValue
 ```
 
+> Luminosity appearance values for dark-mode and light-mode.
+
 ## Cases
 ### `light`
 
 ```swift
 case light
 ```
 
+> Light mode appearance value.
+
 ### `dark`
 
 ```swift
 case dark
 ```
 
+> Dakr mode appearance value.
+
 ## Properties
 ### `appearanceValue`
 

docs/enums/Memory.md → Documentation/Reference/enums/Memory.md

@@ -6,33 +6,45 @@
 public enum Memory: String, Codable
 ```
 
+> The minimum device memory configuration required by the data item.
+
 ## Cases
 ### `requires1GB`
 
 ```swift
 case requires1GB = "1GB"
 ```
 
+> The device needs at least a 1GB memory configuration.
+
 ### `requires2GB`
 
 ```swift
 case requires2GB = "2GB"
 ```
 
+> The device needs at least a 2GB memory configuration.
+
 ### `requires3GB`
 
 ```swift
 case requires3GB = "3GB"
 ```
 
+> The device needs at least a 3GB memory configuration.
+
 ### `requires4GB`
 
 ```swift
 case requires4GB = "4GB"
 ```
 
+> The device needs at least a 4GB memory configuration.
+
 ### `requires6GB`
 
 ```swift
 case requires6GB = "6GB"
 ```
+
+> The device needs at least a 6GB memory configuration.

Documentation/Reference/enums/RenderingIntent.md

@@ -0,0 +1,26 @@
+**ENUM**
+
+# `RenderingIntent`
+
+```swift
+public enum RenderingIntent: String, Codable
+```
+
+> Specifies if the image is a template for use with visual effects such as replacing colors.
+
+## Cases
+### `original`
+
+```swift
+case original
+```
+
+> Render as the original image.
+
+### `template`
+
+```swift
+case template
+```
+
+> Use the image as a template for visual effects such as replacing colors.

Documentation/Reference/enums/Scales.md

@@ -0,0 +1,34 @@
+**ENUM**
+
+# `Scales`
+
+```swift
+public enum Scales: Float
+```
+
+> Prebuilt scales for App Icons and Image Sets.
+
+## Cases
+### `unscaled1x`
+
+```swift
+case unscaled1x = 1.0
+```
+
+> Targeted for unscaled displays.
+
+### `retina2x`
+
+```swift
+case retina2x = 2.0
+```
+
+> Targeted for Retina displays.
+
+### `highdensityretina3x`
+
+```swift
+case highdensityretina3x = 3.0
+```
+
+> Targeted for Retina displays with higher density such as those on the iPhone 6 Plus.