vedeu 0.6.39 → 0.6.40

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba1c61c6e18c58f67aa29538d0f7c7765199fad5
-  data.tar.gz: 82dc0fd7e7f3c65bff2fa207d6103cf8784ada1f
+  metadata.gz: 143043509ebfddd83c874d02592cc32490dcd663
+  data.tar.gz: 05f8618fb7ab1f6a88ac7221794967bd58307022
 SHA512:
-  metadata.gz: b53f28b9940e7f4cb175adec72115203635cceaab007d13f134fca09d39b426fd06fe95ee2526c8a4f6bac591672b40f4217c1fcedfc409e5506c7aad67ff52b
-  data.tar.gz: e05e316be1c418cde5c71c4b2d1bfe5b58ac5a119ceeb5bad4b2227c0e83857c9a4586b1fb1b5e6fde1c440f82c081707bfa798b317eef3808e44e5c3e10c9e1
+  metadata.gz: 95e3e2d995ff6aa700a07e17dd8f462ad412b8df1d17c6a74f0a773e1ca0ef6dabe4100e526bf9c9e9860d3cc440968717c1667c0ded6fe3939857bcdd1d5860
+  data.tar.gz: 45022ead54702e4ce916c0e057cd78d2987c507cd41223a11f2988a254faf200a851739f96b77e4deb81c01b0a5023b30e77afadd6ba7dc259abd9c5c4f98875

data/docs/events/system.md

@@ -11,11 +11,25 @@ popular here.
     Vedeu.trigger(:_exit_)
 
 ### `:\_command\_`
+This event is used by Vedeu internally, though you can bind to it if
+you wish. It is preferred for you to bind to `:command` though.
+
 Will cause the triggering of the `:command` event; which you should
 define to 'do things'.
 
     Vedeu.trigger(:_command_, command)
 
