vedeu 0.2.3 → 0.2.4

data/lib/vedeu/output/render.rb

@@ -7,26 +7,26 @@ module Vedeu
   # @api private
   class Render
 
+    extend Forwardable
+
+    def_delegators :interface, :viewport
+
     # Create a new instance of Render with the provided {Vedeu::Interface} and
     # then convert the interface into a single string of content and escape
     # sequences.
     #
-    # @api private
     # @param interface [Interface]
-    # @param options [Hash]
     # @return [String]
-    def self.call(interface, options = {})
-      new(interface, options).render
+    def self.call(interface)
+      new(interface).render
     end
 
     # Return a new instance of Render.
     #
     # @param interface [Interface]
-    # @param options [Hash]
     # @return [Render]
-    def initialize(interface, options = {})
+    def initialize(interface)
       @interface = interface
-      @options   = options
     end
 
     # Produces a single string which contains all content and escape sequences
@@ -34,13 +34,15 @@ module Vedeu
     #
     # @return [String]
     def render
+      out = [ Clear.call(interface) ]
+
       Vedeu.log("Rendering view: '#{interface.name}'")
 
-      out = [ Clear.call(interface) ]
-      processed_lines.each_with_index do |line, index|
+      viewport.each_with_index do |line, index|
         out << interface.origin(index)
-        out << line.to_s
+        out << line.join
       end
+      out << interface.cursor.to_s if interface.in_focus?
       out.join
     end
 
@@ -48,159 +50,6 @@ module Vedeu
 
     attr_reader :interface
 
-    # The client application may have created a line that us too long for the
-    # interface. This code tries to truncate streams whilst preserving styles
-    # and colours. To achieve this, it successively checks each stream length
-    # against remaining line length and truncates the stream data if it
-    # exceeds the line length. Further stream data that does not fit is
-    # discarded.
-    #
-    # @api private
-    # @return [Array]
-    def processed_lines
-      return [] unless visible_lines.any? { |line| line.streams.any? }
-
-      visible_lines.map do |line|
-        if exceeds_width?(line)
-          line_length = 0
-          new_streams = []
-
-          new_streams = line.streams.map do |stream|
-            next if stream.content.empty?
-
-            if (line_length += stream.content.size) >= width
-              remainder = width - line_length
-              truncated = truncate(stream.content, remainder)
-
-              build_stream(line, stream, truncated)
-
-            else
-              stream
-
-            end
-          end
-
-          build_line(line, new_streams)
-
-        else
-          line
-
-        end
-      end
-    end
-
-    # Builds a new Stream object with the newly truncated text and previous
-    # attributes.
-    #
-    # @api private
-    # @param line [Line]
-    # @param stream [Stream]
-    # @param content [String]
-    # @return [Stream]
-    def build_stream(line, stream, content)
-      attributes = stream.view_attributes.merge!({
-        parent: line.view_attributes,
-        text:   content,
-      })
-
-      Stream.new(attributes)
-    end
-
-    # Builds a new Line object with the new streams and previous attributes.
-    #
-    # @api private
-    # @param line [Line]
-    # @param streams [Array]
-    # @return [Line]
-    def build_line(line, streams)
-      attributes = line.view_attributes.merge!({
-        parent:  interface.view_attributes,
-        streams: streams,
-      })
-
-      Line.new(attributes)
-    end
-
-    # Converts all streams within a line into a single line of text to then
-    # check that this line (without formatting, as that is not visible) exceeds
-    # the width of the interface.
-    #
-    # @api private
-    # @param line [Line]
-    # @return [Boolean]
-    def exceeds_width?(line)
-      line.streams.map(&:content).join.size > width
-    end
-
-    # Truncates the provided string.
-    #
-    # @api private
-    # @param string [String] The string to be truncated.
-    # @param value [Fixnum] The total length of the string after truncation.
-    # @return [String]
-    def truncate(string, value)
-      string.chomp.slice(0...value)
-    end
-
-    # Provides the collection of visible lines associated with the interface.
-    # If the option `:top` was set, we will start at that line. Any lines
-    # outside of the height will not be rendered.
-    #
-    # @api private
-    # @return [Array]
-    def visible_lines
-      lines[top..height]
-    end
-
-    # Provides the collection of lines associated with the interface.
-    #
-    # @api private
-    # @return [Array]
-    def lines
-      interface.lines
-    end
-
-    # Provides the currently available height of the interface.
-    #
-    # @note The height is reported to be one less line than actual because
-    #   terminal coordinates count from 1, not 0.
-    #
-    # @api private
-    # @return [Fixnum]
-    def height
-      interface.viewport_height - 1
-    end
-
-    # Provides the currently available width of the interface.
-    #
-    # @api private
-    # @return [Fixnum]
-    def width
-      interface.viewport_width
-    end
-
-    # The current top line.
-    #
-    # @api private
-    # @return [Fixnum]
-    def top
-      options[:top]
-    end
-
-    # @api private
-    # @return [Hash]
-    def options
-      @_options ||= defaults.merge!(@options)
-    end
-
-    # @api private
-    # @return [Hash]
-    def defaults
-      {
-        top: 0
-      }
-    end
-
   end # Render
 
 end # Vedeu

