vedeu 0.4.5 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6fef3c64356f6fae8e4aa5d76793f341be2a743
-  data.tar.gz: a7f195736cbfd4e597a7381450b431a13d1b7ea3
+  metadata.gz: 1d8e95a7608c18620329eb247fd9dc9049609b03
+  data.tar.gz: 17184d93c7f354a0a8fda4669f49a9a118d4a8da
 SHA512:
-  metadata.gz: 4223a8d24f54f96ac5dd2c1bcad229e9ec335bd5d4426091736426d9dd4a86005c7f270fb2b9ab374f59eb4e8a3fb9b0953f36f68aac65e40275bccb1ddfe8f3
-  data.tar.gz: 91c862b85ab11f9506648a135bde2aa1c2a54d7ad87ccafd017d998fa2f7856a5c12a2d64ee2bb84c9b067ab27071ea72bdf80ff4537bfe2a253ced83b400753
+  metadata.gz: d4a866ae01faf6cff714482e53b58bc142efc775b6ce71dd50948a0dfe730cece1a066113e0ed1c146515239a5c73c9ba440cc65696cb42d54a79e13b6637dfd
+  data.tar.gz: 63369ed9af5b248f7137eb478ba82de72620dde0612b6bbd13231caa4cec28191534eb74c5d23f4a973fc2080c4fc0c34a68dc0cecfa0047460feb5e2b777f27

data/bin/vedeu

@@ -3,9 +3,6 @@
 lib_dir = File.dirname(__FILE__) + '/../lib'
 $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 
--> { its -> { a } }
-trap('INT') { exit! }
-
 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/examples/borders_app.rb

@@ -3,9 +3,6 @@
 lib_dir = File.dirname(__FILE__) + '/../lib'
 $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 
--> { its -> { a } }
-trap('INT') { exit! }
-
 require 'vedeu'
 
 class VedeuBordersApp

data/examples/colours_app.rb

@@ -3,9 +3,6 @@
 lib_dir = File.dirname(__FILE__) + '/../lib'
 $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 
--> { its -> { a } }
-trap('INT') { exit! }
-
 require 'vedeu'
 
 class VedeuColoursApp

data/examples/configuration_app.rb

@@ -3,9 +3,6 @@
 lib_dir = File.dirname(__FILE__) + '/../lib'
 $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 
--> { its -> { a } }
-trap('INT') { exit! }
-
 require 'vedeu'
 
 # This example application shows how configuration works.

data/examples/cursor_app.rb

@@ -3,9 +3,6 @@
 lib_dir = File.dirname(__FILE__) + '/../lib'
 $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 
--> { its -> { a } }
-trap('INT') { exit! }
-
 require 'vedeu'
 
 class VedeuCursorApp

data/examples/focus_app.rb

@@ -3,9 +3,6 @@
 lib_dir = File.dirname(__FILE__) + '/../lib'
 $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 
--> { its -> { a } }
-trap('INT') { exit! }
-
 require 'vedeu'
 
 # This example application shows how interface focus works.

data/examples/geometry_app.rb

@@ -3,9 +3,6 @@
 lib_dir = File.dirname(__FILE__) + '/../lib'
 $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 
--> { its -> { a } }
-trap('INT') { exit! }
-
 require 'vedeu'
 
 class VedeuGeometryApp

data/examples/lines_app.rb

@@ -3,9 +3,6 @@
 lib_dir = File.dirname(__FILE__) + '/../lib'
 $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 
--> { its -> { a } }
-trap('INT') { exit! }
-
 require 'vedeu'
 
 class VedeuLinesApp

data/examples/view_templates_app/template.erb

@@ -0,0 +1 @@
+Here's a simple example that will be displayed in the main interface of the application.

