vedeu 0.6.34 → 0.6.35

data/lib/vedeu/geometry/dsl.rb

@@ -73,6 +73,7 @@ module Vedeu
     #
     class DSL
 
+      include Vedeu::Common
       include Vedeu::DSL
       include Vedeu::DSL::Use
 
@@ -94,6 +95,100 @@ module Vedeu
         Vedeu::Geometry::Geometry.build(name: name, &block).store
       end
 
+      # Instructs Vedeu to align the interface/view either left,
+      # centre or right. A width is also required so that required
+      # coordinates are calculated correctly.
+      #
+      #   Vedeu.geometry :some_interface do
+      #     # :some_value must be one of: :left, :none, :center,
+      #     #   :centre, or :right
+      #     # `width` is a positive integer, e.g. 30
+      #     alignment(:some_value, width)
+      #
+      #     # ... some code
+      #   end
+      #
+      # @param value [Symbol] One of :center, :centre, :left, :none,
+      #   :right.
+      # @param width [Fixnum] The width of the aligned interface/view.
+      # @raise [Vedeu::Error::InvalidSyntax] When the value or width
+      #   is not given.
+      # @return [Vedeu::Geometry::Geometry]
+      def alignment(value, width)
+        fail Vedeu::Error::InvalidSyntax,
+             'No alignment given. Valid values are :center, :centre, :left, ' \
+             ':none, :right.'.freeze unless present?(value)
+        fail Vedeu::Error::InvalidSyntax,
+             'No width given.'.freeze unless present?(width)
+
+        model.alignment = Vedeu::Geometry::Alignment.align(value)
+        model.width     = width
+        model
+      end
+
+      # Align the interface/view centrally.
+      #
+      #   Vedeu.geometry :some_interface do
+      #     # `width` is a positive integer, e.g. 30
+      #     align_centre 30
+      #
+      #     # this is the same as:
+      #     # alignment(:centre, 30)
+      #
+      #     # ... some code
+      #   end
+      #
+      #   # Also allows `align_center` if preferred.
+      #
+      # @param width [Fixnum] The number of characters/columns.
+      # @raise [Vedeu::Error::InvalidSyntax] When the width is not
+      #   given.
+      # @return [Vedeu::Geometry::Geometry]
+      def align_centre(width)
+        alignment(:centre, width)
+      end
+      alias_method :align_center, :align_centre
+
+      # Align the interface/view to the left.
+      #
+      #   Vedeu.geometry :some_interface do
+      #     # `width` is a positive integer, e.g. 30
+      #     align_left 30
+      #
+      #     # this is the same as:
+      #     # alignment(:left, 30)
+      #
+      #     # ... some code
+      #   end
+      #
+      # @param width [Fixnum] The number of characters/columns.
+      # @raise [Vedeu::Error::InvalidSyntax] When the width is not
+      #   given.
+      # @return [Vedeu::Geometry::Geometry]
+      def align_left(width)
+        alignment(:left, width)
+      end
+
+      # Align the interface/view to the right.
+      #
+      #   Vedeu.geometry :some_interface do
+      #     # `width` is a positive integer, e.g. 30
+      #     align_right 30
+      #
+      #     # this is the same as:
+      #     # alignment(:right, 30)
+      #
+      #     # ... some code
+      #   end
+      #
+      # @param width [Fixnum] The number of characters/columns.
+      # @raise [Vedeu::Error::InvalidSyntax] When the width is not
+      #   given.
+      # @return [Vedeu::Geometry::Geometry]
+      def align_right(width)
+        alignment(:right, width)
+      end
+
       # Instructs Vedeu to calculate x and y geometry automatically
       # based on the centre character of the terminal, the width and
       # the height.
@@ -178,7 +273,7 @@ module Vedeu
       #     # ... some code
       #   end
       #
-      # @param value [Fixnum]
+      # @param value [Fixnum] The number of characters/columns.
       # @return [Fixnum]
       def width(value)
         model.width = proc { value }

data/lib/vedeu/geometry/geometry.rb

@@ -31,6 +31,10 @@ module Vedeu
                      :height,
                      :width
 
+      # @!attribute [rw] alignment
+      # @return [Symbol]
+      attr_accessor :alignment
+
       # @!attribute [rw] centred
       # @return [Boolean]
       attr_accessor :centred
