vedeu 0.8.4 → 0.8.5

data/lib/vedeu/output/viewport.rb

@@ -67,48 +67,14 @@ module Vedeu
 
       private
 
-      # @return [Array<Array<Vedeu::Cells::Char>>]
-      def output
-        Vedeu.timer("Rendering content: '#{name}'") do
-          out = []
-
-          show.each_with_index do |line, iy|
-            line.each_with_index do |column, ix|
-              column.position = [by + iy, bx + ix]
-              out << column
-            end
-          end
-
-          out
-        end
-      end
-
-      # Returns the visible content for the view.
-      #
-      # @note If there are no lines of content, we return an empty
-      #   array. If there are no more columns of content we return a
-      #   space enclosed in an array; this prevents a weird line
-      #   hopping bug which occurs when the current line has no more
-      #   content, but subsequent lines do.
-      #
-      # @return [Array]
-      def show
-        (lines[rows] || []).map { |line| (line.chars[columns] || []) }
+      # @return [Fixnum]
+      def bx
+        @bx ||= geometry.bx
       end
 
-      # Using the current cursor's y position, return a range of
-      # visible lines.
-      #
-      # Scrolls the content vertically when the stored cursor's y
-      # position for the interface is outside of the visible area.
-      #
-      # @note
-      #   The height is reduced by one as #rows is a range of Array
-      #   elements.
-      #
-      # @return [Range]
-      def rows
-        top...(top + bordered_height)
+      # @return [Fixnum]
+      def by
+        @by ||= geometry.by
       end
 
       # Using the current cursor's x position, return a range of
@@ -126,16 +92,6 @@ module Vedeu
         left...(left + bordered_width)
       end
 
-      # @return [Fixnum]
-      def left
-        @left ||= content_offset(ox, bordered_width)
-      end
-
-      # @return [Fixnum]
-      def top
-        @top ||= content_offset(oy, bordered_height)
-      end
-
       # Returns the offset for the content (the number of rows or
       # columns to change the viewport by on either the y or x axis)
       # determined by the offset (the cursor's y or x offset position.
@@ -149,6 +105,12 @@ module Vedeu
         offset - dimension
       end
 
+      # @return [Vedeu::Cursors::Cursor]
+      # @see Vedeu::Cursors::Repository#by_name
+      def cursor
+        @cursor ||= Vedeu.cursors.by_name(name)
+      end
+
       # Returns the geometry for the interface.
       #
       # @return (see Vedeu::Geometries::Repository#by_name)
@@ -157,19 +119,57 @@ module Vedeu
       end
 
       # @return [Fixnum]
-      def bx
-        @bx ||= geometry.bx
+      def left
+        @left ||= content_offset(ox, bordered_width)
       end
 
-      # @return [Fixnum]
-      def by
-        @by ||= geometry.by
+      # @return [Array<Array<Vedeu::Cells::Char>>]
+      def output
+        Vedeu.timer("Rendering content: '#{name}'") do
+          out = []
+
+          show.each_with_index do |line, iy|
+            line.each_with_index do |column, ix|
+              column.position = [by + iy, bx + ix]
+              out << column
+            end
+          end
+
+          out
+        end
       end
 
-      # @return [Vedeu::Cursors::Cursor]
-      # @see Vedeu::Cursors::Repository#by_name
-      def cursor
-        @cursor ||= Vedeu.cursors.by_name(name)
+      # Using the current cursor's y position, return a range of
+      # visible lines.
+      #
+      # Scrolls the content vertically when the stored cursor's y
+      # position for the interface is outside of the visible area.
+      #
+      # @note
+      #   The height is reduced by one as #rows is a range of Array
+      #   elements.
+      #
+      # @return [Range]
+      def rows
+        top...(top + bordered_height)
+      end
+
+      # Returns the visible content for the view.
+      #
+      # @note If there are no lines of content, we return an empty
+      #   array. If there are no more columns of content we return a
+      #   space enclosed in an array; this prevents a weird line
+      #   hopping bug which occurs when the current line has no more
+      #   content, but subsequent lines do.
+      #
+      # @return [Array]
+      def show
+        (lines[rows] || []).map { |line| (line.chars[columns] || []) }
+      end
+
+      # @return [Fixnum]
+      def top
+        @top ||= content_offset(oy, bordered_height)
       end
 
     end # Viewport

