fastlane-plugin-settings_bundle 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d5aded674a659311979b8b13ff5c48f5bf8ef03d
-  data.tar.gz: 8431dec4540f60360adfd7d02396f1c726001f2b
+  metadata.gz: 8ec2f564820b8e88b1b974a32e4d44414a65b0b8
+  data.tar.gz: 8da1f81314e240c30050a058df47d9c9c66cbe56
 SHA512:
-  metadata.gz: 32a6e2e1dfd12a92027f42345809371144c790c03f9af8706f25f049cd2ac5eda4df3a96f617cb48b682c6310c7cbc3a86f83bc7aba297e9e74eb8f6a9caad07
-  data.tar.gz: eaeeceeaa4c7dcf7eb7788991fb3c2ad33038e0bab99ff5ac6e1d995a2666e804d77821a9d27c295f3fa5d44d8868d96c6f73022f3aef245fe175dd71ea38181
+  metadata.gz: bab2cbe3e48fafe76e35bfce1868278a8c06910f3b26aec4d277d6b4e91b2c4e92532e0d906f07f04878c3ca577a09cef42caeef14973ae73ea1939b213145f5
+  data.tar.gz: e0744e178aff7a0415ef31801856ec11200e0a495a9fc99827509948a41e5abe86a258588332acb02ae4c5f66c54af7f5be8243702a450eb2f9f51817c9a8dbf

data/README.md

