vedeu 0.6.4 → 0.6.5

data/lib/vedeu/bindings/system.rb

@@ -146,7 +146,7 @@ module Vedeu
       #   Vedeu.trigger(:_maximise_, name)
       #
       # @return [TrueClass]
-      # @see Vedeu::Geometry#maximise
+      # @see Vedeu::Geometry::Geometry#maximise
       def maximise!
         Vedeu.bind(:_maximise_) do |name|
           Vedeu.geometries.by_name(name).maximise
@@ -184,7 +184,7 @@ module Vedeu
       #   Vedeu.trigger(:_unmaximise_, name)
       #
       # @return [TrueClass]
-      # @see Vedeu::Geometry#unmaximise
+      # @see Vedeu::Geometry::Geometry#unmaximise
       def unmaximise!
         Vedeu.bind(:_unmaximise_) do |name|
           Vedeu.geometries.by_name(name).unmaximise

data/lib/vedeu/bindings/visibility.rb

@@ -52,7 +52,7 @@ module Vedeu
       # @return [TrueClass]
       def hide_cursor!
         Vedeu.bind(:_hide_cursor_) do |name|
-          Vedeu::Cursor.hide_cursor(name)
+          Vedeu::Cursors::Cursor.hide_cursor(name)
         end
 
         Vedeu.bind_alias(:_cursor_hide_, :_hide_cursor_)
@@ -87,7 +87,7 @@ module Vedeu
       # @return [TrueClass]
       def show_cursor!
         Vedeu.bind(:_show_cursor_) do |name|
-          Vedeu::Cursor.show_cursor(name)
+          Vedeu::Cursors::Cursor.show_cursor(name)
         end
 
         Vedeu.bind_alias(:_cursor_show_, :_show_cursor_)
@@ -120,7 +120,7 @@ module Vedeu
       # @return [TrueClass]
       def toggle_cursor!
         Vedeu.bind(:_toggle_cursor_) do |name|
-          Vedeu::Cursor.toggle_cursor(name)
+          Vedeu::Cursors::Cursor.toggle_cursor(name)
         end
       end
 

data/lib/vedeu/borders/all.rb

@@ -0,0 +1,13 @@
+module Vedeu
+
+  module Borders
+
+  end # Borders
+
+end # Vedeu
+
+require 'vedeu/borders/border'
+require 'vedeu/borders/dsl'
+require 'vedeu/borders/null'
+require 'vedeu/borders/render'
+require 'vedeu/borders/repository'

data/lib/vedeu/borders/border.rb

@@ -1,209 +1,216 @@
 module Vedeu
 
-  # Provides the mechanism to decorate an interface with a border on all edges,
-  # or specific edges. The characters which are used for the border parts (e.g.
-  # the corners, verticals and horizontals) can be customised as can the colours
-  # and styles.
-  #
-  # @note Refer to UTF-8 U+2500 to U+257F for border characters. More details
-  #   can be found at: http://en.wikipedia.org/wiki/Box-drawing_character
-  #
-  class Border
-
-    extend Forwardable
-    include Vedeu::Common
-    include Vedeu::Model
-    include Vedeu::Presentation
-
-    def_delegators :geometry,
-                   :x,
-                   :xn,
-                   :y,
-                   :yn
-
-    def_delegators :interface, :visible?
-
-    # @!attribute [rw] attributes
-    # @return [Hash]
-    attr_accessor :attributes
-
-    # @!attribute [rw] bottom_left
-    # @return [String]
-    attr_accessor :bottom_left
-
-    # @!attribute [rw] bottom_right
-    # @return [String]
-    attr_accessor :bottom_right
-
-    # @!attribute [rw] horizontal
-    # @return [String]
-    attr_accessor :horizontal
-
-    # @!attribute [rw] show_bottom
-    # @return [Boolean]
-    attr_accessor :show_bottom
-    alias_method :bottom?, :show_bottom
-
-    # @!attribute [rw] show_left
-    # @return [Boolean]
-    attr_accessor :show_left
-    alias_method :left?, :show_left
-
-    # @!attribute [rw] show_right
-    # @return [Boolean]
-    attr_accessor :show_right
-    alias_method :right?, :show_right
-
-    # @!attribute [rw] show_top
-    # @return [Boolean]
-    attr_accessor :show_top
-    alias_method :top?, :show_top
-
-    # @!attribute [rw] caption
-    # @return [String]
-    attr_accessor :caption
-
-    # @!attribute [rw] title
-    # @return [String]
-    attr_accessor :title
-
-    # @!attribute [rw] top_left
-    # @return [String]
-    attr_accessor :top_left
-
-    # @!attribute [rw] top_right
-    # @return [String]
-    attr_accessor :top_right
-
-    # @!attribute [rw] vertical
-    # @return [String]
-    attr_accessor :vertical
-
-    # @!attribute [r] name
-    # @return [String]
-    attr_reader :name
-
-    # @!attribute [r] enabled
-    # @return [Boolean]
-    attr_accessor :enabled
-    alias_method :enabled?, :enabled
-
-    # Returns a new instance of Vedeu::Border.
-    #
-    # @param attributes [Hash]
-    # @option attributes bottom_left [String] The bottom left border character.
-    # @option attributes bottom_right [String] The bottom right border
-    #   character.
-    # @option attributes colour [Hash]
-    # @option attributes enabled [Boolean] Indicate whether the border is to be
-    #   shown for this interface.
-    # @option attributes horizontal [String] The horizontal border character.
-    # @option attributes name [String] The name of the interface to which this
-    #   border relates.
-    # @option attributes style [Vedeu::Style]
-    # @option attributes show_bottom [Boolean] Indicate whether the bottom
-    #   border is to be shown.
-    # @option attributes show_left [Boolean] Indicate whether the left border
-    #   is to be shown.
-    # @option attributes show_right [Boolean] Indicate whether the right border
-    #   is to be shown.
-    # @option attributes show_top [Boolean] Indicate whether the top border is
-    #   to be shown.
-    # @option attributes title [String] An optional title for when the top
-    #   border is to be shown.
-    # @option attributes caption [String] An optional caption for when the
-    #   bottom border is to be shown.
-    # @option attributes top_left [String] The top left border character.
-    # @option attributes top_right [String] The top right border character.
-    # @option attributes vertical [String] The vertical border character.
-    # @return [Vedeu::Border]
-    def initialize(attributes = {})
-      @attributes = defaults.merge!(attributes)
-
-      @attributes.each { |key, value| instance_variable_set("@#{key}", value) }
-    end
-
-    # @return [Fixnum]
-    def bx
-      (enabled? && left?) ? x + 1 : x
-    end
-
-    # @return [Fixnum]
-    def bxn
-      (enabled? && right?) ? xn - 1 : xn
-    end
-
-    # @return [Fixnum]
-    def by
-      (enabled? && top?) ? y + 1 : y
-    end
-
-    # @return [Fixnum]
-    def byn
-      (enabled? && bottom?) ? yn - 1 : yn
-    end
-
-    # Returns the width of the interface determined by whether a left, right,
-    # both or neither borders are shown.
-    #
-    # @return [Fixnum]
-    def width
-      (bx..bxn).size
-    end
+  module Borders
 
