vedeu 0.7.4 → 0.8.0

data/lib/vedeu/colours/validator.rb

@@ -0,0 +1,84 @@
+module Vedeu
+
+  module Colours
+
+    # Validates the value as a valid colour string in HTML/CSS format,
+    # e.g. '#123456'.
+    #
+    # @api private
+    #
+    class Validator
+
+      include Vedeu::Common
+
+      # @param value [String]
+      # @return [Boolean]
+      def self.valid?(value)
+        new(value).valid?
+      end
+
+      # @param value [String]
+      # @return [Vedeu::Colours::Validator]
+      def initialize(value)
+        @value = value
+      end
+
+      # Returns a boolean indicating whether the value is within the
+      # range of valid terminal numbered colours.
+      #
+      # @return [Boolean]
+      def within_range?
+        numeric?(value) && value >= 0 && value <= 255
+      end
+
+      # Returns a boolean indicating whether the colour provided is a
+      # valid named colour.
+      #
+      # @return [Boolean]
+      def named?
+        Vedeu::EscapeSequences::Esc.valid_name?(value)
+      end
+
+      # Returns a boolean indicated whether the colour is a valid
+      # HTML/CSS colour.
+      #
+      # @return [Boolean]
+      def rgb?
+        return true if value =~ /^#([A-Fa-f0-9]{6})$/.freeze
+
+        false
+      end
+
+      # @return [Boolean]
+      def valid?
+        background? || colour? || foreground? || rgb? || named? || within_range?
+      end
+
+      protected
+
+      # @!attribute [r] value
+      # @return [String]
+      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 # Validator
+
+  end # Colours
+
+end # Vedeu

data/lib/vedeu/common.rb

@@ -24,6 +24,41 @@ module Vedeu
       klass.new(attributes)
     end
 
+    # Returns a boolean indicating the value was a boolean.
+    #
+    # @param value [void]
+    # @return [Boolean]
+    def boolean(value)
+      return value if boolean?(value)
+      return false if falsy?(value)
+      return true  if truthy?(value)
+    end
+
+    # Returns a boolean indicating whether the value is a Boolean.
+    #
+    # @param value [Boolean]
+    # @return [Boolean]
+    def boolean?(value)
+      value.is_a?(TrueClass) || value.is_a?(FalseClass)
+    end
+
+    # Returns a boolean indicating whether the value should be
+    # considered false.
+    #
+    # @param value [void]
+    # @return [Boolean]
+    def falsy?(value)
+      value.nil? || value.is_a?(FalseClass)
+    end
+
+    # Returns a boolean indicating whether the value is a Hash.
+    #
+    # @param value [Hash|void]
+    # @return [Boolean]
+    def hash?(value)
+      value.is_a?(Hash)
+    end
+
     # Returns a boolean indicating whether the value is a Fixnum.
     #
     # @param value [Fixnum|void]
@@ -64,6 +99,23 @@ module Vedeu
       name
     end
 
+    # Returns a boolean indicating whether the value is a Fixnum.
+    #
+    # @param value [String|void]
+    # @return [Boolean]
+    def string?(value)
+      value.is_a?(String)
+    end
+
+    # Returns a boolean indicating whether the value should be
+    # considered true.
+    #
+    # @param value [void]
+    # @return [Boolean]
+    def truthy?(value)
+      !falsy?(value)
+    end
+
   end # Common
 
 end # Vedeu

data/lib/vedeu/configuration/api.rb

@@ -556,10 +556,7 @@ module Vedeu
       def background(value = nil)
         return options[:background] unless value
 
-        bg = Vedeu::Colours::Background.coerce(value)
-
-        options[:background] = colour_attributes(background: bg)
-                               .fetch(:background)
+        options[:background] = value
       end
 
       # Sets the foreground of the terminal.
@@ -574,10 +571,7 @@ module Vedeu
       def foreground(value = nil)
         return options[:foreground] unless value
 
-        fg = Vedeu::Colours::Foreground.coerce(value)
-
-        options[:foreground] = colour_attributes(foreground: fg)
-                               .fetch(:foreground)
+        options[:foreground] = value
       end
 
       # Sets the background and foreground of the terminal.
@@ -590,8 +584,8 @@ module Vedeu
       # @param attrs [Hash<Symbol => String>]
       # @return [Hash<Symbol => void>]
       def colour(attrs = {})
-        options[:background] = background(attrs[:background])
-        options[:foreground] = foreground(attrs[:foreground])
+        options[:background] = attrs[:background]
+        options[:foreground] = attrs[:foreground]
         options
       end
 

data/lib/vedeu/configuration/configuration.rb