+    Vedeu.bind(:command) do
+      # ... your code here ...
+    end
+
+Alternatively, you can access commands entered using the following
+API methods: (See {Vedeu::Input::Store} for more details).
+
+    Vedeu.all_commands
+
+    Vedeu.last_command
+
 ### `:\_editor\_`
 This event is called by {Vedeu::Input::Capture#read}. When
 invoked, the key will be passed to the editor for currently
@@ -41,6 +55,9 @@ action(s), like render the first screen, interface or make a sound.
     Vedeu.trigger(:_initialize_)
 
 ### `:\_keypress\_`
+This event is used by Vedeu internally, though you can bind to it if
+you wish. It is preferred for you to bind to `:key` though.
+
 When the name is given:
 
 - The given key is passed to the named keymap. If the keymap is
@@ -62,6 +79,17 @@ It is also to be noted, that a `:key` event will be triggered
 irrespective of the conditions above, you can bind to this event
 separately to 'do things'.
 
+    Vedeu.bind(:key) do
+      # ... your code here ...
+    end
+
+Alternatively, you can access keypresses entered using the following
+API methods: (See {Vedeu::Input::Store} for more details).
+
+    Vedeu.all_keypresses
+
+    Vedeu.last_keypress
+
 A list of supported keypresses can be found here:
 {Vedeu::Input::Capture}.
 

data/examples/dsl_editor.rb

@@ -8,6 +8,7 @@ class EditorApp
   Vedeu.bind(:_initialize_) { Vedeu.trigger(:_refresh_) }
 
   Vedeu.configure do
+    debug!
     log '/tmp/editor.log'
     renderers Vedeu::Renderers::File.new(filename: '/tmp/editor.out')
     fake!
@@ -35,15 +36,22 @@ class EditorApp
   # When pressing Return/Enter in the editor view, the :_command_
   # event will be triggered with any typed content you have provided.
   #
-  # Bind to this event to retrieve the content entered, and then
-  # process yourself in whatever way appropriate.
+  # The :_command_ event in turn triggers the :command event. Bind to
+  # :command to retrieve the content entered, and then process
+  # yourself in whatever way appropriate.
   #
-  #     Vedeu.bind(:_command_) do |data|
+  #     Vedeu.bind(:command) do |data|
   #        # ... do something with 'data'
   #     end
   #
   Vedeu.keymap :editor_view do
     key(:enter) { Vedeu.trigger(:_editor_execute_, :editor_view) }
+    key(:insert) do
+      Vedeu.log(type:    :debug,
+                message: "Commands: #{Vedeu.all_commands.inspect}")
+      Vedeu.log(type:    :debug,
+                message: "Keypresses: #{Vedeu.all_keypresses.inspect}")
+    end
   end
 
   Vedeu.keymap '_global_' do
@@ -60,7 +68,7 @@ class EditorApp
       lines do
         line 'Type into the editor dialog above,'
         line 'and press Return. This will trigger the'
-        line ':_command_ event with the contents of '
+        line ':command event with the contents of '
         line 'the view.'
 
         # @todo Not implemented yet:

data/lib/vedeu/input/mapper.rb

@@ -155,7 +155,11 @@ module Vedeu
   # :nocov:
 
   # See {file:docs/events/system.md#\_keypress_}
-  Vedeu.bind(:_keypress_) { |key, name| Vedeu.keypress(key, name) }
+  Vedeu.bind(:_keypress_) do |key, name|
+    Vedeu.add_keypress(key)
+
+    Vedeu.keypress(key, name)
+  end
 
   # See {file:docs/events/drb.md#\_drb_input_}
   Vedeu.bind(:_drb_input_) do |data, type|
@@ -169,7 +173,11 @@ module Vedeu
   end
 
   # See {file:docs/events/system.md#\_command_}
-  Vedeu.bind(:_command_) { |command| Vedeu.trigger(:command, command) }
+  Vedeu.bind(:_command_) do |command|
+    Vedeu.add_command(command)
+
+    Vedeu.trigger(:command, command)
+  end
 
   # :nocov:
 

data/lib/vedeu/input/store.rb

@@ -4,46 +4,89 @@ module Vedeu
 
     # Stores each keypress or command to be retrieved later.
     #
-    class Store
-
-      def initialize
-      end
-
+    module Store
+
+      extend self
+
+      # Add a command (a collection of characters/keypresses from an
+      # Editor::Document) to the store. Used by Vedeu internally to
+      # store commands entered.
+      #
+      # @example
+      #   Vedeu.add_command(:some_command)
+      #
+      # @param command [Symbol|String]
       # @return [Hash<Symbol => Array<Symbol|String>>]
       def add_command(command)
         all_commands << command
       end
 
+      # Add a keypress to the store. Used by Vedeu internally to
+      # store a keypress entered.
+      #
+      # @example
+      #   Vedeu.add_keypress(:escape)
+      #
+      # @param keypress [Symbol|String]
       # @return [Hash<Symbol => Array<Symbol|String>>]
       def add_keypress(keypress)
         all_keypresses << keypress
       end
 
+      # Access all commands and keypresses stored.
+      #
       # @return [Hash<Symbol => Array<Symbol|String>>]
       def all
         storage
       end
 
+      # Access all commands stored.
+      #
+      # @example
+      #   Vedeu.all_commands
+      #
       # @return [Array<Symbol|String>]
       def all_commands
         storage[:commands]
       end
 
+      # Access all keypresses stored.
+      #
+      # @example
+      #   Vedeu.all_keypresses
+      #
       # @return [Array<Symbol|String>]
       def all_keypresses
         storage[:keypresses]
       end
 
+      # Access the last command stored. If no commands have been
+      # entered since the client application started, then this will
+      # return nil.
+      #
+      # @example
+      #   Vedeu.last_command
+      #
       # @return [NilClass|Symbol|String]
       def last_command
         all_commands[-1]
       end
 
+      # Access the last keypress stored. If no keys have been pressed
+      # since the client application started, then this will return
+      # nil.
+      #
+      # @example
+      #   Vedeu.last_keypress
+      #
       # @return [NilClass|Symbol|String]
       def last_keypress
         all_keypresses[-1]
       end
 
+      # Remove all stored entries. Any commands or keypresses entered
+      # before calling this method will be removed.
+      #
       # @return [Hash<Symbol => Array<Symbol|String>>]
       def reset
         @storage = in_memory
@@ -68,4 +111,24 @@ module Vedeu
 
   end # Input
 
+  # @!method add_command
+  #   @see Vedeu::Input::Store.add_command
+  # @!method add_keypress
+  #   @see Vedeu::Input::Store.add_keypress
+  # @!method all_commands
+  #   @see Vedeu::Input::Store.all_commands
+  # @!method all_keypresses
+  #   @see Vedeu::Input::Store.all_keypresses
+  # @!method last_command
+  #   @see Vedeu::Input::Store.last_command
+  # @!method last_keypress
+  #   @see Vedeu::Input::Store.last_keypress
+  def_delegators Vedeu::Input::Store,
+                 :add_command,
+                 :add_keypress,
+                 :all_commands,
+                 :all_keypresses,
+                 :last_command,
+                 :last_keypress
+
 end # Vedeu

data/lib/vedeu/version.rb

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

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

@@ -7,14 +7,13 @@ module Vedeu
     describe Store do
 
       let(:described) { Vedeu::Input::Store }
-      let(:instance)  { described.new }
 
-      before { instance.reset }
+      before { described.reset }
 
       describe '#add_command' do
         let(:command) { 'command_1' }
 
-        subject { instance.add_command(command) }
+        subject { described.add_command(command) }
 
         it { subject.must_equal(['command_1']) }
       end
@@ -22,13 +21,13 @@ module Vedeu
       describe '#add_keypress' do
         let(:keypress) { 'a' }
 
-        subject { instance.add_keypress(keypress) }
+        subject { described.add_keypress(keypress) }
 
         it { subject.must_equal(['a']) }
       end
 
       describe '#all' do
-        subject { instance.all }
+        subject { described.all }
 
         context 'when empty' do
           it { subject.must_equal({ commands: [], keypresses: [] }) }
@@ -43,10 +42,10 @@ module Vedeu
           }
 
           before do
