vedeu 0.8.4 → 0.8.5

data/lib/vedeu/coercers/horizontal_alignment.rb

@@ -10,17 +10,21 @@ module Vedeu
     #
     class HorizontalAlignment < Vedeu::Coercers::Alignment
 
+      # @raise (see Vedeu::Coercers::Alignment#validate)
+      # @return (see Vedeu::Coercers::Alignment#validate)
+      def validate
+        return coerce if valid_horizontal?
+
+        fail Vedeu::Error::InvalidSyntax,
+             'Missing or invalid horizontal alignment value. ' \
+             "Valid values are: #{to_sentence}"
+      end
+
       private
 
-      # @return [Array<Symbol>]
-      def values
-        [
-          :centre,
-          :center,
-          :left,
-          :none,
-          :right,
-        ]
+      # @return [String]
+      def to_sentence
+        Vedeu::Sentence.construct(horizontal_values)
       end
 
     end # HorizontalAlignment

data/lib/vedeu/coercers/vertical_alignment.rb

@@ -10,16 +10,21 @@ module Vedeu
     #
     class VerticalAlignment < Vedeu::Coercers::Alignment
 
+      # @raise (see Vedeu::Coercers::Alignment#validate)
+      # @return (see Vedeu::Coercers::Alignment#validate)
+      def validate
+        return coerce if valid_vertical?
+
+        fail Vedeu::Error::InvalidSyntax,
+             'Missing or invalid vertical alignment value. ' \
+             "Valid values are: #{to_sentence}"
+      end
+
       private
 
-      # @return [Array<Symbol>]
-      def values
-        [
-          :bottom,
-          :middle,
-          :none,
-          :top,
-        ]
+      # @return [String]
+      def to_sentence
+        Vedeu::Sentence.construct(vertical_values)
       end
 
     end # VerticalAlignment

data/lib/vedeu/common.rb

@@ -90,7 +90,7 @@ module Vedeu
     #   check.
     # @return [Boolean]
     def present?(variable)
-      return true if variable.is_a?(Fixnum)
+      return true if numeric?(variable)
       return true unless variable.nil? ||
                          (variable.respond_to?(:empty?) && variable.empty?)
 

data/lib/vedeu/configuration/configuration.rb

@@ -133,9 +133,25 @@ module Vedeu
 
       # Returns the client defined height for the terminal.
       #
+      # {include:file:docs/dsl/by_method/height.md}
+      #
       # @return [Fixnum]
       def height
-        instance.options[:height]
+        if drb?
+          drb_height
+
+        elsif height?
+          instance.options[:height]
+
+        else
+          Vedeu::Terminal.size[0]
+
+        end
+      end
+
+      # @return [Boolean]
+      def height?
+        instance.options[:height].is_a?(Fixnum)
       end
 
       # Returns whether the application is interactive (required user
@@ -257,9 +273,25 @@ module Vedeu
 
       # Returns the client defined width for the terminal.
       #
+      # {include:file:docs/dsl/by_method/width.md}
+      #
       # @return [Fixnum]
       def width
-        instance.options[:width]
+        if drb?
+          drb_width
+
+        elsif width?
+          instance.options[:width]
+
+        else
+          Vedeu::Terminal.size[-1]
+
+        end
+      end
+
+      # @return [Boolean]
+      def width?
+        instance.options[:width].is_a?(Fixnum)
       end
 
       # @param value [void]
@@ -374,10 +406,16 @@ module Vedeu
   #   @see Vedeu::Configuration.configure
   # @!method configuration
   #   @see Vedeu::Configuration.configuration
+  # @!method height
+  #   @see Vedeu::Configuration.height
+  # @!method width
+  #   @see Vedeu::Configuration.width
   def_delegators Vedeu::Configuration,
                  :config,
                  :configure,
-                 :configuration
+                 :configuration,
+                 :height,
+                 :width
 
   # Sets up a default configuration. Client applications calling using
   # the `Vedeu.configure` API method will override these settings.

