vedeu 0.6.15 → 0.6.16

data/lib/vedeu/geometry/generic_coordinate.rb

@@ -28,13 +28,9 @@ module Vedeu
       #
       # @return [Fixnum]
       def dn
-        if d_dn <= 0
-          0
+        return 0 if d_dn <= 0
 
-        else
-          d + d_dn
-
-        end
+        d + d_dn
       end
       alias_method :xn, :dn
       alias_method :yn, :dn
@@ -137,13 +133,9 @@ module Vedeu
       #
       # @return [Fixnum]
       def dn_index
-        if d_dn < 1
-          0
+        return 0 if d_dn < 1
 
-        else
-          d_dn - 1
-
-        end
+        d_dn - 1
       end
 
       # Returns an array with all coordinates from d to dn.

data/lib/vedeu/geometry/geometry.rb

@@ -125,7 +125,7 @@ module Vedeu
 
         work = store
 
-        Vedeu.trigger(:_refresh_, name)
+        Vedeu.trigger(:_refresh_view_, name)
 
         work
       end

data/lib/vedeu/input/translator.rb

@@ -36,7 +36,11 @@ module Vedeu
 
       # @return [Hash<String => Symbol>]
       def symbols
-        @symbols ||= f_keys.merge!(ctrl_letters).merge!(specials)
+        @symbols ||= ctrl_letters.merge!(f_keys)
+                     .merge!(shift_f_keys)
+                     .merge!(ctrl_f_keys)
+                     .merge!(direction_keys)
+                     .merge!(specials)
       end
 
       # @return [Hash<String => Symbol>]
@@ -44,10 +48,13 @@ module Vedeu
         {
           "\u0001"  => :ctrl_a,
           "\u0002"  => :ctrl_b,
+
           "\u0003"  => :ctrl_c,
           "\u2404"  => :ctrl_c,
+
           "\u0004"  => :ctrl_d,
           "\u2403"  => :ctrl_d,
+
           "\u0005"  => :ctrl_e,
           "\u0006"  => :ctrl_f,
           "\u0007"  => :ctrl_g,
@@ -61,8 +68,10 @@ module Vedeu
           "\u0015"  => :ctrl_o,
           "\u0016"  => :ctrl_p,
           "\u0017"  => :ctrl_q,
+
           "\u0018"  => :ctrl_r,
           "\u2412"  => :ctrl_r,
+
           "\u0019"  => :ctrl_s,
           # "\u0020"  => :ctrl_t, # duplicates spacebar
           "\u0021"  => :ctrl_u,
@@ -81,41 +90,59 @@ module Vedeu
           "\eOQ"      => :f2,
           "\eOR"      => :f3,
           "\eOS"      => :f4,
-
           "\e[15~"    => :f5,
-          "\e[15;2~"  => :shift_f5,
-          "\e[15;5~"  => :ctrl_f5,
-
           "\e[17~"    => :f6,
-          "\e[17;2~"  => :shift_f6,
-          "\e[17;5~"  => :ctrl_f6,
-
           "\e[18~"    => :f7,
-          "\e[18;2~"  => :shift_f7,
-          "\e[18;5~"  => :ctrl_f7,
-
           "\e[19~"    => :f8,
-          "\e[19;2~"  => :shift_f8,
-          "\e[19;5~"  => :ctrl_f8,
-
           "\e[20~"    => :f9,
-          "\e[20;2~"  => :shift_f9,
-          "\e[20;5~"  => :ctrl_f9,
-
           "\e[21~"    => :f10,
-          "\e[21;2~"  => :shift_f10,
-          "\e[21;5~"  => :ctrl_f10,
-
           "\e[23~"    => :f11,
-          "\e[23;2~"  => :shift_f11,
-          "\e[23;5~"  => :ctrl_f11,
-
           "\e[24~"    => :f12,
+        }
+      end
+
+      # @return [Hash<String => Symbol>]
+      def shift_f_keys
+        {
+          "\e[15;2~"  => :shift_f5,
+          "\e[17;2~"  => :shift_f6,
+          "\e[18;2~"  => :shift_f7,
+          "\e[19;2~"  => :shift_f8,
+          "\e[20;2~"  => :shift_f9,
+          "\e[21;2~"  => :shift_f10,
+          "\e[23;2~"  => :shift_f11,
           "\e[24;2~"  => :shift_f12,
+        }
+      end
+
+      # @return [Hash<String => Symbol>]
+      def ctrl_f_keys
+        {
+          "\e[15;5~"  => :ctrl_f5,
+          "\e[17;5~"  => :ctrl_f6,
+          "\e[18;5~"  => :ctrl_f7,
+          "\e[19;5~"  => :ctrl_f8,
+          "\e[20;5~"  => :ctrl_f9,
+          "\e[21;5~"  => :ctrl_f10,
+          "\e[23;5~"  => :ctrl_f11,
           "\e[24;5~"  => :ctrl_f12,
         }
       end
 
