branch_io_cli 0.10.0 → 0.11.0

data/lib/branch_io_cli/configuration/validate_configuration.rb

@@ -1,7 +1,36 @@
 module BranchIOCLI
   module Configuration
     class ValidateConfiguration < Configuration
-      attr_reader :domains
+      class << self
+        def return_value
+          "If validation passes, this command returns 0. If validation fails, it returns 1."
+        end
+
+        def available_options
+          [
+            Option.new(
+              name: :domains,
+              description: "Comma-separated list of domains to validate (Branch domains or non-Branch domains)",
+              type: Array,
+              example: "example.com,www.example.com",
+              aliases: "-D",
+              default_value: []
+            ),
+            Option.new(
+              name: :xcodeproj,
+              description: "Path to an Xcode project to update",
+              type: String,
+              example: "MyProject.xcodeproj"
+            ),
+            Option.new(
+              name: :target,
+              description: "Name of a target to validate in the Xcode project",
+              type: String,
+              example: "MyAppTarget"
+            )
+          ]
+        end
+      end
 
       def initialize(options)
         super

data/lib/branch_io_cli/core_ext/io.rb

@@ -1,4 +1,5 @@
 require "open3"
+require "shellwords"
 
 class IO
   # Report the command. Execute the command, capture stdout
@@ -6,8 +7,9 @@ class IO
   # status at the end in case of error. Returns a Process::Status
   # object.
   #
-  # :command: [String] a shell command to execute and report
+  # @param command [String, Array] a shell command to execute and report
   def log_command(command)
+    command = command.map(&:to_s).map(&:shellescape).join(" ") if command.kind_of? Array
     write "$ #{command}\n\n"
 
     Open3.popen2e(command) do |stdin, output, thread|
@@ -31,8 +33,9 @@ end
 # not redirected. Report the exit status at the end if nonzero.
 # Returns a Process::Status object.
 #
-# :command: [String] a shell command to execute and report
+# @param command [String, Array] a shell command to execute and report
 def STDOUT.log_command(command)
+  command = command.map(&:to_s).map(&:shellescape).join(" ") if command.kind_of? Array
   # TODO: Improve this implementation?
   say "<%= color(%q{$ #{command}}, [MAGENTA, BOLD]) %>\n\n"
   # May also write to stderr

data/lib/branch_io_cli/format.rb

@@ -0,0 +1,15 @@
+require "branch_io_cli/format/commander_format"
+require "branch_io_cli/format/markdown_format"
+
+module BranchIOCLI
+  module Format
+    def render(template)
+      path = File.expand_path(File.join("..", "..", "assets", "templates", "#{template}.erb"), __FILE__)
+      ERB.new(File.read(path)).result binding
+    end
+
+    def option(opt)
+      highlight "--#{opt.to_s.gsub(/_/, '-')}"
+    end
+  end
+end

data/lib/branch_io_cli/format/commander_format.rb

@@ -0,0 +1,21 @@
+require "erb"
+
+module BranchIOCLI
+  module Format
+    module CommanderFormat
+      include Format
+
+      def header(text, level = 1)
+        highlight text
+      end
+
+      def highlight(text)
+        "<%= color('#{text}', BOLD) %>"
+      end
+
+      def italics(text)
+        highlight text
+      end
+    end
+  end
+end

data/lib/branch_io_cli/format/markdown_format.rb

@@ -0,0 +1,60 @@
+module BranchIOCLI
+  module Format
+    module MarkdownFormat
+      include Format
+
+      def header(text, level = 1)
+        "#" * level + " #{text}"
+      end
+
+      def highlight(text)
+        "`#{text}`"
+      end
+
+      def italics(text)
+        "_#{text}_"
+      end
+
+      def table_options
+        @command.available_options.map { |o| table_option o }.join("\n")
+      end
+
+      def table_option(option)
+        text = "|#{option.aliases.join(', ')}"
+        text += ", " unless option.aliases.blank?
+
+        text += "--"
+        text += "[no-]" if option.negatable
+        text += option.name.to_s.gsub(/_/, '-')
+
+        if option.example
+          text += " "
+          text += "[" if option.argument_optional
+          text += option.example
+          text += "]" if option.argument_optional
+        end
+
+        text += "|#{option.description}"
+
+        if option.type.nil?
+          default_value = option.default_value ? "yes" : "no"
+        else
+          default_value = option.default_value
+        end
+
+        if default_value
+          text += " (default: #{default_value})"
+        end
+        text += "|"
+        text
+      end
+
+      def render_command(name)
+        @command = Object.const_get("BranchIOCLI")
+                         .const_get("Command")
+                         .const_get("#{name.to_s.capitalize}Command")
+        render :command
+      end
+    end
+  end
+end

