fastlane-plugin-branch 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: deb9d71578884158d8ac26de9f51633067221bdf
-  data.tar.gz: 4011ed386f10314697c333a0d194480780e13281
+SHA256:
+  metadata.gz: b9698deff778126e250ebc87f1944a952ced21c3ccdc614ba5e91683e39ae18f
+  data.tar.gz: ed00d7306008408acc65780eb2bcc18b27ae7db193acbfc15ed6c6c9b6296a63
 SHA512:
-  metadata.gz: d8a42857ea57a3d76301a3f308acda6ffc49a8579ff0cfb571461e4c8afd1231d9467b6a33196d414649fe65544715dc61fa594425763124bb2d30adb9eed60f
-  data.tar.gz: 828cfc8821fb821a6dfdcb4ece5e97b4754aceb1beead4a590cc1948b5f28f7e22f08c499b48e9238bafad11d400778a42052b58083411653b45a901d068d27d
+  metadata.gz: a8a15ce1709786a5d21311442c9bcc4f714fccc1b924b4707029c7844051225a00ca0dc50a5f95d118a74837b5a781e4f60a9ecf71a9f980bc63e728b9b29c79
+  data.tar.gz: 0d5aaf69ee0ca67d2b559074efe1da5e7f6ef67540c7f5825f0c18d120bd51c6fa4015b36c87307d1f6b649d690c400abbdc7882230c8ace24b00891cb7d5949

data/README.md

