vedeu 0.4.13 → 0.4.14

data/lib/vedeu/models/char.rb

@@ -23,9 +23,9 @@ module Vedeu
     # @return [Vedeu::Line]
     attr_accessor :parent
 
-    # @!attribute [rw] value
+    # @!attribute [w] value
     # @return [String]
-    attr_accessor :value
+    attr_writer :value
 
     # Returns a new instance of Vedeu::Char.
     #
@@ -68,7 +68,7 @@ module Vedeu
 
     # @return [String]
     def inspect
-      "<Vedeu::Char '#{Vedeu::Esc.escape(self.to_s)}'>"
+      "<Vedeu::Char '#{Vedeu::Esc.escape(to_s)}'>"
     end
 
     # @return [Vedeu::Position]
@@ -84,6 +84,17 @@ module Vedeu
       @position = Vedeu::Position.coerce(value)
     end
 
+    # @return [String]
+    def value
+      if border
+        Vedeu::Esc.border { @value }
+
+      else
+        @value
+
+      end
+    end
+
     # Returns the x position for the Char if set.
     #
     # @return [Fixnum|NilClass]
@@ -107,18 +118,12 @@ module Vedeu
     # @return [Hash]
     def to_hash
       {
-        parent:     {
-          background: parent_background.to_s,
-          foreground: parent_foreground.to_s,
-          style:      parent_style.to_s,
-        },
-        background: background.to_s,
-        border:     border.to_s,
-        foreground: foreground.to_s,
-        style:      style.to_s,
-        value:      value,
-        x:          x,
-        y:          y,
+        border:   border.to_s,
+        colour:   colour_to_hash,
+        parent:   parent_to_hash,
+        position: position_to_hash,
+        style:    style.to_s,
+        value:    value,
       }
     end
 
@@ -127,12 +132,25 @@ module Vedeu
       @to_html ||= Vedeu::HTMLChar.render(self)
     end
 
+    # @return [String]
+    def to_json
+      @to_json ||= JSON.generate(to_hash)
+    end
+
     private
 
     # @!attribute [r] attributes
     # @return [Hash]
     attr_reader :attributes
 
+    # @return [Hash]
+    def colour_to_hash
+      {
+        background: background.to_s,
+        foreground: foreground.to_s,
+      }
+    end
+
     # The default values for a new instance of this class.
     #
     # @return [Hash]
@@ -147,6 +165,23 @@ module Vedeu
       }
     end
 
+    # @return [Hash]
+    def parent_to_hash
+      {
+        background: parent_background.to_s,
+        foreground: parent_foreground.to_s,
+        style:      parent_style.to_s,
+      }
+    end
+
+    # @return [Hash]
+    def position_to_hash
+      {
+        y: y,
+        x: x,
+      }
+    end
+
   end # Char
 
 end # Vedeu

data/lib/vedeu/models/composition.rb

@@ -32,7 +32,7 @@ module Vedeu
     end
 
     # @param child [Vedeu::Interface]
-    # @return [void]
+    # @return [Vedeu::Interfaces]
     def add(child)
       @interfaces = interfaces.add(child)
     end
@@ -43,6 +43,13 @@ module Vedeu
     end
     alias_method :value, :interfaces
 
+    # Composition objects do not have a parent.
+    #
+    # @return [NilClass]
+    def parent
+      nil
+    end
+
     private
 
     # The default values for a new instance of this class.

data/lib/vedeu/models/focus.rb

@@ -42,7 +42,7 @@ module Vedeu
     # @return [String] The name of the interface now in focus.
     def by_name(name)
       fail ModelNotFound, "Cannot focus '#{name}' as this interface has not " \
-                          "been registered." unless registered?(name)
+                          'been registered.' unless registered?(name)
 
       storage.rotate!(storage.index(name))
 
@@ -82,7 +82,7 @@ module Vedeu
 
       update
     end
-    alias_method :next, :next_item
+    alias_method :next,       :next_item
     alias_method :focus_next, :next_item
 
     # Put the previous interface relative to the current interface in focus.
@@ -93,8 +93,8 @@ module Vedeu
 
       update
     end
-    alias_method :prev,     :prev_item
-    alias_method :previous, :prev_item
+    alias_method :prev,           :prev_item
+    alias_method :previous,       :prev_item
     alias_method :focus_previous, :prev_item
 
     # Refresh the interface in focus.

data/lib/vedeu/models/group.rb

