vedeu 0.6.20 → 0.6.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0fbbcdaa8be4572e7426e84959d56e5932e90bba
-  data.tar.gz: 039d7499ad442e6eb675920ef27abb4d8560d9a3
+  metadata.gz: b2bc250678c9728597c333d93e87cc728cbb4767
+  data.tar.gz: 5be52acf963d8b8db5fdc19a478293b836c7edb8
 SHA512:
-  metadata.gz: 8711ec3ecd769c9924fcd0f9da09d18289a32ff86f03b44cc539c2909f54355563f1817e242d106a9e2deb7c5921dc1aea17e138ab444bdb2c86407a74162c80
-  data.tar.gz: e724e09e2aead30c2502c31d5aefd80b9481e9c493250991eb463f6b48940e14fce71a64d7fc4617a747ce5b2f345063c49989af8a1796270ef4a586e2fbec8f
+  metadata.gz: b0210cec1fa8d31b42f9dcb8deb71697e09b2925120274524bcb185da446481dede13465795ef86ebb1b6b5d44d228d36667ac11733ba87d7a6702c9e87b14e8
+  data.tar.gz: 6e9b739f5ee331a20e1df15c4e97880313f9491067edc82d487c553757eafd134bc14861c9ecf5a384ed314d79253e62b3ec07dcb2db16e0dcbabb2235a62ed3

data/.yardopts

@@ -1,6 +1,6 @@
 --private
 --protected
---embed-mixin ClassMethods
+--embed-mixins
 -
 docs/api.md
 docs/configuration.md

data/README.md

@@ -74,6 +74,10 @@ Any branch on the repository that is not `master` is probably experimental; do
  into `master` before a release, and branches prefixed with `spike/` are me
  playing with ideas.
 