+      # @return [Hash<String => Symbol>]
+      def direction_keys
+        {
+          "\e[B"    => :down,
+          "\u2193"  => :down,
+          "\e[D"    => :left,
+          "\u2190"  => :left,
+          "\e[C"    => :right,
+          "\u2192"  => :right,
+          "\e[A"    => :up,
+          "\u2191"  => :up,
+        }
+      end
+
       # @return [Hash<String => Symbol>]
       def specials
         {
@@ -124,8 +151,6 @@ module Vedeu
           "\u23CE"  => :carriage_return,
           "\e[3~"   => :delete,
           "\u232B"  => :delete,
-          "\e[B"    => :down,
-          "\u2193"  => :down,
           "\e[F"    => :end,
           "\r"      => :enter,
           "\n"      => :enter,
@@ -134,21 +159,15 @@ module Vedeu
           "\e[H"    => :home,
           "\eOH"    => :home,
           "\e[2~"   => :insert,
-          "\e[D"    => :left,
-          "\u2190"  => :left,
           "\u240A"  => :line_feed,
           "\e[5~"   => :page_up,
           "\e[6~"   => :page_down,
           "\e[1;2R" => :pause_break,
           "\e[1;2P" => :print_screen,
-          "\e[C"    => :right,
-          "\u2192"  => :right,
           "\e[1;2Q" => :scroll_lock,
           "\e[Z"    => :shift_tab,
           "\t"      => :tab,
           "\u21B9"  => :tab,
-          "\e[A"    => :up,
-          "\u2191"  => :up,
         }
       end
 

data/lib/vedeu/models/focus.rb

@@ -7,23 +7,26 @@ module Vedeu
     # is currently being focussed.
     #
     # @note
-    #   - Interfaces are added to the collection in the order they are defined.
+    #   - Interfaces are added to the collection in the order they are
+    #     defined.
     #   - If the interface definition contains `focus!`,
-    #     (see Vedeu::DSL::Interface#focus!) then that interface is prepended to
-    #     the list.
-    #   - If the `Vedeu.focus_by_name 'some_interface'` declaration is used,
-    #     then the list pointer (`current`) is set to the interface of
-    #     that name.
+    #     (see Vedeu::DSL::Interface#focus!) then that interface is
+    #     prepended to the list.
+    #   - If the `Vedeu.focus_by_name 'some_interface'` declaration is
+    #     used, then the list pointer (`current`) is set to the
+    #     interface of that name.
     #
     module Focus
 
       extend self
 
-      # Add an interface name to the focus list unless it is already registered.
+      # Add an interface name to the focus list unless it is already
+      # registered.
       #
       # @param name [String] The name of the interface.
-      # @param focus [Boolean] When true, prepends the interface name to the
-      #   collection, making that interface the currently focussed interface.
+      # @param focus [Boolean] When true, prepends the interface name
+      #   to the collection, making that interface the currently
+      #   focussed interface.
       # @return [Array] The collection of interface names.
       def add(name, focus = false)
         if registered?(name)
@@ -53,7 +56,8 @@ module Vedeu
       #   Vedeu.focus_by_name('name')
       #
       # @param name [String] The interface to focus; must be defined.
-      # @raise [Vedeu::Error::ModelNotFound] When the interface cannot be found.
+      # @raise [Vedeu::Error::ModelNotFound] When the interface cannot
+      #   be found.
       # @return [String] The name of the interface now in focus.
       def by_name(name)
         unless registered?(name)
@@ -79,7 +83,8 @@ module Vedeu
       end
       alias_method :focus, :current
 
-      # Returns a boolean indicating whether the named interface is focussed.
+      # Returns a boolean indicating whether the named interface is
+      # focussed.
       #
       # @example
       #   Vedeu.focussed?(name)
@@ -98,7 +103,8 @@ module Vedeu
         storage.empty?
       end
 
