vedeu 0.6.8 → 0.6.9

data/lib/vedeu/bindings/system.rb

@@ -2,15 +2,12 @@ module Vedeu
 
   module Bindings
 
-    # Creates system events which when called provide a variety of core
-    # functions and behaviours. They are soft-namespaced using underscores.
-    #
-    # :nocov:
     module System
 
       extend self
 
-      # Setup events relating to running Vedeu. This method is called by Vedeu.
+      # Setup events relating to running Vedeu. This method is called
+      # by Vedeu.
       #
       # @return [TrueClass]
       def setup!
@@ -30,15 +27,7 @@ module Vedeu
 
       private
 
-      # Vedeu triggers this event when `:_exit_` is triggered. You can hook
-      # into this to perform a special action before the application
-      # terminates. Saving the user's work, session or preferences might be
-      # popular here.
-      #
-      # @example
-      #   Vedeu.trigger(:_exit_)
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/system.md#\_cleanup_}
       def cleanup!
         Vedeu.bind(:_cleanup_) do
           Vedeu.trigger(:_drb_stop_)
@@ -46,14 +35,7 @@ module Vedeu
         end
       end
 
-      # Clears the whole terminal space, or when a name is given, the named
-      # interface area will be cleared.
-      #
-      # @example
-      #   Vedeu.trigger(:_clear_)
-      #   Vedeu.clear_by_name(name)
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/system.md#\_cleanup_}
       def clear!
         Vedeu.bind(:_clear_) do |name|
           if name
@@ -66,48 +48,24 @@ module Vedeu
         end
       end
 
-      # Will cause the triggering of the `:command` event; which you should
-      # define to 'do things'
-      #
-      # @example
-      #   Vedeu.trigger(:_command_, command)
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/system.md#\_command_}
       def command!
         Vedeu.bind(:_command_) { |command| Vedeu.trigger(:command, command) }
       end
 
-      # This event is called by {Vedeu::Input::Input#capture}. When
-      # invoked, the key will be passed to the editor for currently
-      # focussed view.
-      #
-      # @example
-      #   Vedeu.trigger(:_editor_, key)
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/system.md#\_editor_}
       def editor!
         Vedeu.bind(:_editor_) do |key|
           Vedeu::Editor::Editor.keypress(name: Vedeu.focus, input: key)
         end
       end
 
-      # When triggered, Vedeu will trigger a `:cleanup` event which you can
-      # define (to save files, etc) and attempt to exit.
-      #
-      # @example
-      #   Vedeu.trigger(:_exit_)
-      #   Vedeu.exit
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/system.md#\_exit_}
       def exit!
         Vedeu.bind(:_exit_) { Vedeu::Runtime::Application.stop }
       end
 
-      # Vedeu triggers this event when it is ready to enter the main loop.
-      # Client applications can listen for this event and perform some
-      # action(s), like render the first screen, interface or make a sound.
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/system.md#\_initialize_}
       def initialize!
         Vedeu.bind(:_initialize_) do
           Vedeu.ready!
@@ -115,77 +73,34 @@ module Vedeu
         end
       end
 
-      # Will cause the triggering of the `:key` event; which you should define
-      # to 'do things'. If the `escape` key is pressed, then `key` is triggered
-      # with the argument `:escape`, also an internal event `_mode_switch_` is
-      # triggered. Vedeu recognises most key presses and some 'extended'
-      # keypress (eg. Ctrl+J), a list of supported keypresses can be found here:
-      # {Vedeu::Input::Input#specials} and {Vedeu::Input::Input#f_keys}.
-      #
-      # @example
-      #   Vedeu.trigger(:_keypress_, key)
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/system.md#\_keypress_}
       def keypress!
         Vedeu.bind(:_keypress_) { |key| Vedeu.keypress(key) }
       end
 
-      # When triggered with a message will cause Vedeu to log the message if
-      # logging is enabled in the configuration.
-      #
-      # @example
-      #   Vedeu.trigger(:_log_, message)
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/system.md#\_log_}
       def log!
         Vedeu.bind(:_log_) { |msg| Vedeu.log(type: :debug, message: msg) }
       end
 
