vedeu 0.4.9 → 0.4.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f8e55b96180371a74727bb5684f829aea4fb3ae
-  data.tar.gz: d3bbd55216ffff82ebf2007cd7616228be86e155
+  metadata.gz: a9fe2d78e6318aca74ab320786c9074d8b745eff
+  data.tar.gz: 824f82bca58a42308ad10bec73fd49fbd1c20884
 SHA512:
-  metadata.gz: 52b9ca57b1f4258a516e236a49e42840665bb4f40352e8d7b562de206eb1a23340fe4be40acfe02d41a28618db3e36a8841964d2a1fa2c3108bd841bdb6aa29f
-  data.tar.gz: b5caa9c02529b83537e2894d4fbc287beedef7c1cbcd7de1bc5d2eafb178d225ec9709c14fda5a8872bd2760f04c3df0ed2a95051e8fc1a8ebe1002506ff8b4e
+  metadata.gz: 103b80280897cd8904924011ef77a0060256f60a5475c1725ad118a0b606861eaa7c0f4938fe2b4c1e06fb6edd9ff84809ee209aa57b07a73b49f8b12ba61c8f
+  data.tar.gz: d39f7987ca6a1f517ad469d3be912d7748e2f7592128689eb3aace31cc5e59c57f5c2d62200d4c4f9abc009e91b017f6ecb8a2de5c420ac28983649c42356925

data/lib/vedeu/api.rb

@@ -46,6 +46,14 @@ module Vedeu
     #   @see Vedeu::Canvas.canvas
     def_delegators Vedeu::Canvas, :canvas
 
+    # @!method background_colours
+    #   @see Vedeu::BackgroundColours.background_colours
+    def_delegators Vedeu::BackgroundColours, :background_colours
+
+    # @!method foreground_colours
+    #   @see Vedeu::ForegroundColours.foreground_colours
+    def_delegators Vedeu::ForegroundColours, :foreground_colours
+
     # @!method cursors
     #   @see Vedeu::Cursors.cursors
     def_delegators Vedeu::Cursors, :cursors

data/lib/vedeu/application.rb

@@ -29,6 +29,8 @@ module Vedeu
     end
 
     # :nocov:
+    # Returns a new instance of Vedeu::Application.
+    #
     # @param configuration [Vedeu::Configuration]
     # @return [Application]
     def initialize(configuration)

data/lib/vedeu/bindings.rb

@@ -84,6 +84,9 @@ module Vedeu
     # events. Please see those events for their behaviour.
     Vedeu.bind(:_resize_, { delay: 0.25 }) { Vedeu.resize }
 
+    Vedeu.bind(:tick) { |time| Vedeu.log(type: :debug, message: "Tick: #{time}") }
+    Vedeu.bind(:tock) { |time| Vedeu.log(type: :debug, message: "Tock: #{time}") }
+
     # Hide the cursor of the named interface or interface currently in focus.
     Vedeu.bind(:_cursor_hide_) do |name|
       named = name ? Vedeu.cursors.by_name(name) : Vedeu.cursor

data/lib/vedeu/configuration/configuration.rb

@@ -218,7 +218,7 @@ module Vedeu
     # @return [Hash]
     attr_reader :options
 
-    # Create a new singleton instance of Configuration.
+    # Create a new singleton instance of Vedeu::Configuration.
     #
     # @return [Configuration]
     def initialize

data/lib/vedeu/cursor/cursor.rb

@@ -44,7 +44,7 @@ module Vedeu
     # @return [Fixnum]
     attr_reader :y
 
-    # Returns a new instance of Cursor.
+    # Returns a new instance of Vedeu::Cursor.
     #
     # @param attributes [Hash]
     # @option attributes name [String] The name of the interface this cursor

data/lib/vedeu/cursor/move.rb

@@ -46,7 +46,7 @@ module Vedeu
                               :height,
                               :width
 
-    # Returns an instance of Move.
+    # Returns an instance of Vedeu::Move.
     #
     # @param cursor    [Cursor]
     # @param interface [Interface]