-      # Put the next interface relative to the current interfaces in focus.
+      # Put the next interface relative to the current interfaces in
+      # focus.
       #
       # @example
       #   Vedeu.trigger(:_focus_next_)
@@ -112,8 +118,8 @@ module Vedeu
       end
       alias_method :next, :next_item
 
-      # Put the next visible interface relative to the current interfaces in
-      # focus.
+      # Put the next visible interface relative to the current
+      # interfaces in focus.
       #
       # @return [String]
       def next_visible_item
@@ -128,7 +134,8 @@ module Vedeu
       end
       alias_method :focus_next, :next_visible_item
 
-      # Put the previous interface relative to the current interface in focus.
+      # Put the previous interface relative to the current interface
+      # in focus.
       #
       # @example
       #   Vedeu.trigger(:_focus_prev_)
@@ -143,8 +150,8 @@ module Vedeu
       alias_method :prev,     :prev_item
       alias_method :previous, :prev_item
 
-      # Put the previous visible interface relative to the current interfaces in
-      # focus.
+      # Put the previous visible interface relative to the current
+      # interfaces in focus.
       #
       # @return [String]
       def prev_visible_item
@@ -166,7 +173,8 @@ module Vedeu
         Vedeu.trigger(:_refresh_, current)
       end
 
-      # Returns a collection of the names of all the registered entities.
+      # Returns a collection of the names of all the registered
+      # entities.
       #
       # @return [Array]
       def registered
@@ -175,7 +183,8 @@ module Vedeu
         storage
       end
 
-      # Returns a boolean indicating whether the named model is registered.
+      # Returns a boolean indicating whether the named model is
+      # registered.
       #
       # @param name [String]
       # @return [Boolean]
@@ -194,8 +203,9 @@ module Vedeu
 
       private
 
-      # Return the name of the interface in focus after triggering the refresh
-      # event for that interface. Returns false when the storage is empty.
+      # Return the name of the interface in focus after triggering the
+      # refresh event for that interface. Returns false when the
+      # storage is empty.
       #
       # @return [String|FalseClass]
       def update
@@ -215,7 +225,8 @@ module Vedeu
         @storage ||= in_memory
       end
 
-      # Returns an empty collection ready for the storing of interface names.
+      # Returns an empty collection ready for the storing of interface
+      # names.
       #
       # @return [Array]
       def in_memory

data/lib/vedeu/models/group.rb

@@ -68,13 +68,14 @@ module Vedeu
         interfaces.sort { |a, b| a.zindex <=> b.zindex }.map(&:name)
       end
 
-      # Hide the named group of interfaces, or without a name, the group of the
-      # currently focussed interface. Useful for hiding part of that which is
-      # currently displaying in the terminal.
+      # Hide the named group of interfaces, or without a name, the
+      # group of the currently focussed interface. Useful for hiding
+      # part of that which is currently displaying in the terminal.
       #
       # @note
-      #   The action of showing a group will effectively clear the terminal and
-      #   show the new group, therefore hiding the group may not be necessary.
+      #   The action of showing a group will effectively clear the
+      #   terminal and show the new group, therefore hiding the group
+      #   may not be necessary.
       #
       # @example
       #   Vedeu.trigger(:_hide_group_, name)
@@ -117,8 +118,8 @@ module Vedeu
         Vedeu::Models::Group.new(attrs).store
       end
 
-      # Show the named group of interfaces, or without a name, the group of the
-      # currently focussed interface.
+      # Show the named group of interfaces, or without a name, the
+      # group of the currently focussed interface.
       #
       # @example
       #   Vedeu.trigger(:_show_group_, name)

data/lib/vedeu/models/interface.rb

@@ -61,8 +61,8 @@ module Vedeu
         end
       end
 
-      # Hide a named interface buffer, or without a name, the buffer of the
-      # currently focussed interface.
+      # Hide a named interface buffer, or without a name, the buffer
+      # of the currently focussed interface.
       #
       # @example
       #   Vedeu.hide_interface(name)
@@ -74,8 +74,8 @@ module Vedeu
         Vedeu.buffers.by_name(name).hide
       end
 
-      # Show the named interface buffer, or without a name, the buffer of the
-      # currently focussed interface.
+      # Show the named interface buffer, or without a name, the buffer
+      # of the currently focussed interface.
       #
       # @example
       #   Vedeu.show_interface(name)
@@ -94,13 +94,9 @@ module Vedeu
       #
       # @return [void]
       def toggle
