vedeu 0.1.15 → 0.1.16

data/lib/vedeu/models/composition.rb

@@ -1,20 +1,36 @@
 module Vedeu
   class Composition
-    def initialize(attributes = {})
-      @attributes = attributes
+
+    attr_reader :attributes
+
+    # @param attributes [Hash]
+    # @param block [Proc]
+    # @return [Hash]
+    def self.build(attributes = {}, &block)
+      new(attributes, &block).attributes
     end
 
-    def attributes
-      @_attributes ||= defaults.merge!(@attributes)
+    # @param attributes [Hash]
+    # @param block [Proc]
+    # @return [Composition]
+    def initialize(attributes = {}, &block)
+      @attributes = defaults.merge!(attributes)
+
+      if block_given?
+        @self_before_instance_eval = eval('self', block.binding)
+
+        instance_eval(&block)
+      end
     end
 
+    # @return [Array]
     def interfaces
       @interfaces ||= if attributes[:interfaces].nil? || attributes[:interfaces].empty?
         []
 
       else
         [ attributes[:interfaces] ].flatten.map do |attrs|
-          stored = Store.query(attrs[:name])
+          stored = Buffers.retrieve_attributes(attrs[:name])
 
           combined = stored.merge(attrs) do |key, s, a|
             key == :lines && s.empty? ? a : s
@@ -26,6 +42,7 @@ module Vedeu
       end
     end
 
+    # @return [String]
     def to_s
       interfaces.map(&:to_s).join
     end
@@ -37,5 +54,6 @@ module Vedeu
         interfaces: []
       }
     end
+
   end
 end

data/lib/vedeu/models/geometry.rb

@@ -1,73 +1,157 @@
 module Vedeu
   class Geometry
+
+    attr_reader :attributes, :centred, :height, :width
+
+    # @param attributes [Hash]
+    # @return [Geometry]
     def initialize(attributes = {})
-      @attributes = attributes
-    end
+      @attributes = defaults.merge!(attributes)
 
-    def attributes
-      defaults.merge!(@attributes)
+      @centred = @attributes[:centred]
+      @height  = @attributes[:height]
+      @width   = @attributes[:width]
     end
 
+    # @return [Fixnum]
     def y
-      @y ||= attributes[:y]
+      if attributes[:y].is_a?(Proc)
+        attributes[:y].call
+
+      else
+        attributes[:y]
+
+      end
     end
 
+    # @return [Fixnum]
     def x
-      @x ||= attributes[:x]
-    end
+      if attributes[:x].is_a?(Proc)
+        attributes[:x].call
+
+      else
+        attributes[:x]
 
-    def width
-      @width ||= attributes[:width]
+      end
     end
 
-    def height
-      @height ||= attributes[:height]
+    # @return [Fixnum]
+    def viewport_width
+      if (x + width) > Terminal.width
+        width - ((x + width) - Terminal.width)
+
+      else
+        width
+
+      end
     end
 
-    def centred
-      @centred ||= attributes[:centred]
+    # @return [Fixnum]
+    def viewport_height
+      if (y + height) > Terminal.height
+        height - ((y + height) - Terminal.height)
+
+      else
+        height
+
+      end
     end
 
+    # @param index [Fixnum]
+    # @param block [Proc]
+    # @return [String]
     def origin(index = 0, &block)
       Esc.set_position(virtual_y[index], left, &block)
     end
 
+    # @return [Fixnum]
     def top
       if centred
-        centre_y - (height / 2)
+        centre_y - (viewport_height / 2)
+
       else
         y
+
       end
     end
 
+    # Returns the row above the top by default.
+    #
+    # @example
+    #   `top` is 4.
+    #
+    #   north     # => 3
+    #   north(2)  # => 2
+    #   north(-4) # => 8
+    #
+    # @param value [Fixnum]
+    # @return [Fixnum]
     def north(value = 1)
       top - value
     end
 
+    # @return [Fixnum]
     def left
       if centred
-        centre_x - (width / 2)
+        centre_x - (viewport_width / 2)
+
       else
         x
+
       end
     end
 
+    # Returns the column before left by default.
+    #
+    # @example
+    #   `left` is 8.
+    #
+    #   west      # => 7
+    #   west(2)   # => 6
+    #   west(-4)  # => 12
+    #
+    # @param value [Fixnum]
+    # @return [Fixnum]
     def west(value = 1)
       left - value
     end
 
+    # @return [Fixnum]
     def bottom
       top + height
     end
 
+    # Returns the row below the bottom by default.
+    #
+    # @example
+    #   `bottom` is 12.
+    #
+    #   south     # => 13
+    #   south(2)  # => 14
+    #   south(-4) # => 8
+    #
+    # @param value [Fixnum]
+    # @return [Fixnum]
     def south(value = 1)
       bottom + value
     end
 
+    # @return [Fixnum]
     def right
       left + width
     end
 
+    # Returns the column after right by default.
+    #
+    # @example
+    #   `right` is 19.
+    #
+    #   east     # => 20
+    #   east(2)  # => 21
+    #   east(-4) # => 15
+    #
+    # @param value [Fixnum]
+    # @return [Fixnum]
     def east(value = 1)
       right + value
     end
@@ -75,7 +159,7 @@ module Vedeu
     private
 
     def centre
-      @_centre ||= Terminal.centre
+      Terminal.centre
     end
 
     def centre_y
@@ -99,5 +183,6 @@ module Vedeu
         centred: false,
       }
     end
+
   end
 end

data/lib/vedeu/models/interface.rb

@@ -1,45 +1,54 @@
 module Vedeu
   class Interface