@@ -29,53 +29,98 @@ This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To
 fastlane add_plugin branch
 ```
 
-## setup_branch action
+<!-- The following is generated. Do not edit by hand. Run fastlane readme to -->
+<!-- regenerate this section. -->
+<!-- BEGIN ACTION REFERENCE -->
+### setup_branch action
+
+```Ruby
+setup_branch
+```
 
 Integrates the Branch SDK into a native app project. This currently supports iOS only.
 It will infer the project location if there is exactly one .xcodeproj anywhere under
 the current directory, excluding any in a Pods or Carthage folder. Otherwise, specify
-the project location using the `--xcodeproj` option, or the CLI will prompt you for the
+the project location using the `xcodeproj` option, or the CLI will prompt you for the
 location.
 
 If a Podfile or Cartfile is detected, the Branch SDK will be added to the relevant
 configuration file and the dependencies updated to include the Branch framework.
-This behavior may be suppressed using `--no-add-sdk`. If no Podfile or Cartfile
+This behavior may be suppressed using `no_add_sdk`. If no Podfile or Cartfile
 is found, and Branch.framework is not already among the project's dependencies,
 you will be prompted for a number of choices, including setting up CocoaPods or
 Carthage for the project or directly installing the Branch.framework.
 
 By default, all supplied Universal Link domains are validated. If validation passes,
 the setup continues. If validation fails, no further action is taken. Suppress
-validation using `--no-validate` or force changes when validation fails using
-`--force`.
+validation using `no_validate` or force changes when validation fails using
+`force`.
 
 By default, this command will look for the first app target in the project. Test
-targets are not supported. To set up an extension target, supply the `--target` option.
+targets are not supported. To set up an extension target, supply the `target` option.
 
 All relevant target settings are modified. The Branch keys are added to the Info.plist,
-along with the `branch_universal_link_domains` key for custom domains (when `--domains`
+along with the `branch_universal_link_domains` key for custom domains (when `domains`
 is used). For app targets, all domains are added to the project's Associated Domains
 entitlement. An entitlements file is also added for app targets if none is found.
-Optionally, if `--frameworks` is specified, this command can add a list of system
+Optionally, if `frameworks` is specified, this command can add a list of system
 frameworks to the target's dependencies (e.g., AdSupport, CoreSpotlight, SafariServices).
 
 A language-specific patch is applied to the AppDelegate (Swift or Objective-C).
-This can be suppressed using `--no-patch-source`.
+This can be suppressed using `no_patch_source`.
 
 #### Prerequisites
 
-Before using this command, make sure to set up your app in the [Branch Dashboard](https://dashboard.branch.io). See https://docs.branch.io/pages/dashboard/integrate/ for details. To use the `setup` command, you need:
+Before using this command, make sure to set up your app in the Branch Dashboard
+(https://dashboard.branch.io). See https://docs.branch.io/pages/dashboard/integrate/
+for details. To use the `setup` command, you need:
 
 - Branch key(s), either live, test or both
 - Domain name(s) used for Branch links
 - Location of your Xcode project (may be inferred in simple projects)
 
-If using the `--commit` option, `git` is required. If not using `--no-add-sdk`,
+If using the `commit` option, `git` is required. If not using `no_add_sdk`,
 the `pod` or `carthage` command may be required. If not found, the CLI will
 offer to install and set up these command-line tools for you. Alternately, you can arrange
 that the relevant commands are available in your `PATH`.
 
-```ruby
+All parameters are optional. A live key or test key, or both is required, as well
+as at least one domain. Specify `live_key`, `test_key` or both and `app_link_subdomain`,
+`domains` or both. If these are not specified, this command will prompt you
+for this information.
+
+See https://github.com/BranchMetrics/branch_io_cli#setup-command for more information.
+
+
+#### Options
+
+|Fastfile key|description|Environment variable|type|default value|
+|---|---|---|---|---|
+|live_key|Branch live key|BRANCH_LIVE_KEY|Boolean||
+|test_key|Branch test key|BRANCH_TEST_KEY|Boolean||
+|domains|Comma-separated list of custom domain(s) or non-Branch domain(s)|BRANCH_DOMAINS|Boolean||
+|app_link_subdomain|Branch app.link subdomain, e.g. myapp for myapp.app.link|BRANCH_APP_LINK_SUBDOMAIN|Boolean||
+|uri_scheme|Custom URI scheme used in the Branch Dashboard for this app|BRANCH_URI_SCHEME|Boolean||
+|setting|Use a custom build setting for the Branch key (default: Use Info.plist)|BRANCH_SETTING|Boolean||
+|test_configurations|List of configurations that use the test key with a user-defined setting (default: Debug configurations)|BRANCH_TEST_CONFIGURATIONS|Boolean||
+|xcodeproj|Path to an Xcode project to update|BRANCH_XCODEPROJ|Boolean||
+|target|Name of a target to modify in the Xcode project|BRANCH_TARGET|Boolean||
+|podfile|Path to the Podfile for the project|BRANCH_PODFILE|Boolean||
+|cartfile|Path to the Cartfile for the project|BRANCH_CARTFILE|Boolean||
+|carthage_command|Command to run when installing from Carthage|BRANCH_CARTHAGE_COMMAND|Boolean|update --platform ios|
+|frameworks|Comma-separated list of system frameworks to add to the project|BRANCH_FRAMEWORKS|Boolean||
+|pod_repo_update|Update the local podspec repo before installing|BRANCH_POD_REPO_UPDATE||true|
+|validate|Validate Universal Link configuration|BRANCH_VALIDATE||true|
+|force|Update project even if Universal Link validation fails|BRANCH_FORCE||false|
+|add_sdk|Add the Branch framework to the project|BRANCH_ADD_SDK||true|
+|patch_source|Add Branch SDK calls to the AppDelegate|BRANCH_PATCH_SOURCE||true|
+|commit|Commit the results to Git if non-blank|BRANCH_COMMIT|Boolean||
+|confirm|Confirm configuration before proceeding|BRANCH_CONFIRM||true|
+
+
+#### Examples
+
+```Ruby
 setup_branch(
   live_key: "key_live_xxxx",
   test_key: "key_test_yyyy",
@@ -83,143 +128,103 @@ setup_branch(
   uri_scheme: "myscheme",
   xcodeproj: "MyIOSApp.xcodeproj"
 )
+
 ```
 
