vedeu 0.7.4 → 0.8.0

data/lib/vedeu/application/controller.rb

@@ -79,7 +79,7 @@ module Vedeu
     # @param klass [Class]
     # @return [void]
     def self.included(klass)
-      klass.send(:extend, ClassMethods)
+      klass.extend(Vedeu::Controller::ClassMethods)
     end
 
   end # Controller

data/lib/vedeu/boolean.rb

@@ -0,0 +1,35 @@
+module Vedeu
+
+  # Represent a boolean object.
+  #
+  # @api private
+  #
+  class Boolean
+
+    # @param value [void]
+    # @return [Vedeu::Boolean]
+    def initialize(value = nil)
+      @value = value
+    end
+
+    # @return [Boolean]
+    def false?
+      value.nil? || value == false
+    end
+
+    # @return [Boolean]
+    def true?
+      return false if false?
+
+      true
+    end
+
+    private
+
+    # @!attribute [r] value
+    # @return [void]
+    attr_reader :value
+
+  end # Boolean
+
+end # Vedeu

data/lib/vedeu/borders/border.rb

@@ -296,13 +296,13 @@ module Vedeu
           bottom_horizontal: nil,
           bottom_left:       nil,
           bottom_right:      nil,
-          caption:           '',
+          caption:           ''.freeze,
           client:            nil,
           colour:            nil,
           enabled:           false,
           horizontal:        Vedeu::EscapeSequences::Borders.horizontal,
           left_vertical:     nil,
-          name:              '',
+          name:              ''.freeze,
           parent:            nil,
           repository:        Vedeu.borders,
           right_vertical:    nil,
@@ -311,7 +311,7 @@ module Vedeu
           show_right:        true,
           show_top:          true,
           style:             nil,
-          title:             '',
+          title:             ''.freeze,
           top_horizontal:    nil,
           top_left:          nil,
           top_right:         nil,

data/lib/vedeu/borders/caption.rb

@@ -22,7 +22,7 @@ module Vedeu
 
       # @return [Fixnum]
       def y
-        @_y ||= geometry.yn
+        geometry.yn
       end
 
     end # Caption

data/lib/vedeu/borders/dsl.rb

@@ -7,29 +7,10 @@ module Vedeu
     class DSL
 
       include Vedeu::DSL
+      include Vedeu::DSL::Border
       include Vedeu::DSL::Presentation
       include Vedeu::DSL::Use
 
-      # Specify the border of an interface or view with a simple DSL.
-      #
-      #   Vedeu.border :some_interface do
-      #     # ...
-      #   end
-      #
-      # @param name [String|Symbol] The name of the interface or view
-      #   to which this border belongs.
-      # @param block [Proc]
-      # @raise [Vedeu::Error::MissingRequired|
-      #   Vedeu::Error::RequiresBlock] When a name or block
-      #   respectively are not given.
-      # @return [Vedeu::Borders::Border]
-      def self.border(name, &block)
-        fail Vedeu::Error::MissingRequired unless name
-        fail Vedeu::Error::RequiresBlock unless block_given?
-
-        Vedeu::Borders::Border.build(enabled: true, name: name, &block).store
-      end
-
       # Set the character to be used to draw the bottom left corner of
       # the border.
       #

data/lib/vedeu/borders/title.rb

@@ -67,7 +67,7 @@ module Vedeu
       #
       # @return [String]
       def value
-        @value || ''
+        @value || ''.freeze
       end
       alias_method :title, :value
       alias_method :caption, :value
@@ -89,10 +89,8 @@ module Vedeu
       # @param x [Fixnum]
       # @return [Hash<Symbol => void>]
       def attributes(char, x)
-        @_attributes ||= border.attributes
-
-        @_attributes.merge!(position: Vedeu::Geometries::Position.new(y, x),
-                            value:    char)
+        border.attributes.merge(position: Vedeu::Geometries::Position.new(y, x),
+                                value:    char)
       end
 
       # @return [Vedeu::Borders::Border]
@@ -169,7 +167,7 @@ module Vedeu
       #
       # @return [String]
       def truncate
-        @_truncate ||= value.chomp.slice(0...(width - 4))
+        value.chomp.slice(0...(width - 4))
       end
 
       # Return the size of the horizontal border given.
