fastlane-plugin-facelift 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5d8f24a65c6678e724bdfcdb47995b28558b63a8
+  data.tar.gz: 6b0bbb3b208b753e9b58cab4ddf3f474db3af6ab
+SHA512:
+  metadata.gz: f59f28ba0251f899695bfc019f26b633bc67c24fe3c77eba26162364d61619b792cd85c73f282ab11d413fe8639609367fc32eb926630b36fec14287487c63f0
+  data.tar.gz: cab9dd45d3207d78a1ef0a91a7ae9a709e895964645aa6e42db096cf1b24d86cdc6e6e97546574e5adfd5862593523143ec90c5b0c04acdfc1b06827d9912970

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Richard Szalay <richard.szalay@mullenloweprofero.com>
+
+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,79 @@
+# facelift plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-facelift)
+
+## Getting Started
+
+This project is a [fastlane](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-facelift`, add it to your project by running:
+
+```bash
+fastlane add_plugin facelift
+```
+
+## About facelift
+
+Applies changes to plists and app icons inside a compiled IPA, combined with sigh's `resign` it makes it easy to release an IPA with different configurations 🎭
+
+## 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`. 
+
+Here's some usage scenarios:
+
+```ruby
+# Modify Info.plist
+facelift(
+  ipa: "example/Example.ipa",
+
+  iconset: "example/Blue.appiconset",
+
+  # Set a hash of plist values
+  plist_values: {
+    ":CustomApplicationKey" => "Replaced!"
+  },
+
+  # Run a list of PlistBuddy commands
+  plist_commands: [
+    "Delete :DebugApplicationKey"
+  ]
+)
+
+# Modify a different plist
+facelift(
+  ipa: "example/Example.ipa",
+  plist_file: "GoogleService-Info.plist",
+  
+  plist_values: {
+    ":TRACKING_ID" => "UA-22222222-22"
+  }
+)
+```
+
+## 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://github.com/fastlane/fastlane/blob/master/fastlane/docs/PluginsTroubleshooting.md) doc in the main `fastlane` repo.
+
+## Using `fastlane` Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://github.com/fastlane/fastlane/blob/master/fastlane/docs/Plugins.md).
+
+## About `fastlane`
+
+`fastlane` is the easiest way to automate building and releasing your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/facelift.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/facelift/version'
+
+module Fastlane
+  module Facelift
+    # 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::Facelift.all_classes.each do |current|
+  require current
+end

data/lib/fastlane/plugin/facelift/actions/facelift_action.rb

@@ -0,0 +1,106 @@
+module Fastlane
+  module Actions
+    class FaceliftAction < Action
+      def self.run(params)
+        params[:ipa] = File.expand_path params[:ipa]
+        raise "IPA #{params[:ipa]} does not exist" unless File.exist? params[:ipa]
+
+        params[:app_name] = (File.basename params[:ipa], ".*") + ".app" unless params[:app_name]
+
+        create_temp_dir = params[:temp_dir].nil?
+        params[:temp_dir] = Dir.mktmpdir if create_temp_dir
+        UI.verbose("Working in temp dir: #{params[:temp_dir]}")
+
+        archive = Helper::IPAArchive.new params[:ipa], params[:app_name], params[:temp_dir]
+
+        raise "IPA does not contain Payload/#{params[:app_name]}. Rename the .ipa to match the .app, or provide an app_name option value" unless archive.contains
+
+        params[:plist_file] = "Info.plist" unless params[:plist_file]
+
+        Helper::PlistPatcher.patch(
+          archive,
+          params[:plist_file],
+          params[:plist_values],
+          params[:plist_commands]
+        ) if params[:plist_values] or params[:plist_commands]
+
+        Helper::IconPatcher.patch(
+          archive,
+          params[:iconset],
+          !params[:skip_delete_icons]
+        ) if params[:iconset]
+
+        if create_temp_dir
+          UI.verbose("Removing temp dir")
+          `rm -rf #{params[:temp_dir]}`
+        end
+      end
+
+      def self.description
+        "Reconfigures .plists and icons inside a compiled IPA"
+      end
+
+      def self.authors
+        ["Richard Szalay"]
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :ipa,
+                                  env_name: "FACELIFT_IPA",
+                               description: "Path of the IPA file being modified",
+                                  optional: false,
+                                      type: String),
+
+          FastlaneCore::ConfigItem.new(key: :iconset,
+                               description: "Path to iconset to swap into the IPA (ignores :plist option)",
+                                  optional: true,
+                                      type: String),
+
+          FastlaneCore::ConfigItem.new(key: :plist_file,
+                                  env_name: "FACELIFT_PLIST_FILE",
+                               description: "The name of the plist file to modify, relative to the .app bundle`",
+                                  optional: true,
+                             default_value: "Info.plist",
+                                      type: String),
+
+          FastlaneCore::ConfigItem.new(key: :plist_values,
+                               description: "Hash of plist values to set to the plist file",
+                                  optional: true,
+                                      type: Hash),
+
+          FastlaneCore::ConfigItem.new(key: :plist_commands,
+                               description: "Array of PlistBuddy commands to invoke",
+                                  optional: true,
+                                      type: Array),
+
+          # TODO: :force flag for ignoring command errors and auto-adding plist_values if non-existant
+
+          # Very optional
+          FastlaneCore::ConfigItem.new(key: :app_name,
+                                  env_name: "FACELIFT_APP_NAME",
+                               description: "The name of the .app file (including extension), if not the same as the IPA",
+                                  optional: true,
+                                      type: String),
+
+          FastlaneCore::ConfigItem.new(key: :temp_dir,
+                                  env_name: "FACELIFT_TEMP_DIR",
+                               description: "The temporary directory to work from. One will be created if not supplied",
+                                  optional: true,
+                                      type: String),
+
+          FastlaneCore::ConfigItem.new(key: :skip_delete_icons,
+                                    env_name: "FACELIFT_SKIP_DELETE_ICONS",
+                                 description: "When true, the old icon files will not be deleted from the IPA",
+                                    optional: true,
+                                default_value: false,
+                                        type: [TrueClass, FalseClass])
+        ]
+      end
+
+      def self.is_supported?(platform)
+        [:ios].include?(platform)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/facelift/helper/facelift_helper.rb