@@ -37,7 +37,7 @@ module Vedeu
     def add(member)
       @members = members.add(member)
 
-      Vedeu::Group.new({ name: name, members: @members }).store
+      Vedeu::Group.new(name: name, members: @members).store
     end
 
     # Return the members as a Set.
@@ -54,14 +54,14 @@ module Vedeu
     def remove(member)
       @members = members.delete(member)
 
-      Vedeu::Group.new({ name: name, members: @members }).store
+      Vedeu::Group.new(name: name, members: @members).store
     end
 
     # Remove all members from the group.
     #
     # @return [Group]
     def reset
-      Vedeu::Group.new(defaults.merge!({ name: name })).store
+      Vedeu::Group.new(defaults.merge!(name: name)).store
     end
 
     private

data/lib/vedeu/models/interface.rb

@@ -1,4 +1,3 @@
-require 'vedeu/geometry/content'
 require 'vedeu/models/all'
 require 'vedeu/output/null_border'
 require 'vedeu/output/presentation'
@@ -22,10 +21,6 @@ module Vedeu
     collection Vedeu::Lines
     member     Vedeu::Line
 
-    # @!attribute [rw] colour
-    # @return [void]
-    attr_accessor :colour
-
     # @!attribute [rw] delay
     # @return [Fixnum|Float]
     attr_accessor :delay
@@ -42,33 +37,34 @@ module Vedeu
     # @return [Vedeu::Composition]
     attr_accessor :parent
 
-    # @!attribute [rw] style
+    # @!attribute [rw] visible
     # @return [String|Symbol]
-    attr_accessor :style
+    attr_accessor :visible
+    alias_method :visible?, :visible
 
     # @!attribute [w] lines
     # @return [Array<Vedeu::Line>]
     attr_writer :lines
 
     def_delegators :geometry,
-      :north,
-      :east,
-      :south,
-      :west,
-      :top,
-      :right,
-      :bottom,
-      :left,
-      :y,
-      :yn,
-      :x,
-      :xn,
-      :width,
-      :height,
-      :top_left,
-      :top_right,
-      :bottom_left,
-      :bottom_right
+                   :north,
+                   :east,
+                   :south,
+                   :west,
+                   :top,
+                   :right,
+                   :bottom,
+                   :left,
+                   :y,
+                   :yn,
+                   :x,
+                   :xn,
+                   :width,
+                   :height,
+                   :top_left,
+                   :top_right,
+                   :bottom_left,
+                   :bottom_right
 
     # Return a new instance of Vedeu::Interface.
     #
@@ -80,6 +76,7 @@ module Vedeu
     # @option attributes name [String]
     # @option attributes parent [Vedeu::Composition]
     # @option attributes style [Vedeu::Style]
+    # @option attributes visible [Boolean]
     # @return [Vedeu::Interface]
     def initialize(attributes = {})
       @attributes = defaults.merge!(attributes)
@@ -92,6 +89,7 @@ module Vedeu
       @parent     = @attributes[:parent]
       @repository = Vedeu.interfaces
       @style      = @attributes[:style]
+      @visible    = @attributes[:visible]
     end
 
     # @param child []
@@ -106,12 +104,13 @@ module Vedeu
     # @return [Hash]
     def attributes
       {
-        colour:   colour,
-        delay:    delay,
-        group:    group,
-        name:     name,
-        parent:   parent,
-        style:    style,
+        colour:  colour,
+        delay:   delay,
+        group:   group,
+        name:    name,
+        parent:  parent,
+        style:   style,
+        visible: true,
       }
     end
 
@@ -126,18 +125,12 @@ module Vedeu
     #
     # @return [Vedeu::Border|NilClass]
     def border
-      @border ||= if border?
-        Vedeu.borders.find(name)
-
-      else
-        Vedeu::NullBorder.new(self)
-
-      end
+      @border ||= Vedeu.borders.by_name(name)
     end
 
     # @return [Array<Array<Vedeu::Char>>]
     def clear
-      Vedeu::Clear.render(self)
+      Vedeu::Clear.new(self)
     end
 
     # Fetch the cursor belonging to this interface (by name), if one does not
@@ -150,7 +143,7 @@ module Vedeu
 
     # @return [Vedeu::Geometry]
     def geometry
-      @geometry ||= Vedeu.geometries.find(name)
+      @geometry ||= Vedeu.geometries.by_name(name)
     end
 
     # @return [Vedeu::Lines]
