vedeu 0.6.68 → 0.6.69

data/lib/vedeu/colours/translator.rb

@@ -168,7 +168,7 @@ module Vedeu
       #
       # @return [String]
       def numbered
-        "#{numbered_prefix}#{css_to_numbered}m".freeze
+        "#{prefix}5;#{css_to_numbered}m".freeze
       end
 
       # Returns a boolean indicated whether the colour is a valid
@@ -200,6 +200,13 @@ module Vedeu
         end
       end
 
+      # Returns part of an escape sequence.
+      #
+      # @return [String]
+      def rgb_prefix
+        "#{prefix}2;%s;%s;%sm".freeze
+      end
+
       # Returns a boolean indicating whether the numbered colour is
       # within the range of valid terminal numbered colours.
       #
@@ -266,9 +273,7 @@ module Vedeu
         fail Vedeu::Error::NotImplemented, 'Subclasses implement this.'.freeze
       end
       alias_method :named_codes,     :not_implemented
-      alias_method :numbered_prefix, :not_implemented
       alias_method :repository,      :not_implemented
-      alias_method :rgb_prefix,      :not_implemented
 
     end # Translator
 

data/lib/vedeu/cursors/all.rb

@@ -15,6 +15,7 @@ module Vedeu
 
 end # Vedeu
 
+require 'vedeu/cursors/coordinate'
 require 'vedeu/cursors/cursor'
 require 'vedeu/cursors/dsl'
 require 'vedeu/cursors/refresh'

data/lib/vedeu/{geometries → cursors}/coordinate.rb

@@ -1,6 +1,6 @@
 module Vedeu
 
-  module Geometries
+  module Cursors
 
     # Crudely corrects out of range values.
     #
@@ -8,13 +8,13 @@ module Vedeu
     #
     class Coordinate
 
-      # Return a new instance of Vedeu::Geometries::Coordinate.
+      # Return a new instance of Vedeu::Cursors::Coordinate.
       #
       # @param attributes [Hash<Symbol => Fixnum|String|Symbol>]
       # @option attributes name [String|Symbol]
       # @option attributes type [Symbol]
       # @option attributes offset [Fixnum]
-      # @return [Vedeu::Geometries::Coordinate]
+      # @return [Vedeu::Cursors::Coordinate]
       def initialize(attributes = {})
         defaults.merge!(attributes).each do |key, value|
           instance_variable_set("@#{key}", value)
@@ -172,6 +172,6 @@ module Vedeu
 
     end # Coordinate
 
-  end # Geometries
+  end # Cursors
 
 end # Vedeu

data/lib/vedeu/cursors/cursor.rb

@@ -264,11 +264,11 @@ module Vedeu
 
       # Determine correct x and y related coordinates.
       #
-      # @return [Vedeu::Geometries::Coordinate]
+      # @return [Vedeu::Cursors::Coordinate]
       def coordinate(offset, type)
-        Vedeu::Geometries::Coordinate.new(name:   name,
-                                          offset: offset,
-                                          type:   type)
+        Vedeu::Cursors::Coordinate.new(name:   name,
+                                       offset: offset,
+                                       type:   type)
       end
 
       # The default values for a new instance of this class.
@@ -335,15 +335,15 @@ module Vedeu
 
   # :nocov:
 
-  # See {file:docs/events/visibility.md#\_hide_cursor_}
+  # See {file:docs/cursors.md#vedeuhide_cursor__}
   Vedeu.bind(:_hide_cursor_) { |name| Vedeu.hide_cursor(name) }
-  # Vedeu.bind_alias(:_cursor_hide_, :_hide_cursor_)
+  Vedeu.bind_alias(:_cursor_hide_, :_hide_cursor_)
 
-  # See {file:docs/events/visibility.md#\_show_cursor_}
+  # See {file:docs/cursors.md#vedeushow_cursor__}
   Vedeu.bind(:_show_cursor_) { |name| Vedeu.show_cursor(name) }
-  # Vedeu.bind_alias(:_cursor_show_, :_show_cursor_)
+  Vedeu.bind_alias(:_cursor_show_, :_show_cursor_)
 
-  # See {file:docs/events/visibility.md#\_toggle_cursor_}
+  # See {file:docs/cursors.md#vedeutoggle_cursor__}
   Vedeu.bind(:_toggle_cursor_) { |name| Vedeu.toggle_cursor(name) }
 
   # See {file:docs/cursors.md}
@@ -380,7 +380,7 @@ module Vedeu
 
     Vedeu.trigger(:_refresh_cursor_, name)
   end
-  # Vedeu.bind_alias(:_cursor_reset_, :_cursor_origin_)
+  Vedeu.bind_alias(:_cursor_reset_, :_cursor_origin_)
 
   # See {file:docs/cursors.md}
   Vedeu.bind(:_cursor_position_) do |name|

data/lib/vedeu/cursors/dsl.rb

@@ -4,38 +4,14 @@ module Vedeu
 
     # Control the visibility of the cursor for each interface/view.
     #