+    include Coercions
+    include Presentation
+
     extend Forwardable
 
     def_delegators :geometry, :north, :east, :south, :west,
                               :top, :right, :bottom, :left,
-                              :width, :height, :origin
+                              :width, :height, :origin,
+                              :viewport_width, :viewport_height
 
-    def initialize(attributes = {})
-      @attributes = attributes
-    end
+    attr_reader :attributes, :delay, :group, :name
 
-    def attributes
-      @_attributes ||= defaults.merge!(@attributes)
+    # @param  attributes [Hash]
+    # @param  block [Proc]
+    # @return [Hash]
+    def self.build(attributes = {}, &block)
+      new(attributes, &block).attributes
     end
 
-    def name
-      @name ||= attributes[:name]
-    end
+    # @param  attributes [Hash]
+    # @param  block [Proc]
+    # @return [Interface]
+    def initialize(attributes = {}, &block)
+      @attributes = defaults.merge!(attributes)
 
-    def group
-      @group ||= attributes[:group]
-    end
+      @name  = @attributes[:name]
+      @group = @attributes[:group]
+      @delay = @attributes[:delay]
 
-    def lines
-      @lines ||= Attributes.coercer(attributes[:lines], Line, :streams)
-    end
+      if block_given?
+        @self_before_instance_eval = eval('self', block.binding)
 
-    def colour
-      @colour ||= Colour.new(attributes[:colour])
+        instance_eval(&block)
+      end
     end
 
-    def style
-      @style ||= Attributes.coerce_styles(attributes[:style])
+    # @return [Array]
+    def lines
+      @lines ||= Line.coercer(attributes[:lines])
     end
 
+    # @return [Geometry]
     def geometry
       @geometry ||= Geometry.new(attributes[:geometry])
     end
 
+    # @return [String]
     def cursor
-      @cursor ||= if cursor?
+      @cursor ||= if attributes[:cursor] == true
         Esc.string('show_cursor')
 
       else
@@ -48,20 +57,18 @@ module Vedeu
       end
     end
 
-    def delay
-      @delay || attributes[:delay]
-    end
-
+    # @return [String]
     def to_s
       Render.call(self)
     end
 
-    private
-
-    def cursor?
-      attributes[:cursor] == true
+    # @return [String]
+    def clear
+      Clear.call(self)
     end
 
+    private
+
     def defaults
       {
         name:     '',
@@ -74,5 +81,6 @@ module Vedeu
         delay:    0.0
       }
     end
+
   end
 end

data/lib/vedeu/models/line.rb

@@ -1,11 +1,22 @@
 module Vedeu
   class Line
+    include Coercions
+    include Presentation
+
+    attr_reader :attributes
+
+    # @param attributes [Hash]
+    # @param block [Proc]
+    # @return [Hash]
     def self.build(attributes = {}, &block)
       new(attributes, &block).attributes
     end
 
+    # @param attributes [Hash]
+    # @param block [Proc]
+    # @return [Line]
     def initialize(attributes = {}, &block)
-      @attributes = attributes
+      @attributes = defaults.merge!(attributes)
 
       if block_given?
         @self_before_instance_eval = eval('self', block.binding)
@@ -14,22 +25,12 @@ module Vedeu
       end
     end
 
-    def attributes
-      @_attributes ||= defaults.merge!(@attributes)
-    end
-
-    def colour
-      @colour ||= Colour.new(attributes[:colour])
-    end
-
+    # @return [Array]
     def streams
-      @streams ||= Attributes.coercer(attributes[:streams], Stream, :text)
-    end
-
-    def style
-      @style ||= Attributes.coerce_styles(attributes[:style])
+      @streams ||= Stream.coercer(attributes[:streams])
     end
 
+    # @return [String]
     def to_s
       [ colour, style, streams ].join
     end
@@ -47,5 +48,6 @@ module Vedeu
     def method_missing(method, *args, &block)
       @self_before_instance_eval.send(method, *args, &block)
     end
+
   end
 end

data/lib/vedeu/models/stream.rb

@@ -1,11 +1,25 @@
 module Vedeu
   class Stream
+    include Coercions
+    include Presentation
+
+    attr_reader :attributes, :align, :text, :width
+
+    # @param attributes [Hash]
+    # @param block [Proc]
+    # @return [Hash]
     def self.build(attributes = {}, &block)
       new(attributes, &block).attributes
     end
 
+    # @param attributes [Hash]
+    # @param block [Proc]
+    # @return [Stream]
     def initialize(attributes = {}, &block)
-      @attributes = attributes
+      @attributes = defaults.merge!(attributes)
+      @align      = @attributes[:align]
+      @text       = @attributes[:text]
+      @width      = @attributes[:width]
 
       if block_given?
         @self_before_instance_eval = eval('self', block.binding)
@@ -14,30 +28,7 @@ module Vedeu
       end
     end
 
-    def attributes
-      @_attributes ||= defaults.merge!(@attributes)
-    end
-
-    def colour
-      @colour ||= Colour.new(attributes[:colour])
-    end
-
-    def style
-      @style ||= Attributes.coerce_styles(attributes[:style])
-    end
-
-    def text
-      @text ||= attributes[:text]
-    end
-
-    def width
-      @width ||= attributes[:width]
-    end
-
-    def align
-      @align ||= attributes[:align]
-    end
-
+    # @return [String]
     def to_s
       [ colour, style, data ].join
     end
@@ -73,5 +64,6 @@ module Vedeu
     def method_missing(method, *args, &block)
       @self_before_instance_eval.send(method, *args, &block)
     end
+
   end
 end