unlimit 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 864ee31974d738b3a807e9dfc681453675c8076f9e99b5e92dc8996d7b14f115
-  data.tar.gz: b6de9ff30673b7f7ee0ba00d9bb913c2192e7f6891cd39830fcf6874a6f110dd
+  metadata.gz: eba32d679ee469fe3d8409bb3ef56041a35af9702c6da8f08b2e2b73322e6ec9
+  data.tar.gz: 03e3577fb0c245213b3b95f9d9ebf1af8f71087c4323ac7ef36800ba419c095f
 SHA512:
-  metadata.gz: dacc6bbd3d729b9ead635d2f09ce7ffc0832f65534ccc7aba0954f285b62fdf8b9ea6887372f7767c042784853daa007ec5ea44386f7503d2bfc78f105bbcfc5
-  data.tar.gz: 6aa08686cd9bbeeefdaf74e1c2294671c07e1002493c5cf632d67010fc37eafa3041c8b2624a953aa125c17a7efb54dd23f8ad54a6a3fc4a0764a90abc941639
+  metadata.gz: 55aeddde38ec4c8959e712d1cddef076429bb3b6d7e6ef5a88506ce8aee93c3f1a1614df3e7ee094ede8cfac53d195c1f3534fd4a72cd4050ce51e0a48b685ab
+  data.tar.gz: a71051d83726106704497f030d2d381f7f7a6e02e11d263f303f0d71f49ad3f78be59e368baf010b7a4f66f6609d4e7bd0651b2007b865e6722cee2a41cf3de9

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
+## [0.0.3](https://github.com/biocross/unlimit/releases/tag/0.0.3)
+Released on 2019-08-24.
 
+#### Added
+- Unlimit now supports custom scripts after finishing! Just create an `.unlimit.yml` file in your project root, put your scripts in the `custom_scripts` key, and run unlimit.
+- Added `--configuration` flag to set configuration file path manually (Default: `.unlimit.yml`)
 
 ## [0.0.2](https://github.com/biocross/unlimit/releases/tag/0.0.2)
 Released on 2019-08-15.

data/Gemfile.lock

@@ -3,7 +3,8 @@ PATH
   specs:
     unlimit (0.0.2)
       configure_extensions
-      fastlane
+      fastlane (>= 2.116.0)
+      highline
       plist
       xcodeproj
 
@@ -20,7 +21,7 @@ GEM
       public_suffix (>= 2.0.2, < 4.0)
     atomos (0.1.3)
     babosa (1.0.2)
-    claide (1.0.2)
+    claide (1.0.3)
     colored (1.2)
     colored2 (3.1.2)
     commander-fastlane (4.4.6)
@@ -34,9 +35,9 @@ GEM
     digest-crc (0.4.1)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
-    dotenv (2.7.4)
+    dotenv (2.7.5)
     emoji_regex (1.0.1)
-    excon (0.65.0)
+    excon (0.66.0)
     faraday (0.15.4)
       multipart-post (>= 1.2, < 3)
     faraday-cookie_jar (0.0.6)
@@ -45,7 +46,7 @@ GEM
     faraday_middleware (0.13.1)
       faraday (>= 0.7.4, < 1.0)
     fastimage (2.1.5)
-    fastlane (2.128.1)
+    fastlane (2.129.0)
       CFPropertyList (>= 2.3, < 4.0.0)
       addressable (>= 2.3, < 3.0.0)
       babosa (>= 1.0.2, < 2.0.0)
@@ -163,7 +164,7 @@ GEM
     unf_ext (0.0.7.6)
     unicode-display_width (1.6.0)
     word_wrap (1.0.0)
-    xcodeproj (1.11.0)
+    xcodeproj (1.12.0)
       CFPropertyList (>= 2.3.3, < 4.0)
       atomos (~> 0.1.3)
       claide (>= 1.0.2, < 2.0)

data/README.md

