vedeu 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 95a7c03c3ccd065d3c66d1c5a176e66f6e7d04f4
-  data.tar.gz: 2ddf794a56b73ddb0e2cd468ee8d4482baaa347c
+  metadata.gz: 522afbcf7e2a24c1059b645ad484d1508f665c89
+  data.tar.gz: 33f8e2f388e083fc3f2e18638ced642692047b62
 SHA512:
-  metadata.gz: 7fc84b1f48e9267a3f8fc5d282cc259764bc61a85dd77bee1f0bad19fb0b499e9e0102b7872d119405c4e25052afa50aa16c811ba72552615de827f69399d324
-  data.tar.gz: 391a08f45037963856371ebbcfb82ed17494d4f4b9e93f0df76068dd1c354e7796c5679d02246e643ac526bdf5d8fc577b26cab5de475b0f0634ccf3d3efb5d8
+  metadata.gz: 03e7507a1f364b8c5c6c236a98a7a48ca5a86ac2985f1f3856af4ba9e314eafa546e3a02c7e861182a665c14d69e290fc8f87496c32da1bdb2718dece6cd8c33
+  data.tar.gz: 96249c16c65ca1b929e2d0b20a1e1330902338fc3cf04fede864918760bbcefc41b511634c14318624ba750a0669b3d6c865ae69891696fd47685c04578208d5

data/examples/borders_app.rb

@@ -20,8 +20,6 @@ class VedeuBordersApp
   bind(:_initialize_) { Vedeu.trigger(:_refresh_) }
 
   interface 'default_border' do
-    border do
-    end
     geometry do
       x      2
       y      2
@@ -38,26 +36,20 @@ class VedeuBordersApp
       height 3
       width  7
     end
-    colour  foreground: '#ffffff', background: '#00ff00'
+    colour  foreground: '#ffffff', background: '#ff0000'
   end
 
   interface 'no_top' do
-    border do
-      show_top false
-    end
     geometry do
       x      20
       y      2
       height 3
       width  7
     end
-    colour  foreground: '#ffffff', background: '#0000ff'
+    colour  foreground: '#000000', background: '#ffff00'
   end
 
   interface 'no_bottom' do
-    border do
-      show_bottom false
-    end
     geometry do
       x      29
       y      2
@@ -68,9 +60,6 @@ class VedeuBordersApp
   end
 
   interface 'no_left' do
-    border do
-      show_left false
-    end
     geometry do
       x      38
       y      2
@@ -81,9 +70,6 @@ class VedeuBordersApp
   end
 
   interface 'no_right' do
-    border do
-      show_right false
-    end
     geometry do
       x      47
       y      2
@@ -94,12 +80,6 @@ class VedeuBordersApp
   end
 
   interface 'custom_corners' do
-    border do
-      top_right    'B'
-      top_left     'A'
-      bottom_right 'D'
-      bottom_left  'C'
-    end
     geometry do
       x      2
       y      7
@@ -110,25 +90,16 @@ class VedeuBordersApp
   end
 
   interface 'custom_horizontal_and_vertical' do
-    border do
-      horizontal '*'
-      vertical   '$'
-    end
     geometry do
       x      11
       y      7
       height 3
       width  7
     end
-    colour  foreground: '#ffffff', background: '#00ff00'
+    colour  foreground: '#ffffff', background: '#ff0000'
   end
 
   interface 'only_top' do
-    border do
-      show_right  false
-      show_bottom false
-      show_left   false
-    end
     geometry do
       x      20
       y      7
@@ -139,54 +110,36 @@ class VedeuBordersApp
   end
 
   interface 'only_bottom' do
-    border do
-      show_top   false
-      show_right false
-      show_left  false
-    end
     geometry do
       x      29
       y      7
       height 3
       width  7
     end
-    colour  foreground: '#000000', background: '#ffff00'
+    colour  foreground: '#ffffff', background: '#0000ff'
   end
 
   interface 'only_left' do
-    border do
-      show_top    false
-      show_bottom false
-      show_right  false
-    end
     geometry do
       x      38
       y      7
       height 3
       width  7
     end
-    colour  foreground: '#000000', background: '#ffff00'
+    colour  foreground: '#ffffff', background: '#0000ff'
   end
 
   interface 'only_right' do
-    border do
-      show_top    false
-      show_bottom false
-      show_left   false
-    end
     geometry do
       x      47
       y      7
       height 3
       width  7
     end
-    colour  foreground: '#000000', background: '#ffff00'
+    colour  foreground: '#ffffff', background: '#0000ff'
   end
 
   interface 'custom_colour' do