-      # Maximising an interface.
-      #
-      # @example
-      #   Vedeu.trigger(:_maximise_, name)
-      #
-      # @return [TrueClass]
-      # @see Vedeu::Geometry::Geometry#maximise
+      # See {file:docs/events/system.md#\_maximise_}
       def maximise!
         Vedeu.bind(:_maximise_) do |name|
           Vedeu.geometries.by_name(name).maximise
         end
       end
 
-      # When triggered (by default, after the user presses `escape`), Vedeu
-      # switches between modes of the terminal. The idea here being
-      # that the raw mode is for single keypress actions, whilst fake and cooked
-      # modes allow the user to enter more elaborate commands- such as commands
-      # with arguments.
-      #
-      # @example
-      #   Vedeu.trigger(:_mode_switch_)
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/system.md#\_mode_switch_}
       def mode_switch!
         Vedeu.bind(:_mode_switch_) { fail Vedeu::Error::ModeSwitch }
       end
 
-      # When triggered will cause Vedeu to trigger the `:_clear_` and
-      # `:_refresh_` events. Please see those events for their behaviour.
-      #
-      # @example
-      #   Vedeu.trigger(:_resize_)
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/system.md#\_resize_}
       def resize!
         Vedeu.bind(:_resize_, delay: 0.25) { Vedeu.resize }
       end
 
-      # Unmaximising an interface.
-      #
-      # @example
-      #   Vedeu.trigger(:_unmaximise_, name)
-      #
-      # @return [TrueClass]
-      # @see Vedeu::Geometry::Geometry#unmaximise
+      # See {file:docs/events/system.md#\_unmaximise_}
       def unmaximise!
         Vedeu.bind(:_unmaximise_) do |name|
           Vedeu.geometries.by_name(name).unmaximise
@@ -193,7 +108,6 @@ module Vedeu
       end
 
     end # System
-    # :nocov:
 
   end # Bindings
 

data/lib/vedeu/bindings/visibility.rb

@@ -5,7 +5,6 @@ module Vedeu
     # System events relating to the visibility of cursors or
     # interfaces.
     #
-    # :nocov:
     module Visibility
 
       extend self
@@ -29,29 +28,14 @@ module Vedeu
 
       private
 
-      # Clears the spaces occupied by the interfaces belonging to the
-      # named group.
-      #
-      # @example
-      #   Vedeu.trigger(:_clear_group_, name)
-      #   Vedeu.clear_by_group(name)
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/visibility.md#\_clear_group_}
       def clear_group!
         Vedeu.bind(:_clear_group_) do |name|
           Vedeu::Clear::NamedGroup.render(name)
         end
       end
 
-      # Hide the cursor of the named interface or when a name is not
-      # given, the interface currently in focus.
-      #
-      # @example
-      #   Vedeu.trigger(:_hide_cursor_, name)
-      #   Vedeu.trigger(:_cursor_hide_, name)
-      #   Vedeu.hide_cursor(name)
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/visibility.md#\_hide_cursor_}
       def hide_cursor!
         Vedeu.bind(:_hide_cursor_) do |name|
           Vedeu::Cursors::Cursor.hide_cursor(name)
@@ -60,33 +44,21 @@ module Vedeu
         Vedeu.bind_alias(:_cursor_hide_, :_hide_cursor_)
       end
 
-      # @see Vedeu::Group#hide
+      # See {file:docs/events/visibility.md#\_hide_group_}
       def hide_group!
-        Vedeu.bind(:_hide_group_) { |name| Vedeu::Group.hide_group(name) }
+        Vedeu.bind(:_hide_group_) do |name|
+          Vedeu::Models::Group.hide_group(name)
+        end
       end
 
-      # Hiding an interface.
-      #
-      # @example
-      #   Vedeu.trigger(:_hide_interface_, name)
-      #   Vedeu.hide_interface(name)
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/visibility.md#\_hide_interface_}
       def hide_interface!
         Vedeu.bind(:_hide_interface_) do |name|