data/lib/vedeu/cursor/refresh_cursor.rb

@@ -10,6 +10,8 @@ module Vedeu
       new(name).render
     end
 
+    # Returns a new instance of Vedeu::RefreshCursor.
+    #
     # @param name [String] The name of the cursor.
     # @return [Vedeu::RefreshCursor]
     def initialize(name)

data/lib/vedeu/cursor/toggle.rb

@@ -4,7 +4,7 @@ module Vedeu
   #
   class Toggle
 
-    # Returns an instance of Toggle.
+    # Returns an instance of Vedeu::Toggle.
     #
     # @param cursor [Cursor]
     # @return [Toggle]

data/lib/vedeu/debug.rb

@@ -9,18 +9,53 @@ module Vedeu
   def self.debug(filename = 'profile.html', &block)
     require 'ruby-prof'
 
+    RubyProf.measure_mode = RubyProf::WALL_TIME
+    # RubyProf.measure_mode = RubyProf::PROCESS_TIME
+    # RubyProf.measure_mode = RubyProf::CPU_TIME
+    # RubyProf.measure_mode = RubyProf::ALLOCATIONS
+    # RubyProf.measure_mode = RubyProf::MEMORY
+    # RubyProf.measure_mode = RubyProf::GC_TIME
+    # RubyProf.measure_mode = RubyProf::GC_RUNS
+
     RubyProf.start
 
     yield
 
     result = RubyProf.stop
-    result.eliminate_methods!([/^Array/, /^Hash/])
+    result.eliminate_methods!([
+      /^Array/,
+      /^Hash/,
+    ])
 
     File.open('/tmp/' + filename, 'w') do |file|
       RubyProf::CallStackPrinter.new(result).print(file)
 
       # Used with QTCacheGrind to analyse performance.
       # RubyProf::CallTreePrinter.new(result).print(file)
+
+      # Creates a flat report in text format
+      # RubyProf::FlatPrinter
+
+      # - same as above but more verbose
+      # RubyProf::FlatPrinterWithLineNumbers
+
+      # - Creates a call graph report in text format
+      # RubyProf::GraphPrinter
+
+      # - Creates a call graph report in HTML (separate files per thread)
+      # RubyProf::GraphHtmlPrinter
+
+      # - Creates a call graph report in GraphViz's DOT format which can be converted to an image
+      # RubyProf::DotPrinter
+
+      # - Creates a call tree report compatible with KCachegrind.
+      # RubyProf::CallTreePrinter
+
+      # - Creates a HTML visualization of the Ruby stack
+      # RubyProf::CallStackPrinter
+
+      # - Uses the other printers to create several reports in one profiling run
+      # RubyProf::MultiPrinter
     end
   end
   # :nocov:

data/lib/vedeu/distributed/client.rb

@@ -18,6 +18,8 @@ module Vedeu
         new(uri).connect
       end
 
+      # Returns a new instance of Vedeu::Distributed::Client.
+      #
       # @param uri [Vedeu::Distributed::Uri|String]
       # @return [Client]
       def initialize(uri)

data/lib/vedeu/distributed/subprocess.rb

@@ -12,6 +12,8 @@ module Vedeu
       new(application).execute!
     end
 
+    # Returns a new instance of Vedeu::Subprocess.
+    #
     # @param application [Vedeu::TestApplication]
     # @return [Vedeu::Subprocess]
     def initialize(application)

data/lib/vedeu/distributed/test_application.rb

@@ -53,6 +53,8 @@ module Vedeu
       new(attributes).build(&block)
     end
 
+    # Returns a new instance of Vedeu::TestApplication.
+    #
     # @param attributes [Hash<Symbol => String>]
     # @option attributes borders [String]
     # @option attributes configuration [String]

data/lib/vedeu/distributed/uri.rb

@@ -15,6 +15,8 @@ module Vedeu
       # @return [Fixnum|String]
       attr_reader :port
 