@@ -181,12 +179,12 @@ module Vedeu
 
       # @return [Fixnum]
       def x
-        @_x ||= geometry.bx + start_index
+        geometry.bx + start_index
       end
 
       # @return [Fixnum]
       def y
-        @_y ||= geometry.y
+        geometry.y
       end
 
     end # Title

data/lib/vedeu/buffers/buffer.rb

@@ -176,7 +176,7 @@ module Vedeu
         {
           back:       nil,
           front:      nil,
-          name:       '',
+          name:       ''.freeze,
           previous:   nil,
           repository: Vedeu.buffers,
         }
@@ -192,7 +192,7 @@ module Vedeu
       #
       # @return [Boolean]
       def swap
-        Vedeu.log(type: :output, message: "Buffer swapping: '#{name}'".freeze)
+        Vedeu.log(type: :buffer, message: "Buffer swapping: '#{name}'".freeze)
 
         @previous = front
         @front    = back

data/lib/vedeu/buffers/refresh.rb

@@ -64,7 +64,7 @@ module Vedeu
 
       # @return [Boolean]
       def content_only?
-        options[:content_only] == true
+        truthy?(options[:content_only])
       end
 
       # @return [Hash<Symbol => Boolean>]

data/lib/vedeu/cells/border.rb

@@ -40,17 +40,6 @@ module Vedeu
         self
       end
 
-      # @return [Vedeu::Borders::Border|Vedeu::Interfaces::Interface]
-      def named_parent
-        if border
-          border
-
-        elsif interface
-          interface
-
-        end
-      end
-
       # @return [String]
       def value
         return '' unless present?(@value)

data/lib/vedeu/cells/empty.rb

@@ -60,7 +60,7 @@ module Vedeu
       # @param _options [Hash] Ignored.
       # @return [String]
       def to_html(_options = {})
-        ''
+        ''.freeze
       end
 
       # @return [String]
@@ -75,10 +75,10 @@ module Vedeu
       def defaults
         {
           colour:   {},
-          name:     '',
+          name:     ''.freeze,
           position: nil,
-          style:    '',
-          value:    '',
+          style:    ''.freeze,
+          value:    ''.freeze,
         }
       end
 

data/lib/vedeu/{geometries/alignment → coercers}/alignment.rb

@@ -1,52 +1,51 @@
 module Vedeu
 
-  module Geometries
+  module Coercers
 
     # The subclasses of this class, HorizontalAlignment and
-    # VerticalAlignment provide the mechanism to align an interface or
-    # view horizontally or vertically within the available terminal
-    # space.
+    # VerticalAlignment provide the mechanism to validate a horizontal
+    # or vertical alignment value.
     #
-    # @see Vedeu::Geometries::HorizontalAlignment
-    # @see Vedeu::Geometries::VerticalAlignment
+    # @see Vedeu::Coercers::HorizontalAlignment
+    # @see Vedeu::Coercers::VerticalAlignment
     #
     # @api private
     #
     class Alignment
 
-      # @param (see #initialize)
-      # @return (see #align)
-      def self.align(value = nil)
-        new(value).align
-      end
-
-      # @param value [NilClass|Symbol|Vedeu::Geometries::Alignment]
-      # @return [Vedeu::Geometries::Alignment]
-      def self.coerce(value = nil)
-        if value.is_a?(self)
-          value
+      include Vedeu::Common
 
-        elsif value.is_a?(Symbol)
-          new(value)
+      # @!attribute [r] value
+      # @return [Symbol]
+      attr_reader :value
 
-        else
-          new(:none)
+      # @param value [Symbol|Vedeu::Coercers::Alignment]
+      # @return [Vedeu::Coercers::Alignment]
+      def self.coerce(value = :none)
+        return value if value.is_a?(self)
 
-        end
+        new(value).coerce
       end
 
-      # Returns a new instance of Vedeu::Geometries::Alignment.
+      # Returns a new instance of Vedeu::Coercers::Alignment.
       #
-      # @param value [NilClass|Symbol]
-      # @return [Vedeu::Geometries::Alignment]
-      def initialize(value = nil)
-        @value = value
+      # @param value [Symbol]
+      # @return [Vedeu::Coercers::Alignment]
+      def initialize(value = :none)
+        @value = value || :none
       end
 