-          Vedeu::Interface.hide_interface(name)
+          Vedeu::Models::Interface.hide_interface(name)
         end
       end
 
-      # Show the cursor of the named interface or when a name is not
-      # given, the interface currently in focus.
-      #
-      # @example
-      #   Vedeu.trigger(:_show_cursor_, name)
-      #   Vedeu.trigger(:_cursor_show_, name)
-      #   Vedeu.show_cursor(name)
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/visibility.md#\_show_cursor_}
       def show_cursor!
         Vedeu.bind(:_show_cursor_) do |name|
           Vedeu::Cursors::Cursor.show_cursor(name)
@@ -95,65 +67,42 @@ module Vedeu
         Vedeu.bind_alias(:_cursor_show_, :_show_cursor_)
       end
 
-      # @see Vedeu::Group#show
+      # See {file:docs/events/visibility.md#\_show_group_}
       def show_group!
-        Vedeu.bind(:_show_group_) { |name| Vedeu::Group.show_group(name) }
+        Vedeu.bind(:_show_group_) do |name|
+          Vedeu::Models::Group.show_group(name)
+        end
       end
 
-      # Showing an interface.
-      #
-      # @example
-      #   Vedeu.trigger(:_show_interface_, name)
-      #   Vedeu.show_interface(name)
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/visibility.md#\_show_interface_}
       def show_interface!
         Vedeu.bind(:_show_interface_) do |name|
-          Vedeu::Interface.show_interface(name)
+          Vedeu::Models::Interface.show_interface(name)
         end
       end
 
-      # Toggling a cursor.
-      #
-      # @example
-      #   Vedeu.trigger(:_toggle_cursor_, name)
-      #   Vedeu.toggle_cursor(name)
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/visibility.md#\_toggle_cursor_}
       def toggle_cursor!
         Vedeu.bind(:_toggle_cursor_) do |name|
           Vedeu::Cursors::Cursor.toggle_cursor(name)
         end
       end
 
-      # Toggling a group.
-      #
-      # @example
-      #   Vedeu.trigger(:_toggle_group_, name)
-      #   Vedeu.toggle_group(name)
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/visibility.md#\_toggle_group_}
       def toggle_group!
         Vedeu.bind(:_toggle_group_) do |name|
-          Vedeu::Group.toggle_group(name)
+          Vedeu::Models::Group.toggle_group(name)
         end
       end
 
-      # Toggling an interface.
-      #
-      # @example
-      #   Vedeu.trigger(:_toggle_interface_, name)
-      #   Vedeu.toggle_interface(name)
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/visibility.md#\_toggle_interface_}
       def toggle_interface!
         Vedeu.bind(:_toggle_interface_) do |name|
-          Vedeu::Interface.toggle_interface(name)
+          Vedeu::Models::Interface.toggle_interface(name)
         end
       end
 
     end # Visibility
-    # :nocov:
 
   end # Bindings
 

data/lib/vedeu/borders/all.rb

@@ -1,9 +1,10 @@
 module Vedeu
 
   # Borders are defined by name for each of the client application's
-  # interfaces or views. They can be enabled or disabled (which controls
-  # whether they are rendered or not), they have their own colours and styles,
-  # and each aspect of the border can be controlled.
+  # interfaces or views. They can be enabled or disabled (which
+  # controls whether they are rendered or not), they have their own
+  # colours and styles, and each aspect of the border can be
+  # controlled.
   #
   # @example
   #   # Borders can be defined when defining your interface...

data/lib/vedeu/borders/border.rb

@@ -2,13 +2,15 @@ module Vedeu
 
   module Borders
 
-    # Provides the mechanism to decorate an interface with a border on all
-    # edges, or specific edges. The characters which are used for the border
-    # parts (e.g. the corners, verticals and horizontals) can be customised as
-    # can the colours and styles.
+    # Provides the mechanism to decorate an interface with a border on
+    # all edges, or specific edges. The characters which are used for
+    # the border parts (e.g. the corners, verticals and horizontals)
+    # can be customised as can the colours and styles.
     #
