vedeu 0.6.20 → 0.6.21

data/lib/vedeu/menus/menu.rb

@@ -38,19 +38,19 @@ module Vedeu
       # items for your users to select; and provide interactivity
       # within your application.
       #
-      # @param name [String]
+      # @param name [String|Symbol]
       # @param block [Proc] A set of attributes which define the
       #   features of the menu. See {Vedeu::Menus::DSL#items} and
       #   {Vedeu::Menus::DSL#name}.
       #
       # @example
-      #   Vedeu.menu 'my_interface' do
+      #   Vedeu.menu :my_interface do
       #     items [:item_1, :item_2, :item_3]
       #     # ...
       #   end
       #
       #   Vedeu.menu do
-      #     name 'menus_must_have_a_name'
+      #     name :menus_must_have_a_name
       #     items Track.all_my_favourites
       #     # ...
       #   end
@@ -67,7 +67,7 @@ module Vedeu
       #
       # @param attributes [Hash]
       # @option attributes collection [Array]
-      # @option attributes name [String]
+      # @option attributes name [String|Symbol]
       # @option attributes current [Fixnum]
       # @option attributes selected [Fixnum|NilClass]
       # @return [Vedeu::Menus::Menu]
@@ -228,4 +228,8 @@ module Vedeu
 
   end # Menus
 
+  # @!method menu
+  #   @see Vedeu::Menus::Menu.menu
+  def_delegators Vedeu::Menus::Menu, :menu
+
 end # Vedeu

data/lib/vedeu/menus/null.rb

@@ -9,7 +9,7 @@ module Vedeu
       # Returns an instance of the Vedeu::Menus::Null class.
       #
       # @param attributes [Hash<Symbol => void>]
-      # @option attributes name [String|NilClass]
+      # @option attributes name [String|Symbol|NilClass]
       # @return [Vedeu::Menus::Null]
       def initialize(attributes = {})
         @attributes = attributes

data/lib/vedeu/menus/repository.rb

@@ -15,4 +15,13 @@ module Vedeu
 
   end # Menus
 
+  # Manipulate the repository of menus.
+  #
+  # @example
+  #   Vedeu.menus
+  #
+  # @!method menus
+  # @return [Vedeu::Menus::Repository]
+  def_delegators Vedeu::Menus::Repository, :menus
+
 end # Vedeu

data/lib/vedeu/models/cell.rb

@@ -34,6 +34,11 @@ module Vedeu
         end
       end
 
+      # @return [Boolean]
+      def cell?
+        true
+      end
+
       # An object is equal when its values are the same.
       #
       # @param other [Vedeu::Models::Cell]

data/lib/vedeu/models/escape.rb

@@ -23,6 +23,11 @@ module Vedeu
         end
       end
 
+      # @return [Boolean]
+      def cell?
+        false
+      end
+
       # @return [NilClass]
       def null
         nil

data/lib/vedeu/models/focus.rb

@@ -23,7 +23,7 @@ module Vedeu
       # Add an interface name to the focus list unless it is already
       # registered.
       #
-      # @param name [String] The name of the interface.
+      # @param name [String|Symbol] The name of the interface.
       # @param focus [Boolean] When true, prepends the interface name
       #   to the collection, making that interface the currently
       #   focussed interface.
@@ -55,10 +55,12 @@ module Vedeu
       #   Vedeu.trigger(:_focus_by_name_, name)
       #   Vedeu.focus_by_name('name')
       #
-      # @param name [String] The interface to focus; must be defined.
+      # @param name [String|Symbol] The interface to focus; must be
+      #   defined.
       # @raise [Vedeu::Error::ModelNotFound] When the interface cannot
       #   be found.
-      # @return [String] The name of the interface now in focus.
+      # @return [String|Symbol] The name of the interface now in
+      #   focus.
       def by_name(name)
         unless registered?(name)
           fail Vedeu::Error::ModelNotFound,
@@ -89,7 +91,7 @@ module Vedeu
       # @example
       #   Vedeu.focussed?(name)
       #
-      # @param name [String]
+      # @param name [String|Symbol]
       # @return [Boolean]
       def current?(name)
         current == name
@@ -186,7 +188,7 @@ module Vedeu
       # Returns a boolean indicating whether the named model is
       # registered.
       #
-      # @param name [String]
+      # @param name [String|Symbol]
       # @return [Boolean]
       def registered?(name)
         return false if empty?
@@ -242,4 +244,17 @@ module Vedeu
 
   end # Models
 
+  # @!method focus
+  #   @see Vedeu::Models::Focus#focus
+  # @!method focus_by_name
+  #   @see Vedeu::Models::Focus#focus_by_name
+  # @!method focussed?
+  #   @see Vedeu::Models::Focus#focussed?
+  # @!method focus_next
+  #   @see Vedeu::Models::Focus#focus_next
+  # @!method focus_previous
+  #   @see Vedeu::Models::Focus#focus_previous
+  def_delegators Vedeu::Models::Focus, :focus, :focus_by_name, :focussed?,
+                 :focus_next, :focus_previous
+
 end # Vedeu