-Use the `:domains` parameter to specify custom domains, including non-Branch domains
-```ruby
-setup_branch(
-  live_key: "key_live_xxxx",
-  domains: %w{example.com www.example.com}
-  xcodeproj: "MyIOSApp.xcodeproj"
-)
+
+
+
+### validate_universal_links action
+
+```Ruby
+validate_universal_links
 ```
 
-Available options:
+This command validates all Universal Link domains configured in a project without making any
+modification. It validates both Branch and non-Branch domains. Unlike web-based Universal
+Link validators, this command operates directly on the project. It finds the bundle and
+signing team identifiers in the project as well as the app's Associated Domains. It requests
+the apple-app-site-association file for each domain and validates the file against the
+project's settings.
 
-|Fastfile key|description|Environment variable|type|default value|
-|---|---|---|---|---|
-|:live_key|The Branch live key to use (:live_key or :test_key is required)|BRANCH_LIVE_KEY|string||
-|:test_key|The Branch test key to use (:live_key or :test_key is required)|BRANCH_TEST_KEY|string||
-|:app_link_subdomain|An app.link subdomain to use (:app_link_subdomain or :domains is required. The union of the two sets of domains will be used.)|BRANCH_APP_LINK_SUBDOMAIN|string||
-|:domains|A list of domains (custom domains or Branch domains) to use (:app_link_subdomain or :domains is required. The union of the two sets of domains will be used.)|BRANCH_DOMAINS|array of strings or comma-separated string||
-|:uri_scheme|A URI scheme to add to the manifest|BRANCH_URI_SCHEME|string||
-|:xcodeproj|Path to a .xcodeproj directory to use. (:xcodeproj, :android_project_path or :android_manifest_path is required.)|BRANCH_XCODEPROJ|string||
-|:target|Name of the target to use in the Xcode project (iOS only; optional)|BRANCH_TARGET|string||
-|:validate|Determines whether to validate the resulting Universal Link configuration before modifying the project|BRANCH_VALIDATE|boolean|true|
-|:force|Update project(s) even if Universal Link validation fails|BRANCH_FORCE_UPDATE|boolean|false|
-|:commit|Set to true to commit changes to Git; set to a string to commit with a custom message|BRANCH_COMMIT_CHANGES|boolean or string|false|
-|:frameworks|A list of system frameworks to add to the target that uses the Branch SDK (iOS only)|BRANCH_FRAMEWORKS|array|[]|
-|:add_sdk|Set to false to disable automatic integration of the Branch SDK|BRANCH_ADD_SDK|boolean|true|
-|:podfile|Path to a Podfile to update (iOS only)|BRANCH_PODFILE|string||
-|:patch_source|Set to false to disable automatic source-code patching|BRANCH_PATCH_SOURCE|boolean|true|
-|:pod_repo_update|Set to false to disable update of local podspec repo before pod install|BRANCH_POD_REPO_UPDATE|boolean|true|
-|:cartfile|Path to a Cartfile to update (iOS only)|BRANCH_CARTFILE|string||
-|:carthage_command|Command to use when installing with Carthage|BRANCH_CARTHAGE_COMMAND|string|update --platform ios|
+Only app targets are supported for this command. By default, it will validate the first.
+If your project has multiple app targets, specify the `target` option to validate other
+targets.
 
-Individually, all parameters are optional, but the following conditions apply:
+All parameters are optional. If `domains` is specified, the list of Universal Link domains in
+the Associated Domains entitlement must exactly match this list, without regard to order. If
+no `domains` are provided, validation passes if at least one Universal Link domain is
+configured and passes validation, and no Universal Link domain is present that does not pass
+validation.
 
-- :live_key or :test_key must be specified.
-- :app_link_subdomain or :domains must be specified.
+See https://github.com/BranchMetrics/branch_io_cli#validate-command for more information.
 
-If these parameters are not specified, you will be prompted for them.
 
-This action also supports an optional Branchfile to specify configuration options.
-See the sample [Branchfile](./fastlane/Branchfile) in the fastlane subdirectory of this repo.
+#### Options
 
-## validate_universal_links action (iOS only)
+|Fastfile key|description|Environment variable|type|default value|
+|---|---|---|---|---|
+|domains|Comma-separated list of domains to validate (Branch domains or non-Branch domains)|BRANCH_DOMAINS|Boolean|[]|
+|xcodeproj|Path to an Xcode project to update|BRANCH_XCODEPROJ|Boolean||
+|target|Name of a target to validate in the Xcode project|BRANCH_TARGET|Boolean||
 
-This action validates all Universal Link domains configured in a project without making any modification.
-It validates both Branch and non-Branch domains.
 
+#### Examples
 
-```ruby
+```Ruby
 validate_universal_links
 ```
 
