vedeu 0.4.33 → 0.4.34

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b62c5ba6eef01e883bf71b71a52223214dcffa48
-  data.tar.gz: 6217942929014ce27de055b78a2e533a56bb638d
+  metadata.gz: 627cd72e48091fbe2959ffc08efac5353a7af4cb
+  data.tar.gz: f027bb4b0648c2dce85949bdb8b381ba7eb09408
 SHA512:
-  metadata.gz: 8b40fb9d5ee9ffc2660ebd062a12f2eb64903330b5f80f50daf4133c9adec364caa31cb31140981ac9a0de585d065d472208e33cb85363c235ef2720ac4101b2
-  data.tar.gz: e6cdfbc8f776b1ad7f5f611dadf8cc7bce21f8ec0375650f7995dc9e1070922e755e7e6143230f6bb1a2ca426c23595ba4046513ccc4ac710d22331eb9e736ef
+  metadata.gz: 05fdee8984b672ea21e8fd03b29139dfcaa237ec93db32c2d7d4afa63ba421656caff81caa6cf580682cb66184e8fbbc67b331c96c9c2a16a67bb4d725b853d0
+  data.tar.gz: 50e6af9ada7c570262c426c493a330ab39897d4218e635bd151540d5c3a719a1eb0233d2280aef038ebd2b2aaa396030968ba068e9e51c5bcec8828bc6dcd4a0

data/lib/vedeu/bindings.rb

@@ -13,6 +13,8 @@ module Vedeu
   # @api public
   module Bindings
 
+    # Triggering this event will send input to the running application as long
+    # as it has the DRb server running.
     Vedeu.bind(:_drb_input_) do |data, type|
       Vedeu.log(type: :drb, message: "Sending input (#{type})")
 
@@ -24,13 +26,22 @@ module Vedeu
 
     Vedeu.bind(:_drb_retrieve_output_) { Vedeu::VirtualBuffer.retrieve }
 
+    # Triggering this event with 'data' will push data into the running
+    # application's virtual buffer.
     Vedeu.bind(:_drb_store_output_) do |data|
       Vedeu::VirtualBuffer.store(Vedeu::Terminal.virtual.output(data))
     end
 
+    # Use the DRb server to request the client application to restart.
     Vedeu.bind(:_drb_restart_) { Vedeu::Distributed::Server.restart }
+
+    # Use the DRb server to request the client application to start.
     Vedeu.bind(:_drb_start_)   { Vedeu::Distributed::Server.start }
+
+    # Use the DRb server to request the status of the client application.
     Vedeu.bind(:_drb_status_)  { Vedeu::Distributed::Server.status }
+
+    # Use the DRb server to request the client application to stop.
     Vedeu.bind(:_drb_stop_)    { Vedeu::Distributed::Server.stop }
 
     # Vedeu triggers this event when `:_exit_` is triggered. You can hook into

data/lib/vedeu/configuration/configuration.rb

@@ -39,6 +39,9 @@ module Vedeu
       # are provided at application invocation, override any options with the
       # arguments provided.
       #
+      # @example
+      #   Vedeu.configure
+      #
       # @param args [Array]
       # @param opts [Hash]
       # @option opts stdin [File|IO]
@@ -53,6 +56,9 @@ module Vedeu
 
       # Returns the configuration singleton.
       #
+      # @example
+      #   Vedeu.configuration
+      #
       # @return [Vedeu::Configuration]
       def configuration
         instance

data/lib/vedeu/dsl/geometry.rb

@@ -8,6 +8,11 @@ module Vedeu
     # top-left, y = 1, x = 1. The 'y' coordinate is deliberately first.
     #
     # @example
+    #
+    #   Vedeu.geometry 'some_interface' do
+    #     # ...
+    #
+    #
     #   This crude ASCII diagram represents a Geometry within Vedeu, each of the
     #   labels is a value you can access or define.
     #

data/lib/vedeu/events/event.rb

@@ -90,6 +90,9 @@ module Vedeu
 
       # Unbind events from a named handler.
       #
+      # @example
+      #   Vedeu.unbind('some_event')
+      #
       # @param name [String]
       # @return [Boolean]
       def unbind(name)
@@ -101,7 +104,6 @@ module Vedeu
 
         true
       end
-      alias_method :unevent, :unbind
 
       extend Forwardable
 

data/lib/vedeu/input/mapper.rb

@@ -9,6 +9,9 @@ module Vedeu
     # the associated action is fired, if not, we move to the next keymap or
     # return false.
     #
+    # @example
+    #   Vedeu.keypress(key_name, keymap_name)
+    #
     # @param (see #initialize)
     # @return [Boolean]
     def self.keypress(key = nil, name = nil)

