vedeu 0.6.20 → 0.6.21

data/lib/vedeu/dsl/keymap.rb

@@ -17,7 +17,7 @@ module Vedeu
       # assumed to be global, meaning its action will happen
       # regardless of the interface in focus.
       #
-      #   Vedeu.keymap 'some_interface' do
+      #   Vedeu.keymap :my_interface do
       #     key('s')        { Vedeu.trigger(:save) }
       #     key('h', :left) { Vedeu.trigger(:left) }
       #     key('j', :down) { Vedeu.trigger(:down) }
@@ -29,13 +29,13 @@ module Vedeu
       #
       #   # or...
       #
-      #   Vedeu.keys 'some_interface' do
+      #   Vedeu.keys :my_interface do
       #     # ... some code
       #   end
       #
       #   # or...
       #
-      #   Vedeu.interface 'some_interface' do
+      #   Vedeu.interface :my_interface do
       #     keymap do
       #       # ... some code
       #     end # or...
@@ -45,8 +45,8 @@ module Vedeu
       #     end
       #   end
       #
-      # @param name [String] The name of the interface which this
-      #   keymap relates to.
+      # @param name [String|Symbol] The name of the interface which
+      #   this keymap relates to.
       # @param block [Proc]
       # @raise [Vedeu::Error::RequiresBlock]
       # @return [Vedeu::Input::Keymap]
@@ -58,16 +58,6 @@ module Vedeu
         Vedeu::Input::Keymap.build(name: name, &block).store
       end
 
-      # Returns an instance of DSL::Keymap.
-      #
-      # @param model [Vedeu::Input::Keymap]
-      # @param client [Object]
-      # @return [Vedeu::DSL::Keymap]
-      def initialize(model, client = nil)
-        @model  = model
-        @client = client
-      end
-
       # Define keypress(es) to perform an action.
       #
       # @param values [Array<String>|Array<Symbol>|String|Symbol]
@@ -104,16 +94,16 @@ module Vedeu
       # To only allow certain keys to work with specific interfaces,
       # use the same name as the interface.
       #
-      # When the name '_global_' is used, all keys in the keymap block
+      # When the name :_global_ is used, all keys in the keymap block
       # will be available to all interfaces. Once a key has been
-      # defined in the '_global_' keymap, it cannot be used for a
+      # defined in the :_global_ keymap, it cannot be used for a
       # specific interface.
       #
       #   Vedeu.keymap do
-      #     name 'some_interface'
+      #     name :some_interface
       #   end
       #
-      # @param value [String]
+      # @param value [String|Symbol]
       # @return [String]
       def name(value)
         model.name = value
@@ -124,4 +114,8 @@ module Vedeu
 
   end # DSL
 
+  # @!method keymap
+  #   @see Vedeu::DSL::Keymap.keymap
+  def_delegators Vedeu::DSL::Keymap, :keymap
+
 end # Vedeu

data/lib/vedeu/dsl/line.rb

@@ -5,7 +5,7 @@ module Vedeu
     # Provides methods to be used to define views.
     #
     #   Vedeu.renders do
-    #     view 'my_interface' do
+    #     view :my_interface do
     #       lines do
     #         background '#000000'
     #         foreground '#ffffff'
@@ -36,20 +36,10 @@ module Vedeu
       include Vedeu::DSL::Presentation
       include Vedeu::DSL::Text
 
-      # Returns an instance of DSL::Line.
-      #
-      # @param model [Vedeu::Views::Line]
-      # @param client [Object]
-      # @return [Vedeu::DSL::Line]
-      def initialize(model, client = nil)
-        @model  = model
-        @client = client
-      end
-
       # Specify a single line in a view.
       #
       #   Vedeu.renders do
-      #     view 'my_interface' do
+      #     view :my_interface do
       #       line 'some text...'
       #       # ... some code
       #
@@ -85,7 +75,7 @@ module Vedeu
       # required block.
       #
       #   Vedeu.renders do
-      #     view 'my_interface' do
+      #     view :my_interface do
       #       line do
       #         streams do
       #           # ... some code

data/lib/vedeu/dsl/shared.rb

