vedeu 0.6.60 → 0.6.61

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 686a2b4fb8270f973081dc3c7d108cdb49e6449a
-  data.tar.gz: 4ad07b62d0523da5bcfa758b53d1602b12396bc5
+  metadata.gz: caa790910d980d060680517416aab7206faea84f
+  data.tar.gz: b8ce3a4ae71d898bbd1c99da090b3d66976b0bb9
 SHA512:
-  metadata.gz: 019242a5c896bf72c9e396f389ec4e185b461d9839087ae68f208a17c62307137aece08f65174ba3d4aa68f4d90233b327138dcaec1de35f858fa916ac58f43c
-  data.tar.gz: f1489ca293258577eef48e095e8cea55cc22502d14c0a2df0f3fd281b0b200348cb6dd9486a92a845c68638d766514a7771d01dc63d1a6e4fe0b15c3abfa2ef0
+  metadata.gz: 97f27f54135a8415d01fc5c2b3f65d1652ba3b057c63fc5f9f0baf67ec07f7560340b652b40fbeea864015e0423eac7d4b877c0259f7451fc5316965987e2dcb
+  data.tar.gz: f895269aef915276b769640d7f77e02cffb79f0ec920dc50a173967c737d80c2866bade305ff064e82465264caddcebec48c0481ed80ce4391edc045396af07c

data/docs/dsl.md

@@ -105,27 +105,27 @@ end
 
 ## Geometry
 
-{include:Vedeu::Geometry::DSL}
+{include:Vedeu::Geometries::DSL}
 
 ### Setting the interface dimensions
 