data/lib/vedeu/models/focus.rb

@@ -38,6 +38,9 @@ module Vedeu
     # Focus an interface by name. Used after defining an interface or interfaces
     # to set the initially focussed interface.
     #
+    # @example
+    #   Vedeu.focus_by_name('name')
+    #
     # @param name [String] The interface to focus; must be defined.
     # @raise [ModelNotFound] When the interface cannot be found.
     # @return [String] The name of the interface now in focus.
@@ -53,6 +56,9 @@ module Vedeu
 
     # Return the interface currently focussed.
     #
+    # @example
+    #   Vedeu.focus
+    #
     # @return [String]
     def current
       storage.first
@@ -61,6 +67,9 @@ module Vedeu
 
     # Returns a boolean indicating whether the named interface is focussed.
     #
+    # @example
+    #   Vedeu.focussed?(name)
+    #
     # @param name [String]
     # @return [Boolean]
     def current?(name)
@@ -77,6 +86,9 @@ module Vedeu
 
     # Put the next interface relative to the current interfaces in focus.
     #
+    # @example
+    #   Vedeu.focus_next
+    #
     # @return [String]
     def next_item
       storage.rotate!
@@ -88,6 +100,9 @@ module Vedeu
 
     # Put the previous interface relative to the current interface in focus.
     #
+    # @example
+    #   Vedeu.focus_previous
+    #
     # @return [String]
     def prev_item
       storage.rotate!(-1)

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

@@ -18,12 +18,18 @@ module Vedeu
 
     # Provides access to the list of renderers.
     #
+    # @example
+    #   Vedeu.renderers
+    #
     # @api public
     # @return [Module]
     def renderers
       self
     end
 
+    # @example
+    #   Vedeu.renderers.render(*args)
+    #
     # @return [Array<void>]
     def render(*args)
       threads = storage.map do |renderer|
@@ -53,6 +59,9 @@ module Vedeu
       storage
     end
 
+    # @example
+    #   Vedeu.renderers.reset
+    #
     # @return [Set]
     def reset
       @storage = Set.new

data/lib/vedeu/repositories/repositories/background_colours.rb

@@ -5,6 +5,9 @@ module Vedeu
   # @api public
   class BackgroundColours < Colours
 
+    # @example
+    #   Vedeu.background_colours
+    #
     # @return [Vedeu::BackgroundColours]
     def self.background_colours
       @background_colours ||= new

data/lib/vedeu/repositories/repositories/borders.rb

@@ -8,11 +8,17 @@ module Vedeu
 
     class << self
 
+      # @example
+      #   Vedeu.borders
+      #
       # @return [Vedeu::Borders]
       alias_method :borders, :repository
 
       # Remove all stored models from the repository.
       #
+      # @example
+      #   Vedeu.borders.reset
+      #
       # @return [Vedeu::Borders]
       def reset!
         @borders = register(Vedeu::Border)

data/lib/vedeu/repositories/repositories/buffers.rb

@@ -7,11 +7,17 @@ module Vedeu
 
     class << self
 
+      # @example
+      #   Vedeu.buffers
+      #
       # @return [Vedeu::Buffers]
       alias_method :buffers, :repository
 
       # Remove all stored models from the repository.
       #
+      # @example
+      #   Vedeu.buffers.reset
+      #
       # @return [Vedeu::Buffers]
       def reset!
         @buffers = register(Vedeu::Buffer)

data/lib/vedeu/repositories/repositories/cursors.rb

@@ -7,9 +7,15 @@ module Vedeu
 
     class << self
 
+      # @example
+      #   Vedeu.cursors
+      #
       # @return [Vedeu::Cursors]
       alias_method :cursors, :repository
 
+      # @example
+      #   Vedeu.cursor
+      #
       # @return [Vedeu::Cursor]
       def cursor
         cursors.by_name(Vedeu.focus) if Vedeu.focus
@@ -17,6 +23,9 @@ module Vedeu
 
       # Remove all stored models from the repository.
       #
+      # @example
+      #   Vedeu.cursors.reset
+      #
       # @return [Vedeu::Cursors]
       def reset!
         @cursors = register(Vedeu::Cursor)
@@ -24,6 +33,9 @@ module Vedeu
 
     end
 
+    # @example
+    #   Vedeu.cursors.by_name('some_name')
+    #
     # @param name [String] The name of the stored cursor.
     # @return [Vedeu::Cursor]
     def by_name(name)

data/lib/vedeu/repositories/repositories/events_repository.rb

@@ -7,11 +7,17 @@ module Vedeu
 
     class << self
 
