vedeu 0.6.15 → 0.6.16

data/docs/events/refresh.md

@@ -3,7 +3,7 @@
 ## Refresh Events
 
 ### :_refresh_
-Refreshes all registered interfaces or the named interface.
+Refreshes all registered interfaces.
 
 The interfaces will be refreshed in z-index order, meaning that
 interfaces with a lower z-index will be drawn first. This means
@@ -11,7 +11,6 @@ overlapping interfaces will be drawn as specified. Hidden interfaces
 will be still refreshed in memory but not shown.
 
     Vedeu.trigger(:_refresh_)
-    Vedeu.trigger(:_refresh_, name)
 
 ### :_refresh_cursor_
 Will cause the named cursor to refresh, or the cursor of the interface
@@ -23,3 +22,8 @@ which is currently in focus.
 Will cause all interfaces in the named group to refresh.
 
     Vedeu.trigger(:_refresh_group_, name)
+
+### :_refresh_view_
+Will cause the named view to refresh.
+
+    Vedeu.trigger(:_refresh_view_, name)

data/docs/events/visibility.md

@@ -3,11 +3,10 @@
 ## Visibility Events
 
 ### :_clear_
-Clears the whole terminal space, or when a name is given, the named
-interface area will be cleared.
+Clears the whole terminal space.
 
     Vedeu.trigger(:_clear_)
-    Vedeu.clear_by_name(name)
+    Vedeu.clear
 
 ### :_clear_group_
 Clears the spaces occupied by the interfaces belonging to the named
@@ -16,6 +15,12 @@ group.
     Vedeu.trigger(:_clear_group_, name)
     Vedeu.clear_by_group(name)
 
+### :_clear_view_
+Clears the named view/interface area.
+
+    Vedeu.trigger(:_clear_view_, name)
+    Vedeu.clear_by_name(name)
+
 ### :_hide_cursor_
 Hide the cursor of the named interface or when a name is not given,
 the interface currently in focus.

data/lib/vedeu.rb

@@ -22,7 +22,8 @@ require 'thor'
 
 require 'vedeu/logging/log'
 
-# Vedeu is a GUI framework for terminal/console applications written in Ruby.
+# Vedeu is a GUI framework for terminal/console applications written
+# in Ruby.
 #
 module Vedeu
 
@@ -39,8 +40,8 @@ module Vedeu
   end
 
   # :nocov:
-  # When Vedeu is included within one of your classes, you should have all
-  # API methods at your disposal.
+  # When Vedeu is included within one of your classes, you should have
+  # all API methods at your disposal.
   #
   # @example
   #   class YourClassHere

data/lib/vedeu/all.rb

@@ -18,8 +18,9 @@ require 'vedeu/models/toggleable'
 
 require 'vedeu/output/presentation/presentation'
 require 'vedeu/output/direct'
-require 'vedeu/output/clear/named_group'
-require 'vedeu/output/clear/named_interface'
+
+require 'vedeu/output/clear/all'
+
 require 'vedeu/output/compressor'
 require 'vedeu/output/text'
 require 'vedeu/output/output'

data/lib/vedeu/api/external.rb

@@ -138,16 +138,16 @@ module Vedeu
       def_delegators Vedeu::Runtime::Application, :exit
 
       # @!method clear
-      #   @see Vedeu::Terminal#clear
-      def_delegators Vedeu::Terminal, :clear
+      #   @see Vedeu::Terminal::Buffer#clear
+      def_delegators Vedeu::Terminal::Buffer, :clear
 
       # @!method clear_by_name
-      #   @see Vedeu::Clear::NamedInterface.render
-      def_delegators Vedeu::Clear::NamedInterface, :clear_by_name
+      #   @see Vedeu::Clear::Interface.render
+      def_delegators Vedeu::Clear::Interface, :clear_by_name
 
       # @!method clear_by_group
-      #   @see Vedeu::Clear::NamedGroup.render
-      def_delegators Vedeu::Clear::NamedGroup, :clear_by_group
+      #   @see Vedeu::Clear::Group.render
+      def_delegators Vedeu::Clear::Group, :clear_by_group
 
       # @!method hide_cursor
       #   @see Vedeu::Cursors::Cursor#hide

