vedeu 0.8.8 → 0.8.9

data/lib/vedeu/coercers/editor_line.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Vedeu
+
+  module Coercers
+
+    # Provides the mechanism to convert a value into a
+    # {Vedeu::Editor::Line}.
+    #
+    # @api private
+    #
+    class EditorLine < Vedeu::Coercers::Coercer
+
+      # @return [void]
+      def coerce
+        if coerced?
+          value
+
+        else
+
+
+        end
+      end
+
+      private
+
+      # @return [Class]
+      def klass
+        Vedeu::Editor::Line
+      end
+
+    end # EditorLine
+
+  end # Coercers
+
+end # Vedeu

data/lib/vedeu/coercers/editor_lines.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Vedeu
+
+  module Coercers
+
+    # Provides the mechanism to convert a value into a
+    # {Vedeu::Editor::Lines}.
+    #
+    # @api private
+    #
+    class EditorLines < Vedeu::Coercers::Coercer
+
+      # @return [void]
+      def coerce
+        if coerced?
+          value
+
+        else
+
+
+        end
+      end
+
+      private
+
+      # @return [Class]
+      def klass
+        Vedeu::Editor::Lines
+      end
+
+    end # EditorLines
+
+  end # Coercers
+
+end # Vedeu

data/lib/vedeu/coercers/lines.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Vedeu
+
+  module Coercers
+
+    # Provides the mechanism to convert a value into a
+    # {Vedeu::Views::Lines}.
+    #
+    # @api private
+    #
+    class Lines < Vedeu::Coercers::Coercer
+
+      # @return [void]
+      def coerce
+        if coerced?
+          value
+
+        else
+
+
+        end
+      end
+
+      private
+
+      # @return [Class]
+      def klass
+        Vedeu::Views::Lines
+      end
+
+    end # Lines
+
+  end # Coercers
+
+end # Vedeu

data/lib/vedeu/coercers/page.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Vedeu
+
+  module Coercers
+
+    # Provides the mechanism to convert a value into a
+    # {Vedeu::Models::Page}.
+    #
+    # @api private
+    #
+    class Page < Vedeu::Coercers::Coercer
+
+      # @param value
+      #   [Vedeu::Models::Page|Vedeu::Models::Row|Array<void>|void]
+      # @macro raise_invalid_syntax
+      # @return [Vedeu::Models::Page]
+      def coerce
+        if coerced?
+          value
+
+        elsif value.is_a?(Vedeu::Models::Row)
+          klass.new([value])
+
+        elsif value.is_a?(Array) && value.empty?
+          klass.new([Vedeu::Models::Row.coerce(value)])
+
+        elsif value.is_a?(Array) || value.is_a?(Vedeu::Buffers::View)
+          values = value.map { |v| Vedeu::Models::Row.coerce(v) }
+
+          klass.new(values)
+
+        else
+          fail Vedeu::Error::InvalidSyntax,
+               "Cannot coerce as value is not an Array, #{klass} " \
+               "or Vedeu::Models::Row. Is a '#{value.class.name}'."
+
+        end
+      end
+
+      private
+
+      # @return [Class]
+      def klass
+        Vedeu::Models::Page
+      end
+
+    end # Page
+
+  end # Coercers
+
+end # Vedeu

data/lib/vedeu/coercers/position.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Vedeu
+
+  module Coercers
+
+    # Provides the mechanism to convert a value into a
+    # {Vedeu::Geometries::Position}.
+    #
+    # @api private
+    #
+    class Position < Vedeu::Coercers::Coercer
+
+      # @macro raise_fatal
+      # @return [NilClass|Vedeu::Geometries::Position]
+      def coerce
+        if value.nil? || coerced?
+          value
+
+        elsif tuple?
+          klass.new(*value)
+
+        elsif hash?
+          klass.new(value.fetch(:y, 1), value.fetch(:x, 1))
+
+        elsif fixnum?
+          klass.new(value, 1)
+
+        else
+          fail Vedeu::Error::Fatal,
+               "Vedeu cannot coerce a '#{value.class.name}' into a " \
+               "'#{klass}'."
+
+        end
+      end
+
+      private
+
+      # @return [Boolean]
+      def fixnum?
+        value.is_a?(Fixnum)
+      end
+
+      # @return [Boolean]
+      def hash?
+        value.is_a?(Hash)
+      end
+
+      # @return [Class]
+      def klass
+        Vedeu::Geometries::Position
+      end
+
+      # @macro raise_fatal
+      # @return [Boolean]
+      def tuple?
+        return false unless value.is_a?(Array)
+        return true  if value.size == 2
+
+        fail Vedeu::Error::Fatal,
+             "A '#{klass}' is made up of two elements. (Provided " \
+             "#{value.size}.)"
+      end
+
+    end # Position
+
+  end # Coercers
+
+end # Vedeu

