Merge pull request #32 from koher/dev-0.6.0

Develop 0.6.0

Author: koher

.travis.yml

@@ -1,18 +1,5 @@
 matrix:
   include:
-    - os: osx
-      language: objective-c
-      osx_image: xcode9.4
-      script:
-        - set -o pipefail
-        - xcodebuild test -scheme EasyImagy-macOS -configuration Debug | xcpretty -c
-        - xcodebuild test -scheme EasyImagy-iOS -configuration Debug -sdk iphonesimulator -destination "platform=iOS Simulator,name=iPhone X" | xcpretty -c
-        - xcodebuild test -scheme EasyImagy-tvOS -configuration Debug -sdk appletvsimulator -destination "platform=tvOS Simulator,name=Apple TV 4K" | xcpretty -c
-        - xcodebuild build -scheme EasyImagy-watchOS -configuration Debug -sdk watchsimulator -destination "platform=watchOS Simulator,name=Apple Watch Series 3 - 38mm" | xcpretty -c
-        - xcodebuild test -scheme EasyImagy-macOS -configuration Release | xcpretty -c
-        - xcodebuild test -scheme EasyImagy-iOS -configuration Release -sdk iphonesimulator -destination "platform=iOS Simulator,name=iPhone X" | xcpretty -c
-        - xcodebuild test -scheme EasyImagy-tvOS -configuration Release -sdk appletvsimulator -destination "platform=tvOS Simulator,name=Apple TV 4K" | xcpretty -c
-        - xcodebuild build -scheme EasyImagy-watchOS -configuration Release -sdk watchsimulator -destination "platform=watchOS Simulator,name=Apple Watch Series 3 - 38mm" | xcpretty -c
     - os: osx
       language: objective-c
       osx_image: xcode10
@@ -39,15 +26,6 @@ matrix:
         - xcodebuild test -scheme EasyImagy-iOS -configuration Release -sdk iphonesimulator -destination "platform=iOS Simulator,name=iPhone XS" | xcpretty -c
         - xcodebuild test -scheme EasyImagy-tvOS -configuration Release -sdk appletvsimulator -destination "platform=tvOS Simulator,name=Apple TV 4K" | xcpretty -c
         - xcodebuild build -scheme EasyImagy-watchOS -configuration Release -sdk watchsimulator -destination "platform=watchOS Simulator,name=Apple Watch Series 4 - 44mm" | xcpretty -c
-    - os: osx
-      language: generic
-      osx_image: xcode9.4
-      script:
-        - swift --version
-        - swift build
-        - swift test
-        - swift build -c release
-        - swift test -c release
     - os: osx
       language: generic
       osx_image: xcode10
@@ -66,18 +44,6 @@ matrix:
         - swift test
         - swift build -c release
         - swift test -c release
-    - os: linux
-      language: generic
-      sudo: required
-      env: SWIFT_VERSION=4.1
-      install:
-        - eval "$(curl -sL https://swiftenv.fuller.li/install.sh)"
-      script:
-        - swift --version
-        - swift build
-        - swift test
-        - swift build -c release
-        - swift test -c release
     - os: linux
       language: generic
       sudo: required
@@ -100,3 +66,5 @@ matrix:
         - swift --version
         - swift build
         - swift test
+        - swift build -c release
+        - swift test -c release

EasyImagy.xcodeproj/project.pbxproj

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "0940"
+   LastUpgradeVersion = "1000"
    version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"

EasyImagy.xcodeproj/xcshareddata/xcschemes/EasyImagy-iOS.xcscheme

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "0940"
+   LastUpgradeVersion = "1000"
    version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"

EasyImagy.xcodeproj/xcshareddata/xcschemes/EasyImagy-macOS.xcscheme

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "0940"
+   LastUpgradeVersion = "1000"
    version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"

EasyImagy.xcodeproj/xcshareddata/xcschemes/EasyImagy-tvOS.xcscheme

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "0940"
+   LastUpgradeVersion = "1000"
    version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"

EasyImagy.xcodeproj/xcshareddata/xcschemes/EasyImagy-watchOS.xcscheme

@@ -1,4 +1,4 @@
-// swift-tools-version:4.0
+// swift-tools-version:4.2
 // The swift-tools-version declares the minimum version of Swift required to build this package.
 
 import PackageDescription

Package.swift