@@ -171,11 +164,19 @@ module Vedeu
 
     # @return [Array<Array<Vedeu::Char>>]
     def render
-      [
-        border.render,
-        clear,
-        viewport
-      ]
+      if visible?
+        [
+          hide_cursor,
+          clear.render,
+          border.render,
+          viewport.render,
+          show_cursor,
+        ]
+
+      else
+        []
+
+      end
     end
 
     # @return [Interface]
@@ -190,7 +191,7 @@ module Vedeu
 
     # @return [Array<Array<Vedeu::Char>>]
     def viewport
-      Vedeu::Viewport.render(self)
+      Vedeu::Viewport.new(self)
     end
 
     private
@@ -208,9 +209,24 @@ module Vedeu
         name:   '',
         parent: nil,
         style:  nil,
+        visible: true,
       }
     end
 
+    # @return [String]
+    def hide_cursor
+      return Vedeu::Esc.string(:hide_cursor) if cursor.visible?
+
+      ''
+    end
+
+    # @return [String]
+    def show_cursor
+      return Vedeu::Esc.string(:show_cursor) if cursor.visible?
+
+      ''
+    end
+
   end # Interface
 
 end # Vedeu

data/lib/vedeu/models/line.rb

@@ -73,7 +73,7 @@ module Vedeu
     #
     # @return [Fixnum]
     def size
-      streams.map(&:size).inject(0, :+) { |sum, x| sum += x }
+      streams.map(&:size).inject(0, :+)
     end
 
     # @return [Vedeu::Streams]

data/lib/vedeu/models/null.rb

@@ -0,0 +1,48 @@
+module Vedeu
+
+  # Represents a empty model.
+  #
+  class Null
+
+    # @return [Vedeu::Null]
+    def initialize; end
+
+    # @return [NilClass]
+    def add(*)
+      nil
+    end
+
+    # @return [NilClass]
+    def colour
+      nil
+    end
+
+    # @return [NilClass]
+    def parent
+      nil
+    end
+
+    # @return [Vedeu::Null]
+    def store
+      self
+    end
+
+    # @return [NilClass]
+    def style
+      nil
+    end
+
+    # @return [FalseClass]
+    def visible?
+      false
+    end
+    alias_method :visible, :visible?
+
+    # @return [FalseClass]
+    def visible=(*)
+      false
+    end
+
+  end # Null
+
+end # Vedeu

data/lib/vedeu/models/stream.rb

@@ -59,11 +59,11 @@ module Vedeu
       return [] if value.empty?
 
       value.chars.map do |char|
-        member.new({ value:    char,
-                     parent:   parent,
-                     colour:   colour,
-                     style:    style,
-                     position: nil })
+        member.new(value:    char,
+                   parent:   parent,
+                   colour:   colour,
+                   style:    style,
+                   position: nil)
       end
     end
 

data/lib/vedeu/output/all.rb

@@ -1,30 +1,20 @@
-require 'vedeu/output/esc'
-
-require 'vedeu/output/translator'
-require 'vedeu/output/background'
-require 'vedeu/output/foreground'
-
-require 'vedeu/output/border'
-require 'vedeu/output/null_border'
-require 'vedeu/output/colour'
-require 'vedeu/output/compositor'
-
-require 'vedeu/output/clear'
-
-require 'vedeu/output/presentation'
-require 'vedeu/output/style'
-require 'vedeu/output/text'
-require 'vedeu/output/virtual_buffer'
-require 'vedeu/output/html_char'
-require 'vedeu/output/refresh'
-
-require 'vedeu/output/renderers/all'
-
-require 'vedeu/output/output'
-
-require 'vedeu/output/viewport'
-require 'vedeu/output/virtual_terminal'
-require 'vedeu/output/wordwrap'
-
-module Vedeu
-end # Vedeu
+require_relative 'esc'
+require_relative 'translator'
+require_relative 'background'
+require_relative 'foreground'
+require_relative 'border'
+require_relative 'null_border'
+require_relative 'colour'
+require_relative 'compressor'
+require_relative 'clear'
+require_relative 'presentation'
+require_relative 'style'
+require_relative 'text'
+require_relative 'virtual_buffer'
+require_relative 'html_char'
+require_relative 'refresh'
+require_relative 'renderers/all'
+require_relative 'output'
+require_relative 'viewport'
+require_relative 'virtual_terminal'
+require_relative 'wordwrap'