pantograph 0.1.14 → 0.1.15

data/pantograph/lib/pantograph/actions/jira.rb

@@ -5,26 +5,19 @@ module Pantograph
         Actions.verify_gem!('jira-ruby')
         require 'jira-ruby'
 
-        site         = params[:url]
-        auth_type    = :basic
-        context_path = params[:context_path]
-        username     = params[:username]
-        password     = params[:password]
-        ticket_id    = params[:ticket_id]
-        comment_text = params[:comment_text]
+        client = JIRA::Client.new(
+          {
+            site: params[:url],
+            context_path: params[:context_path],
+            auth_type: :basic,
+            username: params[:username],
+            password: params[:password]
+          }
+        )
 
-        options = {
-                    site: site,
-                    context_path: context_path,
-                    auth_type: auth_type,
-                    username: username,
-                    password: password
-                  }
-
-        client = JIRA::Client.new(options)
-        issue = client.Issue.find(ticket_id)
+        issue   = client.Issue.find(params[:ticket_id])
         comment = issue.comments.build
-        comment.save({ 'body' => comment_text })
+        comment.save({ 'body' => params[:comment_text] })
       end
 
       #####################################################
@@ -32,47 +25,49 @@ module Pantograph
       #####################################################
 
       def self.description
-        "Leave a comment on JIRA tickets"
+        'Leave a comment on JIRA tickets'
       end
 
       def self.available_options
         [
-          PantographCore::ConfigItem.new(key: :url,
-                                      env_name: 'JIRA_SITE',
-                                      description: 'URL for Jira instance',
-                                       verify_block: proc do |value|
-                                         UI.user_error!("No url for Jira given, pass using `url: 'url'`") if value.to_s.length == 0
-                                       end),
-          PantographCore::ConfigItem.new(key: :context_path,
-                                      env_name: 'JIRA_CONTEXT_PATH',
-                                      description: "Appends to the url (ex: \"/jira\")",
-                                      optional: true,
-                                      default_value: ""),
-          PantographCore::ConfigItem.new(key: :username,
-                                       env_name: 'JIRA_USERNAME',
-                                       description: 'Username for JIRA instance',
-                                       verify_block: proc do |value|
-                                         UI.user_error!('No username') if value.to_s.length == 0
-                                       end),
-          PantographCore::ConfigItem.new(key: :password,
-                                       env_name: 'JIRA_PASSWORD',
-                                       description: 'Password for Jira',
-                                       sensitive: true,
-                                       verify_block: proc do |value|
-                                         UI.user_error!("No password") if value.to_s.length == 0
-                                       end),
-          PantographCore::ConfigItem.new(key: :ticket_id,
-                                       env_name: 'JIRA_TICKET_ID',
-                                       description: 'Ticket ID for Jira, i.e. APP-123',
-                                       verify_block: proc do |value|
-                                         UI.user_error!("No Ticket specified") if value.to_s.length == 0
-                                       end),
-          PantographCore::ConfigItem.new(key: :comment_text,
-                                       env_name: 'JIRA_COMMENT_TEXT',
-                                       description: 'Text to add to the ticket as a comment',
-                                       verify_block: proc do |value|
-                                         UI.user_error!('No comment specified') if value.to_s.length == 0
-                                       end)
+          PantographCore::ConfigItem.new(
+            key: :url,
+            env_name: 'JIRA_SITE',
+            description: 'URL for Jira instance',
+            optional: false
+          ),
+          PantographCore::ConfigItem.new(
+            key: :context_path,
+            env_name: 'JIRA_CONTEXT_PATH',
+            description: "Appends to the url (ex: \"/jira\")",
+            optional: true,
+            default_value: ''
+          ),
+          PantographCore::ConfigItem.new(
+            key: :username,
+            env_name: 'JIRA_USERNAME',
+            description: 'Username for JIRA instance',
+            optional: false
+          ),
+          PantographCore::ConfigItem.new(
+            key: :password,
+            env_name: 'JIRA_PASSWORD',
+            description: 'Password for Jira',
+            sensitive: true,
+            optional: false
+          ),
+          PantographCore::ConfigItem.new(
+            key: :ticket_id,
+            env_name: 'JIRA_TICKET_ID',
+            description: 'Ticket ID for Jira, i.e. APP-123',
+            optional: false
+          ),
+          PantographCore::ConfigItem.new(
+            key: :comment_text,
+            env_name: 'JIRA_COMMENT_TEXT',
+            description: 'Text to add to the ticket as a comment',
+            optional: false
+          )
         ]
       end
 