-    border do
-      colour foreground: '#ffff00', background: '#0000ff'
-    end
     geometry do
       x      2
       y      12
@@ -197,9 +150,6 @@ class VedeuBordersApp
   end
 
   interface 'negative' do
-    border do
-      style 'negative'
-    end
     geometry do
       x      11
       y      12
@@ -210,8 +160,14 @@ class VedeuBordersApp
     style  'normal'
   end
 
+  keymap '_global_' do
+    key('r') { Vedeu.trigger(:_refresh_) }
+  end
+
   renders do
     view('default_border') do
+      border do
+      end
       lines do
         line 'on'
       end
@@ -222,67 +178,115 @@ class VedeuBordersApp
       end
     end
     view('no_top') do
+      border do
+        show_top false
+      end
       lines do
         line 'no t'
       end
     end
     view('no_bottom') do
+      border do
+        show_bottom false
+      end
       lines do
         line 'no b'
       end
     end
     view('no_left') do
+      border do
+        show_left false
+      end
       lines do
         line 'no l'
       end
     end
     view('no_right') do
+      border do
+        show_right false
+      end
       lines do
         line 'no r'
       end
     end
     view('custom_corners') do
+      border do
+        top_right    'B'
+        top_left     'A'
+        bottom_right 'D'
+        bottom_left  'C'
+      end
       lines do
         line 'chars'
         line '1'
       end
     end
     view('custom_horizontal_and_vertical') do
+      border do
+        horizontal '*'
+        vertical   '$'
+      end
       lines do
         line 'chars'
         line '2'
       end
     end
     view('only_top') do
+      border do
+        show_right  false
+        show_bottom false
+        show_left   false
+      end
       lines do
         line 'only'
         line 't'
       end
     end
     view('only_bottom') do
+      border do
+        show_top   false
+        show_right false
+        show_left  false
+      end
       lines do
         line 'only'
         line 'b'
       end
     end
     view('only_left') do
+      border do
+        show_top    false
+        show_bottom false
+        show_right  false
+      end
       lines do
         line 'only'
         line 'l'
       end
     end
     view('only_right') do
+      border do
+        show_top    false
+        show_bottom false
+        show_left   false
+      end
       lines do
         line 'only'
         line 'r'
       end
     end
     view('custom_colour') do
+      border do
+        colour foreground: '#ffff00', background: '#0000ff'
+      end
       lines do
         line 'color'
       end
     end
     view('negative') do
+      border do
+        style 'negative'
+      end
       lines do
         line 'style'
       end

data/lib/vedeu/buffers/all.rb

@@ -3,6 +3,7 @@ require 'vedeu/buffers/display_buffer'
 
 module Vedeu
 
+  # @return [Vedeu::Repository]
   def self.buffers
     @_buffers ||= Vedeu::Repository.new(Vedeu::Buffer)
   end

data/lib/vedeu/configuration/configuration.rb

@@ -1,13 +1,11 @@
 require 'singleton'
 
-require 'vedeu/support/common'
 require 'vedeu/configuration/api'
 require 'vedeu/configuration/cli'
 
 module Vedeu
 
   # Namespace for the API configuration and CLI configuration classes.
-  #
   module Config
   end
 
@@ -26,8 +24,6 @@ module Vedeu
 
     class << self
 
-      include Vedeu::Common
-
       # Configure Vedeu with sensible defaults. If the client application sets
       # options, override the defaults with those, and if command-line arguments
       # are provided at application invocation, override any options with the
@@ -127,6 +123,8 @@ module Vedeu
         }
       end
 
+      # @param value []
+      # @return []
       def options=(value)
         instance.options = value
       end

data/lib/vedeu/cursor/all.rb

@@ -5,17 +5,14 @@ require 'vedeu/cursor/toggle_cursor'
 
 module Vedeu
 
-  class Cursors < Repository
-  end
-
   extend self
 
-  # @return [Cursors]
+  # @return [Vedeu::Repository]
   def cursors
-    @_cursors ||= Vedeu::Cursors.new(Vedeu::Cursor)
+    @_cursors ||= Vedeu::Repository.new(Vedeu::Cursor)
   end
 
-  # @return [Cursor|NilClass]
+  # @return [Vedeu::Cursor|NilClass]
   def cursor
     cursors.current
   end

data/lib/vedeu/cursor/cursor.rb

@@ -22,12 +22,13 @@ module Vedeu
     # Provides a new instance of Cursor.
     #
     # @param attributes [Hash]
