tty-prompt 0.16.0 → 0.16.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6dde0a99b670047f5cd262c047451d003dfc47ed8179bcd8b4f5e826612baeb8
-  data.tar.gz: 2b9dca2f4d4790a157f30457dd1e5d4c1696aaaf29327624ee886342e67acec5
+  metadata.gz: aec759d54706c89726d2a7a9b5ec7d7dd14c773c0cb1240e1ecf51c2a0b734c6
+  data.tar.gz: af25b5b8fe122644232e5e02fd2aea203bad75901d7dfa1d2c0605c4181035ab
 SHA512:
-  metadata.gz: d7504991bca7514addf3b72afdd2fcbf3e811528d06e9dede50edc7c80398a1cc486e6662162094afe5eb06657df14fa06082d59b4e587ed2afeac66af7f1e6b
-  data.tar.gz: d6ab20ddeae00214b47428e6c5f9a65aa756d08466e5bf68e84acf6f58cba975d81ad4f99ffa687190694e7bd158e5a82c9af9c6bb74c802344aeb6f2badf628
+  metadata.gz: a44c4754daf0cabddbcce1a3863988603150df18364075ad0b9d2bef8193d16b3e0d67804f7553ace2f68c907cbcf9ad708f28442b5bd66c088400732bfa8101
+  data.tar.gz: 4253e5b3e30113775138f233c28a020291d3d20a70ed8f7e37c68407c62ebda1f09788909274c66c8e8e88cb4c855dd0085a13a89a9e42b7fc5174dabc05051c

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change log
 
+## [v0.16.1] - 2018-04-29
+
+### Fixed
+* Fix key events subscription to only listen for the current prompt events
+
 ## [v0.16.0] - 2018-03-11
 
 ### Added
@@ -261,6 +266,7 @@
 
 * Initial implementation and release
 
