vedeu 0.5.4 → 0.5.5

data/lib/vedeu/models/views/lines.rb

@@ -0,0 +1,13 @@
+module Vedeu
+
+  module Views
+
+    # A collection of {Vedeu::Views::Line} instances.
+    #
+    class Lines < Vedeu::Collection
+
+    end # Lines
+
+  end # Views
+
+end # Vedeu

data/lib/vedeu/models/views/stream.rb

@@ -0,0 +1,122 @@
+module Vedeu
+
+  module Views
+
+    # Represents a character or collection of characters as part of a
+    # {Vedeu::Views::Line} which you wish to colour and style independently of
+    # the other characters in that line.
+    #
+    class Stream
+
+      include Vedeu::Model
+      include Vedeu::Presentation
+
+      collection Vedeu::Views::Chars
+      member     Vedeu::Views::Char
+
+      # @!attribute [rw] parent
+      # @return [Vedeu::Views::Line]
+      attr_accessor :parent
+
+      # @!attribute [rw] value
+      # @return [String]
+      attr_accessor :value
+      alias_method :content, :value
+      alias_method :data,    :value
+      alias_method :text,    :value
+
+      # @!attribute [r] attributes
+      # @return [Hash]
+      attr_reader :attributes
+
+      # Returns a new instance of Vedeu::Views::Stream.
+      #
+      # @param attributes [Hash]
+      # @option attributes value [String]
+      # @option attributes parent [Vedeu::Views::Line]
+      # @option attributes colour [Vedeu::Colour]
+      # @option attributes style [Vedeu::Style]
+      # @return [Vedeu::Views::Stream]
+      def initialize(attributes = {})
+        @attributes = defaults.merge!(attributes)
+
+        @attributes.each do |key, value|
+          instance_variable_set("@#{key}", value)
+        end
+      end
+
+      # @param child [Vedeu::Views::Stream]
+      # @return [Vedeu::Views::Streams]
+      def add(child)
+        parent.add(child)
+      end
+      alias_method :<<, :add
+
+      # Returns an array of characters, each element is the escape sequences of
+      # colours and styles for this stream, the character itself, and the escape
+      # sequences of colours and styles for the parent of the stream
+      # ({Vedeu::Views::Line}).
+      #
+      # @return [Array]
+      def chars
+        return [] if empty?
+
+        @chars ||= value.chars.map do |char|
+          member.new(value:    char,
+                     parent:   parent,
+                     colour:   colour,
+                     style:    style,
+                     position: nil)
+        end
+      end
+
+      # Returns a boolean indicating whether the stream has content.
+      #
+      # @return [Boolean]
+      def empty?
+        value.empty?
+      end
+
+      # An object is equal when its values are the same.
+      #
+      # @param other [Vedeu::Views::Char]
+      # @return [Boolean]
+      def eql?(other)
+        self.class == other.class && value == other.value &&
+          colour == other.colour && style == other.style &&
+          parent == other.parent
+      end
+      alias_method :==, :eql?
+
+      # @return [NilClass|String]
+      def name
+        parent.name if parent
+      end
+
+      # Returns the size of the content in characters without formatting.
+      #
+      # @return [Fixnum]
+      def size
+        value.size
+      end
+
+      private
+
+      # The default values for a new instance of this class.
+      #
+      # @return [Hash]
+      def defaults
+        {
+          client: nil,
+          colour: nil,
+          parent: nil,
+          style:  nil,
+          value:  '',
+        }
+      end
+
+    end # Stream
+
+  end # Views
+
+end # Vedeu

data/lib/vedeu/models/views/streams.rb

@@ -0,0 +1,13 @@
+module Vedeu
+
+  module Views
+
+    # A collection of {Vedeu::Views::Stream} instances.
+    #
+    class Streams < Vedeu::Collection
+
+    end # Streams
+
+  end # Views
+
+end # Vedeu

data/lib/vedeu/models/views/view.rb