data/lib/vedeu/output/view.rb

@@ -46,7 +46,6 @@ module Vedeu
 
     # Create a new Composition object with the attributes.
     #
-    # @api private
     # @return [Composition]
     def composition
       @_composition ||= Composition.new(attributes)
@@ -55,7 +54,6 @@ module Vedeu
     # Calls the #render method of the subclass, hopefully receives attributes
     # suitable to create one or more views.
     #
-    # @api private
     # @return []
     def attributes
       render

data/lib/vedeu/output/viewport.rb

@@ -0,0 +1,132 @@
+module Vedeu
+
+  # A Viewport is the visible part of the content within an interface.
+  #
+  # When a buffer has more lines than the defined height, or more columns than
+  # the defined width of the interface, the Viewport class provides 'scrolling'
+  # via the cursor's position.
+  #
+  class Viewport
+
+    extend Forwardable
+
+    def_delegators :interface, :content, :height, :offset, :width
+
+    # @see Viewport#show
+    def self.show(interface)
+      new(interface).show
+    end
+
+    # Returns an instance of Viewport.
+    #
+    # @param interface [Interface] An instance of interface.
+    # @return [Viewport]
+    def initialize(interface)
+      @interface = interface
+      @top       = 0
+      @left      = 0
+    end
+
+    # Returns the visible content for the interface.
+    #
+    # @return [Array]
+    def show
+      line_adjustment
+      column_adjustment
+
+      return [] unless content?
+
+      content[lines].map { |line| line.chars[columns] }.compact
+    end
+
+    private
+
+    attr_reader :interface
+
+    # @return [Fixnum]
+    def line_adjustment
+      if offset.y < lines.min
+        set_top(offset.y)
+
+      elsif offset.y > lines.max
+        set_top(offset.y - (lines.max - lines.min))
+
+      else
+        # @top does not need adjusting
+
+      end
+    end
+
+    # @return [Fixnum]
+    def column_adjustment
+      if offset.x < columns.min
+        set_left(offset.x)
+
+      elsif offset.x > columns.max
+        set_left(offset.x - (columns.max - columns.min))
+
+      else
+        # @left does not need adjusting
+
+      end
+    end
+
+    # @param value [Fixnum]
+    # @return [Fixnum]
+    def set_top(value)
+      @top = [[value, (content_height - height)].min, 0].max
+    end
+
+    # @param value [Fixnum]
+    # @return [Fixnum]
+    def set_left(value)
+      @left = [value, 0].max
+    end
+
+    # @return [Range]
+    def lines
+      @top..(@top + height - 1)
+    end
+
+    # @return [Range]
+    def columns
+      @left..(@left + width - 1)
+    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?
+
+      [content.size, height].max
+    end
+
+    # 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?
+
+      [content_maximum_line_length, width].max
+    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
+
+  end # Viewport
+
+end # Vedeu

data/lib/vedeu/repositories/buffers.rb

@@ -49,31 +49,26 @@ module Vedeu
     # and we should return nothing.
     #
     # @param name [String]
-    # @return [Hash]
+    # @return [Hash|NilClass]
     def latest(name)
-      if new_content?(name)
-        swap_buffers(name)
-        front_buffer(name)
-
-      elsif old_content?(name)
-        front_buffer(name)
-
-      else
-        nil
+      swap_buffers(name) if new_content?(name)
 
-      end
+      front_buffer(name)
     end
 
     private
 
-    # Swap the named back buffer into the front buffer of the same name.
+    # Swap the named back buffer into the front buffer of the same name. This is
+    # called when the back buffer has new content (perhaps as part of a
+    # refresh). It also resets the offsets (i.e. scroll position)
     #