+      # Returns a new instance of Vedeu::Distributed::Uri.
+      #
       # @param host [String] Hostname or IP address.
       # @param port [Fixnum|String]
       # @return [Uri]

data/lib/vedeu/events/event.rb

@@ -110,7 +110,7 @@ module Vedeu
       Vedeu::Trigger.trigger(name, *args)
     end
 
-    # Returns a new instance of Event.
+    # Returns a new instance of Vedeu::Event.
     #
     # @param (see Vedeu::Event.bind)
     # @return [Event]

data/lib/vedeu/events/trigger.rb

@@ -18,6 +18,8 @@ module Vedeu
       new(name, *args).trigger
     end
 
+    # Returns a new instance of Vedeu::Trigger.
+    #
     # @param (see .trigger)
     # @return [Vedeu::Trigger]
     def initialize(name, *args)

data/lib/vedeu/geometry/all.rb

@@ -1,5 +1,4 @@
 require 'vedeu/geometry/area'
-require 'vedeu/geometry/bounding_area'
 require 'vedeu/geometry/canvas'
 require 'vedeu/geometry/centre'
 require 'vedeu/geometry/content'

data/lib/vedeu/geometry/area.rb

@@ -44,6 +44,8 @@ module Vedeu
       new(y: y, yn: yn, x: x, xn: xn)
     end
 
+    # Returns a new instance of Vedeu::Area.
+    #
     # @param y [Fixnum]
     # @param yn [Fixnum]
     # @param x [Fixnum]
@@ -149,6 +151,26 @@ module Vedeu
       x - offset
     end
 
+    # @return [Vedeu::Position]
+    def top_left
+      Vedeu::Position[y, x]
+    end
+
+    # @return [Vedeu::Position]
+    def bottom_left
+      Vedeu::Position[yn, x]
+    end
+
+    # @return [Vedeu::Position]
+    def top_right
+      Vedeu::Position[y, xn]
+    end
+
+    # @return [Vedeu::Position]
+    def bottom_right
+      Vedeu::Position[yn, xn]
+    end
+
     private
 
   end # Area

data/lib/vedeu/geometry/centre.rb

@@ -27,6 +27,8 @@ module Vedeu
       new({ v: v, vn: vn }).centre
     end
 
+    # Returns a new instance of Vedeu::Centre.
+    #
     # @param attributes [Hash<Symbol => Fixnum>]
     # @option attributes v [Fixnum] The starting coordinate value.
     # @option attributes vn [Fixnum] The ending coordinate value.

data/lib/vedeu/geometry/content.rb

@@ -17,6 +17,8 @@ module Vedeu
       :x,
       :y
 
+    # Returns a new instance of Vedeu::Content.
+    #
     # @param interface [Vedeu::Interface]
     # @return [Vedeu::Content]
     def initialize(interface)

data/lib/vedeu/geometry/coordinate.rb

@@ -20,6 +20,8 @@ module Vedeu
     # @return [Fixnum]
     attr_reader :y
 
+    # Returns a new instance of Vedeu::Coordinate.
+    #
     # @param height [Fixnum]
     # @param width [Fixnum]
     # @param x [Fixnum]

data/lib/vedeu/geometry/dimension.rb

@@ -10,6 +10,8 @@ module Vedeu
       new(attributes).pair
     end
 
+    # Returns a new instance of Vedeu::Dimension.
+    #
     # @param attributes [Hash<Symbol => Fixnum, NilClass>]
     # @option attributes d [Fixnum|NilClass] The starting value (y or x).
     # @option attributes dn [Fixnum|NilClass] The ending value (yn or xn).

data/lib/vedeu/geometry/geometry.rb

@@ -32,7 +32,8 @@ module Vedeu
     extend Forwardable
     include Vedeu::Model
 
-    def_delegators :area, :north,
+    def_delegators :area,
+      :north,
       :east,
       :south,
       :west,
@@ -45,7 +46,11 @@ module Vedeu
       :yn,
       :x,
       :height,