+[v0.16.1]: https://github.com/piotrmurach/tty-prompt/compare/v0.16.0...v0.16.1
 [v0.16.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.15.0...v0.16.0
 [v0.15.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.14.0...v0.15.0
 [v0.14.0]: https://github.com/piotrmurach/tty-prompt/compare/v0.13.2...v0.14.0

data/Gemfile

@@ -2,7 +2,7 @@ source 'https://rubygems.org'
 
 gemspec
 
-# gem 'tty-reader', path: '../tty-reader'
+#gem 'tty-reader', path: '../tty-reader'
 # gem 'tty-reader', git: 'https://github.com/piotrmurach/tty-reader'
 
 group :test do

data/README.md

@@ -79,8 +79,9 @@ Or install it yourself as:
       * [2.6.2.1 :disabled](#2621-disabled)
       * [2.6.2.2 :filter](#2622-filter)
     * [2.6.3 multi_select](#263-multi_select)
-      * [2.6.3.1 :echo](#2631-echo)
-      * [2.6.3.2 :filter](#2632-filter)
+      * [2.6.3.1 :disabled](#2631-disabled)
+      * [2.6.3.2 :echo](#2632-echo)
+      * [2.6.3.3 :filter](#2633-filter)
     * [2.6.4 enum_select](#264-enum_select)
   * [2.7 expand](#27-expand)
   * [2.8 collect](#28-collect)
@@ -890,7 +891,36 @@ prompt.multi_select("Choose your letter?", letters, per_page: 4)
 # (Move up or down to reveal more choices)
 ```
 
-### 2.6.3.1 `:echo`
+#### 2.6.3.1 `:disabled`
+
+To disable menu choice, use the `:disabled` key with a value that explains the reason for the choice being unavailable. For example, out of all drinks, the sake and beer are currently out of stock:
+
+```ruby
+drinks = [
+  'bourbon',
+  {name: 'sake', disabled: '(out of stock)'},
+  'vodka',
+  {name: 'beer', disabled: '(out of stock)'},
+  'wine',
+  'whisky'
+]
+```
+
+The disabled choice will be displaed with a cross `✘` character next to it and followed by an explanation:
+
+```ruby
+prompt.multi_select('Choose your favourite drink?', drinks)
+# =>
+# Choose your favourite drink? (Use arrow keys, press Space to select and Enter to finish)
+# ‣ ⬡ bourbon
+#   ✘ sake (out of stock)
+#   ⬡ vodka
+#   ✘ beer (out of stock)
+#   ⬡ wine
+#   ⬡ whisky
+```
+
+#### 2.6.3.2 `:echo`
 
 To control whether the selected items are shown on the question
 header use the :echo option:
@@ -907,7 +937,7 @@ prompt.multi_select("Select drinks?", choices, echo: false)
 # ‣ ⬢ 5) bourbon
 ```
 
-### 2.6.3.2 `:filter`
+#### 2.6.3.3 `:filter`
 
 To activate dynamic list filtering on letter/number typing, use the :filter option:
 

data/examples/multi_select_disabled.rb

@@ -5,13 +5,13 @@ require_relative "../lib/tty-prompt"
 prompt = TTY::Prompt.new
 
 drinks = [
+  'bourbon',
   {name: 'sake', disabled: '(out of stock)'},
   'vodka',
   {name: 'beer', disabled: '(out of stock)'},
   'wine',
-  'whisky',
-  'bourbon'
+  'whisky'
 ]
-answer = prompt.multi_select('Choose your favourite drink?', drinks, default: 2)
+answer = prompt.multi_select('Choose your favourite drink?', drinks)
 
 puts answer.inspect

data/lib/tty/prompt.rb

@@ -76,7 +76,7 @@ module TTY
                    :show, :hide
 
     def_delegators :@reader, :read_char, :read_line, :read_keypress,
-                   :read_multiline, :on, :subscribe, :trigger,
+                   :read_multiline, :on, :subscribe, :unsubscribe, :trigger,
                    :count_screen_lines
 
     def_delegators :@output, :print, :puts, :flush

data/lib/tty/prompt/enum_list.rb

@@ -41,8 +41,6 @@ module TTY
         @page_help    = options[:page_help] || PAGE_HELP
         @paginator    = EnumPaginator.new
         @page_active  = @default
-
-        @prompt.subscribe(self)
       end
 
       # Set default option selected
@@ -122,7 +120,9 @@ module TTY
         @question = question
         block[self] if block
         setup_defaults
-        render
+        @prompt.subscribe(self) do
+          render
+        end
       end
 
       def keypress(event)

data/lib/tty/prompt/expander.rb

@@ -31,8 +31,6 @@ module TTY
         @status       = :collapsed
         @hint         = nil
         @default_key  = false
-
-        @prompt.subscribe(self)
       end
 
       def expanded?
@@ -133,7 +131,9 @@ module TTY
         block.call(self) if block
         setup_defaults
         choice(HELP_CHOICE)
-        render
+        @prompt.subscribe(self) do
+          render
+        end
       end
 
       private

data/lib/tty/prompt/list.rb

@@ -57,8 +57,6 @@ module TTY
         @per_page     = options[:per_page]
         @page_help    = options[:page_help] || PAGE_HELP
         @paginator    = Paginator.new
-
-        @prompt.subscribe(self)
       end
 
       # Set marker
@@ -183,7 +181,9 @@ module TTY
         @question = question
         block.call(self) if block
         setup_defaults
-        render
+        @prompt.subscribe(self) do
+          render
+        end
       end
 
       # Check if list is enumerated

data/lib/tty/prompt/mask_question.rb

@@ -18,7 +18,6 @@ module TTY
         @mask        = options.fetch(:mask) { Symbols.symbols[:dot] }
         @done_masked = false
         @failure     = false
-        @prompt.subscribe(self)
       end
 
       # Set character for masking the STDIN input

data/lib/tty/prompt/multiline.rb

@@ -17,8 +17,6 @@ module TTY
         @help         = options[:help] || self.class::HELP
         @first_render = true
         @lines_count  = 0
-
-        @prompt.subscribe(self)
       end
 
       # Provide help information

data/lib/tty/prompt/question.rb

@@ -99,7 +99,9 @@ module TTY
         return if Utils.blank?(message)
         @message = message
         block.call(self) if block
-        render
+        @prompt.subscribe(self) do
+          render
+        end
       end
 
       # Read answer and convert to type

data/lib/tty/prompt/slider.rb

@@ -40,8 +40,6 @@ module TTY
         @format       = options.fetch(:format) { FORMAT }
         @first_render = true
         @done         = false
-
-        @prompt.subscribe(self)
       end
 
       # Setup initial active position
@@ -100,7 +98,9 @@ module TTY
         @question = question
         block.call(self) if block
         @active = initial
-        render
+        @prompt.subscribe(self) do
+          render
+        end
       end
 
       def keyleft(*)

data/lib/tty/prompt/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   class Prompt
-    VERSION = '0.16.0'.freeze
+    VERSION = '0.16.1'.freeze
   end # Prompt
 end # TTY

data/tty-prompt.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'pastel',       '~> 0.7.0'
   spec.add_dependency 'timers',       '~> 4.0'
   spec.add_dependency 'tty-cursor',   '~> 0.5.0'
-  spec.add_dependency 'tty-reader',   '~> 0.2.0'
+  spec.add_dependency 'tty-reader',   '~> 0.3.0'
 
   spec.add_development_dependency 'bundler', '>= 1.5.0', '< 2.0'
   spec.add_development_dependency 'rake'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-prompt
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.16.1
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-11 00:00:00.000000000 Z
+date: 2018-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: necromancer
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement