vedeu 0.2.10 → 0.2.11

data/lib/vedeu/models/geometry.rb

@@ -23,7 +23,7 @@ module Vedeu
       @width   = @attributes[:width]
     end
 
-    # Returns the row/line position for the interface.
+    # Returns the row/line start position for the interface.
     #
     # @return [Fixnum]
     def y
@@ -36,7 +36,20 @@ module Vedeu
       end
     end
 
-    # Returns the column position for the interface.
+    # Returns the row/line end position for the interface.
+    #
+    # @return [Fixnum]
+    def yn
+      if attributes[:yn].is_a?(Proc)
+        attributes[:yn].call
+
+      else
+        attributes[:yn]
+
+      end
+    end
+
+    # Returns the column/character start position for the interface.
     #
     # @return [Fixnum]
     def x
@@ -49,6 +62,19 @@ module Vedeu
       end
     end
 
+    # Returns the column/character end position for the interface.
+    #
+    # @return [Fixnum]
+    def xn
+      if attributes[:xn].is_a?(Proc)
+        attributes[:xn].call
+
+      else
+        attributes[:xn]
+
+      end
+    end
+
     # Returns a dynamic value calculated from the current terminal width,
     # combined with the desired column start point.
     #
@@ -481,6 +507,8 @@ module Vedeu
         width:   Terminal.width,
         height:  Terminal.height,
         centred: false,
+        yn:      nil,
+        xn:      nil,
       }
     end
 

data/lib/vedeu/models/key.rb

@@ -0,0 +1,39 @@
+module Vedeu
+
+  # A single keypress or combination of keypresses bound to a specific action.
+  class Key
+
+    # Returns a new instance of Key.
+    #
+    # @param input [String|Symbol]
+    # @param output [Proc]
+    # @return [Key]
+    def initialize(input, output)
+      @input  = input
+      @output = output
+    end
+
+    # Returns the key defined.
+    #
+    # @return [String|Symbol]
+    def input
+      @input
+    end
+    alias_method :key, :input
+
+    # The procedure to call when the key is pressed.
+    def output
+      @output
+    end
+    alias_method :action, :output
+
+    # Pressing the key will call the procedure.
+    #
+    # @return [|Symbol]
+    def press
+      output.is_a?(Proc) ? output.call : :noop
+    end
+
+  end # Key
+
+end # Vedeu

data/lib/vedeu/output/compositor.rb

@@ -8,104 +8,58 @@ module Vedeu
 
     include Common
 
-    # Convenience method to initialize a new Compositor and call its {#render}
+    # Convenience method to initialize a new Compositor and call its {#compose}
     # method.
     #
-    # @param name [String] The name of the interface/buffer.
     # @return [Compositor]
-    def self.render(name)
-      new(name).render
+    # @see #initialize
+    def self.compose(interface, buffer)
+      new(interface, buffer).compose
     end
 
     # Initialize a new Compositor.
     #
-    # @param name [String] The name of the interface/buffer.
+    # @param interface [Hash] The attributes of the interface to be refreshed.
+    # @param buffer [Hash] The atttributes of the buffer to refresh the
+    #   interface with.
     # @return [Compositor]
-    def initialize(name)
-      @name = name
+    def initialize(interface, buffer)
+      @interface = interface
+      @buffer    = buffer
     end
 
-    # Send the view to the terminal.
-    #
-    # @return [Array]
-    def render
-      Terminal.output(view, cursor)
-    end
-
-    private
-
-    attr_reader :name
-
-    # Renders the cursor into the currently focussed interface. May be hidden.
-    #
-    # @return [String] The escape sequence to render the cursor as shown or
-    #   hidden.
-    def cursor
-      Interface.new(Interfaces.find(Focus.current)).cursor.to_s
-    end
-
-    # Return the content for this buffer.
-    #
-    # - If we have new content (i.e. content on 'back') to be shown, we first
-    #   clear the area occupied by the previous content, then clear the area for
-    #   the new content, and then finally render the new content.
-    # - If there is no new content (i.e. 'back' is empty), check the 'front'
-    #   buffer and display that.
-    # - If there is no new content, and the front buffer is empty, display the
-    #   'previous' buffer.
-    # - If the 'previous' buffer is empty, return an empty hash.
+    # Return a new instance of Interface built by combining the buffer content
+    # attributes with the stored interface attributes.
     #
-    # @return [Hash]
-    def view
-      if buffer.back?
-        Clear.call(compose(buffer.previous)) if buffer.previous?
-
-        buffer.swap
+    # @return [Array<Hash>] The updated interface attributes.
+    def compose
+      buffer.content.each do |content|
+        change_geometry(content)
 
-        Render.call(compose(buffer.front))
-
-      elsif buffer.front?
-        Render.call(compose(buffer.front))
-
-      elsif buffer.previous?
-        Render.call(compose(buffer.previous))
-
-      else
-        Clear.call(compose({}), { direct: false })
+        interface[:lines] = content[:lines]
+        change_colour(content)
+        change_style(content)
 
+        Output.render(Interface.new(interface))
       end
     end
 
-    # Return a new instance of Interface built by combining the buffer content
-    # attributes with the stored interface attributes.
-    #
-    # @return [Interface]
-    def compose(content)
-      if defined_value?(content[:geometry])
-        content[:geometry].each do |k, v|
-          interface[:geometry][k] = v if defined_value?(k)
-        end
-      end
+    private
 
-      interface[:lines]  = content[:lines]
-      interface[:colour] = content[:colour] if defined_value?(content[:colour])
-      interface[:style]  = content[:style]  if defined_value?(content[:style])
+    attr_reader :interface, :buffer
 
-      Interface.new(interface)
+    def change_colour(content)
+      interface[:colour] = content[:colour] if defined_value?(content[:colour])
     end
 