data/examples/view_templates_app/view_templates_app.rb

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby
+
+lib_dir = File.dirname(__FILE__) + '/../../lib'
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+require 'vedeu'
+
+class VedeuViewTemplateApp
+  include Vedeu
+
+  configure do
+    colour_mode 16777216
+    debug!
+    log '/tmp/vedeu_view_templates_app.log'
+  end
+
+  bind(:_initialize_) { Vedeu.trigger(:_refresh_) }
+
+  interface 'default' do
+    colour foreground: '#ff0000', background: '#000000'
+    cursor!
+  end
+
+  interface 'prune' do
+    colour foreground: '#00ff00', background: '#000000'
+    cursor!
+  end
+
+  interface 'wrap' do
+    colour foreground: '#0000ff', background: '#000000'
+    cursor!
+  end
+
+  keymap('_global_') 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
+
+  border('default') do
+    colour foreground: '#aadd00', background: '#000000'
+  end
+  border('prune') do
+    colour foreground: '#aadd00', background: '#000000'
+  end
+  border('wrap') do
+    colour foreground: '#aadd00', background: '#000000'
+  end
+
+  geometry('prune') do
+    centred!
+    height 6
+    width  25
+  end
+
+  geometry 'default' do
+    height 6
+    width  25
+    x      Vedeu.use('prune').left
+    y      Vedeu.use('prune').north(7)
+  end
+
+  geometry 'wrap' do
+    height 6
+    width  25
+    x      Vedeu.use('prune').left
+    y      Vedeu.use('prune').south(1)
+  end
+
+  renders do
+    template_for('default', (File.dirname(__FILE__) + '/template.erb'), nil)
+    template_for('prune', (File.dirname(__FILE__) + '/template.erb'), nil, { mode: :prune, width: 22 })
+    template_for('wrap', (File.dirname(__FILE__) + '/template.erb'), nil, { mode: :wrap, width: 25 })
+  end
+
+  def self.start(argv = ARGV)
+    Vedeu::Launcher.execute!(argv)
+  end
+end
+
+VedeuViewTemplateApp.start(ARGV)

data/lib/vedeu/all.rb

@@ -24,7 +24,6 @@ require 'vedeu/dsl/all'
 
 require 'vedeu/events/all'
 require 'vedeu/input/all'
-require 'vedeu/models/all'
 require 'vedeu/output/all'
 require 'vedeu/support/all'
 

data/lib/vedeu/application.rb

@@ -51,8 +51,8 @@ module Vedeu
     def start
       Vedeu.trigger(:_drb_start_)
 
-      output = Terminal.open do
-        Terminal.set_cursor_mode
+      output = Vedeu::Terminal.open do
+        Vedeu::Terminal.set_cursor_mode
 
         Vedeu.trigger(:_initialize_)
 
@@ -66,6 +66,7 @@ module Vedeu
 
     private
 
+    # @!attribute [r] configuration
     # @return [Configuration]
     attr_reader :configuration
 
@@ -93,7 +94,7 @@ module Vedeu
     # @return [void]
     def main_sequence
       if configuration.interactive?
-        Input.capture(Terminal)
+        Vedeu::Input.capture(Terminal)
 
       else
         Vedeu.trigger(:_standalone_)
@@ -107,14 +108,14 @@ module Vedeu
     #
     # @return [void]
     def run_many
-      MainLoop.start! { yield }
+      Vedeu::MainLoop.start! { yield }
 
     rescue ModeSwitch
-      Terminal.switch_mode!
+      Vedeu::Terminal.switch_mode!
 
       Vedeu.trigger(:_drb_restart_)
 
-      Application.restart(configuration)
+      Vedeu::Application.restart(configuration)
 
     end
 

data/lib/vedeu/bindings.rb

@@ -80,30 +80,30 @@ module Vedeu
     Vedeu.bind(:_cursor_hide_) do |name|
       named = name ? Vedeu.cursors.by_name(name) : Vedeu.cursor
 
-      ToggleCursor.hide(named)
+      Vedeu::ToggleCursor.hide(named)
     end
 
     # Show the cursor of the named interface or interface currently in focus.
     Vedeu.bind(:_cursor_show_) do |name|
       named = name ? Vedeu.cursors.by_name(name) : Vedeu.cursor
 
-      ToggleCursor.show(named)
+      Vedeu::ToggleCursor.show(named)
     end
 
     # @see {Vedeu::MoveCursor}
