vedeu 0.4.7 → 0.4.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 80640072b141fef605a79c9713e7e0b389fe7ef6
-  data.tar.gz: ff600f46a10489bd1369e7c3af9389d5265bf802
+  metadata.gz: 7649a91c05398be50b8403bf37f0f2f46fbd0317
+  data.tar.gz: 2b8f063515e7ae529fc2877ebcf482d821cebbc0
 SHA512:
-  metadata.gz: a28c6ab1df05e903f03820ca75492ef060253f3122f4336e7bdf164db91571afbfd6c2f8c3a8983825eba2b2d3139badd88a2012ce5a3689e994132b9a1b6dde
-  data.tar.gz: 3968b584c4ad1161164dbc7b163f9f850fe5883255ccfa899fa3a1a3374d9d9cddace5f42e506c01c9f4d68fbfbb6d6eb306107e33d31a9eb006b880647765a4
+  metadata.gz: 00be70e455d52864393e79a59f678b3d3d308370eadba24d74cf1ce216b4c84c25859cce8ae33ce43d151bd0173b8c7f555fe4e0455c916a0fa33ed671077b3a
+  data.tar.gz: 2d82fcc1f9ee603023b99c4d1b4a7bde1c9b02578bb68feeac24a1fdaf6e41ddb98845c8336a883a04be5ec3d40fbed5de3202e50449c3052ea9d36895cdb5e7

data/lib/vedeu/all.rb

@@ -5,9 +5,8 @@ require 'vedeu/debug'
 require 'vedeu/traps'
 require 'vedeu/exceptions'
 
-require 'vedeu/repositories/all'
-
 require 'vedeu/geometry/all'
+require 'vedeu/repositories/all'
 
 require 'vedeu/api'
 require 'vedeu/bindings'

data/lib/vedeu/api.rb

@@ -23,6 +23,7 @@ module Vedeu
 
     def_delegators Vedeu::Borders,       :borders
     def_delegators Vedeu::Buffers,       :buffers
+    def_delegators Vedeu::Canvas,        :canvas
     def_delegators Vedeu::Cursors,       :cursors
     def_delegators Vedeu::Cursors,       :cursor
     def_delegators Vedeu::EventsRepository, :events

data/lib/vedeu/application.rb

@@ -4,14 +4,12 @@ module Vedeu
   #
   class Application
 
-    # @param configuration [Vedeu::Configuration]
-    # @return [void]
+    # @param (see #initialize)
     def self.start(configuration)
       new(configuration).start
     end
 
-    # @param configuration [Vedeu::Configuration]
-    # @return [void]
+    # @param (see #initialize)
     def self.restart(configuration)
       new(configuration).start
     end

data/lib/vedeu/bindings.rb

@@ -88,32 +88,32 @@ module Vedeu
     Vedeu.bind(:_cursor_hide_) do |name|
       named = name ? Vedeu.cursors.by_name(name) : Vedeu.cursor
 
-      Vedeu::ToggleCursor.hide(named)
+      Vedeu::Toggle.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
 
-      Vedeu::ToggleCursor.show(named)
+      Vedeu::Toggle.show(named)
     end
 
-    # @see {Vedeu::MoveCursor}
-    Vedeu.bind(:_cursor_down_) { |name| Vedeu::MoveCursor.by_name(:down, name) }
+    # @see {Vedeu::Move}
+    Vedeu.bind(:_cursor_down_) { |name| Vedeu::Move.by_name(:down, name) }
 
-    # @see {Vedeu::MoveCursor}
-    Vedeu.bind(:_cursor_left_) { |name| Vedeu::MoveCursor.by_name(:left, name) }
+    # @see {Vedeu::Move}
+    Vedeu.bind(:_cursor_left_) { |name| Vedeu::Move.by_name(:left, name) }
 
-    # @see {Vedeu::MoveCursor}
-    Vedeu.bind(:_cursor_right_) { |name| Vedeu::MoveCursor.by_name(:right, name) }
+    # @see {Vedeu::Move}
+    Vedeu.bind(:_cursor_right_) { |name| Vedeu::Move.by_name(:right, name) }
 