-    # @option attributes name [String] The name of the interface this cursor belongs to.
+    # @option attributes name [String] The name of the interface this cursor
+    #   belongs to.
     # @option attributes ox [Fixnum] The offset x coordinate.
     # @option attributes oy [Fixnum] The offset y coordinate.
     # @option attributes repository [Vedeu::Repository]
-    # @option attributes state [Boolean|Symbol] The visibility of the cursor, either +true+
-    #   or +false+, +:hide+ or +:show+.
+    # @option attributes state [Boolean|Symbol] The visibility of the cursor,
+    #   either +true+ or +false+, +:hide+ or +:show+.
     # @option attributes x [Fixnum] The terminal x coordinate for the cursor.
     # @option attributes y [Fixnum] The terminal y coordinate for the cursor.
     #

data/lib/vedeu/cursor/move_cursor.rb

@@ -1,10 +1,10 @@
 require 'vedeu/cursor/cursor'
+require 'vedeu/support/coordinate'
 require 'vedeu/support/position_validator'
 
 module Vedeu
 
   # Adjusts the position of the cursor.
-  #
   class MoveCursor
 
     extend Forwardable
@@ -95,8 +95,8 @@ module Vedeu
     # @return [PositionValidator]
     def validator
       @validator ||= Vedeu::PositionValidator.validate(interface,
-                                   coordinate.x_position(ox),
-                                   coordinate.y_position(oy))
+                                                      coordinate.x_position(ox),
+                                                      coordinate.y_position(oy))
     end
 
     # @return [Fixnum]
@@ -115,7 +115,10 @@ module Vedeu
 
     # @return [Coordinate]
     def coordinate
-      @coordinate ||= Coordinate.new(bordered_height, bordered_width, left, top)
+      @coordinate ||= Vedeu::Coordinate.new(bordered_height,
+                                            bordered_width,
+                                            left,
+                                            top)
     end
 
     # @return [Fixnum]

data/lib/vedeu/cursor/toggle_cursor.rb

@@ -1,7 +1,6 @@
 module Vedeu
 
   # Adjusts the visibility of the cursor.
-  #
   class ToggleCursor
 
     # @param cursor [Cursor]

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

@@ -9,6 +9,13 @@ module Vedeu
     # Allows customisation for the border's sides and corners; a custom
     # foreground and background, style, and whether a particular side should be
     # drawn or not.
+    #
+    # @example
+    #   Vedeu.renders do
+    #     view 'border_demo' do
+    #       border do
+    #         # ...
+    #
     class Border
 
       include Vedeu::DSL
@@ -23,6 +30,16 @@ module Vedeu
         @client = client
       end
 
+      # Set the character to be used to draw the bottom left corner of the
+      # border.
+      #
+      # @example
+      #   Vedeu.renders do
+      #     view 'border_demo' do
+      #       border do
+      #         bottom_left '+'
+      #         # ...
+      #
       # @param char [String] Character to be used as the bottom left border
       #   character.
       # @return [String]
@@ -30,6 +47,16 @@ module Vedeu
         model.attributes[:bottom_left] = char
       end
 
+      # Set the character to be used to draw the bottom right corner of the
+      # border.
+      #
+      # @example
+      #   Vedeu.renders do
+      #     view 'border_demo' do
+      #       border do
+      #         bottom_right '+'
+      #         # ...
+      #
       # @param char [String] Character to be used as the bottom right border
       #   character.
       # @return [String]
@@ -37,6 +64,15 @@ module Vedeu
         model.attributes[:bottom_right] = char
       end
 
+      # Set the character to be used to draw a horizontal part of the border.
+      #
+      # @example
+      #   Vedeu.renders do
+      #     view 'border_demo' do
+      #       border do
+      #         horizontal '-'
+      #         # ...
+      #
       # @param char [String] Character to be used as the horizontal border
       #   character.
       # @return [String]
@@ -44,6 +80,15 @@ module Vedeu
         model.attributes[:horizontal] = char
       end
 
+      # Enable/disable the bottom border.
+      #
+      # @example
+      #   Vedeu.renders do
+      #     view 'border_demo' do
+      #       border do
+      #         show_bottom false
+      #         # ...
+      #
       # @param boolean [Boolean] All values evaluate as true except nil and
       #   false.
       # @return [Boolean]
@@ -51,6 +96,15 @@ module Vedeu
         model.attributes[:show_bottom] = !!boolean
       end
 
+      # Enable/disable the left border.
+      #
+      # @example
+      #   Vedeu.renders do
+      #     view 'border_demo' do
+      #       border do
+      #         show_left false
+      #         # ...
+      #
       # @param boolean [Boolean] All values evaluate as true except nil and
       #   false.
       # @return [Boolean]