@@ -0,0 +1,157 @@
+module Vedeu
+
+  module Views
+
+    # Represents a container for {Vedeu::Views::Line} and {Vedeu::Views::Stream}
+    # objects.
+    #
+    class View
+
+      include Vedeu::Model
+      include Vedeu::Presentation
+
+      collection Vedeu::Views::Lines
+      member     Vedeu::Views::Line
+
+      # @!attribute [rw] client
+      # @return [Fixnum|Float]
+      attr_accessor :client
+
+      # @!attribute [rw] name
+      # @return [String]
+      attr_accessor :name
+
+      # @!attribute [rw] parent
+      # @return [Vedeu::Views::Composition]
+      attr_accessor :parent
+
+      # @!attribute [rw] zindex
+      # @return [Fixnum]
+      attr_accessor :zindex
+
+      # @!attribute [r] attributes
+      # @return [Hash]
+      attr_reader :attributes
+
+      # @!attribute [w] lines
+      # @return [Array<Vedeu::Views::Line>]
+      attr_writer :lines
+
+      # Return a new instance of Vedeu::Views::View.
+      #
+      # @param attributes [Hash]
+      # @option attributes client [Vedeu::Client]
+      # @option attributes colour [Vedeu::Colour]
+      # @option attributes lines [Vedeu::Views::Lines]
+      # @option attributes name [String]
+      # @option attributes parent [Vedeu::Views::Composition]
+      # @option attributes style [Vedeu::Style]
+      # @option attributes zindex [Fixnum]
+      # @return [Vedeu::Views::View]
+      def initialize(attributes = {})
+        @attributes = defaults.merge!(attributes)
+
+        @attributes.each do |key, value|
+          instance_variable_set("@#{key}", value)
+        end
+      end
+
+      # @param child [Vedeu::Views::Line]
+      # @return [void]
+      def add(child)
+        @lines = lines.add(child)
+      end
+      alias_method :<<, :add
+
+      # Override Ruby's Object#inspect method to provide a more helpful output.
+      #
+      # @return [String]
+      def inspect
+        "<Vedeu::Views::View name: '#{name}', zindex: '#{zindex}'>"
+      end
+
+      # @return [Vedeu::Views::Lines]
+      def lines
+        collection.coerce(@lines, self)
+      end
+      alias_method :value, :lines
+
+      # Returns a boolean indicating whether the interface has content.
+      #
+      # @return [Boolean]
+      def lines?
+        lines.any?
+      end
+
+      # @return [Array<Array<Vedeu::Views::Char>>]
+      def render
+        return [] unless visible?
+
+        output = [
+          Vedeu::Cursor.hide_cursor(name),
+          Vedeu::Clear::NamedInterface.render(name),
+          Vedeu::Viewport.render(self),
+          Vedeu.borders.by_name(name).render,
+          Vedeu::Cursor.show_cursor(name),
+        ]
+
+        output
+      end
+
+      # Store the view and immediately refresh it; causing to be pushed to the
+      # Terminal. Called by {Vedeu::DSL::View.renders}.
+      #
+      # @return [Vedeu::Views::View]
+      def store_immediate
+        store_deferred
+
+        Vedeu::Refresh.by_name(name)
+
+        self
+      end
+
+      # When a name is given, the view is stored with this name. This view will
+      # be shown next time a refresh event is triggered with this name.
+      # Called by {Vedeu::DSL::View.views}.
+      #
+      # @raise [Vedeu::InvalidSyntax] The name is not defined.
+      # @return [Vedeu::Views::View]
+      def store_deferred
+        unless present?(name)
+          fail Vedeu::InvalidSyntax, 'Cannot store an interface without a name.'
+        end
+
+        Vedeu.buffers.by_name(name).add(self)
+
+        self
+      end
+
+      # Returns a boolean indicating whether the view is visible.
+      #
+      # @return [Boolean]
+      def visible?
+        Vedeu.interfaces.by_name(name).visible?
+      end
+
+      private
+
+      # The default values for a new instance of this class.
+      #
+      # @return [Hash]
+      def defaults
+        {
+          client:     nil,
+          colour:     Vedeu::Colour.coerce(background: :default,
+                                           foreground: :default),
+          name:       '',
+          parent:     nil,
+          style:      :normal,
+          zindex:     0,
+        }
+      end
+
+    end # View
+
+  end # Views
+
+end # Vedeu

data/lib/vedeu/models/views/view_collection.rb