-    # @see {Vedeu::MoveCursor}
-    Vedeu.bind(:_cursor_up_) { |name| Vedeu::MoveCursor.by_name(:up, name) }
+    # @see {Vedeu::Move}
+    Vedeu.bind(:_cursor_up_) { |name| Vedeu::Move.by_name(:up, name) }
 
-    # @see {Vedeu::MoveCursor}
-    Vedeu.bind(:_cursor_origin_) { |name| Vedeu::MoveCursor.by_name(:origin, name) }
+    # @see {Vedeu::Move}
+    Vedeu.bind(:_cursor_origin_) { |name| Vedeu::Move.by_name(:origin, name) }
 
-    # @see {Vedeu::MoveCursor}
+    # @see {Vedeu::Move}
     Vedeu.bind(:_cursor_reset_) { |name| Vedeu.trigger(:_cursor_origin_, name) }
 
     # When triggered with an interface name will focus that interface and

data/lib/vedeu/configuration/api.rb

@@ -11,6 +11,11 @@ module Vedeu
 
       include Vedeu::Common
 
+      # @param (see #initialize)
+      def self.configure(&block)
+        new(&block).configuration
+      end
+
       # Configure Vedeu via a simple configuration API DSL. Options set here
       # override the default Vedeu configuration set in
       # {Vedeu::Configuration#defaults}.
@@ -20,14 +25,6 @@ module Vedeu
       #     ...
       #
       # @param block [Proc]
-      # @return [Hash]
-      def self.configure(&block)
-        new(&block).configuration
-      end
-
-      # Returns an instance of Configuration::API.
-      #
-      # @param block [Proc]
       # @return [Configuration::API]
       def initialize(&block)
         instance_eval(&block) if block_given?
@@ -35,7 +32,7 @@ module Vedeu
 
       # Returns the configuration options set up by the API DSL.
       #