-    # Returns the height of the interface determined by whether a top, bottom,
-    # both or neither borders are shown.
+    # Provides the mechanism to decorate an interface with a border on all
+    # edges, or specific edges. The characters which are used for the border
+    # parts (e.g. the corners, verticals and horizontals) can be customised as
+    # can the colours and styles.
     #
-    # @return [Fixnum]
-    def height
-      (by..byn).size
-    end
-
-    # @return [Array<Array<Vedeu::Views::Char>>]
-    def render
-      Vedeu::RenderBorder.with(self)
-    end
-
-    private
-
-    # @return [Vedeu::Geometry]
-    def geometry
-      Vedeu.geometries.by_name(name)
-    end
-
-    # @return [Vedeu::Interface]
-    def interface
-      @interface ||= Vedeu.interfaces.by_name(name)
-    end
-    alias_method :parent, :interface
-
-    # The default values for a new instance of this class.
+    # @note Refer to UTF-8 U+2500 to U+257F for border characters. More details
+    #   can be found at: http://en.wikipedia.org/wiki/Box-drawing_character
     #
-    # @return [Hash]
-    # @see Vedeu::EscapeSequences::Borders
-    def defaults
-      {
-        bottom_left:  Vedeu::EscapeSequences::Borders.bottom_left,
-        bottom_right: Vedeu::EscapeSequences::Borders.bottom_right,
-        caption:      '',
-        client:       nil,
-        colour:       nil,
-        enabled:      false,
-        horizontal:   Vedeu::EscapeSequences::Borders.horizontal,
-        name:         '',
-        repository:   Vedeu.borders,
-        show_bottom:  true,
-        show_left:    true,
-        show_right:   true,
-        show_top:     true,
-        style:        nil,
-        title:        '',
-        top_left:     Vedeu::EscapeSequences::Borders.top_left,
-        top_right:    Vedeu::EscapeSequences::Borders.top_right,
-        vertical:     Vedeu::EscapeSequences::Borders.vertical,
-      }
-    end
-
-  end # Border
+    class Border
+
+      extend Forwardable
+      include Vedeu::Common
+      include Vedeu::Model
+      include Vedeu::Presentation
+
+      def_delegators :geometry,
+                     :x,
+                     :xn,
+                     :y,
+                     :yn
+
+      def_delegators :interface, :visible?
+
+      # @!attribute [rw] attributes
+      # @return [Hash]
+      attr_accessor :attributes
+
+      # @!attribute [rw] bottom_left
+      # @return [String]
+      attr_accessor :bottom_left
+
+      # @!attribute [rw] bottom_right
+      # @return [String]
+      attr_accessor :bottom_right
+
+      # @!attribute [rw] horizontal
+      # @return [String]
+      attr_accessor :horizontal
+
+      # @!attribute [rw] show_bottom
+      # @return [Boolean]
+      attr_accessor :show_bottom
+      alias_method :bottom?, :show_bottom
+
+      # @!attribute [rw] show_left
+      # @return [Boolean]
+      attr_accessor :show_left
+      alias_method :left?, :show_left
+
+      # @!attribute [rw] show_right
+      # @return [Boolean]
+      attr_accessor :show_right
+      alias_method :right?, :show_right
+
+      # @!attribute [rw] show_top
+      # @return [Boolean]
+      attr_accessor :show_top
+      alias_method :top?, :show_top
+
+      # @!attribute [rw] caption
+      # @return [String]
+      attr_accessor :caption
+
+      # @!attribute [rw] title
+      # @return [String]
+      attr_accessor :title
+
+      # @!attribute [rw] top_left
+      # @return [String]
+      attr_accessor :top_left
+
+      # @!attribute [rw] top_right
+      # @return [String]
+      attr_accessor :top_right
+
+      # @!attribute [rw] vertical
+      # @return [String]
+      attr_accessor :vertical
+
+      # @!attribute [r] name
+      # @return [String]
+      attr_reader :name
+
+      # @!attribute [r] enabled
+      # @return [Boolean]
+      attr_accessor :enabled
+      alias_method :enabled?, :enabled
+
+      # Returns a new instance of Vedeu::Borders::Border.
+      #
+      # @param attributes [Hash]
+      # @option attributes bottom_left [String] The bottom left border
+      #   character.
+      # @option attributes bottom_right [String] The bottom right border
+      #   character.
+      # @option attributes colour [Hash]
+      # @option attributes enabled [Boolean] Indicate whether the border is to
+      #   be shown for this interface.
+      # @option attributes horizontal [String] The horizontal border character.
+      # @option attributes name [String] The name of the interface to which this
+      #   border relates.
+      # @option attributes style [Vedeu::Style]
+      # @option attributes show_bottom [Boolean] Indicate whether the bottom
+      #   border is to be shown.
+      # @option attributes show_left [Boolean] Indicate whether the left border
+      #   is to be shown.
+      # @option attributes show_right [Boolean] Indicate whether the right
+      #   border is to be shown.
+      # @option attributes show_top [Boolean] Indicate whether the top border is
+      #   to be shown.
+      # @option attributes title [String] An optional title for when the top
+      #   border is to be shown.
+      # @option attributes caption [String] An optional caption for when the
+      #   bottom border is to be shown.
+      # @option attributes top_left [String] The top left border character.
+      # @option attributes top_right [String] The top right border character.
+      # @option attributes vertical [String] The vertical border character.
+      # @return [Vedeu::Borders::Border]
+      def initialize(attributes = {})
+        @attributes = defaults.merge!(attributes)
+
+        @attributes.each do |key, value|
+          instance_variable_set("@#{key}", value)
+        end
+      end
+
+      # @return [Fixnum]
+      def bx
+        (enabled? && left?) ? x + 1 : x
+      end
+
+      # @return [Fixnum]
+      def bxn
+        (enabled? && right?) ? xn - 1 : xn
+      end
+
+      # @return [Fixnum]
+      def by
+        (enabled? && top?) ? y + 1 : y
+      end
+
+      # @return [Fixnum]
+      def byn
+        (enabled? && bottom?) ? yn - 1 : yn
+      end
+
+      # Returns the width of the interface determined by whether a left, right,
+      # both or neither borders are shown.
+      #
+      # @return [Fixnum]
+      def width
+        (bx..bxn).size
+      end
+
+      # Returns the height of the interface determined by whether a top, bottom,
+      # both or neither borders are shown.
+      #
+      # @return [Fixnum]
+      def height
+        (by..byn).size
+      end
+
+      # @return [Array<Array<Vedeu::Views::Char>>]
+      def render
+        Vedeu::Borders::Render.with(self)
+      end
+
+      private
+
+      # @return [Vedeu::Geometry::Geometry]
+      def geometry
+        Vedeu.geometries.by_name(name)
+      end
+
+      # @return [Vedeu::Interface]
+      def interface
+        @interface ||= Vedeu.interfaces.by_name(name)
+      end
+      alias_method :parent, :interface
+
+      # The default values for a new instance of this class.
+      #
+      # @return [Hash]
+      # @see Vedeu::EscapeSequences::Borders
+      def defaults
+        {
+          bottom_left:  Vedeu::EscapeSequences::Borders.bottom_left,
+          bottom_right: Vedeu::EscapeSequences::Borders.bottom_right,
+          caption:      '',
+          client:       nil,
+          colour:       nil,
+          enabled:      false,
+          horizontal:   Vedeu::EscapeSequences::Borders.horizontal,
+          name:         '',
+          repository:   Vedeu.borders,
+          show_bottom:  true,
+          show_left:    true,
+          show_right:   true,
+          show_top:     true,
+          style:        nil,
+          title:        '',
+          top_left:     Vedeu::EscapeSequences::Borders.top_left,
+          top_right:    Vedeu::EscapeSequences::Borders.top_right,
+          vertical:     Vedeu::EscapeSequences::Borders.vertical,
+        }
+      end
+
+    end # Border
+
+  end # Borders
 
 end # Vedeu