data/lib/branch_io_cli/helper/ios_helper.rb

@@ -489,11 +489,14 @@ module BranchIOCLI
         add_change pods_folder_path
         add_change workspace_path
 
-        cmd = "git add #{Shellwords.escape(podfile_pathname)} " \
-          "#{Shellwords.escape(podfile_pathname)}.lock " \
-          "#{Shellwords.escape(pods_folder_path)} " \
-          "#{Shellwords.escape(workspace_path)}"
-        sh cmd
+        sh [
+          "git",
+          "add",
+          podfile_pathname,
+          "#{podfile_pathname}.lock",
+          pods_folder_path,
+          workspace_path
+        ]
       end
 
       def add_carthage(options)
@@ -543,10 +546,7 @@ EOF
         carthage_folder_path = Pathname.new(File.expand_path("../Carthage", cartfile_path)).relative_path_from(Pathname.pwd)
         cartfile_pathname = Pathname.new(cartfile_path).relative_path_from Pathname.pwd
         add_change carthage_folder_path
-        cmd = "git add #{Shellwords.escape(cartfile_pathname)} " \
-          "#{Shellwords.escape(cartfile_pathname)}.resolved " \
-          "#{Shellwords.escape(carthage_folder_path)}"
-        sh cmd
+        sh ["git", "add", cartfile_pathname, "#{cartfile_pathname}.resolved", carthage_folder_path]
       end
 
       def add_direct(options)
@@ -601,7 +601,7 @@ EOF
 
         add_change config.xcodeproj_path
         add_change framework_path
-        sh "git add #{Shellwords.escape(framework_path)}" if options.commit
+        sh ["git", "add", framework_path] if options.commit
 
         say "Done. ✅"
       end
@@ -646,12 +646,12 @@ EOF
 
         # 4. Check if Pods folder is under SCM
         pods_folder_path = Pathname.new(File.expand_path("../Pods", podfile_path)).relative_path_from Pathname.pwd
-        `git ls-files #{pods_folder_path} --error-unmatch > /dev/null 2>&1`
+        `git ls-files #{pods_folder_path.to_s.shellescape} --error-unmatch > /dev/null 2>&1`
         return true unless $?.exitstatus == 0
 
         # 5. If so, add the Pods folder to the commit (in case :commit param specified)
         add_change pods_folder_path
-        sh "git add #{Shellwords.escape(pods_folder_path)}" if options.commit
+        sh ["git", "add", pods_folder_path] if options.commit
 
         true
       end
@@ -693,12 +693,12 @@ EOF
 
         # 6. Check if Carthage folder is under SCM
         carthage_folder_path = Pathname.new(File.expand_path("../Carthage", cartfile_path)).relative_path_from Pathname.pwd
-        `git ls-files #{carthage_folder_path} --error-unmatch > /dev/null 2>&1`
+        `git ls-files #{carthage_folder_path.to_s.shellescape} --error-unmatch > /dev/null 2>&1`
         return true unless $?.exitstatus == 0
 
         # 7. If so, add the Carthage folder to the commit (in case :commit param specified)
         add_change carthage_folder_path
-        sh "git add #{Shellwords.escape(carthage_folder_path)}" if options.commit
+        sh ["git", "add", carthage_folder_path] if options.commit
 
         true
       end

data/lib/branch_io_cli/helper/methods.rb

@@ -19,8 +19,8 @@ module BranchIOCLI
       # other cases, both stdout and stderr are redirected to output.
       # In these cases, formatting (colors, highlights) may be lost.
       #
