fastlane-plugin-localize 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b9abc2c961cdbb0dfb43d435da11531ce84445d6
+  data.tar.gz: 7e560ea153fb1b19fd10da4c506592e5c8de9513
+SHA512:
+  metadata.gz: 374ea985d1bfe90ac4b9d3490979781657d3b41ae735af02e1d4a51f7e8ef9b1823868187ba475fc8aae3561de611662d8ee199b86b85135959bd748a8f1a285
+  data.tar.gz: 705afb57d00e194c0e957876069cfdb39f2fbb1aa29741d5fe38a1fd8bae01a547420706d57a35723ecc2f432507b2805adfc075a0cfa49c68b5ee2783d70660

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Wolfgang Lutz <wlut@num42.de>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+# localize plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-localize)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-localize`, add it to your project by running:
+
+```bash
+fastlane add_plugin localize
+```
+
+## About 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.
+
+## Example
+
+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`.
+
+**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)
+
+## Run tests for this plugin
+
+To run both the tests, and code style validation, run
+
+```
+rake
+```
+
+To automatically fix many of the styling issues, use
+```
+rubocop -a
+```
+
+## Issues and Feedback
+
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+## Troubleshooting
+
+If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
+
+## Using _fastlane_ Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
+
+## About _fastlane_
+
+_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/localize.rb

@@ -0,0 +1,16 @@
+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__))]
+    end
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::Localize.all_classes.each do |current|
+  require current
+end

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

@@ -0,0 +1,102 @@
+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)
+
+        files = Helper::LocalizeHelper.codeFiles(target, params)
+
+        matches = files.flat_map do |file|
+          Helper::LocalizeHelper.stringsFromFile(file)
+        end
+
+
+        matchHash = {}
+
+        matches.each do |match|
+          matchHash[match[0]] = [] unless matchHash[match[0]] != nil
+          matchHash[match[0]] << match
+        end
+
+
+        whitelist = Helper::LocalizeHelper.getWhitelist
+
+        matchHash.keys
+        .map { |match|
+          match.gsub(/^\\"/, "\"").gsub(/\\"$/, "\"")
+        }
+        .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)
+          else
+            Helper::LocalizeHelper.addToWhitelist(match)
+          end
+        }
+      end
+
+      def self.description
+        "Searches the code for extractable strings and allows interactive extraction to .strings file."
+      end
+
+      def self.authors
+        ["Wolfgang Lutz"]
+      end
+
+      def self.return_value
+      end
+
+      def self.details
+        "Searches the code for extractable strings and allows interactive extraction to .strings file:"
+        "- Whitelists non-extracted strings"
+        "- Support for NSLocalizedString and Swiftgen"
+      end
+
+      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
+                                   ),
+          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
+                                       )
+        ]
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :mac].include?(platform)
+        true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,150 @@
+require 'fastlane_core/ui/ui'
+
+module Fastlane
+  UI = FastlaneCore::UI unless Fastlane.const_defined?("UI")
+
+  module Helper
+    class LocalizeHelper
+      # class methods that you define here become available in your action
+      # as `Helper::LocalizeHelper.your_method`
+      #
+
+
+      def self.getProject(options)
+        projectPath = nil
+
+        unless options.nil?
+          projectPath = options[:localize_project]
+        end
+
+        if projectPath.nil?
+          projectPath = ENV["PROJECT_FILE_PATH"]
+        end
+
+        if projectPath.nil?
+          projectPath = Dir.entries('.').select { |f| f.end_with?(".xcodeproj") }.first
+        end
+
+        if projectPath.nil?
+          fail "no xcodeproject found"
+        end
+
+        project = Xcodeproj::Project.open(projectPath)
+
+        project
+      end
+
+      def self.getTarget(project)
+        targetName = nil
+
+        # if options[:localize_target].nil?
+        #   targetName = ENV["TARGETNAME"]
+        # end
+
+        if targetName.nil?
+          targetName = project.targets.first.name
+        end
+
+        if targetName.nil?
+          fail "no target found"
+        end
+
+        target = project.targets.select { |target| target.name.eql? targetName }.first
+
+        if target.nil?
+          fail 'no target'
+        end
+
+        target
+      end
+
+      def self.codeFiles(target, options)
+
+      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
+        end.select do |path|
+           path.end_with?(".swift")
+        end.select do |path|
+           bool = true
+
+          filter.each { |filter|
+            if path.include? filter
+              bool = false
+            end
+          }
+
+          next bool
+        end.select do |path|
+           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}
+        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]
+            UI.message "In file #{file} (line #{index}): \n\n#{hits.join()}"
+          end
+        }
+      end
+
+      def self.whitelistFilename
+        "fastlane/.fastlane_localization_whitelist"
+      end
+
+      def self.addToWhitelist(string)
+        open(whitelistFilename, 'a') { |f|
+            f.puts string
+        }
+        UI.message "Added \"#{string}\" to #{whitelistFilename}"
+      end
+
+      def self.getWhitelist
+        if File.exist?(whitelistFilename)
+          return File.readlines(whitelistFilename).map(&:strip).map { |s| s.gsub(/^\\"/, "\"").gsub(/\\"$/, "\"") }
+        else
+          return []
+        end
+      end
+
+      def self.localize_string(string, key, files, params)
+        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 }
+        end
+
+        UI.message "Replaced \"#{string}\" with \"#{replacementString(key, params)}\""
+      end
+
+      def self.replacementString(key, params)
+        if params[:use_swiftgen]
+          return "L10n.#{key.gsub("." , "_").split("_").inject { |m, p| m + p.capitalize }}"
+        else
+          return "NSLocalizedString(\"#{key}\")"
+        end
+      end
+    end
+  end
+end

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

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

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-localize
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Wolfgang Lutz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-require_tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.81.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.81.0
+description: 
+email: wlut@num42.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/localize.rb
+- lib/fastlane/plugin/localize/actions/localize_action.rb
+- lib/fastlane/plugin/localize/helper/localize_helper.rb
+- lib/fastlane/plugin/localize/version.rb
+homepage: https://github.com/num42/fastlane-plugin-localize
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+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: 
+specification_version: 4
+summary: Searches the code for extractable strings and allows interactive extraction
+  to .strings file.
+test_files: []