vedeu 0.6.69 → 0.6.70

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a0211b4a6e94bd7926f99ff108861471ea89615
-  data.tar.gz: e083d41fa583f3ef357d1814c17fe7bd36357e46
+  metadata.gz: 6a215a258800fb64a1c3493c3a504bfed883fc54
+  data.tar.gz: f6b96d7ba7a7e0b5aca5e55ef211a3afc5b50f4c
 SHA512:
-  metadata.gz: f8c146bd737d56df2eda77f1b8d762b80da4f2321240df7d29d4a48904276b7932d5bf11b59e773822e7456c895c3ed84277075bd4d1ed6ad1b7fb03acb333f7
-  data.tar.gz: d46ceb3d84bc7782854ca90aebc88bef0b9c397a120b5c23514e6827f860bea645f41fe751b61160acd0d9409dc7cfa0244dc163185374e339b32207eaa32629
+  metadata.gz: 901c2cce80b9ec3468c80c538e8c6b8b372cea78db1fae7b04cfee13bf0b457ade911966d1086b0bec8b4f04d9270ec08d0a7b9e1296aac56011fbd1e56d5b69
+  data.tar.gz: b747cefb06613a45addde327f5183c13cfa8d7dc0cfcf2367b6b75ebf65bd581d4f595f2bbd329ebc47739a8fe86d8e2befd9111c0e74d7af4b4d3a25ae4e8fa

data/docs/api.md

@@ -285,6 +285,10 @@ Repository method. Access registered events.
 
 @todo Add more documentation.
 
+### Vedeu.focus?
+
+@todo Add more documentation.
+
 ### Vedeu.focus_by_name
 
 @todo Add more documentation.

data/lib/vedeu/all.rb

@@ -1,23 +1,21 @@
+require 'vedeu/common'
+require 'vedeu/error'
 require 'vedeu/version'
 
-require 'vedeu/common'
 require 'vedeu/colours/all'
 require 'vedeu/configuration/all'
 require 'vedeu/repositories/all'
 require 'vedeu/events/all'
 require 'vedeu/esc/all'
 require 'vedeu/logging/all'
-require 'vedeu/error'
 require 'vedeu/runtime/all'
 require 'vedeu/terminal/all'
-
-require 'vedeu/models/toggleable'
-
+require 'vedeu/presentation/all'
 require 'vedeu/output/all'
-
+require 'vedeu/renderers/all'
 require 'vedeu/esc/all'
 require 'vedeu/null/all'
-require 'vedeu/models/views/all'
+require 'vedeu/views/all'
 require 'vedeu/models/all'
 require 'vedeu/application/all'
 require 'vedeu/cursors/all'

data/lib/vedeu/borders/all.rb

@@ -39,3 +39,4 @@ require 'vedeu/borders/border'
 require 'vedeu/borders/dsl'
 require 'vedeu/borders/refresh'
 require 'vedeu/borders/repository'
+require 'vedeu/borders/set_attribute'

data/lib/vedeu/borders/repository.rb

@@ -35,16 +35,12 @@ module Vedeu
 
   # See {file:docs/borders.md#label-3A_set_border_caption_}
   Vedeu.bind(:_set_border_caption_) do |name, caption|
-    border = Vedeu.borders.by_name(name)
-    border.caption = caption
-    border.store { Vedeu.trigger(:_refresh_border_, name) }
+    Vedeu::Borders::SetAttribute.update(name, :title, caption)
   end
 
   # See {file:docs/borders.md#label-3A_set_border_title_}
   Vedeu.bind(:_set_border_title_) do |name, title|
-    border = Vedeu.borders.by_name(name)
-    border.title = title
-    border.store { Vedeu.trigger(:_refresh_border_, name) }
+    Vedeu::Borders::SetAttribute.update(name, :caption, title)
   end
 
   # :nocov:

data/lib/vedeu/borders/set_attribute.rb

