Merge pull request #15 from RedMadRobot/feature/export_filter

subdan · web-flow · commit 702976b1831f · 2020-07-30T13:29:33.000+03:00
Add support for exporting selected resources
diff --git a/Example/Example.xcodeproj/xcshareddata/xcschemes/Example.xcscheme b/Example/Example.xcodeproj/xcshareddata/xcschemes/Example.xcscheme
@@ -0,0 +1,78 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Scheme
+   LastUpgradeVersion = "1160"
+   version = "1.3">
+   <BuildAction
+      parallelizeBuildables = "YES"
+      buildImplicitDependencies = "YES">
+      <BuildActionEntries>
+         <BuildActionEntry
+            buildForTesting = "YES"
+            buildForRunning = "YES"
+            buildForProfiling = "YES"
+            buildForArchiving = "YES"
+            buildForAnalyzing = "YES">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "0F20186424D1B4AF002068B4"
+               BuildableName = "Example.app"
+               BlueprintName = "Example"
+               ReferencedContainer = "container:Example.xcodeproj">
+            </BuildableReference>
+         </BuildActionEntry>
+      </BuildActionEntries>
+   </BuildAction>
+   <TestAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      shouldUseLaunchSchemeArgsEnv = "YES">
+      <Testables>
+      </Testables>
+   </TestAction>
+   <LaunchAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      launchStyle = "0"
+      useCustomWorkingDirectory = "NO"
+      ignoresPersistentStateOnLaunch = "NO"
+      debugDocumentVersioning = "YES"
+      debugServiceExtension = "internal"
+      allowLocationSimulation = "YES">
+      <BuildableProductRunnable
+         runnableDebuggingMode = "0">
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "0F20186424D1B4AF002068B4"
+            BuildableName = "Example.app"
+            BlueprintName = "Example"
+            ReferencedContainer = "container:Example.xcodeproj">
+         </BuildableReference>
+      </BuildableProductRunnable>
+   </LaunchAction>
+   <ProfileAction
+      buildConfiguration = "Release"
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      savedToolIdentifier = ""
+      useCustomWorkingDirectory = "NO"
+      debugDocumentVersioning = "YES">
+      <BuildableProductRunnable
+         runnableDebuggingMode = "0">
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "0F20186424D1B4AF002068B4"
+            BuildableName = "Example.app"
+            BlueprintName = "Example"
+            ReferencedContainer = "container:Example.xcodeproj">
+         </BuildableReference>
+      </BuildableProductRunnable>
+   </ProfileAction>
+   <AnalyzeAction
+      buildConfiguration = "Debug">
+   </AnalyzeAction>
+   <ArchiveAction
+      buildConfiguration = "Release"
+      revealArchiveInOrganizer = "YES">
+   </ArchiveAction>
+</Scheme>
diff --git a/Package.swift b/Package.swift
@@ -51,8 +51,8 @@ let package = Package(
         ),
         
         .testTarget(
-            name: "figma-exportTests",
-            dependencies: ["FigmaExport"]
+            name: "FigmaExportCoreTests",
+            dependencies: ["FigmaExportCore"]
         ),
         .testTarget(
             name: "XcodeExportTests",
diff --git a/README.md b/README.md
@@ -147,7 +147,21 @@ Run `fastlane sync_colors` to run FigmaExport.
    `./figma-export images -i figma-export.yaml`
    
 
-## Parameters
+## Arguments
+
+**Export specific icons/images**
+
+If you want to export specific icons/images you can list their names in the last argument like this:
+
+`./figma-export icons "ic/24/edit"` — Exports only one icon.
+
+`./figma-export icons "ic/24/edit, ic/16/notification"` — Exports two icons
+
+`./figma-export icons "ic/24/videoplayer/*"` — Exports all icons which names starts with `ic/24/videoplayer/`
+
+`./figma-export icons` — Exports all the icons.
+
+**Configuration file**
 
 Argument `-i` or `-input` specifies path to `figma-export.yaml` file where all the properties stores: figma, ios, android.
 
diff --git a/Sources/FigmaExport/Loaders/ImagesLoader.swift b/Sources/FigmaExport/Loaders/ImagesLoader.swift
@@ -14,25 +14,54 @@ final class ImagesLoader {
         self.platform = platform
     }
 
-    func loadIcons() throws -> [ImagePack] {
+    func loadIcons(filter: String? = nil) throws -> [ImagePack] {
         if platform == .android {
-            return try _loadImages(fileId: params.lightFileId, frameName: .icons, params: SVGParams()).map { ImagePack.singleScale($0) }
+            return try _loadImages(
+                fileId: params.lightFileId,
+                frameName: .icons,
+                params: SVGParams(),
+                filter: filter
+            ).map { ImagePack.singleScale($0) }
         } else {
-            return try _loadImages(fileId: params.lightFileId, frameName: .icons, params: PDFParams()).map { ImagePack.singleScale($0) }
+            return try _loadImages(
+                fileId: params.lightFileId,
+                frameName: .icons,
+                params: PDFParams(),
+                filter: filter
+            ).map { ImagePack.singleScale($0) }
         }
     }
 
-    func loadImages() throws -> (light: [ImagePack], dark: [ImagePack]?) {
+    func loadImages(filter: String? = nil) throws -> (light: [ImagePack], dark: [ImagePack]?) {
         if platform == .android {
-            let light = try _loadImages(fileId: params.lightFileId, frameName: .illustrations, params: SVGParams())
-            let dark = try params.darkFileId.map { try _loadImages(fileId: $0, frameName: .illustrations, params: SVGParams()) }
+            let light = try _loadImages(
+                fileId: params.lightFileId,
+                frameName: .illustrations,
+                params: SVGParams(),
+                filter: filter)
+            
+            let dark = try params.darkFileId.map {
+                try _loadImages(
+                    fileId: $0,
+                    frameName: .illustrations,
+                    params: SVGParams(),
+                    filter: filter)
+            }
             return (
                 light.map { ImagePack.singleScale($0) },
                 dark?.map { ImagePack.singleScale($0) }
             )
         } else {
-            let lightImages = try _loadPNGImages(fileId: params.lightFileId, frameName: .illustrations)
-            let darkImages = try params.darkFileId.map { try _loadPNGImages(fileId: $0, frameName: .illustrations) }
+            let lightImages = try _loadPNGImages(
+                fileId: params.lightFileId,
+                frameName: .illustrations,
+                filter: filter)
+            let darkImages = try params.darkFileId.map {
+                try _loadPNGImages(
+                    fileId: $0,
+                    frameName: .illustrations,
+                    filter: filter)
+            }
             return (
                 lightImages,
                 darkImages
@@ -42,33 +71,41 @@ final class ImagesLoader {
 
     // MARK: - Helpers
 
-    private func fetchImageComponents(fileId: String, frameName: FrameName) throws -> [NodeId: Component] {
-        let components = try loadComponents(fileId: fileId)
+    private func fetchImageComponents(fileId: String, frameName: FrameName, filter: String? = nil) throws -> [NodeId: Component] {
+        var components = try loadComponents(fileId: fileId)
             .filter {
                 $0.containingFrame.name == frameName.rawValue &&
                     ($0.description == platform.rawValue ||
                         $0.description == nil || $0.description == "")
             }
+        
+        if let filter = filter {
+            let assetsFilter = AssetsFilter(filter: filter)
+            components = components.filter { component -> Bool in
+                assetsFilter.match(name: component.name)
+            }
+        }
+        
         return Dictionary(uniqueKeysWithValues: components.map { ($0.nodeId, $0) })
     }
 
-    private func _loadImages(fileId: String, frameName: FrameName, params: FormatParams) throws -> [Image] {
-        let imagesDict = try fetchImageComponents(fileId: fileId, frameName: frameName)
+    private func _loadImages(fileId: String, frameName: FrameName, params: FormatParams, filter: String? = nil) throws -> [Image] {
+        let imagesDict = try fetchImageComponents(fileId: fileId, frameName: frameName, filter: filter)
         let imagesIds: [NodeId] = imagesDict.keys.map { $0 }
-
         let imageIdToImagePath = try loadImages(fileId: fileId, nodeIds: imagesIds, params: params)
-
+        
         return imageIdToImagePath.map { (imageId, imagePath) -> Image in
-            Image(
-                name: imagesDict[imageId]!.name,
+            let name = imagesDict[imageId]!.name
+            return Image(
+                name: name,
                 url: URL(string: imagePath)!,
                 format: params.format
             )
         }
     }
 
-    private func _loadPNGImages(fileId: String, frameName: FrameName) throws -> [ImagePack] {
-        let imagesDict = try fetchImageComponents(fileId: fileId, frameName: frameName)
+    private func _loadPNGImages(fileId: String, frameName: FrameName, filter: String? = nil) throws -> [ImagePack] {
+        let imagesDict = try fetchImageComponents(fileId: fileId, frameName: frameName, filter: filter)
         let imagesIds: [NodeId] = imagesDict.keys.map { $0 }
 
         let imageIdToImagePath1 = try loadImages(fileId: fileId, nodeIds: imagesIds, params: PNGParams(scale: 1))
diff --git a/Sources/FigmaExport/Subcommands/ExportIcons.swift b/Sources/FigmaExport/Subcommands/ExportIcons.swift
@@ -18,6 +18,9 @@ extension FigmaExportCommand {
         @Option(name: .shortAndLong, default: "figma-export.yaml", help: "An input YAML file with figma and platform properties.")
         var input: String
         
+        @Argument(help: "[Optional] Name of the icons to export. For example \"ic/24/edit\" to export single icon, \"ic/24/edit, ic/16/notification\" to export several icons and \"ic/16/*\" to export all icons of size 16 pt")
+        var filter: String?
+        
         func run() throws {
             let logger = Logger(label: "com.redmadrobot.figma-export")
 
@@ -45,7 +48,7 @@ extension FigmaExportCommand {
 
             logger.info("Fetching icons info from Figma. Please wait...")
             let loader = ImagesLoader(figmaClient: client, params: params.figma, platform: .ios)
-            let images = try loader.loadIcons()
+            let images = try loader.loadIcons(filter: filter)
 
             logger.info("Processing icons...")
             let processor = ImagesProcessor(
@@ -62,7 +65,9 @@ extension FigmaExportCommand {
             
             let exporter = XcodeIconsExporter(output: output)
             let localAndRemoteFiles = exporter.export(assets: icons.map { $0.single })
-            try? FileManager.default.removeItem(atPath: assetsURL.path)
+            if filter == nil {
+                try? FileManager.default.removeItem(atPath: assetsURL.path)
+            }
 
             logger.info("Downloading remote files...")
             let localFiles = try fileDownloader.fetch(files: localAndRemoteFiles)
@@ -79,7 +84,7 @@ extension FigmaExportCommand {
             // 1. Get Icons info
             logger.info("Fetching icons info from Figma. Please wait...")
             let loader = ImagesLoader(figmaClient: client, params: params.figma, platform: .android)
-            let images = try loader.loadIcons()
+            let images = try loader.loadIcons(filter: filter)
 
             // 2. Proccess images
             logger.info("Processing icons...")
diff --git a/Sources/FigmaExport/Subcommands/ExportImages.swift b/Sources/FigmaExport/Subcommands/ExportImages.swift
@@ -17,7 +17,10 @@ extension FigmaExportCommand {
 
         @Option(name: .shortAndLong, default: "figma-export.yaml", help: "An input YAML file with figma and platform properties.")
         var input: String
-
+        
+        @Argument(help: "[Optional] Name of the images to export. For example \"img/login\" to export single image, \"img/onboarding/1, img/onboarding/2\" to export several images and \"img/onboarding/*\" to export all images from onboarding group")
+        var filter: String?
+        
         func run() throws {
             let logger = Logger(label: "com.redmadrobot.figma-export")
 
@@ -45,7 +48,7 @@ extension FigmaExportCommand {
 
             logger.info("Fetching images info from Figma. Please wait...")
             let loader = ImagesLoader(figmaClient: client, params: params.figma, platform: .ios)
-            let imagesTuple = try loader.loadImages()
+            let imagesTuple = try loader.loadImages(filter: filter)
 
             logger.info("Processing images...")
             let processor = ImagesProcessor(
@@ -59,8 +62,9 @@ extension FigmaExportCommand {
             let output = XcodeImagesOutput(assetsFolderURL: assetsURL)
             let exporter = XcodeImagesExporter(output: output)
             let localAndRemoteFiles = exporter.export(assets: images)
-            try? FileManager.default.removeItem(atPath: assetsURL.path)
-
+            if filter == nil {
+                try? FileManager.default.removeItem(atPath: assetsURL.path)
+            }
             logger.info("Downloading remote files...")
             let localFiles = try fileDownloader.fetch(files: localAndRemoteFiles)
 
@@ -76,7 +80,7 @@ extension FigmaExportCommand {
             // 1. Get Images info
             logger.info("Fetching images info from Figma. Please wait...")
             let loader = ImagesLoader(figmaClient: client, params: params.figma, platform: .android)
-            let imagesTuple = try loader.loadImages()
+            let imagesTuple = try loader.loadImages(filter: filter)
 
             // 2. Proccess images
             logger.info("Processing images...")
diff --git a/Sources/FigmaExportCore/AssetsFilter.swift b/Sources/FigmaExportCore/AssetsFilter.swift
@@ -0,0 +1,31 @@
+import Foundation
+
+public struct AssetsFilter {
+    
+    private let filters: [String]
+    
+    public init(filter: String) {
+        filters = filter
+            .split(separator: ",")
+            .map { $0.trimmingCharacters(in: .whitespaces) }
+    }
+    
+    /// Returns true if name matches with filter
+    /// - Parameters:
+    ///   - name: Name of the asset
+    ///   - filter: Name of the assets separated by comma
+    public func match(name: String) -> Bool {
+        return filters.contains(where: { filter -> Bool in
+            if filter.contains("*") {
+                return wildcard(name, pattern: filter)
+            } else {
+                return name == filter
+            }
+        })
+    }
+    
+    private func wildcard(_ string: String, pattern: String) -> Bool {
+        let pred = NSPredicate(format: "self LIKE %@", pattern)
+        return !NSArray(object: string).filtered(using: pred).isEmpty
+    }
+}
diff --git a/Tests/FigmaExportCoreTests/AssetsFilterTests.swift b/Tests/FigmaExportCoreTests/AssetsFilterTests.swift
@@ -0,0 +1,33 @@
+import XCTest
+import Foundation
+@testable import FigmaExportCore
+
+final class AssetsFilterTests: XCTestCase {
+
+    func testSingleMatch() {
+        let filter = AssetsFilter(filter: "ic/24/edit")
+
+        XCTAssert(filter.match(name: "ic/24/edit"))
+        XCTAssertFalse(filter.match(name: "ic/24/call"))
+    }
+
+    func testMultipleMatch() {
+        let filter = AssetsFilter(filter: "ic/24/edit, ic/16/notification")
+
+        XCTAssert(filter.match(name: "ic/24/edit"))
+        XCTAssert(filter.match(name: "ic/16/notification"))
+
+        XCTAssertFalse(filter.match(name: "ic/24/call"))
+        XCTAssertFalse(filter.match(name: "ic/16/edit"))
+    }
+
+    func testMatchWithAsterisk() {
+        let filter = AssetsFilter(filter: "ic/24/*")
+
+        XCTAssert(filter.match(name: "ic/24/call"))
+        XCTAssert(filter.match(name: "ic/24/test/my"))
+
+        XCTAssertFalse(filter.match(name: "ic/16/call"))
+        XCTAssertFalse(filter.match(name: "img/24/edit"))
+    }
+}
diff --git a/Tests/LinuxMain.swift b/Tests/LinuxMain.swift
diff --git a/Tests/figma-exportTests/XCTestManifests.swift b/Tests/figma-exportTests/XCTestManifests.swift
diff --git a/Tests/figma-exportTests/figma_exportTests.swift b/Tests/figma-exportTests/figma_exportTests.swift