@@ -1,4 +1,4 @@
-# Unlimit 🚀📲
+# Unlimit 🚀📲 [![Gem Version](https://badge.fury.io/rb/unlimit.svg)](https://badge.fury.io/rb/unlimit)
 
 Unlimit is a simple tool to quickly run your app on your device without worrying about the 100 device limit per developer account set by Apple. It achieves this by temporarily switching your Xcode Project to your [free](https://github.com/biocross/unlimit#do-i-require-a-paid-apple-developer-account-to-use-this) personal team (`Personal Team`).
 
@@ -8,18 +8,6 @@ Unlimit is a simple tool to quickly run your app on your device without worrying
 
 **Note that all changes unlimit makes to your project are local on your mac, and do not in anyway affect the configuration on your Apple Developer Portal.**
 
-### Why can't I just do it myself?
-
-Well, you can, if your project is simple. However, if your project has capabilities like **Push Notifications**, **Background Modes** & **App Extensions**, things get complicated, since these require you to configure your `Personal Team` with all these entitlements. Unlimit gets rid of all this mess, and gets you quickly up and running on your device.
-
-### What's the catch?
-
-Well, since unlimit temporarily removes capabilities like **App Extensions, Push Notifications** & more from your project, you **cannot** test these features on your device when using your personal team.
-
-### How do I undo unlimit's changes?
-
-We recommend you run unlimit when you have no staged changes, so that you can simple go back by running `git reset --hard` when you're done testing on your device.
-
 ## Installation
 
 If your iOS/Mac project does not have a `Gemfile` yet, [learn how to set it up here](https://www.mokacoding.com/blog/ruby-for-ios-developers-bundler/). It's highly recommended you use [**bundler**](https://bundler.io/) to maintain consistent versions of tools like `cocoapods`, `fastlane` etc within your team. 
@@ -43,6 +31,8 @@ After installing the gem, just run:
 
 and unlimit will do it's magic.
 
+If you need to perform additional actions after unlimit finishes, see [custom scripts](https://github.com/biocross/unlimit#custom-scripts).
+
 ## Parameters
 All these parameters are optional, as unlimit can **autodetect** most of these. You can use these when unlimit is unable to figure them out, or to pass in overrides.
 
@@ -52,14 +42,51 @@ All these parameters are optional, as unlimit can **autodetect** most of these.
 | `target`  | The **app target** you want to run on your device | `--target MyApp` |
 | `plist`   | The **path** to your app's **Info.plist** file | `--plist MyApp/MyApp-Info.plist` |
 | `team_id`   | The Code Signing **Team ID** to use | `--team_id A1B2C3D4E5A` |
+| `configuration`   | The configuration file to use to read your custom scripts, defaults to `.unlimit.yml` (See below) | `--configuration config.yml` |
 | `keep_fabric`   | Unlimit automatically disables Fabric's build phase script, to avoid the annoying `New app ID added` email sent by Fabric. Use this flag for keep the Fabric script. (Note: This does not affect Fabric/Crashlytics functionality, only disables it's dSYM uploading shell script) | `--keep_fabric` |
 | `version`   | Print the current unlimit version you're using and exit | `--version` |
 
+## Custom Scripts
+
+To perform additional actions after unlimit finishes, use custom scripts!
+
+Just create an `.unlimit.yml` file in your project root, and put in your scripts inside the `custom_scripts` array:
+
+For example, the following unlimit file runs a script to modify a plist using PlistBuddy:
+
+```yaml
+custom_scripts:
+  - /usr/libexec/PlistBuddy -c "Set :AppGroup UNLIMIT_APP_GROUP_NAME" UNLIMIT_PLIST_PATH
+
+```
+Like the above script, You can use a few handy variables that unlimit will automatically replace with real values in your scripts:
+
+| Variable | Description |
+| --- | --- |
+| `UNLIMIT_PROJECT_PATH` | The path to the current **.xcodeproj** |
+| `UNLIMIT_TARGET_NAME`  | The current target name |
+| `UNLIMIT_PLIST_PATH`   | The **path** to your target's **Info.plist** file |
+| `UNLIMIT_TEAM_ID`   | The Code Signing **Team ID** in use |
+| `UNLIMIT_APP_BUNDLE_ID` | The unique app **bundle ID** generated by unlimit |
+| `UNLIMIT_APP_GROUP_NAME`   | The **app group id** generated by unlimit |
+
 ## Contributing
 
 Bug reports and pull requests are welcome. Any feedback or feature suggesions are also encouraged.
 
-## More FAQs
+## FAQs
+
+### Why can't I just do it myself?
+
+Well, you can, if your project is simple. However, if your project has capabilities like **Push Notifications**, **Background Modes** & **App Extensions**, things get complicated, since these require you to configure your `Personal Team` with all these entitlements. Unlimit gets rid of all this mess, and gets you quickly up and running on your device.
+
+### What's the different between using unlimit and running on a registered device?
+
+Well, since unlimit temporarily removes capabilities like **App Extensions, Push Notifications** & more from your project, you **cannot** test these features on your device when using your personal team.
+
+### How do I undo unlimit's changes?
+
+We recommend you run unlimit when you have no staged changes, so that you can simple go back by running `git reset --hard` when you're done testing on your device.
 
 ### Do I require a paid apple developer account to use this?
 

data/bin/unlimit

@@ -12,6 +12,7 @@ OptionParser.new do |opt|
   opt.on('--plist INFO_PLIST') { |o| options['plist_path'] = o }
   opt.on('--target TARGET_NAME') { |o| options['target_name'] = o }
   opt.on('--team_id TEAM_ID') { |o| options['team_id'] = o }
+  opt.on('--configuration CONFIGURATION_YAML_FILE') { |o| options['configuration'] = o }
   opt.on('--keep_fabric') { |_o| options['keep_fabric'] = true }
   opt.on('--version') { unlimiter.showVersion }
 end.parse!

data/lib/unlimit/version.rb

@@ -1,3 +1,3 @@
 module Unlimit
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/unlimit.rb

@@ -4,6 +4,7 @@ require 'unlimit/version'
 require 'xcodeproj'
 require 'securerandom'
 require 'json'
+require 'yaml'
 require 'plist'
 require 'open3'
 require 'highline'
@@ -13,11 +14,13 @@ PlistPathKey = 'plist_path'
 TargetNameKey = 'target_name'
 TeamIDKey = 'team_id'
 KeepFabricKey = 'keep_fabric'
+ProjectConfigurationFileKey = 'configuration'
 InfoPlistBuildSettingKey = 'INFOPLIST_FILE'
 ProductTypeApplicationTarget = 'com.apple.product-type.application'
 FastlaneEnvironmentVariables = 'LC_ALL=en_US.UTF-8 LANG=en_US.UTF-8 FASTLANE_SKIP_UPDATE_CHECK=true'
 CapabilitiesWhitelist = ['com.apple.SafariKeychain'].freeze
 FastFilePath = 'fastlane/Fastfile'
+DefaultProjectConfigurationFilePath = '.unlimit.yml'
 Divider = '================================================'
 
 module Unlimit
@@ -46,7 +49,9 @@ module Unlimit
       target_name = ''
       personal_team_id = ''
       uses_app_groups = false
+      app_group_name = ''
       entitlements_file = ''
+      project_configuration_file = ''
       extensions = []
       target = nil
 
@@ -114,6 +119,18 @@ module Unlimit
         end
       end
 
+      if options.key?(ProjectConfigurationFileKey)
+        project_configuration_file = options[ProjectConfigurationFileKey]
+
+        unless File.file?(project_configuration_file)
+          abort("YAML Configuration file not found at path: #{project_configuration_file}".red)
+        end
+        puts "Using YAML Configuration at path #{project_configuration_file}.".green
+      else
+        project_configuration_file = DefaultProjectConfigurationFilePath
+        putsWithOverrides('YAML Configuration', project_configuration_file, ProjectConfigurationFileKey)
+      end
+
       project.targets.each do |target|
         if target.product_type.include? 'app-extension'
           extensions.push(target.name)
@@ -155,7 +172,7 @@ module Unlimit
         end
       end
 
-      puts "================================================\n"
+      puts "#{Divider}\n"
 
       # Turn off capabilities that require entitlements
       puts 'Turning OFF all Capabilities'.red
@@ -203,8 +220,9 @@ module Unlimit
       system("#{FastlaneEnvironmentVariables} bundle exec fastlane run update_app_identifier plist_path:#{plist_path} app_identifier:#{bundle_identifier}")
 
       if uses_app_groups # Create a temporary fastfile, and set the app group identifiers
+        app_group_name = "group.#{bundle_identifier}"
         fastfile = "lane :set_app_group do
-        update_app_group_identifiers(entitlements_file: \"#{entitlements_file}\", app_group_identifiers: ['group.#{bundle_identifier}'])
+        update_app_group_identifiers(entitlements_file: \"#{entitlements_file}\", app_group_identifiers: ['#{app_group_name}'])
         end"
 
         existingFastfile = ''
@@ -233,6 +251,25 @@ module Unlimit
         system("bundle exec configure_extensions remove #{project_path} #{target_name} #{app_extensions}")
       end
 
+      if File.file?(project_configuration_file)
+        puts "Running Custom Scripts from #{project_configuration_file}".red
+        local_configuration = YAML.load_file(project_configuration_file)
+        unless local_configuration['custom_scripts'].empty?
+          environment_variables = { 'UNLIMIT_PROJECT_PATH' => project_path, 'UNLIMIT_TARGET_NAME' => target_name, 'UNLIMIT_PLIST_PATH' => plist_path, 'UNLIMIT_TEAM_ID' => personal_team_id, 'UNLIMIT_APP_BUNDLE_ID' => bundle_identifier, 'UNLIMIT_APP_GROUP_NAME' => app_group_name }
+          local_configuration['custom_scripts'].each do |script|
+            script = script.to_s
+            environment_variables.each do |key, variable|
+              script.gsub!(key.to_s, variable.to_s)
+            end
+            puts "Running: #{script}".green
+            output, stderr, status = Open3.capture3(script)
+            puts output unless output.empty?
+            puts stderr unless stderr.empty?
+            puts "Done with Status: #{status}"
+          end
+            end
+          end
+
       puts "\n#{Divider}"
       puts 'You\'re good to go! Just connect your device and hit run!'.green
       puts Divider

data/unlimit.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Siddharth Gupta']
   spec.email         = ['sids.1992@gmail.com']
 
-  spec.summary       = 'Test your iOS projects on device despite the 100 device limit'
+  spec.summary       = 'Test your iOS projects on device despite the 100 device limit, by automatically switching to your personal team'
   spec.description   = 'Test your iOS projects on device despite the 100 device limit, by automatically switching to your personal team'
   spec.homepage      = 'https://github.com/biocross/unlimit'
   spec.license       = 'MIT'
@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   if spec.respond_to?(:metadata)
     spec.metadata['homepage_uri'] = spec.homepage
     spec.metadata['source_code_uri'] = 'https://github.com/biocross/unlimit'
-    spec.metadata['changelog_uri'] = 'https://github.com/biocross/unlimit'
+    spec.metadata['changelog_uri'] = 'https://github.com/biocross/unlimit/blob/master/CHANGELOG.md'
   else
     raise 'RubyGems 2.0 or newer is required to protect against ' \
       'public gem pushes.'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unlimit
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Siddharth Gupta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-15 00:00:00.000000000 Z
+date: 2019-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xcodeproj
@@ -138,7 +138,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/biocross/unlimit
   source_code_uri: https://github.com/biocross/unlimit
-  changelog_uri: https://github.com/biocross/unlimit
+  changelog_uri: https://github.com/biocross/unlimit/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -157,5 +157,6 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Test your iOS projects on device despite the 100 device limit
+summary: Test your iOS projects on device despite the 100 device limit, by automatically
+  switching to your personal team
 test_files: []