vedeu 0.2.12 → 0.3.0

data/lib/vedeu/output/viewport.rb

@@ -8,6 +8,30 @@ module Vedeu
   #
   class Viewport
 
+    extend Forwardable
+
+    def_delegators :interface,
+      :border,
+      :border?,
+      :geometry,
+      :lines,
+      :lines?,
+      :cursor
+
+    def_delegators :border,
+      :bottom?,
+      :left?,
+      :right?,
+      :top?
+
+    def_delegators :cursor,
+      :ox,
+      :oy
+
+    def_delegators :geometry,
+      :height,
+      :width
+
     # @see Viewport#show
     def self.show(interface)
       new(interface).show
@@ -19,8 +43,6 @@ module Vedeu
     # @return [Viewport]
     def initialize(interface)
       @interface = interface
-      @top       = 0
-      @left      = 0
     end
 
     # Returns the visible content for the interface.
@@ -32,14 +54,18 @@ module Vedeu
     #
     # @return [Array]
     def show
-      line_adjustment
-      column_adjustment
-
-      return [] unless content?
+      return [] unless lines?
 
       line_pad.map { |line| column_pad(line) }.compact
     end
 
+    # Returns a string representation of the viewport.
+    #
+    # @return [String]
+    def to_s
+      show.map(&:join).join("\n")
+    end
+
     private
 
     attr_reader :interface
@@ -49,13 +75,13 @@ module Vedeu
     #
     # @return [Array<Array<String>>]
     def line_pad
-      cl = content[lines] || []
+      visible_lines = lines[rows] || []
 
-      if cl.size < (height + 1)
-        cl + [" "] * ((height + 1) - cl.size)
+      if visible_lines.size < height
+        visible_lines + [" "] * (height - visible_lines.size)
 
       else
-        cl
+        visible_lines
 
       end
     end
@@ -66,123 +92,81 @@ module Vedeu
     # @param line [Array<String>]
     # @return [Array<String>]
     def column_pad(line)
-      chars = line.chars[columns] || [" "]
+      visible_columns = line.chars[columns] || []
 
-      if chars.size < width
-        chars + [" "] * (width - chars.size)
+      if visible_columns.size < width
+        visible_columns + [" "] * (width - visible_columns.size)
 
       else
-        chars
+        visible_columns
 
       end
     end
 
-    # Scrolls the content vertically when the stored y offset for the interface
-    # is outside of the visible area.
+    # Using the current cursor's x position, return a range of visible lines.
+    #
+    # Scrolls the content horizontally when the stored cursor's x position for
+    # the interface is outside of the visible area.
     #
     # @note
-    #   @top = [value, 0].max # this allows us to set a top that is greater than
-    #                         # the content height.
+    #   [value, 0].max # this allows us to set a left that is greater
+    #                  # than the content width.
     #
-    #   @top = [[value, (content_height - height)].min, 0].max
-    #                         # this does not allow us to have an offset greater
-    #                         # than the content height.
+    #   [[value, (content_width - width)].min, 0].max
+    #                  # this does not allow us to have a position
+    #                  # greater than the content width.
     #
-    # @return [Fixnum]
-    def line_adjustment
-      if offset.y < 0
-        @top = [offset.y, 0].max
+    # @return [Range]
+    def rows
+      top = if oy >= bordered_height
+        [(oy - bordered_height), 0].max
 
-      elsif offset.y > height
-        @top = [(offset.y - height), 0].max
+      else
+        0
 
       end
+
+      top..(top + (height - 1))
     end
 
-    # Scrolls the content horizontally when the stored x offset for the
+    # Using the current cursor's y position, return a range of visible columns.
+    #
+    # Scrolls the content vertically when the stored cursor's y position for the
     # interface is outside of the visible area.
     #
     # @note
-    #   @left = [value, 0].max # this allows us to set a left that is greater
-    #                          # than the content width.
-    #
-    #   @left = [[value, (content_width - width)].min, 0].max
-    #                         # this does not allow us to have an offset greater
-    #                         # than the content width.
-    #
-    # @return [Fixnum]
-    def column_adjustment
-      if offset.x < 0
-        @left = [offset.x, 0].max
-
-      elsif offset.x > width
-        @left = [(offset.x - width), 0].max
-
-      end
-    end
-
-    # Using the current x offset, return a range of visible lines.
+    #   [value, 0].max # this allows us to set a top that is greater than
+    #                  # the content height.
     #