-        if visible?
-          hide
+        return hide if visible?
 
-        else
-          show
-
-        end
+        show
       end
 
       private

data/lib/vedeu/models/toggleable.rb

@@ -36,16 +36,13 @@ module Vedeu
     #
     # @return [FalseClass|TrueClass]
     def toggle
-      if visible?
-        hide
+      return hide if visible?
 
-      else
-        show
-
-      end
+      show
     end
 
-    # Provide class methods to models to allow the visibility to be changed.
+    # Provide class methods to models to allow the visibility to be
+    # changed.
     #
     module ClassMethods
 
@@ -95,8 +92,8 @@ module Vedeu
 
     end # ClassMethods
 
-    # When this module is included in a class, provide ClassMethods as class
-    # methods for the class.
+    # When this module is included in a class, provide ClassMethods as
+    # class methods for the class.
     #
     # @param klass [Class]
     # @return [void]

data/lib/vedeu/models/views/char.rb

@@ -9,11 +9,12 @@ module Vedeu
 
     end # Chars
 
-    # A Char represents a single character of the terminal. It is a container
-    # for the a single character in a {Vedeu::Views::Stream}.
+    # A Char represents a single character of the terminal. It is a
+    # container for the a single character in a
+    # {Vedeu::Views::Stream}.
     #
-    # Though a multi-character String can be passed as a value, only the first
-    # character is returned in the escape sequence.
+    # Though a multi-character String can be passed as a value, only
+    # the first character is returned in the escape sequence.
     #
     class Char
 
@@ -39,8 +40,9 @@ module Vedeu
       # Returns a new instance of Vedeu::Views::Char.
       #
       # @param attributes [Hash]
-      # @option attributes border [NilClass|Symbol] A symbol representing the
-      #   border 'piece' this Vedeu::Views::Char represents.
+      # @option attributes border [NilClass|Symbol]
+      #   A symbol representing the border 'piece' this
+      #   {Vedeu::Views::Char} represents.
       # @option attributes colour [Vedeu::Colours::Colour]
       # @option attributes parent [Vedeu::Views::Line]
       # @option attributes position [Vedeu::Geometry::Position]
@@ -54,11 +56,11 @@ module Vedeu
         @value      = @attributes[:value]
       end
 
-      # When {Vedeu::Output::Viewport#show} has less lines that required to fill
-      # the visible area of the interface, it creates a line that contains a
-      # single {Vedeu::Views::Char} containing a space (0x20); later, attempts
-      # to call `#chars` on an expected {Vedeu::Views::Line} and fail; this
-      # method fixes that.
+      # When {Vedeu::Output::Viewport#show} has less lines that
+      # required to fill the visible area of the interface, it creates
+      # a line that contains a single {Vedeu::Views::Char} containing
+      # a space (0x20); later, attempts to call `#chars` on an
+      # expected {Vedeu::Views::Line} and fail; this method fixes that.
       #
       # @return [Array]
       def chars
@@ -91,13 +93,9 @@ module Vedeu
 
       # @return [String]
       def value
-        if border
-          Vedeu::EscapeSequences::Esc.border { @value }
+        return @value unless border
 
-        else
-          @value
-
-        end
+        Vedeu::EscapeSequences::Esc.border { @value }
       end
 
       # Returns the x position for the Vedeu::Views::Char when set.
@@ -117,9 +115,9 @@ module Vedeu
       # Returns a Hash of all the values before coercion.
       #
       # @note
-      #   From this hash we should be able to construct a new instance of
-      #   Vedeu::Views::Char, however, at the moment, `:parent` cannot be
-      #   coerced.
+      #   From this hash we should be able to construct a new instance
+      #   of {Vedeu::Views::Char}, however, at the moment, `:parent`
+      #   cannot be coerced.
       #
       # @return [Hash<Symbol => Hash, String>]
       def to_hash
@@ -152,17 +150,13 @@ module Vedeu
 
       # @return [Hash<Symbol => String>]
       def parent_to_hash
-        if parent
-          {
-            background: parent.background.to_s,
-            foreground: parent.foreground.to_s,
-            style:      parent.style.to_s,
-          }
-
-        else
-          {}
+        return {} unless parent
 
-        end
+        {
+          background: parent.background.to_s,
+          foreground: parent.foreground.to_s,
+          style:      parent.style.to_s,
+        }
       end
 
       # @return [Has<Symbol => Fixnum>]