vedeu 0.6.65 → 0.6.66

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7de5e8ce3c945a022377f002d55b636db36d4c4
-  data.tar.gz: 304a938cd7a728def2501a2fbb9c56dc47087c69
+  metadata.gz: d3296c4a873190f0059f2603ddce098130fa4ac3
+  data.tar.gz: 00cdbf96d644568b7eb6d4cd783b82ab315289d3
 SHA512:
-  metadata.gz: 5319814ddc77d021cc4b9d6c0faeaf0dee1dfbad8fda6aed11999ed3e596ee304dd25c24155aff10968d5a48112ecfff371d8a7b58fd370fc2ee9195444570ba
-  data.tar.gz: 51b151afec06d804cbf24e0a7cf490b434e8d0130d5c993a74e80e93734c22ba00cec0908696fd1bb4d2ce36e6e943a487e7742bdc9b21788ad34476662243fa
+  metadata.gz: 9aed24c7e9953e07e443f4183302086010241f6c626934ecd178b8e0416ce82c2ace9c645eb2a670d66051104f3e7af6418ca37d072deac44c6f15540ec6392b
+  data.tar.gz: bc86d7cfad0485d4912fb7a4d04c9e485c34f44e064013a5976b32d6352fa8c751d007030776494e6668eb8e4bbe49f2779c05ac37fcd4876baf13bdd19fd44c

data/docs/api.md

@@ -146,10 +146,14 @@ See {file:docs/events.md}
 
 ### Vedeu.all_commands
 
+Returns an array of all commands received by Vedeu.
+
 @todo Add more documentation.
 
 ### Vedeu.all_keypresses
 
+Returns an array of all keypresses received by Vedeu.
+
 @todo Add more documentation.
 
 ### Vedeu.background_colours
@@ -383,10 +387,14 @@ Repository method. Access registered keymaps.
 
 ### Vedeu.last_command
 
+Returns the last command entered into Vedeu.
+
 @todo Add more documentation.
 
 ### Vedeu.last_keypress
 
+Returns the last keypress entered into Vedeu.
+
 @todo Add more documentation.
 
 ### Vedeu.log
@@ -419,7 +427,36 @@ Repository method. Access registered menus.
 
 ### Vedeu.read
 
-@todo Add more documentation.
+This allows the direct reading from the terminal, unencumbered by the
+framework.
+
+    Vedeu.read("some input here") # => programmatic cooked mode
+                                  #    (default)
+
+    Vedeu.read("\e[24;2~", mode: :raw) # => programmatic raw mode
+                                       #    (provides :shift_f12 in
+                                       #    this example)
+
+    Vedeu.read(nil, mode: :raw) # => for a single keypress
+
+    Vedeu.read(nil, mode: :cooked) # => (default mode) for a 'line at
+                                   #    a time' (pressing 'return'
+                                   #    ends the line)
+
+The way that these are used will depend on the mode your terminal is currently set to. Vedeu by default sets this to `:raw` (single character, hidden cursor). `Vedeu.read` by default expects the terminal to be in `:cooked` mode unless you provide the `mode: :raw` option.
+
+- In `:cooked` mode (default), it will trigger a `:_command_` event
+  with the input provided, meaning you should bind to :command to
+  receive the input.
+- In `:raw` mode, it will trigger a `:_keypress_` event with the input
+  provided, meaning you should bind to `:key` to receive the input.
+
+You can also access the input given using the API methods:
+
+    Vedeu.all_commands
+    Vedeu.all_keypresses
+    Vedeu.last_command
+    Vedeu.last_keypress
 
 ### Vedeu.ready!
 
@@ -513,4 +550,7 @@ Repository method. Access registered renderers.
 
 ### Vedeu.write
 
+This allows the direct writing to the terminal, unencumbered by the
+framework.
+
 @todo Add more documentation.

data/docs/dsl.md

@@ -78,6 +78,10 @@ end
 
 {include:Vedeu::Borders::DSL}
 