@@ -58,6 +112,15 @@ module Vedeu
         model.attributes[:show_left] = !!boolean
       end
 
+      # Enable/disable the right border.
+      #
+      # @example
+      #   Vedeu.renders do
+      #     view 'border_demo' do
+      #       border do
+      #         show_right false
+      #         # ...
+      #
       # @param boolean [Boolean] All values evaluate as true except nil and
       #   false.
       # @return [Boolean]
@@ -65,6 +128,15 @@ module Vedeu
         model.attributes[:show_right] = !!boolean
       end
 
+      # Enable/disable the top border.
+      #
+      # @example
+      #   Vedeu.renders do
+      #     view 'border_demo' do
+      #       border do
+      #         show_top false
+      #         # ...
+      #
       # @param boolean [Boolean] All values evaluate as true except nil and
       #   false.
       # @return [Boolean]
@@ -72,6 +144,15 @@ module Vedeu
         model.attributes[:show_top] = !!boolean
       end
 
+      # Set the character to be used to draw the top left corner of the border.
+      #
+      # @example
+      #   Vedeu.renders do
+      #     view 'border_demo' do
+      #       border do
+      #         top_left '+'
+      #         # ...
+      #
       # @param char [String] Character to be used as the top left border
       #   character.
       # @return [String]
@@ -79,6 +160,15 @@ module Vedeu
         model.attributes[:top_left] = char
       end
 
+      # Set the character to be used to draw the top right corner of the border.
+      #
+      # @example
+      #   Vedeu.renders do
+      #     view 'border_demo' do
+      #       border do
+      #         top_right '+'
+      #         # ...
+      #
       # @param char [String] Character to be used as the top right border
       #   character.
       # @return [String]
@@ -86,6 +176,15 @@ module Vedeu
         model.attributes[:top_right] = char
       end
 
+      # Set the character to be used to draw a vertical part of the border.
+      #
+      # @example
+      #   Vedeu.renders do
+      #     view 'border_demo' do
+      #       border do
+      #         vertical '|'
+      #         # ...
+      #
       # @param char [String] Character to be used as the vertical border
       #   character.
       # @return [String]

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

@@ -1,3 +1,4 @@
+require 'vedeu/models/geometry'
 require 'vedeu/dsl/shared/use'
 
 module Vedeu

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

@@ -58,7 +58,7 @@ module Vedeu
           end
 
           unless model.key_defined?(value)
-            model.add(Vedeu::Key.define(value, &block))
+            model.add(model.member.build(value, &block))
           end
         end
       end

data/lib/vedeu/dsl/composition.rb

@@ -1,3 +1,5 @@
+require 'vedeu/models/view/interface'
+
 module Vedeu
 
   module DSL
@@ -34,16 +36,16 @@ module Vedeu
       def view(name = '', &block)
         fail InvalidSyntax, 'block not given' unless block_given?
 
-        child_model = if Vedeu.interfaces.registered?(name)
-          interface = Vedeu.interfaces.find(name)
-          child.build(attributes.merge(interface.attributes), &block)
+        new_member = if Vedeu.interfaces.registered?(name)
+          existing_member = Vedeu.interfaces.find(name)
+          model.member.build(attributes.merge(existing_member.attributes), &block)
 
         else
-          child.build(attributes.merge({ name: name }), &block)
+          model.member.build(attributes.merge({ name: name }), &block)
 
         end
 
-        model.add(child_model)
+        model.add(new_member)
       end
 
       private
@@ -58,13 +60,6 @@ module Vedeu
         }
       end
 
-      # Return the class name for the children on this model.
-      #
-      # @return [Class]
-      def child
-        Vedeu::Interface
-      end
-
     end # Composition
 
   end # DSL

data/lib/vedeu/dsl/interface.rb

@@ -1,3 +1,9 @@
+require 'vedeu/cursor/cursor'
+require 'vedeu/models/focus'
+require 'vedeu/models/geometry'
+require 'vedeu/models/group'
+require 'vedeu/models/view/line'
+require 'vedeu/output/border'
 require 'vedeu/support/common'
 
 module Vedeu
@@ -165,7 +171,7 @@ module Vedeu
       def lines(&block)
         fail InvalidSyntax, 'block not given' unless block_given?
 
-        model.add(child.build(attributes, &block))
+        model.add(model.member.build(attributes, &block))
       end
       alias_method :line, :lines
 
@@ -196,13 +202,6 @@ module Vedeu
         }
       end
 
-      # Return the class name for the children on this model.
-      #
-      # @return [Class]
-      def child
-        Vedeu::Line
-      end
-
     end # Interface
 
   end # DSL