data/lib/vedeu/coercers/row.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Vedeu
+
+  module Coercers
+
+    # Provides the mechanism to convert a value into a
+    # {Vedeu::Models::Row}.
+    #
+    # @api private
+    #
+    class Row < Vedeu::Coercers::Coercer
+
+      # @param value [Vedeu::Models::Row|Array<void>|void]
+      # @return [Vedeu::Models::Row]
+      def coerce
+        if coerced?
+          value
+
+        elsif value.is_a?(Array)
+          klass.new(value.compact)
+
+        elsif value.nil?
+          klass.new
+
+        else
+          klass.new([value])
+
+        end
+      end
+
+      private
+
+      # @return [Class]
+      def klass
+        Vedeu::Models::Row
+      end
+
+    end # Row
+
+  end # Coercers
+
+end # Vedeu

data/lib/vedeu/coercers/streams.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Vedeu
+
+  module Coercers
+
+    # Provides the mechanism to convert a value into a
+    # {Vedeu::Views::Streams}.
+    #
+    # @api private
+    #
+    class Streams < Vedeu::Coercers::Coercer
+
+      # @return [void]
+      def coerce
+      end
+
+      private
+
+      # @return [Class]
+      def klass
+        Vedeu::Views::Streams
+      end
+
+    end # Streams
+
+  end # Coercers
+
+end # Vedeu

data/lib/vedeu/coercers/style.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Vedeu
+
+  module Coercers
+
+    # Provides the mechanism to convert a value into a
+    # {Vedeu::Presentation::Style}.
+    #
+    # @api private
+    #
+    class Style < Vedeu::Coercers::Coercer
+
+      # Produces new objects of the correct class from the value,
+      # ignores objects that have already been coerced.
+      #
+      # @return [Vedeu::Presentation::Style]
+      def coerce
+        if coerced?
+          value
+
+        elsif value.is_a?(Hash)
+          if present?(value[:style])
+            if value[:style].is_a?(klass)
+              value[:style]
+
+            else
+              Vedeu::Coercers::Style.coerce(value[:style])
+
+            end
+
+          else
+            klass.new
+
+          end
+
+        else
+          klass.new(value)
+
+        end
+      end
+
+      private
+
+      # @return [Class]
+      def klass
+        Vedeu::Presentation::Style
+      end
+
+    end # Style
+
+  end # Coercers
+
+end # Vedeu

data/lib/vedeu/configuration/api.rb

@@ -525,6 +525,16 @@ module Vedeu
       end
       alias terminal_mode= terminal_mode
 
+      # Instructs Vedeu to use threads to perform certain actions.
+      # This can have a performance impact.
+      #
+      # @param boolean [Boolean]
+      # @return [Boolean]
+      def threaded(boolean)
+        options[:threaded] = boolean
+      end
+      alias threaded= threaded
+
       # Sets the width of the terminal.
       #
       #   Vedeu.configure do

data/lib/vedeu/configuration/configuration.rb

@@ -269,6 +269,16 @@ module Vedeu
         instance.options[:terminal_mode]
       end
 
+      # Returns a boolean indicating whether Vedeu should use threads
+      # to perform certain actions. This can have a performance
+      # impact.
+      #
+      # @return [Boolean]
+      def threaded?
+        instance.options[:threaded]
+      end
+      alias threaded threaded?
+
       # Returns the client defined width for the terminal.
       #
       # {include:file:docs/dsl/by_method/width.md}
