vedeu 0.7.4 → 0.8.0

data/lib/vedeu/coercers/colour_attributes.rb

@@ -0,0 +1,122 @@
+module Vedeu
+
+  module Coercers
+
+    # Coerces a colour options hash into: an empty hash, or a hash
+    # containing either or both background and foreground keys.
+    #
+    # @api private
+    #
+    class ColourAttributes
+
+      include Vedeu::Common
+
+      # @param value [Hash]
+      # @return [Hash]
+      def self.coerce(value)
+        new(value).coerce
+      end
+
+      # @param value [Hash]
+      # @return [Hash]
+      def initialize(value)
+        @value = value
+      end
+
+      # @return [Hash]
+      def coerce
+        fail Vedeu::Error::InvalidSyntax unless hash?(value)
+
+        if colour? && hash?(colour)
+          Vedeu::Coercers::ColourAttributes.coerce(colour)
+
+        elsif colour? && already_coerced?(colour)
+          colour.attributes
+
+        else
+          coerced_background.merge(coerced_foreground)
+
+        end
+      end
+
+      protected
+
+      # @!attribute [r] value
+      # @return [Hash]
+      attr_reader :value
+
+      private
+
+      # @param colour [void]
+      # @return [Boolean]
+      def already_coerced?(colour)
+        colour.is_a?(Vedeu::Colours::Colour)
+      end
+
+      # @return [Hash]
+      def coerced_background
+        if background?
+          {
+            background: background
+          }
+
+        else
+          {}
+
+        end
+      end
+
+      # @return [NilClass|String]
+      def background
+        value[:background]
+      end
+
+      # @return [Boolean]
+      def background?
+        valid?(background)
+      end
+
+      # @return [Hash]
+      def colour
+        value[:colour]
+      end
+
+      # @return [Boolean]
+      def colour?
+        value.key?(:colour)
+      end
+
+      # @return [Hash]
+      def coerced_foreground
+        if foreground?
+          {
+            foreground: foreground
+          }
+
+        else
+          {}
+
+        end
+      end
+
+      # @return [NilClass|String]
+      def foreground
+        value[:foreground]
+      end
+
+      # @return [Boolean]
+      def foreground?
+        valid?(foreground)
+      end
+
+      # @param colour [void]
+      # @return [Boolean]
+      def valid?(colour)
+        Vedeu::Colours::Validator.valid?(colour)
+      end
+
+    end # ColourAttributes
+
+  end # Coercers
+
+end # Vedeu

data/lib/vedeu/coercers/horizontal_alignment.rb

@@ -0,0 +1,28 @@
+module Vedeu
+
+  module Coercers
+
+    # Provides the mechanism to validate a horizontal alignment value.
+    #
+    # @api private
+    #
+    class HorizontalAlignment < Vedeu::Coercers::Alignment
+
+      private
+
+      # @return [Array<Symbol>]
+      def values
+        [
+          :centre,
+          :center,
+          :left,
+          :none,
+          :right,
+        ]
+      end
+
+    end # HorizontalAlignment
+
+  end # Coercers
+
+end # Vedeu

data/lib/vedeu/coercers/vertical_alignment.rb

@@ -0,0 +1,27 @@
+module Vedeu
+
+  module Coercers
+
+    # Provides the mechanism to validate a vertical alignment value.
+    #
+    # @api private
+    #
+    class VerticalAlignment < Vedeu::Coercers::Alignment
+
+      private
+
+      # @return [Array<Symbol>]
+      def values
+        [
+          :bottom,
+          :middle,
+          :none,
+          :top,
+        ]
+      end
+
+    end # VerticalAlignment
+
+  end # Coercers
+
+end # Vedeu

data/lib/vedeu/colours/all.rb

@@ -8,6 +8,7 @@ module Vedeu
 
 end # Vedeu
 
+require 'vedeu/colours/validator'
 require 'vedeu/colours/repository'
 require 'vedeu/colours/backgrounds'
 require 'vedeu/colours/foregrounds'

data/lib/vedeu/colours/background.rb

@@ -10,6 +10,11 @@ module Vedeu
     #
     class Background < Vedeu::Colours::Translator
 
+      # @return [Boolean]
+      def background?
+        present?(to_s)
+      end
+
       private
 
       # @return [String]
@@ -17,9 +22,15 @@ module Vedeu
         "\e[48;".freeze
       end
 
+      # Returns an escape sequence for a named colour.
+      #
+      # @note
+      #   Valid names can be found at
+      #   {Vedeu::EscapeSequences::Esc#valid_codes}
+      #
       # @return [String]
-      def named_codes
-        Vedeu::EscapeSequences::Esc.background_codes[colour]
+      def named_code
+        Vedeu::EscapeSequences::Esc.background_colour(colour)
       end
 
       # @return [Vedeu::Colours::Backgrounds]

data/lib/vedeu/colours/colour.rb

@@ -37,44 +37,29 @@ module Vedeu
     #
     class Colour
 
-      # @param value [Vedeu::Colours::Colour|Hash<Symbol => void>]
-      # @return [Vedeu::Colours::Colour]
-      def self.coerce(value)
-        return value if value.is_a?(self)
-        return new unless value.is_a?(Hash)
+      class << self
 
-        if value[:colour] && value[:colour].is_a?(self)
-          value[:colour]
+        extend Forwardable
 
-        elsif value[:colour] && value[:colour].is_a?(Hash)
-          new(value[:colour])
+        def_delegators Vedeu::Coercers::Colour,
+                       :coerce
 
-        elsif value[:background] || value[:foreground]
-          new(value)
+        # @return [Vedeu::Colours::Colour]
+        def default
+          new(background: :default, foreground: :default)
+        end
 