+      # @example
+      #   Vedeu.events
+      #
       # @return [Vedeu::EventsRepository]
       alias_method :events, :repository
 
       # Remove all stored models from the repository.
       #
+      # @example
+      #   Vedeu.events.reset
+      #
       # @return [Vedeu::EventsRepository]
       def reset!
         @events = new(Vedeu::Events)

data/lib/vedeu/repositories/repositories/foreground_colours.rb

@@ -5,6 +5,9 @@ module Vedeu
   # @api public
   class ForegroundColours < Colours
 
+    # @example
+    #   Vedeu.foreground_colours
+    #
     # @return [Vedeu::ForegroundColours]
     def self.foreground_colours
       @foreground_colours ||= new

data/lib/vedeu/repositories/repositories/geometries.rb

@@ -8,11 +8,17 @@ module Vedeu
 
     class << self
 
+      # @example
+      #   Vedeu.geometries
+      #
       # @return [Vedeu::Geometries]
       alias_method :geometries, :repository
 
       # Remove all stored models from the repository.
       #
+      # @example
+      #   Vedeu.geometries.reset!
+      #
       # @return [Vedeu::Geometries]
       def reset!
         @geometries = register(Vedeu::Geometry)

data/lib/vedeu/repositories/repositories/groups.rb

@@ -7,11 +7,17 @@ module Vedeu
 
     class << self
 
+      # @example
+      #   Vedeu.groups
+      #
       # @return [Vedeu::Groups]
       alias_method :groups, :repository
 
       # Remove all stored models from the repository.
       #
+      # @example
+      #   Vedeu.groups.reset!
+      #
       # @return [Vedeu::Groups]
       def reset!
         @groups = register(Vedeu::Group)
@@ -19,6 +25,9 @@ module Vedeu
 
     end
 
+    # @example
+    #   Vedeu.groups.by_name('name')
+    #
     # @param name [String] The name of the stored group.
     # @return [Vedeu::Group]
     def by_name(name)

data/lib/vedeu/repositories/repositories/interfaces_repository.rb

@@ -7,11 +7,17 @@ module Vedeu
 
     class << self
 
+      # @example
+      #   Vedeu.interfaces
+      #
       # @return [Vedeu::InterfacesRepository]
       alias_method :interfaces, :repository
 
       # Remove all stored models from the repository.
       #
+      # @example
+      #   Vedeu.interfaces.reset!
+      #
       # @return [Vedeu::InterfacesRepository]
       def reset!
         @interfaces = register(Vedeu::Interface)
@@ -24,6 +30,9 @@ module Vedeu
 
     # Returns the interfaces in zindex order.
     #
+    # @example
+    #   Vedeu.interfaces.zindexed
+    #
     # @return [Array<Vedeu::Interface>]
     # @see Vedeu::DSL::Interface#zindex
     def zindexed

data/lib/vedeu/repositories/repositories/keymaps.rb

@@ -7,11 +7,17 @@ module Vedeu
 
     class << self
 
+      # @example
+      #   Vedeu.keymaps
+      #
       # @return [Vedeu::Keymaps]
       alias_method :keymaps, :repository
 
       # Remove all stored models from the repository.
       #
+      # @example
+      #   Vedeu.keymaps.reset!
+      #
       # @return [Vedeu::Keymaps]
       def reset!
         @keymaps = register(Vedeu::Keymap)

data/lib/vedeu/repositories/repositories/menus.rb

@@ -7,11 +7,17 @@ module Vedeu
 
     class << self
 
+      # @example
+      #   Vedeu.menus
+      #
       # @return [Vedeu::Menus]
       alias_method :menus, :repository
 
       # Remove all stored models from the repository.
       #
+      # @example
+      #   Vedeu.menus.reset!
+      #
       # @return [Vedeu::Menus]
       def reset!
         @menus = register(Vedeu::Menu)

data/lib/vedeu/support/terminal.rb

@@ -76,6 +76,9 @@ module Vedeu
     # and attempt to redraw the current interface with varying degrees of
     # success. Can also be used to simulate a terminal resize.
     #
+    # @example
+    #   Vedeu.resize
+    #
     # @return [TrueClass]
     def resize
       Vedeu.trigger(:_clear_)

data/lib/vedeu/support/timer.rb

@@ -7,6 +7,11 @@ module Vedeu
 
     class << self
 
+      # @example
+      #   Vedeu.timer 'message' do
+      #     # ... code to be measured
+      #   end
+      #
       # @param message [String]
       # @param block [Proc]
       # @return [void]

data/lib/vedeu/version.rb

@@ -1,6 +1,6 @@
 module Vedeu
 
   # The current version of Vedeu.
-  VERSION = '0.4.33'
+  VERSION = '0.4.34'
 
 end