vedeu 0.8.8 → 0.8.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8abebd20481d927ef3b7de1f4a21c566109fcb5a
-  data.tar.gz: 3db48c0f3218d6d534cf731f256084e6a98efb91
+  metadata.gz: 83b3e4909563317ccf8df15a1f8e0106f27ca00a
+  data.tar.gz: fc3fce16bcc6f5648854b4897b493aaf6b04857e
 SHA512:
-  metadata.gz: e6555ade9af405d42797525c9ce496d4e6f105babf54d6edbfe5cf2fcbc618b71823b9709544fca60c8c2a853918d4d259dc372ca56bf037061d351add0f5016
-  data.tar.gz: 057a89420029e115a3a87bcdc56872d0e01b0149e08c4d29899870632a0e989377b09b295bf7be4f94f4e8ed8800c1fec1a59292cb635696bca7d2604edee9c5
+  metadata.gz: 32aa195136e7b3cbbfa16018dba9c6da366df448e2a4a432c232485808bbad8d0c5dd4f9154d5313ccb9a1867373b607142dad8859a90474c738deca068d2f94
+  data.tar.gz: efdbc099065362fd76ecc407f50915ebad6285b0f36707153fe7a2266f8603be7620aaefb87abb34871730db610527bddfda04783258c51b9bf9051273727019

data/docs/dsl/by_method/focus_by_name.md

@@ -1 +1,6 @@
-@todo Add more documentation.
+Instruct Vedeu to focus the view with the given name.
+
+@todo Add more documentation
+- What would happen if the view was not currently visible?
+- What would happen if the view was occupying the same space as
+  another view?

data/docs/dsl/by_method/focus_next.md

@@ -1 +1,8 @@
+Instruct Vedeu to focus the next visible view.
+
+    Vedeu.focus_next
+
+    Vedeu.trigger(:_focus_next_)
+
 @todo Add more documentation.
+- How does this work with groups?

data/docs/dsl/by_method/focus_previous.md

@@ -1 +1,8 @@
+Instruct Vedeu to focus the previous visible view.
+
+    Vedeu.focus_previous
+
+    Vedeu.trigger(:_focus_prev_)
+
 @todo Add more documentation.
+- How does this work with groups?

data/docs/events/by_name/mouse_event.md

@@ -0,0 +1,8 @@
+Triggered when Vedeu receives input from a mouse.
+
+Binding to this event in the client application will give access to
+the escape sequence emitted by the terminal.
+
+    Vedeu.bind(:_mouse_event_) do |input|
+      # ... some code ...
+    end

data/lib/vedeu.rb

@@ -44,4 +44,16 @@ module Vedeu
 
 end # Vedeu
 
+# Define some Yard macros used throughout the project.
+#
+# @!macro [new] included_module
+#   Provide additional behaviour to a class or module.
+#
+#   When a ClassMethods submodule and/or an InstanceMethods submodule
+#   is defined within this module, then provide these methods as
+#   class or instance methods to the including class or module.
+#
+#   @param klass [Class]
+#   @return [void]
+
 require 'vedeu/all'

data/lib/vedeu/all.rb

@@ -7,6 +7,8 @@ require 'vedeu/sentence'
 require 'vedeu/version'
 
 require 'vedeu/support/point'
+require 'vedeu/support/x_coordinate'
+require 'vedeu/support/y_coordinate'
 
 require 'vedeu/configuration/all'
 require 'vedeu/esc/all'

data/lib/vedeu/application/controller.rb

@@ -6,7 +6,7 @@ module Vedeu
   #
   module Controller
 
-    # When included, provide these methods as class methods.
+    # Provide additional behaviour as class methods.
     #
     module ClassMethods
 
@@ -75,11 +75,7 @@ module Vedeu
 
     end # ClassMethods
 
-    # When this module is included in a class, provide ClassMethods as
-    # class methods for the class.
-    #
-    # @param klass [Class]
-    # @return [void]
+    # @macro included_module
     def self.included(klass)
       klass.extend(Vedeu::Controller::ClassMethods)
     end

data/lib/vedeu/buffers/empty.rb

@@ -58,7 +58,8 @@ module Vedeu
       def empty
         Array.new(height) do |h|
           Array.new(width) do |w|