-    # Returns the attributes of the named interface (layout).
-    #
-    # @return [Hash]
-    def interface
-      @_interface ||= Interfaces.find(name)
+    def change_geometry(content)
+      content[:geometry].each do |k, v|
+        interface[:geometry][k] = v if defined_value?(k)
+      end if defined_value?(content[:geometry])
     end
 
-    # Return the named Buffer (view).
-    #
-    # @return [Buffer]
-    def buffer
-      @_buffer ||= Buffers.find(name)
+    def change_style(content)
+      interface[:style] = content[:style] if defined_value?(content[:style])
     end
 
   end # Compositor

data/lib/vedeu/output/output.rb

@@ -0,0 +1,74 @@
+module Vedeu
+
+  class Output
+
+    # Writes content (the provided interface object with associated lines,
+    # streams, colours and styles) to the area defined by the interface.
+    #
+    # @return [Array|String]
+    # @see #initialize
+    def self.render(interface)
+      new(interface).render
+    end
+
+    # Return a new instance of Output.
+    #
+    # @param interface [Interface]
+    # @return [Output]
+    def initialize(interface)
+      @interface = interface
+    end
+
+    # Send the view to the terminal.
+    #
+    # @return [Array]
+    def render
+      Terminal.output(view, Focus.cursor)
+    end
+
+    private
+
+    attr_reader :interface
+
+    # For each visible line of the interface, set the foreground and background
+    # colours to those specified when the interface was defined, then starting
+    # write space characters over the area which the interface occupies.
+    #
+    # @return [String]
+    def clear
+      Vedeu.log("Clearing view: '#{interface.name}'")
+
+      rows.inject([colours]) do |line, index|
+        line << interface.origin(index) { ' ' * interface.width }
+      end.join
+    end
+
+    # @return [String]
+    def colours
+      interface.colour.to_s
+    end
+
+    # @return [Enumerator]
+    def rows
+      interface.height.times
+    end
+
+    # Produces a single string which contains all content and escape sequences
+    # required to render this interface in the terminal window.
+    #
+    # @return [String]
+    def view
+      out = [ clear ]
+
+      Vedeu.log("Rendering view: '#{interface.name}'")
+
+      interface.viewport.each_with_index do |line, index|
+        out << interface.origin(index)
+        out << line.join
+      end
+      out.join
+    end
+
+  end # Output
+
+end # Vedeu

data/lib/vedeu/output/viewport.rb

@@ -8,10 +8,6 @@ module Vedeu
   #
   class Viewport
 
-    extend Forwardable
-
-    def_delegators :interface, :content, :height, :offset, :width
-
     # @see Viewport#show
     def self.show(interface)
       new(interface).show
@@ -52,38 +48,6 @@ module Vedeu
 
     # Scrolls the content vertically when the stored y offset for the interface
     # is outside of the visible area.
-    #
-    # @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
-
-    # Scrolls the content horizontally when the stored x offset for the
-    # interface is outside of the visible area.
-    #
-    # @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
-
     #
     # @note
     #   @top = [value, 0].max # this allows us to set a top that is greater than
@@ -93,12 +57,19 @@ module Vedeu
     #                         # this does not allow us to have an offset greater
     #                         # than the content height.
     #
-    # @param value [Fixnum]
     # @return [Fixnum]
-    def set_top(value)
-      @top = [value, 0].max
+    def line_adjustment
+      if offset.y < 0
+        @top = [offset.y, 0].max
+
+      elsif offset.y > height
+        @top = [(offset.y - height), 0].max
+
+      end
     end
 
+    # Scrolls the content horizontally when the stored x offset for the
+    # interface is outside of the visible area.
     #
     # @note
     #   @left = [value, 0].max # this allows us to set a left that is greater
@@ -108,24 +79,29 @@ module Vedeu
     #                         # this does not allow us to have an offset greater
     #                         # than the content width.
     #
-    # @param value [Fixnum]
     # @return [Fixnum]
-    def set_left(value)
-      @left = [value, 0].max
+    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.
     #
     # @return [Range]
     def lines
-      @top..(@top + height - 1)
+      @top..(@top + height)
     end
 
     # Using the current y offset, return a range of visible columns.
     #
     # @return [Range]
     def columns
-      @left..(@left + width - 1)
+      @left..(@left + width)
     end
 
     # Returns the height of the content, or when no content, the visible height
@@ -162,6 +138,22 @@ module Vedeu
       content.any?
     end
 
+    def content
+      interface.content
+    end
+
+    def offset
+      interface.offset
+    end
+
+    def width
+      interface.width - 1
+    end
+
+    def height
+      interface.height - 1
+    end
+
   end # Viewport
 
 end # Vedeu

data/lib/vedeu/repositories/buffers.rb

@@ -28,38 +28,25 @@ module Vedeu
       else
         Vedeu.log("Adding new buffer: '#{name}'")
 
-        Buffer.new({ name: name }).add(attributes)
+        model.new({ name: name }).add(attributes)
 
       end
 
       name
     end
 
-    # Update the repository with the provided Buffer. Returns a boolean
-    # indicating whether this was successful.
-    #
-    # @param buffer [Buffer]
-    # @return [Boolean]
-    def update(buffer)
-      storage.store(buffer.name, buffer)
+    private
 
-      true
+    # @return [Class] The model class for this repository.
+    def model
+      Vedeu::Buffer
     end
 
-    private
-
     # @return [Hash]
     def in_memory
       {}
     end
 
-    # @param name [String]
-    # @raise [BufferNotFound] When the entity cannot be found with this name.
-    # @return [BufferNotFound]
-    def not_found(name)
-      fail BufferNotFound, "Cannot find buffer: '#{name}'"
-    end
-
   end # Buffers
 
 end # Vedeu