-      # @raise [Vedeu::Error::NotImplemented] Subclasses of this class
-      #   must implement this method.
-      def align
-        fail Vedeu::Error::NotImplemented, 'Subclasses implement this.'.freeze
+      # @return [Symbol]
+      def coerce
+        if value == :center
+          @value = :centre
+
+        elsif invalid?
+          @value = :none
+
+        end
+
+        self
       end
 
       # Return a boolean indicating alignment was set to :bottom.
@@ -63,6 +62,20 @@ module Vedeu
         value == :centre
       end
 
+      # An object is equal when its values are the same.
+      #
+      # @param other [void]
+      # @return [Boolean]
+      def eql?(other)
+        self.class == other.class && value == other.value
+      end
+      alias_method :==, :eql?
+
+      # @return [Boolean]
+      def invalid?
+        !valid?
+      end
+
       # Return a boolean indicating alignment was set to :left.
       #
       # @return [Boolean]
@@ -98,37 +111,21 @@ module Vedeu
         value == :none
       end
 
-      private
-
-      # @return [Boolean]
-      def none?
-        @value == :none || @value.nil? || !(@value.is_a?(Symbol))
-      end
-
+      # Return a boolean indicating the value is a valid alignment.
+      #
       # @return [Boolean]
       def valid?
-        values.include?(value)
+        present?(value) && value.is_a?(Symbol) && values.include?(value)
       end
 
-      # @return [Symbol]
-      def value
-        @_value ||= if none?
-                      :none
-
-                    elsif @value == :center
-                      :centre
-
-                    else
-                      @value.to_sym
-
-                    end
-      end
+      private
 
       # @return [Array<Symbol>]
       def values
         [
           :bottom,
           :centre,
+          :center,
           :left,
           :middle,
           :none,
@@ -139,6 +136,6 @@ module Vedeu
 
     end # Alignment
 
-  end # Geometries
+  end # Coercers
 
 end # Vedeu

data/lib/vedeu/coercers/all.rb

@@ -0,0 +1,16 @@
+module Vedeu
+
+  # Provides a mechanism to coerce values within Vedeu.
+  #
+  module Coercers
+
+  end # Coercers
+
+end # Vedeu
+
+require 'vedeu/coercers/alignment'
+require 'vedeu/coercers/horizontal_alignment'
+require 'vedeu/coercers/vertical_alignment'
+
+require 'vedeu/coercers/colour'
+require 'vedeu/coercers/colour_attributes'

data/lib/vedeu/coercers/colour.rb

@@ -0,0 +1,78 @@
+module Vedeu
+
+  module Coercers
+
+    # Converts a given value into a {Vedeu::Colours::Colour} if
+    # possible.
+    #
+    # @api private
+    #
+    class Colour
+
+      include Vedeu::Common
+
+      # @param (see #initialize)
+      # @return (see #coerce)
+      def self.coerce(value)
+        new(value).coerce
+      end
+
+      # @param value [void]
+      # @return [Vedeu::Coercers::Colour]
+      def initialize(value)
+        @value = value
+      end
+
+      # @raise [Vedeu::Error::Fatal] When the value cannot be coerced.
+      # @return [void]
+      def coerce
+        if absent?(value)
+          Vedeu::Colours::Colour.new
+
+        elsif background?
+          Vedeu::Colours::Colour.new(background: value)
+
+        elsif colour?
+          value
+
+        elsif foreground?
+          Vedeu::Colours::Colour.new(foreground: value)
+
+        elsif hash?(value)
+          attributes = Vedeu::Coercers::ColourAttributes.coerce(value)
+          Vedeu::Colours::Colour.new(attributes)
+
+        else
+          fail Vedeu::Error::Fatal, 'Vedeu cannot coerce this colour.'.freeze
+
+        end
+      end
+
+      protected
+
+      # @!attribute [r] value
+      # @return [void]
+      attr_reader :value
+
+      private
+
+      # @return [Boolean]
+      def background?
+        value.is_a?(Vedeu::Colours::Background)
+      end
+
+      # @return [Boolean]
+      def colour?
+        value.is_a?(Vedeu::Colours::Colour)
+      end
+
+      # @return [Boolean]
+      def foreground?
+        value.is_a?(Vedeu::Colours::Foreground)
+      end
+
+    end # Colour
+
+  end # Coercers
+
+end # Vedeu