data/lib/vedeu/bindings/bindings.rb

@@ -12,14 +12,14 @@ module Vedeu
 
       Vedeu::Bindings::Application.setup!
       Vedeu::Bindings::Document.setup!
-      Vedeu::Bindings::Visibility.setup!
-      Vedeu::Bindings::Movement.setup!
-      Vedeu::Bindings::Menus.setup!
       Vedeu::Bindings::DRB.setup!
       Vedeu::Bindings::Focus.setup!
+      Vedeu::Bindings::Menus.setup!
+      Vedeu::Bindings::Movement.setup!
       Vedeu::Bindings::Refresh.setup!
       Vedeu::Bindings::System.setup!
       Vedeu::Bindings::View.setup!
+      Vedeu::Bindings::Visibility.setup!
 
       true
     end

data/lib/vedeu/bindings/movement.rb

@@ -37,8 +37,8 @@ module Vedeu
 
             Vedeu.trigger(:_clear_)
             Vedeu.trigger(:_refresh_)
-            Vedeu.trigger(:_clear_, name)
-            Vedeu.trigger(:_refresh_, name)
+            Vedeu.trigger(:_clear_view_, name)
+            Vedeu.trigger(:_refresh_view_, name)
           end
 
           Vedeu.bind_alias("_geometry_#{direction}_".to_sym,
@@ -67,8 +67,8 @@ module Vedeu
         Vedeu.bind(:_cursor_reposition_) do |name, y, x|
           Vedeu.cursors.by_name(name).reposition(y, x)
 
-          Vedeu.trigger(:_clear_, name)
-          Vedeu.trigger(:_refresh_, name)
+          Vedeu.trigger(:_clear_view_, name)
+          Vedeu.trigger(:_refresh_view_, name)
           Vedeu.trigger(:_refresh_cursor_, name)
         end
       end

data/lib/vedeu/bindings/refresh.rb

@@ -16,6 +16,7 @@ module Vedeu
         refresh!
         refresh_cursor!
         refresh_group!
+        refresh_view!
       end
 
       private
@@ -24,15 +25,7 @@ module Vedeu
 
       # See {file:docs/events/refresh.md#\_refresh_}
       def refresh!
-        Vedeu.bind(:_refresh_) do |name|
-          if name
-            Vedeu::Buffers::Refresh.by_name(name)
-
-          else
-            Vedeu::Output::Refresh.all
-
-          end
-        end
+        Vedeu.bind(:_refresh_) { Vedeu::Output::Refresh.all }
       end
 
       # See {file:docs/events/refresh.md#\_refresh_cursor_}
@@ -49,6 +42,13 @@ module Vedeu
         end
       end
 
+      # See {file:docs/events/refresh.md#\_refresh_view_}
+      def refresh_view!
+        Vedeu.bind(:_refresh_view_) do |name|
+          Vedeu::Buffers::Refresh.by_name(name)
+        end
+      end
+
       # :nocov:
 
     end # Refresh

data/lib/vedeu/bindings/visibility.rb

@@ -16,6 +16,7 @@ module Vedeu
       def setup!
         clear!
         clear_group!
+        clear_view!
         hide_cursor!
         hide_group!
         hide_interface!
@@ -31,23 +32,20 @@ module Vedeu
 
       # :nocov:
 
-      # See {file:docs/events/system.md#\_cleanup_}
+      # See {file:docs/events/visibility.md#\_cleanup_}
       def clear!
-        Vedeu.bind(:_clear_) do |name|
-          if name
-            Vedeu::Clear::NamedInterface.render(name)
-
-          else
-            Vedeu::Terminal::Buffer.clear
-
-          end
-        end
+        Vedeu.bind(:_clear_) { Vedeu::Terminal::Buffer.clear }
       end
 
       # See {file:docs/events/visibility.md#\_clear_group_}
       def clear_group!
-        Vedeu.bind(:_clear_group_) do |name|
-          Vedeu::Clear::NamedGroup.render(name)
+        Vedeu.bind(:_clear_group_) { |name| Vedeu::Clear::Group.render(name) }
+      end
+
+      # See {file:docs/events/visibility.md#\_clear_view_}
+      def clear_view!
+        Vedeu.bind(:_clear_view_) do |name|
+          Vedeu::Clear::Interface.render(name)
         end
       end
 

data/lib/vedeu/buffers/buffer.rb

@@ -108,7 +108,7 @@ module Vedeu
       #
       # @return [Array<Array<Array<Vedeu::Views::Char>>>]
       def hide
-        Vedeu.trigger(:_clear_, name)
+        Vedeu.trigger(:_clear_view_, name)
       end
 
       # Return the content for this buffer.

data/lib/vedeu/buffers/refresh.rb

@@ -5,7 +5,7 @@ module Vedeu
     # Refreshes the given named interface.
     #
     # @example
-    #   Vedeu.trigger(:_refresh_, name)
+    #   Vedeu.trigger(:_refresh_view_, name)
     #
     class Refresh
 

data/lib/vedeu/colours/repository.rb

@@ -54,6 +54,7 @@ module Vedeu
       # registers the colour with its respective escape sequence.
       #
       # @return [String]
+      # @todo Unused - GL 2015-09-26
       def retrieve_or_register(colour, escape_sequence)
         if registered?(colour)
           retrieve(colour)

data/lib/vedeu/colours/translator.rb

@@ -39,13 +39,9 @@ module Vedeu
       # @param value [Object|NilClass]
       # @return [Object]
       def self.coerce(value)
-        if value.is_a?(self)
-          value
+        return value if value.is_a?(self)
 
-        else
-          new(value)
-
-        end
+        new(value)
       end
 
       # Return a new instance of Vedeu::Colours::Translator.

data/lib/vedeu/common.rb

@@ -21,7 +21,8 @@ module Vedeu
     #
     # @example
     #   snake_case(MyClassName) # => "my_class_name"
-    #   snake_case(NameSpaced::ClassName) # => "name_spaced/class_name"
+    #   snake_case(NameSpaced::ClassName)
+    #   # => "name_spaced/class_name"
     #
     # @param name [String]
     # @return [String]

data/lib/vedeu/configuration/api.rb

@@ -453,14 +453,9 @@ module Vedeu
       # @see Vedeu::Config::API#fake!
       # @see Vedeu::Config::API#raw!
       def terminal_mode(mode)
-        if [:cooked, :fake, :raw].include?(mode)
-          options[:terminal_mode] = mode
+        return invalid_mode! unless valid_mode?(mode)
 
-        else
-          fail Vedeu::Error::InvalidSyntax,
-               'Terminal mode can be set to either :cooked, :fake or :raw'
-
-        end
+        options[:terminal_mode] = mode
       end
 
       # Sets the width of the terminal.
@@ -478,6 +473,12 @@ module Vedeu
 
       private
 
+      # @raise [Vedeu::Error::InvalidSyntax]
+      def invalid_mode!
+        fail Vedeu::Error::InvalidSyntax,
+             'Terminal mode can be set to either :cooked, :fake or :raw'
+      end
+
       # Returns the options set via the configuration API DSL or an
       # empty Hash when none were set.
       #
@@ -494,6 +495,14 @@ module Vedeu
         value.is_a?(Fixnum) && [8, 16, 256, 16_777_216].include?(value)
       end
 
+      # Checks that the mode provided is valid.
+      #
+      # @param mode [Symbol] :cooked, :fake or :raw are valid
+      # @return [Boolean]
+      def valid_mode?(mode)
+        [:cooked, :fake, :raw].include?(mode)
+      end
+
     end # API
 
   end # Config

data/lib/vedeu/cursors/cursor.rb

@@ -136,7 +136,7 @@ module Vedeu
       #
       # @return [Array<Vedeu::Models::Escape>]
       def render
-        Vedeu::Output::Output.render(visibility)
+        Vedeu::Output::Output.render(escape_sequence)
       end
 
       # Arbitrarily move the cursor to a given position.
@@ -158,13 +158,9 @@ module Vedeu
       #
       # @return [String]
       def to_s
-        if block_given?
-          "#{position}#{yield}#{visibility}"
+        return escape_sequence.to_s unless block_given?
 
-        else
-          "#{visibility}"
-
-        end
+        "#{position}#{yield}#{escape_sequence}"
       end
       alias_method :to_str, :to_s
 
@@ -221,13 +217,9 @@ module Vedeu
       #
       # @return [Vedeu::Models::Escape]
       def toggle
-        if visible?
-          hide
-
-        else
-          show
+        return hide if visible?
 
-        end
+        show
       end
 
       # @return [Fixnum] The column/character coordinate.
@@ -277,6 +269,11 @@ module Vedeu
         }
       end
 