data/lib/vedeu/cursors/coordinate.rb

@@ -61,9 +61,7 @@ module Vedeu
 
               end
 
-        pos = pos < bd ? bd : pos
-        pos = pos > bdn ? bdn : pos
-        pos
+        Vedeu::Point.coerce(value: pos, min: bd, max: bdn).value
       end
       alias_method :x, :d_position
       alias_method :y, :d_position

data/lib/vedeu/cursors/cursor.rb

@@ -244,16 +244,12 @@ module Vedeu
 
       # @return [Fixnum] The column/character coordinate.
       def x
-        @x = (@x < bx) ? bx : @x
-        @x = (@x > bxn) ? bxn : @x
-        @x
+        @x = Vedeu::Point.coerce(value: @x, min: bx, max: bxn).value
       end
 
       # @return [Fixnum] The row/line coordinate.
       def y
-        @y = (@y < by) ? by : @y
-        @y = (@y > byn) ? byn : @y
-        @y
+        @y = Vedeu::Point.coerce(value: @y, min: by, max: byn).value
       end
 
       private

data/lib/vedeu/dsl/all.rb

@@ -10,11 +10,10 @@ module Vedeu
 
 end # Vedeu
 
-require 'vedeu/dsl/string/all'
+require 'vedeu/dsl/helpers/all'
 require 'vedeu/dsl/border'
 require 'vedeu/dsl/cursors'
 require 'vedeu/dsl/dsl'
-require 'vedeu/dsl/attributes'
 require 'vedeu/dsl/geometry'
 require 'vedeu/dsl/use'
 require 'vedeu/dsl/presentation'

data/lib/vedeu/dsl/border.rb

@@ -27,9 +27,9 @@ module Vedeu
         # @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.
+        # @macro raise_requires_block
+        # @raise [Vedeu::Error::MissingRequired] When a name is not
+        #   given.
         # @return [Vedeu::Borders::Border]
         # @see Vedeu::Borders::DSL
         def border(name, &block)
@@ -71,9 +71,9 @@ module Vedeu
         #   setting it here is just mirroring functionality of
         #   {Vedeu::DSL::Border::ClassMethods.border}.
         # @param block [Proc]
-        # @raise [Vedeu::Error::MissingRequired|
-        #   Vedeu::Error::RequiresBlock] When a name or block
-        #   respectively are not given.
+        # @macro raise_requires_block
+        # @raise [Vedeu::Error::MissingRequired] When a name is not
+        #   given.
         # @return [Vedeu::Borders::Border]
         # @see Vedeu::Borders::DSL
         def border(name = nil, &block)

data/lib/vedeu/dsl/elements.rb

@@ -63,11 +63,11 @@ module Vedeu
       # @macro raise_requires_block
       # @raise [Vedeu::Error::Fatal]
       # @return [void]
-      def lines(&block)
+      def lines(opts = {}, &block)
         requires_block!(&block)
         requires_model!
 
-        attrs = Vedeu::DSL::Attributes.build(self, model, nil, {}, &block)
+        attrs = Vedeu::DSL::Attributes.build(self, model, nil, opts, &block)
 
         if view_model?
           if model.lines?

data/lib/vedeu/dsl/geometry.rb

@@ -27,9 +27,9 @@ module Vedeu
         # @param name [String|Symbol] The name of the interface or
         #   view to which this geometry belongs.
         # @param block [Proc]
-        # @raise [Vedeu::Error::MissingRequired|
-        #   Vedeu::Error::RequiresBlock] When a name or block
-        #   respectively are not given.
+        # @macro raise_requires_block
+        # @raise [Vedeu::Error::MissingRequired] When a name is not
+        #   given.
         # @return [Vedeu::Geometries::Geometry]
         # @see Vedeu::Geometries::DSL
         def geometry(name = nil, &block)
