fastlane-plugin-localize 0.1.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b9abc2c961cdbb0dfb43d435da11531ce84445d6
-  data.tar.gz: 7e560ea153fb1b19fd10da4c506592e5c8de9513
+SHA256:
+  metadata.gz: 44a29020ea890b0cd1af66e88acec9b82365c57e3dfffc3c2947bef6d2ff243b
+  data.tar.gz: ed5be6c7cd95fa51aaf26c4f84d3b974ab4e51903984be214302f3d70be965fc
 SHA512:
-  metadata.gz: 374ea985d1bfe90ac4b9d3490979781657d3b41ae735af02e1d4a51f7e8ef9b1823868187ba475fc8aae3561de611662d8ee199b86b85135959bd748a8f1a285
-  data.tar.gz: 705afb57d00e194c0e957876069cfdb39f2fbb1aa29741d5fe38a1fd8bae01a547420706d57a35723ecc2f432507b2805adfc075a0cfa49c68b5ee2783d70660
+  metadata.gz: 112308493533f28118e0622beac78952c48a65897f637b174e119b3462f9a94ad5d0cb8b17d2d5118a4e47cde633604120a628ac441649e18a5a449525263d12
+  data.tar.gz: 44e950b5735531cc135183e5d1321eabce0c42badbed3589618126e2ed38b8a3d0a9ecce517a4199b4a03e127af235f151eaa97b1507f48f797fe5588dec7991

data/README.md

@@ -14,13 +14,38 @@ fastlane add_plugin localize
 
 Searches the code for extractable strings and allows interactive extraction to .strings file.
 