@@ -0,0 +1,12 @@
+module Fastlane
+  module Helper
+    class FaceliftHelper
+      # class methods that you define here become available in your action
+      # as `Helper::FaceliftHelper.your_method`
+      #
+      def self.show_message
+        UI.message("Hello from the facelift plugin helper!")
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/facelift/helper/icon_patcher.rb

@@ -0,0 +1,91 @@
+module Fastlane
+  module Helper
+    class IconPatcher
+      def self.patch(archive, iconset_path, delete_old_iconset)
+        plist_path = "Info.plist"
+        archive.extract(plist_path)
+
+        UI.message("Patching icons from: #{iconset_path}")
+
+        plist_buddy = PlistBuddy.new archive.local_path(plist_path)
+
+        self.delete_icons(archive, plist_buddy, delete_old_iconset)
+
+        icon_list = get_icons_from_iconset(iconset_path)
+        icon_list.group_by { |i| i[:idiom] }.each do |idiom, icons|
+          idiom_suffix = idiom == "iphone" ? "" : "~#{idiom}"
+          icons_plist_key = ":CFBundleIcons#{idiom_suffix}:CFBundlePrimaryIcon:CFBundleIconFiles"
+
+          plist_buddy.exec("Add #{icons_plist_key} array")
+
+          icons.each do |i|
+            relative_path = (i[:target]).to_s
+            local_path = archive.local_path(relative_path)
+            `cp #{i[:source]} #{local_path}`
+            archive.replace(relative_path)
+          end
+
+          icons.map { |i| i[:name] }.uniq.each_with_index do |key, index|
+            plist_buddy.exec("Add #{icons_plist_key}:#{index} string #{key}")
+          end
+        end
+
+        archive.replace(plist_path)
+      end
+
+      def self.get_icons_from_iconset(icon_set_path)
+        icon_set = File.basename(icon_set_path, ".*")
+
+        icon_set_manifest_file = File.expand_path "#{icon_set_path}/Contents.json"
+        raise ".iconset manifest #{icon_set_manifest_file} does not exist" unless File.exist? icon_set_manifest_file
+
+        icon_set_manifest = JSON.parse(File.read(icon_set_manifest_file))
+
+        return icon_set_manifest["images"].map do |entry|
+          scale_suffix = entry['scale'] == '1x' ? '' : "@" + entry['scale']
+          idiom_suffix = entry['idiom'] == "iphone" ? '' : "~" + entry['idiom']
+          file_extension = File.extname(entry['filename'])
+
+          {
+            source: "#{icon_set_path}/#{entry['filename']}",
+            name: "#{icon_set}#{entry['size']}",
+            idiom: entry['idiom'],
+            target: "#{icon_set}#{entry['size']}#{scale_suffix}#{idiom_suffix}#{file_extension}"
+          }
+        end
+      end
+
+      def self.delete_icons(archive, plist_buddy, delete_old_iconset)
+        existing_icon_set_keys = plist_buddy.parse_dict_keys(plist_buddy.exec("Print"))
+                                            .map { |k| k.match(/^CFBundleIcons(~.+)?$/) }
+                                            .select { |m| m }
+
+        existing_icon_set_keys.each do |match|
+          key = match[0]
+          idiom_suffix = match[1]
+
+          icon_list_key = ":#{key}:CFBundlePrimaryIcon:CFBundleIconFiles"
+
+          begin
+            icon_files_value = plist_buddy.exec "Print #{icon_list_key}"
+          rescue
+            next
+          end
+
+          existing_icons = plist_buddy.parse_scalar_array(icon_files_value)
+
+          if existing_icons.size && delete_old_iconset
+            icons_to_delete = existing_icons.map { |name| "#{name}#{idiom_suffix}*" }
+
+            icons_to_delete.each do |icon_to_delete|
+              archive.delete icon_to_delete
+            end
+
+          end
+
+          plist_buddy.exec "Delete #{icon_list_key}"
+        end
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/facelift/helper/ipa_archive.rb