-    # @return [Range]
-    def lines
-      @top..(@top + height)
-    end
-
-    # Using the current y offset, return a range of visible columns.
+    #   [[value, (content_height - height)].min, 0].max
+    #                  # this does not allow us to have a position
+    #                  # greater than the content height.
     #
     # @return [Range]
     def columns
-      @left..(@left + width)
-    end
-
-    # Returns the height of the content, or when no content, the visible height
-    # of the interface.
-    #
-    # @return [Fixnum]
-    def content_height
-      return height unless content?
+      left = if ox >= bordered_width
+        [(ox - bordered_width), 0].max
 
-      [content.size, height].max
-    end
+      else
+        0
 
-    # Returns the width of the content, or when no content, the visible width of
-    # the interface.
-    #
-    # @return [Fixnum]
-    def content_width
-      return width unless content?
+      end
 
-      [content_maximum_line_length, width].max
+      left..(left + (width - 1))
     end
 
-    # Returns the character length of the longest line for this interface.
-    #
     # @return [Fixnum]
-    def content_maximum_line_length
-      content.map { |line| line.size }.max
-    end
-
-    # Return a boolean indicating whether this interface currently has content.
-    #
-    # @return [Boolean]
-    def content?
-      content.any?
-    end
-
-    def content
-      interface.content
-    end
+    def bordered_width
+      return border.width if border?
 
-    def offset
-      interface.offset
+      width
     end
 
-    def width
-      interface.width - 1
-    end
+    # @return [Fixnum]
+    def bordered_height
+      return border.height if border?
 
-    def height
-      interface.height - 1
+      height
     end
 
   end # Viewport

data/lib/vedeu/output/writer.rb

@@ -0,0 +1,29 @@
+module Vedeu
+
+  class Writer
+
+    attr_reader :writers
+
+    def self.[](*args)
+      new(args)
+    end
+
+    def initialize(writers)
+      @writers = writers
+    end
+
+    def ==(other)
+      writers == other.writers
+    end
+
+    def +(other)
+      Writer[*(writers + other.writers)]
+    end
+
+    def write(stream)
+      @writers.each { |writer| writer.write(stream) }
+    end
+
+  end # Consoles
+
+end # Vedeu

data/lib/vedeu/presentation/all.rb

@@ -0,0 +1,9 @@
+require 'vedeu/presentation/translator'
+require 'vedeu/presentation/background'
+require 'vedeu/presentation/colour'
+require 'vedeu/presentation/foreground'
+require 'vedeu/presentation/style'
+require 'vedeu/presentation/presentation'
+
+module Vedeu
+end # Vedeu

data/lib/vedeu/{colours → presentation}/background.rb

@@ -15,7 +15,7 @@ module Vedeu
     #
     # @return [String]
     def named
-      ["\e[", background_codes[colour], 'm'].join
+      ["\e[", Esc.background_codes[colour], 'm'].join
     end
 
     # Returns an escape sequence.
@@ -38,14 +38,6 @@ module Vedeu
       end
     end
 
-    # Produces the background named colour escape sequence hash from the
-    # foreground escape sequence hash.
-    #
-    # @return [Hash]
-    def background_codes
-      Esc.codes.inject({}) { |h, (k, v)| h.merge(k => v + 10) }
-    end
-
   end # Background
 
 end # Vedeu

data/lib/vedeu/{colours → presentation}/colour.rb

@@ -1,3 +1,5 @@
+require 'vedeu/support/coercions'
+
 module Vedeu
 
   # Provides a container for terminal escape sequences controlling the
@@ -7,28 +9,39 @@ module Vedeu
   # @api private
   class Colour
 
-    attr_reader :attributes
+    include Vedeu::Coercions
+
+    attr_reader :attributes,
+      :background,
+      :foreground
 
     # Returns a new instance of Colour.
     #
     # @param attributes [Hash]
+    # @option attributes background [String]
+    # @option attributes foreground [String]
     # @return [Colour]
     def initialize(attributes = {})
       @attributes = defaults.merge(attributes)
+
+      @background = Background.escape_sequence(@attributes[:background])
+      @foreground = Foreground.escape_sequence(@attributes[:foreground])
     end
 