-**Note to author:** Add a more detailed description about this plugin here. If your plugin contains multiple actions, make sure to mention them here.
+- Whitelists non-extracted strings for further runs
+- Extracts as `NSLocalizedString` by default
+- Support for [Swiftgen](https://github.com/SwiftGen/SwiftGen) by supplying `use_swiftgen:true`
 
-## Example
+![Example Gif](https://github.com/num42/fastlane-plugin-localize/raw/master/Localize.gif)
 
-Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
+## Run from Commandline
 
-**Note to author:** Please set up a sample project to make it easy for users to explore what your plugin does. Provide everything that is necessary to try out the plugin in this project (including a sample Xcode/Android project if necessary)
+To show all options:
+
+```bash
+fastlane action localize
+```
+
+Example:
+
+```bash
+fastlane run localize strings_file:"Sources/Base/Supporting Files/en.lproj/Localizable.strings" file_filter:"Swiftgen,Sourcery" use_swiftgen:"true"
+```
+
+## Run from Fastfile
+
+```ruby
+desc "Search for localizable strings"
+lane :localize_strings do
+  localize(
+    strings_file: "Sources/Base/Supporting Files/en.lproj/Localizable.strings",
+    file_filter: "Swiftgen,Sourcery", # filters files with these words in their path
+    use_swiftgen: "true" # remove to use NSLocalizableString instead
+  )
+end
+```
 
 ## Run tests for this plugin
 

data/lib/fastlane/plugin/localize/actions/localize_action.rb

@@ -1,12 +1,13 @@
-require 'fastlane/action'
-require_relative '../helper/localize_helper'
+require "fastlane/action"
+require_relative "../helper/localize_helper"
 
 module Fastlane
   module Actions
     class LocalizeAction < Action
       def self.run(params)
         project = Helper::LocalizeHelper.getProject(params)
-        target = Helper::LocalizeHelper.getTarget(project)
+
+        target = Helper::LocalizeHelper.getTarget(params)
 
         files = Helper::LocalizeHelper.codeFiles(target, params)
 
@@ -14,7 +15,6 @@ module Fastlane
           Helper::LocalizeHelper.stringsFromFile(file)
         end
 
-
         matchHash = {}
 
         matches.each do |match|
@@ -22,27 +22,29 @@ module Fastlane
           matchHash[match[0]] << match
         end
 
-
         whitelist = Helper::LocalizeHelper.getWhitelist
 
         matchHash.keys
-        .map { |match|
+          .map { |match|
           match.gsub(/^\\"/, "\"").gsub(/\\"$/, "\"")
         }
-        .reject { |match|
+          .reject { |match|
           whitelist.include? match
         }
-        .each { |match|
-
-          files.flat_map do |file|
-            Helper::LocalizeHelper.showStringOccurrencesFromFile(file, match)
-          end
-
-          if UI.confirm "Extract #{match}?"
-            key = UI.input "Enter key for localization:"
-            Helper::LocalizeHelper.localize_string(match, key, files, params)
+          .each { |match|			
+		  if params[:lint_only]
+			puts "warning: #{match} is not localized"
           else
-            Helper::LocalizeHelper.addToWhitelist(match)
+            files.flat_map do |file|
+              Helper::LocalizeHelper.showStringOccurrencesFromFile(file, match)
+            end
+          
+            if UI.confirm "Extract #{match}?"
+              key = UI.input "Enter key for localization:"
+              Helper::LocalizeHelper.localize_string(match, key, files, params)
+            else
+              Helper::LocalizeHelper.addToWhitelist(match)
+            end
           end
         }
       end
@@ -67,29 +69,40 @@ module Fastlane
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(key: :localize_project,
-                                     env_name: "FL_LOCALIZE_PROJECT", # The name of the environment variable
-                                     description: "The project to localize", # a short description of this parameter
-                                     is_string: true, # true: verifies the input is a string, false: every kind of value
-                                     default_value: Helper::LocalizeHelper.getProject(nil).path # the default value if the user didn't provide one
-                                   ),
+                                       env_name: "FL_LOCALIZE_PROJECT", # The name of the environment variable
+                                       description: "The project to localize", # a short description of this parameter
+                                       is_string: true, # true: verifies the input is a string, false: every kind of value
+                                       default_value: Helper::LocalizeHelper.getProject(nil).path # the default value if the user didn't provide one
+            ),
+          FastlaneCore::ConfigItem.new(key: :localize_target,
+                                       env_name: "FL_LOCALIZE_TARGET", # The name of the environment variable
+                                       description: "The target to localize", # a short description of this parameter
+                                       is_string: true, # true: verifies the input is a string, false: every kind of value
+                                       default_value: Helper::LocalizeHelper.getTargetName(nil) # the default value if the user didn't provide one
+            ),
           FastlaneCore::ConfigItem.new(key: :use_swiftgen,
                                        env_name: "FL_LOCALIZE_USE_SWIFTGEN", # The name of the environment variable
                                        description: "Localize using Swiftgens L10n ", # a short description of this parameter
                                        is_string: false, # true: verifies the input is a string, false: every kind of value
                                        default_value: false # the default value if the user didn't provide one
-                                      ),
+            ),
           FastlaneCore::ConfigItem.new(key: :strings_file,
                                        env_name: "FL_LOCALIZE_STRINGS_FILE",
                                        description: "The stringsfile to write to",
                                        is_string: true, # true: verifies the input is a string, false: every kind of value
                                        default_value: "Localizable.strings" # the default value if the user didn't provide one,
-                                     ),
-           FastlaneCore::ConfigItem.new(key: :file_filter,
-                                         env_name: "FL_LOCALIZE_FILE_FILTER",
-                                         description: "Filter strings for file paths to ignore, separated by commas",
-                                         optional: true,
-                                         is_string: false
-                                       )
+            ),
+          FastlaneCore::ConfigItem.new(key: :file_filter,
+                                       env_name: "FL_LOCALIZE_FILE_FILTER",
+                                       description: "Filter strings for file paths to ignore, separated by commas",
+                                       optional: true,
+                                       is_string: false),
+          FastlaneCore::ConfigItem.new(key: :lint_only,
+                                       env_name: "FL_LOCALIZE_LINT_ONLY", # The name of the environment variable
+                                       description: "Only lint and print warnings for unlocalized strings. ", # a short description of this parameter
+                                       is_string: false, # true: verifies the input is a string, false: every kind of value
+                                       default_value: false # the default value if the user didn't provide one
+            ),
         ]
       end
 

data/lib/fastlane/plugin/localize/helper/localize_helper.rb

@@ -1,4 +1,4 @@
-require 'fastlane_core/ui/ui'
+require "fastlane_core/ui/ui"
 
 module Fastlane
   UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
@@ -9,8 +9,7 @@ module Fastlane
       # as `Helper::LocalizeHelper.your_method`
       #
 
-
-      def self.getProject(options)
+      def self.getProjectPath(options)
         projectPath = nil
 
         unless options.nil?
@@ -22,52 +21,72 @@ module Fastlane
         end
 
         if projectPath.nil?
-          projectPath = Dir.entries('.').select { |f| f.end_with?(".xcodeproj") }.first
+          projectPath = Dir.entries(".").select { |f| f.end_with?(".xcodeproj") }.first
         end
 
         if projectPath.nil?
           fail "no xcodeproject found"
         end
 
-        project = Xcodeproj::Project.open(projectPath)
+        projectPath
+      end
+
+      def self.getProject(options)
+        project = Xcodeproj::Project.open(self.getProjectPath(options))
 
         project
       end
 
-      def self.getTarget(project)
+      def self.getTargetName(options)
+        project = self.getProject(options)
+
         targetName = nil
 
-        # if options[:localize_target].nil?
-        #   targetName = ENV["TARGETNAME"]
-        # end
+        unless options.nil?
+          targetName = options[:localize_target]
+        end
+
+        if targetName.nil?
+          targetName = ENV["TARGET_NAME"]
+        end
 
         if targetName.nil?
-          targetName = project.targets.first.name
+          targetName = project.targets.map { |target| target.name.to_s }.first
         end
 
         if targetName.nil?
           fail "no target found"
         end
 
+        targetName
+      end
+
+      def self.getTarget(options)
+        project = self.getProject(options)
+        targetName = self.getTargetName(options)
+
         target = project.targets.select { |target| target.name.eql? targetName }.first
 
         if target.nil?
-          fail 'no target'
+          fail "no target"
         end
 
         target
       end
 
       def self.codeFiles(target, options)
+        if options[:file_filter].nil?
+          filter = []
+        else
+          filter = (options[:file_filter]).split(",")
+        end
 
-      filter = options[:file_filter].split(",")
-
-       codeFiles = target.source_build_phase.files.to_a.map do |pbx_build_file|
-  	       pbx_build_file.file_ref.real_path.to_s
+        codeFiles = target.source_build_phase.files.to_a.map do |pbx_build_file|
+          pbx_build_file.file_ref.real_path.to_s
         end.select do |path|
-           path.end_with?(".swift")
+          path.end_with?(".swift")
         end.select do |path|
-           bool = true
+          bool = true
 
           filter.each { |filter|
             if path.include? filter
@@ -77,28 +96,24 @@ module Fastlane
 
           next bool
         end.select do |path|
-           File.exists?(path)
-       end
+          File.exists?(path)
+        end
 
         codeFiles
       end
 
       def self.stringsFromFile(file)
-
         strings = File.readlines(file).to_s.enum_for(:scan,
-          /(?<!\#imageLiteral\(resourceName:|\#imageLiteral\(resourceName: |NSLocalizedString\()\\"[^\\"\r\n]*\\"/
-        ).flat_map {Regexp.last_match}
+                                                     /(?<!\#imageLiteral\(resourceName:|\#imageLiteral\(resourceName: |NSLocalizedString\()\\"[^\\"\r\n]*\\"/).flat_map { Regexp.last_match }
         return strings
       end
 
       def self.showStringOccurrencesFromFile(file, string)
-
         line_array = File.readlines(file)
 
         File.open(file).each_with_index { |line, index|
-          if line =~ /(?<!\#imageLiteral\(resourceName:|\#imageLiteral\(resourceName: |NSLocalizedString\()#{string}/
-          then
-            hits = line_array[index-2 .. index-1] + [line_array[index].green] + line_array[index+1 .. index+2]
+          if line =~ /(?<!\#imageLiteral\(resourceName:|\#imageLiteral\(resourceName: |NSLocalizedString\()#{Regexp.escape(string)}/
+            hits = line_array[index - 2..index - 1] + [line_array[index].green] + line_array[index + 1..index + 2]
             UI.message "In file #{file} (line #{index}): \n\n#{hits.join()}"
           end
         }
@@ -109,8 +124,8 @@ module Fastlane
       end
 
       def self.addToWhitelist(string)
-        open(whitelistFilename, 'a') { |f|
-            f.puts string
+        open(whitelistFilename, "a") { |f|
+          f.puts string
         }
         UI.message "Added \"#{string}\" to #{whitelistFilename}"
       end
@@ -124,15 +139,15 @@ module Fastlane
       end
 
       def self.localize_string(string, key, files, params)
-        open(params[:strings_file], 'a') { |f|
-            f.puts "\"#{key}\" = #{string};"
+        open(params[:strings_file], "a") { |f|
+          f.puts "\"#{key}\" = #{string};"
         }
         files.each do |file_name|
           text = File.read(file_name)
 
           new_contents = text.gsub(string, replacementString(key, params))
 
-          File.open(file_name, "w") {|file| file.puts new_contents }
+          File.open(file_name, "w") { |file| file.puts new_contents }
         end
 
         UI.message "Replaced \"#{string}\" with \"#{replacementString(key, params)}\""
@@ -140,7 +155,14 @@ module Fastlane
 
       def self.replacementString(key, params)
         if params[:use_swiftgen]
-          return "L10n.#{key.gsub("." , "_").split("_").inject { |m, p| m + p.capitalize }}"
+          swiftgenKey = key.gsub(".", "_").split("_").inject { |m, p|
+            letters = p.split("")
+            letters.first.upcase!
+            p2 = letters.join
+            m + p2
+          }
+
+          return "L10n.#{swiftgenKey}"
         else
           return "NSLocalizedString(\"#{key}\")"
         end

data/lib/fastlane/plugin/localize/version.rb

@@ -1,5 +1,5 @@
 module Fastlane
   module Localize
-    VERSION = "0.1.0"
+    VERSION = "1.1.0"
   end
 end

data/lib/fastlane/plugin/localize.rb

@@ -1,10 +1,10 @@
-require 'fastlane/plugin/localize/version'
+require "fastlane/plugin/localize/version"
 
 module Fastlane
   module Localize
     # Return all .rb files inside the "actions" and "helper" directory
     def self.all_classes
-      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+      Dir[File.expand_path("**/{actions,helper}/*.rb", File.dirname(__FILE__))]
     end
   end
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-localize
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Wolfgang Lutz
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-02-19 00:00:00.000000000 Z
+date: 2022-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.204.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.204.3
+- !ruby/object:Gem::Dependency
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -86,16 +100,16 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.49.1
+        version: 1.12.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.49.1
+        version: 1.12.1
 - !ruby/object:Gem::Dependency
-  name: rubocop-require_tools
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rubocop-require_tools
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,20 +137,20 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: fastlane
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.81.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.81.0
-description: 
+        version: '0'
+description:
 email: wlut@num42.de
 executables: []
 extensions: []
@@ -152,7 +166,7 @@ homepage: https://github.com/num42/fastlane-plugin-localize
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -160,16 +174,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.1
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: Searches the code for extractable strings and allows interactive extraction
   to .strings file.