vedeu 0.8.16 → 0.8.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 805fd2db1418da4e71a147f7e0c3abffe83cbca0
-  data.tar.gz: 5ae3a8f1f58bbce6b6581063d766f8b67cb87925
+  metadata.gz: 428c6ce796c2302c1c1ffdc4fe0e24dbc93bd72d
+  data.tar.gz: f2be6bebebfc68dad88801c1d28100bcd615a7fe
 SHA512:
-  metadata.gz: 8b85555d260e7e07638b1239abb46f97c99929539f8bac9efebe7b4239c72d47bc3941012826595806bf5b195e6a6421a5cd85b20affdc89f443ba68608c69c0
-  data.tar.gz: c8906b96488c8158013fd89a5f5faa4a7f77c8978a199e994f059de9735b341e35d19647c810af8a98a861c745146c46dbcc101543444c96948c17e401a0b326
+  metadata.gz: ea73e52d7a7641e7d201508946bd444f8010c33d43b198ae2a8db66b634beb2f6604eaae721f1123a3fdb7a7580635c677419f6de963eb6c4d4eef366abf14af
+  data.tar.gz: 29571610db40d58fdb32d01ce87719da00ff8f28f5f67bb0776156d9a79a4affe5f3b48ed76b90a0fb7e87e44bfaa4c9ded1194508b6340e2cf8e8b14f5d510e

data/TODO.md

@@ -1,3 +1,11 @@
+## 2016-02-25
+
+- In Vedeu::XCoordinate and Vedeu::YCoordinate, rename #d_dn to
+  #bd_bdn
+- Add new #d_dn to Vedeu::XCoordinate and Vedeu::YCoordinate.
+- Rename all private instance variables used for memoization from
+  '@...' to '@_...'.
+
 ## 2016-01-16
 
 - Add Vedeu::Index which converts a Vedeu::Point to an array index.

data/examples/dsl_alignment.rb

@@ -12,8 +12,11 @@ class AlignmentApp
   Vedeu.configure do
     debug!
     log '/tmp/alignment.log'
-    renderers(Vedeu::Renderers::Terminal.new,
-              Vedeu::Renderers::Text.new(filename: '/tmp/alignment.out'))
+    renderers [
+                Vedeu::Renderers::Terminal.new,
+                # Vedeu::Renderers::Text.new(
+                #   filename: '/tmp/alignment.out'),
+              ]
     run_once!
     standalone!
   end

data/examples/dsl_horizontal_alignment.rb

@@ -51,8 +51,11 @@ class HorizontalAlignmentApp
   Vedeu.configure do
     debug!
     log '/tmp/vedeu_horizontal.log'
-    renderers(Vedeu::Renderers::Terminal.new,
-              Vedeu::Renderers::Text.new(filename: '/tmp/vedeu_horizontal.out'))
+    renderers [
+                Vedeu::Renderers::Terminal.new,
+                # Vedeu::Renderers::Text.new(
+                #   filename: '/tmp/vedeu_horizontal.out'),
+              ]
   end
 
   Vedeu.interface :left_interface do

data/examples/dsl_vertical_alignment.rb

@@ -51,8 +51,11 @@ class VerticalAlignmentApp
   Vedeu.configure do
     debug!
     log '/tmp/vedeu_vertical.log'
-    renderers(Vedeu::Renderers::Terminal.new,
-              Vedeu::Renderers::Text.new(filename: '/tmp/vedeu_vertical.out'))
+    renderers [
+                Vedeu::Renderers::Terminal.new,
+                # Vedeu::Renderers::Text.new(
+                #   filename: '/tmp/vedeu_vertical.out'),
+              ]
   end
 
   Vedeu.interface :top_interface do

data/integrations/test_runner.sh

@@ -1,12 +1,11 @@
 #!/bin/bash
 
+set -euo pipefail
+
 # Notes:
 # At the moment, the terminal must be set to width 135 x height 34 for
 # these tests to pass.
 