@@ -10,14 +10,14 @@ module Vedeu
       # Allows the setting of a border for the interface.
       #
       # @example
-      #   Vedeu.interface 'my_interface' do
+      #   Vedeu.interface :my_interface do
       #     border do
       #       # ... see Vedeu::Borders::DSL for DSL methods for
       #       #     borders.
       #     end
       #   end
       #
-      # @param name [String] The name of the interface; this is
+      # @param name [String|Symbol] 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::Borders::DSL.border}.
@@ -39,7 +39,7 @@ module Vedeu
       # Applies the default border to the interface.
       #
       # @example
-      #   Vedeu.interface 'my_interface' do
+      #   Vedeu.interface :my_interface do
       #     border!
       #
       #     # ... some code
@@ -55,14 +55,14 @@ module Vedeu
       # Define the geometry for an interface.
       #
       # @example
-      #   Vedeu.interface 'my_interface' do
+      #   Vedeu.interface :my_interface do
       #     geometry do
       #       # ... see Vedeu::Geometry::DSL for DSL methods for
       #       #     geometries.
       #     end
       #   end
       #
-      # @param name [String] The name of the interface; this is
+      # @param name [String|Symbol] 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::Geometry::DSL.geometry}.

data/lib/vedeu/dsl/stream.rb

@@ -10,16 +10,6 @@ module Vedeu
       include Vedeu::DSL::Presentation
       include Vedeu::DSL::Text
 
-      # Returns an instance of Vedeu::DSL::Stream.
-      #
-      # @param model [Vedeu::Views::Stream]
-      # @param client [Object]
-      # @return [Vedeu::DSL::Stream]
-      def initialize(model, client = nil)
-        @model  = model
-        @client = client
-      end
-
       # @param block [Proc]
       # @raise [Vedeu::Error::RequiresBlock]
       # @return [void]

data/lib/vedeu/dsl/use.rb

@@ -14,10 +14,10 @@ module Vedeu
       # Border, Geometry and Interface.
       #
       # @example
-      #   # Here the character used for 'my_border' is used in
-      #   # 'my_other_border'.
-      #   Vedeu.border 'my_other_border' do
-      #     top_right use('my_border').top_right
+      #   # Here the character used for :my_border is used in
+      #   # :my_other_border.
+      #   Vedeu.border :my_other_border do
+      #     top_right use(:my_border).top_right
       #   end
       #
       # @note
@@ -27,8 +27,8 @@ module Vedeu
       #     exception may be raised, or the request for an attribute
       #     may raise a NoMethodError exception.
       #
-      # @param name [String] The name of the model with the value you
-      #   wish to use.
+      # @param name [String|Symbol] The name of the model with the
+      #   value you wish to use.
       # @raise
       #   [Vedeu::Error::ModelNotFound|Vedeu::Error::NoMethodError]
       #   The model or attribute cannot be found.

data/lib/vedeu/dsl/view.rb

@@ -15,7 +15,7 @@ module Vedeu
     # you use these examples, ensure your terminal is at least 70
     # characters in width and 5 lines in height.)
     #
-    #   Vedeu.interface 'main' do
+    #   Vedeu.interface :main do
     #     geometry do
     #       centred!
     #       height 4
@@ -23,7 +23,7 @@ module Vedeu
     #     end
     #   end
     #
-    #   Vedeu.interface 'title' do
+    #   Vedeu.interface :title do
     #     geometry do
     #       height 1
     #       width  50
@@ -100,7 +100,7 @@ module Vedeu
         # triggered when needed.
         #
         #   Vedeu.renders do
-        #     view 'some_interface' do
+        #     view :some_interface do
         #       line do
         #         stream do
         #           left 'Title goes here', width: 35
@@ -110,7 +110,7 @@ module Vedeu
         #         end
         #       end
         #     end
-        #     view 'other_interface' do
+        #     view :other_interface do
         #       lines do
         #         line 'This is content for the main interface.'
         #         line ''
@@ -123,7 +123,7 @@ module Vedeu
         #   # or...
         #
         #   Vedeu.render do
-        #     view 'my_interface' do
+        #     view :my_interface do
         #       # ... some code
         #     end
         #   end
