vedeu 0.4.32 → 0.4.33

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2db54587f464686863ae7a86653c4e690522f778
-  data.tar.gz: 8d0f17548d624a09022312fd9704632090a73b4a
+  metadata.gz: b62c5ba6eef01e883bf71b71a52223214dcffa48
+  data.tar.gz: 6217942929014ce27de055b78a2e533a56bb638d
 SHA512:
-  metadata.gz: 5a817ae692b688d3a6f67b70c3f88a2fc2775c2b754fa227e5e7b0610705c4c52a266a631fe4efc169b9c26867141cbf48a1ca2e73acbe3d1a047b451dfa75f2
-  data.tar.gz: 5a2423e352bc179911a180df68addaf8b194786dff67ebece988897e4756d5386c71fb8dc97281b47c92665058daeee8d5476ee7445a8e59ed28fa5d1108d23f
+  metadata.gz: 8b40fb9d5ee9ffc2660ebd062a12f2eb64903330b5f80f50daf4133c9adec364caa31cb31140981ac9a0de585d065d472208e33cb85363c235ef2720ac4101b2
+  data.tar.gz: e6cdfbc8f776b1ad7f5f611dadf8cc7bce21f8ec0375650f7995dc9e1070922e755e7e6143230f6bb1a2ca426c23595ba4046513ccc4ac710d22331eb9e736ef

data/bin/vedeu

@@ -3,6 +3,9 @@
 lib_dir = File.dirname(__FILE__) + '/../lib'
 $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 
+require 'vedeu/version'
+
+puts "Vedeu (#{Vedeu::VERSION})"
 puts ''
 puts 'Vedeu is a Ruby gem. This executable serves for a future in which ' \
      'Vedeu can generate a starting point for your terminal-based GUI '   \

data/docs/dsl.md

@@ -13,8 +13,42 @@ Borders are defined by name for each of the client application's interfaces or
 
 ### Geometry
 
-Geometry is defined by name and allows the configuration of the position and
- size of an interface.
+Geometry allows the configuration of the position and size of an interface.
+
+Here is an example of declarations for a `geometry` block:
+
+ ```ruby
+interface 'main' do
+  geometry do
+    height 5 # Sets the height of the view to 5
+    width 20 # Sets the width of the view to 20
+    x 3 # Start drawing 3 spaces from left
+    y 10 # Start drawing 10 spaces from top
+    xn 30 # Stop drawing 30 spaces from the left
+    yn 20 # Stop drawing 20 spaces from top
+  end
+end
+```
+
+If a declaration is omitted for `height` or `width` the full remaining space
+available in the terminal will be used. `x` and `y` both default to 0.
+
+You can also make a geometry declaration dependent on another view:
+
+ ```ruby
+interface 'other_panel' do
+  # other code ...
+end
+
+interface 'main' do
+  geometry do
+    height 10
+    y { use('other_panel').south }
+  end
+end
+```
+
+This view will begin just below "other\_panel".
 
 ### Groups
 

data/examples/borders_app.rb

@@ -6,6 +6,11 @@ $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 require 'vedeu'
 
 # An example application to demonstrate borders.
+#
+# If you have cloned this repository from GitHub, you can run this example:
+#
+#     ./examples/borders_app.rb
+#
 class VedeuBordersApp
 
   include Vedeu

data/examples/colours_app.rb

@@ -6,6 +6,11 @@ $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 require 'vedeu'
 
 # An example application to demonstrate colours.
+#
+# If you have cloned this repository from GitHub, you can run this example:
+#
+#     ./examples/colours_app.rb
+#
 class VedeuColoursApp
 
   include Vedeu

data/examples/configuration_app.rb

@@ -7,6 +7,10 @@ require 'vedeu'
 
 # This example application shows how configuration works.
 #
+# If you have cloned this repository from GitHub, you can run this example:
+#
+#     ./examples/configuration_app.rb
+#
 # First, we use the configuration API to switch debugging on, and set the
 # logging to go to a file in the /tmp directory.
 #
@@ -15,6 +19,7 @@ require 'vedeu'
 # overridden by command line arguments.
 #
 # Use 'space' to refresh, 'q' to exit.
+#
 class VedeuConfigurationApp
 
   include Vedeu

data/examples/drb_app.rb

@@ -6,6 +6,10 @@ $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 require 'vedeu'
 
 # An example application to demonstrate the DRb server.
+# If you have cloned this repository from GitHub, you can run this example:
+#
+#     ./examples/drb_app.rb
+#
 class VedeuTestApplication
 
   # Be aware that running an application with debugging enabled will affect

data/examples/focus_app.rb

@@ -7,6 +7,11 @@ require 'vedeu'
 
 # This example application shows how interface focus works.
 #
+# If you have cloned this repository from GitHub, you can run this example:
+#
+#     ./examples/focus_app.rb
+#
+#
 # First, we set up the interfaces, noting that 'copper' should have focus when
 # the application starts. Also note that 'status' should not show a cursor.
 #

data/examples/geometry_app.rb