-            instance.add_command('command_1')
-            instance.add_command('command_2')
-            instance.add_keypress('a')
-            instance.add_keypress('b')
+            described.add_command('command_1')
+            described.add_command('command_2')
+            described.add_keypress('a')
+            described.add_keypress('b')
           end
 
           it { subject.must_equal(expected) }
@@ -54,7 +53,7 @@ module Vedeu
       end
 
       describe '#all_commands' do
-        subject { instance.all_commands }
+        subject { described.all_commands }
 
         context 'when there are no stored commands' do
           it { subject.must_equal([]) }
@@ -62,9 +61,9 @@ module Vedeu
 
         context 'when there are stored commands' do
           before do
-            instance.add_command('command_1')
-            instance.add_command('command_2')
-            instance.add_command('command_3')
+            described.add_command('command_1')
+            described.add_command('command_2')
+            described.add_command('command_3')
           end
 
           it { subject.must_equal(['command_1', 'command_2', 'command_3']) }
@@ -72,7 +71,7 @@ module Vedeu
       end
 
       describe '#all_keypresses' do
-        subject { instance.all_keypresses }
+        subject { described.all_keypresses }
 
         context 'when there are no stored keypresses' do
           it { subject.must_equal([]) }
@@ -80,9 +79,9 @@ module Vedeu
 
         context 'when there are stored keypresses' do
           before do
-            instance.add_keypress('a')
-            instance.add_keypress('b')
-            instance.add_keypress('c')
+            described.add_keypress('a')
+            described.add_keypress('b')
+            described.add_keypress('c')
           end
 
           it { subject.must_equal(['a', 'b', 'c']) }
@@ -90,7 +89,7 @@ module Vedeu
       end
 
       describe '#last_command' do
-        subject { instance.last_command }
+        subject { described.last_command }
 
         context 'when there are no stored commands' do
           it { subject.must_equal(nil) }