data/pantograph/lib/pantograph/actions/lane_context.rb

@@ -10,14 +10,14 @@ module Pantograph
       #####################################################
 
       def self.description
-        "Access lane context values"
+        'Access lane context values'
       end
 
       def self.details
         [
-          "Access the pantograph lane context values.",
-          "More information about how the lane context works: [https://johnknapprs.github.io/pantograph/advanced/#lane-context](https://johnknapprs.github.io/pantograph/advanced/#lane-context)."
-        ].join("\n")
+          'More information about how the lane context works:',
+          '[https://johnknapprs.github.io/pantograph/advanced/#lane-context](https://johnknapprs.github.io/pantograph/advanced/#lane-context)'
+        ].join(' ')
       end
 
       def self.available_options
@@ -33,7 +33,7 @@ module Pantograph
       end
 
       def self.authors
-        ["KrauseFx"]
+        ['KrauseFx']
       end
 
       def self.is_supported?(platform)
@@ -47,7 +47,7 @@ module Pantograph
 
       def self.example_code
         [
-          'lane_context[SharedValues::BUILD_NUMBER]',
+          'lane_context[:BUILD_NUMBER]',
           'lane_context[SharedValues::IPA_OUTPUT_PATH]'
         ]
       end

data/pantograph/lib/pantograph/actions/last_git_commit.rb

@@ -10,7 +10,7 @@ module Pantograph
       #####################################################
 
       def self.description
-        "Return last git commit hash, abbreviated commit hash, commit message and author"
+        'Return last git commit hash, abbreviated commit hash, commit message and author'
       end
 
       def self.return_value
@@ -21,8 +21,8 @@ module Pantograph
         :hash_of_strings
       end
 
-      def self.author
-        "ngutman"
+      def self.authors
+        ['ngutman', 'johnknapprs']
       end
 
       def self.is_supported?(platform)

data/pantograph/lib/pantograph/actions/min_pantograph_version.rb

@@ -1,57 +1,51 @@
 module Pantograph
   module Actions
-    module SharedValues
-    end
-
     class MinPantographVersionAction < Action
       def self.run(params)
-        params = nil unless params.kind_of?(Array)
-        value = (params || []).first
-        defined_version = Gem::Version.new(value) if value
-
-        UI.user_error!("Please pass minimum pantograph version as parameter to min_pantograph_version") unless defined_version
+        begin
+          defined_version = Gem::Version.new(params.first)
+        rescue
+          UI.user_error!('Please provide minimum pantograph version')
+        end
 
         if Gem::Version.new(Pantograph::VERSION) < defined_version
           PantographCore::UpdateChecker.show_update_message('pantograph', Pantograph::VERSION)
           error_message = "The Pantfile requires a pantograph version of >= #{defined_version}. You are on #{Pantograph::VERSION}."
           UI.user_error!(error_message)
+        else
+          UI.success("Your pantograph version #{Pantograph::VERSION} matches the minimum requirement of #{defined_version}  ✅")
         end
+      end
 
-        UI.message("Your pantograph version #{Pantograph::VERSION} matches the minimum requirement of #{defined_version}  ✅")
+      def self.description
+        'Verifies the minimum pantograph version required'
       end
 
-      def self.step_text
-        "Verifying pantograph version"
+      def self.details
+        'Add this to your `Pantfile` to require a certain version of _pantograph_.'
       end
 
-      def self.author
-        "KrauseFx"
+      def self.authors
+        ['KrauseFx', 'johnknapprs']
       end
 
-      def self.description
-        "Verifies the minimum pantograph version required"
+      def self.is_supported?(platform)
+        true
       end
 
       def self.example_code
         [
-          'min_pantograph_version("1.50.0")'
+          'min_pantograph_version("0.14.0")'
         ]
       end
 