-    # @note Refer to UTF-8 U+2500 to U+257F for border characters. More details
-    #   can be found at: http://en.wikipedia.org/wiki/Box-drawing_character
+    # @note
+    #   Refer to UTF-8 U+2500 to U+257F for border characters.
+    #   More details can be found at:
+    #   http://en.wikipedia.org/wiki/Box-drawing_character
     #
     class Border
 
@@ -95,30 +97,34 @@ module Vedeu
       # @param attributes [Hash]
       # @option attributes bottom_left [String] The bottom left border
       #   character.
-      # @option attributes bottom_right [String] The bottom right border
-      #   character.
+      # @option attributes bottom_right [String] The bottom right
+      #   border character.
       # @option attributes colour [Hash]
-      # @option attributes enabled [Boolean] Indicate whether the border is to
-      #   be shown for this interface.
-      # @option attributes horizontal [String] The horizontal border character.
-      # @option attributes name [String] The name of the interface to which this
-      #   border relates.
-      # @option attributes style [Vedeu::Style]
-      # @option attributes show_bottom [Boolean] Indicate whether the bottom
-      #   border is to be shown.
-      # @option attributes show_left [Boolean] Indicate whether the left border
-      #   is to be shown.
-      # @option attributes show_right [Boolean] Indicate whether the right
-      #   border is to be shown.
-      # @option attributes show_top [Boolean] Indicate whether the top border is
-      #   to be shown.
-      # @option attributes title [String] An optional title for when the top
-      #   border is to be shown.
-      # @option attributes caption [String] An optional caption for when the
+      # @option attributes enabled [Boolean] Indicate whether the
+      #   border is to be shown for this interface.
+      # @option attributes horizontal [String] The horizontal border
+      #   character.
+      # @option attributes name [String] The name of the interface to
+      #   which this border relates.
+      # @option attributes style [Vedeu::Presentation::Style]
+      # @option attributes show_bottom [Boolean] Indicate whether the
       #   bottom border is to be shown.
-      # @option attributes top_left [String] The top left border character.
-      # @option attributes top_right [String] The top right border character.
-      # @option attributes vertical [String] The vertical border character.
+      # @option attributes show_left [Boolean] Indicate whether the
+      #   left border is to be shown.
+      # @option attributes show_right [Boolean] Indicate whether the
+      #   right border is to be shown.
+      # @option attributes show_top [Boolean] Indicate whether the top
+      #   border is to be shown.
+      # @option attributes title [String] An optional title for when
+      #   the top border is to be shown.
+      # @option attributes caption [String] An optional caption for
+      #   when the bottom border is to be shown.
+      # @option attributes top_left [String] The top left border
+      #   character.
+      # @option attributes top_right [String] The top right border
+      #   character.
+      # @option attributes vertical [String] The vertical border
+      #   character.
       # @return [Vedeu::Borders::Border]
       def initialize(attributes = {})
         @attributes = defaults.merge!(attributes)
@@ -148,16 +154,16 @@ module Vedeu
         (enabled? && bottom?) ? yn - 1 : yn
       end
 
-      # Returns the width of the interface determined by whether a left, right,
-      # both or neither borders are shown.
+      # Returns the width of the interface determined by whether a
+      # left, right, both or neither borders are shown.
       #
       # @return [Fixnum]
       def width
         (bx..bxn).size
       end
 
-      # Returns the height of the interface determined by whether a top, bottom,
-      # both or neither borders are shown.
+      # Returns the height of the interface determined by whether a
+      # top, bottom, both or neither borders are shown.
       #
       # @return [Fixnum]
       def height
@@ -176,7 +182,7 @@ module Vedeu
         Vedeu.geometries.by_name(name)
       end
 
-      # @return [Vedeu::Interface]
+      # @return [Vedeu::Models::Interface]
       def interface
         @interface ||= Vedeu.interfaces.by_name(name)
       end