+I may have left some TODO items lying around, which you can find with:
+
+    yard list --query '@todo'
+
 ### General contribution help
 
 1. Fork it ([https://github.com/gavinlaking/vedeu/fork](https://github.com/gavinlaking/vedeu/fork))

data/Rakefile

@@ -16,11 +16,24 @@ YARD::Rake::YardocTask.new(:yard) do |task|
     'lib/**/*.rb',
     '-',
     'docs/api.md',
+    'docs/configuration.md',
     'docs/dsl.md',
     'docs/events.md',
     'docs/getting_started.md',
     'docs/object_graph.md',
+    'docs/events/application.md',
+    'docs/events/document.md',
+    'docs/events/drb.md',
+    'docs/events/focus.md',
+    'docs/events/menu.md',
+    'docs/events/movement.md',
+    'docs/events/refresh.md',
+    'docs/events/system.md',
+    'docs/events/view.md',
+    'docs/events/visibility.md',
   ]
+  task.options = ['--highlight']
+  task.stats_options = ['--list-undoc']
 end
 
 RuboCop::RakeTask.new(:rubocop) do |task|

data/bin/vedeu_drb_server

@@ -42,7 +42,7 @@ class VedeuTestApplication
 
   Vedeu.bind(:_initialize_) { Vedeu.trigger(:_refresh_) }
 
-  Vedeu.border 'test_interface' do
+  Vedeu.border :test_interface do
     # Define colour and style of border
     colour foreground: '#ffff00', background: '#0000ff'
     style  'normal'
@@ -62,7 +62,7 @@ class VedeuTestApplication
     vertical     '|'
   end
 
-  Vedeu.geometry 'test_interface' do
+  Vedeu.geometry :test_interface do
     # centred!
     height 6
     width  26
@@ -70,24 +70,24 @@ class VedeuTestApplication
     y      4
   end
 
-  Vedeu.interface 'test_interface' do
+  Vedeu.interface :test_interface do
     colour foreground: '#ff0000', background: '#000000'
     cursor!
   end
 
-  Vedeu.keymap 'test_interface' do
+  Vedeu.keymap :test_interface do
     key(:up,    'k') { Vedeu.trigger(:_cursor_up_)    }
     key(:right, 'l') { Vedeu.trigger(:_cursor_right_) }
     key(:down,  'j') { Vedeu.trigger(:_cursor_down_)  }
     key(:left,  'h') { Vedeu.trigger(:_cursor_left_)  }
   end
 
-  Vedeu.menu 'test_interface' do
+  Vedeu.menu :test_interface do
     # ...
   end
 
   Vedeu.renders do
-    view 'test_interface' do
+    view :test_interface do
       lines do
         line 'a1b1c1d1e1f1g1h1i1j1k1l1m1n1o1p1q1r1s1t1u1v1w1x1y1z1'
         line 'a2b2c2d2e2f2g2h2i2j2k2l2m2n2o2p2q2r2s2t2u2v2w2x2y2z2'

data/docs/api.md

@@ -14,6 +14,20 @@ applications. Below is a list of all the API methods:
       # ...
     end
 
+Most of Vedeu's core functionality comes from its API methods, these
+methods are used in a variety of ways, sometimes in combination:
+
+    # with parameters
+    Vedeu.method_name(*params)
+
+    # with a block
+    Vedeu.method_name(*params) do
+      # ...
+    end
+
+    # with other methods
+    Vedeu.method_name.other_method
+
 ## Configuration
 
 See {file:docs/configuration.md}

data/docs/dsl.md

@@ -7,10 +7,10 @@ your application whilst using Vedeu.
 
 ## Interfaces
 
-An Interface is a basic element in the GUI. It usually but does not
-necessarily correspond to a region of the terminal screen (for
-example, an Interface might not be displayed at certain points in an
-application life cycle).
+An Interface is a basic element in the GUI. You can think of it as a
+container for a portion of the terminal screen. Interfaces can be set
+to be show or hidden, and combined into groups to form the different
+'screens' of your application.
 
 Much of the behavior of an Interface comes from child objects that
 are defined under the Interface. These objects are described in more
@@ -19,13 +19,13 @@ detail in their respective sections below.
 Here is an example of declarations for an `interface` block:
 
 ```ruby
-interface 'main' do
+interface :main do
   visible true # whether to show the interface
   focus! # focus this interface
   cursor true # Show the cursor when this section is focused
   colour foreground: '#ffffff', # set interface foreground
          background: '#000033'  # and background colors
-  group 'general' # set interface group
+  group :general # set interface group
 
   geometry do
     # size and position details
@@ -36,12 +36,12 @@ interface 'main' do
   keymap do
     # keymap that is in effect when this interface is focused
   end
-  views do
-    # details about how to render the interface
-  end
 end
 ```
 
+The content for an interface is handled by a 'view'. More details on
+these can be found here: {file:docs/dsl.md#Views Views}
+
 ### Declaring interface sub-objects
 
 Every object in the DSL besides interface itself is defined for a
@@ -53,7 +53,7 @@ That is, these are equivalent ways to declare a Geometry for an
 existing interface
 
 ```ruby
-interface 'main' do
+interface :main do
   geometry do
     # some geometry
   end
@@ -65,11 +65,11 @@ end
 or you can say
 
 ```ruby
-interface 'main' do
+interface :main do
   # some other declarations
 end
 
-geometry 'main' do
+geometry :main do
   # some geometry
 end
 ```

data/docs/events/document.md

@@ -2,6 +2,8 @@
 
 ## Document Events
 
+Note: 'name' is a Symbol unless mentioned otherwise.
+
 ### :_editor_execute_
 
     Vedeu.trigger(:_editor_execute_, name)
@@ -28,6 +30,8 @@ line in the named document.
 This event attempts to insert the given character in the named
 document at the current virtual cursor position.
 
+Note: 'character' is a string.
+
     Vedeu.trigger(:_editor_insert_character_, name, character)
 
 ### :_editor_insert_line_
@@ -42,14 +46,12 @@ character in the named document.
 
     Vedeu.trigger(:_editor_left_, name)
 
-
 ### :_editor_right_
 This event attempts to move the virtual cursor right by one
 character in the named document.
 
     Vedeu.trigger(:_editor_right_, name)
 
-
 ### :_editor_up_
 This event attempts to move the virtual cursor up by one line
 in the named document.

data/docs/events/drb.md

@@ -6,6 +6,8 @@
 Triggering this event will send input to the running application as
 long as it has the DRb server running.
 
+Note: See {Vedeu::Distributed::Server#input} for parameter details.
+
     Vedeu.trigger(:_drb_input_, data, type)
 
 ### :_drb_retrieve_output_
@@ -16,6 +18,8 @@ long as it has the DRb server running.
 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)
 
 ### :_drb_restart_

data/docs/events/focus.md

@@ -2,6 +2,8 @@
 
 ## Focus Events
 
+Note: 'name' is a Symbol unless mentioned otherwise.
+
 ### :_focus_by_name_
 When triggered with an interface name will focus that interface and
 restore the cursor position and visibility.

data/docs/events/menu.md

@@ -2,6 +2,8 @@
 
 ## Menu Events
 
+Note: 'name' is a Symbol unless mentioned otherwise.
+
 ### :_menu_bottom_
 Makes the last menu item the current menu item.
 

data/docs/events/movement.md

@@ -2,6 +2,8 @@
 
 ## Movement Events
 
+Note: 'name' is a Symbol unless mentioned otherwise.
+
 ### :_cursor_origin_
 This event moves the cursor to the interface origin; the top left
 corner of the named interface.
@@ -25,7 +27,7 @@ Adjusts the position of the cursor or view.
 When a name is not given, the cursor in the interface which is
 currently in focus should move in the direction specified.
 
-    Vedeu.trigger(:_cursor_left_, 'my_interface')
+    Vedeu.trigger(:_cursor_left_, name)
     Vedeu.trigger(:_cursor_left_)
     Vedeu.trigger(:_cursor_right_)
     Vedeu.trigger(:_cursor_up_)
@@ -49,9 +51,9 @@ See {file:docs/events.md#\_cursor__up_down_left_right_}
 
 Please note that the name of the view is required for these events.
 
-    Vedeu.trigger(:_view_down_,  'my_interface')
-    Vedeu.trigger(:_view_left_,  'my_interface')
-    Vedeu.trigger(:_view_right_, 'my_interface')
-    Vedeu.trigger(:_view_up_,    'my_interface')
+    Vedeu.trigger(:_view_down_, name)
+    Vedeu.trigger(:_view_left_, name)
+    Vedeu.trigger(:_view_right_, name)
+    Vedeu.trigger(:_view_up_, name)
 
 Each of the :_view_* events has an alias, :_geometry_* if you prefer.

data/docs/events/refresh.md

@@ -2,6 +2,8 @@
 
 ## Refresh Events
 
+Note: 'name' is a Symbol unless mentioned otherwise.
+
 ### :_refresh_
 Refreshes all registered interfaces.
 

data/docs/events/system.md

@@ -21,6 +21,9 @@ This event is called by {Vedeu::Input::Capture#read}. When
 invoked, the key will be passed to the editor for currently
 focussed view.
 
+Note: 'key' is a String for alphanumeric keys and special keys are
+represented by Symbols.
+
     Vedeu.trigger(:_editor_, key)
 
 ### :_exit_
@@ -51,6 +54,8 @@ can be found here: {Vedeu::Input::Capture}.
 When triggered with a message will cause Vedeu to log the message if
 logging is enabled in the configuration.
 
+Note: 'message' is a String.
+
     Vedeu.trigger(:_log_, message)
 
 ### :_mode_switch_

data/docs/events/view.md

@@ -2,6 +2,8 @@
 
 ## View Events
 
+Note: 'name' is a Symbol unless mentioned otherwise.
+
 ### :_maximise_
 Maximising an interface.
 

data/docs/events/visibility.md

@@ -2,6 +2,8 @@
 
 ## Visibility Events
 
+Note: 'name' is a Symbol unless mentioned otherwise.
+
 ### :_clear_
 Clears the whole terminal space.
 

data/lib/vedeu.rb

@@ -15,8 +15,6 @@ require 'zlib'
 
 require 'thor'
 
-require 'vedeu/logging/log'
-
 # Vedeu is a GUI framework for terminal/console applications written
 # in Ruby.
 #
@@ -25,8 +23,6 @@ module Vedeu
   extend Forwardable
   extend self
 
-  def_delegators Vedeu::Logging::Log, :log
-
   # Return the name of currently focussed interface.
   #
   # @return [Vedeu::Models::Focus]
@@ -34,25 +30,6 @@ module Vedeu
     @focusable ||= Vedeu::Models::Focus
   end
 
-  # :nocov:
-  # When Vedeu is included within one of your classes, you should have
-  # all API methods at your disposal.
-  #
-  # @example
-  #   class YourClassHere
-  #     include Vedeu
-  #
-  #     # ...
-  #   end
-  #
-  # @param receiver [void]
-  # @return [void]
-  def included(receiver)
-    receiver.send(:include, Vedeu::API::External)
-    receiver.extend(Vedeu::API::External)
-  end
-  # :nocov:
-
 end # Vedeu
 
 require 'vedeu/all'

data/lib/vedeu/all.rb

@@ -1,3 +1,4 @@
+require 'vedeu/logging/all'
 require 'vedeu/version'
 require 'vedeu/options'
 
@@ -14,16 +15,14 @@ require 'vedeu/repositories/all'
 
 require 'vedeu/models/toggleable'
 
-require 'vedeu/output/presentation/presentation'
 require 'vedeu/output/direct'
-
 require 'vedeu/output/clear/all'
-
 require 'vedeu/output/compressor'
 require 'vedeu/output/text'
 require 'vedeu/output/output'
 require 'vedeu/output/viewport'
 require 'vedeu/output/wordwrap'
+require 'vedeu/output/presentation/all'
 require 'vedeu/output/refresh/refresh'
 require 'vedeu/output/renderers/all'
 
@@ -46,6 +45,5 @@ require 'vedeu/input/all'
 require 'vedeu/menus/all'
 require 'vedeu/templating/all'
 
-require 'vedeu/api/all'
 require 'vedeu/bindings/all'
 require 'vedeu/plugins/all'

data/lib/vedeu/application/application_view.rb

@@ -10,7 +10,7 @@ module Vedeu
 
     # Renders the view.
     #
-    # @param params [Hash]
+    # @param (see #initialize)
     # @return [void]
     def self.render(**params)
       new(params).render

data/lib/vedeu/borders/all.rb

@@ -8,20 +8,20 @@ module Vedeu
   #
   # @example
   #   # Borders can be defined when defining your interface...
-  #   Vedeu.interface 'my_interface' do
+  #   Vedeu.interface :my_interface do
   #     border do
   #     # ...
   #   end
   #
   #   # ...or as part of a view definition...
   #   Vedeu.renders do
-  #     view 'border_demo' do
+  #     view :border_demo do
   #       border do
   #       # ...
   #     end
   #
   #   # ...or standalone; referencing the target interface or view.
-  #   Vedeu.border 'some_interface' do
+  #   Vedeu.border :some_interface do
   #     # ...
   #   end
   #