-      def self.details
-        [
-          "Add this to your `Pantfile` to require a certain version of _pantograph_.",
-          "Use it if you use an action that just recently came out and you need it."
-        ].join("\n")
+      def self.step_text
+        'Verifying pantograph version'
       end
 
       def self.category
         :misc
       end
-
-      def self.is_supported?(platform)
-        true
-      end
     end
   end
 end

data/pantograph/lib/pantograph/actions/number_of_commits.rb

@@ -1,24 +1,17 @@
 module Pantograph
   module Actions
-    class NumberOfCommitsAction < Action
-      def self.is_git?
-        Actions.sh('git rev-parse HEAD')
-        return true
-      rescue
-        return false
-      end
+    module SharedValues
+      NUMBER_OF_COMMITS = :NUMBER_OF_COMMITS
+    end
 
+    class NumberOfCommitsAction < Action
       def self.run(params)
-        if is_git?
-          if params[:all]
-            command = 'git rev-list --all --count'
-          else
-            command = 'git rev-list HEAD --count'
-          end
-        else
-          UI.user_error!("Not in a git repository.")
-        end
-        return Actions.sh(command).strip.to_i
+        Pantograph::Helper::Git.is_git?
+
+        type    = params[:all] ? '--all' : 'HEAD'
+        commits = Actions.sh("git rev-list #{type} --count").strip.to_i
+
+        Actions.lane_context[:NUMBER_OF_COMMITS] = commits
       end
 
       #####################################################
@@ -29,8 +22,7 @@ module Pantograph
         'Return the number of commits in current git branch'
       end
 
-      def self.return_value
-        'The total number of all commits in current git branch'
+      def self.details
       end
 
       def self.return_type
@@ -39,20 +31,28 @@ module Pantograph
 
       def self.available_options
         [
-          PantographCore::ConfigItem.new(key: :all,
-                                       env_name: 'NUMBER_OF_COMMITS_ALL',
-                                       optional: true,
-                                       is_string: false,
-                                       description: 'Returns number of all commits instead of current branch')
+          PantographCore::ConfigItem.new(
+            key: :all,
+            env_name: 'NUMBER_OF_COMMITS_ALL',
+            optional: true,
+            is_string: false,
+            description: 'Returns number of all commits instead of current branch'
+          )
         ]
       end
 
-      def self.details
-        'You can use this action to get the number of commits of this branch. This is useful if you want to set the build number to the number of commits. See `pantograph actions number_of_commits` for more details.'
+      def self.return_value
+        'The total number of all commits in current git branch'
+      end
+
+      def self.output
+        [
+          'NUMBER_OF_COMMITS', 'Total number of git commits'
+        ]
       end
 
       def self.authors
-        ['onevcat', 'samuelbeek']
+        ['onevcat', 'samuelbeek', 'johnknapprs']
       end
 
       def self.is_supported?(platform)
@@ -61,9 +61,13 @@ module Pantograph
 
       def self.example_code
         [
-          'increment_build_number(build_number: number_of_commits)',
-          'build_number = number_of_commits(all: true)
-          increment_build_number(build_number: build_number)'
+          '
+          ENV["VERSION_NAME"] = number_of_commits
+          ',
+          '
+          build_number = number_of_commits(all: true)
+          increment_build_number(build_number: build_number)
+          '
         ]
       end
 

data/pantograph/lib/pantograph/actions/opt_out_usage.rb

@@ -2,24 +2,24 @@ module Pantograph
   module Actions
     class OptOutUsageAction < Action
       def self.run(params)
-        ENV['PANTOGRAPH_OPT_OUT_USAGE'] = "YES"
-        UI.message("Disabled upload of used actions")
+        ENV['PANTOGRAPH_OPT_OUT_USAGE'] = 'YES'
+        UI.message('Disabled upload of used actions')
       end
 
       def self.description