-    # Converts the `:foreground` attribute into a terminal escape sequence.
+    # Converts the value into a terminal escape sequence.
     #
+    # @param value [String]
     # @return [String]
-    def foreground
-      @foreground ||= Foreground.escape_sequence(attributes[:foreground])
+    def foreground=(value)
+      @foreground = Foreground.escape_sequence(value)
     end
 
-    # Converts the `:background` attribute into a terminal escape sequence.
+    # Converts the value into a terminal escape sequence.
     #
+    # @param value [String]
     # @return [String]
-    def background
-      @background ||= Background.escape_sequence(attributes[:background])
+    def background=(value)
+      @background = Background.escape_sequence(value)
     end
 
     # Returns both or either of the converted attributes into a single escape
@@ -41,7 +54,7 @@ module Vedeu
 
     private
 
-    # The default values for a new instance of Colour.
+    # The default values for a new instance of this class.
     #
     # @return [Hash]
     def defaults

data/lib/vedeu/{colours → presentation}/foreground.rb

@@ -1,3 +1,7 @@
+require 'vedeu/configuration/configuration'
+require 'vedeu/presentation/translator'
+require 'vedeu/support/esc'
+
 module Vedeu
 
   # The class represents one half (the other, can be found at
@@ -15,7 +19,7 @@ module Vedeu
     #
     # @return [String]
     def named
-      ["\e[", foreground_codes[colour], 'm'].join
+      ["\e[", Esc.foreground_codes[colour], 'm'].join
     end
 
     # Returns an escape sequence.
@@ -38,14 +42,6 @@ module Vedeu
       end
     end
 
-    # Produces the foreground named colour escape sequence hash from
-    # {Vedeu::Translator#codes}
-    #
-    # @return [Hash]
-    def foreground_codes
-      Esc.codes
-    end
-
   end # Foreground
 
 end # Vedeu

data/lib/vedeu/presentation/presentation.rb

@@ -0,0 +1,91 @@
+module Vedeu
+
+  # This module allows the sharing of presentation concerns between the models:
+  # Interface, Line and Stream.
+  #
+  # @api private
+  module Presentation
+
+    # @return [Vedeu::Colour]
+    def colour
+      Vedeu::Colour.coerce(@colour)
+    end
+
+    # @return [Vedeu::Colour]
+    def colour=(value)
+      @colour = Vedeu::Colour.coerce(value)
+    end
+
+    # @return [Vedeu::Style]
+    def style
+      Vedeu::Style.coerce(@style)
+    end
+
+    # @return [Vedeu::Style]
+    def style=(value)
+      @style = Vedeu::Style.coerce(value)
+    end
+
+    # Converts the colours and styles to escape sequences, and if the parent
+    # model has previously set the colour and style, reverts back to that for
+    # consistent formatting.
+    #
+    # @return [String] An escape sequence with value interpolated.
+    def to_s
+      render_position { render_colour { render_style { value } } }
+    end
+
+    private
+
+    def parent_colour
+      return '' unless parent
+
+      parent.colour
+    end
+
+    def parent_style
+      return '' unless parent
+
+      parent.style
+    end
+
+    # Renders the colour attributes of the receiver, yields (to then render the
+    # the styles) and once returned, attempts to set the colours back to the
+    # those of the receiver's parent.
+    #
+    # @return [String]
+    def render_colour
+      [
+        colour,
+        yield,
+        parent_colour
+      ].join
+    end
+
+    # @return [String]
+    def render_position
+      if self.respond_to?(:position) && position.is_a?(Position)
+        position.to_s { yield }
+
+      else
+        yield
+
+      end
+    end
+
+    # Renders the style attributes of the receiver, yields (to then render the
+    # next model, or finally, the content) and once returned, attempts to set
+    # the style back to that of the receiver's parent.
+    #
+    # @return [String]
+    def render_style
+      [
+        style,
+        yield,
+        parent_style
+      ].join
+    end
+
+  end # Presentation
+
+end # Vedeu

data/lib/vedeu/presentation/style.rb