@@ -0,0 +1,13 @@
+module Vedeu
+
+  module Views
+
+    # A collection of {Vedeu::Views::View} instances.
+    #
+    class ViewCollection < Vedeu::Collection
+
+    end # ViewCollection
+
+  end # Views
+
+end # Vedeu

data/lib/vedeu/null/view.rb

@@ -0,0 +1,67 @@
+require 'vedeu/output/presentation'
+
+module Vedeu
+
+  module Null
+
+    # Provides a non-existent model to swallow messages.
+    #
+    class View
+
+      include Vedeu::Presentation
+
+      # @!attribute [r] name,
+      # @return [String]
+      attr_reader :name
+
+      # @!attribute [r] attributes
+      # @return [String]
+      attr_reader :attributes
+
+      # @!attribute [rw] visible
+      # @return [String]
+      attr_accessor :visible
+      alias_method :visible?, :visible
+
+      # Returns a new instance of Vedeu::Null::View.
+      #
+      # @param attributes [Hash<Symbol => void>]
+      # @option attributes name [String]
+      # @return [Vedeu::Null::View]
+      def initialize(attributes = {})
+        @attributes = attributes
+        @name       = @attributes[:name]
+        @visible    = @attributes[:visible]
+      end
+
+      # @return [NilClass]
+      def null
+        nil
+      end
+      alias_method :parent, :null
+      alias_method :zindex, :null
+
+      # @return [Boolean]
+      def null?
+        true
+      end
+
+      # Pretend to store this model in the repository.
+      #
+      # @return [Vedeu::Null::View]
+      def store
+        self
+      end
+
+      # The null interface should not be visible.
+      #
+      # @return [FalseClass]
+      def visible?
+        false
+      end
+
+    end # View
+
+  end # Null
+
+end # Vedeu

data/lib/vedeu/output/clear/named_interface.rb

@@ -56,7 +56,7 @@ module Vedeu
       # then starting write space characters over the area which the interface
       # occupies.
       #
-      # @return [Array<Array<Vedeu::Char>>]
+      # @return [Array<Array<Vedeu::Views::Char>>]
       def output
         Vedeu.timer("Clearing: '#{name}'") do
           @y      = geometry.y
@@ -67,9 +67,9 @@ module Vedeu
 
           @clear ||= Array.new(@height) do |iy|
             Array.new(@width) do |ix|
-              Vedeu::Char.new(value:    ' ',
-                              colour:   @colour,
-                              position: [@y + iy, @x + ix])
+              Vedeu::Views::Char.new(value:    ' ',
+                                     colour:   @colour,
+                                     position: [@y + iy, @x + ix])
             end
           end
         end

data/lib/vedeu/output/compressor.rb

@@ -1,12 +1,12 @@
 module Vedeu
 
-  # During the conversion of a Vedeu::Char object into a string of escape
+  # During the conversion of a Vedeu::Views::Char object into a string of escape
   # sequences, this class removes multiple occurences of the same escape
   # sequence, resulting in a smaller payload being sent to the renderer.
   #
   class Compressor
 
-    # @param output [Array<Array<Vedeu::Char>>]
+    # @param output [Array<Array<Vedeu::Views::Char>>]
     # @return [String]
     def self.render(output)
       new(output).render
@@ -14,7 +14,7 @@ module Vedeu
 
     # Returns a new instance of Vedeu::Compressor.
     #
-    # @param output [Array<Array<Vedeu::Char>>]
+    # @param output [Array<Array<Vedeu::Views::Char>>]
     # @return [Vedeu::Compressor]
     def initialize(output)
       @output = output
@@ -38,7 +38,7 @@ module Vedeu
     protected
 
     # @!attribute [r] output
-    # @return [Array<Array<Vedeu::Char>>]
+    # @return [Array<Array<Vedeu::Views::Char>>]
     attr_reader :output
 
     private
@@ -62,7 +62,7 @@ module Vedeu
       out
     end
 
-    # @param char [Vedeu::Char]
+    # @param char [Vedeu::Views::Char]
     # @return [String]
     def colour_for(char)
       return '' if char.colour == @colour
@@ -71,7 +71,7 @@ module Vedeu
       @colour.to_s
     end
 
-    # @param char [Vedeu::Char]
+    # @param char [Vedeu::Views::Char]
     # @return [String]
     def style_for(char)
       return '' if char.style == @style