-    Vedeu.bind(:_cursor_down_) { |name| MoveCursor.by_name(:down, name) }
+    Vedeu.bind(:_cursor_down_) { |name| Vedeu::MoveCursor.by_name(:down, name) }
 
     # @see {Vedeu::MoveCursor}
-    Vedeu.bind(:_cursor_left_) { |name| MoveCursor.by_name(:left, name) }
+    Vedeu.bind(:_cursor_left_) { |name| Vedeu::MoveCursor.by_name(:left, name) }
 
     # @see {Vedeu::MoveCursor}
-    Vedeu.bind(:_cursor_right_) { |name| MoveCursor.by_name(:right, name) }
+    Vedeu.bind(:_cursor_right_) { |name| Vedeu::MoveCursor.by_name(:right, name) }
 
     # @see {Vedeu::MoveCursor}
-    Vedeu.bind(:_cursor_up_) { |name| MoveCursor.by_name(:up, name) }
+    Vedeu.bind(:_cursor_up_) { |name| Vedeu::MoveCursor.by_name(:up, name) }
 
     # @see {Vedeu::MoveCursor}
-    Vedeu.bind(:_cursor_origin_) { |name| MoveCursor.by_name(:origin, name) }
+    Vedeu.bind(:_cursor_origin_) { |name| Vedeu::MoveCursor.by_name(:origin, name) }
 
     # @see {Vedeu::MoveCursor}
     Vedeu.bind(:_cursor_reset_) { |name| Vedeu.trigger(:_cursor_origin_, name) }
@@ -161,7 +161,7 @@ module Vedeu
     # if given.
     Vedeu.bind(:_clear_) do |name|
       if name && Vedeu.interfaces.registered?(name)
-        Vedeu::Output.clear(Vedeu.interfaces.find(name))
+        Vedeu::Clear.clear(Vedeu.interfaces.find(name))
 
       else
         Vedeu::Terminal.virtual.clear if Vedeu::Configuration.drb?

data/lib/vedeu/buffers/buffer.rb

@@ -1,4 +1,4 @@
-require 'vedeu/models/model'
+require 'vedeu/repositories/model'
 
 module Vedeu
 
@@ -16,10 +16,20 @@ module Vedeu
 
     include Vedeu::Model
 
-    attr_accessor :back,
-      :front,
-      :previous
+    # @!attribute [rw] back
+    # @return [Interface]
+    attr_accessor :back
 
+    # @!attribute [rw] front
+    # @return [Interface]
+    attr_accessor :front
+
+    # @!attribute [rw] previous
+    # @return [Interface]
+    attr_accessor :previous
+
+    # @!attribute [r] name
+    # @return [String]
     attr_reader :name
 
     # Return a new instance of Buffer.

data/lib/vedeu/buffers/display_buffer.rb

@@ -1,4 +1,4 @@
-require 'vedeu/repositories/repository'
+require 'vedeu/repositories/all'
 
 module Vedeu
 
@@ -48,7 +48,7 @@ module Vedeu
         Vedeu.buffers.find(name).add(self)
 
       else
-        Buffer.new(name, self).store
+        Vedeu::Buffer.new(name, self).store
 
       end
 

data/lib/vedeu/configuration/cli.rb

@@ -124,7 +124,13 @@ module Vedeu
 
       private
 
-      attr_reader :args, :options
+      # @!attribute [r] args
+      # @return [Array<String>]
+      attr_reader :args
+
+      # @!attribute [r] options
+      # @return [Hash]
+      attr_reader :options
 
     end # CLI
 

data/lib/vedeu/configuration/configuration.rb

@@ -214,6 +214,8 @@ module Vedeu
 
     end # Configuration eigenclass
 
+    # @!attribute [r] options
+    # @return [Hash]
     attr_reader :options
 
     # Create a new singleton instance of Configuration.
@@ -237,7 +239,7 @@ module Vedeu
 
       @options.merge!(Config::CLI.configure(args)) if args.any?
 
-      Configuration
+      Vedeu::Configuration
     end
 
     # Reset the configuration to the default values.