-# die on error
-set -e
-
 # change to directory that contains this script
 cd "$(dirname "$0")"
 

data/lib/vedeu.rb

@@ -70,6 +70,36 @@ end # Vedeu
 #     target model to act upon. May default to `Vedeu.focus`.
 #
 # @!macro [new] return_name
-#   @return [NilClass|Symbol|String]
+#   @return [NilClass|Symbol|String] The name of the model, the target
+#     model or the name of the associated model.
+#
+# @!macro [new] border_by_name
+#   Returns the named border from the borders repository.
+#   @return [Vedeu::Borders::Border]
+#
+# @!macro [new] buffer_by_name
+#   Returns the named buffer from the buffer repository.
+#   @return [Vedeu::Buffers::Buffer]
+#
+# @!macro [new] cursor_by_name
+#   Returns the named cursor from the cursors repository.
+#   @return [Vedeu::Cursors::Cursor]
+#
+# @!macro [new] document_by_name
+#   Returns the named document from the documents repository.
+#   @return [Vedeu::Editor::Document]
+#
+# @!macro [new] geometry_by_name
+#   Returns the named geometry from the geometries repository.
+#   @return [Vedeu::Geometries::Geometry]
+
+# @!macro [new] group_by_name
+#   Returns the named group from the groups repository.
+#   @return [Vedeu::Groups::Group]
+#
+# @!macro [new] interface_by_name
+#   Returns the named interface/view from the interfaces repository.
+#   @return [Vedeu::Interfaces::Interface]
+#
 
 require 'vedeu/all'

data/lib/vedeu/borders/all.rb

@@ -33,6 +33,25 @@ module Vedeu
 
   end # Borders
 
+  # :nocov:
+
+  # {include:file:docs/events/by_name/refresh_border.md}
+  Vedeu.bind(:_refresh_border_) do |name|
+    Vedeu::Borders::Refresh.by_name(name) if Vedeu.ready?
+  end
+
+  # See {file:docs/events/by_name/set_border_caption.md}
+  Vedeu.bind(:_set_border_caption_) do |name, caption|
+    Vedeu.borders.by_name(name).caption = caption
+  end
+
+  # See {file:docs/events/by_name/set_border_title.md}
+  Vedeu.bind(:_set_border_title_) do |name, title|
+    Vedeu.borders.by_name(name).title = title
+  end
+
+  # :nocov:
+
 end # Vedeu
 
 require 'vedeu/borders/title'

data/lib/vedeu/borders/border.rb

@@ -107,8 +107,7 @@ module Vedeu
       attr_writer :right_vertical
 
       # @!attribute [r] name
-      # @return [String|Symbol] Associates the border with the
-      #   same-named interface/view.
+      # @macro return_name
       attr_reader :name
 
       # @!attribute [r] parent

data/lib/vedeu/borders/caption.rb

@@ -18,11 +18,13 @@ module Vedeu
       private
 
       # @return [Fixnum]
+      # @see Vedeu::Borders::Title#start_index
       def start_index
         (width - size) - 1
       end
 
       # @return [Fixnum]
+      # @see Vedeu::Borders::Title#y
       def y
         geometry.yn
       end

data/lib/vedeu/borders/refresh.rb

@@ -77,7 +77,7 @@ module Vedeu
       protected
 
       # @!attribute [r] name
-      # @return [String|Symbol]
+      # @macro return_name
       attr_reader :name
 
       private
@@ -91,9 +91,7 @@ module Vedeu
         }
       end
 
-      # Returns the border for the interface.
-      #
-      # @return (see Vedeu::Borders::Repository#by_name)
+      # @macro border_by_name
       def border
         @border ||= Vedeu.borders.by_name(name)
       end
@@ -122,9 +120,7 @@ module Vedeu
         [(bottom_left if left?), captionbar, (bottom_right if right?)].compact
       end
 
