vedeu 0.8.4 → 0.8.5

data/lib/vedeu/all.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
-require 'vedeu/version'
-
 require 'vedeu/boolean'
 require 'vedeu/common'
 require 'vedeu/error'
+require 'vedeu/sentence'
+require 'vedeu/version'
+
+require 'vedeu/support/point'
 
 require 'vedeu/configuration/all'
 require 'vedeu/esc/all'

data/lib/vedeu/borders/border.rb

@@ -37,10 +37,10 @@ module Vedeu
       #   horizontal border if enabled.
       attr_writer :bottom_horizontal
 
-      # @!attribute [rw] caption
+      # @!attribute [r] caption
       # @return [String] An optional caption for when the bottom
       #   border is to be shown.
-      attr_accessor :caption
+      attr_reader :caption
 
       # @!attribute [rw] horizontal
       # @return [String] The character to be used for the horizontal
@@ -71,10 +71,10 @@ module Vedeu
       attr_accessor :show_top
       alias_method :top?, :show_top
 
-      # @!attribute [rw] title
+      # @!attribute [r] title
       # @return [String] An optional title for when the top border is
       #   to be shown.
-      attr_accessor :title
+      attr_reader :title
 
       # @!attribute [w] top_left
       # @return [String] The character to be used for the top left
@@ -177,7 +177,7 @@ module Vedeu
           bottom_horizontal: bottom_horizontal,
           bottom_left:       bottom_left,
           bottom_right:      bottom_right,
-          caption:           @caption,
+          caption:           caption,
           client:            @client,
           colour:            colour,
           enabled:           @enabled,
@@ -192,7 +192,7 @@ module Vedeu
           show_right:        @show_right,
           show_top:          @show_top,
           style:             style,
-          title:             @title,
+          title:             title,
           top_horizontal:    top_horizontal,
           top_left:          top_left,
           top_right:         top_right,
@@ -200,6 +200,14 @@ module Vedeu
         }
       end
 
+      # @param value [String]
+      # @return [Vedeu::Borders::Border]
+      def caption=(value)
+        @caption = value
+
+        store
+      end
+
       # Returns a DSL instance responsible for defining the DSL
       # methods of this model.
       #
@@ -277,6 +285,14 @@ module Vedeu
         @bottom_right ||= Vedeu::Cells::BottomRight.new(cell_attributes)
       end
 
+      # @param value [String]
+      # @return [Vedeu::Borders::Border]
+      def title=(value)
+        @title = value
+
+        store
+      end
+
       private
 
       # @return [Hash<Symbol => void>]

data/lib/vedeu/borders/repository.rb

@@ -30,18 +30,14 @@ module Vedeu
 
   # :nocov:
 
-  # See {file:docs/borders.md#label-3A_set_border_caption_}
+  # See {file:docs/events/by_name/set_border_caption.md}
   Vedeu.bind(:_set_border_caption_) do |name, caption|
-    if Vedeu.borders.registered?(name)
-      Vedeu.borders.by_name(name).caption = caption
-    end
+    Vedeu.borders.by_name(name).caption = caption
   end
 
-  # See {file:docs/borders.md#label-3A_set_border_title_}
+  # See {file:docs/events/by_name/set_border_title.md}
   Vedeu.bind(:_set_border_title_) do |name, title|
-    if Vedeu.borders.registered?(name)
-      Vedeu.borders.by_name(name).title = title
-    end
+    Vedeu.borders.by_name(name).title = title
   end
 
   # :nocov:

data/lib/vedeu/buffers/buffer.rb

@@ -52,17 +52,20 @@ module Vedeu
         end
       end
 
-      # Add the content to the back buffer, then update the
-      # repository. Returns boolean indicating that the repository was
-      # updated.
+      # Add the view to the back buffer, then update the repository.
+      # Returns boolean indicating that the repository was updated.
       #
-      # @param content [Vedeu::Views::View]
+      # @param view [Vedeu::Views::View]
+      # @param refresh [Boolean] Should the view be refreshed once
+      #   stored? Default: false.
       # @return [Boolean]
-      def add(content)
-        @back = content
+      def add(view, refresh = false)
+        @back = view
 
         store
 
+        Vedeu.trigger(:_refresh_view_, view.name) if boolean(refresh)
+
         true
       end
 

data/lib/vedeu/buffers/empty.rb

@@ -12,37 +12,29 @@ module Vedeu
 
       include Vedeu::Repositories::Defaults
 