@@ -268,7 +270,7 @@ module Vedeu
         stdin:         nil,
         stdout:        nil,
         stderr:        nil,
-        system_keys:   Configuration.default_system_keys,
+        system_keys:   Vedeu::Configuration.default_system_keys,
         terminal_mode: :raw,
         trace:         false,
       }

data/lib/vedeu/cursor/all.rb

@@ -1,4 +1,4 @@
-require 'vedeu/repositories/repository'
+require 'vedeu/repositories/all'
 require 'vedeu/cursor/cursor'
 require 'vedeu/cursor/move_cursor'
 require 'vedeu/cursor/toggle_cursor'

data/lib/vedeu/cursor/cursor.rb

@@ -1,5 +1,4 @@
 require 'vedeu/cursor/all'
-require 'vedeu/models/model'
 require 'vedeu/geometry/position'
 require 'vedeu/support/visible'
 
@@ -16,7 +15,33 @@ module Vedeu
 
     include Vedeu::Model
 
-    attr_reader :attributes, :name, :ox, :oy, :state, :x, :y
+    # @!attribute [r] attributes
+    # @return [Hash]
+    attr_reader :attributes
+
+    # @!attribute [r] name
+    # @return [String]
+    attr_reader :name
+
+    # @!attribute [r] ox
+    # @return [Fixnum]
+    attr_reader :ox
+
+    # @!attribute [r] oy
+    # @return [Fixnum]
+    attr_reader :oy
+
+    # @!attribute [r] state
+    # @return [Boolean|Symbol]
+    attr_reader :state
+
+    # @!attribute [r] x
+    # @return [Fixnum]
+    attr_reader :x
+
+    # @!attribute [r] y
+    # @return [Fixnum]
+    attr_reader :y
 
     # Returns a new instance of Cursor.
     #
@@ -70,6 +95,8 @@ module Vedeu
 
     private
 
+    # @!attribute [r] position
+    # @return [Vedeu::Position]
     attr_reader :position
 
     # The default values for a new instance of this class.

data/lib/vedeu/cursor/move_cursor.rb

@@ -74,14 +74,14 @@ module Vedeu
       if name
         cursor     = Vedeu.cursors.by_name(name)
         interface  = Vedeu.interfaces.find(name)
-        new_cursor = MoveCursor.send(direction, cursor, interface)
-        Refresh.by_name(name)
+        new_cursor = Vedeu::MoveCursor.send(direction, cursor, interface)
+        Vedeu::Refresh.by_name(name)
 
       else
         cursor     = Vedeu.cursor
         interface  = Vedeu.interfaces.current
-        new_cursor = MoveCursor.send(direction, cursor, interface)
-        Refresh.by_focus
+        new_cursor = Vedeu::MoveCursor.send(direction, cursor, interface)
+        Vedeu::Refresh.by_focus
 
       end
       new_cursor
@@ -140,12 +140,26 @@ module Vedeu
     #
     # @return [Cursor]
     def move
-      Cursor.new(cursor.attributes.merge!(moved_attributes)).store
+      Vedeu::Cursor.new(cursor.attributes.merge!(moved_attributes)).store
     end
 
     private
 
-    attr_reader :cursor, :dx, :dy, :interface
+    # @!attribute [r] cursor
+    # @return [Vedeu::Cursor]
+    attr_reader :cursor
+
+    # @!attribute [r] dx
+    # @return [Fixnum]
+    attr_reader :dx
+
+    # @!attribute [r] dy
+    # @return [Fixnum]
+    attr_reader :dy
+
+    # @!attribute [r] interface
+    # @return [Vedeu::Interface]
+    attr_reader :interface
 
     # @return [Hash]
     def moved_attributes

data/lib/vedeu/cursor/toggle_cursor.rb

@@ -48,6 +48,8 @@ module Vedeu
 
     private
 
+    # @!attribute [r] cursor
+    # @return [Vedeu::Cursor]
     attr_reader :cursor
 
   end # ToggleCursor

data/lib/vedeu/distributed/client.rb

@@ -91,6 +91,8 @@ module Vedeu
 
       private
 