@@ -101,6 +105,7 @@ module Vedeu
       # @return [Hash]
       def attributes
         {
+          alignment:  @alignment,
           client:     @client,
           centred:    @centred,
           height:     height,
@@ -222,6 +227,7 @@ module Vedeu
       # @return [Hash<Symbol => Boolean, Fixnum>]
       def area_attributes
         {
+          alignment: @alignment,
           centred:   @centred,
           maximised: @maximised,
           x:         @x.is_a?(Proc)      ? @x.call      : @x,
@@ -234,8 +240,9 @@ module Vedeu
       end
 
       # When moving an interface;
-      # 1) Reset the centred and maximised states to false; it wont be
-      #    centred if moved, and cannot be moved if maximised.
+      # 1) Reset the alignment, centred and maximised states to false;
+      #    it wont be aligned to a side if moved, nor centred if
+      #    moved, and cannot be moved if maximised.
       # 2) Get the current coordinates of the interface, then:
       # 3) Override the attributes with the new coordinates for
       #    desired movement; these are usually +/- 1 of the current
@@ -250,7 +257,9 @@ module Vedeu
       # @option coordinates yn [Fixnum] The ending row/line position.
       # @return [Hash<Symbol => Boolean, Fixnum>]
       def move(coordinates = {})
-        attrs = attributes.merge!(centred: false, maximised: false)
+        attrs = attributes.merge!(alignment: :none,
+                                  centred:   false,
+                                  maximised: false)
                 .merge!(coordinates)
 
         Vedeu::Geometry::Geometry.store(attrs)
@@ -261,6 +270,7 @@ module Vedeu
       # @return [Hash]
       def defaults
         {
+          alignment:  Vedeu::Geometry::Alignment.align(:none),
           client:     nil,
           centred:    false,
           height:     nil,

data/lib/vedeu/input/translator.rb

@@ -23,7 +23,7 @@ module Vedeu
 
       # @return [Symbol]
       def translate
-        symbols.fetch(code, code)
+        Vedeu::KEY_TABLE[code] || code
       end
 
       protected
@@ -32,147 +32,98 @@ module Vedeu
       # @return [String]
       attr_reader :code
 
-      private
-
-      # @return [Hash<String => Symbol>]
-      def symbols
-        @symbols ||= ctrl_letters.merge!(f_keys)
-                     .merge!(shift_f_keys)
-                     .merge!(ctrl_f_keys)
-                     .merge!(direction_keys)
-                     .merge!(specials)
-      end
-
-      # @return [Hash<String => Symbol>]
-      def ctrl_letters
-        {
-          "\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,
-          "\u0008"  => :ctrl_h,
-          # "\u0009"  => :ctrl_i, # duplicates tab
-          "\u0010"  => :ctrl_j, # produces "\n"
-          "\u0011"  => :ctrl_k,
-          "\u0012"  => :ctrl_l,
-          "\u0013"  => :ctrl_m,
-          "\u0014"  => :ctrl_n,
-          "\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,
-          "\u0022"  => :ctrl_v,
-          "\u0023"  => :ctrl_w,
-          "\u0024"  => :ctrl_x,
-          "\u0025"  => :ctrl_y,
-          "\u0026"  => :ctrl_z,
-        }
-      end
-
-      # @return [Hash<String => Symbol>]
-      def f_keys
-        {
-          "\eOP"      => :f1,
-          "\eOQ"      => :f2,
-          "\eOR"      => :f3,
-          "\eOS"      => :f4,
-          "\e[15~"    => :f5,
-          "\e[17~"    => :f6,
-          "\e[18~"    => :f7,
-          "\e[19~"    => :f8,
-          "\e[20~"    => :f9,
-          "\e[21~"    => :f10,
-          "\e[23~"    => :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
-        {
-          "\u007F"  => :backspace,
-          "\u2408"  => :backspace,
-          "\u23CE"  => :carriage_return,
-          "\e[3~"   => :delete,
-          "\u232B"  => :delete,
-          "\e[F"    => :end,
-          "\r"      => :enter,
-          "\n"      => :enter,
-          "\e"      => :escape,
-          "\u238B"  => :escape,
-          "\e[H"    => :home,
-          "\eOH"    => :home,
-          "\e[2~"   => :insert,
-          "\u240A"  => :line_feed,
-          "\e[5~"   => :page_up,
-          "\e[6~"   => :page_down,
-          "\e[1;2R" => :pause_break,
-          "\e[1;2P" => :print_screen,
-          "\e[1;2Q" => :scroll_lock,
-          "\e[Z"    => :shift_tab,
-          "\t"      => :tab,
-          "\u21B9"  => :tab,
-        }
-      end
-
     end # Translator
 
   end # Input
 
+  KEY_TABLE = {
+    "\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,
+    "\u0008" => :ctrl_h,
+    # "\u0009" => :ctrl_i, # duplicates tab
+    "\u0010" => :ctrl_j, # produces "\n"
+    "\u0011" => :ctrl_k,
+    "\u0012" => :ctrl_l,
+    "\u0013" => :ctrl_m,
+    "\u0014" => :ctrl_n,
+    "\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,
+    "\u0022" => :ctrl_v,
+    "\u0023" => :ctrl_w,
+    "\u0024" => :ctrl_x,
+    "\u0025" => :ctrl_y,
+    "\u0026" => :ctrl_z,
+    "\eOP" => :f1,
+    "\eOQ" => :f2,
+    "\eOR" => :f3,
+    "\eOS" => :f4,
+    "\e[15~" => :f5,
+    "\e[17~" => :f6,
+    "\e[18~" => :f7,
+    "\e[19~" => :f8,
+    "\e[20~" => :f9,
+    "\e[21~" => :f10,
+    "\e[23~" => :f11,
+    "\e[24~" => :f12,
+    "\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,
+    "\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,
+    "\e[B" => :down,
+    "\u2193" => :down,
+    "\e[D" => :left,
+    "\u2190" => :left,
+    "\e[C" => :right,
+    "\u2192" => :right,
+    "\e[A" => :up,
+    "\u2191" => :up,
+    "\u007F" => :backspace,
+    "\u2408" => :backspace,
+    "\u23CE" => :carriage_return,
+    "\e[3~" => :delete,
+    "\u232B" => :delete,
+    "\e[F" => :end,
+    "\r" => :enter,
+    "\n" => :enter,
+    "\e" => :escape,
+    "\u238B" => :escape,
+    "\e[H" => :home,
+    "\eOH" => :home,
+    "\e[2~" => :insert,
+    "\u240A" => :line_feed,
+    "\e[5~" => :page_up,
+    "\e[6~" => :page_down,
+    "\e[1;2R" => :pause_break,
+    "\e[1;2P" => :print_screen,
+    "\e[1;2Q" => :scroll_lock,
+    "\e[Z" => :shift_tab,
+    "\t" => :tab,
+    "\u21B9" => :tab,
+  }.freeze
+
 end # Vedeu

data/lib/vedeu/models/focus.rb

@@ -33,19 +33,12 @@ module Vedeu
           return storage unless focus
 
           by_name(name)
-          storage
 
         else
           Vedeu.log(type:    :store,
                     message: "Storing focus entry: '#{name}'".freeze)
 
-          if focus
-            storage.unshift(name)
-
-          else
-            storage.push(name)
-
-          end
+          focus ? storage.unshift(name) : storage.push(name)
         end
       end
 
@@ -63,11 +56,7 @@ module Vedeu
       # @return [String|Symbol] The name of the interface now in
       #   focus.
       def by_name(name)
-        unless registered?(name)
-          fail Vedeu::Error::ModelNotFound,
-               "Cannot focus '#{name}' as this interface has not been " \
-               'registered.'.freeze
-        end
+        not_registered! unless registered?(name)
 
         storage.rotate!(storage.index(name))
 
@@ -84,9 +73,7 @@ module Vedeu
       def current
         return storage[0] unless empty?
 
-        fail Vedeu::Error::Fatal,
-             'No interfaces or views have been registered, therefore the ' \
-             'focus table is empty.'.freeze
+        no_interfaces_registered!
       end
       alias_method :focus, :current
 
@@ -212,6 +199,20 @@ module Vedeu
 
       private
 
+      # @raise [Vedeu::Error::Fatal]
+      def no_interfaces_registered!
+        fail Vedeu::Error::Fatal,
+             'No interfaces or views have been registered, therefore the ' \
+             'focus table is empty.'.freeze
+      end
+
+      # @raise [Vedeu::Error::ModelNotFound]
+      def not_registered!
+        fail Vedeu::Error::ModelNotFound,
+             "Cannot focus '#{name}' as this interface has not been " \
+             'registered.'.freeze
+      end
+
       # Return the name of the interface in focus after triggering the
       # refresh event for that interface. Returns false when the
       # storage is empty.
@@ -220,8 +221,7 @@ module Vedeu
       def update
         return false if empty?
 
-        Vedeu.log(type:    :info,
-                  message: "Interface in focus: '#{current}'".freeze)
+        Vedeu.log(message: "Interface in focus: '#{current}'".freeze)
 
         refresh