+    # See {file:docs/cursors.md#interface_cursors}
+    # See {file:docs/cursors.md#view_cursors}
     module DSL
 
       # Set the cursor visibility on an interface.
       #
       # @param value [Boolean] Any value other than nil or false will
-      #   evaluate
-      #   to true.
-      #
-      # @example
-      #   Vedeu.interface :my_interface do
-      #     cursor  true  # => show the cursor for this interface
-      #     # or...
-      #     cursor  :show # => both of these are equivalent to line
-      #                   #    above
-      #     # or...
-      #     cursor!       #
-      #     # ...
-      #   end
-      #
-      #   Vedeu.interface :my_interface do
-      #     cursor false # => hide the cursor for this interface
-      #     # or...
-      #     cursor nil   # => as above
-      #     # ...
-      #   end
-      #
-      #   Vedeu.view :my_interface do
-      #     cursor true # => Specify the visibility of the cursor when
-      #                 #    the view is rendered.
-      #     # ...
-      #   end
-      #
+      #   evaluate to true.
       # @return [Vedeu::Cursors::Cursor]
       def cursor(value = true)
         boolean = value ? true : false

data/lib/vedeu/cursors/reposition.rb

@@ -67,11 +67,11 @@ module Vedeu
       #
       # @param offset []
       # @param type []
-      # @return [Vedeu::Geometries::Coordinate]
+      # @return [Vedeu::Cursors::Coordinate]
       def coordinate(offset, type)
-        Vedeu::Geometries::Coordinate.new(name:   name,
-                                          offset: offset,
-                                          type:   type)
+        Vedeu::Cursors::Coordinate.new(name:   name,
+                                       offset: offset,
+                                       type:   type)
       end
 
       # @return [Vedeu::Cursors::Cursor]

data/lib/vedeu/esc/esc.rb

@@ -1,7 +1,3 @@
-require 'vedeu/esc/actions'
-require 'vedeu/esc/borders'
-require 'vedeu/esc/colours'
-
 module Vedeu
 
   module EscapeSequences
@@ -57,13 +53,24 @@ module Vedeu
         "#{border_on}#{yield}#{border_off}".freeze
       end
 
-      private
-
       # @return [String]
       def clear
         "#{colour_reset}\e[2J".freeze
       end
 
+      # @return [String]
+      def screen_init
+        "#{reset}#{clear}#{hide_cursor}#{enable_mouse}".freeze
+      end
+
+      # @return [String]
+      def screen_exit
+        "#{disable_mouse}#{show_cursor}#{screen_colour_reset}#{reset}" \
+        "#{last_character_position}\n".freeze
+      end
+
+      private
+
       # @return [String]
       def clear_line
         "#{colour_reset}\e[2K".freeze
@@ -101,22 +108,11 @@ module Vedeu
         "#{underline_off}#{bold_off}#{positive}".freeze
       end
 
-      # @return [String]
-      def screen_init
-        "#{reset}#{clear}#{hide_cursor}#{enable_mouse}".freeze
-      end
-
       # @return [String]
       def screen_colour_reset
         "#{fg_reset}#{bg_reset}".freeze
       end
 
-      # @return [String]
-      def screen_exit
-        "#{disable_mouse}#{show_cursor}#{screen_colour_reset}#{reset}" \
-        "#{last_character_position}\n".freeze
-      end
-
       # @return [String]
       def last_character_position
         Vedeu::Geometries::Position[Vedeu.height, Vedeu.width].to_s

data/lib/vedeu/geometries/alignment/all.rb

@@ -0,0 +1,11 @@
+module Vedeu
+
+  module Geometries
+
+  end # Geometries
+
+end # Vedeu
+
+require 'vedeu/geometries/alignment/alignment'
+require 'vedeu/geometries/alignment/horizontal_alignment'
+require 'vedeu/geometries/alignment/vertical_alignment'

data/lib/vedeu/geometries/all.rb

@@ -13,19 +13,11 @@ module Vedeu
 
 end # Vedeu
 
-require 'vedeu/geometries/alignment'
-require 'vedeu/geometries/horizontal_alignment'
-require 'vedeu/geometries/vertical_alignment'
-require 'vedeu/geometries/area'
-require 'vedeu/geometries/coordinate'
-require 'vedeu/geometries/dimension'
-require 'vedeu/geometries/x_dimension'
-require 'vedeu/geometries/y_dimension'
-require 'vedeu/geometries/validator'
-require 'vedeu/geometries/dsl'
-require 'vedeu/geometries/coordinate'
+require 'vedeu/geometries/alignment/all'
+require 'vedeu/geometries/area/all'
+require 'vedeu/geometries/dsl/all'
+
 require 'vedeu/geometries/geometry'
-require 'vedeu/geometries/grid'
 require 'vedeu/geometries/move'
 require 'vedeu/geometries/position'
 require 'vedeu/geometries/repository'

data/lib/vedeu/geometries/area/all.rb