@@ -153,7 +153,7 @@ module Vedeu
         # here will be rendered to {Vedeu::Terminal#output}.
         #
         #   Vedeu.views do
-        #     view 'some_interface' do
+        #     view :some_interface do
         #       line do
         #         stream do
         #           left 'Title goes here', width: 35
@@ -163,7 +163,7 @@ module Vedeu
         #         end
         #       end
         #     end
-        #     view 'other_interface' do
+        #     view :other_interface do
         #       lines do
         #         line 'This is content for the main interface.'
         #         line ''
@@ -220,28 +220,18 @@ module Vedeu
 
       end # Eigenclass
 
-      # Returns an instance of Vedeu::DSL::View.
-      #
-      # @param model [Vedeu::DSL::View]
-      # @param client [Object]
-      # @return [Vedeu::DSL::View]
-      def initialize(model, client = nil)
-        @model  = model
-        @client = client
-      end
-
       # Specify multiple lines in a view.
       #
       # @param block [Proc]
       #
       # @example
-      #   Vedeu.view 'my_interface' do
+      #   Vedeu.view :my_interface do
       #     lines do
       #       # ... see {Vedeu::DSL::Line} and {Vedeu::DSL::Stream}
       #     end
       #   end
       #
-      #   Vedeu.view 'my_interface' do
+      #   Vedeu.view :my_interface do
       #     line do
       #       # ... see {Vedeu::DSL::Line} and {Vedeu::DSL::Stream}
       #     end
@@ -260,4 +250,12 @@ module Vedeu
 
   end # DSL
 
+  # @!method render
+  #   @see Vedeu::DSL::View.render
+  # @!method renders
+  #   @see Vedeu::DSL::View.renders
+  # @!method views
+  #   @see Vedeu::DSL::View.views
+  def_delegators Vedeu::DSL::View, :renders, :render, :views
+
 end # Vedeu

data/lib/vedeu/editor/cursor.rb

@@ -23,6 +23,10 @@ module Vedeu
       # @return [Fixnum]
       attr_accessor :byn
 
+      # @!attribute [r] name
+      # @return [String|Symbol]
+      attr_reader :name
+
       # @!attribute [rw] ox
       # @return [Fixnum]
       attr_accessor :ox
@@ -49,6 +53,7 @@ module Vedeu
       # @option attributes bx [Fixnum]
       # @option attributes byn [Fixnum]
       # @option attributes bxn [Fixnum]
+      # @option attributes name [String|Symbol]
       # @option attributes oy [Fixnum]
       # @option attributes ox [Fixnum]
       # @return [Vedeu::Editor::Cursor]
@@ -87,6 +92,22 @@ module Vedeu
         self
       end
 
+      # Overwrite the cursor of the same name. This ensure that on
+      # refresh the cursor stays in the correct position for the
+      # document being edited.
+      #
+      # @return [Vedeu::Editor::Cursor]
+      def store
+        Vedeu::Cursors::Cursor.store(name:    name,
+                                     x:       real_x,
+                                     y:       real_y,
+                                     ox:      0,
+                                     oy:      0,
+                                     visible: true)
+
+        self
+      end
+
       # Move the virtual cursor to the origin (0, 0).
       #
       # @return [Vedeu::Editor::Cursor]
@@ -108,8 +129,8 @@ module Vedeu
         self
       end
 
-      # Return the escape sequence for setting the cursor position and
-      # show the cursor.
+      # Return the escape sequence as a string for setting the cursor
+      # position and show the cursor.
       #
       # @return [String]
       def to_s
@@ -149,14 +170,15 @@ module Vedeu
       # @return [Hash<Symbol => Fixnum|NilClass>]
       def defaults
         {
-          y:   0,
-          x:   0,
-          by:  nil,
-          bx:  nil,
-          byn: nil,
-          bxn: nil,
-          ox:  0,
-          oy:  0,
+          y:    0,
+          x:    0,
+          by:   nil,
+          bx:   nil,
+          byn:  nil,
+          bxn:  nil,
+          name: '',
+          ox:   0,
+          oy:   0,
         }
       end
 

data/lib/vedeu/editor/document.rb

@@ -24,6 +24,10 @@ module Vedeu
                      :x,
                      :y
 