+      # @return [Vedeu::Models::Escape]
+      def escape_sequence
+        Vedeu::Models::Escape.new(position: position, value: visibility)
+      end
+
       # @return [Hash]
       def new_attributes(new_y = y, new_x = x, new_oy = oy, new_ox = ox)
         attributes.merge!(x: new_x, y: new_y, ox: new_ox, oy: new_oy)
@@ -287,15 +284,9 @@ module Vedeu
       #
       # @return [String]
       def visibility
-        value = if visible?
-                  Vedeu::EscapeSequences::Esc.show_cursor
-
-                else
-                  Vedeu::EscapeSequences::Esc.hide_cursor
-
-                end
+        return Vedeu::EscapeSequences::Esc.show_cursor if visible?
 
-        Vedeu::Models::Escape.new(position: position, value: value)
+        Vedeu::EscapeSequences::Esc.hide_cursor
       end
 
     end # Cursor

data/lib/vedeu/cursors/refresh.rb

@@ -36,7 +36,7 @@ module Vedeu
       def by_name
         Vedeu.log(type: :info, message: "Refreshing cursor: '#{name}'")
 
-        Vedeu.trigger(:_refresh_, name) if refresh_view?
+        Vedeu.trigger(:_refresh_view_, name) if refresh_view?
 
         cursor.render
       end