-```ruby
+```Ruby
 validate_universal_links(xcodeproj: "MyProject.xcodeproj")
 ```
 
-```ruby
+```Ruby
 validate_universal_links(xcodeproj: "MyProject.xcodeproj", target: "MyProject")
 ```
 
-```ruby
+```Ruby
 validate_universal_links(domains: %w{example.com www.example.com})
 ```
 
-Available options:
-
-|Fastfile key|description|Environment variable|type|default value|
-|---|---|---|---|---|
-|:xcodeproj|Path to a .xcodeproj directory to use|BRANCH_XCODEPROJ|string||
-|:target|Name of the target to use in the Xcode project|BRANCH_TARGET|string||
-|:domains|A list of domains (custom domains or Branch domains) that must be present in the project.|BRANCH_DOMAINS|array of strings or comma-separated string||
-
-All parameters are optional. Without any parameters, the action looks for a single .xcodeproj
-folder (with the exception of a Pods project) and reports an error if none or more than one is found.
-It uses the first non-test, non-extension target in that project.
-
-If the :domains parameter is not provided, validation will pass as long as there is at least
-one Universal Link domain configured for the target, and all Universal Link domains pass
-AASA validation. If the the :domains parameter is provided, the Universal Link domains in
-the project must also match the value of this parameter without regard to order.
 
-This action does not use the Branchfile.
 
-## Examples
 
-There is an example [Fastfile](./fastlane/Fastfile) in this repo that defines a number of
-example lanes. Be sure to run `bundle install` before trying any of the examples.
 
-### setup
+### branch_report action
 
-This lane sets up the BranchPluginExample project
-in
-[examples/ios/BranchPluginExample](./examples/ios/BranchPluginExample).
-The Xcode project uses CocoaPods and Swift.
-
-```bash
-bundle exec fastlane setup
+```Ruby
+branch_report
 ```
 
-### setup_and_commit
-
-This lane sets up the BranchPluginExample projects and also commits the results to git.
+_Work in progress_
 
-```bash
-bundle exec fastlane setup_and_commit
-```
+This command optionally cleans and then builds a workspace or project, generating a verbose
+report with additional diagnostic information suitable for opening a support ticket.
 
-### setup_objc
 
-This lane sets up the BranchPluginExampleObjc project
-in [examples/ios/BranchPluginExampleObjc](./examples/ios/BranchPluginExampleObjc).
-The project uses CocoaPods and Objective-C.
+#### Options
 
-```bash
-bundle exec fastlane setup_objc
-```
-
-### setup_carthage
-
-This lane sets up the BranchPluginExampleCarthage project
-in [examples/ios/BranchPluginExampleCarthage](./examples/ios/BranchPluginExampleCarthage).
-The project uses Carthage and Swift.
+|Fastfile key|description|Environment variable|type|default value|
+|---|---|---|---|---|
+|workspace|Path to an Xcode workspace|BRANCH_WORKSPACE|Boolean||
+|xcodeproj|Path to an Xcode project|BRANCH_XCODEPROJ|Boolean||
+|scheme|A scheme from the project or workspace to build|BRANCH_SCHEME|Boolean||
+|target|A target to build|BRANCH_TARGET|Boolean||
+|configuration|The build configuration to use (default: Scheme-dependent)|BRANCH_CONFIGURATION|Boolean||
+|sdk|Passed as -sdk to xcodebuild|BRANCH_SDK|Boolean|iphonesimulator|
+|podfile|Path to the Podfile for the project|BRANCH_PODFILE|Boolean||
+|cartfile|Path to the Cartfile for the project|BRANCH_CARTFILE|Boolean||
+|clean|Clean before attempting to build|BRANCH_CLEAN||true|
+|header_only|Write a report header to standard output and exit|BRANCH_HEADER_ONLY||false|
+|pod_repo_update|Update the local podspec repo before installing|BRANCH_POD_REPO_UPDATE||true|
+|out|Report output path|BRANCH_REPORT_PATH|Boolean|./report.txt|
 