+      # @!attribute [r] uri
+      # @return [String]
       attr_reader :uri
 
       # @return [void]

data/lib/vedeu/distributed/server.rb

@@ -97,7 +97,7 @@ module Vedeu
 
         Vedeu.trigger(:_exit_)
 
-        Terminal.restore_screen
+        Vedeu::Terminal.restore_screen
       end
 
       # @return [Vedeu::Distributed::Server]
@@ -161,6 +161,8 @@ module Vedeu
 
       private
 
+      # @!attribute [r] configuration
+      # @return [Configuration]
       attr_reader :configuration
 
       # @return [Boolean]

data/lib/vedeu/distributed/subprocess.rb

@@ -44,7 +44,12 @@ module Vedeu
 
     private
 
-    attr_reader   :application
+    # @!attribute [r] application
+    # @return [Vedeu::TestApplication]
+    attr_reader :application
+
+    # @!attribute [rw] pid
+    # @return [Fixnum]
     attr_accessor :pid
 
     # @return [String]

data/lib/vedeu/distributed/test_application.rb

@@ -16,14 +16,37 @@ module Vedeu
   #
   class TestApplication
 
-    attr_accessor :borders,
-      :configuration,
-      :events,
-      :geometries,
-      :interfaces,
-      :keymaps,
-      :menus,
-      :views
+    # @!attribute [rw] borders
+    # @return [String]
+    attr_accessor :borders
+
+    # @!attribute [rw] configuration
+    # @return [String]
+    attr_accessor :configuration
+
+    # @!attribute [rw] events
+    # @return [String]
+    attr_accessor :events
+
+    # @!attribute [rw] geometries
+    # @return [String]
+    attr_accessor :geometries
+
+    # @!attribute [rw] interfaces
+    # @return [String]
+    attr_accessor :interfaces
+
+    # @!attribute [rw] keymaps
+    # @return [String]
+    attr_accessor :keymaps
+
+    # @!attribute [rw] menus
+    # @return [String]
+    attr_accessor :menus
+
+    # @!attribute [rw] views
+    # @return [String]
+    attr_accessor :views
 
     # @param attributes [Hash]
     # @param block [Proc]
@@ -55,7 +78,7 @@ module Vedeu
     def build(&block)
       self.instance_eval(&block) if block_given?
 
-      Template.parse(self, template)
+      Vedeu::Template.parse(self, template)
     end
 
     # @return [String]

data/lib/vedeu/distributed/uri.rb

@@ -7,7 +7,13 @@ module Vedeu
     #
     class Uri
 
-      attr_reader :host, :port
+      # @!attribute [r] host
+      # @return [String]
+      attr_reader :host
+
+      # @!attribute [r] port
+      # @return [Fixnum|String]
+      attr_reader :port
 
       # @param host [String] Hostname or IP address.
       # @param port [Fixnum|String]

data/lib/vedeu/dsl/components/border.rb

@@ -275,9 +275,11 @@ module Vedeu
 
       private
 
+      # @!attribute [r] client
       # @return [Object]
       attr_reader :client
 
+      # @!attribute [r] model
       # @return [Border]
       attr_reader :model
 

data/lib/vedeu/dsl/components/geometry.rb

@@ -136,9 +136,11 @@ module Vedeu
 
       private
 
+      # @!attribute [r] client
       # @return [Object]
       attr_reader :client
 
+      # @!attribute [r] model
       # @return [Geometry]
       attr_reader :model
 

data/lib/vedeu/dsl/components/keymap.rb

@@ -126,9 +126,11 @@ module Vedeu
 
       private
 
+      # @!attribute [r] client
       # @return [Object]
       attr_reader :client
 
+      # @!attribute [r] model
       # @return [Keymap]
       attr_reader :model
 

data/lib/vedeu/dsl/components/menu.rb

@@ -75,10 +75,12 @@ module Vedeu
 
       private
 
+      # @!attribute [r] client
       # @return [Object]
       attr_reader :client
 
-      # @return [Menu]
+      # @!attribute [r] model
+      # @return [Vedeu::Menu]
       attr_reader :model
 
     end # Menu