@@ -0,0 +1,47 @@
+require 'vedeu/support/common'
+require 'vedeu/support/coercions'
+
+module Vedeu
+
+  # Converts the style value or value collection into a terminal escape
+  # sequence. Unrecognised values are discarded- an empty string is returned.
+  #
+  # @api private
+  class Style
+
+    include Vedeu::Common
+    include Vedeu::Coercions
+
+    attr_accessor :value
+
+    # Return a new instance of Style.
+    #
+    # @param value [Array|Array<String>|Array<Symbol>|String|Symbol]
+    #   The style value or a collection of values.
+    # @return [Style]
+    def initialize(value = nil)
+      @value = value
+    end
+
+    # Return an attributes hash for this class.
+    #
+    # @return [Hash]
+    def attributes
+      {
+        style: value
+      }
+    end
+
+    # Return the terminal escape sequences after converting the style or styles.
+    #
+    # @return [String]
+    def to_s
+      return '' unless defined_value?(value)
+
+      @_sequences ||= Array(value).flatten.map { |v| Esc.string(v) }.join
+    end
+    alias_method :escape_sequences, :to_s
+
+  end # Style
+
+end # Vedeu

data/lib/vedeu/{colours → presentation}/translator.rb

@@ -1,3 +1,5 @@
+require 'vedeu/support/coercions'
+
 module Vedeu
 
   # Convert a CSS/HTML colour string into a terminal escape sequence.
@@ -22,6 +24,11 @@ module Vedeu
   # @api private
   class Translator
 
+    include Vedeu::Coercions
+
+    attr_reader :colour
+    alias_method :value, :colour
+
     # Convert a CSS/HTML colour string into a terminal escape sequence.
     #
     # @param colour [Fixnum|String|Symbol]
@@ -58,11 +65,10 @@ module Vedeu
 
       end
     end
+    alias_method :to_s, :escape_sequence
 
     private
 
-    attr_reader :colour
-
     # @return [Boolean]
     def no_colour?
       colour.nil? || colour.to_s.empty?
@@ -159,7 +165,7 @@ module Vedeu
       end
     end
 
-    # Takes the red component of {css_to_rgb} and converts to the correct value
+    # Takes the red component of {#css_to_rgb} and converts to the correct value
     # for setting the terminal red value.
     #
     # @return [Fixnum]
@@ -167,7 +173,7 @@ module Vedeu
       (css_to_rgb[0] / 51) * 36
     end
 
-    # Takes the green component of {css_to_rgb} and converts to the correct value
+    # Takes the green component of {#css_to_rgb} and converts to the correct value
     # for setting the terminal green value.
     #
     # @return [Fixnum]
@@ -175,7 +181,7 @@ module Vedeu
       (css_to_rgb[1] / 51) * 6
     end
 
-    # Takes the blue component of {css_to_rgb} and converts to the correct value
+    # Takes the blue component of {#css_to_rgb} and converts to the correct value
     # for setting the terminal blue value.
     #
     # @return [Fixnum]

data/lib/vedeu/repositories/all.rb

@@ -0,0 +1,5 @@
+require 'vedeu/repositories/repository'
+require 'vedeu/repositories/menus'
+
+module Vedeu
+end # Vedeu

data/lib/vedeu/repositories/menus.rb

@@ -1,48 +1,11 @@
-module Vedeu
-
-  # Repository for storing and retrieving defined menus.
-  #
-  # @api private
-  module Menus
-
-    include Repository
-    extend self
-
-    # Stores the menu attributes defined by the API.
-    #
-    # @param attributes [Hash]
-    # @return [Hash|MissingRequired]
-    def add(attributes)
-      validate_attributes!(attributes)
-
-      Vedeu.log("Registering menu: '#{attributes[:name]}'")
-
-      attributes.merge!({ items: model.new(attributes[:items]) })
+require 'vedeu/repositories/repository'
 
-      storage.store(attributes[:name], attributes)
-    end
-
-    # Access a menu by name.
-    #
-    # @param name [String]
-    # @return [Vedeu::Menu]
-    def use(name)
-      find(name).fetch(:items)
-    end
-
-    private
+module Vedeu
 
-    # @return [Class] The model class for this repository.
-    def model
-      Vedeu::Menu
-    end
+  class Menus < Repository
 
-    # Returns an empty collection ready for the storing of menus by name with
-    # associated menu instance.
-    #
-    # @return [Hash]
-    def in_memory
-      {}
+    def self.menus
+      @_menus ||= Vedeu::Menus.new(Vedeu::Menu)
     end
 
   end # Menus