vedeu 0.6.4 → 0.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db7557217b4f94e3fcfea2f541421306550f35a4
-  data.tar.gz: 2a8dbc1907f3c2b48b9f24ee342d974686949ef3
+  metadata.gz: fcd82ad8c943b3b1555c4b4019b6945bea88b4fd
+  data.tar.gz: efe4918ea1f85cca3528dae2098c1bc108786638
 SHA512:
-  metadata.gz: be86100e63189b39cbdb342ab8799e67f03a58b0b62f92fd165d4a70dcc3306da0639536cbc7cf8985dd63b699082a52d4f2021a13fa41f54658c0c1f9086b37
-  data.tar.gz: 3b7f9ea1aec43791928f0afbd3fac58f91f7cd2d269dca02f3d5e2f7b80bda87de406090d2a8c90c71513aa2957da88a9ab99be33e71ad8efe5fd8330dadedb9
+  metadata.gz: aea1f3d343da09c7250f6b7e879e046ff05f1ac3be9a8f0afc4f18b15ccf49f296de0530e697a4a03cbbfad33085d55853fd19b2df397bf8a749cc12b8aea89d
+  data.tar.gz: 1cffa670f4d1c02ccc95ab5784653d22aaad3135f94b5ad9dd54123d6e515bbd34aeb826f3681b060e33bef39768caac6884449700cb8a68a3fd7c98ea203277

data/.codeclimate.yml

@@ -0,0 +1,40 @@
+# This is a sample .codeclimate.yml configured for Engine analysis on Code
+# Climate Platform. For an overview of the Code Climate Platform, see here:
+# http://docs.codeclimate.com/article/300-the-codeclimate-platform
+
+# Under the engines key, you can configure which engines will analyze your repo.
+# Each key is an engine name. For each value, you need to specify enabled: true
+# to enable the engine as well as any other engines-specific configuration.
+
+# For more details, see here:
+# http://docs.codeclimate.com/article/289-configuring-your-repository-via-codeclimate-yml#platform
+
+# For a list of all available engines, see here:
+# http://docs.codeclimate.com/article/296-engines-available-engines
+languages:
+  Ruby: true
+
+engines:
+# to turn on an engine, add it here and set enabled to `true`
+# to turn off an engine, set enabled to `false` or remove it
+  rubocop:
+    enabled: true
+
+# Engines can analyze files and report issues on them, but you can separately
+# decide which files will receive ratings based on those issues. This is
+# specified by path patterns under the ratings key.
+
+# For more details see here:
+# http://docs.codeclimate.com/article/289-configuring-your-repository-via-codeclimate-yml#platform
+
+ratings:
+  paths:
+  - lib/**
+
+# You can globally exclude files from being analyzed by any engine using the
+# exclude_paths key.
+
+exclude_paths:
+- examples/**/*
+- test/**/*
+- vendor/**/*

data/README.md