@@ -6,6 +6,10 @@ $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 require 'vedeu'
 
 # An example application to demonstrate geometry.
+# If you have cloned this repository from GitHub, you can run this example:
+#
+#     ./examples/geometry_app.rb
+#
 class VedeuGeometryApp
 
   include Vedeu

data/examples/hello_world.rb

@@ -9,6 +9,11 @@ trap('INT') { exit! }
 require 'vedeu'
 
 # An example application to demonstrate 'Hello World'.
+#
+# If you have cloned this repository from GitHub, you can run this example:
+#
+#     ./examples/hello_world.rb
+#
 class HelloWorldApp
 
   include Vedeu

data/examples/material_colours_app.rb

@@ -7,6 +7,11 @@ require 'vedeu'
 
 # An example application to demonstrate colours, cursor and interface movement,
 # maximising/unmaximising of interfaces and toggling of cursors and interfaces.
+#
+# If you have cloned this repository from GitHub, you can run this example:
+#
+#     ./examples/material_colours_app.rb
+#
 class VedeuMaterialColoursApp
 
   include Vedeu
@@ -35,20 +40,22 @@ class VedeuMaterialColoursApp
     zindex 2
   end
 
+  # This interface uses the 'parens' style for the DSL, which sometimes helps
+  # Ruby to understand the values you provide.
   interface 'other_interface' do
     border 'other_interface' do
-      colour foreground: '#ffffff', background: :default
-      title 'Wow!'
+      colour(foreground: '#ffffff', background: :default)
+      title('Wow!')
     end
-    colour foreground: '#ffffff', background: :default
+    colour(foreground: '#ffffff', background: :default)
     cursor!
     geometry 'other_interface' do
-      x  27
-      xn 47
-      y  3
-      yn 13
+      x(27)
+      xn(47)
+      y(3)
+      yn(13)
     end
-    zindex 1
+    zindex(1)
   end
 
   keymap('_global_') do

data/examples/panel_app.rb

@@ -7,6 +7,11 @@ require 'vedeu'
 
 # An example application to demonstrate colours, cursor and interface movement,
 # maximising/unmaximising of interfaces and toggling of cursors and interfaces.
+#
+# If you have cloned this repository from GitHub, you can run this example:
+#
+#     ./examples/panel_app.rb
+#
 class VedeuPanelApp
 
   include Vedeu

data/examples/typed_commands/typed_commands_app.rb

@@ -63,15 +63,15 @@ class VedeuTypedCommands
   geometry('status') do
     height 1
     width  40
-    x      Vedeu.use('output').left
-    y      Vedeu.use('output').south(0)
+    x      use('output').left
+    y      use('output').south(0)
   end
 
   geometry 'command' do
     height 3
     width  40
-    x      Vedeu.use('status').left
-    y      Vedeu.use('status').south(0)
+    x      use('status').left
+    y      use('status').south(0)
   end
 
   focus_by_name 'command'

data/examples/view_templates_app/view_templates_app.rb

@@ -58,15 +58,15 @@ class VedeuViewTemplateApp
   geometry 'default' do
     height 6
     width  25
-    x      Vedeu.use('prune').left
-    y      Vedeu.use('prune').north(7)
+    x      use('prune').left
+    y      use('prune').north(7)
   end
 
   geometry 'wrap' do
     height 6
     width  25
-    x      Vedeu.use('prune').left
-    y      Vedeu.use('prune').south(1)
+    x      use('prune').left
+    y      use('prune').south(1)
   end
 
   renders do

data/lib/vedeu/application.rb

@@ -1,6 +1,8 @@
 module Vedeu
 
   # Orchestrates the running of the main application loop.
+  #
+  # @api private
   class Application
 
     # @param (see #initialize)

data/lib/vedeu/bindings.rb

@@ -10,6 +10,7 @@ module Vedeu
   #
   # :nocov:
   #
+  # @api public
   module Bindings
 
     Vedeu.bind(:_drb_input_) do |data, type|

data/lib/vedeu/buffers/buffer.rb

@@ -10,6 +10,8 @@ module Vedeu
   # if available, otherwise from the current 'Front' buffer. When new content
   # is copied to the 'Front' buffer, the current 'Front' buffer is also copied
   # to the 'Previous' buffer.
+  #
+  # @api private
   class Buffer
 
     include Vedeu::Model

data/lib/vedeu/buffers/display_buffer.rb

@@ -3,6 +3,7 @@ module Vedeu
   # This module is included in Vedeu::Interface to provide means to store client
   # application views created with {Vedeu.renders} or {Vedeu.views}.
   #
+  # @api private
   module DisplayBuffer
 
     include Vedeu::Common

data/lib/vedeu/configuration/api.rb

@@ -4,6 +4,8 @@ module Vedeu
 
     # The Configuration::API class parses client application configuration into
     # options used by Vedeu to affect certain behaviours.
+    #
+    # @api public
     class API
 
       include Vedeu::Common

data/lib/vedeu/configuration/cli.rb