@@ -0,0 +1,71 @@
+module Vedeu
+
+  module Borders
+
+    # @api private
+    #
+    class SetAttribute
+
+      include Vedeu::Common
+
+      # @param name [String|Symbol]
+      # @param attribute [Symbol]
+      # @param value [String]
+      # @return [Vedeu::Borders::Border]
+      def self.update(name, attribute, value)
+        new(name, attribute, value).update
+      end
+
+      # @param name [String|Symbol]
+      # @param attribute [Symbol]
+      # @param value [String]
+      # @return [Vedeu::Borders::SetAttribute]
+      def initialize(name, attribute, value)
+        @name      = name
+        @attribute = attribute
+        @value     = value
+      end
+
+      # @return [Vedeu::Borders::Border]
+      def update
+        border.send(attribute, value)
+        border.store { Vedeu.trigger(:_refresh_border_, name) }
+        border
+      end
+
+      protected
+
+      # @!attribute [r] name
+      # @return [String|Symbol] The name of the border.
+      attr_reader :name
+
+      private
+
+      # @return [Symbol]
+      def attribute
+        fail Vedeu::Error::MissingRequired if @attribute.nil?
+
+        (@attribute.to_s + '=').to_sym
+      end
+
+      # @return [Vedeu::Borders::Border]
+      def border
+        @_border ||= Vedeu.borders.by_name(name)
+      end
+
+      # @return [String] The new value.
+      def value
+        if present?(@value)
+          @value
+
+        else
+          ''
+
+        end
+      end
+
+    end # SetAttribute
+
+  end # Borders
+
+end # Vedeu

data/lib/vedeu/buffers/buffer.rb

@@ -97,7 +97,7 @@ module Vedeu
           previous.cursor_visible?
 
         else
-          Vedeu.interfaces.by_name(name).cursor_visible?
+          interface.cursor_visible?
 
         end
       end
@@ -186,6 +186,11 @@ module Vedeu
         }
       end
 
+      # @return [Vedeu::Interfaces::Interface]
+      def interface
+        Vedeu.interfaces.by_name(name)
+      end
+
       # Return a boolean indicating content was swapped between
       # buffers.
       #

data/lib/vedeu/buffers/refresh.rb

@@ -46,7 +46,7 @@ module Vedeu
       def by_name
         Vedeu.trigger(:_clear_view_content_, name)
 
-        Vedeu.buffers.by_name(name).render
+        buffer.render
 
         Vedeu.trigger(:_refresh_border_, name) unless content_only?
       end
@@ -57,6 +57,11 @@ module Vedeu
       # @return [String|Symbol]
       attr_reader :name
 
+      # @return [Vedeu::Buffers::Buffer]
+      def buffer
+        Vedeu.buffers.by_name(name)
+      end
+
       # @return [Boolean]
       def content_only?
         options[:content_only] == true

data/lib/vedeu/common.rb

@@ -44,7 +44,8 @@ module Vedeu
     # @return [Boolean]
     def present?(variable)
       return true if variable.is_a?(Fixnum)
-      return true unless variable.nil? || variable.empty?
+      return true unless variable.nil? ||
+                         (variable.respond_to?(:empty?) && variable.empty?)
 
       false
     end

data/lib/vedeu/configuration/configuration.rb

@@ -358,7 +358,7 @@ module Vedeu
 
   end # Configuration
 
-  require 'vedeu/output/renderers/all'
+  require 'vedeu/renderers/all'
 
   Vedeu::Configuration.configure({})
 

data/lib/vedeu/cursors/all.rb

@@ -15,6 +15,7 @@ module Vedeu
 
 end # Vedeu
 
+require 'vedeu/cursors/move'
 require 'vedeu/cursors/coordinate'
 require 'vedeu/cursors/cursor'
 require 'vedeu/cursors/dsl'

data/lib/vedeu/cursors/cursor.rb

@@ -101,7 +101,7 @@ module Vedeu
         @oy += 1
         @y = coordinate(oy, :y).y
 
-        store_and_refresh
+        self
       end
 
       # Moves the cursor left by one column.
@@ -114,7 +114,7 @@ module Vedeu
         @ox -= 1
         @x = coordinate(ox, :x).x
 
-        store_and_refresh
+        self
       end
 
       # Moves the cursor to the top left of the named interface.
@@ -142,7 +142,7 @@ module Vedeu
         @ox += 1
         @x = coordinate(ox, :x).x
 
-        store_and_refresh
+        self
       end
 
       # Moves the cursor up by one row.
@@ -155,7 +155,7 @@ module Vedeu
         @oy -= 1
         @y = coordinate(oy, :y).y
 
-        store_and_refresh
+        self
       end
 
       # Renders the cursor.
@@ -297,17 +297,6 @@ module Vedeu
         attributes.merge!(x: new_x, y: new_y, ox: new_ox, oy: new_oy)
       end
 
-      # Store the cursor and refresh the cursor.
-      #
-      # @return [void]
-      def store_and_refresh
-        store
-
-        Vedeu.trigger(:_refresh_cursor_, name)
-
-        self
-      end
-
       # Returns the escape sequence for setting the visibility of the
       # cursor.
       #
@@ -348,30 +337,22 @@ module Vedeu
 
   # See {file:docs/cursors.md}
   Vedeu.bind(:_cursor_left_) do |name|
