fastlane-plugin-settings_bundle 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1e4de8d118519798ac033619bc8e7d97df7a53ed
+  data.tar.gz: 7c4b5392ec299f3793407f595f4ebddd7db7a6b0
+SHA512:
+  metadata.gz: a8d7cee31bc2f87df9d4887c723b66d07b38eb1db2c7665343ffe1eeb2b692006eeeda7311b4389aa2949d9b9bc00e2db947438df950acc948567d803f8c3f8b
+  data.tar.gz: 816ac7eaf9b17e5e3e8b65a6f5318260932d73289c5eb487531c968d48fe902a4339b90868ab46262349589f527929c07bf2c6781e3db6f0bd8f94237a87b317

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Jimmy Dee <jgvdthree@gmail.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,140 @@
+# settings_bundle plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg?style=flat)](https://rubygems.org/gems/fastlane-plugin-settings_bundle)
+[![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/jdee/settings-bundle/blob/master/LICENSE)
+[![CircleCI](https://circleci.com/gh/jdee/settings-bundle.svg?style=svg)](https://circleci.com/gh/jdee/settings-bundle)
+
+## Getting Started
+
+This project is a [fastlane](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-settings_bundle`, run the following command:
+```
+fastlane add_plugin settings_bundle
+```
+
+## About settings_bundle
+
+Fastlane plugin to update static settings in an iOS settings bundle
+
+![Sample Settings Bundle](https://github.com/jdee/settings-bundle/blob/master/settings-bundle-example.png)
+
+### update_settings_bundle
+
+This action updates a specified NSUserDefaults key in the project's
+`Settings.bundle` to a specified value. There are two macros that will
+be expanded if included in the value argument. `:version` will be
+replaced with the app's marketing version; `:build` will be replaced with
+the current build number.
+
+```ruby
+update_settings_bundle(
+  xcodeproj: "MyProject.xcodeproj",
+  key: "CurrentAppVersion",
+  value: ":version (:build)"
+)
+```
+
+This updates the key named `CurrentAppVersion` in the `Root.plist` in the
+`Settings.bundle` to contain the marketing version and build number in the
+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.
+
+#### Files other than Root.plist
+
+```ruby
+update_settings_bundle(
+  xcodeproj: "MyProject.xcodeproj",
+  file: "About.plist",
+  key: "CurrentAppVersion",
+  value: ":version (:build)"
+)
+```
+
+The `file` argument specifies a file other than `Root.plist` in the
+`Settings.bundle`. If you have multiple projects, keys or files,
+run the action multiple times.
+
+#### Key content
+
+Any string is valid for the value. It need not contain either or
+both the symbols mentioned. If it contains neither, the literal value
+of the value argument will be used. This can be useful for including
+other settings besides the version and build numbers.
+
+```ruby
+update_settings_bundle(
+  xcodeproj: "MyProject.xcodeproj",
+  key: "BuildDate",
+  value: Time.now.strftime("%Y-%m-%d")
+)
+```
+
+#### Configuration parameter
+
+A project can use different `Info.plist` files per configuration
+(Debug, Release, etc.). However, a project only has a single settings
+bundle. By default, this action uses the `Info.plist` file from the
+Release configuration. If you want to use the `Info.plist` for a
+different configuration, use a `configuration` parameter:
+
+```ruby
+update_settings_bundle(
+  xcodeproj: "MyProject.xcodeproj",
+  key: "CurrentAppVersion",
+  value: ":version (:build)",
+  configuration: "Debug"
+```
+
+## Example
+
+See the SettingsBundleExample subdirectory for a sample project that
+makes use of this action.
+
+First build and run the sample project on a simulator. It should show
+you the current
+version and build number: 1.0.0 (1). This info is taken from the main
+bundle.
+
+If you visit the Settings app and look at the settings for
+SettingsBundleExample, you'll see the same version and build number
+as well as a blank field for the Build date.
+
+Now run Fastlane:
+
+```bash
+bundle install
+bundle exec fastlane test
+```
+
+Now run the sample app again. It should display 1.0.0 (2). Visit the
+Settings app under the settings for the app to see the update to the
+settings bundle. The Build date field should show the current date.
+
+## 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 beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/settings_bundle.rb

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

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

@@ -0,0 +1,140 @@
+# Copyright (c) 2016 Jimmy Dee
+#
+# 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.
+
+module Fastlane
+  module Actions
+    class UpdateSettingsBundleAction < Action
+      def self.run(params)
+        key = params[:key]
+        configuration = params[:configuration]
+        file = params[:file]
+        value = params[:value]
+
+        # try to open project file (raises)
+        project = Xcodeproj::Project.open params[:xcodeproj]
+
+        helper = Helper::SettingsBundleHelper
+
+        settings = helper.settings_from_project project, configuration
+
+        formatted_value = helper.formatted_value value, settings
+
+        helper.update_settings_plist_title_setting project, file, key,
+                                                   formatted_value
+      rescue => e
+        UI.user_error! e.message
+      end
+
+      def self.description
+        "Fastlane plugin action to update static settings in an iOS settings bundle"
+      end
+
+      def self.author
+        "Jimmy Dee"
+      end
+
+      def self.details
+        "This action is used to automatically update a Title entry in a plist\n" \
+          "in an app's Settings bundle. It can be used to update the current\n" \
+          "version and/or build number automatically after they have been \n" \
+          "updated, e.g. by the increment_version_number or increment_build_number\n" \
+          "actions."
+      end
+
+      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",
+                                  optional: false,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :value,
+                                  env_name: "SETTINGS_BUNDLE_VALUE",
+                               description: "Value to set with optional :version and :build included",
+                                  optional: false,
+                                      type: String),
+
+          # Optional parameters
+          FastlaneCore::ConfigItem.new(key: :configuration,
+                                  env_name: "SETTINGS_BUNDLE_CONFIGURATION",
+                               description: "The build configuration to use for the Info.plist file",
+                                  optional: true,
+                             default_value: "Release",
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :file,
+                                  env_name: "SETTINGS_BUNDLE_FILE",
+                               description: "The plist file in the Settings.bundle to update",
+                                  optional: true,
+                             default_value: "Root.plist",
+                                      type: String)
+        ]
+      end
+
+      def self.example_code
+        [
+          <<-EOF
+            update_settings_bundle(
+              xcodeproj: "MyProject.xcodeproj",
+              key: "CurrentAppVersion",
+              value: ":version (:build)"
+            )
+          EOF,
+          <<-EOF
+            update_settings_bundle(
+              xcodeproj: "MyProject.xcodeproj",
+              file: "About.plist",
+              key: "CurrentAppVersion",
+              value: ":version (:build)"
+            )
+          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"
+            )
+          EOF
+        ]
+      end
+
+      def self.is_supported?(platform)
+        platform == :ios
+      end
+
+      def self.category
+        :project
+      end
+    end
+  end
+end

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

@@ -0,0 +1,126 @@
+# Copyright (c) 2016 Jimmy Dee
+#
+# 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.
+
+require 'plist'
+
+module Fastlane
+  module Helper
+    class SettingsBundleHelper
+      Settings = Struct.new "Settings", :version, :build
+
+      class << self
+        # Takes a value, a version number and a build number and
+        # returns a formatted string.
+        # :version is replaced by the version number. :build
+        # is replaced by the build number. Neither the version nor
+        # the build number is required. Omitting both from the
+        # format will result in the format being returned as the value.
+        #
+        # :value: A string value containing :version, :build, neither or both
+        # :settings: A Settings struct containing settings from a project
+        def formatted_value(value, settings)
+          value.gsub(/:version/, settings.version.to_s).gsub(/:build/, settings.build.to_s)
+        end
+
+        # Takes an open Xcodeproj::Project and extracts the current
+        # settings, returning a Settings struct with settings data.
+        # Raises on error.
+        #
+        # :project: An open Xcodeproj::Project via Xcodeproj::Project.open, e.g.
+        # :configuration: A valid build configuration in the project
+        def settings_from_project(project, configuration)
+          # find the first non-test, non-extension target
+          # TODO: Make this a :target parameter
+          target = project.targets.find { |t| !t.test_target_type? && !t.extension_target_type? }
+          raise "No application target found" if target.nil?
+
+          # find the Info.plist paths for all configurations
+          info_plist_paths = target.resolved_build_setting "INFOPLIST_FILE"
+
+          raise "INFOPLIST_FILE not found in target" if info_plist_paths.nil? or info_plist_paths.empty?
+
+          # this can differ from one configuration to another.
+          # take from Release, since only one Settings.bundle per project
+          # (not per configuration)
+          release_info_plist_path = info_plist_paths[configuration]
+
+          raise "Info.plist not found for configuration #{configuration}" if release_info_plist_path.nil?
+
+          project_parent = File.dirname project.path
+
+          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
+
+          # increments already happened. read the current state.
+          current_marketing_version = info_plist["CFBundleShortVersionString"]
+          current_build_number = info_plist["CFBundleVersion"]
+
+          raise "CFBundleShortVersionString not found in Info.plist" if current_marketing_version.nil?
+          raise "CFBundleVersion not found in Info.plist" if current_build_number.nil?
+
+          Settings.new current_marketing_version, current_build_number
+        end
+
+        # Takes an open Xcodeproj::Project, extracts the settings bundle
+        # and updates the specified setting key in the specified file
+        # to the specified value. Only valid for title items. Raises
+        # on error.
+        #
+        # :project: An open Xcodeproj::Project, obtained from Xcodeproj::Project.open, e.g.
+        # :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/ }
+
+          raise "Settings.bundle not found in project" if settings_bundle.nil?
+
+          settings_bundle_path = settings_bundle.path
+
+          project_parent = File.dirname project.path
+
+          plist_path = File.join project_parent, settings_bundle_path, file
+
+          # 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?
+
+          # Find the specifier for the supplied key
+          title_specifier = preference_specifiers.find do |specifier|
+            specifier["Key"] == key
+          end
+
+          raise "preference specifier for key #{key} not found in #{file}" if title_specifier.nil?
+          raise "preference for key #{key} must be of type title" unless title_specifier["Type"] == "PSTitleValueSpecifier"
+
+          # Update to the new value. Old value need not be present.
+          title_specifier["DefaultValue"] = value.to_s
+
+          # Save (raises)
+          Plist::Emit.save_plist settings_plist, plist_path
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module SettingsBundle
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-settings_bundle
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jimmy Dee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: plist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: xcodeproj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !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.106.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.106.2
+description: 
+email: jgvdthree@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/settings_bundle.rb
+- lib/fastlane/plugin/settings_bundle/actions/update_settings_bundle_action.rb
+- lib/fastlane/plugin/settings_bundle/helper/settings_bundle_helper.rb
+- lib/fastlane/plugin/settings_bundle/version.rb
+homepage: https://github.com/jdee/settings-bundle
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Fastlane plugin to update static settings in an iOS settings bundle
+test_files: []