-      # @return [Hash]
+      # @return [Hash<Symbol => Boolean, Fixnum, String>]
       def configuration
         options.merge!({
           system_keys: Configuration.default_system_keys.merge!(system_keys)

data/lib/vedeu/configuration/cli.rb

@@ -9,17 +9,14 @@ module Vedeu
     #
     class CLI
 
-      # Configure Vedeu via command-line arguments. Options set here via
-      # arguments override the client application configuration set via
-      # {Vedeu::API#configure}.
-      #
-      # @param args [Array]
-      # @return [Hash]
+      # @param (see #initialize)
       def self.configure(args = [])
         new(args).configuration
       end
 
-      # Returns an instance of Configuration::CLI.
+      # Configure Vedeu via command-line arguments. Options set here via
+      # arguments override the client application configuration set via
+      # {Vedeu::API#configure}.
       #
       # @param args [Array]
       # @return [Configuration::CLI]

data/lib/vedeu/cursor/all.rb

@@ -1,8 +1,8 @@
 require 'vedeu/repositories/all'
 require 'vedeu/cursor/cursor'
-require 'vedeu/cursor/move_cursor'
+require 'vedeu/cursor/move'
 require 'vedeu/cursor/refresh_cursor'
-require 'vedeu/cursor/toggle_cursor'
+require 'vedeu/cursor/toggle'
 
 module Vedeu
 end # Vedeu

data/lib/vedeu/cursor/{move_cursor.rb → move.rb}

@@ -33,7 +33,7 @@ module Vedeu
   #   The cursor will move freely within the bounds of the interface,
   #     irrespective of content.
   #
-  class MoveCursor
+  class Move
 
     extend Forwardable
 
@@ -46,13 +46,13 @@ module Vedeu
                               :height,
                               :width
 
-    # Returns an instance of MoveCursor.
+    # Returns an instance of Move.
     #
     # @param cursor    [Cursor]
     # @param interface [Interface]
     # @param dy        [Fixnum] Move up (-1), or down (1), or no action (0).
     # @param dx        [Fixnum] Move left (-1), or right (1), or no action (0).
-    # @return [MoveCursor]
+    # @return [Move]
     def initialize(cursor, interface, dy = 0, dx = 0)
       @cursor    = cursor
       @dy        = dy || 0
@@ -81,7 +81,7 @@ module Vedeu
 
       end
 
-      new_cursor = Vedeu::MoveCursor.send(direction, cursor, interface)
+      new_cursor = Vedeu::Move.send(direction, cursor, interface)
 
       Vedeu.trigger(:_refresh_cursor_, new_cursor.name)
 
@@ -162,7 +162,7 @@ module Vedeu
     # @return [Vedeu::Interface]
     attr_reader :interface
 
-    # @return [Hash]
+    # @return [Hash<Symbol => Fixnum>]
     def moved_attributes
       {
         x:  validator.x,
@@ -225,6 +225,6 @@ module Vedeu
       width
     end
 
-  end # MoveCursor
+  end # Move
 
 end # Vedeu

data/lib/vedeu/cursor/refresh_cursor.rb

@@ -1,9 +1,11 @@
 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.
+  #
   class RefreshCursor
 
-    # @param name [String] The name of the cursor.
-    # @return [Array]
+    # @param (see #initialize)
     def self.render(name)
       new(name).render
     end
@@ -29,7 +31,8 @@ module Vedeu
 
     # @return [Boolean]
     def refresh_view?
-      new_cursor.ox >= interface_width || new_cursor.oy >= interface_height
+      new_cursor.ox >= interface_width ||
+      new_cursor.oy >= interface_height
     end
 
     # @return [Vedeu::Cursor]
@@ -37,7 +40,7 @@ module Vedeu
       @new_cursor ||= Vedeu::Cursor.new(cursor.attributes.merge(position))
     end
 
-    # @return [Hash]
+    # @return [Hash<Symbol => Fixnum>]
     def position
       {
         x: validated_position.x,

data/lib/vedeu/cursor/{toggle_cursor.rb → toggle.rb}

@@ -2,20 +2,19 @@ module Vedeu
 
   # Adjusts the visibility of the cursor.
   #
-  class ToggleCursor
+  class Toggle
 
-    # Returns an instance of ToggleCursor.
+    # Returns an instance of Toggle.
     #
     # @param cursor [Cursor]
-    # @return [ToggleCursor]
+    # @return [Toggle]
     def initialize(cursor)
       @cursor = cursor
     end
 
     # Hides the cursor.
     #
-    # @param cursor [Cursor]
-    # @return [Cursor]
+    # @param (see #initialize)
     def self.hide(cursor)
       return cursor if cursor.invisible?
 
@@ -24,8 +23,7 @@ module Vedeu
 
     # Shows the cursor.
     #
-    # @param cursor [Cursor]
-    # @return [Cursor]
+    # @param (see #initialize)
     def self.show(cursor)
       return cursor if cursor.visible?
 
@@ -52,6 +50,6 @@ module Vedeu
     # @return [Vedeu::Cursor]
     attr_reader :cursor
 
-  end # ToggleCursor
+  end # Toggle
 
 end # Vedeu

data/lib/vedeu/debug.rb

@@ -1,5 +1,6 @@
 module Vedeu
 
+  # :nocov:
   # Helps to debug a running application by providing a stack trace of its
   # execution upon exiting.
   #
@@ -22,5 +23,6 @@ module Vedeu
       # RubyProf::CallTreePrinter.new(result).print(file)
     end
   end
+  # :nocov:
 
 end # Vedeu

data/lib/vedeu/distributed/client.rb

@@ -13,8 +13,7 @@ module Vedeu
     #
     class Client
 
-      # @param uri [String]
-      # @return [Client]
+      # @param (see #initialize)
       def self.connect(uri)
         new(uri).connect
       end

data/lib/vedeu/distributed/server.rb

@@ -13,7 +13,7 @@ module Vedeu
 
       include Singleton
 
-      # @see Vedeu::Distributed::Server#input
+      # @param (see #input)
       def self.input(data, type = :key)
         instance.input(data, type)
       end

data/lib/vedeu/distributed/subprocess.rb

@@ -7,8 +7,7 @@ module Vedeu
   #
   class Subprocess
 
-    # @param application [Vedeu::TestApplication]
-    # @return [Array]
+    # @param (see #initialize)
     def self.execute!(application)
       new(application).execute!
     end
@@ -20,6 +19,7 @@ module Vedeu
       @pid         = nil
     end
 
+    # :nocov:
     # @return [Array]
     def execute!
       file_open && file_write && file_close
@@ -32,6 +32,7 @@ module Vedeu
 
       self
     end
+    # :nocov:
 
     # Sends the KILL signal to the process.
     #

data/lib/vedeu/distributed/test_application.rb

@@ -48,14 +48,12 @@ module Vedeu
     # @return [String]
     attr_accessor :views
 
-    # @param attributes [Hash]
-    # @param block [Proc]
-    # @return [String]
+    # @param (see #initialize)
     def self.build(attributes = {}, &block)
       new(attributes).build(&block)
     end
 
-    # @param attributes [Hash]
+    # @param attributes [Hash<Symbol => String>]
     # @option attributes borders [String]
     # @option attributes configuration [String]
     # @option attributes events [String]

data/lib/vedeu/dsl/all.rb

@@ -16,6 +16,7 @@ module Vedeu
 
     private
 
+    # :nocov:
     # Attempts to find the missing method on the client object.
     #
     # @param method [Symbol] The name of the method sought.
@@ -27,6 +28,7 @@ module Vedeu
 
       client.send(method, *args, &block) if client
     end
+    # :nocov:
 
   end # DSL
 

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

@@ -1,4 +1,4 @@
-require 'vedeu/models/geometry'
+require 'vedeu/geometry/geometry'
 require 'vedeu/dsl/shared/all'
 
 module Vedeu
@@ -62,13 +62,15 @@ module Vedeu
 
       # Specify the number of characters/rows/lines tall the interface will be.
       #
-      # @param value [Fixnum]
-      #
       # @example
       #   geometry 'some_interface' do
       #     height 8
       #     # ...
       #
+      # @note
+      #   This value will be ignored if by `y` and `yn` are set.
+      #
+      # @param value [Fixnum]
       # @return [Fixnum]
       def height(value)
         model.height = value
@@ -83,6 +85,9 @@ module Vedeu
       #     width 25
       #     # ...
       #
+      # @note
+      #   This value will be ignored if by `x` and `xn` are set.
+      #
       # @return [Fixnum]
       def width(value)
         model.width = value
@@ -90,9 +95,6 @@ module Vedeu
 
       # Specify the starting x position (column) of the interface.
       #
-      # @param value [Fixnum]
-      # @param block [Proc]
-      #
       # @example
       #   geometry 'some_interface' do
       #     x 7 # start on column 7.
@@ -104,17 +106,32 @@ module Vedeu
       #                                       # position, `some_interface` will
       #                                       # too.
       #
+      # @param value [Fixnum]
+      # @param block [Proc]
       # @return [Fixnum]
-      def x(value = 0, &block)
+      def x(value = 1, &block)
         return model.x = block if block_given?
 
         model.x = value
       end
 
-      # Specify the starting y position (row/line) of the interface.
+      # Specify the ending x position (column) of the interface.
+      #
+      # @example
+      #   geometry 'some_interface' do
+      #     xn 37 # end at column 37.
+      #     # ...
+      #
+      # @note
+      #   This value will override `width`.
       #
       # @param value [Fixnum]
-      # @param block [Proc]
+      # @return [Fixnum]
+      def xn(value)
+        model.xn = value
+      end
+
+      # Specify the starting y position (row/line) of the interface.
       #
       # @example
       #   geometry 'some_interface' do
@@ -127,13 +144,31 @@ module Vedeu
       #                                         # position, `some_interface`
       #                                         # will too.
       #
+      # @param value [Fixnum]
+      # @param block [Proc]
       # @return [Fixnum]
-      def y(value = 0, &block)
+      def y(value = 1, &block)
         return model.y = block if block_given?
 
         model.y = value
       end
 
+      # Specify the ending y position (row/line) of the interface.
+      #
+      # @example
+      #   geometry 'some_interface' do
+      #     yn 24 # end at row 24.
+      #     # ...
+      #
+      # @note
+      #   This value will override `height`.
+      #
+      # @param value [Fixnum]
+      # @return [Fixnum]
+      def yn(value)
+        model.yn = value
+      end
+
       private
 
       # @!attribute [r] client

data/lib/vedeu/dsl/interface.rb

@@ -1,6 +1,6 @@
 require 'vedeu/cursor/cursor'
 require 'vedeu/models/focus'
-require 'vedeu/models/geometry'
+require 'vedeu/geometry/geometry'
 require 'vedeu/models/group'
 require 'vedeu/models/line'
 require 'vedeu/output/border'

data/lib/vedeu/events/event.rb

@@ -15,21 +15,21 @@ module Vedeu
   # Events described here assume that you have either included Vedeu in your
   # class:
   #
-  # class SomeClassInYourApplication
-  #   include Vedeu
+  #   class SomeClassInYourApplication
+  #     include Vedeu
   #
-  #   bind :event_name do |arg1, arg2|
-  #     # Things that should happen when the event is triggered; these can be
-  #     # method calls or the triggering of another event or events.
-  #   end
+  #     bind :event_name do |arg1, arg2|
+  #       # Things that should happen when the event is triggered; these can be
+  #       # method calls or the triggering of another event or events.
+  #     end
   #
   # or, you are prepared to use the `Vedeu` prefix:
   #
-  # class SomeClassInYourApplication
-  #   Vedeu.bind(:event_name) do
-  #     # Not all events you define will have arguments; like methods.
-  #     :do_stuff
-  #   end
+  #   class SomeClassInYourApplication
+  #     Vedeu.bind(:event_name) do
+  #       # Not all events you define will have arguments; like methods.
+  #       :do_stuff
+  #     end
   #
   class Event
 
@@ -104,6 +104,7 @@ module Vedeu
 
     end
 
+    # @param (see Vedeu::Trigger.trigger)
     # @see Vedeu::Trigger.trigger
     def self.trigger(name, *args)
       Vedeu::Trigger.trigger(name, *args)
@@ -111,9 +112,7 @@ module Vedeu
 
     # Returns a new instance of Event.
     #
-    # @param name [Symbol]
-    # @param options [Hash]
-    # @param closure [Proc] The code to be executed when the event is triggered.
+    # @param (see Vedeu::Event.bind)
     # @return [Event]
     def initialize(name, options = {}, closure)
       @name         = name
@@ -237,6 +236,8 @@ module Vedeu
       false
     end
 
+    # Returns the time in seconds since the last triggering of this event.
+    #
     # @return [Float]
     def elapsed_time
       now - @executed_at
@@ -257,16 +258,23 @@ module Vedeu
       @now = 0
     end
 
+    # Returns a boolean indicating if this event has a deadline.
+    #
     # @return [Boolean]
     def has_deadline?
       @deadline > 0
     end
 
+    # Resets the deadline of this event.
+    #
     # @return [Fixnum]
     def reset_deadline
       @deadline = 0
     end
 
+    # Sets the deadline for when this event can be executed to a point in the
+    # future determined by the amount of debounce time left.
+    #
     # @return [NilClass]
     def set_deadline
       @deadline = now + debounce

data/lib/vedeu/events/trigger.rb

@@ -18,15 +18,16 @@ module Vedeu
       new(name, *args).trigger
     end
 
-    # @see Vedeu::Trigger.trigger
-    # @return [Trigger]
+    # @param (see .trigger)
+    # @return [Vedeu::Trigger]
     def initialize(name, *args)
       @name = name
       @args = args
       @repository = Vedeu.events
     end
 
-    # @see Vedeu::Trigger.trigger
+    # Trigger the event and return the result (if one) or an array of results.
+    #
     # @return [Array]
     def trigger
       if results.one?
@@ -57,6 +58,8 @@ module Vedeu
       @results ||= registered_events.map { |event| event.trigger(*args) }
     end
 
+    # Return all of the registered events for this name.
+    #
     # @return [Array|Array<Vedeu::Event>]
     def registered_events
       return [] unless repository.registered?(name)

data/lib/vedeu/geometry/all.rb

@@ -1,6 +1,11 @@
+require 'vedeu/geometry/area'
 require 'vedeu/geometry/bounding_area'
-require 'vedeu/geometry/content_geometry'
+require 'vedeu/geometry/canvas'
+require 'vedeu/geometry/centre'
+require 'vedeu/geometry/content'
 require 'vedeu/geometry/coordinate'
+require 'vedeu/geometry/dimension'
+require 'vedeu/geometry/geometry'
 require 'vedeu/geometry/grid'
 require 'vedeu/geometry/index_position'
 require 'vedeu/geometry/limit'