tty-reader 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f1b83301002055869c17bb4ecb0571be89b2d8e0
-  data.tar.gz: 39bd25b1b47c2542c000a407a2839bd4cba12c31
+  metadata.gz: c03f74e7241085592fa20639a1e611fcc67236e0
+  data.tar.gz: 4e86e58a736ac624efcbb11bd4d4d09a7e80e7ed
 SHA512:
-  metadata.gz: 08c4198829dcc5a4f95c865c4dfcb2c4be9711885a3d071c6f1d9f917e8dc20083d558dde98ffc38af0d7e6ce6de9f4fbfeecb1158109f2905adb047aa6970f1
-  data.tar.gz: 3899ba4f5461099024379df0058deb177dbf1a45d6fb250970f3a639adf792f9563773adeae1b240f2feb41241d6ec45b4a012c15f4b1c234ad6bf582f7c0ac4
+  metadata.gz: ce215884478b45022b5e44a0f464906880dedcfb059f8f265ac6a016a41a622385ef2c899bb370c8f63d3417fac4ebcfb9ac284d819e7e97220c3ad0d52ee8bf
+  data.tar.gz: 7bf7f7e083acfefef98c5806f54c4e14398d286cb7e926f79a41ef7b4216f77d3d312074d1703a306bd4b280bccccc8e17ceb648d37e1419fada48aac10ab868

data/.travis.yml

@@ -11,6 +11,7 @@ rvm:
   - 2.2.9
   - 2.3.6
   - 2.4.3
+  - 2.5.0
   - ruby-head
   - jruby-9.1.1.0
   - jruby-head

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Change log
 
+## [v0.3.0] - 2018-04-29
+
+### Added
+* Add Reader#unsubscribe to allow stop listening to local key events
+
+### Changed
+* Change Reader#subscribe to allow to listening for key events only inside a block
+* Change to group xterm keys for navigation
+
 ## [v0.2.0] - 2018-01-01
 
 ### Added
@@ -24,5 +33,6 @@
 
 * Initial implementation and release
 
+[v0.3.0]: https://github.com/piotrmurach/tty-reader/compare/v0.2.0...v0.3.0
 [v0.2.0]: https://github.com/piotrmurach/tty-reader/compare/v0.1.0...v0.2.0
 [v0.1.0]: https://github.com/piotrmurach/tty-reader/compare/v0.1.0

data/README.md

@@ -60,8 +60,9 @@ Or install it yourself as:
   * [2.3 read_multiline](#23-read_multiline)
   * [2.4 on](#24-on)
   * [2.5 subscribe](#25-subscribe)
-  * [2.6 trigger](#26-trigger)
-  * [2.7 supported events](#27-supported-events)
+  * [2.6 unsubscribe](#26-unsubscribe)
+  * [2.7 trigger](#27-trigger)
+  * [2.8 supported events](#28-supported-events)
 * [3. Configuration](#3-configuration)
   * [3.1 :interrupt](#31-interrupt)
   * [3.2 :track_history](#32-track_history)
@@ -178,10 +179,10 @@ prompt.on(:keypress) { |key| ... }
 
 You can subscribe any object to listen for the emitted [key events](#27-supported-events) using the `subscribe` message. The listener would need to implement a method for every event it wishes to receive.
 
-For example, if a `Context` class wishes to only listen for `keypress` event:
+For example, if a `MyListener` class wishes to only listen for `keypress` event:
 
 ```ruby
-class Context
+class MyListener
   def keypress(event)
     ...
   end
@@ -191,11 +192,26 @@ end
 Then subcribing is done:
 
 ```ruby
-context = Context.new
-reader.subscribe(context)
+reader.subscribe(MyListener.new)
 ```
 
-### 2.6 trigger
+Alternatively, `subscribe` allows you to listen to events only for the dueration of block execution like so:
+
+```ruby
+reader.subscribe(MyListener) do
+  ...
+end
+```
+
+### 2.6 unsubscribe
+
+You can unsubscribe any object from listening to the key events using the `unsubscribe` message:
+
+```ruby
+reader.unsubscribe(my_listener)
+```
+
+### 2.7 trigger
 
 The signature for triggering key events is `trigger(event, args...)`. The first argument is a [key event name](#27-supported-events) followed by any number of actual values related to the event being triggered.
 
@@ -213,12 +229,12 @@ reader.on(:keypress) do |event|
     reader.trigger(:keydown)
   end
   if evevnt.value == 'k'
-    reader.trigger(:keup)
+    reader.trigger(:keyup)
   end
 end
 ```
 
-### 2.7 supported events
+### 2.8 supported events
 
 The available key events for character input are:
 

data/appveyor.yml

@@ -19,3 +19,5 @@ environment:
     - ruby_version: "23-x64"
     - ruby_version: "24"
     - ruby_version: "24-x64"
+    - ruby_version: "25"
+    - ruby_version: "25-x64"

data/lib/tty/reader.rb

@@ -91,6 +91,43 @@ module TTY
       subscribe(self)
     end
 
+    alias old_subcribe subscribe
+
+    # Subscribe to receive key events
+    #
+    # @example
+    #   reader.subscribe(MyListener.new)
+    #
+    # @return [self|yield]
+    #
+    # @api public
+    def subscribe(listener, options = {})
+      old_subcribe(listener, options)
+      object = self
+      if block_given?
+        object = yield
+        unsubscribe(listener)
+      end
+      object
+    end
+
+    # Unsubscribe from receiving key events
+    #
+    # @example
+    #   reader.unsubscribe(my_listener)
+    #
+    # @return [void]
+    #
+    # @api public
+    def unsubscribe(listener)
+      registry = send(:local_registrations)
+      registry.each do |object|
+        if object.listener.equal?(listener)
+          registry.delete(object)
+        end
+      end
+    end
+
     # Select appropriate console
     #
     # @api private

data/lib/tty/reader/keys.rb

@@ -69,15 +69,22 @@ module TTY
           "\e[D" => :left,
           "\e[E" => :clear,
           "\e[H" => :home,
-          "\eOH" => :home,
           "\e[F" => :end,
-          "\eOF" => :end,
           "\e[Z" => :back_tab, # shift + tab
 
-          "\eOP" => :f1,
-          "\eOQ" => :f2,
-          "\eOR" => :f3,
-          "\eOS" => :f4,
+          # xterm/gnome
+          "\eOA" => :up,
+          "\eOB" => :down,
+          "\eOC" => :right,
+          "\eOD" => :left,
+          "\eOE" => :clear,
+          "\eOF" => :end,
+          "\eOH" => :home,
+
+          "\eOP" => :f1, # xterm
+          "\eOQ" => :f2, # xterm
+          "\eOR" => :f3, # xterm
+          "\eOS" => :f4, # xterm
           "\e[[A" => :f1, # linux
           "\e[[B" => :f2, # linux
           "\e[[C" => :f3, # linux
@@ -115,11 +122,6 @@ module TTY
           "\e[21;2~" => :f22,
           "\e[23;2~" => :f23,
           "\e[24;2~" => :f24,
-
-          "\eOA" => :up,
-          "\eOB" => :down,
-          "\eOC" => :right,
-          "\eOD" => :left
         }
       end
       module_function :keys

data/lib/tty/reader/version.rb

@@ -2,6 +2,6 @@
 
 module TTY
   class Reader
-    VERSION = '0.2.0'.freeze
+    VERSION = '0.3.0'.freeze
   end # Reader
 end # TTY

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-reader
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-01 00:00:00.000000000 Z
+date: 2018-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: wisper