data/lib/vedeu/presentation/all.rb

@@ -11,9 +11,8 @@ module Vedeu
 
 end # Vedeu
 
-require 'vedeu/presentation/background'
-require 'vedeu/presentation/foreground'
 require 'vedeu/presentation/colour'
+require 'vedeu/presentation/position'
 require 'vedeu/presentation/styles'
 require 'vedeu/presentation/style'
 require 'vedeu/presentation/presentation'

data/lib/vedeu/presentation/colour.rb

@@ -10,9 +10,35 @@ module Vedeu
     #
     module Colour
 
-      include Vedeu::Repositories::Parent
-      include Vedeu::Presentation::Colour::Background
-      include Vedeu::Presentation::Colour::Foreground
+      # When the background colour for the model exists, return it,
+      # otherwise returns the parent background colour, or an empty
+      # Vedeu::Colours::Background.
+      #
+      # @return [Vedeu::Colours::Background]
+      def background
+        @background ||= if colour && present?(colour.background)
+                          colour.background
+
+                        elsif named_colour?
+                          named_colour.background
+
+                        elsif parent && present?(parent.background)
+                          parent.background
+
+                        else
+                          Vedeu::Colours::Background.new
+
+                        end
+      end
+
+      # Allows the setting of the background colour by coercing the
+      # given value into a Vedeu::Colours::Background colour.
+      #
+      # @return [Vedeu::Colours::Background]
+      def background=(value)
+        @background = colour.background = value
+        @_colour = @colour = colour
+      end
 
       # @return [Vedeu::Colours::Colour]
       def colour
@@ -44,6 +70,52 @@ module Vedeu
         present?(@colour)
       end
 
+      # When the foreground colour for the model exists, return it,
+      # otherwise returns the parent foreground colour, or an empty
+      # Vedeu::Colours::Foreground.
+      #
+      # @return [Vedeu::Colours::Foreground]
+      def foreground
+        @foreground ||= if colour && present?(colour.foreground)
+                          colour.foreground
+
+                        elsif named_colour?
+                          named_colour.foreground
+
+                        elsif parent && present?(parent.foreground)
+                          parent.foreground
+
+                        else
+                          Vedeu::Colours::Foreground.new
+
+                        end
+      end
+
+      # Allows the setting of the foreground colour by coercing the
+      # given value into a Vedeu::Colours::Foreground colour.
+      #
+      # @return [Vedeu::Colours::Foreground]
+      def foreground=(value)
+        @foreground = colour.foreground = value
+        @_colour = @colour = colour
+      end
+
+      # @return [NilClass|void]
+      def parent
+        present?(@parent) ? @parent : nil
+      end
+
+      # @return [NilClass|String|Symbol]
+      def name
+        if present?(@name)
+          @name
+
+        elsif parent && present?(parent.name)
+          parent.name
+
+        end
+      end
+
       private
 
       # @return [Vedeu::Colours::Colour]

data/lib/vedeu/{geometries/positionable.rb → presentation/position.rb}

@@ -2,13 +2,13 @@
 
 module Vedeu
 
-  module Geometries
+  module Presentation
 
     # Provide position functionality to the including model.
     #
     # @api private
     #
-    module Positionable
+    module Position
 
       # Gets the position.
       #
@@ -50,8 +50,8 @@ module Vedeu
         position.y if position?
       end
 
-    end # Positionable
+    end # Position
 
-  end # Geometries
+  end # Presentation
 
 end # Vedeu

data/lib/vedeu/presentation/presentation.rb

@@ -1,13 +1,11 @@
-require 'vedeu/geometries/positionable'
-
 # frozen_string_literal: true
 
 module Vedeu
 
   module Presentation
 
-    include Vedeu::Geometries::Positionable
     include Vedeu::Presentation::Colour
+    include Vedeu::Presentation::Position
     include Vedeu::Presentation::Styles
 
     # Converts the colours and styles to escape sequences, and when

data/lib/vedeu/presentation/styles.rb

@@ -9,7 +9,22 @@ module Vedeu
     module Styles
 
       include Vedeu::Common