-```bash
-bundle exec fastlane setup_carthage
-```
 
-### validate
 
-This lane validates the Universal Link configuration for the BranchPluginExample
-project in [examples/ios/BranchPluginExample](./examples/ios/BranchPluginExample).
 
-```bash
-bundle exec fastlane validate
-```
 
+<!-- END ACTION REFERENCE -->
 
 ## Run tests for this plugin
 

data/lib/fastlane/plugin/branch/actions/branch_report_action.rb

@@ -0,0 +1,52 @@
+require "branch_io_cli"
+require "fastlane/plugin/branch/config_item"
+require "fastlane/plugin/branch/fastlane_format"
+
+include Fastlane::Branch::FastlaneDescriptionFormat
+
+module Fastlane
+  module Actions
+    class BranchReportAction < Action
+      def self.run(params)
+        config = BranchIOCLI::Configuration::ReportConfiguration.wrapper params, false
+        BranchIOCLI::Commands::ReportCommand.new(config).run!
+      rescue StandardError => e
+        UI.user_error! "Error in BranchReportAction: #{e.message}\n#{e.backtrace}"
+      end
+
+      def self.description
+        "TODO"
+      end
+
+      def self.authors
+        [
+          "Branch <integrations@branch.io>",
+          "Jimmy Dee <jgvdthree@gmail.com>"
+        ]
+      end
+
+      def self.details
+        render :report_description
+      end
+
+      def self.example_code
+        [
+        ]
+      end
+
+      def self.available_options
+        BranchIOCLI::Configuration::ReportConfiguration.available_options.map do |option|
+          FastlaneCore::ConfigItem.from_branch_option(option)
+        end
+      end
+
+      def self.is_supported?(platform)
+        platform == :ios
+      end
+
+      def self.category
+        :project
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/branch/actions/setup_branch_action.rb

@@ -1,18 +1,27 @@
 require "branch_io_cli"
+require "fastlane/plugin/branch/config_item"
+require "fastlane/plugin/branch/fastlane_format"
+
+include Fastlane::Branch::FastlaneDescriptionFormat
 
 module Fastlane
   module Actions
     class SetupBranchAction < Action
       def self.run(params)
         params.load_configuration_file "Branchfile"
-        options = Helper::BranchOptions.new params
-        BranchIOCLI::Commands::SetupCommand.new(options).run!
+        # second arg false: Don't add default values or env. vars. Let Fastlane
+        # handle that. This is necessary to work with the Branchfile.
+        config = BranchIOCLI::Configuration::SetupConfiguration.wrapper params, false
+        BranchIOCLI::Commands::SetupCommand.new(config).run!
       rescue StandardError => e
         UI.user_error! "Error in SetupBranchAction: #{e.message}\n#{e.backtrace}"
       end
 
       def self.description
-        "Adds Branch keys, custom URI schemes and domains to iOS and Android projects."
+        "This action automatically configures Xcode projects that use the Branch SDK " \
+          "for Universal Links and custom URI handling. It modifies Xcode project settings and " \
+          "entitlements as well as Info.plist files. It also validates the Universal Link " \
+          "configuration for Xcode projects."
       end
 
       def self.authors