@@ -0,0 +1,12 @@
+module Vedeu
+
+  module Geometries
+
+  end # Geometries
+
+end # Vedeu
+
+require 'vedeu/geometries/area/area'
+require 'vedeu/geometries/area/dimension'
+require 'vedeu/geometries/area/x_dimension'
+require 'vedeu/geometries/area/y_dimension'

data/lib/vedeu/geometries/dsl/all.rb

@@ -0,0 +1,11 @@
+module Vedeu
+
+  module Geometries
+
+  end # Geometries
+
+end # Vedeu
+
+require 'vedeu/geometries/dsl/grid'
+require 'vedeu/geometries/dsl/validator'
+require 'vedeu/geometries/dsl/dsl'

data/lib/vedeu/input/raw.rb

@@ -2,6 +2,11 @@ module Vedeu
 
   module Input
 
+    # Handle input when terminal is in :raw (character at a time)
+    # mode.
+    #
+    # @api private
+    #
     class Raw
 
       # @see Vedeu::Input::Raw#initialize

data/lib/vedeu/input/read.rb

@@ -78,12 +78,12 @@ module Vedeu
 
       # @return [String]
       def mouse_off
-        Vedeu::EscapeSequences::Esc.string('mouse_x10_off')
+        Vedeu::EscapeSequences::Esc.mouse_x10_off
       end
 
       # @return [String]
       def show_cursor
-        Vedeu::EscapeSequences::Esc.string('show_cursor')
+        Vedeu::EscapeSequences::Esc.show_cursor
       end
 
       # @return [String]

data/lib/vedeu/output/compressor.rb

@@ -61,6 +61,7 @@ module Vedeu
                      end
       end
 
+      # @return [Array<void>|String]
       def cached
         cached_original   = Vedeu::Output::CompressorCache.read(:original)
         cached_compressed = Vedeu::Output::CompressorCache.read(:compressed)
@@ -91,7 +92,6 @@ module Vedeu
             ].join
           end.join
 
-
           Vedeu.log(type:    :compress,
                     message: "#{message} -> #{out.size} characters".freeze)
 

data/lib/vedeu/output/compressor_cache.rb

@@ -2,6 +2,13 @@ module Vedeu
 
   module Output
 
+    # Store a copy of the data last processed by
+    # {Vedeu::Output::Compressor}. Both the original content and the
+    # compressed versions are kept (unless modified) to speed up the
+    # rendering of the display.
+    #
+    # @api private
+    #
     module CompressorCache
 
       extend self

data/lib/vedeu/terminal/terminal.rb

@@ -60,7 +60,7 @@ module Vedeu
     def initialize_screen(mode)
       Vedeu.log(message: "Terminal entering '#{mode}' mode".freeze)
 
-      output(Vedeu::EscapeSequences::Esc.string('screen_init'))
+      output(Vedeu::EscapeSequences::Esc.screen_init)
 
       yield if block_given?
     end
@@ -72,7 +72,7 @@ module Vedeu
     #
     # @return [String]
     def clear
-      output(Vedeu::EscapeSequences::Esc.string('clear'))
+      output(Vedeu::EscapeSequences::Esc.clear)
     end
 
     # Attempts to tidy up the screen just before the application
@@ -82,7 +82,7 @@ module Vedeu
     #
     # @return [String]
     def restore_screen
-      output(Vedeu::EscapeSequences::Esc.string('screen_exit'))
+      output(Vedeu::EscapeSequences::Esc.screen_exit)
     end
 
     # Sets the cursor to be visible unless in raw mode, whereby it
@@ -90,7 +90,7 @@ module Vedeu
     #
     # @return [String]
     def set_cursor_mode
-      output(Vedeu::EscapeSequences::Esc.string('show_cursor')) unless raw_mode?
+      output(Vedeu::EscapeSequences::Esc.show_cursor) unless raw_mode?
     end
 
     # Returns a coordinate tuple of the format [y, x], where `y` is

data/lib/vedeu/version.rb

@@ -1,6 +1,6 @@
 module Vedeu
 
   # The current version of Vedeu.
-  VERSION = '0.6.68'.freeze
+  VERSION = '0.6.69'.freeze
 
 end

data/test/lib/vedeu/{geometries/coordinate.rb → cursors/coordinate_test.rb}

@@ -2,11 +2,11 @@ require 'test_helper'
 
 module Vedeu
 
-  module Geometries
+  module Cursors
 
     describe Coordinate do
 
-      let(:described)  { Vedeu::Geometries::Coordinate }
+      let(:described)  { Vedeu::Cursors::Coordinate }
       let(:instance)   { described.new(attributes) }
       let(:attributes) {
         {
@@ -38,7 +38,7 @@ module Vedeu
         # it { skip }
       end
 
-      # let(:described) { Vedeu::Geometries::Coordinate }
+      # let(:described) { Vedeu::Cursors::Coordinate }
       # let(:instance)  { described.new(_name, oy, ox) }
       # let(:_name)     { 'coordinate' }
       # let(:oy)        { 0 }
@@ -162,6 +162,6 @@ module Vedeu
 
     end # Coordinate
 
-  end # Geometries
+  end # Cursors
 
 end # Vedeu