@@ -0,0 +1,55 @@
+module Fastlane
+  module Helper
+    class IPAArchive
+      def initialize(ipa_file, app_name, temp_dir)
+        @ipa_file = ipa_file
+        @app_path = "Payload/#{app_name}"
+        @temp_dir = temp_dir
+      end
+
+      # Returns the full path to the given file within the temp dir
+      def local_path(path)
+        "#{@temp_dir}/#{@app_path}/#{path}"
+      end
+
+      # Extract files to the temp dir
+      def extract(path)
+        UI.verbose("Extracting #{@app_path}/#{path}")
+
+        Dir.chdir(@temp_dir) do
+          result = `unzip -o -q #{@ipa_file} #{@app_path}/#{path}`
+
+          if $?.exitstatus.nonzero?
+            UI.important result
+            raise "extract operation failed with exit code #{$?.exitstatus}"
+          end
+        end
+      end
+
+      # Restore extracted files from the temp dir
+      def replace(path)
+        UI.verbose("Replacing #{@app_path}/#{path}")
+        Dir.chdir(@temp_dir) do
+          `zip -q #{@ipa_file} #{@app_path}/#{path}`
+        end
+      end
+
+      # Delete path inside the ipa
+      def delete(path)
+        UI.verbose("Deleting #{@app_path}/#{path}")
+        Dir.chdir(@temp_dir) do
+          `zip -dq #{@ipa_file} #{@app_path}/#{path}`
+        end
+      end
+
+      def contains(path = nil)
+        `zipinfo -1 #{@ipa_file} #{@app_path}/#{path}`
+        $?.exitstatus.zero?
+      end
+
+      def clean
+        `rm -rf #{temp_dir}/*`
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/facelift/helper/plist_buddy.rb

@@ -0,0 +1,50 @@
+module Fastlane
+  module Helper
+    class PlistBuddy
+      def initialize(plist_file)
+        @plist_file = plist_file
+      end
+
+      def exec(command)
+        UI.verbose("/usr/libexec/PlistBuddy -c \"#{command}\" \"#{@plist_file}\"")
+        result = `/usr/libexec/PlistBuddy -c "#{command}" "#{@plist_file}"`
+
+        if $?.exitstatus.nonzero?
+          UI.important "PlistBuddy command failed: #{result}"
+          raise "PlistBuddy command failed failed with exit code #{$?.exitstatus} - #{result}"
+        end
+
+        return result
+      end
+
+      def parse_scalar_array(result)
+        # This should probably use -x and parse the xml using Nokogiri
+
+        return [] unless result =~ /\S/
+
+        result_lines = result.lines.map(&:chop)
+
+        raise "value is not an array" unless result_lines.first == "Array {"
+
+        array_values = result_lines.drop(1).take(result_lines.size - 2)
+
+        return array_values.map { |line| line[4..line.size] }
+      end
+
+      def parse_dict_keys(entry)
+        # This should probably use -x and parse the xml using Nokogiri
+
+        result_lines = entry.lines.map(&:chop)
+
+        raise "value is not an dict" unless result_lines.first == "Dict {"
+
+        keys = result_lines
+               .map { |l| l.match(/^\s{4}([^\s}]+)/) }
+               .select { |l| l }
+               .map { |l| l[1] }
+
+        return keys
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/facelift/helper/plist_patcher.rb

@@ -0,0 +1,23 @@
+module Fastlane
+  module Helper
+    class PlistPatcher
+      def self.patch(archive, plist_path, values, commands)
+        archive.extract(plist_path)
+
+        UI.message("Patching Plist: #{plist_path}")
+
+        plist_buddy = PlistBuddy.new archive.local_path(plist_path)
+
+        values.each do |key, value|
+          plist_buddy.exec "Set #{key} #{value}"
+        end if values
+
+        commands.each do |command|
+          plist_buddy.exec command
+        end if commands
+
+        archive.replace(plist_path)
+      end
+    end
+  end
+end

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

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

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-facelift
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Richard Szalay
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-11 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: 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'
+  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: 1.99.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.99.0
+description: 
+email: richard@richardszalay.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/facelift.rb
+- lib/fastlane/plugin/facelift/actions/facelift_action.rb
+- lib/fastlane/plugin/facelift/helper/facelift_helper.rb
+- lib/fastlane/plugin/facelift/helper/icon_patcher.rb
+- lib/fastlane/plugin/facelift/helper/ipa_archive.rb
+- lib/fastlane/plugin/facelift/helper/plist_buddy.rb
+- lib/fastlane/plugin/facelift/helper/plist_patcher.rb
+- lib/fastlane/plugin/facelift/version.rb
+homepage: https://github.com/richardszalay/fastlane-plugin-facelift
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Applies changes to plists and app icons inside a compiled IPA
+test_files: []