@@ -23,121 +32,27 @@ module Fastlane
       end
 
       def self.details
-        "This action automatically configures Xcode projects that use the Branch SDK " \
-          "for Universal Links and custom URI handling. It modifies Xcode project settings and " \
-          "entitlements as well as Info.plist files. It also validates the Universal Link " \
-          "configuration for Xcode projects."
+        render :setup_description
       end
 
       def self.example_code
         [
           <<-EOF
-            setup_branch(
-              live_key: "key_live_xxxx",
-              test_key: "key_test_yyyy",
-              app_link_subdomain: "myapp",
-              uri_scheme: "myscheme",
-              xcodeproj: "MyIOSApp.xcodeproj"
-            )
+setup_branch(
+  live_key: "key_live_xxxx",
+  test_key: "key_test_yyyy",
+  app_link_subdomain: "myapp",
+  uri_scheme: "myscheme",
+  xcodeproj: "MyIOSApp.xcodeproj"
+)
           EOF
         ]
       end
 
       def self.available_options
-        [
-          FastlaneCore::ConfigItem.new(key: :xcodeproj,
-                                  env_name: "BRANCH_XCODEPROJ",
-                               description: "Path to an Xcode project to modify",
-                                  optional: true,
-                                      type: String),
-          FastlaneCore::ConfigItem.new(key: :live_key,
-                                  env_name: "BRANCH_LIVE_KEY",
-                               description: "The Branch live key for your app",
-                                  optional: true,
-                                      type: String),
-          FastlaneCore::ConfigItem.new(key: :test_key,
-                                  env_name: "BRANCH_TEST_KEY",
-                               description: "The Branch test key for your app",
-                                  optional: true,
-                                      type: String),
-          FastlaneCore::ConfigItem.new(key: :domains,
-                                  env_name: "BRANCH_DOMAINS",
-                               description: "Branch (and/or non-Branch) Universal Link/App Link domains to add (comma-separated list or array)",
-                                  optional: true,
-                                 is_string: false),
-          FastlaneCore::ConfigItem.new(key: :app_link_subdomain,
-                                  env_name: "BRANCH_APP_LINK_SUBDOMAIN",
-                               description: "app.link subdomain",
-                                  optional: true,
-                                      type: String),
-          FastlaneCore::ConfigItem.new(key: :uri_scheme,
-                                  env_name: "BRANCH_URI_SCHEME",
-                               description: "Custom URI scheme used with Branch",
-                                  optional: true,
-                                      type: String),
-          FastlaneCore::ConfigItem.new(key: :target,
-                                  env_name: "BRANCH_TARGET",
-                               description: "Name of the target in the Xcode project to modify (iOS only)",
-                                  optional: true,
-                                      type: String),
-          FastlaneCore::ConfigItem.new(key: :validate,
-                                  env_name: "BRANCH_VALIDATE",
-                               description: "Determines whether to validate the resulting Universal Link configuration before modifying the project",
-                             default_value: true,
-                                 is_string: false),
-          FastlaneCore::ConfigItem.new(key: :force,
-                                  env_name: "BRANCH_FORCE_UPDATE",
-                               description: "Update project(s) even if Universal Link validation fails",
-                                  optional: true,
-                             default_value: false,
-                                 is_string: false),
-          FastlaneCore::ConfigItem.new(key: :commit,
-                                  env_name: "BRANCH_COMMIT_CHANGES",
-                               description: "Set to true to commit changes to Git; set to a string to commit with a custom message",
-                                  optional: true,
-                             default_value: false,
-                                 is_string: false),
-          FastlaneCore::ConfigItem.new(key: :frameworks,
-                                  env_name: "BRANCH_FRAMEWORKS",
-                               description: "A list of system frameworks to add to the target that uses the Branch SDK (iOS only)",
-                                  optional: true,
-                             default_value: [],
-                                      type: Array),
-          FastlaneCore::ConfigItem.new(key: :add_sdk,
-                                  env_name: "BRANCH_ADD_SDK",
-                               description: "Set to false to disable automatic integration of the Branch SDK",
-                                  optional: true,
-                             default_value: true,
-                                 is_string: false),
-          FastlaneCore::ConfigItem.new(key: :podfile,
-                                  env_name: "BRANCH_PODFILE",
-                               description: "Path to a Podfile to update (iOS only)",
-                                  optional: true,
-                                      type: String),
-          FastlaneCore::ConfigItem.new(key: :patch_source,
-                                  env_name: "BRANCH_PATCH_SOURCE",
-                               description: "Set to false to disable automatic source-code patching",
-                                  optional: true,
-                             default_value: true,
-                                 is_string: false),
-          FastlaneCore::ConfigItem.new(key: :pod_repo_update,
-                                  env_name: "BRANCH_POD_REPO_UPDATE",
-                               description: "Set to false to disable update of local podspec repo before pod install",
-                                  optional: true,
-                             default_value: true,
-                                 is_string: false),
-          FastlaneCore::ConfigItem.new(key: :cartfile,
-                                  env_name: "BRANCH_CARTFILE",
-                               description: "Path to a Cartfile to update (iOS only)",
-                                  optional: true,
-                                      type: String),
-          FastlaneCore::ConfigItem.new(key: :carthage_command,
-                                  env_name: "BRANCH_CARTHAGE_COMMAND",
-                               description: "Command to use when installing with Carthage",
-                                  optional: true,
-                             default_value: "update --platform ios",
-                                      type: String)
-        ]
+        BranchIOCLI::Configuration::SetupConfiguration.available_options.map do |option|
+          FastlaneCore::ConfigItem.from_branch_option(option)
+        end
       end
 
       def self.is_supported?(platform)