@@ -98,9 +97,9 @@ module Vedeu
 
         context 'when there are stored commands' do
           before do
-            instance.add_command('command_1')
-            instance.add_command('command_2')
-            instance.add_command('command_3')
+            described.add_command('command_1')
+            described.add_command('command_2')
+            described.add_command('command_3')
           end
 
           it { subject.must_equal('command_3') }
@@ -108,7 +107,7 @@ module Vedeu
       end
 
       describe '#last_keypress' do
-        subject { instance.last_keypress }
+        subject { described.last_keypress }
 
         context 'when there are no stored keypresses' do
           it { subject.must_equal(nil) }
@@ -116,9 +115,9 @@ module Vedeu
 
         context 'when there are stored keypresses' do
           before do
-            instance.add_keypress('a')
-            instance.add_keypress('b')
-            instance.add_keypress('c')
+            described.add_keypress('a')
+            described.add_keypress('b')
+            described.add_keypress('c')
           end
 
           it { subject.must_equal('c') }
@@ -126,7 +125,7 @@ module Vedeu
       end
 
       describe '#reset' do
-        subject { instance.reset }
+        subject { described.reset }
 
         it { subject.must_equal({ commands: [], keypresses: [] }) }
       end

data/test/lib/vedeu_test.rb

@@ -2,6 +2,10 @@ require 'test_helper'
 
 describe Vedeu do
 
+  it { Vedeu.must_respond_to(:add_command) }
+  it { Vedeu.must_respond_to(:add_keypress) }
+  it { Vedeu.must_respond_to(:all_commands) }
+  it { Vedeu.must_respond_to(:all_keypresses) }
   it { Vedeu.must_respond_to(:background_colours) }
   it { Vedeu.must_respond_to(:bind) }
   it { Vedeu.must_respond_to(:bind_alias) }
@@ -51,6 +55,8 @@ describe Vedeu do
   it { Vedeu.must_respond_to(:keymap) }
   it { Vedeu.must_respond_to(:keymaps) }
   it { Vedeu.must_respond_to(:keypress) }
+  it { Vedeu.must_respond_to(:last_command) }
+  it { Vedeu.must_respond_to(:last_keypress) }
   it { Vedeu.must_respond_to(:log) }
   it { Vedeu.must_respond_to(:log_stderr) }
   it { Vedeu.must_respond_to(:log_stdout) }

data/test/support/examples/material_colours_app.rb

@@ -110,6 +110,13 @@ class VedeuMaterialColoursApp
     key(:home)  { Vedeu.trigger(:_cursor_top_) }
     key(:end)   { Vedeu.trigger(:_cursor_bottom_) }
 
+    key(:insert) do
+      Vedeu.log(type:    :debug,
+                message: "Commands: #{Vedeu.all_commands.inspect}")
+      Vedeu.log(type:    :debug,
+                message: "Keypresses: #{Vedeu.all_keypresses.inspect}")
+    end
+
     key('q')        { Vedeu.trigger(:_exit_) }
     key(:escape)    { Vedeu.trigger(:_mode_switch_) }
     key(:shift_tab) { Vedeu.trigger(:_focus_prev_) }

data/vedeu.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'guard',              '2.13.0'
   spec.add_development_dependency 'guard-minitest',     '2.4.4'
   spec.add_development_dependency 'guard-rubocop',      '1.2.0'
-  spec.add_development_dependency 'minitest',           '5.8.1'
+  spec.add_development_dependency 'minitest',           '5.8.2'
   spec.add_development_dependency 'minitest-reporters', '1.1.4'
   spec.add_development_dependency 'mocha',              '1.1.0'
   spec.add_development_dependency 'pry',                '0.10.3'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vedeu
 version: !ruby/object:Gem::Version
-  version: 0.6.39
+  version: 0.6.40
 platform: ruby
 authors:
 - Gavin Laking
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.8.1
+        version: 5.8.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.8.1
+        version: 5.8.2
 - !ruby/object:Gem::Dependency
   name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement