danger-localizationlinter 0.0.2

data/spec/Test/Test.xcodeproj/project.xcworkspace/contents.xcworkspacedata

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Workspace
+   version = "1.0">
+   <FileRef
+      location = "self:">
+   </FileRef>
+</Workspace>

data/spec/Test/Test.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>IDEDidComputeMac32BitWarning</key>
+	<true/>
+</dict>
+</plist>

data/spec/Test/Test.xcworkspace/contents.xcworkspacedata

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Workspace
+   version = "1.0">
+   <FileRef
+      location = "group:Test.xcodeproj">
+   </FileRef>
+   <FileRef
+      location = "group:Pods/Pods.xcodeproj">
+   </FileRef>
+</Workspace>

data/spec/Test/Test.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>IDEDidComputeMac32BitWarning</key>
+	<true/>
+</dict>
+</plist>

data/spec/Test/Test/AppDelegate.swift

@@ -0,0 +1,36 @@
+//
+//  AppDelegate.swift
+//  Test
+//
+//  Created by Claire Peyron on 12/04/2021.
+//
+
+import UIKit
+
+@main
+class AppDelegate: UIResponder, UIApplicationDelegate {
+
+
+
+    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
+        // Override point for customization after application launch.
+        return true
+    }
+
+    // MARK: UISceneSession Lifecycle
+
+    func application(_ application: UIApplication, configurationForConnecting connectingSceneSession: UISceneSession, options: UIScene.ConnectionOptions) -> UISceneConfiguration {
+        // Called when a new scene session is being created.
+        // Use this method to select a configuration to create the new scene with.
+        return UISceneConfiguration(name: "Default Configuration", sessionRole: connectingSceneSession.role)
+    }
+
+    func application(_ application: UIApplication, didDiscardSceneSessions sceneSessions: Set<UISceneSession>) {
+        // Called when the user discards a scene session.
+        // If any sessions were discarded while the application was not running, this will be called shortly after application:didFinishLaunchingWithOptions.
+        // Use this method to release any resources that were specific to the discarded scenes, as they will not return.
+    }
+
+
+}
+

data/spec/Test/Test/Assets.xcassets/AccentColor.colorset/Contents.json