-      # Returns the geometry for the interface.
-      #
-      # @return (see Vedeu::Geometries::Repository#by_name)
+      # @macro geometry_by_name
       def geometry
         Vedeu.geometries.by_name(name)
       end
@@ -136,7 +132,7 @@ module Vedeu
       #
       # @return (see Vedeu::Interfaces::Repository#by_name)
       def interface
-        @interface ||= Vedeu.interfaces.by_name(name)
+        @_interface ||= Vedeu.interfaces.by_name(name)
       end
       alias parent interface
 
@@ -218,13 +214,4 @@ module Vedeu
 
   end # Borders
 
-  # :nocov:
-
-  # {include:file:docs/events/by_name/refresh_border.md}
-  Vedeu.bind(:_refresh_border_) do |name|
-    Vedeu::Borders::Refresh.by_name(name) if Vedeu.ready?
-  end
-
-  # :nocov:
-
 end # Vedeu

data/lib/vedeu/borders/repository.rb

@@ -25,18 +25,4 @@ module Vedeu
   def_delegators Vedeu::Borders::Repository,
                  :borders
 
-  # :nocov:
-
-  # See {file:docs/events/by_name/set_border_caption.md}
-  Vedeu.bind(:_set_border_caption_) do |name, caption|
-    Vedeu.borders.by_name(name).caption = caption
-  end
-
-  # See {file:docs/events/by_name/set_border_title.md}
-  Vedeu.bind(:_set_border_title_) do |name, title|
-    Vedeu.borders.by_name(name).title = title
-  end
-
-  # :nocov:
-
 end # Vedeu

data/lib/vedeu/borders/title.rb

@@ -82,7 +82,7 @@ module Vedeu
       attr_reader :horizontal
 
       # @!attribute [r] name
-      # @return [String|Symbol]
+      # @macro return_name
       attr_reader :name
 
       private
@@ -95,7 +95,7 @@ module Vedeu
                                 value:    char)
       end
 
-      # @return [Vedeu::Borders::Border]
+      # @macro border_by_name
       def border
         @_border ||= Vedeu.borders.by_name(name)
       end
@@ -126,7 +126,7 @@ module Vedeu
         start_index + (size - 1)
       end
 
-      # @return [Vedeu::Geometries::Geometry]
+      # @macro geometry_by_name
       def geometry
         @_geometry ||= Vedeu.geometries.by_name(name)
       end
@@ -154,6 +154,10 @@ module Vedeu
         pad.size
       end
 
+      # Provides the index on the horizontal border for where the
+      # title (or caption) should start. The title will appear
+      # top-left, whilst the caption will be justified bottom-right.
+      #
       # @return [Fixnum]
       def start_index
         1
@@ -189,6 +193,8 @@ module Vedeu
         geometry.bx + start_index
       end
 
+      # Return the vertical position for the title (or caption).
+      #
       # @return [Fixnum]
       def y
         geometry.y

data/lib/vedeu/buffers/all.rb

@@ -18,6 +18,31 @@ module Vedeu
 
   end # Buffers
 
+  # :nocov:
+
+  # @see Vedeu::Buffers::Terminal#clear
+  Vedeu.bind(:_clear_) { Vedeu.clear }
+
+  # @see Vedeu::Buffers::Terminal#output
+  Vedeu.bind(:_drb_retrieve_output_) { Vedeu::Buffers::Terminal.output }
+
+  # @see Vedeu::Buffers::Terminal#write
+  Vedeu.bind(:_drb_store_output_) do |data|
+    Vedeu::Buffers::Terminal.write(data)
+  end
+
+  # See {file:docs/events/by_name/refresh_view.md}
+  Vedeu.bind(:_refresh_view_) do |name|
+    Vedeu::Buffers::Refresh.by_name(name) if Vedeu.ready?
+  end
+
+  # See {file:docs/events/by_name/refresh_view_content.md}
+  Vedeu.bind(:_refresh_view_content_) do |name|
+    Vedeu::Buffers::Refresh.refresh_content_by_name(name) if Vedeu.ready?
+  end
+
+  # :nocov:
+
 end # Vedeu
 
 require 'vedeu/buffers/empty'