-      include Vedeu::Repositories::Parent
+
+      # @return [NilClass|String|Symbol]
+      def name
+        if present?(@name)
+          @name
+
+        elsif parent && present?(parent.name)
+          parent.name
+
+        end
+      end
+
+      # @return [NilClass|void]
+      def parent
+        present?(@parent) ? @parent : nil
+      end
 
       # When the style for the model exists, return it, otherwise
       # returns the parent style, or an empty

data/lib/vedeu/repositories/all.rb

@@ -15,7 +15,6 @@ require 'vedeu/repositories/collection'
 require 'vedeu/repositories/defaults'
 require 'vedeu/repositories/repositories'
 require 'vedeu/repositories/model'
-require 'vedeu/repositories/parent'
 require 'vedeu/repositories/store'
 require 'vedeu/repositories/registerable'
 require 'vedeu/repositories/repository'

data/lib/vedeu/sentence.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Vedeu
+
+  # Converts the array of elements provided into a comma separated
+  # sentence with the penultimate and ultimate elements separated with
+  # the word 'and'.
+  #
+  class Sentence
+
+    # @param (see #initialize)
+    # @return (see #construct)
+    def self.construct(elements, label = 'elements')
+      new(elements, label).construct
+    end
+
+    # @param elements [Array]
+    # @param label [String]
+    # @return [Vedeu::Sentence]
+    def initialize(elements, label = 'elements')
+      @elements = elements
+      @label    = label
+    end
+
+    # @return [String]
+    def construct
+      if one?
+        first
+
+      elsif two?
+        elements.join(' and ')
+
+      elsif many?
+        [but_last, last].join(' and ')
+
+      else
+        "No #{label} have been assigned."
+
+      end
+    end
+
+    protected
+
+    # @!attribute [r] elements
+    # @return [Array]
+    attr_reader :elements
+
+    # @!attribute [r] label
+    # @return [String]
+    attr_reader :label
+
+    private
+
+    # @return [Boolean]
+    def one?
+      count == 1
+    end
+
+    # @return [Boolean]
+    def two?
+      count == 2
+    end
+
+    # @return [Boolean]
+    def many?
+      count > 2
+    end
+
+    # @return [Array]
+    def but_last
+      elements[0...-1].join(', ')
+    end
+
+    # @return [void]
+    def first
+      elements.first
+    end
+
+    # @return [void]
+    def last
+      elements[-1]
+    end
+
+    # @return [Fixnum]
+    def count
+      elements.size
+    end
+
+  end # Sentence
+
+end # Vedeu

data/lib/vedeu/support/point.rb

@@ -0,0 +1,72 @@
+module Vedeu
+
+  class Point
+
+    # @param (see #initialize)
+    # @return (see #initialize)
+    def self.coerce(value: nil, min: 1, max: nil)
+      new(value: value, min: min, max: max).coerce
+    end
+
+    # @param (see #initialize)
+    # @return (see #initialize)
+    def self.valid?(value: nil, min: 1, max: nil)
+      new(value: value, min: min, max: max).valid?
+    end
+
+    # @param value [Fixnum|NilClass]
+    # @param min [Fixnum]
+    # @param max [Fixnum]
+    # @return [Vedeu::Point]
+    def initialize(value: nil, min: 1, max: nil)
+      @min   = min
+      @max   = max
+      @value = value
+    end
+
+    # @return [Vedeu::Point]
+    def coerce
+      fail Vedeu::Error::InvalidSyntax,
+           "Expecting 'min' to be less than 'max'." if min > max
+
+      if value < min
+        Vedeu::Point.coerce(value: min, min: min, max: max)
+
+      elsif value > max
+        Vedeu::Point.coerce(value: max, min: min, max: max)
+
+      else
+        self
+
+      end
+    end
+
+    # @return [Boolean]
+    def valid?
+      @value.is_a?(Fixnum) && @value >= min && @value <= max
+    end
+
+    # @return [Fixnum]
+    def value
+      @value ||= min
+    end
+
+    private
+
+    # @return [Fixnum]
+    def min
+      return @min if @min.is_a?(Fixnum)
+
+      fail Vedeu::Error::InvalidSyntax, "Expecting 'min' to be a Fixnum."
+    end
+
+    # @return [Fixnum]
+    def max
+      return @max if @max.is_a?(Fixnum)
+
+      fail Vedeu::Error::InvalidSyntax, "Expecting 'max' to be a Fixnum."
+    end
+
+  end # Point
+
+end # Vedeu