@@ -1,5 +1,6 @@
 [![Code Climate](https://codeclimate.com/github/gavinlaking/vedeu.png)](https://codeclimate.com/github/gavinlaking/vedeu)
 [![Build Status](https://travis-ci.org/gavinlaking/vedeu.svg?branch=master)](https://travis-ci.org/gavinlaking/vedeu)
+[![Test Coverage](https://codeclimate.com/github/gavinlaking/vedeu/badges/coverage.svg)](https://codeclimate.com/github/gavinlaking/vedeu/coverage)
 
 # Vedeu
 

data/docs/dsl.md

@@ -75,48 +75,48 @@ end
 
 ## Borders
 
-{include:Vedeu::DSL::Border}
+{include:Vedeu::Borders::DSL}
 
 ### Setting a title for the border
 
-{include:Vedeu::DSL::Border#title}
+{include:Vedeu::Borders::DSL#title}
 
 ### Customising the appearance of the border
 
-{include:Vedeu::DSL::Border#bottom_left}
-{include:Vedeu::DSL::Border#bottom_right}
-{include:Vedeu::DSL::Border#horizontal}
-{include:Vedeu::DSL::Border#top_left}
-{include:Vedeu::DSL::Border#top_right}
-{include:Vedeu::DSL::Border#vertical}
+{include:Vedeu::Borders::DSL#bottom_left}
+{include:Vedeu::Borders::DSL#bottom_right}
+{include:Vedeu::Borders::DSL#horizontal}
+{include:Vedeu::Borders::DSL#top_left}
+{include:Vedeu::Borders::DSL#top_right}
+{include:Vedeu::Borders::DSL#vertical}
 
 ### Enabling/disabling the border
 
-{include:Vedeu::DSL::Border#enable!}
-{include:Vedeu::DSL::Border#disable!}
+{include:Vedeu::Borders::DSL#enable!}
+{include:Vedeu::Borders::DSL#disable!}
 
 ### Enabling/disabling an aspect of the border
 
-{include:Vedeu::DSL::Border#bottom}
-{include:Vedeu::DSL::Border#left}
-{include:Vedeu::DSL::Border#right}
-{include:Vedeu::DSL::Border#top}
+{include:Vedeu::Borders::DSL#bottom}
+{include:Vedeu::Borders::DSL#left}
+{include:Vedeu::Borders::DSL#right}
+{include:Vedeu::Borders::DSL#top}
 
 ## Geometry
 
-{include:Vedeu::DSL::Geometry}
+{include:Vedeu::Geometry::DSL}
 
 ### Setting the interface dimensions
 
-{include:Vedeu::DSL::Geometry#centred}
-{include:Vedeu::DSL::Geometry#height}
-{include:Vedeu::DSL::Geometry#width}
-{include:Vedeu::DSL::Geometry#columns}
-{include:Vedeu::DSL::Geometry#rows}
-{include:Vedeu::DSL::Geometry#x}
-{include:Vedeu::DSL::Geometry#xn}
-{include:Vedeu::DSL::Geometry#y}
-{include:Vedeu::DSL::Geometry#yn}
+{include:Vedeu::Geometry::DSL#centred}
+{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}
 
 ## Groups
 

data/lib/vedeu/all.rb

@@ -1,7 +1,9 @@
 require 'vedeu/version'
+require 'vedeu/options'
+
 require 'vedeu/runtime/launcher'
 require 'vedeu/runtime/bootstrap'
-require 'vedeu/exceptions'
+require 'vedeu/error'
 require 'vedeu/log/lockless_log_device'
 require 'vedeu/log/mono_logger'
 require 'vedeu/log/log'
@@ -23,8 +25,6 @@ require 'vedeu/runtime/main_loop'
 require 'vedeu/runtime/flags'
 require 'vedeu/runtime/application'
 
-require 'vedeu/models/toggleable'
-
 require 'vedeu/repositories/collection'
 require 'vedeu/input/keys'
 require 'vedeu/repositories/repositories'
@@ -35,56 +35,22 @@ require 'vedeu/repositories/registerable'
 require 'vedeu/repositories/repository'
 
 require 'vedeu/null/null'
-require 'vedeu/null/border'
-require 'vedeu/null/buffer'
 require 'vedeu/null/generic'
-require 'vedeu/null/geometry'
 require 'vedeu/null/interface'
 require 'vedeu/null/menu'
 require 'vedeu/null/view'
 
-require 'vedeu/geometry/area'
-require 'vedeu/geometry/generic_coordinate'
-require 'vedeu/geometry/coordinate'
-require 'vedeu/geometry/dimension'
-require 'vedeu/geometry/geometry'
-require 'vedeu/geometry/geometries'
-require 'vedeu/geometry/grid'
-require 'vedeu/geometry/position'
-
-require 'vedeu/colours/all'
-
-require 'vedeu/buffers/buffer'
-require 'vedeu/buffers/buffers'
-require 'vedeu/buffers/virtual_buffer'
-require 'vedeu/buffers/virtual_buffers'
-
 require 'vedeu/refresh/refresh'
-require 'vedeu/refresh/refresh_cursor'
 require 'vedeu/refresh/refresh_buffer'
 require 'vedeu/refresh/refresh_group'
 
-require 'vedeu/cursor/cursor'
-require 'vedeu/cursor/cursors'
-require 'vedeu/cursor/move'
-require 'vedeu/cursor/reposition'
+require 'vedeu/models/toggleable'
 
 require 'vedeu/esc/actions'
 require 'vedeu/esc/borders'
 require 'vedeu/esc/colours'
 require 'vedeu/esc/esc'
 
-require 'vedeu/output/renderers/renderer_options'
-require 'vedeu/output/renderers/escape_sequence'
-require 'vedeu/output/renderers/file'
-require 'vedeu/output/renderers/html'
-require 'vedeu/output/renderers/json'
-require 'vedeu/output/renderers/null'
-require 'vedeu/output/renderers/terminal'
-require 'vedeu/output/renderers/text'
-require 'vedeu/output/renderers'
-
-require 'vedeu/events/all'
 require 'vedeu/models/views/all'
 
 require 'vedeu/models/cell'
@@ -94,6 +60,8 @@ require 'vedeu/models/group'
 require 'vedeu/models/groups'
 require 'vedeu/models/menu'
 require 'vedeu/models/menus'
+require 'vedeu/models/row'
+require 'vedeu/models/page'
 
 require 'vedeu/templating/all'
 require 'vedeu/templating/encoder'
@@ -119,9 +87,7 @@ require 'vedeu/dsl/dsl'
 require 'vedeu/dsl/shared'
 require 'vedeu/dsl/use'
 require 'vedeu/dsl/presentation'
-require 'vedeu/dsl/border'
 require 'vedeu/dsl/composition'
-require 'vedeu/dsl/geometry'
 require 'vedeu/dsl/group'
 require 'vedeu/dsl/keymap'
 require 'vedeu/dsl/text'
@@ -139,9 +105,12 @@ require 'vedeu/input/keymap'
 require 'vedeu/input/keymaps'
 require 'vedeu/input/editor/all'
 
-require 'vedeu/borders/render_border'
-require 'vedeu/borders/border'
-require 'vedeu/borders/borders'
+require 'vedeu/borders/all'
+require 'vedeu/buffers/all'
+require 'vedeu/colours/all'
+require 'vedeu/cursors/all'
+require 'vedeu/events/all'
+require 'vedeu/geometry/all'
 
 require 'vedeu/output/direct'
 require 'vedeu/output/clear/named_group'
@@ -151,10 +120,18 @@ require 'vedeu/output/compressor'
 require 'vedeu/output/style'
 require 'vedeu/output/text'
 require 'vedeu/output/html_char'
-
 require 'vedeu/output/output'
 require 'vedeu/output/viewport'
 require 'vedeu/output/wordwrap'
+require 'vedeu/output/renderers/renderer_options'
+require 'vedeu/output/renderers/escape_sequence'
+require 'vedeu/output/renderers/file'
+require 'vedeu/output/renderers/html'
+require 'vedeu/output/renderers/json'
+require 'vedeu/output/renderers/null'
+require 'vedeu/output/renderers/terminal'
+require 'vedeu/output/renderers/text'
+require 'vedeu/output/renderers'
 
 require 'vedeu/api'
 require 'vedeu/internal_api'

data/lib/vedeu/api.rb

@@ -34,8 +34,8 @@ module Vedeu
     #   Vedeu.cursor
     #
     # @!method cursor
-    # @return [Vedeu::Cursor]
-    def_delegators Vedeu::Cursors, :cursor
+    # @return [Vedeu::Cursors::Cursor]
+    def_delegators Vedeu::Cursors::Repository, :cursor
 
     # Manipulate the DRb server implementation.
     #
@@ -60,15 +60,15 @@ module Vedeu
     #   Vedeu.border
     #
     # @!method border
-    #   @see Vedeu::DSL::Border.border
-    def_delegators Vedeu::DSL::Border, :border
+    #   @see Vedeu::Borders::DSL.border
+    def_delegators Vedeu::Borders::DSL, :border
 
     # @example
     #   Vedeu.geometry
     #
     # @!method geometry
-    #   @see Vedeu::DSL::Geometry.geometry
-    def_delegators Vedeu::DSL::Geometry, :geometry
+    #   @see Vedeu::Geometry::DSL.geometry
+    def_delegators Vedeu::Geometry::DSL, :geometry
 
     # @example
     #   Vedeu.group
@@ -250,8 +250,8 @@ module Vedeu
     #   Vedeu.hide_cursor(name)
     #
     # @!method hide_cursor
-    #   @see Vedeu::Cursor#hide
-    def_delegators Vedeu::Cursor, :hide_cursor
+    #   @see Vedeu::Cursors::Cursor#hide
+    def_delegators Vedeu::Cursors::Cursor, :hide_cursor
 
     # Shows the cursor for the interface of the given name.
     #
@@ -259,8 +259,8 @@ module Vedeu
     #   Vedeu.show_cursor(name)
     #
     # @!method show_cursor
-    #   @see Vedeu::Cursor#show
-    def_delegators Vedeu::Cursor, :show_cursor
+    #   @see Vedeu::Cursors::Cursor#show
+    def_delegators Vedeu::Cursors::Cursor, :show_cursor
 
     # Toggle the visibility of the cursor with the given name.
     #
@@ -268,9 +268,9 @@ module Vedeu
     #   Vedeu.toggle_cursor(name)
     #
     # @!method toggle_cursor
-    #   @see Vedeu::Cursor#hide
-    #   @see Vedeu::Cursor#show
-    def_delegators Vedeu::Cursor, :toggle_cursor
+    #   @see Vedeu::Cursors::Cursor#hide
+    #   @see Vedeu::Cursors::Cursor#show
+    def_delegators Vedeu::Cursors::Cursor, :toggle_cursor
 
     # @!method hide_group
     #   @see Vedeu::Group#hide

data/lib/vedeu/application/application_controller.rb

@@ -8,6 +8,8 @@ module Vedeu
 
     include Vedeu::Controller
 
+    # Returns an instance of Vedeu::ApplicationController.
+    #
     # @param params [Hash] The named parameters provided to the controller which
     #   will be used by the actions within the controller.
     # @return [Vedeu::ApplicationController]

data/lib/vedeu/bindings/movement.rb

@@ -21,32 +21,63 @@ module Vedeu
 
       private
 
-      # Move the cursor/view down, left, right or up by one character.
+      # Adjusts the position of the cursor or view.
       #
       # @example
-      #   Vedeu.trigger(:_cursor_down_, name)
-      #   Vedeu.trigger(:_view_down_, name)
-      #   Vedeu.trigger(:_geometry_down_, name)
-      #   Vedeu.trigger(:_cursor_left_, name)
-      #   Vedeu.trigger(:_view_left_, name)
-      #   Vedeu.trigger(:_geometry_left_, name)
-      #   Vedeu.trigger(:_cursor_right_, name)
-      #   Vedeu.trigger(:_view_right_, name)
-      #   Vedeu.trigger(:_geometry_right_, name)
-      #   Vedeu.trigger(:_cursor_up_, name)
-      #   Vedeu.trigger(:_view_up_, name)
-      #   Vedeu.trigger(:_geometry_up_, name)
+      #   Vedeu.trigger(:_cursor_down_)
+      #
+      #   Vedeu.trigger(:_cursor_left_) # When a name is not given, the cursor
+      #                                 # in the interface which is currently in
+      #                                 # focus should move to the left.
+      #
+      #   Vedeu.trigger(:_cursor_left_, 'my_interface')
+      #                                 # When a name is given, the cursor
+      #                                 # instance belonging to this interface
+      #                                 # moves to the left.
+      #
+      #   Vedeu.trigger(:_cursor_right_)
+      #   Vedeu.trigger(:_cursor_up_)
+      #
+      #   Vedeu.trigger(:_cursor_origin_)                 # /or/
+      #   Vedeu.trigger(:_cursor_origin_, 'my_interface')
+      #                                 # Moves the cursor to the top left of
+      #                                 # the named or current interface in
+      #                                 # focus.
+      #
+      #   Vedeu.trigger(:_view_down_,  'my_interface')
+      #   Vedeu.trigger(:_view_left_,  'my_interface')
+      #   Vedeu.trigger(:_view_right_, 'my_interface')
+      #   Vedeu.trigger(:_view_up_,    'my_interface')
+      #
+      #   Each of the :_view_* events has an alias, :_geometry_*
+      #
+      # @note
+      #   The cursor or view may not be visible, but it will still move if
+      #     requested.
+      #   The cursor will not exceed the border or boundary of the interface, or
+      #     boundary of the visible terminal.
+      #   The cursor will move freely within the bounds of the interface,
+      #     irrespective of content.
+      #   The view will not exceed the boundary of the visible terminal.
+      #   The view will move freely within the bounds of the interface,
+      #     irrespective of content.
       #
       # @return [TrueClass]
-      # @see Vedeu::Move
       def directional!
         [:down, :left, :right, :up].each do |direction|
           Vedeu.bind("_cursor_#{direction}_".to_sym) do |name|
-            Vedeu::Move.send(direction, Vedeu::Cursor, name)
+            Vedeu.cursors.by_name(name).send("move_#{direction}")
+
+            Vedeu.trigger(:_refresh_cursor_, name)
           end
 
           Vedeu.bind("_view_#{direction}_".to_sym) do |name|
-            Vedeu::Move.send(direction, Vedeu::Geometry, name)
+            Vedeu.geometries.by_name(name).send("move_#{direction}")
+
+            Vedeu.trigger(:_clear_)
+            Vedeu.trigger(:_refresh_)
+            Vedeu.trigger(:_clear_, name)
+            Vedeu.trigger(:_refresh_, name)
           end
 
           Vedeu.bind_alias("_geometry_#{direction}_".to_sym,
@@ -65,7 +96,7 @@ module Vedeu
       # @see Vedeu::Move
       def cursor_origin!
         Vedeu.bind(:_cursor_origin_) do |name|
-          Vedeu::Move.origin(Vedeu::Cursor, name)
+          Vedeu::Move.origin(Vedeu::Cursors::Cursor, name)
         end
 
         Vedeu.bind_alias(:_cursor_reset_, :_cursor_origin_)
@@ -95,7 +126,11 @@ module Vedeu
       # @see Vedeu::Move
       def cursor_reposition!
         Vedeu.bind(:_cursor_reposition_) do |name, y, x|
-          Vedeu::Reposition.to(Vedeu::Cursor, name, y, x)
+          Vedeu.cursors.by_name(name).reposition(y, x)
+
+          Vedeu.trigger(:_clear_, name)
+          Vedeu.trigger(:_refresh_, name)
+          Vedeu.trigger(:_refresh_cursor_, name)
         end
       end
 

data/lib/vedeu/bindings/refresh.rb

@@ -49,7 +49,7 @@ module Vedeu
       # @return [TrueClass]
       def refresh_cursor!
         Vedeu.bind(:_refresh_cursor_) do |name|
-          Vedeu::RefreshCursor.by_name(name)
+          Vedeu::Cursors::Refresh.by_name(name)
         end
       end