-    # @api private
     # @param name [String]
     # @return [Hash]
     def swap_buffers(name)
       buffer = find(name)
 
+      Offsets.update({ name: name })
+
       storage.store(name, {
         front_buffer: buffer[:back_buffer],
         back_buffer:  nil,
@@ -82,7 +77,6 @@ module Vedeu
 
     # Return a boolean indicating whether the named back buffer has new content.
     #
-    # @api private
     # @param name [String]
     # @return [Boolean]
     def new_content?(name)
@@ -91,16 +85,14 @@ module Vedeu
 
     # Return a boolean indicating whether the named front buffer has content.
     #
-    # @api private
     # @param name [String]
     # @return [Boolean]
-    def old_content?(name)
-      defined_value?(front_buffer(name))
-    end
+    # def old_content?(name)
+    #   defined_value?(front_buffer(name))
+    # end
 
     # Return the named back buffer.
     #
-    # @api private
     # @param name [String]
     # @return [Hash|Nil]
     def back_buffer(name)
@@ -109,14 +101,12 @@ module Vedeu
 
     # Return the named front buffer.
     #
-    # @api private
     # @param name [String]
     # @return [Hash|Nil]
     def front_buffer(name)
       find(name)[:front_buffer]
     end
 
-    # @api private
     # @return [Hash]
     def in_memory
       Hash.new do |hash, interface_name|
@@ -127,7 +117,6 @@ module Vedeu
       end
     end
 
-    # @api private
     # @param name [String]
     # @raise [BufferNotFound] When the entity cannot be found with this name.
     # @return [BufferNotFound]

data/lib/vedeu/repositories/cursors.rb

@@ -10,15 +10,10 @@ module Vedeu
     include Repository
     extend self
 
-    # System events which when called will update the cursor position or
-    # visibility accordingly for the interface in focus.
-    Vedeu.event(:_cursor_up_)      { Cursors.use(:move_up)    }
-    Vedeu.event(:_cursor_right_)   { Cursors.use(:move_right) }
-    Vedeu.event(:_cursor_down_)    { Cursors.use(:move_down)  }
-    Vedeu.event(:_cursor_left_)    { Cursors.use(:move_left)  }
-    Vedeu.event(:_cursor_hide_)    { Cursors.use(:hide)       }
-    Vedeu.event(:_cursor_show_)    { Cursors.use(:show)       }
-    Vedeu.event(:_cursor_refresh_) { Cursors.use(:refresh)    }
+    # System events which when called will update the cursor visibility
+    # accordingly for the interface in focus.
+    Vedeu.event(:_cursor_hide_)    { Cursors.hide }
+    Vedeu.event(:_cursor_show_)    { Cursors.show }
 
     # Adds an interface to the cursors repository.
     #
@@ -27,50 +22,36 @@ module Vedeu
     def add(attributes)
       validate_attributes!(attributes)
 
-      Vedeu.log("Registering cursor: '#{attributes[:name]}'")
+      Vedeu.log("#{action(__callee__)} cursor: '#{attributes[:name]}'")
 
-      storage.store(attributes[:name], {
-        name: attributes[:name],
-        x: 1,
-        y: 1,
-        state: :show
-      })
+      storage.store(attributes[:name], Cursor.new(attributes))
     end
+    alias_method :update, :add
 
-    # Saves the attributes in the repository for future use.
+    # Make the cursor of this interface invisible.
     #
-    # @param attributes [Hash]
-    # @return [Hash]
-    def update(attributes)
-      return false unless defined_value?(attributes[:name])
-
-      Vedeu.log("Updating cursor: '#{attributes[:name]}'")
-
-      storage.store(attributes[:name], attributes)
+    # @return [Cursor]
+    def hide
+      find_or_create(Focus.current).hide
     end
 
-    # Perform an action (moving, showing or hiding) and save the new cursor
-    # state.
+    # Make the cursor of this interface visible.
     #
-    # @param action [Symbol] A symbol representing the method name to be called
-    #   on the Cursor instance.
-    # @return [String] The escape sequence sent to the Terminal on completion
-    #   of the action.
-    def use(action)
-      name   = Focus.current
-      cursor = Cursor.new(find(name))
-
-      storage.store(name, cursor.send(action))
-
-      Terminal.output(cursor.to_s)
+    # @return [Cursor]
+    def show
+      find_or_create(Focus.current).show
     end
 
     private
 
+    # @return [Class]
+    def entity
+      Cursor
+    end
+
     # Returns an empty collection ready for the storing of cursors by name with
     # current attributes.
     #
-    # @api private
     # @example
     #   { 'holmium' => {
     #                    name:     'holmium',
@@ -83,14 +64,6 @@ module Vedeu
       {}
     end
 
-    # @api private
-    # @param name [String]
-    # @raise [CursorNotFound] When the entity cannot be found with this name.
-    # @return [CursorNotFound]
-    def not_found(name)
-      fail CursorNotFound, "Cursor was not found with this name: #{name.to_s}."
-    end
-
   end # Cursors
 
 end # Vedeu

data/lib/vedeu/repositories/events.rb

@@ -2,6 +2,8 @@ module Vedeu
 
   # Provides a mechanism for storing and retrieving events by name. A single
   # name can contain many events. Also, an event can trigger other events.
+  #
+  # @api private
   module Events
 
     include Repository
@@ -47,7 +49,6 @@ module Vedeu
     # Returns an empty collection ready for the storing of events by name with
     # associated event instance.
     #
-    # @api private
     # @return [Hash]
     def in_memory
       Hash.new { |hash, key| hash[key] = { events: [] } }

data/lib/vedeu/repositories/focus.rb

@@ -14,20 +14,9 @@ module Vedeu
     # System events which when called will change which interface is currently
     # focussed. When the interface is brought into focus, its cursor position
     # and visibility is restored.
-    Vedeu.event(:_focus_by_name_) do |name|
-      Vedeu::Focus.by_name(name)
-      Vedeu.trigger(:_cursor_refresh_)
-    end
-
-    Vedeu.event(:_focus_next_) do
-      Vedeu::Focus.next_item
-      Vedeu.trigger(:_cursor_refresh_)
-    end
-
-    Vedeu.event(:_focus_prev_) do
-      Vedeu::Focus.prev_item
-      Vedeu.trigger(:_cursor_refresh_)
-    end
+    Vedeu.event(:_focus_by_name_) { |name| Vedeu::Focus.by_name(name) }
+    Vedeu.event(:_focus_next_)    { Vedeu::Focus.next_item }
+    Vedeu.event(:_focus_prev_)    { Vedeu::Focus.prev_item }
 
     # Add an interface name to the focus list unless it is already registered.
     #
@@ -57,6 +46,8 @@ module Vedeu
 
       Vedeu.log("Interface in focus: '#{current}'")
 
+      refresh
+
       current
     end
 
@@ -87,6 +78,8 @@ module Vedeu
 
       Vedeu.log("Interface in focus: '#{current}'")
 
+      refresh
+
       current
     end
 
@@ -98,9 +91,18 @@ module Vedeu
 
       Vedeu.log("Interface in focus: '#{current}'")
 
+      refresh
+
       current
     end
 
+    # Refresh the interface in focus.
+    #
+    # @return [Array]
+    def refresh
+      Vedeu.trigger("_refresh_#{current}_".to_sym)
+    end
+
     # Returns all registered interfaces by name.
     #
     # @return [Array]
@@ -110,7 +112,6 @@ module Vedeu
 
     # Returns a boolean indicating whether the named interface is registered.
     #
-    # @api private
     # @return [Boolean]
     def registered?(name)
       return false if storage.empty?
@@ -122,7 +123,6 @@ module Vedeu
 
     # Returns an empty collection ready for the storing of interface names.
     #
-    # @api private
     # @return [Array]
     def in_memory
       []

data/lib/vedeu/repositories/groups.rb

@@ -13,7 +13,7 @@ module Vedeu
     # exist, and rejecting the interface if it is already known.
     #
     # @param attributes [Hash]
-    # @return [Groups|FalseClass]
+    # @return [Boolean]
     def add(attributes)
       validate_attributes!(attributes)
 
@@ -29,7 +29,6 @@ module Vedeu
     private
 
     # @see Vedeu::Refresh.register_event
-    # @api private
     # @param attributes [Hash]
     # @return [Boolean]
     def register_event(attributes)
@@ -39,13 +38,11 @@ module Vedeu
       Vedeu::Refresh.register_event(:by_group, name, delay)
     end
 
-    # @api private
     # @return [Hash]
     def in_memory
       Hash.new { |hash, key| hash[key] = Set.new }
     end
 
-    # @api private
     # @param name [String]
     # @raise [GroupNotFound] When the entity cannot be found with this name.
     # @return [GroupNotFound]