@@ -29,7 +29,6 @@ the current build number.
 
 ```ruby
 update_settings_bundle(
-  xcodeproj: "MyProject.xcodeproj",
   key: "CurrentAppVersion",
   value: ":version (:build)"
 )
@@ -41,11 +40,24 @@ specified format. Use the action this way after `increment_build_number` or
 `increment_version_number` to update your settings bundle as part of a
 version bump.
 
+#### Specifying the project file
+
+By default, the action looks for a single .xcodeproj file in the repo,
+excluding any under Pods. If more than one is present, use the `:xcodeproj`
+parameter:
+
+```ruby
+update_settings_bundle(
+  xcodeproj: "./MyProject.xcodeproj",
+  key: "CurrentAppVersion",
+  value: ":version (:build)"
+)
+```
+
 #### Files other than Root.plist
 
 ```ruby
 update_settings_bundle(
-  xcodeproj: "MyProject.xcodeproj",
   file: "About.plist",
   key: "CurrentAppVersion",
   value: ":version (:build)"
@@ -65,7 +77,6 @@ other settings besides the version and build numbers.
 
 ```ruby
 update_settings_bundle(
-  xcodeproj: "MyProject.xcodeproj",
   key: "BuildDate",
   value: Time.now.strftime("%Y-%m-%d")
 )
@@ -81,7 +92,6 @@ different configuration, use a `configuration` parameter:
 
 ```ruby
 update_settings_bundle(
-  xcodeproj: "MyProject.xcodeproj",
   key: "CurrentAppVersion",
   value: ":version (:build)",
   configuration: "Debug"
@@ -94,16 +104,35 @@ By default, this action takes the settings from the first non-test, non-extensio
 the project. Use the optional :target parameter to specify a target by name.
 ```ruby
 update_settings_bundle(
-  xcodeproj: "MyProject.xcodeproj",
   key: "CurrentAppVersion",
   value: ":version (:build)",
   target: "MyAppTarget"
 )
 ```
 
-## Example
+#### Bundle name parameter
+
+By default, this action looks for a file called `Settings.bundle` in the project. To
+specify a different name for your settings bundle, use the `:bundle_name` option:
+```ruby
+update_settings_bundle(
+  key: "CurrentAppVersion",
+  value: ":version (:build)",
+  bundle_name: "MySettings.bundle"
+)
+```
 
-See the SettingsBundleExample subdirectory for a sample project that
+## Examples
+
+[SettingsBundleExample]: ./examples/SettingsBundleExample
+[SettingsBundleLibraryExample]: ./examples/SettingsBundleLibraryExample
+
+There are two examples in the `examples` subdirectory: [SettingsBundleExample] (basic) and
+[SettingsBundleLibraryExample] (advanced).
+
+### SettingsBundleExample (basic)
+
+See the `examples/SettingsBundleExample` subdirectory for a simple example project that
 makes use of this action.
 
 First build and run the sample project on a simulator or device. It should show
@@ -125,6 +154,37 @@ Run the sample app again. It should display 1.0.0 (2). Tap the version number ag
 to see the update to the
 settings bundle. The Build date field should show the current date.
 
+### SettingsBundleLibraryExample (advanced)
+
+The [SettingsBundleLibraryExample] project includes multiple targets with different versions
+and a settings bundle with multiple pages. In addition to the `SettingsBundleLibraryExample`
+target, there is a `SettingsBundleExampleFramework`, which builds a framework that is embedded
+in the application. The app version is 1.0.0. The framework version is 1.0.1.
+
+The settings bundle includes a child pane in Framework.plist. The app version (CurrentAppVersion)
+and build date are in the Root.plist. The framework version (CurrentFrameworkVersion) is in
+Framework.plist. It appears on the "Framework settings" page in the Settings app.
+
+The lane in the Fastfile makes use of the :target parameter to choose which version data to use.
+
+To update this project:
+
+```bash
+bundle exec fastlane library_test
+```
+
+Now build and run the app. The settings have been updated with the appropriate version
+for each component.
+
+#### Note
+
+Though you can use a different version in
+the `Info.plist` for each target, `agvtool` will
+automatically set them all to the same value on update.
+If you do your version update using a different
+mechanism, `:build` will refer to the `CFBundleVersion` from the `Info.plist`
+for whichever target you use.
+
 ## Run tests for this plugin
 
 To run both the tests, and code style validation, run

data/lib/fastlane/plugin/settings_bundle/actions/update_settings_bundle_action.rb

@@ -28,19 +28,25 @@ module Fastlane
         file = params[:file]
         value = params[:value]
 
-        # try to open project file (raises)
-        project = Xcodeproj::Project.open params[:xcodeproj]
-
         helper = Helper::SettingsBundleHelper
 
+        xcodeproj_path = helper.xcodeproj_path_from_params params
+        # Error already reported in helper
+        return if xcodeproj_path.nil?
+
+        # try to open project file (raises)
+        project = Xcodeproj::Project.open xcodeproj_path
+
+        # raises
         settings = helper.settings_from_project project, configuration, target_name
 
         formatted_value = helper.formatted_value value, settings
 
-        helper.update_settings_plist_title_setting project, file, key,
+        # raises
+        helper.update_settings_plist_title_setting project, params[:bundle_name], file, key,
                                                    formatted_value
       rescue => e
-        UI.user_error! e.message
+        UI.user_error! "#{e.message}\n#{e.backtrace}"
       end
 
       def self.description
@@ -62,11 +68,6 @@ module Fastlane
       def self.available_options
         [
           # Required parameters
-          FastlaneCore::ConfigItem.new(key: :xcodeproj,
-                                  env_name: "SETTINGS_BUNDLE_XCODEPROJ",
-                               description: "An Xcode project file whose settings bundle to update",
-                                  optional: false,
-                                      type: String),
           FastlaneCore::ConfigItem.new(key: :key,
                                   env_name: "SETTINGS_BUNDLE_KEY",
                                description: "The user defaults key to update in the settings bundle",
@@ -79,6 +80,11 @@ module Fastlane
                                       type: String),
 
           # Optional parameters
+          FastlaneCore::ConfigItem.new(key: :xcodeproj,
+                                  env_name: "SETTINGS_BUNDLE_XCODEPROJ",
+                               description: "An Xcode project file whose settings bundle to update",
+                                  optional: true,
+                                      type: String),
           FastlaneCore::ConfigItem.new(key: :configuration,
                                   env_name: "SETTINGS_BUNDLE_CONFIGURATION",
                                description: "The build configuration to use for the Info.plist file",
@@ -91,6 +97,12 @@ module Fastlane
                                   optional: true,
                              default_value: "Root.plist",
                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :bundle_name,
+                                  env_name: "SETTINGS_BUNDLE_BUNDLE_NAME",
+                               description: "The name of the settings bundle in the project (default Settings.bundle)",
+                                  optional: true,
+                             default_value: "Settings.bundle",
+                                      type: String),
           FastlaneCore::ConfigItem.new(key: :target,
                                   env_name: "SETTINGS_BUNDLE_TARGET",
                                description: "An optional target name from the project",
@@ -103,7 +115,6 @@ module Fastlane
         [
           <<-EOF
             update_settings_bundle(
-              xcodeproj: "MyProject.xcodeproj",
               key: "CurrentAppVersion",
               value: ":version (:build)"
             )
@@ -111,6 +122,12 @@ module Fastlane
           <<-EOF
             update_settings_bundle(
               xcodeproj: "MyProject.xcodeproj",
+              key: "CurrentAppVersion",
+              value: ":version (:build)"
+            )
+          EOF,
+          <<-EOF
+            update_settings_bundle(
               file: "About.plist",
               key: "CurrentAppVersion",
               value: ":version (:build)"
@@ -118,14 +135,12 @@ module Fastlane
           EOF,
           <<-EOF
             update_settings_bundle(
-              xcodeproj: "MyProject.xcodeproj",
               key: "BuildDate",
               value: Time.now.strftime("%Y-%m-%d")
             )
           EOF,
           <<-EOF
             update_settings_bundle(
-              xcodeproj: "MyProject.xcodeproj",
               key: "CurrentAppVersion",
               value: ":version (:build)",
               configuration: "Debug"
@@ -133,11 +148,17 @@ module Fastlane
           EOF,
           <<-EOF
             update_settings_bundle(
-              xcodeproj: "MyProject.xcodeproj",
               key: "CurrentAppVersion",
               value: ":version (:build)",
               target: "MyAppTarget"
             )
+          EOF,
+          <<-EOF
+            update_settings_bundle(
+              key: "CurrentAppVersion",
+              value: ":version (:build)",
+              bundle_name: "MySettings.bundle"
+            )
           EOF
         ]
       end

data/lib/fastlane/plugin/settings_bundle/helper/settings_bundle_helper.rb

@@ -22,6 +22,7 @@ require 'plist'
 
 module Fastlane
   module Helper
+    UI = FastlaneCore::UI
     class SettingsBundleHelper
       Settings = Struct.new "Settings", :version, :build
 
@@ -73,8 +74,9 @@ module Fastlane
 
           release_info_plist_path = File.join project_parent, release_info_plist_path
 
-          # try to open and parse the Info.plist (raises)
-          info_plist = Plist.parse_xml release_info_plist_path
+          # try to open and parse the Info.plist. raises on failure.
+          info_plist = File.open(release_info_plist_path) { |f| Plist.parse_xml f }
+          raise "Failed to parse plist file #{release_info_plist_path}" if info_plist.nil?
 
           # increments already happened. read the current state.
           current_marketing_version = info_plist["CFBundleShortVersionString"]
@@ -92,22 +94,25 @@ module Fastlane
         # on error.
         #
         # :project: An open Xcodeproj::Project, obtained from Xcodeproj::Project.open, e.g.
+        # :bundle_name: (String) Regex to identify the bundle to look for, usually Settings.bundle.
         # :file: A settings plist file in the Settings.bundle, usually "Root.plist"
         # :key: A valid NSUserDefaults key in the Settings.bundle
         # :value: A new value for the key
-        def update_settings_plist_title_setting(project, file, key, value)
-          settings_bundle = project.files.find { |f| f.path =~ /Settings.bundle/ }
+        def update_settings_plist_title_setting(project, bundle_name, file, key, value)
+          settings_bundle = project.files.find { |f| f.path =~ /#{bundle_name}/ }
 
-          raise "Settings.bundle not found in project" if settings_bundle.nil?
+          raise "#{bundle_name} not found in project" if settings_bundle.nil?
 
-          settings_bundle_path = settings_bundle.path
+          # The #real_path method returns the full resolved path to the Settings.bundle
+          settings_bundle_path = settings_bundle.real_path
 
-          project_parent = File.dirname project.path
+          plist_path = File.join settings_bundle_path, file
+
+          # raises IOError
+          settings_plist = File.open(plist_path) { |f| Plist.parse_xml f }
 
-          plist_path = File.join project_parent, settings_bundle_path, file
+          raise "Could not parse #{plist_path}" if settings_plist.nil?
 
-          # raises
-          settings_plist = Plist.parse_xml plist_path
           preference_specifiers = settings_plist["PreferenceSpecifiers"]
 
           raise "#{file} is not a settings plist file" if preference_specifiers.nil?
@@ -126,6 +131,34 @@ module Fastlane
           # Save (raises)
           Plist::Emit.save_plist settings_plist, plist_path
         end
+
+        def xcodeproj_path_from_params(params)
+          return params[:xcodeproj] if params[:xcodeproj]
+
+          # Adapted from commit_version_bump
+          # https://github.com/fastlane/fastlane/blob/master/fastlane/lib/fastlane/actions/commit_version_bump.rb#L21
+
+          # This may not be a git project. Search relative to the Gemfile.
+          repo_path = Bundler.root
+
+          all_xcodeproj_paths = Dir[File.expand_path(File.join(repo_path, '**/*.xcodeproj'))]
+          # find an xcodeproj (ignoring the Cocoapods one)
+          xcodeproj_paths = Fastlane::Actions.ignore_cocoapods_path(all_xcodeproj_paths)
+
+          # no projects found: error
+          UI.user_error!('Could not find a .xcodeproj in the current repository\'s working directory.') and return nil if xcodeproj_paths.count == 0
+
+          # too many projects found: error
+          if xcodeproj_paths.count > 1
+            repo_pathname = Pathname.new repo_path
+            relative_projects = xcodeproj_paths.map { |e| Pathname.new(e).relative_path_from(repo_pathname).to_s }.join("\n")
+            UI.user_error!("Found multiple .xcodeproj projects in the current repository's working directory. Please specify your app's main project: \n#{relative_projects}")
+            return nil
+          end
+
+          # one project found: great
+          xcodeproj_paths.first
+        end
       end
     end
   end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module SettingsBundle
-    VERSION = "1.1.1"
+    VERSION = "1.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-settings_bundle
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Jimmy Dee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-21 00:00:00.000000000 Z
+date: 2017-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plist
@@ -154,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Fastlane plugin to update static settings in an iOS settings bundle