@@ -0,0 +1,11 @@
+{
+  "colors" : [
+    {
+      "idiom" : "universal"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

data/spec/Test/Test/Assets.xcassets/AppIcon.appiconset/Contents.json

@@ -0,0 +1,98 @@
+{
+  "images" : [
+    {
+      "idiom" : "iphone",
+      "scale" : "2x",
+      "size" : "20x20"
+    },
+    {
+      "idiom" : "iphone",
+      "scale" : "3x",
+      "size" : "20x20"
+    },
+    {
+      "idiom" : "iphone",
+      "scale" : "2x",
+      "size" : "29x29"
+    },
+    {
+      "idiom" : "iphone",
+      "scale" : "3x",
+      "size" : "29x29"
+    },
+    {
+      "idiom" : "iphone",
+      "scale" : "2x",
+      "size" : "40x40"
+    },
+    {
+      "idiom" : "iphone",
+      "scale" : "3x",
+      "size" : "40x40"
+    },
+    {
+      "idiom" : "iphone",
+      "scale" : "2x",
+      "size" : "60x60"
+    },
+    {
+      "idiom" : "iphone",
+      "scale" : "3x",
+      "size" : "60x60"
+    },
+    {
+      "idiom" : "ipad",
+      "scale" : "1x",
+      "size" : "20x20"
+    },
+    {
+      "idiom" : "ipad",
+      "scale" : "2x",
+      "size" : "20x20"
+    },
+    {
+      "idiom" : "ipad",
+      "scale" : "1x",
+      "size" : "29x29"
+    },
+    {
+      "idiom" : "ipad",
+      "scale" : "2x",
+      "size" : "29x29"
+    },
+    {
+      "idiom" : "ipad",
+      "scale" : "1x",
+      "size" : "40x40"
+    },
+    {
+      "idiom" : "ipad",
+      "scale" : "2x",
+      "size" : "40x40"
+    },
+    {
+      "idiom" : "ipad",
+      "scale" : "1x",
+      "size" : "76x76"
+    },
+    {
+      "idiom" : "ipad",
+      "scale" : "2x",
+      "size" : "76x76"
+    },
+    {
+      "idiom" : "ipad",
+      "scale" : "2x",
+      "size" : "83.5x83.5"
+    },
+    {
+      "idiom" : "ios-marketing",
+      "scale" : "1x",
+      "size" : "1024x1024"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

data/spec/Test/Test/Assets.xcassets/Contents.json

@@ -0,0 +1,6 @@
+{
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

data/spec/Test/Test/ContentView.swift

@@ -0,0 +1,21 @@
+//
+//  ContentView.swift
+//  Test
+//
+//  Created by Claire Peyron on 12/04/2021.
+//
+
+import SwiftUI
+
+struct ContentView: View {
+    var body: some View {
+        Text("Hello, world!")
+            .padding()
+    }
+}
+
+struct ContentView_Previews: PreviewProvider {
+    static var previews: some View {
+        ContentView()
+    }
+}

data/spec/Test/Test/Info.plist

@@ -0,0 +1,62 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>CFBundleDevelopmentRegion</key>
+	<string>$(DEVELOPMENT_LANGUAGE)</string>
+	<key>CFBundleExecutable</key>
+	<string>$(EXECUTABLE_NAME)</string>
+	<key>CFBundleIdentifier</key>
+	<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
+	<key>CFBundleInfoDictionaryVersion</key>
+	<string>6.0</string>
+	<key>CFBundleName</key>
+	<string>$(PRODUCT_NAME)</string>
+	<key>CFBundlePackageType</key>
+	<string>$(PRODUCT_BUNDLE_PACKAGE_TYPE)</string>
+	<key>CFBundleShortVersionString</key>
+	<string>1.0</string>
+	<key>CFBundleVersion</key>
+	<string>1</string>
+	<key>LSRequiresIPhoneOS</key>
+	<true/>
+	<key>UIApplicationSceneManifest</key>
+	<dict>
+		<key>UIApplicationSupportsMultipleScenes</key>
+		<false/>
+		<key>UISceneConfigurations</key>
+		<dict>
+			<key>UIWindowSceneSessionRoleApplication</key>
+			<array>
+				<dict>
+					<key>UISceneConfigurationName</key>
+					<string>Default Configuration</string>
+					<key>UISceneDelegateClassName</key>
+					<string>$(PRODUCT_MODULE_NAME).SceneDelegate</string>
+				</dict>
+			</array>
+		</dict>
+	</dict>
+	<key>UIApplicationSupportsIndirectInputEvents</key>
+	<true/>
+	<key>UILaunchStoryboardName</key>
+	<string>LaunchScreen</string>
+	<key>UIRequiredDeviceCapabilities</key>
+	<array>
+		<string>armv7</string>
+	</array>
+	<key>UISupportedInterfaceOrientations</key>
+	<array>
+		<string>UIInterfaceOrientationPortrait</string>
+		<string>UIInterfaceOrientationLandscapeLeft</string>
+		<string>UIInterfaceOrientationLandscapeRight</string>
+	</array>
+	<key>UISupportedInterfaceOrientations~ipad</key>
+	<array>
+		<string>UIInterfaceOrientationPortrait</string>
+		<string>UIInterfaceOrientationPortraitUpsideDown</string>
+		<string>UIInterfaceOrientationLandscapeLeft</string>
+		<string>UIInterfaceOrientationLandscapeRight</string>
+	</array>
+</dict>
+</plist>

data/spec/Test/Test/SceneDelegate.swift

@@ -0,0 +1,63 @@
+//
+//  SceneDelegate.swift
+//  Test
+//
+//  Created by Claire Peyron on 12/04/2021.
+//
+
+import UIKit
+import SwiftUI
+
+class SceneDelegate: UIResponder, UIWindowSceneDelegate {
+
+    var window: UIWindow?
+
+
+    func scene(_ scene: UIScene, willConnectTo session: UISceneSession, options connectionOptions: UIScene.ConnectionOptions) {
+        // Use this method to optionally configure and attach the UIWindow `window` to the provided UIWindowScene `scene`.
+        // If using a storyboard, the `window` property will automatically be initialized and attached to the scene.
+        // This delegate does not imply the connecting scene or session are new (see `application:configurationForConnectingSceneSession` instead).
+
+        // Create the SwiftUI view that provides the window contents.
+        let contentView = ContentView()
+
+        // Use a UIHostingController as window root view controller.
+        if let windowScene = scene as? UIWindowScene {
+            let window = UIWindow(windowScene: windowScene)
+            window.rootViewController = UIHostingController(rootView: contentView)
+            self.window = window
+            window.makeKeyAndVisible()
+        }
+    }
+
+    func sceneDidDisconnect(_ scene: UIScene) {
+        // Called as the scene is being released by the system.
+        // This occurs shortly after the scene enters the background, or when its session is discarded.
+        // Release any resources associated with this scene that can be re-created the next time the scene connects.
+        // The scene may re-connect later, as its session was not necessarily discarded (see `application:didDiscardSceneSessions` instead).
+    }
+
+    func sceneDidBecomeActive(_ scene: UIScene) {
+        // Called when the scene has moved from an inactive state to an active state.
+        // Use this method to restart any tasks that were paused (or not yet started) when the scene was inactive.
+    }
+
+    func sceneWillResignActive(_ scene: UIScene) {
+        // Called when the scene will move from an active state to an inactive state.
+        // This may occur due to temporary interruptions (ex. an incoming phone call).
+    }
+
+    func sceneWillEnterForeground(_ scene: UIScene) {
+        // Called as the scene transitions from the background to the foreground.
+        // Use this method to undo the changes made on entering the background.
+    }
+
+    func sceneDidEnterBackground(_ scene: UIScene) {
+        // Called as the scene transitions from the foreground to the background.
+        // Use this method to save data, release shared resources, and store enough scene-specific state information
+        // to restore the scene back to its current state.
+    }
+
+
+}
+

data/spec/Test/Test/all_target_main_language.yml

@@ -0,0 +1 @@
+Test: en

data/spec/Test/Test/en.lproj/LaunchScreen.storyboard

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<document type="com.apple.InterfaceBuilder3.CocoaTouch.Storyboard.XIB" version="3.0" toolsVersion="13122.16" targetRuntime="iOS.CocoaTouch" propertyAccessControl="none" useAutolayout="YES" launchScreen="YES" useTraitCollections="YES" useSafeAreas="YES" colorMatched="YES" initialViewController="01J-lp-oVM">
+    <dependencies>
+        <plugIn identifier="com.apple.InterfaceBuilder.IBCocoaTouchPlugin" version="13104.12"/>
+        <capability name="Safe area layout guides" minToolsVersion="9.0"/>
+        <capability name="documents saved in the Xcode 8 format" minToolsVersion="8.0"/>
+    </dependencies>
+    <scenes>
+        <!--View Controller-->
+        <scene sceneID="EHf-IW-A2E">
+            <objects>
+                <viewController id="01J-lp-oVM" sceneMemberID="viewController">
+                    <view key="view" contentMode="scaleToFill" id="Ze5-6b-2t3">
+                        <rect key="frame" x="0.0" y="0.0" width="375" height="667"/>
+                        <autoresizingMask key="autoresizingMask" widthSizable="YES" heightSizable="YES"/>
+                        <color key="backgroundColor" xcode11CocoaTouchSystemColor="systemBackgroundColor" cocoaTouchSystemColor="whiteColor"/>
+                        <viewLayoutGuide key="safeArea" id="6Tk-OE-BBY"/>
+                    </view>
+                </viewController>
+                <placeholder placeholderIdentifier="IBFirstResponder" id="iYj-Kq-Ea1" userLabel="First Responder" sceneMemberID="firstResponder"/>
+            </objects>
+            <point key="canvasLocation" x="53" y="375"/>
+        </scene>
+    </scenes>
+</document>

data/spec/Test/Test/en.lproj/localizable.strings

@@ -0,0 +1,3 @@
+"common_key" = "common_value";
+"english_key" = "english_value";
+"common_parametered_key" = "value %@";

data/spec/Test/Test/fr.lproj/LaunchScreen.storyboard

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<document type="com.apple.InterfaceBuilder3.CocoaTouch.Storyboard.XIB" version="3.0" toolsVersion="13122.16" targetRuntime="iOS.CocoaTouch" propertyAccessControl="none" useAutolayout="YES" launchScreen="YES" useTraitCollections="YES" useSafeAreas="YES" colorMatched="YES" initialViewController="01J-lp-oVM">
+    <dependencies>
+        <plugIn identifier="com.apple.InterfaceBuilder.IBCocoaTouchPlugin" version="13104.12"/>
+        <capability name="Safe area layout guides" minToolsVersion="9.0"/>
+        <capability name="documents saved in the Xcode 8 format" minToolsVersion="8.0"/>
+    </dependencies>
+    <scenes>
+        <!--View Controller-->
+        <scene sceneID="EHf-IW-A2E">
+            <objects>
+                <viewController id="01J-lp-oVM" sceneMemberID="viewController">
+                    <view key="view" contentMode="scaleToFill" id="Ze5-6b-2t3">
+                        <rect key="frame" x="0.0" y="0.0" width="375" height="667"/>
+                        <autoresizingMask key="autoresizingMask" widthSizable="YES" heightSizable="YES"/>
+                        <color key="backgroundColor" xcode11CocoaTouchSystemColor="systemBackgroundColor" cocoaTouchSystemColor="whiteColor"/>
+                        <viewLayoutGuide key="safeArea" id="6Tk-OE-BBY"/>
+                    </view>
+                </viewController>
+                <placeholder placeholderIdentifier="IBFirstResponder" id="iYj-Kq-Ea1" userLabel="First Responder" sceneMemberID="firstResponder"/>
+            </objects>
+            <point key="canvasLocation" x="53" y="375"/>
+        </scene>
+    </scenes>
+</document>

data/spec/Test/Test/fr.lproj/localizable.strings

@@ -0,0 +1,3 @@
+"common_key" = "valeur_commune";
+"french_key" = "valeur_francaise";
+"common_parametered_key" = "valeur sans parametre";

data/spec/localizationofficer_spec.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+require "#{File.dirname(__FILE__)}/../ext/localizationlinter/localizationlinter.rb"
+require File.expand_path('spec_helper', __dir__)
+
+# rubocop:disable Metrics/BlockLength
+module Danger
+  describe Danger::DangerLocalizationlinter do
+    it 'should be a plugin' do
+      expect(Danger::DangerLocalizationlinter.new(nil)).to be_a Danger::Plugin
+    end
+
+    describe 'with Dangerfile' do
+      before do
+        @fixtures_path = "#{File.dirname(__FILE__)}/support/fixtures"
+        @dangerfile = testing_dangerfile
+        @my_plugin = @dangerfile.localizationlinter
+        @my_plugin.verbose = true
+        @my_plugin.clean_after_execution = false
+        @my_plugin.language_configuration_path = "#{@fixtures_path}/all_target_main_language.yml"
+        @my_plugin.derived_data_path = "#{@fixtures_path}/derived_data"
+        @my_plugin.resource_path = "#{@fixtures_path}/resources"
+        @ok_target = 'TEST_OK'
+        @main_region = 'en'
+        @test_region = 'fr'
+        @main_file_name = @my_plugin.linter.temporary_localizable_check_file_path(@ok_target, @main_region)
+      end
+
+      it 'Test main_region_for_target' do
+        expect(@my_plugin.linter.main_region_for_target(@ok_target)).to eq(@main_region)
+      end
+
+      it 'Test temporary_localizable_check_file_path' do
+        expect(@main_file_name).to eq("#{@my_plugin.derived_data_path}/#{@ok_target}_#{@main_region}")
+      end
+
+      it 'Test get_hash' do
+        # rubocop:disable Style/WordArray
+        result = {
+          'L10n' => {
+            'StringKey' => ['Int'],
+            'localized_key' => [],
+            'localized_key.sub_path_param' => ['String', 'Int'],
+            'localized_key_param' => ['String', 'String']
+          }
+        }
+        # rubocop:enable Style/WordArray
+        expect(@my_plugin.linter.get_hash(@main_file_name)).to eq(result)
+      end
+
+      it 'Test check_missing_keys_in_target OK' do
+        hash = @my_plugin.linter.get_hash(@main_file_name)
+        expect { @my_plugin.linter.check_missing_key(@ok_target, @test_region, @main_region, hash) }
+          .to raise_error(LocalizationLinter::RegionHashIdenticalAsMainOne)
+      end
+
+      it 'Test check_missing_keys_in_target KO' do
+        target = 'TEST_KO'
+        main_file_name = @my_plugin.linter.temporary_localizable_check_file_path(target, @main_region)
+        hash = @my_plugin.linter.get_hash(main_file_name)
+        fixtures_aboslute_path = "#{Dir.pwd}/spec/support/fixtures"
+        filepath = "#{fixtures_aboslute_path}/resources/#{target}/#{@test_region}.lproj/Localizable.strings"
+        # rubocop:disable Style/HashSyntax
+        result = [
+          {
+            :filename => filepath,
+            :key => 'localized_key_useless_key',
+            :line => 8,
+            :message => 'useless key: /L10n/localized_key_useless_key'
+          },
+          {
+            :filename => filepath,
+            :key => 'localized_key_missing_key',
+            :line => 0,
+            :message => 'missing key: /L10n/localized_key_missing_key'
+          },
+          {
+            :filename => filepath,
+            :key => 'localized_key.sub_path_param_wrong_param',
+            :line => 11,
+            :message => 'wrong parameters in key: /L10n/localized_key.sub_path_param_wrong_param/1/String'
+          }
+        ]
+        # rubocop:enable Style/HashSyntax
+        expect(@my_plugin.linter.check_missing_key(target, @test_region, @main_region, hash)).to eq(result)
+      end
+
+      it 'Test write_l10n_check_file with SwiftGen' do
+        target = 'TEST'
+        @my_plugin.swift_gen_path = "#{File.dirname(__FILE__)}/Test/Pods/SwiftGen/bin/swiftgen"
+        base_path = "#{@my_plugin.derived_data_path}/#{@ok_target}_#{@main_region}"
+        result_path = "#{@my_plugin.derived_data_path}/#{target}_#{@main_region}"
+        File.delete(result_path) if File.exist?(result_path)
+        @my_plugin.linter.write_l10n_check_file(target, @main_region)
+        expect(@my_plugin.linter.get_hash(result_path)).to eq(@my_plugin.linter.get_hash(base_path))
+        File.delete(result_path) if File.exist?(result_path)
+      end
+
+      it 'Test end to end in a project' do
+        @my_plugin.swift_gen_path = "#{File.dirname(__FILE__)}/Test/Pods/SwiftGen/bin/swiftgen"
+        @my_plugin.project_path = "#{File.dirname(__FILE__)}/Test/Test.xcodeproj"
+        @my_plugin.resource_path = "#{File.dirname(__FILE__)}/Test"
+        @my_plugin.language_configuration_path = "#{File.dirname(__FILE__)}/Test/Test/all_target_main_language.yml"
+        @my_plugin.derived_data_path = "#{File.dirname(__FILE__)}/Test/derived_data"
+        @my_plugin.inline_mode = true
+        @my_plugin.lint
+        output = @my_plugin.status_report[:warnings]
+        expect(output.size).to eq(3)
+        expect(output[0]).to include('useless key: /L10n/french_key')
+        expect(output[1]).to include('missing key: /L10n/english_key')
+        expect(output[2]).to include('missing key: /L10n/common_parametered_key/0')
+      end
+    end
+  end
+end
+# rubocop:enable Metrics/BlockLength