class Pantograph::Actions::PromptSecureAction

Public Class Methods

authors() click to toggle source
# File pantograph/lib/pantograph/actions/prompt_secure.rb, line 95
def self.authors
  ['KrauseFx', 'johnknapprs']
end
available_options() click to toggle source
# File pantograph/lib/pantograph/actions/prompt_secure.rb, line 58
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
category() click to toggle source
# File pantograph/lib/pantograph/actions/prompt_secure.rb, line 123
def self.category
  :misc
end
description() click to toggle source

@!group Documentation

# File pantograph/lib/pantograph/actions/prompt_secure.rb, line 46
def self.description
  "Ask the user for a value or for confirmation"
end
details() click to toggle source
# File pantograph/lib/pantograph/actions/prompt_secure.rb, line 50
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
example_code() click to toggle source
# File pantograph/lib/pantograph/actions/prompt_secure.rb, line 103
def self.example_code
  [
    'changelog = prompt(text: "Changelog: ")',
    'changelog = prompt(
      text: "Changelog: ",
      multi_line_end_keyword: "END"
    )

    sh("echo #{changelog}")'
  ]
end
is_supported?(platform) click to toggle source
# File pantograph/lib/pantograph/actions/prompt_secure.rb, line 99
def self.is_supported?(platform)
  true
end
output() click to toggle source
# File pantograph/lib/pantograph/actions/prompt_secure.rb, line 91
def self.output
  []
end
return_type() click to toggle source
# File pantograph/lib/pantograph/actions/prompt_secure.rb, line 119
def self.return_type
  :string
end
run(params) click to toggle source
# File pantograph/lib/pantograph/actions/prompt_secure.rb, line 4
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
sample_return_value() click to toggle source
# File pantograph/lib/pantograph/actions/prompt_secure.rb, line 115
def self.sample_return_value
  "User Content\nWithNewline"
end