data/lib/vedeu/buffers/buffer.rb

@@ -33,7 +33,7 @@ module Vedeu
       attr_accessor :previous
 
       # @!attribute [r] name
-      # @return [String|Symbol]
+      # @macro return_name
       attr_reader :name
 
       # Return a new instance of Buffer. Generally a Buffer is
@@ -185,7 +185,7 @@ module Vedeu
         }
       end
 
-      # @return [Vedeu::Interfaces::Interface]
+      # @macro interface_by_name
       def interface
         Vedeu.interfaces.by_name(name)
       end

data/lib/vedeu/buffers/refresh.rb

@@ -50,7 +50,7 @@ module Vedeu
 
       private
 
-      # @return [Vedeu::Buffers::Buffer]
+      # @macro buffer_by_name
       def buffer
         Vedeu.buffers.by_name(name)
       end
@@ -81,18 +81,4 @@ module Vedeu
 
   end # Buffers
 
-  # :nocov:
-
-  # See {file:docs/events/by_name/refresh_view.md}
-  Vedeu.bind(:_refresh_view_) do |name|
-    Vedeu::Buffers::Refresh.by_name(name) if Vedeu.ready?
-  end
-
-  # See {file:docs/events/by_name/refresh_view_content.md}
-  Vedeu.bind(:_refresh_view_content_) do |name|
-    Vedeu::Buffers::Refresh.refresh_content_by_name(name) if Vedeu.ready?
-  end
-
-  # :nocov:
-
 end # Vedeu

data/lib/vedeu/buffers/terminal.rb

@@ -100,19 +100,4 @@ module Vedeu
                  :clear,
                  :refresh
 
-  # :nocov:
-
-  # @see Vedeu::Buffers::Terminal#clear
-  Vedeu.bind(:_clear_) { Vedeu.clear }
-
-  # @see Vedeu::Buffers::Terminal#output
-  Vedeu.bind(:_drb_retrieve_output_) { Vedeu::Buffers::Terminal.output }
-
-  # @see Vedeu::Buffers::Terminal#write
-  Vedeu.bind(:_drb_store_output_) do |data|
-    Vedeu::Buffers::Terminal.write(data)
-  end
-
-  # :nocov:
-
 end # Vedeu

data/lib/vedeu/buffers/view.rb

@@ -58,7 +58,7 @@ module Vedeu
       protected
 
       # @!attribute [r] name
-      # @return [String|Symbol]
+      # @macro return_name
       attr_reader :name
 
       private
@@ -85,7 +85,7 @@ module Vedeu
         }
       end
 
-      # @return [Vedeu::Geometries::Geometry]
+      # @macro geometry_by_name
       def geometry
         @_geometry ||= Vedeu.geometries.by_name(name)
       end

data/lib/vedeu/cells/empty.rb

@@ -18,8 +18,7 @@ module Vedeu
       include Vedeu::Repositories::Defaults
 
       # @!attribute [r] name
-      # @return [String|Symbol] The name of the interface/view this
-      #   cell belongs to.
+      # @macro return_name
       attr_reader :name
 
       # @!attribute [r] value
@@ -99,17 +98,17 @@ module Vedeu
         }
       end
 
-      # @return [Vedeu::Borders::Border]
+      # @macro border_by_name
       def border
         Vedeu.borders.by_name(name)
       end
 
-      # @return [Vedeu::Geometries::Geometry]
+      # @macro geometry_by_name
       def geometry
         Vedeu.geometries.by_name(name)
       end
 
-      # @return [Vedeu::Interfaces::Interface]
+      # @macro interface_by_name
       def interface
         Vedeu.interfaces.by_name(name)
       end