data/lib/fastlane/plugin/branch/actions/validate_universal_links_action.rb

@@ -1,11 +1,15 @@
 require "branch_io_cli"
+require "fastlane/plugin/branch/config_item"
+require "fastlane/plugin/branch/fastlane_format"
+
+include Fastlane::Branch::FastlaneDescriptionFormat
 
 module Fastlane
   module Actions
     class ValidateUniversalLinksAction < Action
       def self.run(params)
-        options = Helper::BranchOptions.new params
-        BranchIOCLI::Commands::ValidateCommand.new(options).run!
+        config = BranchIOCLI::Configuration::ValidateConfiguration.wrapper params, false
+        BranchIOCLI::Commands::ValidateCommand.new(config).run! == 0
       rescue StandardError => e
         UI.user_error! "Error in ValidateUniversalLinksAction: #{e.message}\n#{e.backtrace}"
         false
@@ -23,50 +27,26 @@ module Fastlane
       end
 
       def self.details
-        "This action validates all the Universal Link domains found in an Xcode project's entitlements " \
-        "file by ensuring that the development team and bundle identifier combination is found in the " \
-        "domain's apple-app-site-association file."
+        render :validate_description
       end
 
       def self.example_code
         [
-          <<-EOF
-            validate_universal_links
-          EOF,
-          <<-EOF
-            validate_universal_links(xcodeproj: "MyProject.xcodeproj")
-          EOF,
-          <<-EOF
-            validate_universal_links(xcodeproj: "MyProject.xcodeproj", target: "MyProject")
-          EOF,
-          <<-EOF
-            validate_universal_links(domains: %w{example.com www.example.com})
-          EOF
+          "validate_universal_links",
+          %{validate_universal_links(xcodeproj: "MyProject.xcodeproj")},
+          %{validate_universal_links(xcodeproj: "MyProject.xcodeproj", target: "MyProject")},
+          %{validate_universal_links(domains: %w{example.com www.example.com})}
         ]
       end
 
       def self.available_options