@@ -2,12 +2,12 @@
 
 [![Build Status](https://travis-ci.org/koher/EasyImagy.svg?branch=master)](https://travis-ci.org/koher/EasyImagy)
 
-_EasyImagy_ makes it easy to process images in Swift.
+_EasyImagy_ is a Swift library for image processing.
 
 ```swift
 var image = Image<RGBA<UInt8>>(named: "ImageName")!
 
-print(image[x, y])
+let pixel: RGBA<UInt8> = image[x, y]
 image[x, y] = RGBA(red: 255, green: 0, blue: 0, alpha: 127)
 image[x, y] = RGBA(0xFF00007F) // red: 255, green: 0, blue: 0, alpha: 127
 
@@ -16,7 +16,7 @@ for pixel in image {
     // ...
 }
 
-// Processes images (e.g. binarizations)
+// Image processing (e.g. binarizations)
 let binarized: Image<Bool> = image.map { $0.gray >= 127 }
 
 // From/to `UIImage`
@@ -26,9 +26,21 @@ imageView.image = image.uiImage
 
 ## Introduction
 
-Processing images by _CoreGraphics_ is complicated: various formats, old C APIs and painful memory management. _EasyImagy_ provides easier APIs to process images.
+Image processing by _CoreGraphics_ is complicated: various formats, old C APIs and painful memory management. _EasyImagy_ provides easy and Swifty APIs for image processing.
 
-Typically the `Image` type is used with the `RGBA` type. The `RGBA` is a simple structure declared as follows.
+With _EasyImagy_, images are handled as instances of the `Image` type. `Image` is a type similar to `Array`.
+
+```swift
+var image: Image<UInt8> = Image(width: 640, height: 480, pixels: [255, 248, /* ... */])
+
+let pixel: UInt8 = image[x, y]
+image[x, y] = 255
+
+let width: Int = image.width // 640
+let height: Int = image.height // 480
+```
+
+Typically `Image` is used with the `RGBA` type. `RGBA` is a simple structure declared as follows.
 
 ```swift
 struct RGBA<Channel> {
@@ -39,15 +51,17 @@ struct RGBA<Channel> {
 }
 ```
 
-You can easily access to pixels using subscripts like `image[x, y]` and also their channels using properties `red`, `green`, `blue` and `alpha`.
+Because both `Image` and `RGBA` are generic types, concrete image types have a nested type parameter like `Image<RGBA<UInt8>>` when `Image` and `RGBA` are combined.
 
-In addition, `Image` and `RGBA` provide some powerful APIs to process images. For example, it is possible to convert an image to grayscale combining `Image.map` with `RGBA.gray` in one line as shown below.
+`Image` and `RGBA` provide some powerful APIs to process images. For example, it is possible to convert an RGBA image to grayscale combining `Image.map` with `RGBA.gray` in one line as shown below.
 
 ```swift
+var image = Image<RGBA<UInt8>>(named: "ImageName")!
 let grayscale: Image<UInt8> = image.map { $0.gray }
+
 ```
 
-Another notable feature of _EasyImagy_ is that the `Image` is a `struct`, i.e. a value type, with copy-on-write. It means
+Another notable feature of _EasyImagy_ is that `Image` is a structure, i.e. a value type, with copy-on-write. It means
 
 - `Image` instances never be shared
 - defensive copying is unnecessary
@@ -281,42 +295,21 @@ imageView.image = image.uiImage
 
 ## Requirements
 
-- Swift 4 or later
-- Xcode 9 or later
+- Swift 4.2 or later
+- Xcode 10 or later
 
 ## Installation
 
 ### Swift Package Manager
 
-**Package.swift**
-
 ```swift
-// swift-tools-version:4.0
-// The swift-tools-version declares the minimum version of Swift required to build this package.
-
-import PackageDescription
-
-let package = Package(
-  ...
-  dependencies: [
-    .package(url: "https://github.com/koher/EasyImagy.git", from: "0.5.0"),
-  ],
-  targets: [
-    .target(
-      ...
-      dependencies: [
-        "EasyImagy",
-      ]),
-    ]
-)
+.package(url: "https://github.com/koher/EasyImagy.git", from: "0.6.0"),
 ```
 
 ### [Carthage](https://github.com/Carthage/Carthage)
 
-**Cartfile**
-
 ```
-github "koher/EasyImagy" ~> 0.5.0
+github "koher/EasyImagy" ~> 0.6.0
 ```
 
 ### Manually

README.md

@@ -7,16 +7,16 @@ public struct AnyImage<Pixel> : ImageProtocol {
     private var box: AnyImageBox<Pixel>
     private let lock = NSLock()
 
-    public let xRange: CountableRange<Int>
-    public let yRange: CountableRange<Int>
+    public let xRange: Range<Int>
+    public let yRange: Range<Int>
 
-    private init(box: AnyImageBox<Pixel>, xRange: CountableRange<Int>, yRange: CountableRange<Int>) {
+    private init(box: AnyImageBox<Pixel>, xRange: Range<Int>, yRange: Range<Int>) {
         self.box = box
         self.xRange = xRange
         self.yRange = yRange
     }
 
-    internal init<I : ImageProtocol>(_ image: I, xRange: CountableRange<Int>, yRange: CountableRange<Int>) where I.Pixel == Pixel {
+    internal init<I : ImageProtocol>(_ image: I, xRange: Range<Int>, yRange: Range<Int>) where I.Pixel == Pixel {
         self.box = ImageBox<I>(image)
         self.xRange = xRange
         self.yRange = yRange
@@ -46,7 +46,7 @@ public struct AnyImage<Pixel> : ImageProtocol {
         }
     }
 
-    public subscript(xRange: CountableRange<Int>, yRange: CountableRange<Int>) -> AnyImage<Pixel> {
+    public subscript(xRange: Range<Int>, yRange: Range<Int>) -> AnyImage<Pixel> {
         return AnyImage(box: self.box, xRange: xRange, yRange: yRange)
     }
 }