+### Creating a new named border
+
+{include:Vedeu::Borders::DSL#border}
+
 ### Setting a title for the border
 
 {include:Vedeu::Borders::DSL#title}
@@ -107,6 +111,10 @@ end
 
 {include:Vedeu::Geometries::DSL}
 
+### Creating a new named geometry
+
+{include:Vedeu::Geometries::DSL#geometry}
+
 ### Setting the interface dimensions
 
 {include:Vedeu::Geometries::DSL#align}
@@ -131,16 +139,23 @@ end
 
 {include:Vedeu::Groups::DSL}
 
-### Add interfaces to groups
+### Creating a new named group
 
 {include:Vedeu::Groups::DSL.group}
 
+### Add interfaces to groups
+
+{include:Vedeu::Groups::DSL#add}
+
 ## Keymaps
 
 {include:Vedeu::Input::DSL}
-{include:Vedeu::Input::DSL.keymap}
 {include:Vedeu::Input::DSL#name}
 
+### Creating a new named group
+
+{include:Vedeu::Input::DSL.keymap}
+
 ## Menus
 
 {include:Vedeu::Menus::DSL}
@@ -148,6 +163,10 @@ end
 {include:Vedeu::Menus::DSL#items}
 {include:Vedeu::Menus::DSL#name}
 
+### Creating a new named menu
+
+{include:Vedeu::Menus::DSL.menu}
+
 ## Views
 
 {include:Vedeu::DSL::View}

data/docs/input.md

@@ -124,3 +124,26 @@ Accessing the input can be achieved in the following ways:
         Vedeu.bind(:command) do
           # ... do something with the command
         end
+
+## Providing Input
+
+Input can be provided in a couple of ways, automatic and manually.
+
+### Automatically
+
+Dependent on the terminal mode as mentioned previously.
+
+- In `:raw` mode, a keypress (a single character e.g. `b`, or
+  modifier+character e.g. Shift+F12), can be bound via the keymaps
+  functionality.
+- In `:cooked` mode, a group of keypresses, terminated with the
+  `return` key will trigger the `:command` event which you can bind to
+  and perform actions dependent on the input provided.
+- In `:fake` mode, Vedeu emulates the terminal allowing you all the
+  benefits of `:cooked` mode but with Vedeu's in-built editor. The
+  input can be accessed using the API calls as mentioned in
+  {file:docs/input.md#accessing_input}.
+
+### Manually (semi-automatic)
+
+See {file:docs/api.md#vedeuread}

data/lib/vedeu/input/all.rb

@@ -9,6 +9,7 @@ module Vedeu
 
 end # Vedeu
 
+require 'vedeu/input/raw'
 require 'vedeu/input/capture'
 require 'vedeu/input/dsl'
 require 'vedeu/input/key'

data/lib/vedeu/input/capture.rb

@@ -91,13 +91,7 @@ module Vedeu
       #
       # @return [String]
       def input
-        keys = console.getch
-
-        if keys.ord == Vedeu::ESCAPE_KEY_CODE
-          keys << console.read_nonblock(4) rescue nil
-          keys << console.read_nonblock(3) rescue nil
-          keys << console.read_nonblock(2) rescue nil
-        end
+        keys = Vedeu::Input::Raw.read
 
         return Vedeu::Input::Mouse.click(keys) if click?(keys)
 

data/lib/vedeu/input/raw.rb

@@ -0,0 +1,41 @@
+module Vedeu
+
+  module Input
+
+    class Raw
+
+      # @see Vedeu::Input::Raw#initialize
+      def self.read
+        new.read
+      end
+
+      # Returns a new instance of Vedeu::Input::Raw.
+      #
+      # @return [Vedeu::Input::Raw]
+      def initialize; end
+
+      # @return [String]
+      def read
+        keys = console.getch
+
+        if keys.ord == Vedeu::ESCAPE_KEY_CODE
+          keys << console.read_nonblock(4) rescue nil
+          keys << console.read_nonblock(3) rescue nil
+          keys << console.read_nonblock(2) rescue nil
+        end
+
+        keys
+      end
+
+      private
+
+      # @return [IO]
+      def console
+        @console ||= Vedeu::Terminal.console
+      end
+
+    end # Raw
+
+  end # Input
+
+end # Vedeu

data/lib/vedeu/input/read.rb

@@ -77,13 +77,7 @@ module Vedeu
                       console.gets.chomp
 
                     else
-                      keys = console.getch
-
-                      if keys.ord == Vedeu::ESCAPE_KEY_CODE
-                        keys << console.read_nonblock(4) rescue nil
-                        keys << console.read_nonblock(3) rescue nil
-                        keys << console.read_nonblock(2) rescue nil
-                      end
+                      keys = Vedeu::Input::Raw.read
 
                       Vedeu::Input::Translator.translate(keys)
 

data/lib/vedeu/interfaces/clear.rb

@@ -137,11 +137,11 @@ module Vedeu
         Vedeu.timer("Optimised clearing #{clearing}: '#{name}'".freeze) do
           height.times.map do |iy|
             [
-              Vedeu::Geometries::Position.new(y + iy, x).to_s,
+              position(y + iy, x),
               colour.to_s,
               chars,
             ].join
-          end.join + Vedeu::Geometries::Position.new(y, x).to_s
+          end.join + position(y, x)
         end
       end
 
@@ -175,6 +175,11 @@ module Vedeu
                       end
       end
 
+      # @return [Vedeu::Geometries::Position]
+      def position(pos_y, pos_x)
+        Vedeu::Geometries::Position.new(pos_y, pos_x).to_s
+      end
+
       # @return [Fixnum]
       def width
         @width ||= if content_only?

data/lib/vedeu/output/renderers/all.rb

@@ -18,14 +18,9 @@ module Vedeu
     # @return [Array<void>]
     def clear
       storage.map do |renderer|
-        Vedeu.log(type:    :render,
-                  message: "Clearing via #{renderer.class.name}".freeze)
+        log('Clearing', renderer)
 
-        Thread.new(renderer) do
-          mutex.synchronize do
-            toggle_cursor { renderer.clear }
-          end
-        end
+        threaded(renderer) { renderer.clear }
       end.each(&:join) if Vedeu.ready?
 
       ''
@@ -51,14 +46,9 @@ module Vedeu
     # @return [Array<void>]
     def render(output)
       storage.map do |renderer|
-        Vedeu.log(type:    :render,
-                  message: "Rendering via #{renderer.class.name}".freeze)
+        log('Rendering', renderer)
 
-        Thread.new(renderer) do
-          mutex.synchronize do
-            toggle_cursor { renderer.render(output) }
-          end
-        end
+        threaded(renderer) { renderer.render(output) }
       end.each(&:join) if Vedeu.ready?
 
       output
@@ -96,6 +86,14 @@ module Vedeu
       Set.new
     end
 
+    # @param message [String]
+    # @param renderer [Class]
+    # @return [void]
+    def log(message, renderer)
+      Vedeu.log(type:    :render,
+                message: "#{message} via #{renderer.class.name}".freeze)
+    end
+
     # @return [Mutex]
     def mutex
       @mutex ||= Mutex.new
@@ -106,6 +104,17 @@ module Vedeu
       @storage ||= in_memory
     end
 
+    # @return [void]
+    def threaded(renderer)
+      Thread.new(renderer) do
+        mutex.synchronize do
+          toggle_cursor do
+            yield
+          end
+        end
+      end
+    end
+
     # @return [void]
     def toggle_cursor
       Vedeu.trigger(:_hide_cursor_)

data/lib/vedeu/version.rb

@@ -1,6 +1,6 @@
 module Vedeu
 
   # The current version of Vedeu.
-  VERSION = '0.6.65'.freeze
+  VERSION = '0.6.66'.freeze
 
 end

data/test/lib/vedeu/input/capture_test.rb

@@ -48,8 +48,9 @@ module Vedeu
           let(:registered)   { false }
 
           before do
-            Vedeu::Terminal.console.stubs(:getch).returns(keypress)
-            Vedeu::Input::Mapper.stubs(:registered?).with(translated, _name).returns(registered)
+            Vedeu::Input::Raw.stubs(:read).returns(keypress)
+            Vedeu::Input::Mapper.stubs(:registered?).with(translated, _name)
+              .returns(registered)
             Vedeu.interfaces.stubs(:by_name).returns(interface)
           end
 
@@ -157,9 +158,7 @@ module Vedeu
         context 'when the terminal mode is :raw' do
           let(:is_raw_mode) { true }
 
-          before do
-            Vedeu::Terminal.console.stubs(:getch).returns(keypress)
-          end
+          before { Vedeu::Input::Raw.stubs(:read).returns(keypress) }
 
           context 'when the keypress is an escape sequence' do
             context 'when the key is :shift_f5 (read_nonblock(7))' do

data/test/lib/vedeu/input/raw_test.rb

@@ -0,0 +1,36 @@
+require 'test_helper'
+
+module Vedeu
+
+  module Input
+
+    describe Raw do
+
+      let(:described) { Vedeu::Input::Raw }
+      let(:instance)  { described.new }
+
+      describe '#initialize' do
+        it { instance.must_be_instance_of(described) }
+      end
+
+      describe '.read' do
+        let(:keypress) { 'a' }
+
+        before do
+          Vedeu::Terminal.console.stubs(:getch).returns(keypress)
+        end
+
+        subject { described.read }
+
+        it { subject.must_equal(keypress) }
+      end
+
+      describe '#read' do
+        it { instance.must_respond_to(:read) }
+      end
+
+    end # Raw
+
+  end # Input
+
+end # Vedeu

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vedeu
 version: !ruby/object:Gem::Version
-  version: 0.6.65
+  version: 0.6.66
 platform: ruby
 authors:
 - Gavin Laking
@@ -440,6 +440,7 @@ files:
 - lib/vedeu/input/keymap.rb
 - lib/vedeu/input/mapper.rb
 - lib/vedeu/input/mouse.rb
+- lib/vedeu/input/raw.rb
 - lib/vedeu/input/read.rb
 - lib/vedeu/input/repository.rb
 - lib/vedeu/input/store.rb
@@ -625,6 +626,7 @@ files:
 - test/lib/vedeu/input/keymap_test.rb
 - test/lib/vedeu/input/mapper_test.rb
 - test/lib/vedeu/input/mouse_test.rb
+- test/lib/vedeu/input/raw_test.rb
 - test/lib/vedeu/input/read_test.rb
 - test/lib/vedeu/input/repository_test.rb
 - test/lib/vedeu/input/store_test.rb
@@ -839,6 +841,7 @@ test_files:
 - test/lib/vedeu/input/keymap_test.rb
 - test/lib/vedeu/input/mapper_test.rb
 - test/lib/vedeu/input/mouse_test.rb
+- test/lib/vedeu/input/raw_test.rb
 - test/lib/vedeu/input/read_test.rb
 - test/lib/vedeu/input/repository_test.rb
 - test/lib/vedeu/input/store_test.rb