-        [
-          FastlaneCore::ConfigItem.new(key: :xcodeproj,
-                                  env_name: "BRANCH_XCODEPROJ",
-                               description: "Path to an Xcode project to validate",
-                                  optional: true,
-                                      type: String),
-          FastlaneCore::ConfigItem.new(key: :target,
-                                  env_name: "BRANCH_TARGET",
-                               description: "Name of the target in the Xcode project to validate",
-                                  optional: true,
-                                      type: String),
-          FastlaneCore::ConfigItem.new(key: :domains,
-                                  env_name: "BRANCH_DOMAINS",
-                               description: "Branch (and/or non-Branch) Universal Link/App Link domains expected to be present in project (comma-separated list or array)",
-                                  optional: true,
-                                 is_string: false)
-        ]
+        BranchIOCLI::Configuration::ValidateConfiguration.available_options.map do |option|
+          FastlaneCore::ConfigItem.from_branch_option(option)
+        end
       end
 
       def self.return_value
-        "Returns true for a valid configuration, false otherwise."
+        BranchIOCLI::Configuration::ValidateConfiguration.return_value
       end
 
       def self.is_supported?(platform)

data/lib/fastlane/plugin/branch/config_item.rb

@@ -0,0 +1,15 @@
+module FastlaneCore
+  class ConfigItem
+    class << self
+      def from_branch_option(option)
+        new(
+          key: option.name,
+          env_name: option.env_name,
+          description: option.description,
+          default_value: option.default_value,
+          type: option.type
+        )
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/branch/fastlane_format.rb

@@ -0,0 +1,42 @@
+require "branch_io_cli/format"
+
+module Fastlane
+  module Branch
+    module FastlaneMarkdownFormat
+      include BranchIOCLI::Format::MarkdownFormat
+
+      def local_render(template)
+        path = File.expand_path(File.join("..", "..", "..", "..", "..", "assets", "templates", "#{template}.erb"), __FILE__)
+        ERB.new(File.read(path)).result binding
+      end
+
+      def table_option(option)
+        "|#{option.name}|#{option.description}|#{option.env_name}|#{option.type ? 'Boolean' : option.type}|#{option.default_value}|"
+      end
+
+      def option(opt)
+        highlight opt.to_s
+      end
+    end
+
+    module FastlaneDescriptionFormat
+      include BranchIOCLI::Format
+
+      def option(opt)
+        highlight opt.to_s
+      end
+
+      def highlight(text)
+        text
+      end
+
+      def italics(text)
+        text
+      end
+
+      def header(text, level = 1)
+        "#{text}: "
+      end
+    end
+  end
+end

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

@@ -1,5 +1,5 @@
 module Fastlane
   module Branch
-    VERSION = "0.6.0"
+    VERSION = "0.7.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-branch
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Branch
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-01 00:00:00.000000000 Z
+date: 2017-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: branch_io_cli
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.12.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.12.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -162,9 +162,11 @@ files:
 - LICENSE
 - README.md
 - lib/fastlane/plugin/branch.rb
+- lib/fastlane/plugin/branch/actions/branch_report_action.rb
 - lib/fastlane/plugin/branch/actions/setup_branch_action.rb
 - lib/fastlane/plugin/branch/actions/validate_universal_links_action.rb
-- lib/fastlane/plugin/branch/helper/branch_options.rb
+- lib/fastlane/plugin/branch/config_item.rb
+- lib/fastlane/plugin/branch/fastlane_format.rb
 - lib/fastlane/plugin/branch/version.rb
 homepage: https://github.com/BranchMetrics/fastlane-plugin-branch
 licenses:
@@ -186,7 +188,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.2
 signing_key: 
 specification_version: 4
 summary: Adds Branch keys, custom URI schemes and domains to iOS and Android projects.

data/lib/fastlane/plugin/branch/helper/branch_options.rb

@@ -1,16 +0,0 @@
-module Fastlane
-  module Helper
-    class BranchOptions
-      attr_reader :params
-
-      # :param: params [FastlaneCore::Configuration] Params from an action
-      def initialize(params)
-        @params = params
-      end
-
-      def method_missing(method_sym, *arguments, &block)
-        return params[method_sym]
-      end
-    end
-  end
-end