-      # :command: [String] A shell command to execute
-      # :output: [IO] An optional IO object to receive stdout and stderr from the command
+      # @param command [String, Array] A shell command to execute
+      # @param output [IO] An optional IO object to receive stdout and stderr from the command
       def sh(command, output = STDOUT)
         status = output.log_command command
         raise CommandError, [%{Error executing "#{command}": #{status}.}, status] unless status.success?

data/lib/branch_io_cli/rake_task.rb

@@ -5,29 +5,13 @@ require "highline/import"
 
 module BranchIOCLI
   class RakeTask < Rake::TaskLib
-    ReportOptions = Struct.new(
-      :cartfile,
-      :clean,
-      :configuration,
-      :header_only,
-      :out,
-      :pod_repo_update,
-      :podfile,
-      :scheme,
-      :sdk,
-      :target,
-      :xcodeproj,
-      :workspace
-    )
-
     attr_reader :defaults
 
-    def initialize(defaults = {}, &b)
-      @defaults = defaults
-      @defaults[:report] ||= {}
-
-      namespace :branch do
+    def initialize(name = :branch, &b)
+      namespace name do
         report_task
+        setup_task
+        validate_task
       end
     end
 
@@ -39,50 +23,38 @@ module BranchIOCLI
 
         paths.each do |path|
           Dir.chdir(path) do |p|
-            Command::ReportCommand.new(report_options(args[:options])).run!
+            Command::ReportCommand.new(Configuration::ReportConfiguration.wrapper(args[:options] || {})).run!
           end
         end
       end
     end
 
-    # rubocop: disable Metrics/PerceivedComplexity
-    def report_options(options)
-      options ||= {}
-      defs = defaults[:report]
+    def setup_task
+      desc "Set a project up with the Branch SDK"
+      task :setup, %i{paths options} do |task, args|
+        paths = args[:paths]
+        paths = [paths] unless paths.respond_to?(:each)
 
-      if options[:clean].nil? && defs[:clean].nil?
-        clean = true
-      else
-        clean = options[:clean] || defs[:clean]
+        paths.each do |path|
+          Dir.chdir(path) do |p|
+            Command::SetupCommand.new(Configuration::SetupConfiguration.wrapper(args[:options] || {})).run!
+          end
+        end
       end
+    end
 
-      if options[:pod_repo_update].nil? && defs[:pod_repo_update].nil?
-        repo_update = true
-      else
-        repo_update = options[:pod_repo_update] || defs[:pod_repo_update]
-      end
+    def validate_task
+      desc "Validate universal links in one or more projects"
+      task :validate, %i{paths options} do |task, args|
+        paths = args[:paths]
+        paths = [paths] unless paths.respond_to?(:each)
 
-      if options[:header_only].nil? && defs[:header_only].nil?
-        header_only = false
-      else
-        header_only = options[:header_only] || defs[:header_only]
+        paths.each do |path|
+          Dir.chdir(path) do |p|
+            Command::ValidateCommand.new(Configuration::ValidateConfiguration.wrapper(args[:options] || {})).run!
+          end
+        end
       end
-
-      ReportOptions.new(
-        options[:cartfile] || defs[:cartfile],
-        clean,
-        options[:configuration] || defs[:configuration],
-        header_only,
-        options[:out] || defs[:out] || "./report.txt",
-        repo_update,
-        options[:podfile] || defs[:podfile],
-        options[:scheme] || defs[:scheme],
-        options[:sdk] || defs[:sdk] || "iphonesimulator",
-        options[:target] || defs[:target],
-        options[:xcodeproj] || defs[:xcodeproj],
-        options[:workspace] || defs[:workspace]
-      )
     end
-    # rubocop: enable Metrics/PerceivedComplexity
   end
 end

data/lib/branch_io_cli/version.rb

@@ -1,3 +1,3 @@
 module BranchIOCLI
-  VERSION = "0.10.0"
+  VERSION = "0.11.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: branch_io_cli
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Branch
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-16 00:00:00.000000000 Z
+date: 2017-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: CFPropertyList
@@ -287,6 +287,11 @@ files:
 - lib/assets/patches/open_url_source_application_swift.yml
 - lib/assets/patches/open_url_swift.yml
 - lib/assets/patches/swift_import.yml
+- lib/assets/templates/command.erb
+- lib/assets/templates/program_description.erb
+- lib/assets/templates/report_description.erb
+- lib/assets/templates/setup_description.erb
+- lib/assets/templates/validate_description.erb
 - lib/branch_io_cli.rb
 - lib/branch_io_cli/cli.rb
 - lib/branch_io_cli/command.rb
@@ -296,6 +301,8 @@ files:
 - lib/branch_io_cli/command/validate_command.rb
 - lib/branch_io_cli/configuration.rb
 - lib/branch_io_cli/configuration/configuration.rb
+- lib/branch_io_cli/configuration/option.rb
+- lib/branch_io_cli/configuration/option_wrapper.rb
 - lib/branch_io_cli/configuration/report_configuration.rb
 - lib/branch_io_cli/configuration/setup_configuration.rb
 - lib/branch_io_cli/configuration/validate_configuration.rb
@@ -303,6 +310,9 @@ files:
 - lib/branch_io_cli/core_ext.rb
 - lib/branch_io_cli/core_ext/io.rb
 - lib/branch_io_cli/core_ext/regexp.rb
+- lib/branch_io_cli/format.rb
+- lib/branch_io_cli/format/commander_format.rb
+- lib/branch_io_cli/format/markdown_format.rb
 - lib/branch_io_cli/helper.rb
 - lib/branch_io_cli/helper/android_helper.rb
 - lib/branch_io_cli/helper/branch_helper.rb