-        "This will stop uploading the information which actions were run"
+        'This will stop uploading the information which actions were run'
       end
 
       def self.details
         [
-          "By default, _pantograph_ will track what actions are being used. No personal/sensitive information is recorded.",
-          "Learn more at [https://johnknapprs.github.io/pantograph/#metrics](https://johnknapprs.github.io/pantograph/#metrics).",
-          "Add `opt_out_usage` at the top of your Pantfile to disable metrics collection."
+          'By default, _pantograph_ will track what actions are being used. No personal/sensitive information is recorded.',
+          'Learn more at [https://johnknapprs.github.io/pantograph/#metrics](https://johnknapprs.github.io/pantograph/#metrics).',
+          'Add `opt_out_usage` at the top of your Pantfile to disable metrics collection.'
         ].join("\n")
       end
 
-      def self.author
-        "KrauseFx"
+      def self.authors
+        ['KrauseFx']
       end
 
       def self.is_supported?(platform)
@@ -28,10 +28,16 @@ module Pantograph
 
       def self.example_code
         [
-          'opt_out_usage # add this to the top of your Pantfile'
+          ' # add this to the top of your Pantfile
+            opt_out_usage
+          '
         ]
       end
 
+      def self.step_text
+        'Disabled Usage Data Tracking'
+      end
+
       def self.category
         :misc
       end

data/pantograph/lib/pantograph/actions/pantograph_version.rb

@@ -1,4 +1,4 @@
-require "pantograph/actions/min_pantograph_version"
+require 'pantograph/actions/min_pantograph_version'
 
 module Pantograph
   module Actions
@@ -8,7 +8,7 @@ module Pantograph
       #####################################################
 
       def self.description
-        "Alias for the `min_pantograph_version` action"
+        'Alias for the `min_pantograph_version` action'
       end
     end
   end

data/pantograph/lib/pantograph/actions/println.rb

@@ -7,7 +7,7 @@ module Pantograph
       #####################################################
 
       def self.description
-        "Alias for the `puts` action"
+        'Alias for the `puts` action'
       end
     end
   end

data/pantograph/lib/pantograph/actions/prompt.rb

@@ -3,13 +3,12 @@ module Pantograph
     class PromptAction < Action
       def self.run(params)
         if params[:boolean]
-          return params[:ci_input] unless UI.interactive?
-          return UI.confirm(params[:text])
+          return Helper.ci? ? params[:ci_input] : UI.confirm(params[:text])
         end
 
         UI.message(params[:text])
 
-        return params[:ci_input] unless UI.interactive?
+        return params[:ci_input] if Helper.ci?
 
         if params[:multi_line_end_keyword]
           # Multi line
@@ -58,24 +57,34 @@ module Pantograph
 
       def self.available_options
         [
-          PantographCore::ConfigItem.new(key: :text,
-                                       description: "The text that will be displayed to the user",
-                                       default_value: "Please enter some text: "),
-          PantographCore::ConfigItem.new(key: :ci_input,
-                                       description: "The default text that will be used when being executed on a CI service",
-                                       default_value: ''),
-          PantographCore::ConfigItem.new(key: :boolean,
-                                       description: "Is that a boolean question (yes/no)? This will add (y/n) at the end",
-                                       default_value: false,
-                                       is_string: false),
-          PantographCore::ConfigItem.new(key: :secure_text,
-                                       description: "Is that a secure text (yes/no)?",
-                                       default_value: false,
-                                       is_string: false),
-          PantographCore::ConfigItem.new(key: :multi_line_end_keyword,
-                                       description: "Enable multi-line inputs by providing an end text (e.g. 'END') which will stop the user input",
-                                       optional: true,
-                                       type: String)
+          PantographCore::ConfigItem.new(
+            key: :text,
+            description: "The text that will be displayed to the user",
+            default_value: "Please enter some text: "
+          ),
+          PantographCore::ConfigItem.new(
+            key: :ci_input,
+            description: "The default text that will be used when being executed on a CI service",
+            default_value: ''
+          ),
+          PantographCore::ConfigItem.new(
+            key: :boolean,
+            description: "Is that a boolean question (yes/no)? This will add (y/n) at the end",
+            default_value: false,
+            is_string: false
+          ),
+          PantographCore::ConfigItem.new(
+            key: :secure_text,
+            description: "Is that a secure text (yes/no)?",
+            default_value: false,
+            is_string: false
+          ),
+          PantographCore::ConfigItem.new(
+            key: :multi_line_end_keyword,
+            description: "Enable multi-line inputs by providing an end text (e.g. 'END') which will stop the user input",
+            optional: true,
+            type: String
+          )
         ]
       end
 