-{include:Vedeu::Geometry::DSL#align}
-{include:Vedeu::Geometry::DSL#align_left}
-{include:Vedeu::Geometry::DSL#align_centre}
-{include:Vedeu::Geometry::DSL#align_right}
-{include:Vedeu::Geometry::DSL#align_top}
-{include:Vedeu::Geometry::DSL#align_middle}
-{include:Vedeu::Geometry::DSL#align_bottom}
-{include:Vedeu::Geometry::DSL#horizontal_alignment}
-{include:Vedeu::Geometry::DSL#vertical_alignment}
-{include:Vedeu::Geometry::DSL#height}
-{include:Vedeu::Geometry::DSL#width}
-{include:Vedeu::Geometry::DSL#columns}
-{include:Vedeu::Geometry::DSL#rows}
-{include:Vedeu::Geometry::DSL#x}
-{include:Vedeu::Geometry::DSL#xn}
-{include:Vedeu::Geometry::DSL#y}
-{include:Vedeu::Geometry::DSL#yn}
+{include:Vedeu::Geometries::DSL#align}
+{include:Vedeu::Geometries::DSL#align_left}
+{include:Vedeu::Geometries::DSL#align_centre}
+{include:Vedeu::Geometries::DSL#align_right}
+{include:Vedeu::Geometries::DSL#align_top}
+{include:Vedeu::Geometries::DSL#align_middle}
+{include:Vedeu::Geometries::DSL#align_bottom}
+{include:Vedeu::Geometries::DSL#horizontal_alignment}
+{include:Vedeu::Geometries::DSL#vertical_alignment}
+{include:Vedeu::Geometries::DSL#height}
+{include:Vedeu::Geometries::DSL#width}
+{include:Vedeu::Geometries::DSL#columns}
+{include:Vedeu::Geometries::DSL#rows}
+{include:Vedeu::Geometries::DSL#x}
+{include:Vedeu::Geometries::DSL#xn}
+{include:Vedeu::Geometries::DSL#y}
+{include:Vedeu::Geometries::DSL#yn}
 
 ## Groups
 

data/docs/events/drb.md

@@ -11,16 +11,10 @@ Note: See {Vedeu::Distributed::Server#input} for parameter details.
     Vedeu.trigger(:_drb_input_, data, type)
 
 ### `:\_drb_retrieve_output\_`
-
-    Vedeu.trigger(:_drb_retrieve_output_)
+See {Vedeu::Terminal::Buffer#output}
 
 ### `:\_drb_store_output\_`
-Triggering this event with 'data' will push data into the running
-application's virtual buffer.
-
-Note: See {Vedeu::Terminal::Buffer#write} for parameter details.
-
-    Vedeu.trigger(:_drb_store_output_, data)
+See {Vedeu::Terminal::Buffer#write}
 
 ### `:\_drb_restart\_`
 Use the DRb server to request the client application to restart.

data/docs/events/view.md

@@ -9,7 +9,7 @@ Maximising an interface.
 
     Vedeu.trigger(:_maximise_, name)
 
-See {Vedeu::Geometry::Geometry#maximise}
+See {Vedeu::Geometries::Geometry#maximise}
 
 ### `:\_movement_refresh\_`
 When triggered, triggers additional events which aid the updating of
@@ -42,4 +42,4 @@ Unmaximising an interface.
 
     Vedeu.trigger(:_unmaximise_, name)
 
-See {Vedeu::Geometry::Geometry#unmaximise}
+See {Vedeu::Geometries::Geometry#unmaximise}

data/docs/events/visibility.md

@@ -5,10 +5,7 @@
 Note: 'name' is a Symbol unless mentioned otherwise.
 
 ### `:\_clear\_`
-Clears the whole terminal space.
-
-    Vedeu.trigger(:_clear_)
-    Vedeu.clear
+See {Vedeu::Terminal::Buffer#clear}
 
 ### `:\_clear_group\_`
 Clears the spaces occupied by the interfaces belonging to the named

data/lib/vedeu/all.rb

@@ -27,7 +27,7 @@ require 'vedeu/buffers/all'
 require 'vedeu/colours/all'
 require 'vedeu/distributed/all'
 require 'vedeu/editor/all'
-require 'vedeu/geometry/all'
+require 'vedeu/geometries/all'
 require 'vedeu/groups/all'
 require 'vedeu/input/all'
 require 'vedeu/interfaces/all'

data/lib/vedeu/borders/border.rb

@@ -195,7 +195,7 @@ module Vedeu
 
       # Returns the geometry for the interface.
       #
-      # @return (see Vedeu::Geometry::Repository#by_name)
+      # @return (see Vedeu::Geometries::Repository#by_name)
       def geometry
         Vedeu.geometries.by_name(name)
       end

data/lib/vedeu/borders/refresh.rb

@@ -182,7 +182,7 @@ module Vedeu
 
       # Returns the geometry for the interface.
       #
-      # @return (see Vedeu::Geometry::Repository#by_name)
+      # @return (see Vedeu::Geometries::Repository#by_name)
       def geometry
         Vedeu.geometries.by_name(name)
       end

data/lib/vedeu/buffers/empty.rb

@@ -16,11 +16,13 @@ module Vedeu
 
       # @return [Array<Array<Vedeu::Models::Cell>>]
       def buffer
-        Array.new(width) do |y|
-          Array.new(height) do |x|
-            Vedeu::Models::Cell.new(name: name, position: [y, x])
+        Array.new(height) do |y|
+          unless y == 0
+            Array.new(width) do |x|
+              Vedeu::Models::Cell.new(name: name, position: [y, x]) unless x == 0
+            end.compact
           end
-        end
+        end.compact
       end
 
       # @note

data/lib/vedeu/buffers/view.rb

@@ -9,14 +9,52 @@ module Vedeu
     class View
 
       include Vedeu::Repositories::Defaults
+      include Enumerable
 
-      private
+      # @return [Hash<Symbol => String|Symbol>]
+      def attributes
+        {
+          name: name
+        }
+      end
 
-      # @return [Vedeu::Geometry::Geometry]
-      def geometry
-        Vedeu.geometries.by_name(name)
+      # Provides iteration over the buffer.
+      #
+      # @param block [Proc]
+      # @return [Enumerator]
+      def each(&block)
+        current.each(&block)
+      end
+
+      # Resets the named view buffer back to its empty state.
+      #
+      # @return [Vedeu::Buffers::View]
+      def reset!
+        Vedeu::Buffers::View.new(attributes)
+      end
+
+      # @param value_or_values [Array<Array<Vedeu::Views::Char>>|
+      #   Vedeu::Views::Char]
+      # @return [Vedeu::Buffers::View]
+      def update(value_or_values)
+        Array(value_or_values).flatten.each do |value|
+          if valid?(value)
+            current[value.position.y][value.position.x] = value
+            dirty << value.position.to_a
+          end
+        end
+
+        self
       end
 
+      protected
+
+      # @!attribute [r] name
+      # @return [String|Symbol]
+      attr_reader :name
+
+      private
+
       # @return [Vedeu::Buffers::Empty]
       def buffer
         @_buffer ||= Vedeu::Buffers::Empty
@@ -25,7 +63,7 @@ module Vedeu
                             width:  geometry.bordered_width).buffer
       end
 
-      # @return [Vedeu::Buffers::Empty]
+      # @return [Array<Vedeu::Models::Cell>]
       def current
         @current ||= buffer
       end
@@ -44,12 +82,45 @@ module Vedeu
 
       # @return [Vedeu::Buffers::Empty]
       def dirty
-        @dirty ||= buffer
+        @dirty ||= []
       end
 
       # @return [Vedeu::Buffers::Empty]
       def dirty_reset!
-        @dirty = buffer
+        @dirty = []
+      end
+
+      # @return [Vedeu::Geometries::Geometry]
+      def geometry
+        @_geometry ||= Vedeu.geometries.by_name(name)
+      end
+
+      # Returns a boolean indicating the value has a position
+      # attribute and is within the terminal boundary.
+      #
+      # @param value [void]
+      # @return [Boolean]
+      def valid?(value)
+        valid_value?(value) && valid_position?(value)
+      end
+
+      # Returns a boolean indicating whether the position of the value
+      # object is valid for this terminal.
+      #
+      # @param value [void]
+      # @return [Boolean]
+      def valid_position?(value)
+        buffer[value.position.y] && buffer[value.position.y][value.position.x]
+      end
+
+      # Returns a boolean indicating the value has a position
+      # attribute.
+      #
+      # @param value [void]
+      # @return [Boolean]
+      def valid_value?(value)
+        value.respond_to?(:position) &&
+          value.position.is_a?(Vedeu::Geometries::Position)
       end
 
     end # View

data/lib/vedeu/cursors/cursor.rb

@@ -214,9 +214,9 @@ module Vedeu
 
       # Return the position of this cursor.
       #
-      # @return [Vedeu::Geometry::Position]
+      # @return [Vedeu::Geometries::Position]
       def position
-        @position = Vedeu::Geometry::Position[y, x]
+        @position = Vedeu::Geometries::Position[y, x]
       end
 
       # Show a named cursor, or without a name, the cursor of the
@@ -255,16 +255,18 @@ module Vedeu
 
       # Returns the geometry for the interface.
       #
-      # @return (see Vedeu::Geometry::Repository#by_name)
+      # @return (see Vedeu::Geometries::Repository#by_name)
       def geometry
         @geometry ||= Vedeu.geometries.by_name(name)
       end
 
       # Determine correct x and y related coordinates.
       #
-      # @return [Vedeu::Geometry::Coordinate]
+      # @return [Vedeu::Geometries::Coordinate]
       def coordinate(offset, type)
-        Vedeu::Geometry::Coordinate.new(name: name, offset: offset, type: type)
+        Vedeu::Geometries::Coordinate.new(name:   name,
+                                          offset: offset,
+                                          type:   type)
       end
 
       # The default values for a new instance of this class.

data/lib/vedeu/cursors/refresh.rb

@@ -78,7 +78,7 @@ module Vedeu
 
       # Fetch the geometry by name.
       #
-      # @return (see Vedeu::Geometry::Repository#by_name)
+      # @return (see Vedeu::Geometries::Repository#by_name)
       def geometry
         @geometry ||= Vedeu.geometries.by_name(name)
       end

data/lib/vedeu/cursors/reposition.rb

@@ -57,9 +57,11 @@ module Vedeu
       #
       # @param offset []
       # @param type []
-      # @return [Vedeu::Geometry::Coordinate]
+      # @return [Vedeu::Geometries::Coordinate]
       def coordinate(offset, type)
-        Vedeu::Geometry::Coordinate.new(name: name, offset: offset, type: type)
+        Vedeu::Geometries::Coordinate.new(name:   name,
+                                          offset: offset,
+                                          type:   type)
       end
 
       # @return [Vedeu::Cursors::Cursor]
@@ -77,7 +79,7 @@ module Vedeu
         }
       end
 
-      # @return [Vedeu::Geometry::Geometry]
+      # @return [Vedeu::Geometries::Geometry]
       def geometry
         Vedeu.geometries.by_name(name)
       end

data/lib/vedeu/cursors/repository.rb

@@ -35,19 +35,17 @@ module Vedeu
 
   end # Cursors
 
-  # @!method cursor
-  #   @see Vedeu::Cursors::Repository.cursor
-  def_delegators Vedeu::Cursors::Repository,
-                 :cursor
-
   # Manipulate the repository of cursors.
   #
   # @example
   #   Vedeu.cursors
   #
   # @!method cursors
-  # @return [Vedeu::Cursors::Repository]
+  #   @return [Vedeu::Cursors::Repository]
+  # @!method cursor
+  #   @see Vedeu::Cursors::Repository.cursor
   def_delegators Vedeu::Cursors::Repository,
+                 :cursor,
                  :cursors
 
 end # Vedeu

data/lib/vedeu/dsl/shared.rb

@@ -57,7 +57,7 @@ module Vedeu
       # @example
       #   Vedeu.interface :my_interface do
       #     geometry do
-      #       # ... see Vedeu::Geometry::DSL for DSL methods for
+      #       # ... see Vedeu::Geometries::DSL for DSL methods for
       #       #     geometries.
       #     end
       #   end
@@ -65,17 +65,17 @@ 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::Geometry::DSL.geometry}.
+      #   {Vedeu::Geometries::DSL.geometry}.
       # @param block [Proc]
       # @raise [Vedeu::Error::RequiresBlock]
-      # @return [Vedeu::Geometry::Geometry]
-      # @see Vedeu::Geometry::DSL
+      # @return [Vedeu::Geometries::Geometry]
+      # @see Vedeu::Geometries::DSL
       def geometry(name = nil, &block)
         fail Vedeu::Error::RequiresBlock unless block_given?
 
         model_name = name ? name : model.name
 
-        Vedeu::Geometry::Geometry.build(name: model_name, &block).store
+        Vedeu::Geometries::Geometry.build(name: model_name, &block).store
       end
 
     end # Shared

data/lib/vedeu/editor/cropper.rb

@@ -106,7 +106,7 @@ module Vedeu
 
       # Returns the border for the interface.
       #
-      # @return (see Vedeu::Geometry::Repository#by_name)
+      # @return (see Vedeu::Geometries::Repository#by_name)
       def geometry
         @geometry ||= Vedeu.geometries.by_name(name)
       end

data/lib/vedeu/editor/cursor.rb

@@ -164,9 +164,9 @@ module Vedeu
 
       # Returns the geometry for the interface.
       #
-      # @return (see Vedeu::Geometry::Repository#by_name)
+      # @return (see Vedeu::Geometries::Repository#by_name)
       def geometry
-        @border ||= Vedeu.geometries.by_name(name)
+        @geometry ||= Vedeu.geometries.by_name(name)
       end
 
       # Returns the default options/attributes for this class.

data/lib/vedeu/editor/item.rb

@@ -32,12 +32,12 @@ module Vedeu
         if index.nil? || index > size
           collection[-1]
 
-        elsif index <= 0
-          collection[0]
-
         elsif index > 0 && index <= size
           collection[index]
 
+        else
+          collection[0]
+
         end
       end
 

data/lib/vedeu/error.rb

@@ -84,7 +84,7 @@ module Vedeu
     # greater than 12. Vedeu is hard-wired to a 12-column layout for
     # the time being.
     #
-    # @see Vedeu::Geometry::Grid
+    # @see Vedeu::Geometries::Grid
     #
     class OutOfRange < StandardError