-            Vedeu::Cells::Empty.new(name: name, position: [y + h, x + w])
+            position = Vedeu::Geometries::Position.new((y + h), (x + w))
+            Vedeu::Cells::Empty.new(name: name, position: position)
           end
         end
       end

data/lib/vedeu/cells/borders/vertices/bottom_left.rb

@@ -25,7 +25,7 @@ module Vedeu
 
       # @return [Hash<Symbol => String>]
       def defaults
-        super.merge!(position: Vedeu::Geometries::Position.coerce([yn, x]),
+        super.merge!(position: Vedeu::Geometries::Position.new(yn, x),
                      value:    Vedeu.esc.bottom_left)
       end
 

data/lib/vedeu/cells/borders/vertices/bottom_right.rb

@@ -25,7 +25,7 @@ module Vedeu
 
       # @return [Hash<Symbol => String>]
       def defaults
-        super.merge!(position: Vedeu::Geometries::Position.coerce([yn, xn]),
+        super.merge!(position: Vedeu::Geometries::Position.new(yn, xn),
                      value:    Vedeu.esc.bottom_right)
       end
 

data/lib/vedeu/cells/borders/vertices/top_left.rb

@@ -25,7 +25,7 @@ module Vedeu
 
       # @return [Hash<Symbol => String>]
       def defaults
-        super.merge!(position: Vedeu::Geometries::Position.coerce([y, x]),
+        super.merge!(position: Vedeu::Geometries::Position.new(y, x),
                      value:    Vedeu.esc.top_left)
       end
 

data/lib/vedeu/cells/borders/vertices/top_right.rb

@@ -25,7 +25,7 @@ module Vedeu
 
       # @return [Hash<Symbol => String>]
       def defaults
-        super.merge!(position: Vedeu::Geometries::Position.coerce([y, xn]),
+        super.merge!(position: Vedeu::Geometries::Position.new(y, xn),
                      value:    Vedeu.esc.top_right)
       end
 

data/lib/vedeu/cells/char.rb

@@ -16,13 +16,9 @@ module Vedeu
 
       # @return [String]
       def as_html
-        if present?(value)
-          value
+        return value if present?(value)
 
-        else
-          super
-
-        end
+        super
       end
 
       # @return [Boolean]

data/lib/vedeu/cells/cursor.rb

@@ -58,7 +58,7 @@ module Vedeu
 
       # @return [Hash]
       def defaults
-        super.merge!(position: [1, 1])
+        super.merge!(position: Vedeu::Geometries::Position.new(1, 1))
       end
 
     end # Cursor

data/lib/vedeu/cells/support/html.rb

@@ -39,13 +39,9 @@ module Vedeu
 
       # @return [String]
       def background
-        if cell.respond_to?(:background)
-          cell.background.to_html
+        return '' unless cell.respond_to?(:background)
 
-        else
-          ''
-
-        end
+        cell.background.to_html
       end
 
       # @return [String]
@@ -55,13 +51,9 @@ module Vedeu
 
       # @return [String]
       def foreground
-        if cell.respond_to?(:foreground)
-          cell.foreground.to_html
-
-        else
-          ''
+        return '' unless cell.respond_to?(:foreground)
 
-        end
+        cell.foreground.to_html
       end
 
       # @return [String]
@@ -71,13 +63,9 @@ module Vedeu
 
       # @return [String]
       def style_attribute
-        if absent?(background) && absent?(foreground)
-          ''
-
-        else
-          " style='#{background}#{foreground}'"
+        return '' if absent?(background) && absent?(foreground)
 
-        end
+        " style='#{background}#{foreground}'"
       end
 
       # @return [String]

data/lib/vedeu/coercers/all.rb

@@ -2,7 +2,10 @@
 
 module Vedeu
 
-  # Provides a mechanism to coerce values within Vedeu.
+  # Provides a mechanism to coerce values within Vedeu in to expected
+  # objects.
+  #
+  # @api private
   #
   module Coercers
 
@@ -10,9 +13,23 @@ module Vedeu
 
 end # Vedeu
 
+require 'vedeu/coercers/coercer'
+
 require 'vedeu/coercers/alignment'
 require 'vedeu/coercers/horizontal_alignment'
 require 'vedeu/coercers/vertical_alignment'
 
+require 'vedeu/coercers/chars'
+
 require 'vedeu/coercers/colour'
 require 'vedeu/coercers/colour_attributes'
+
+require 'vedeu/coercers/editor_line'
+require 'vedeu/coercers/editor_lines'
+
+require 'vedeu/coercers/lines'
+require 'vedeu/coercers/page'
+require 'vedeu/coercers/position'
+require 'vedeu/coercers/row'
+require 'vedeu/coercers/streams'
+require 'vedeu/coercers/style'

data/lib/vedeu/coercers/chars.rb

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

data/lib/vedeu/coercers/coercer.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Vedeu
+
+  module Coercers
+
+    # Provides the mechanism to convert a value into another value.
+    #
+    # @api private
+    #
+    class Coercer
+
+      include Vedeu::Common
+
+      # @param (see #initialize)
+      # @return (see #coerce)
+      def self.coerce(value)
+        new(value).coerce
+      end
+
+      # Returns a new instance of the Vedeu::Coercers::Coercer
+      # subclass.
+      #
+      # @param value [void]
+      # @return [Vedeu::Coercers::Coercer]
+      def initialize(value)
+        @value = value
+      end
+
+      # @macro raise_not_implemented
+      # @return [void]
+      def coerce
+        fail Vedeu::Error::NotImplemented, 'Subclasses implement this.'
+      end
+
+      protected
+
+      # @!attribute [r] value
+      # @return [void]
+      attr_reader :value
+
+      private
+
+      # @return [Boolean]
+      def coerced?
+        value.is_a?(klass)
+      end
+
+      # @macro raise_not_implemented
+      # @return [Class]
+      def klass
+        fail Vedeu::Error::NotImplemented, 'Subclasses implement this.'
+      end
+
+    end # Coercer
+
+  end # Coercers
+
+end # Vedeu

data/lib/vedeu/coercers/colour.rb

@@ -9,40 +9,28 @@ module Vedeu
     #
     # @api private
     #
-    class Colour
+    class Colour < Vedeu::Coercers::Coercer
 
       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.
+      # @macro raise_fatal
       # @return [void]
       def coerce
-        if absent?(value)
-          Vedeu::Colours::Colour.new
+        if coerced?
+          value
 
-        elsif background?
-          Vedeu::Colours::Colour.new(background: value)
+        elsif absent?(value)
+          klass.new
 
-        elsif colour?
-          value
+        elsif background?
+          klass.new(background: value)
 
         elsif foreground?
-          Vedeu::Colours::Colour.new(foreground: value)
+          klass.new(foreground: value)
 
         elsif hash?(value)
           attributes = Vedeu::Coercers::ColourAttributes.coerce(value)
-          Vedeu::Colours::Colour.new(attributes)
+          klass.new(attributes)
 
         else
           fail Vedeu::Error::Fatal, 'Vedeu cannot coerce this colour.'
@@ -50,12 +38,6 @@ module Vedeu
         end
       end
 
-      protected
-
-      # @!attribute [r] value
-      # @return [void]
-      attr_reader :value
-
       private
 
       # @return [Boolean]
@@ -63,16 +45,16 @@ module Vedeu
         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
 
+      # @return [Class]
+      def klass
+        Vedeu::Colours::Colour
+      end
+
     end # Colour
 
   end # Coercers

data/lib/vedeu/coercers/colour_attributes.rb

@@ -33,7 +33,7 @@ module Vedeu
         if colour? && hash?(colour)
           Vedeu::Coercers::ColourAttributes.coerce(colour)
 
-        elsif colour? && already_coerced?(colour)
+        elsif colour? && coerced?(colour)
           colour.attributes
 
         else
@@ -52,8 +52,8 @@ module Vedeu
 
       # @param colour [void]
       # @return [Boolean]
-      def already_coerced?(colour)
-        colour.is_a?(Vedeu::Colours::Colour)
+      def coerced?(colour)
+        colour.is_a?(klass)
       end
 
       # @return [Hash]
@@ -104,6 +104,11 @@ module Vedeu
         valid?(foreground)
       end
 
+      # @return [Class]
+      def klass
+        Vedeu::Colours::Colour
+      end
+
       # @param colour [void]
       # @return [Boolean]
       def valid?(colour)