@@ -80,11 +80,11 @@ module Vedeu
         # @param name [String|Symbol] The name of the interface; this
         #   is already provided when we define the interface or view,
         #   setting it here is just mirroring functionality of
-        #   {Vedeu::DSL::Geometry::ClassMethods.geometry}.
+        #   {Vedeu::DSL::Geometry::ClassMethods#geometry}.
         # @param block [Proc]
-        # @raise [Vedeu::Error::MissingRequired|
-        #   Vedeu::Error::RequiresBlock] When a name or block
-        #   respectively are not given.
+        # @macro raise_requires_block
+        # @raise [Vedeu::Error::MissingRequired] When a name is not
+        #   given.
         # @return [Vedeu::Geometries::Geometry]
         # @see Vedeu::Geometries::DSL
         def geometry(name = nil, &block)

data/lib/vedeu/dsl/helpers/all.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Vedeu
+
+  # Provides a mechanism to help configure and use Vedeu.
+  #
+  module DSL
+
+  end # DSL
+
+end # Vedeu
+
+require 'vedeu/dsl/helpers/attributes'
+require 'vedeu/dsl/helpers/align'
+require 'vedeu/dsl/helpers/truncate'
+require 'vedeu/dsl/helpers/wordwrap'
+require 'vedeu/dsl/helpers/text'

data/lib/vedeu/dsl/view.rb

@@ -42,31 +42,22 @@ module Vedeu
     #
     class View
 
+      include Vedeu::Common
       include Vedeu::DSL
 
-      # Define a view.
-      #
-      # A view is just an Interface object.
-      #
-      # When a view already exists, we take its attributes and use
-      # them as the basis for the newly defined view. This way we
-      # don't need to specify everything again.
-      #
-      # @todo More documentation required.
+      # {include:file:docs/dsl/by_method/view.md}
       # @param name [String|Symbol] The name of the interface you are
       #   targetting for this view.
       # @param block [Proc] The directives you wish to send to this
-      #   interface.
-      #
-      # @example
-      #   view :my_interface do
-      #     # ...
-      #   end
-      #
+      #   view.
       # @macro raise_requires_block
+      # @raise [Vedeu::Error::MissingRequired]
       # @return [Vedeu::Views::Views<Vedeu::Views::View>]
-      def view(name = '', &block)
+      # @todo More documentation required.
+      def view(name, &block)
         fail Vedeu::Error::RequiresBlock unless block_given?
+        fail Vedeu::Error::MissingRequired,
+             'Cannot add view without a name.' unless present?(name)
 
         new_model = Vedeu::Views::View.build(new_attributes(name), &block)
 
@@ -97,9 +88,10 @@ module Vedeu
       def template_for(name, filename, object = nil, options = {})
         fail Vedeu::Error::MissingRequired,
              'Cannot render template without the name of the ' \
-             'view.' unless name
+             'view.' unless present?(name)
         fail Vedeu::Error::MissingRequired,
-             'Cannot render template without a filename.' unless filename
+             'Cannot render template without a ' \
+             'filename.' unless present?(filename)
 
         options.merge!(name: name)
 

data/lib/vedeu/dsl/views.rb

@@ -93,137 +93,47 @@ module Vedeu
 
       class << self
 
-        include Vedeu::Common
-
-        # Directly write a view buffer to the terminal. Using this
-        # method means that the refresh event does not need to be
-        # triggered after creating the views, though can be later
-        # triggered when needed.
-        #
-        #   Vedeu.renders do
-        #     view :some_interface do
-        #       line do
-        #         stream do
-        #           left 'Title goes here', width: 35
-        #         end
-        #         stream do
-        #           right Time.now.strftime('%H:%m'), width: 7
-        #         end
-        #       end
-        #     end
-        #     view :other_interface do
-        #       lines do
-        #         line 'This is content for the main interface.'
-        #         line ''
-        #         line 'Pretty easy eh?'
-        #       end
-        #     end
-        #     # ... some code
-        #   end
-        #
-        #   # or...
-        #
-        #   Vedeu.render do
-        #     view :my_interface do
-        #       # ... some code
-        #     end
-        #   end
-        #
+        # {include:file:docs/dsl/by_method/renders.md}
         # @param block [Proc] The directives you wish to send to
         #   render. Typically includes `view` with associated
         #   sub-directives.
         # @macro raise_requires_block