@@ -371,6 +381,7 @@ module Vedeu
         stdout:        nil,
         stderr:        nil,
         terminal_mode: :raw,
+        threaded:      true,
         width:         nil,
       }
     end

data/lib/vedeu/cursors/coordinate.rb

@@ -10,10 +10,18 @@ module Vedeu
     #
     class Coordinate
 
+      extend Forwardable
+
+      def_delegators :coordinate,
+                     :d,
+                     :bd,
+                     :bdn,
+                     :d_dn
+
       # Return a new instance of Vedeu::Cursors::Coordinate.
       #
       # @param attributes [Hash<Symbol => Fixnum|String|Symbol>]
-      # @option attributes name [String|Symbol]
+      # @option attributes geometry [Vedeu::Geometries::Geometry]
       # @option attributes type [Symbol]
       # @option attributes offset [Fixnum]
       # @return [Vedeu::Cursors::Coordinate]
@@ -50,27 +58,16 @@ module Vedeu
       #
       # @return [Fixnum]
       def d_position
-        pos = if offset <= 0
-                d
-
-              elsif offset > dn_index
-                dn_position
-
-              else
-                d_range[offset]
-
-              end
-
-        Vedeu::Point.coerce(value: pos, min: bd, max: bdn).value
+        Vedeu::Point.coerce(value: position, min: bd, max: bdn).value
       end
       alias x d_position
       alias y d_position
 
       protected
 
-      # @!attribute [r] name
-      # @return [String|Symbol]
-      attr_reader :name
+      # @!attribute [r] geometry
+      # @return [Vedeu::Geometries::Geometry]
+      attr_reader :geometry
 
       # @!attribute [r] offset
       # @return [Fixnum]
@@ -82,54 +79,16 @@ module Vedeu
 
       private
 
-      # Returns the geometry for the interface.
-      #
-      # @return (see Vedeu::Geometries::Repository#by_name)
-      def geometry
-        @geometry ||= Vedeu.geometries.by_name(name)
-      end
-
-      # Return the :x or :y value from the geometry.
-      #
-      # @return [Fixnum]
-      def d
-        geometry.send(coordinate_type[0])
-      end
-
-      # Return the :bx or :by value from the geometry.
-      #
-      # @return [Fixnum]
-      def bd
-        geometry.send(coordinate_type[1])
-      end
-
-      # Return the :bxn or :byn value from the geometry.
-      #
-      # @return [Fixnum]
-      def bdn
-        geometry.send(coordinate_type[2])
-      end
-
-      # Return the :width or :height value from the geometry.
-      #
-      # @return [Fixnum]
-      def d_dn
-        geometry.send(coordinate_type[3])
-      end
-
-      # Ascertain the correct methods to use for determining the
-      # coordinates.
-      #
       # @macro raise_invalid_syntax
-      # @return [Fixnum]
-      def coordinate_type
-        @_type ||= case type
-                   when :x then [:x, :bx, :bxn, :bordered_width]
-                   when :y then [:y, :by, :byn, :bordered_height]
-                   else
-                     fail Vedeu::Error::InvalidSyntax,
-                          'Coordinate type not given, cannot continue.'
-                   end
+      # @return [Vedeu::XCoordinate|Vedeu::YCoordinate]
+      def coordinate
+        @_coordinate ||= case type
+                         when :x then Vedeu::XCoordinate.new(geometry)
+                         when :y then Vedeu::YCoordinate.new(geometry)
+                         else
+                           fail Vedeu::Error::InvalidSyntax,
+                                'Coordinate type not given, cannot continue.'
+                         end
       end
 
       # Returns the maximum index for an area.
@@ -163,12 +122,28 @@ module Vedeu
       # @return [Hash<Symbol => Fixnum|String|Symbol>]
       def defaults
         {
-          name:   '',
-          offset: nil,
-          type:   :x,
+          geometry: nil,
+          offset:   nil,
+          type:     :x,
         }
       end
 
+      # Return the position respective of the offset.
+      #
+      # @return [Fixnum]
+      def position
+        if offset <= 0
+          d
+
+        elsif offset > dn_index
+          dn_position
+
+        else
+          d_range[offset]
+
+        end
+      end
+
     end # Coordinate
 
   end # Cursors