@@ -4,6 +4,8 @@ module Vedeu
 
     # The Configuration::CLI class parses command-line arguments using
     # OptionParser into options used by Vedeu to affect certain behaviours.
+    #
+    # @api public
     class CLI
 
       # @param (see #initialize)

data/lib/vedeu/configuration/configuration.rb

@@ -27,6 +27,7 @@ module Vedeu
   # application settings (via the configuration API), or any command-line
   # arguments provided.
   #
+  # @api private
   class Configuration
 
     include Singleton

data/lib/vedeu/cursor/cursor.rb

@@ -2,6 +2,8 @@ module Vedeu
 
   # Each interface has its own Cursor which maintains the position and
   # visibility of the cursor within that interface.
+  #
+  # @api private
   class Cursor
 
     include Vedeu::Model

data/lib/vedeu/cursor/move.rb

@@ -38,6 +38,8 @@ module Vedeu
   #   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.
+  #
+  # @api private
   class Move
 
     extend Forwardable

data/lib/vedeu/cursor/refresh_cursor.rb

@@ -2,6 +2,8 @@ module Vedeu
 
   # Handle the refreshing (redrawing) of a cursor, without redrawing the whole
   # interface; unless the cursor's offset has caused the view to change.
+  #
+  # @api private
   class RefreshCursor
 
     extend Forwardable

data/lib/vedeu/debug.rb

@@ -4,6 +4,7 @@ module Vedeu
   # Helps to debug a running application by providing a stack trace of its
   # execution upon exiting.
   #
+  # @api public
   # @param filename [String]
   # @return [void]
   # @yieldreturn [void] The section of the application to debug.

data/lib/vedeu/distributed/uri.rb

@@ -4,6 +4,8 @@ module Vedeu
 
     # Value class which provides the host and port for the DRb server and
     # client.
+    #
+    # @api private
     class Uri
 
       # @!attribute [r] host

data/lib/vedeu/dsl/all.rb

@@ -18,6 +18,7 @@ module Vedeu
 
   # Provides a mechanism to help configure and use Vedeu.
   #
+  # @api public
   module DSL
 
     private

data/lib/vedeu/dsl/border.rb

@@ -23,10 +23,13 @@ module Vedeu
     #   # ...or standalone; referencing the target interface or view.
     #   Vedeu.border 'some_interface' do
     #     # ...
+    #
+    # @api public
     class Border
 
       include Vedeu::DSL
       include Vedeu::DSL::Presentation
+      include Vedeu::DSL::Use
 
       # Specify the border of an interface or view with a simple DSL.
       #

data/lib/vedeu/dsl/composition.rb

@@ -36,6 +36,7 @@ module Vedeu
     # - Colours are defined in CSS-style values, i.e. `#ff0000` would be red.
     # - Styles are named. See the table below for supported styles.
     #
+    # @api public
     class Composition
 
       include Vedeu::DSL

data/lib/vedeu/dsl/geometry.rb

@@ -21,6 +21,7 @@ module Vedeu
     #     yn +--------------+           # south:  yn + 1
     #             south
     #
+    # @api public
     class Geometry
 
       include Vedeu::DSL

data/lib/vedeu/dsl/group.rb

@@ -3,6 +3,8 @@ module Vedeu
   module DSL
 
     # DSL for adding interfaces to a group.
+    #
+    # @api public
     class Group
 
       include Vedeu::DSL

data/lib/vedeu/dsl/interface.rb

@@ -3,6 +3,8 @@ module Vedeu
   module DSL
 
     # DSL for creating interfaces.
+    #
+    # @api public
     class Interface
 
       include Vedeu::Common
@@ -23,12 +25,20 @@ module Vedeu
 
       # Allows the setting of a border for the interface.
       #
+      # @example
+      #   interface 'my_interface' do
+      #     border do
+      #       # ... see Vedeu::DSL::Border for DSL methods for borders.
+      #     end
+      #   end
+      #
       # @param name [String] 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::DSL::Border.border}.
       # @param block [Proc]
       # @raise [InvalidSyntax] The required block was not given.
       # @return [Vedeu::Border]
+      # @see Vedeu::DSL::Border
       def border(name = nil, &block)
         fail InvalidSyntax, 'block not given' unless block_given?
 
@@ -114,7 +124,9 @@ module Vedeu
       # @example
       #   interface 'my_interface' do
       #     geometry do
-      #       # ...
+      #       # ... see Vedeu::DSL::Geometry for DSL methods for geometries.
+      #     end
+      #   end
       #
       # @param name [String] The name of the interface; this is already provided
       #   when we define the interface or view, setting it here is just
@@ -219,6 +231,15 @@ module Vedeu
         visible(false)
       end
 
+      # Use a value from another model.
+      #
+      # @param name [String] The name of the interface model you wish to use a
+      #   value from.
+      # @return [Vedeu::Interface]
+      def use(name)
+        model.repository.by_name(name)
+      end
+
       # Set the visibility of the interface.
       #
       # @param value [Boolean] Any value other than nil or false will evaluate