vedeu 0.6.32 → 0.6.33

data/docs/events/system.md

@@ -2,7 +2,7 @@
 
 ## System Events
 
-### :\_cleanup_
+### `:\_cleanup\_`
 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
@@ -10,13 +10,13 @@ popular here.
 
     Vedeu.trigger(:_exit_)
 
-### :\_command_
+### `:\_command\_`
 Will cause the triggering of the `:command` event; which you should
 define to 'do things'.
 
     Vedeu.trigger(:_command_, command)
 
-### :\_editor_
+### `:\_editor\_`
 This event is called by {Vedeu::Input::Capture#read}. When
 invoked, the key will be passed to the editor for currently
 focussed view.
@@ -26,21 +26,21 @@ represented by Symbols.
 
     Vedeu.trigger(:_editor_, key)
 
-### :\_exit_
+### `:\_exit\_`
 When triggered, Vedeu will trigger a `:cleanup` event which you can
 define (to save files, etc) and attempt to exit.
 
     Vedeu.trigger(:_exit_)
     Vedeu.exit
 
-### :\_initialize_
+### `:\_initialize\_`
 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.
 
     Vedeu.trigger(:_initialize_)
 
-### :\_keypress_
+### `:\_keypress\_`
 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
@@ -50,7 +50,7 @@ can be found here: {Vedeu::Input::Capture}.
 
     Vedeu.trigger(:_keypress_, key)
 
-### :\_log_
+### `:\_log\_`
 When triggered with a message will cause Vedeu to log the message if
 logging is enabled in the configuration.
 
@@ -58,7 +58,7 @@ Note: 'message' is a String.
 
     Vedeu.trigger(:_log_, message)
 
-### :\_mode_switch_
+### `:\_mode_switch\_`
 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

data/docs/events/view.md

@@ -4,20 +4,20 @@
 
 Note: 'name' is a Symbol unless mentioned otherwise.
 
-### :\_maximise_
+### `:\_maximise\_`
 Maximising an interface.
 
     Vedeu.trigger(:_maximise_, name)
 
 See {Vedeu::Geometry::Geometry#maximise}
 
-### :\_resize_
+### `:\_resize\_`
 When triggered will cause Vedeu to trigger the `:_clear_` and
 `:_refresh_` events. Please see those events for their behaviour.
 
     Vedeu.trigger(:_resize_)
 
-### :\_unmaximise_
+### `:\_unmaximise\_`
 Unmaximising an interface.
 
     Vedeu.trigger(:_unmaximise_, name)

data/docs/events/visibility.md

@@ -4,32 +4,32 @@
 
 Note: 'name' is a Symbol unless mentioned otherwise.
 
-### :\_clear_
+### `:\_clear\_`
 Clears the whole terminal space.
 
     Vedeu.trigger(:_clear_)
     Vedeu.clear
 
-### :\_clear_group_
+### `:\_clear_group\_`
 Clears the spaces occupied by the interfaces belonging to the named
 group.
 
     Vedeu.trigger(:_clear_group_, name)
     Vedeu.clear_by_group(name)
 
-### :\_clear_view_
+### `:\_clear_view\_`
 Clears the named view/interface area.
 
     Vedeu.trigger(:_clear_view_, name)
     Vedeu.clear_by_name(name)
 
-### :\_clear_view_content_
+### `:\_clear_view_content\_`
 Clears only the content of the named view/interface area.
 
     Vedeu.trigger(:_clear_view_content_, name)
     Vedeu.clear_content_by_name(name)
 
-### :\_hide_cursor_
+### `:\_hide_cursor\_`
 Hide the cursor of the named interface or when a name is not given,
 the interface currently in focus.
 
@@ -37,19 +37,19 @@ the interface currently in focus.
     Vedeu.trigger(:_cursor_hide_, name)
     Vedeu.hide_cursor(name)
 
-### :\_hide_group_
+### `:\_hide_group\_`
 Hiding a group of interfaces.
 
     Vedeu.trigger(:_hide_group_, name)
     Vedeu.hide_group(name)
 
-### :\_hide_interface_
+### `:\_hide_interface\_`
 Hide an interface by name.
 
     Vedeu.trigger(:_hide_interface_, name)
     Vedeu.hide_interface(name)
 
-### :\_show_cursor_
+### `:\_show_cursor\_`
 Show the cursor of the named interface or when a name is not given,
 the interface currently in focus.
 
@@ -57,31 +57,31 @@ the interface currently in focus.
     Vedeu.trigger(:_cursor_show_, name)
     Vedeu.show_cursor(name)
 
-### :\_show_group_
+### `:\_show_group\_`
 Showing a group of interfaces.
 
     Vedeu.trigger(:_show_group_, name)
     Vedeu.show_group(name)
 
-### :\_show_interface_
+### `:\_show_interface\_`
 Show an interface by name.
 
     Vedeu.trigger(:_show_interface_, name)
     Vedeu.show_interface(name)
 
-### :\_toggle_cursor_
+### `:\_toggle_cursor\_`
 Toggling a cursor.
 
     Vedeu.trigger(:_toggle_cursor_, name)
     Vedeu.toggle_cursor(name)
 
-### :\_toggle_group_
+### `:\_toggle_group\_`
 Toggling a group of interfaces.
 
     Vedeu.trigger(:_toggle_group_, name)
     Vedeu.toggle_group(name)
 
-### :\_toggle_interface_
+### `:\_toggle_interface\_`
 Toggling an interface.
 
     Vedeu.trigger(:_toggle_interface_, name)

data/docs/geometry.md

@@ -24,5 +24,5 @@ of the terminal.
 - Geometry can be maximised- to use all the available terminal space.
 - It can also be unmaximised- to return to the pre-defined dimensions
   as mentioned above.
-- Geometry like a {file:docs/cursor.md Cursor}, via events can be
+- Geometry like a {file:docs/cursors.md Cursor}, via events can be
   moved; left, right, up or down.

data/docs/interfaces.md

@@ -6,7 +6,7 @@ Think of interfaces as being discrete sections of the terminal space.
 - It has a name, which all other aspects of Vedeu will be related.
 - It has a size, in terms of a width and height, determined by
   {file:docs/geometry.md Geometry}.
-- It can have a {file:docs/border.md Border}.
+- It can have a {file:docs/borders.md Border}.
 - It can be part of a {file:docs/group.md Group}.
 - An interface is empty unless it has an associated
   {file:docs/view.md View}.

data/lib/vedeu/borders/border.rb

@@ -7,6 +7,8 @@ module Vedeu
     # the border parts (e.g. the corners, verticals and horizontals)
     # can be customised as can the colours and styles.
     #
+    # More information can be found at: {file:docs/borders.md Borders}
+    #
     # @note
     #   Refer to UTF-8 U+2500 to U+257F for border characters.
     #   More details can be found at:
@@ -58,11 +60,13 @@ module Vedeu
       alias_method :top?, :show_top
 
       # @!attribute [rw] caption
-      # @return [String]
+      # @return [String] An optional caption for when the bottom
+      #   border is to be shown.
       attr_accessor :caption
 
       # @!attribute [rw] title
-      # @return [String]
+      # @return [String] An optional title for when the top
+      #   border is to be shown.
       attr_accessor :title
 
       # @!attribute [rw] top_left

data/lib/vedeu/borders/refresh.rb

@@ -44,24 +44,28 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:_refresh_border_, name)
       #
-      # @param name [String|Symbol] The name of the border to render.
-      # @return [Array<Array<Vedeu::Views::Char>>]
-      def self.by_name(name)
-        new(name).render
+      # @param (see #initialize)
+      # @return (see #by_name)
+      def self.by_name(name = Vedeu.focus)
+        name || Vedeu.focus
+
+        new(name).by_name
       end
 
       # Returns a new instance of Vedeu::Borders::Refresh.
       #
-      # @param name [String|Symbol]
+      # @param name [String|Symbol] The name of the interface/view
+      #   border to be refreshed. Defaults to `Vedeu.focus`.
       # @return [Vedeu::Borders::Refresh]
-      def initialize(name)
-        @name = name
+      def initialize(name = Vedeu.focus)
+        @name = present?(name) ? name : Vedeu.focus
       end
 
       # @return [Array<Array<Vedeu::Views::Char>>]
-      def render
-        Vedeu.render_output(output) if enabled?
+      def by_name
+        Vedeu.render_output(output) if enabled? && visible?
       end
+      alias_method :render, :by_name
 
       protected
 
@@ -362,13 +366,4 @@ module Vedeu
 
   end # Borders
 
-  # :nocov:
-
-  # See {file:docs/events/refresh.md#\_refresh_border_}
-  Vedeu.bind(:_refresh_border_) do |name|
-    Vedeu::Borders::Refresh.by_name(name)
-  end
-
-  # :nocov:
-
 end # Vedeu

data/lib/vedeu/borders/repository.rb

@@ -25,4 +25,27 @@ module Vedeu
   # @return [Vedeu::Borders::Repository]
   def_delegators Vedeu::Borders::Repository, :borders
 
+  # :nocov:
+
+  # See {file:docs/borders.md#label-3A_refresh_border_}
+  Vedeu.bind(:_refresh_border_) do |name|
+    Vedeu::Borders::Refresh.by_name(name)
+  end
+
+  # See {file:docs/borders.md#label-3A_set_border_caption_}
+  Vedeu.bind(:_set_border_caption_) do |name, caption|
+    border = Vedeu.borders.by_name(name)
+    border.caption = caption
+    border.store { Vedeu.trigger(:_refresh_border_, name) }
+  end
+
+  # See {file:docs/borders.md#label-3A_set_border_title_}
+  Vedeu.bind(:_set_border_title_) do |name, title|
+    border = Vedeu.borders.by_name(name)
+    border.title = title
+    border.store { Vedeu.trigger(:_refresh_border_, name) }
+  end
+
+  # :nocov:
+
 end # Vedeu

data/lib/vedeu/buffers/refresh.rb

@@ -13,7 +13,9 @@ module Vedeu
       #
       # @param (see #initialize)
       # @return (see #by_name)
-      def self.by_name(name)
+      def self.by_name(name = Vedeu.focus)
+        name ||= Vedeu.focus
+
         new(name).by_name
       end
 
@@ -22,19 +24,21 @@ module Vedeu
       #
       # @param (see #initialize)
       # @return (see #by_name)
-      def self.refresh_content_by_name(name)
+      def self.refresh_content_by_name(name = Vedeu.focus)
+        name ||= Vedeu.focus
+
         new(name, content_only: true).by_name
       end
 
       # Return a new instance of Vedeu::Buffers::Refresh.
       #
-      # @param name [String|Symbol] The name of the interface to be refreshed
-      #   using the named buffer.
+      # @param name [String|Symbol] The name of the interface/view to
+      #   be refreshed. Defaults to `Vedeu.focus`.
       # @param options [Hash]
       # @option options content_only [Boolean]
       # @return [Vedeu::Buffers::Refresh]
       def initialize(name, options = {})
-        @name    = name
+        @name    = present?(name) ? name : Vedeu.focus
         @options = options
       end
 

data/lib/vedeu/cursors/cursor.rb

@@ -363,6 +363,8 @@ module Vedeu
   # See {file:docs/cursors.md}
   Vedeu.bind(:_cursor_origin_) do |name|
     Vedeu.cursors.by_name(name).move_origin
+
+    Vedeu.trigger(:_refresh_cursor_, name)
   end
   # Vedeu.bind_alias(:_cursor_reset_, :_cursor_origin_)
 

data/lib/vedeu/cursors/refresh.rb

@@ -9,6 +9,7 @@ module Vedeu
     class Refresh
 
       extend Forwardable
+      include Vedeu::Common
 
       def_delegators :border,
                      :height,
@@ -18,16 +19,20 @@ module Vedeu
       #   Vedeu.trigger(:_refresh_cursor_, name)
       #
       # @param (see #initialize)
-      def self.by_name(name = nil)
+      # @return (see #by_name)
+      def self.by_name(name = Vedeu.focus)
+        name || Vedeu.focus
+
         new(name).by_name
       end
 
       # Returns a new instance of Vedeu::Cursors::Refresh.
       #
-      # @param name [String|Symbol] The name of the cursor.
+      # @param name [String|Symbol] The name of the interface/view
+      #   cursor to be refreshed. Defaults to `Vedeu.focus`.
       # @return [Vedeu::Cursors::Refresh]
-      def initialize(name = nil)
-        @name = name || Vedeu.focus
+      def initialize(name)
+        @name = present?(name) ? name : Vedeu.focus
       end
 
       # Renders the cursor in the terminal. If the cursor's x or y

data/lib/vedeu/cursors/repository.rb

@@ -17,7 +17,7 @@ module Vedeu
         #
         # @return [Vedeu::Cursors::Cursor]
         def cursor
-          cursors.by_name(Vedeu.focus) if Vedeu.focus
+          cursors.by_name
         end
 
       end # Eigenclass

data/lib/vedeu/editor/cropper.rb

@@ -8,6 +8,7 @@ module Vedeu
     class Cropper
 
       extend Forwardable
+      include Vedeu::Common
 
       def_delegators :border,
                      :bx,
@@ -26,7 +27,7 @@ module Vedeu
       # @return [Vedeu::Editor::Cropper]
       def initialize(lines:, ox:, oy:, name:)
         @lines = lines
-        @name  = name
+        @name  = present?(name) ? name : Vedeu.focus
         @ox    = ox
         @oy    = oy
       end

data/lib/vedeu/error.rb

@@ -19,7 +19,12 @@ module Vedeu
 
     end # ControllerNotFound
 
-    # Raised when Vedeu encounters an error.
+    # Raised when Vedeu encounters an error it cannot recover from.
+    # This would happen if there was not interfaces, or specifically
+    # if there were no entries in {Vedeu::Models::Focus}, since the
+    # fallback for most of the system when a name is not given or
+    # cannot be found is to use the name of the currently focussed
+    # interface.
     #
     class Fatal < StandardError
 

data/lib/vedeu/groups/refresh.rb

@@ -45,7 +45,7 @@ module Vedeu
       protected
 
       # @!attribute [r] name
-      # @return [String]
+      # @return [String|Symbol]
       attr_reader :name
 
       private
@@ -55,11 +55,17 @@ module Vedeu
       # @return [String]
       def group_name
         return name if present?(name)
+        return group_from_interface if present?(group_from_interface)
 
         fail Vedeu::Error::MissingRequired,
              'Cannot refresh group with an empty group name.'.freeze
       end
 
+      # @return [String|Symbol]
+      def group_from_interface
+        @_group_name ||= Vedeu.interfaces.by_name(name).group
+      end
+
     end # Refresh
 
   end # Groups