-        else
-          new
+      end # Eigenclass
 
-        end
-      end
+      extend Forwardable
 
-      # @return [Vedeu::Colours::Colour]
-      def self.default
-        new(background: :default, foreground: :default)
-      end
+      def_delegators :background,
+                     :background?
 
-      # Returns a new instance of Vedeu::Colours::Colour.
-      #
-      # @param attributes [Hash<Symbol => String|
-      #   Vedeu::Colours::Background|Vedeu::Colours:Foreground>]
-      # @option attributes background [String]
-      # @option attributes foreground [String]
-      # @return [Vedeu::Colours::Colour]
-      def initialize(attributes = {})
-        defaults.merge!(attributes).each do |key, value|
-          instance_variable_set("@#{key}", value)
-        end
-      end
+      def_delegators :foreground,
+                     :foreground?
+
+      include Vedeu::Repositories::Defaults
 
       # @return [Hash<Symbol => Vedeu::Colours::Background,
       #   Vedeu::Colours::Foreground>]

data/lib/vedeu/colours/foreground.rb

@@ -10,6 +10,11 @@ module Vedeu
     #
     class Foreground < Vedeu::Colours::Translator
 
+      # @return [Boolean]
+      def foreground?
+        present?(to_s)
+      end
+
       private
 
       # @return [String]
@@ -17,9 +22,15 @@ module Vedeu
         "\e[38;".freeze
       end
 
+      # Returns an escape sequence for a named colour.
+      #
+      # @note
+      #   Valid names can be found at
+      #   {Vedeu::EscapeSequences::Esc#valid_codes}
+      #
       # @return [String]
-      def named_codes
-        Vedeu::EscapeSequences::Esc.foreground_codes[colour]
+      def named_code
+        Vedeu::EscapeSequences::Esc.foreground_colour(colour)
       end
 
       # @return [Vedeu::Colours::Foregrounds]

data/lib/vedeu/colours/translator.rb

@@ -30,6 +30,14 @@ module Vedeu
     #
     class Translator
 
+      extend Forwardable
+      include Vedeu::Common
+
+      def_delegators :validator,
+                     :named?,
+                     :rgb?,
+                     :within_range?
+
       # @!attribute [r] colour
       # @return [String]
       attr_reader :colour
@@ -56,7 +64,7 @@ module Vedeu
 
       # @return [Boolean]
       def empty?
-        colour.nil? || colour.to_s.empty?
+        absent?(colour)
       end
 
       # An object is equal when its values are the same.
@@ -71,20 +79,19 @@ module Vedeu
       # @return [String]
       # @see Vedeu::Colours::Translator
       def escape_sequence
-        if empty?
-          ''
+        return '' if empty?
 
-        elsif registered?(colour)
+        if registered?(colour)
           retrieve(colour)
 
         elsif rgb?
           rgb
 
-        elsif numbered?
+        elsif within_range?
           numbered
 
         elsif named?
-          named
+          named_code
 
         else
           ''
@@ -132,38 +139,6 @@ module Vedeu
         repository.registered?(colour)
       end
 
-      # @return [Boolean]
-      def named?
-        colour.is_a?(Symbol) && valid_name?
-      end
-
-      # Returns an escape sequence for a named background colour.
-      #
-      # @note
-      #   Valid names can be found at
-      #   {Vedeu::EscapeSequences::Esc#codes}
-      #
-      # @return [String]
-      def named
-        "\e[#{named_codes}m".freeze
-      end
-
-      # Returns a boolean indicating whether the colour provided is a
-      # valid named colour.
-      #
-      # @return [Boolean]
-      def valid_name?
-        Vedeu::EscapeSequences::Esc.codes.keys.include?(colour)
-      end
-
-      # Returns a boolean indicating whether the colour provided is a
-      # terminal numbered colour.
-      #
-      # @return [Boolean]
-      def numbered?
-        colour.is_a?(Fixnum) && valid_range?
-      end
-
       # Returns an escape sequence.
       #
       # @return [String]
@@ -171,16 +146,6 @@ module Vedeu
         "#{prefix}5;#{css_to_numbered}m".freeze
       end
 
-      # Returns a boolean indicated whether the colour is a valid
-      # HTML/CSS colour.
-      #
-      # @return [Boolean]
-      def rgb?
-        return true if colour =~ /^#([A-Fa-f0-9]{6})$/.freeze
-
-        false
-      end
-
       # Returns an escape sequence.
       #
       # @return [String]
@@ -207,14 +172,6 @@ module Vedeu
         "#{prefix}2;%s;%s;%sm".freeze
       end
 
-      # Returns a boolean indicating whether the numbered colour is
-      # within the range of valid terminal numbered colours.
-      #
-      # @return [Boolean]
-      def valid_range?
-        colour >= 0 && colour <= 255
-      end
-
       # Returns a collection of converted HTML/CSS octets as their
       # decimal equivalents.
       #
@@ -236,7 +193,7 @@ module Vedeu
         if rgb?
           [16, red, green, blue].inject(:+)
 
-        elsif numbered?
+        elsif within_range?
           colour
 
         end
@@ -272,8 +229,13 @@ module Vedeu
       def not_implemented
         fail Vedeu::Error::NotImplemented, 'Subclasses implement this.'.freeze
       end
-      alias_method :named_codes,     :not_implemented
-      alias_method :repository,      :not_implemented
+      alias_method :named_code, :not_implemented
+      alias_method :repository, :not_implemented
+
+      # @return [Vedeu::Colours::Validator]
+      def validator
+        @validator ||= Vedeu::Colours::Validator.new(colour)
+      end
 
     end # Translator