data/lib/vedeu/models/interface.rb

@@ -46,7 +46,7 @@ module Vedeu
       # @option attributes colour [Vedeu::Colours::Colour]
       # @option attributes delay [Float]
       # @option attributes group [String]
-      # @option attributes name [String]
+      # @option attributes name [String|Symbol]
       # @option attributes parent [Vedeu::Views::Composition]
       # @option attributes repository [Vedeu::Models::Interfaces]
       # @option attributes style [Vedeu::Presentation::Style]
@@ -112,4 +112,13 @@ module Vedeu
 
   end # Models
 
+  # @!method hide_interface
+  #   @see Vedeu::Toggleable::ClassMethods#hide
+  # @!method show_interface
+  #   @see Vedeu::Toggleable::ClassMethods#show
+  # @!method toggle_interface
+  #   @see Vedeu::Toggleable::ClassMethods#toggle
+  def_delegators Vedeu::Models::Interface, :hide_interface, :show_interface,
+                 :toggle_interface
+
 end # Vedeu

data/lib/vedeu/models/interfaces.rb

@@ -32,4 +32,13 @@ module Vedeu
 
   end # Models
 
+  # Manipulate the repository of interfaces.
+  #
+  # @example
+  #   Vedeu.interfaces
+  #
+  # @!method interfaces
+  # @return [Vedeu::Models::Interfaces]
+  def_delegators Vedeu::Models::Interfaces, :interfaces
+
 end # Vedeu

data/lib/vedeu/models/toggleable.rb

@@ -48,7 +48,12 @@ module Vedeu
 
       # Hides the model.
       #
-      # @param name [String]
+      # @example
+      #   Vedeu.hide_cursor(name)
+      #   Vedeu.hide_group(name)
+      #   Vedeu.hide_interface(name)
+      #
+      # @param name [String|Symbol]
       # @return [void]
       def hide(name = nil)
         model_by_name(repository, name).hide
@@ -59,7 +64,12 @@ module Vedeu
 
       # Shows the model.
       #
-      # @param name [String]
+      # @example
+      #   Vedeu.show_cursor(name)
+      #   Vedeu.show_group(name)
+      #   Vedeu.show_interface(name)
+      #
+      # @param name [String|Symbol]
       # @return [void]
       def show(name = nil)
         model_by_name(repository, name).show
@@ -70,7 +80,12 @@ module Vedeu
 
       # Toggles the visibility of the model.
       #
-      # @param name [String]
+      # @example
+      #   Vedeu.toggle_cursor(name)
+      #   Vedeu.toggle_group(name)
+      #   Vedeu.toggle_interface(name)
+      #
+      # @param name [String|Symbol]
       # @return [void]
       def toggle(name = nil)
         model_by_name(repository, name).toggle
@@ -83,7 +98,7 @@ module Vedeu
 
       # Fetch the model by name.
       #
-      # @param name [String]
+      # @param name [String|Symbol]
       # @param klass [void] The repository of the model.
       # @return [void]
       def model_by_name(klass, name = nil)

data/lib/vedeu/models/views/char.rb

@@ -56,6 +56,11 @@ module Vedeu
         @value      = @attributes[:value]
       end
 
+      # @return [Boolean]
+      def cell?
+        false
+      end
+
       # When {Vedeu::Output::Viewport#show} has less lines that
       # required to fill the visible area of the interface, it creates
       # a line that contains a single {Vedeu::Views::Char} containing
@@ -159,7 +164,7 @@ module Vedeu
         }
       end
 