-    Vedeu.cursors.by_name(name).tap do |cursor|
-      cursor.move_left if cursor.visible?
-    end
+    Vedeu::Cursors::Move.move(name, :move_left)
   end
 
   # See {file:docs/cursors.md}
   Vedeu.bind(:_cursor_down_) do |name|
-    Vedeu.cursors.by_name(name).tap do |cursor|
-      cursor.move_down if cursor.visible?
-    end
+    Vedeu::Cursors::Move.move(name, :move_down)
   end
 
   # See {file:docs/cursors.md}
   Vedeu.bind(:_cursor_up_) do |name|
-    Vedeu.cursors.by_name(name).tap do |cursor|
-      cursor.move_up if cursor.visible?
-    end
+    Vedeu::Cursors::Move.move(name, :move_up)
   end
 
   # See {file:docs/cursors.md}
   Vedeu.bind(:_cursor_right_) do |name|
-    Vedeu.cursors.by_name(name).tap do |cursor|
-      cursor.move_right if cursor.visible?
-    end
+    Vedeu::Cursors::Move.move(name, :move_right)
   end
 
   # See {file:docs/cursors.md}

data/lib/vedeu/cursors/move.rb

@@ -0,0 +1,69 @@
+module Vedeu
+
+  module Cursors
+
+    # @api private
+    #
+    class Move
+
+      extend Forwardable
+
+      def_delegators :cursor,
+                     :visible?
+
+      # @param name [String|Symbol]
+      # @param direction [Symbol]
+      # @return [Vedeu::Cursors::Cursor]
+      def self.move(name, direction)
+        new(name, direction).move
+      end
+
+      # @param name [String|Symbol]
+      # @param direction [Symbol]
+      # @return [Vedeu::Cursors::Move]
+      def initialize(name, direction)
+        @name      = name
+        @direction = direction
+      end
+
+      # @return [NilClass|Vedeu::Cursors::Cursor]
+      def move
+        return nil unless visible? && valid_direction?
+
+        cursor.public_send(direction)
+        cursor.store { Vedeu.trigger(:_refresh_cursor_, name) }
+        cursor
+      end
+
+      protected
+
+      # @!attribute [r] name
+      # @return [String|Symbol] The name of the cursor.
+      attr_reader :name
+
+      # @!attribute [r] direction
+      # @return [Symbol] The direction to move the cursor.
+      attr_reader :direction
+
+      private
+
+      # @return [Vedeu::Cursors::Cursor]
+      def cursor
+        @_cursor ||= Vedeu.cursors.by_name(name)
+      end
+
+      # @return [Boolean]
+      def valid_direction?
+        [
+          :move_down,
+          :move_left,
+          :move_right,
+          :move_up,
+        ].include?(direction)
+      end
+
+    end # Move
+
+  end # Cursors
+
+end # Vedeu

data/lib/vedeu/cursors/repository.rb

@@ -15,7 +15,7 @@ module Vedeu
         # @example
         #   Vedeu.cursor
         #
-        # @return [Vedeu::Cursors::Cursor]
+        # @return [NilClass|Vedeu::Cursors::Cursor]
         def cursor
           cursors.by_name
         end

data/lib/vedeu/dsl/all.rb

@@ -14,6 +14,8 @@ require 'vedeu/dsl/use'
 require 'vedeu/dsl/presentation'
 require 'vedeu/dsl/composition'
 require 'vedeu/dsl/text'
+require 'vedeu/dsl/lines'
 require 'vedeu/dsl/line'
+require 'vedeu/dsl/streams'
 require 'vedeu/dsl/stream'
 require 'vedeu/dsl/view'

data/lib/vedeu/dsl/composition.rb

@@ -135,7 +135,12 @@ module Vedeu
       # @param name [String|Symbol] The name of the interface.
       # @return [Hash<Symbol => void>]
       def existing_attributes(name)
-        Vedeu.interfaces.by_name(name).attributes
+        interface(name).attributes
+      end
+
+      # @return [Vedeu::Interfaces::Interface]
+      def interface(name)
+        Vedeu.interfaces.by_name(name)
       end
 
     end # Composition

data/lib/vedeu/dsl/lines.rb

@@ -0,0 +1,21 @@
+module Vedeu
+
+  module DSL
+
+    class Lines
+
+      # @raise [Vedeu::Error::RequiresBlock]
+      # @return [Vedeu::Views::Lines]
+      # def lines(&block)
+      #   fail Vedeu::Error::RequiresBlock unless block_given?
+
+      #   client = eval('self', block.binding)
+
+      #   # Vedeu::Models::Lines.new
+      # end
+
+    end # Lines
+
+  end # DSL
+
+end # Vedeu