@@ -19,7 +19,7 @@ module Vedeu
       #
       # @return [Vedeu::Colours::Background]
       def background
-        instance.options[:background]
+        Vedeu::Colours::Background.coerce(instance.options[:background])
       end
 
       # Returns the base_path value.
@@ -134,7 +134,7 @@ module Vedeu
       #
       # @return [Vedeu::Colours::Foreground]
       def foreground
-        instance.options[:foreground]
+        Vedeu::Colours::Foreground.coerce(instance.options[:foreground])
       end
 
       # Returns the client defined height for the terminal.
@@ -325,7 +325,7 @@ module Vedeu
     # @return [Hash<Symbol => void>]
     def defaults
       {
-        background:    Vedeu::Colours::Background.coerce(:default),
+        background:    :default,
         base_path:     base_path,
         colour_mode:   detect_colour_mode,
         compression:   true,
@@ -335,7 +335,7 @@ module Vedeu
         drb_port:      nil,
         drb_height:    25,
         drb_width:     80,
-        foreground:    Vedeu::Colours::Foreground.coerce(:default),
+        foreground:    :default,
         height:        nil,
         interactive:   true,
         log:           nil,

data/lib/vedeu/cursors/coordinate.rb

@@ -164,7 +164,7 @@ module Vedeu
       # @return [Hash<Symbol => Fixnum|String|Symbol>]
       def defaults
         {
-          name:   '',
+          name:   ''.freeze,
           offset: nil,
           type:   :x,
         }

data/lib/vedeu/cursors/cursor.rb

@@ -278,7 +278,7 @@ module Vedeu
       #   Vedeu::Cursors::Repository>]
       def defaults
         {
-          name:       '',
+          name:       ''.freeze,
           ox:         0,
           oy:         0,
           repository: Vedeu.cursors,

data/lib/vedeu/cursors/dsl.rb

@@ -8,34 +8,7 @@ module Vedeu
     # See {file:docs/cursors.md#view_cursors}
     module DSL
 
-      # Set the cursor visibility on an interface.
-      #
-      # @param value [Boolean] Any value other than nil or false will
-      #   evaluate to true.
-      # @return [Vedeu::Cursors::Cursor]
-      def cursor(value = true)
-        boolean = value ? true : false
-
-        model.cursor_visible = boolean
-
-        Vedeu::Cursors::Cursor.store(name: model.name, visible: boolean)
-      end
-
-      # Set the cursor to visible for the interface or view.
-      #
-      # @return [Vedeu::Cursors::Cursor]
-      def cursor!
-        cursor(true)
-      end
-      alias_method :show_cursor!, :cursor!
-
-      # Set the cursor to invisible for the interface or view.
-      #
-      # @return [Vedeu::Cursors::Cursor]
-      def no_cursor!
-        cursor(false)
-      end
-      alias_method :hide_cursor!, :no_cursor!
+      include Vedeu::DSL::Cursors
 
     end # DSL
 

data/lib/vedeu/dsl/all.rb

@@ -8,14 +8,14 @@ module Vedeu
 
 end # Vedeu
 
+require 'vedeu/dsl/string/all'
+require 'vedeu/dsl/border'
+require 'vedeu/dsl/cursors'
 require 'vedeu/dsl/dsl'
-require 'vedeu/dsl/shared'
+require 'vedeu/dsl/attributes'
+require 'vedeu/dsl/geometry'
 require 'vedeu/dsl/use'
 require 'vedeu/dsl/presentation'
-require 'vedeu/dsl/composition'
-require 'vedeu/dsl/text'
-require 'vedeu/dsl/lines'
-require 'vedeu/dsl/line'
-require 'vedeu/dsl/streams'
-require 'vedeu/dsl/stream'
 require 'vedeu/dsl/view'
+require 'vedeu/dsl/elements'
+require 'vedeu/dsl/views'

data/lib/vedeu/dsl/attributes.rb

@@ -0,0 +1,224 @@
+module Vedeu
+
+  module DSL
+
+    # Creates attributes for DSL objects.
+    #
+    # @api private
+    #
+    class Attributes
+
+      include Vedeu::Common
+
+      # @param (see #initialize)
+      # @return (see #attributes)
+      def self.build(context = nil,
+                     model   = nil,
+                     value   = ''.freeze,
+                     options = {},
+                     &block)
+        new(context, model, value, options, &block).attributes
+      end
+
+      # @param options [Hash]
+      # @option options align [Symbol] One of :center, :centre, :left,
+      #   :none (default) or :right.
+      # @option options background [String] The background colour.
+      # @option options colour [Hash] The colour.
+      # @option colour background [String] The background colour.
+      # @option colour foreground [String] The foreground colour.
+      # @option options foreground [String] The foreground colour.
+      # @option options name [NilClass|String|Symbol]
+      # @option options pad [String] The character to use to pad the
+      #   value.
+      # @option options style [Array<Symbol>|
+      #   Hash<Symbol => Array<Symbol>|Symbol>|Symbol] The style.
+      # @option options truncate [Boolean] Whether the value should be
+      #   truncated.
+      # @option options width [Fixnum] The desired width for the
+      #   value.
+      # @option options wordwrap [Boolean] Whether the value should be
+      #   wordwrapped.
+      # @return [Vedeu::DSL::Attributes]
+      def initialize(context = nil,
+                     model   = nil,
+                     value   = ''.freeze,
+                     options = {},
+                     &block)
+        @context = context
+        @model   = model
+        @value   = value   || ''.freeze
+        @options = options || {}
+        @block   = block
+      end
+
+      # @return [Hash]
+      def attributes
+        {
+          align:    align,
+          client:   client,
+          colour:   colour,
+          name:     name,
+          pad:      pad,
+          style:    style,
+          truncate: truncate,
+          width:    width,
+          wordwrap: wordwrap,
+        }.merge!(value)
+      end
+
+      protected
+
+      # @!attribute [r] context
+      # @return [NilClass|Vedeu::DSL::Elements]
+      attr_reader :context
+
+      # @!attribute [r] model
+      # @return [NilClass|Vedeu::Views::*]
+      attr_reader :model
+
+      # @!attribute [r] block
+      # @return [NilClass|Proc]
+      attr_reader :block
+
+      private
+
+      # @return [Vedeu::Coercers::Alignment]
+      def align
+        Vedeu::Coercers::Alignment.coerce(options[:align])
+      end
+
+      # Returns the client object which called the DSL method.
+      #
+      # @return [Object]
+      def client
+        if block
+          if eval('client', block.binding).nil?
+            eval(context.class.name, block.binding)
+
+          else
+            eval('client', block.binding)
+
+          end
+        elsif present?(model)
+          model.client
+
+        end
+      end
+
+      # @return [Vedeu::Colours::Colour]
+      def colour
+        Vedeu::Colours::Colour.coerce(new_colour_options)
+      end
+
+      # @return [Hash]
+      def defaults
+        {
+          align:      :none,
+          client:     nil,
+          colour:     nil,
+          name:       nil,
+          pad:        ' '.freeze,
+          style:      nil,
+          truncate:   false,
+          width:      nil,
+          wordwrap:   false,
+        }
+      end
+
+      # @return [NilClass|Vedeu::Geometries::Geometry]
+      def geometry
+        @_geometry ||= Vedeu.geometries.by_name(name)
+      end
+
+      # @return [NilClass|String|Symbol]
+      def name
+        return model.name if present?(model) && present?(model.name)
+
+        nil
+      end
+
+      # @return [Hash]
+      def options
+        defaults.merge!(@options)
+      end
+
+      # @return [String]
+      def pad
+        options[:pad].to_s[0] || ' '.freeze
+      end
+
+      # @return [NilClass|Vedeu::Presentation::Style]
+      def style
+        Vedeu::Presentation::Style.coerce(options[:style])
+      end
+
+      # @return [Boolean]
+      def truncate
+        truthy?(options[:truncate])
+      end
+
+      # @return [Hash<Symbol => String>]
+      def value
+        if block
+          {}
+
+        elsif absent?(@value)
+          {}
+
+        else
+          {
+            value: @value
+          }
+
+        end
+      end
+
+      # @return [Fixnum|NilClass]
+      def width
+        if numeric?(options[:width])
+          options[:width]
+
+        elsif name
+          geometry.bordered_width
+
+        end
+      end
+
+      # @return [Boolean]
+      def wordwrap
+        truthy?(options[:wordwrap])
+      end
+
+      # @return [Array<Symbol>]
+      def colour_attributes
+        [:background, :colour, :foreground]
+      end
+
+      # @return [Hash]
+      def colour_options
+        options.select { |k, _| colour_attributes.include?(k) }
+      end
+
+      # @return [Hash]
+      def coerce_colour_options
+        Vedeu::Coercers::ColourAttributes.coerce(colour_options)
+      end
+
+      # @return [Hash]
+      def model_colour
+        return {} unless present?(model) && model.colour
+
+        model.colour.attributes
+      end
+
+      # @return [Hash]
+      def new_colour_options
+        model_colour.merge(coerce_colour_options)
+      end
+
+    end # Attributes
+
+  end # DSL
+
+end # Vedeu