-      :width
+      :width,
+      :top_left,
+      :top_right,
+      :bottom_left,
+      :bottom_right
 
     # @!attribute [rw] centred
     # @return [Boolean]
@@ -83,7 +88,7 @@ module Vedeu
     # @return [Fixnum]
     attr_writer :yn
 
-    # Returns a new instance of Geometry.
+    # Returns a new instance of Vedeu::Geometry.
     #
     # @param attributes [Hash]
     # @option attributes centred [Boolean]

data/lib/vedeu/geometry/grid.rb

@@ -31,6 +31,8 @@ module Vedeu
       new(value).columns
     end
 
+    # Returns a new instance of Vedeu::Grid.
+    #
     # @param value [Fixnum]
     # @return [Grid]
     def initialize(value)

data/lib/vedeu/geometry/index_position.rb

@@ -13,6 +13,27 @@ module Vedeu
       new(iy, ix, oy, ox).[]
     end
 
+    # @param name [String] The name of the interface.
+    # @param iy [Fixnum]
+    # @param ix [Fixnum]
+    # @return [Vedeu::Position]
+    def self.from_interface(name, iy, ix)
+      if Vedeu.interfaces.registered?(name)
+        interface = Vedeu.interfaces.find(name)
+        oy        = interface.border.by
+        ox        = interface.border.bx
+
+      else
+        oy = 1
+        ox = 1
+
+      end
+
+      new(iy, ix, oy, ox).[]
+    end
+
+    # Returns a new instance of Vedeu::IndexPosition.
+    #
     # @param iy [Fixnum]
     # @param ix [Fixnum]
     # @param oy [Fixnum]

data/lib/vedeu/geometry/limit.rb

@@ -9,6 +9,8 @@ module Vedeu
       new(v, vn, max, min).apply
     end
 
+    # Returns a new instance of Vedeu::Limit.
+    #
     # @param v [Fixnum]
     # @param vn [Fixnum]
     # @param max [Fixnum]

data/lib/vedeu/geometry/position.rb

@@ -38,7 +38,7 @@ module Vedeu
       end
     end
 
-    # Initializes a new instance of Position.
+    # Initializes a new instance of Vedeu::Position.
     #
     # @param y [Fixnum] The row/line position.
     # @param x [Fixnum] The column/character position.

data/lib/vedeu/geometry/position_index.rb

@@ -20,6 +20,8 @@ module Vedeu
       new(y, x).[]
     end
 
+    # Returns a new instance of Vedeu::PositionIndex.
+    #
     # @param y [Fixnum]
     # @param x [Fixnum]
     # @return [Vedeu::PositionIndex]

data/lib/vedeu/geometry/position_validator.rb

@@ -45,6 +45,8 @@ module Vedeu
       new(interface, x, y).validate
     end
 
+    # Returns a new instance of Vedeu::PositionValidator.
+    #
     # @param interface [Interface]
     # @param x [Fixnum]
     # @param y [Fixnum]

data/lib/vedeu/input/input.rb

@@ -13,7 +13,7 @@ module Vedeu
       new(reader).capture
     end
 
-    # Returns a new instance of Input.
+    # Returns a new instance of Vedeu::Input.
     #
     # @param reader [IO] An object that responds to `#read`. Typically, this is
     #   Vedeu::Terminal.

data/lib/vedeu/input/key.rb

@@ -4,7 +4,7 @@ module Vedeu
   #
   class Key
 
-    # Returns a new instance of Key.
+    # Returns a new instance of Vedeu::Key.
     #
     # @param input [String|Symbol]
     # @param block [Proc]

data/lib/vedeu/input/keymap.rb

@@ -18,6 +18,8 @@ module Vedeu
     # @return [String]
     attr_accessor :name
 
+    # Returns a new instance of Vedeu::Keymap.
+    #
     # @param attributes [Hash]
     # @option attributes name [String] The name of the keymap.
     # @option attributes keys [Vedeu::Keys|Array] A collection of keys.