data/lib/vedeu/dsl/streams.rb

@@ -0,0 +1,21 @@
+module Vedeu
+
+  module DSL
+
+    class Streams
+
+      # @raise [Vedeu::Error::RequiresBlock]
+      # @return [Vedeu::Views::Streams]
+      # def streams(&block)
+      #   fail Vedeu::Error::RequiresBlock unless block_given?
+
+      #   client = eval('self', block.binding)
+
+      #   # Vedeu::Models::Stream.new
+      # end
+
+    end # Streams
+
+  end # DSL
+
+end # Vedeu

data/lib/vedeu/groups/clear.rb

@@ -45,9 +45,14 @@ module Vedeu
 
       private
 
+      # @return [Vedeu::Groups::Group]
+      def group
+        Vedeu.groups.by_name(name)
+      end
+
       # @return [Array<String>]
       def members
-        Vedeu.groups.by_name(name).members
+        group.members
       end
 
     end # Clear

data/lib/vedeu/groups/refresh.rb

@@ -63,7 +63,12 @@ module Vedeu
 
       # @return [String|Symbol]
       def group_from_interface
-        @_group_name ||= Vedeu.interfaces.by_name(name).group
+        @_group_name ||= interface.group
+      end
+
+      # @return [Vedeu::Interfaces::Interface]
+      def interface
+        Vedeu.interfaces.by_name(name)
       end
 
     end # Refresh

data/lib/vedeu/input/capture.rb

@@ -60,7 +60,7 @@ module Vedeu
           elsif Vedeu::Input::Mapper.registered?(@key, name)
             Vedeu.trigger(:_keypress_, @key, name)
 
-          elsif Vedeu.interfaces.by_name(name).editable?
+          elsif interface.editable?
             Vedeu.trigger(:_editor_, @key)
 
           elsif @key.nil?
@@ -98,6 +98,11 @@ module Vedeu
         keys
       end
 
+      # @return [Vedeu::Interfaces::Interface]
+      def interface
+        Vedeu.interfaces.by_name(name)
+      end
+
       # Returns a boolean indicating whether a mouse click was
       # received.
       #

data/lib/vedeu/interfaces/clear.rb

@@ -88,7 +88,7 @@ module Vedeu
 
       # @return [Vedeu::Colours::Colour]
       def colour
-        @colour ||= Vedeu.interfaces.by_name(name).colour
+        @colour ||= interface.colour
       end
 
       # @return [Boolean]
@@ -127,6 +127,11 @@ module Vedeu
                     end
       end
 
+      # @return [Vedeu::Interfaces::Interface]
+      def interface
+        Vedeu.interfaces.by_name(name)
+      end
+
       # @return [Hash<Symbol => Boolean>]
       def options
         defaults.merge!(@options)

data/lib/vedeu/interfaces/interface.rb

@@ -11,10 +11,6 @@ module Vedeu
       include Vedeu::Presentation
       include Vedeu::Toggleable
 
-      # @!attribute [r] attributes
-      # @return [Hash]
-      attr_reader :attributes
-
       # @!attribute [rw] client
       # @return [Fixnum|Float]
       attr_accessor :client
@@ -65,13 +61,29 @@ module Vedeu
       # @option attributes zindex [Fixnum]
       # @return [Vedeu::Interfaces::Interface]
       def initialize(attributes = {})
-        @attributes = defaults.merge!(attributes)
-
-        @attributes.each do |key, value|
+        defaults.merge!(attributes).each do |key, value|
           instance_variable_set("@#{key}", value)
         end
       end
 
+      # @return [Hash<Symbol => void>]
+      def attributes
+        {
+          client:         client,
+          colour:         colour,
+          cursor_visible: cursor_visible,
+          delay:          delay,
+          editable:       editable,
+          group:          group,
+          name:           name,
+          parent:         parent,
+          repository:     repository,
+          style:          style,
+          visible:        visible,
+          zindex:         zindex,
+        }
+      end
+
       # Returns a DSL instance responsible for defining the DSL
       # methods of this model.
       #
@@ -128,7 +140,7 @@ module Vedeu
 
       # The default values for a new instance of this class.
       #
-      # @return [Hash]
+      # @return [Hash<Symbol => void>]
       def defaults
         {
           client:         nil,

data/lib/vedeu/models/all.rb

@@ -8,6 +8,7 @@ module Vedeu
 
 end # Vedeu
 
+require 'vedeu/models/toggleable'
 require 'vedeu/models/cell'
 require 'vedeu/models/escape'
 require 'vedeu/models/focus'