+      # @!attribute [r] height
+      # @return [Fixnum]
+      attr_reader :height
+
       # @!attribute [r] name
       # @return [NilClass|String|Symbol]
       attr_reader :name
 
-      # @return [Array<Array<Vedeu::Cells::Empty>>]
-      def buffer
-        Array.new(height) do |y|
-          if y > 0
-            Array.new(width) do |x|
-              Vedeu::Cells::Empty.new(name: name, position: [y, x]) if x > 0
-            end.compact
-          end
-        end.compact
-      end
+      # @!attribute [r] width
+      # @return [Fixnum]
+      attr_reader :width
 
-      # @note
-      #   We add 1 to both the width and height as terminal screens
-      #   are 1-indexed.
-      #
+      # @!attribute [r] x
       # @return [Fixnum]
-      def height
-        @height + 1
-      end
+      attr_reader :x
 
-      # @note
-      #   We add 1 to both the width and height as terminal screens
-      #   are 1-indexed.
-      #
+      # @!attribute [r] y
       # @return [Fixnum]
-      def width
-        @width + 1
+      attr_reader :y
+
+      # @return [Array<Array<Vedeu::Cells::Empty>>]
+      def buffer
+        @buffer ||= empty
       end
 
       private
@@ -55,9 +47,20 @@ module Vedeu
           height: Vedeu.height,
           name:   nil,
           width:  Vedeu.width,
+          x:      1,
+          y:      1,
         }
       end
 
+      # @return [Array<Array<Vedeu::Cells::Empty>>]
+      def empty
+        Array.new(height) do |h|
+          Array.new(width) do |w|
+            Vedeu::Cells::Empty.new(name: name, position: [y + h, x + w])
+          end
+        end
+      end
+
     end # Empty
 
   end # Buffers

data/lib/vedeu/buffers/view.rb

@@ -12,6 +12,15 @@ module Vedeu
 
       include Vedeu::Repositories::Defaults
       include Enumerable
+      extend Forwardable
+
+      def_delegators :geometry,
+                     :bordered_height,
+                     :bordered_width,
+                     :bx,
+                     :by,
+                     :byn,
+                     :bxn
 
       # @return [Hash<Symbol => String|Symbol>]
       def attributes
@@ -39,12 +48,7 @@ module Vedeu
       #   Vedeu::Cells::Char]
       # @return [Vedeu::Buffers::View]
       def update(value_or_values)
-        Array(value_or_values).flatten.each do |value|
-          if valid?(value)
-            current[value.position.y][value.position.x] = value
-            dirty << value.position.to_a
-          end
-        end
+        Array(value_or_values).flatten.each { |value| write(value) }
 
         self
       end
@@ -57,41 +61,22 @@ module Vedeu
 
       private
 
-      # @return [Vedeu::Buffers::Empty]
-      def buffer
-        @_buffer ||= Vedeu::Buffers::Empty
-                       .new(height: geometry.bordered_height,
-                            name:   name,
-                            width:  geometry.bordered_width).buffer
-      end
-
       # @return [Array<Vedeu::Cells::Empty>]
       def current
-        @current ||= buffer
-      end
-
-      # @return [Vedeu::Buffers::Empty]
-      def current_reset!
-        @current = buffer
+        @current ||= Vedeu::Buffers::Empty.new(height: bordered_height,
+                                               name:   name,
+                                               width:  bordered_width,
+                                               x:      bx,
+                                               y:      by).buffer
       end
 
       # @return [Hash<Symbol => NilClass|String|Symbol]
       def defaults
         {
-          name: ''
+          name: nil
         }
       end
 
-      # @return [Vedeu::Buffers::Empty]
-      def dirty
-        @dirty ||= []
-      end
-
-      # @return [Vedeu::Buffers::Empty]
-      def dirty_reset!
-        @dirty = []
-      end
-
       # @return [Vedeu::Geometries::Geometry]
       def geometry
         @_geometry ||= Vedeu.geometries.by_name(name)
@@ -103,16 +88,9 @@ module Vedeu
       # @param value [void]
       # @return [Boolean]
       def valid?(value)
-        valid_value?(value) && valid_position?(value)
-      end
-
-      # Returns a boolean indicating whether the position of the value
-      # object is valid for this terminal.
-      #
-      # @param value [void]
-      # @return [Boolean]
-      def valid_position?(value)
-        buffer[value.position.y] && buffer[value.position.y][value.position.x]
+        valid_value?(value)        &&
+        valid_y?(value.position.y) &&
+        valid_x?(value.position.x)
       end
 
       # Returns a boolean indicating the value has a position