data/lib/vedeu/dsl/text.rb

@@ -1,3 +1,4 @@
+
 module Vedeu
 
   module DSL
@@ -38,28 +39,30 @@ module Vedeu
       #
       #   right 'This will be right aligned.', width: 35
       #   # => '        This will be right aligned.'
-
-      #   right 'This will be right aligned.', width: 35, anchor: centre
-      #   # => '        This will be right aligned.'
       #
-      #   text 'This will be truncated here. More text here.', width: 28
-      #   # => 'This will be truncated here.'
+      #   right 'This will be right aligned.', width: 35,
+      #     anchor: centre
+      #
+      #   text 'This will be truncated here. More text here.',
+      #     width: 28 # => 'This will be truncated here.'
       #
-      #   text 'Padded with hyphens.', width: 25, pad: '-', anchor: :right
-      #   # => '-----Padded with hyphens.'
+      #   text 'Padded with hyphens.', width: 25, pad: '-',
+      #     anchor: :right # => '-----Padded with hyphens.'
       #
-      # @param value [String|Object] A string or object that responds to `to_s`.
+      # @param value [String|Object] A string or object that responds
+      #   to `to_s`.
       # @param options [Hash] Text options.
-      # @option options :anchor [Symbol] One of `:left`, `:centre`/`:center`, or
-      #   `:right`.
-      # @option options :width [Integer|NilClass] The width of the text stream
-      #   to add. If the `string` provided is longer than this value, the string
-      #   will be truncated. If no width is provided in the context of 'lines',
-      #   then the interface width is used. If no width is provided in the
-      #   context of a 'stream', then no alignment will occur.
-      # @option options :pad [String] The character to use to pad the width, by
-      #   default uses an empty space (0x20). Only when the string is shorter
-      #   than the specified width.
+      # @option options :anchor [Symbol] One of `:left`,
+      #   `:centre`/`:center`, or `:right`.
+      # @option options :width [Integer|NilClass] The width of the
+      #   text stream to add. If the `string` provided is longer than
+      #   this value, the string will be truncated. If no width is
+      #   provided in the context of 'lines', then the interface width
+      #   is used. If no width is provided in the context of a
+      #   'stream', then no alignment will occur.
+      # @option options :pad [String] The character to use to pad the
+      #   width, by default uses an empty space (0x20). Only when the
+      #   string is shorter than the specified width.
       # @return [String]
       def text(value = '', options = {})
         options.merge!(anchor: __callee__, model: model)