-      # @return [Has<Symbol => Fixnum>]
+      # @return [Hash<Symbol => Fixnum>]
       def position_to_hash
         {
           y: y,

data/lib/vedeu/models/views/html_char.rb

@@ -9,10 +9,7 @@ module Vedeu
 
       include Vedeu::Common
 
-      # @param char [Vedeu::Views::Char]
-      # @param options [Hash<Symbol => String>]
-      # @option options start_tag [String]
-      # @option options end_tag [String]
+      # @param (see #initialize)
       # @return [String]
       def self.render(char, options = {})
         new(char, options).render

data/lib/vedeu/models/views/line.rb

@@ -90,7 +90,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/views/view.rb

@@ -50,7 +50,7 @@ module Vedeu
       # @option attributes client [Vedeu::Client]
       # @option attributes colour [Vedeu::Colours::Colour]
       # @option attributes value [Vedeu::Views::Lines]
-      # @option attributes name [String]
+      # @option attributes name [String|Symbol]
       # @option attributes parent [Vedeu::Views::Composition]
       # @option attributes style [Vedeu::Presentation::Style]
       # @option attributes zindex [Fixnum]

data/lib/vedeu/null/generic.rb

@@ -11,25 +11,36 @@ module Vedeu
       attr_reader :attributes
 
       # @!attribute [r] name
-      # @return [String]
+      # @return [String|Symbol]
       attr_reader :name
 
       # Returns an instance of the Vedeu::Null::Generic class.
       #
       # @param attributes [Hash<Symbol => void>]
-      # @option attributes name [String|NilClass]
+      # @option attributes name [String|Symbol|NilClass]
       # @return [Vedeu::Null::Generic]
       def initialize(attributes = {})
         @attributes = attributes
         @name       = @attributes[:name]
       end
 
+      # @return [FalseClass]
+      def falsy
+        false
+      end
+      alias_method :centred, :falsy
+      alias_method :enabled?, :falsy
+      alias_method :maximise, :falsy
+      alias_method :maximised?, :falsy
+      alias_method :unmaximise, :falsy
+
       # @return [NilClass]
       def null(*)
         nil
       end
       alias_method :add,           :null
       alias_method :bottom_item,   :null
+      alias_method :clear,         :null
       alias_method :colour,        :null
       alias_method :current_item,  :null
       alias_method :deselect_item, :null
@@ -39,6 +50,7 @@ module Vedeu
       alias_method :next_item,     :null
       alias_method :parent,        :null
       alias_method :prev_item,     :null
+      alias_method :render,        :null
       alias_method :select_item,   :null
       alias_method :selected_item, :null
       alias_method :show,          :null

data/lib/vedeu/null/interface.rb

@@ -15,7 +15,7 @@ module Vedeu
       # Returns a new instance of Vedeu::Null::Interface.
       #
       # @param attributes [Hash<Symbol => void>]
-      # @option attributes name [String]
+      # @option attributes name [String|Symbol]
       # @return [Vedeu::Null::Interface]
       def initialize(attributes = {})
         @attributes = attributes

data/lib/vedeu/null/view.rb

@@ -11,7 +11,7 @@ module Vedeu
       # Returns a new instance of Vedeu::Null::View.
       #
       # @param attributes [Hash<Symbol => void>]
-      # @option attributes name [String]
+      # @option attributes name [String|Symbol]
       # @return [Vedeu::Null::View]
       def initialize(attributes = {})
         @attributes = attributes

data/lib/vedeu/output/clear/interface.rb

@@ -25,7 +25,7 @@ module Vedeu
 
       # Return a new instance of Vedeu::Clear::Interface.
       #
-      # @param name [String] The name of the interface to clear.
+      # @param name [String|Symbol] The name of the interface to clear.
       # @return [Vedeu::Clear::Interface]
       def initialize(name)
         @name = name
@@ -82,4 +82,8 @@ module Vedeu
 
   end # Clear
 
+  # @!method clear_by_name
+  #   @see Vedeu::Clear::Interface.render
+  def_delegators Vedeu::Clear::Interface, :clear_by_name
+
 end # Vedeu

data/lib/vedeu/output/compressor.rb

@@ -9,7 +9,9 @@ module Vedeu
     #
     class Compressor
 
-      # @param output [Array<Array<Vedeu::Views::Char>>]
+      include Vedeu::Common
+
+      # @param (see #initialize)
       # @return [String]
       def self.render(output)
         new(output).render
@@ -44,9 +46,9 @@ module Vedeu
 
       # @return [Array]
       def content
-        return [] if output.nil? || output.empty?
+        return [] if absent?(output)
 
-        output.content.delete_if { |cell| cell.is_a?(Vedeu::Models::Cell) }
+        @content ||= output.content.delete_if(&:cell?)
       end
 
       # @return [String]
@@ -69,7 +71,9 @@ module Vedeu
       def uncompress
         out = ''
 
-        content.each { |cell| out << cell.to_s }
+        content.each do |cell|
+          out << cell.to_s
+        end
 
         out
       end

data/lib/vedeu/output/direct.rb

@@ -6,9 +6,7 @@ module Vedeu
     #
     class Direct
 
-      # @param value [String]
-      # @param x [Fixnum]
-      # @param y [Fixnum]
+      # @param (see #initialize)
       # @return [String]
       def self.write(value:, x:, y:)
         new(value: value, x: x, y: y).write
@@ -28,6 +26,8 @@ module Vedeu
 
       # @return [String]
       def write
+        Vedeu.log(type:    :output,
+                  message: 'Directly writing output to terminal.')
         Vedeu::Terminal.output(output)
 
         output
@@ -51,7 +51,7 @@ module Vedeu
 
       # @return [String]
       def output
-        (Array(position) + Array(value)).join
+        @output ||= (Array(position) + Array(value)).join
       end
 
       # @return [String]

data/lib/vedeu/output/presentation/all.rb

@@ -0,0 +1,15 @@
+require 'vedeu/output/presentation/colour'
+require 'vedeu/output/presentation/styles'
+require 'vedeu/output/presentation/style'
+require 'vedeu/output/presentation/presentation'
+
+module Vedeu
+
+  # This module allows the sharing of presentation concerns between
+  # the models: Interface, View, Line and Stream.
+  #
+  module Presentation
+
+  end # Presentation
+
+end # Vedeu