Merge 37bfd79 into b941ff7

piotrmurach · Mar 24, 2020 · d658012 · d658012
2 parents b941ff7 + 37bfd79
commit d658012
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 17 deletions.
diff --git a/lib/tty/prompt/question.rb b/lib/tty/prompt/question.rb
@@ -35,23 +35,29 @@ def to_s
       #
       # @api public
       def initialize(prompt, **options)
-        @prompt     = prompt
-        @prefix     = options.fetch(:prefix) { @prompt.prefix }
-        @default    = options.fetch(:default) { UndefinedSetting }
-        @required   = options.fetch(:required) { false }
-        @echo       = options.fetch(:echo) { true }
-        @in         = options.fetch(:in) { UndefinedSetting }
-        @modifier   = options.fetch(:modifier) { [] }
-        @validation = options.fetch(:validation) { UndefinedSetting }
-        @convert    = options.fetch(:convert) { UndefinedSetting }
+        # Option deprecation
+        if options[:validation]
+          warn "[DEPRECATION] The `:validation` option is deprecated. Use `:validate` instead."
+          options[:validate] = options[:validation]
+        end
+
+        @prompt       = prompt
+        @prefix       = options.fetch(:prefix) { @prompt.prefix }
+        @default      = options.fetch(:default) { UndefinedSetting }
+        @required     = options.fetch(:required) { false }
+        @echo         = options.fetch(:echo) { true }
+        @in           = options.fetch(:in) { UndefinedSetting }
+        @modifier     = options.fetch(:modifier) { [] }
+        @validation   = options.fetch(:validate) { UndefinedSetting }
+        @convert      = options.fetch(:convert) { UndefinedSetting }
         @active_color = options.fetch(:active_color) { @prompt.active_color }
-        @help_color = options.fetch(:help_color) { @prompt.help_color }
-        @error_color = options.fetch(:error_color) { :red }
-        @value      = options.fetch(:value) { UndefinedSetting }
-        @messages   = Utils.deep_copy(options.fetch(:messages) { { } })
-        @done       = false
+        @help_color   = options.fetch(:help_color) { @prompt.help_color }
+        @error_color  = options.fetch(:error_color) { :red }
+        @value        = options.fetch(:value) { UndefinedSetting }
+        @messages     = Utils.deep_copy(options.fetch(:messages) { { } })
+        @done         = false
         @first_render = true
-        @input      = nil
+        @input        = nil
 
         @evaluator = Evaluator.new(self)
 

diff --git a/spec/unit/question/validate_spec.rb b/spec/unit/question/validate_spec.rb
@@ -45,6 +45,15 @@
     expect(answer).to eq('piotr@example.com')
   end
 
+  it 'deprecates :validation option' do
+    prompt.input << 'piotr@example.com'
+    prompt.input.rewind
+
+    expect do
+      prompt.ask('What is your email?', validation: :email)
+    end.to output("[DEPRECATION] The `:validation` option is deprecated. Use `:validate` instead.\n").to_stderr
+  end
+
   it "provides default error message for wrong input" do
     prompt.input << "wrong\np@m.com\n"
     prompt.input.rewind
@@ -83,8 +92,7 @@
     prompt.input << "wrong\np@m.com"
     prompt.input.rewind
 
-    answer = prompt.ask('What is your email?') do |q|
-      q.validate :email
+    answer = prompt.ask('What is your email?', validate: :email) do |q|
       q.messages[:valid?] = 'Not an email!'
     end