@@ -84,7 +93,7 @@ module Pantograph
       end
 
       def self.authors
-        ["KrauseFx"]
+        ['KrauseFx', 'johnknapprs']
       end
 
       def self.is_supported?(platform)

data/pantograph/lib/pantograph/actions/prompt_secure.rb

@@ -0,0 +1,128 @@
+module Pantograph
+  module Actions
+    class PromptSecureAction < Action
+      def self.run(params)
+        if params[:boolean]
+          return Helper.ci? ? params[:ci_input] : UI.confirm(params[:text])
+        end
+
+        UI.message(params[:text])
+
+        return params[:ci_input] if Helper.ci?
+
+        if params[:multi_line_end_keyword]
+          # Multi line
+          end_tag = params[:multi_line_end_keyword]
+          UI.important("Submit inputs using \"#{params[:multi_line_end_keyword]}\"")
+          user_input = ""
+          loop do
+            line = STDIN.gets # returns `nil` if called at end of file
+            break unless line
+            end_tag_index = line.index(end_tag)
+            if end_tag_index.nil?
+              user_input << line
+            else
+              user_input << line.slice(0, end_tag_index)
+              user_input = user_input.strip
+              break
+            end
+          end
+        else
+          # Standard one line input
+          if params[:secure_text]
+            user_input = STDIN.noecho(&:gets).chomp while (user_input || "").length == 0
+          else
+            user_input = STDIN.gets.chomp.strip while (user_input || "").length == 0
+          end
+        end
+
+        return user_input
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Ask the user for a value or for confirmation"
+      end
+
+      def self.details
+        [
+          "You can use `prompt` to ask the user for a value or to just let the user confirm the next step.",
+          "When this is executed on a CI service, the passed `ci_input` value will be returned.",
+          "This action also supports multi-line inputs using the `multi_line_end_keyword` option."
+        ].join("\n")
+      end
+
+      def self.available_options
+        [
+          PantographCore::ConfigItem.new(
+            key: :text,
+            description: 'The text that will be displayed to the user',
+            default_value: 'Please enter some text: '
+          ),
+          PantographCore::ConfigItem.new(
+            key: :ci_input,
+            description: 'The default text that will be used when being executed on a CI service',
+            default_value: ''
+          ),
+          PantographCore::ConfigItem.new(
+            key: :boolean,
+            description: 'Is that a boolean question (yes/no)? This will add (y/n) at the end',
+            default_value: false,
+            is_string: false
+          ),
+          PantographCore::ConfigItem.new(
+            key: :secure_text,
+            description: 'Is that a secure text (yes/no)?',
+            default_value: false,
+            is_string: false
+          ),
+          PantographCore::ConfigItem.new(
+            key: :multi_line_end_keyword,
+            description: "Enable multi-line inputs by providing an end text (e.g. 'END') which will stop the user input",
+            optional: true,
+            type: String
+          )
+        ]
+      end
+
+      def self.output
+        []
+      end
+
+      def self.authors
+        ['KrauseFx', 'johnknapprs']
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.example_code
+        [
+          'changelog = prompt(text: "Changelog: ")',
+          'changelog = prompt(
+            text: "Changelog: ",
+            multi_line_end_keyword: "END"
+          )
+
+          crashlytics(notes: changelog)'
+        ]
+      end
+
+      def self.sample_return_value
+        "User Content\nWithNewline"
+      end
+
+      def self.return_type
+        :string
+      end
+
+      def self.category
+        :misc
+      end
+    end
+  end
+end

data/pantograph/lib/pantograph/actions/reset_git_repo.rb

@@ -5,7 +5,7 @@ module Pantograph
     # Does a hard reset and clean on the repo
     class ResetGitRepoAction < Action
       def self.run(params)
-        if params[:force] || Actions.lane_context[SharedValues::GIT_REPO_WAS_CLEAN_ON_START]
+        if params[:force] || Actions.lane_context[SharedValues::ENSURE_GIT_STATUS_CLEAN]
           paths = params[:files]
 
           return paths if Helper.test?