-        # @return [Array<View>]
+        # @return [Vedeu::Views::Composition]
         def renders(&block)
           fail Vedeu::Error::RequiresBlock unless block_given?
 
-          store(:store_immediate, client(&block), &block)
+          composition(eval('self', block.binding), true, &block)
         end
         alias_method :render, :renders
 
-        # Define a view (content) for an interface.
-        #
-        # As you can see by comparing the examples above to these
-        # below, the immediate render simply wraps what is already
-        # here in the deferred view.
-        #
-        # The views declared within this block are stored in their
-        # respective interface back buffers until a refresh event
-        # occurs. When the refresh event is triggered, the back
-        # buffers are swapped into the front buffers and the content
-        # here will be rendered to {Vedeu::Terminal#output}.
-        #
-        #   Vedeu.views do
-        #     view :some_interface do
-        #       line do
-        #         stream do
-        #           left 'Title goes here', width: 35
-        #         end
-        #         stream do
-        #           right Time.now.strftime('%H:%m'), width: 7
-        #         end
-        #       end
-        #     end
-        #     view :other_interface do
-        #       lines do
-        #         line 'This is content for the main interface.'
-        #         line ''
-        #         line 'Pretty easy eh?'
-        #       end
-        #     end
-        #     # ... some code
-        #   end
-        #
+        # {include:file:docs/dsl/by_method/views.md}
         # @param block [Proc] The directives you wish to send to
         #   render. Typically includes `view` with associated
         #   sub-directives.
         # @macro raise_requires_block
-        # @return [Array<View>]
+        # @return [Vedeu::Views::Composition]
         def views(&block)
           fail Vedeu::Error::RequiresBlock unless block_given?
 
-          store(:store_deferred, client(&block), &block)
+          composition(eval('self', block.binding), false, &block)
         end
 
         private
 
-        # Returns the client object which called the DSL method.
-        #
-        # @param block [Proc]
-        # @return [Object]
-        def client(&block)
-          eval('self', block.binding)
-        end
-
         # Creates a new Vedeu::Views::Composition which may contain
-        # one or more views (Vedeu::Views::View objects).
+        # one or more view {Vedeu::Views::View} objects.
         #
-        # @param client [Object]
-        # @param block [Proc]
-        # @return [Vedeu::Views::Composition]
-        def composition(client, &block)
-          attrs = { client: client, colour: Vedeu.config.colour }
-
-          Vedeu::Views::Composition.build(attrs, &block)
-        end
-
-        # Creates a new Vedeu::Views::Composition which may contain
-        # one or more views (Vedeu::Views::View objects).
-        #
-        # Stores each of the views defined in their respective buffers
-        # ready to be rendered on next refresh.
-        #
-        # @param method [Symbol] An instruction; `:store_immediate` or
-        #   `:store_deferred` which determines whether the view will
-        #   be shown immediately or later respectively.
         # @param client [Object] The client class which called the DSL
         #   object.
-        # @param block [Proc]
-        # @return [Array]
-        def store(method, client, &block)
-          composition(client, &block).views.map do |view|
-            view.public_send(method)
-          end
+        # @param refresh [Boolean]
+        # @param block [Proc] The directives you wish to send to
+        #   render. Typically includes `view` with associated
+        #   sub-directives.
+        # # @return [Vedeu::Views::Composition]
+        def composition(client, refresh = false, &block)
+          attrs = { client: client, colour: Vedeu.config.colour }
+
+          Vedeu::Views::Composition.build(attrs, &block).update_buffers(refresh)
         end
 
       end # Eigenclass