@@ -125,6 +103,31 @@ module Vedeu
           value.position.is_a?(Vedeu::Geometries::Position)
       end
 
+      # Returns a boolean indicating whether the x position of the
+      # value object is valid for this geometry.
+      #
+      # @return [Boolean]
+      def valid_x?(x)
+        Vedeu::Point.valid?(value: x, min: bx, max: bxn)
+      end
+
+      # Returns a boolean indicating whether the y position of the
+      # value object is valid for this geometry.
+      #
+      # @return [Boolean]
+      def valid_y?(y)
+        Vedeu::Point.valid?(value: y, min: by, max: byn)
+      end
+
+      def write(value)
+        if valid?(value)
+          row    = by - value.position.y
+          column = bx - value.position.x
+
+          current[row][column] = value
+        end
+      end
+
     end # View
 
   end # Buffers

data/lib/vedeu/cells/cursor.rb

@@ -11,8 +11,6 @@ module Vedeu
     #
     class Cursor < Vedeu::Cells::Empty
 
-      include Vedeu::Geometries::Positionable
-
       # @return [Boolean]
       def cell?
         false

data/lib/vedeu/cells/empty.rb

@@ -14,7 +14,6 @@ module Vedeu
     #
     class Empty
 
-      include Comparable
       include Vedeu::Presentation
       include Vedeu::Repositories::Defaults
 

data/lib/vedeu/cells/escape.rb

@@ -19,8 +19,6 @@ module Vedeu
     #
     class Escape < Vedeu::Cells::Empty
 
-      include Vedeu::Geometries::Positionable
-
       # @return [Boolean]
       def cell?
         false

data/lib/vedeu/coercers/alignment.rb

@@ -21,23 +21,30 @@ module Vedeu
       # @return [Symbol]
       attr_reader :value
 
-      # @param value [Symbol|Vedeu::Coercers::Alignment]
-      # @return [Vedeu::Coercers::Alignment]
+      # @param (see #initialize)
+      # @return (see #coerce)
       def self.coerce(value = :none)
         return value if value.is_a?(self)
 
         new(value).coerce
       end
 
+      # @param (see #initialize)
+      # @raise (see #validate)
+      # @return (see #validate)
+      def self.validate(value)
+        new(value).validate
+      end
+
       # Returns a new instance of Vedeu::Coercers::Alignment.
       #
-      # @param value [Symbol]
+      # @param value [Symbol|Vedeu::Coercers::Alignment]
       # @return [Vedeu::Coercers::Alignment]
       def initialize(value = :none)
         @value = value || :none
       end
 
-      # @return [Symbol]
+      # @return [Vedeu::Coercers::Alignment]
       def coerce
         if value == :center
           @value = :centre
@@ -117,21 +124,64 @@ module Vedeu
       #
       # @return [Boolean]
       def valid?
-        present?(value) && value.is_a?(Symbol) && values.include?(value)
+        valid_type? && values.include?(value)
+      end
+
+      # @raise [Vedeu::Error::InvalidSyntax] When the value is missing or
+      #   invalid.
+      # @return [Boolean]
+      def validate
+        return coerce if valid_horizontal? || valid_vertical?
+
+        fail Vedeu::Error::InvalidSyntax,
+             'Missing or invalid alignment value. ' \
+             "Valid values are: #{to_sentence}"
+      end
+
+      # @return [Boolean]
+      def valid_horizontal?
+        valid_type? && horizontal_values.include?(value)
+      end
+
+      # @return [Boolean]
+      def valid_vertical?
+        valid_type? && vertical_values.include?(value)
       end
 
       private
 
       # @return [Array<Symbol>]
-      def values
+      def horizontal_values
         [
-          :bottom,
           :centre,
           :center,
           :left,
-          :middle,
           :none,
           :right,
+        ]
+      end
+
+      # @return [String]
+      def to_sentence
+        Vedeu::Sentence.construct(values)
+      end
+
+      # @return [Boolean]
+      def valid_type?
+        present?(value) && value.is_a?(Symbol)
+      end
+
+      # @return [Array<Symbol>]
+      def values
+        horizontal_values | vertical_values
+      end
+
+      # @return [Array<Symbol>]
+      def vertical_values
+        [
+          :bottom,
+          :middle,
+          :none,
           :top,
         ]
       end