+      def_delegators :interface,
+                     :colour,
+                     :style
+
       # @!attribute [r] attributes
       # @return [Hash]
       attr_reader :attributes
@@ -33,14 +37,14 @@ module Vedeu
       attr_accessor :data
 
       # @!attribute [rw] name
-      # @return [String]
+      # @return [String|Symbol]
       attr_accessor :name
 
       # Returns a new instance of Vedeu::Editor::Document.
       #
       # @param attributes [Hash]
       # @option attributes data [String]
-      # @option attributes name [String]
+      # @option attributes name [String|Symbol]
       # @option attributes repository
       #   [Vedeu::Repositories::Repository]
       # @return [Vedeu::Editor::Document]
@@ -54,7 +58,7 @@ module Vedeu
       #
       # @return [void]
       def clear
-        Vedeu::Output::Direct.write(value: clear_output, x: bx, y: by)
+        Vedeu.trigger(:_clear_view_, name)
       end
 
       # Deletes the character from the line where the cursor is
@@ -76,8 +80,6 @@ module Vedeu
         @lines = lines.delete_line(y)
 
         up
-
-        refresh
       end
 
       # Move the virtual cursor down.
@@ -116,8 +118,6 @@ module Vedeu
         @lines = lines.insert_character(character, y, x)
 
         right
-
-        refresh
       end
 
       # Insert an empty line.
@@ -163,7 +163,7 @@ module Vedeu
       def render
         clear
 
-        Vedeu::Output::Direct.write(value: output, x: bx, y: by)
+        Vedeu::Output::Output.render(output)
       end
 
       # Reset the document to the empty state.
@@ -217,24 +217,14 @@ module Vedeu
         @border ||= Vedeu.borders.by_name(name)
       end
 
-      # Return the data needed to clear the area which the document is
-      # using.
-      #
-      # @return [String]
-      def clear_output
-        clear_output = ''
-
-        (by..byn).each do |row|
-          clear_output << "\e[#{row};#{bx}H" + (' ' * width)
-        end
-
-        # reset cursor to top left of document
-        clear_output << "\e[#{by};#{bx}H"
+      # @return [Vedeu::Models::Interface]
+      def interface
+        @interface ||= Vedeu.interfaces.by_name(name)
       end
 
       # Returns the default options/attributes for this class.
       #
-      # @return [Hash]
+      # @return [Hash<Symbol => void|Symbol]
       def defaults
         {
           data:       Vedeu::Editor::Lines.new([Vedeu::Editor::Line.new]),
@@ -247,16 +237,23 @@ module Vedeu
       #
       # @return [String]
       def output
-        output = ''
+        out = []
+
+        visible_lines.each_with_index do |line, y_index|
+          line.chars.each_with_index do |char, x_index|
+            position = [(by + y_index), (bx + x_index)]
 
-        visible.each_with_index do |line, y_index|
-          output << Vedeu::Geometry::Position.new((by + y_index), bx).to_s
-          output << line.to_s
+            out << Vedeu::Views::Char.new(value:    char,
+                                          parent:   interface,
+                                          position: position)
+          end
         end
 
-        output << cursor.to_s
+        out << border.render
+
+        cursor.store
 
-        output
+        out.flatten
       end
 
       # Return a virtual cursor to track the cursor position within
@@ -264,19 +261,20 @@ module Vedeu
       #
       # @return [Vedeu::Editor::Cursor]
       def cursor
-        @cursor ||= Vedeu::Editor::Cursor.new(y:   0,
-                                              x:   0,
-                                              by:  by,
-                                              bx:  bx,
-                                              byn: byn,
-                                              bxn: bxn)
+        @cursor ||= Vedeu::Editor::Cursor.new(y:    0,
+                                              x:    0,
+                                              by:   by,
+                                              bx:   bx,
+                                              byn:  byn,
+                                              bxn:  bxn,
+                                              name: name)
       end
 
       # Return only the visible lines for the document based on the
       # current virtual cursor position.
       #
       # @return [Vedeu::Editor::Lines]
-      def visible
+      def visible_lines
         Vedeu::Editor::Cropper.new(lines:  lines,
                                    height: height,
                                    width:  width,