vedeu 0.4.54 → 0.4.55

data/lib/vedeu/models/interface.rb

@@ -2,7 +2,7 @@ require 'vedeu/models/char'
 require 'vedeu/models/stream'
 require 'vedeu/models/line'
 require 'vedeu/buffers/display_buffer'
-require 'vedeu/support/toggleable'
+require 'vedeu/models/toggleable'
 
 module Vedeu
 

data/lib/vedeu/{repositories/repositories → models}/interfaces.rb

@@ -34,6 +34,6 @@ module Vedeu
 
     repo Vedeu::Interfaces.repository
 
-  end
+  end # Interface
 
 end # Vedeu

data/lib/vedeu/{support → models}/toggleable.rb

@@ -43,7 +43,7 @@ module Vedeu
       # @param name [String]
       # @return [void]
       def hide(name = nil)
-        model_by_name(name, self.repository).hide
+        model_by_name(name, repository).hide
       end
       alias_method :hide_cursor,    :hide
       alias_method :hide_group,     :hide
@@ -52,7 +52,7 @@ module Vedeu
       # @param name [String]
       # @return [void]
       def show(name = nil)
-        model_by_name(name, self.repository).show
+        model_by_name(name, repository).show
       end
       alias_method :show_cursor,    :show
       alias_method :show_group,     :show
@@ -61,7 +61,7 @@ module Vedeu
       # @param name [String]
       # @return [void]
       def toggle(name = nil)
-        model_by_name(name, self.repository).toggle
+        model_by_name(name, repository).toggle
       end
       alias_method :toggle_cursor,    :toggle
       alias_method :toggle_group,     :toggle
@@ -79,7 +79,7 @@ module Vedeu
       # @param name [String]
       # @return [void]
       def model_name(name = nil)
-        return name || Vedeu.focus
+        name || Vedeu.focus
       end
 
     end # ClassMethods

data/lib/vedeu/null/all.rb

@@ -11,8 +11,8 @@ module Vedeu
 
 end
 
-require_relative 'border'
-require_relative 'buffer'
-require_relative 'generic'
-require_relative 'geometry'
-require_relative 'interface'
+require 'vedeu/null/border'
+require 'vedeu/null/buffer'
+require 'vedeu/null/generic'
+require 'vedeu/null/geometry'
+require 'vedeu/null/interface'

data/lib/vedeu/null/border.rb

@@ -14,10 +14,12 @@ module Vedeu
 
       # Returns a new instance of Vedeu::Null::Border.
       #
-      # @param name [String|NilClass]
+      # @param attributes [Hash<Symbol => void>]
+      # @option attributes name [String|NilClass]
       # @return [Vedeu::Null::Border]
-      def initialize(name = nil)
-        @name = name
+      def initialize(attributes = {})
+        @attributes = attributes
+        @name       = @attributes[:name]
       end
 
       # @return [Fixnum]

data/lib/vedeu/null/buffer.rb

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

data/lib/vedeu/null/generic.rb

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

data/lib/vedeu/null/geometry.rb

@@ -35,11 +35,13 @@ module Vedeu
 
       # Returns a new instance of Vedeu::Null::Geometry.
       #
-      # @param name [String|NilClass]
+      # @param attributes [Hash<Symbol => void>]
+      # @option attributes name [String|NilClass]
       # @return [Vedeu::Null::Geometry]
-      def initialize(name = nil)
-        @name      = name
-        @maximised = false
+      def initialize(attributes = {})
+        @attributes = attributes
+        @name       = @attributes[:name]
+        @maximised  = @attributes.fetch(:maximised, false)
       end
 
       # @return [FalseClass]

data/lib/vedeu/null/interface.rb

@@ -15,19 +15,18 @@ module Vedeu
       # @return [String]
       attr_reader :name
 
+      # @!attribute [r] attributes
+      # @return [String]
+      attr_reader :attributes
+
       # Returns a new instance of Vedeu::Null::Interface.
       #
-      # @param name [String]
+      # @param attributes [Hash<Symbol => void>]
+      # @option attributes name [String]
       # @return [Vedeu::Null::Interface]
-      def initialize(name = nil)
-        @name = name
-      end
-
-      # @return [Hash<Symbol => String>]
-      def attributes
-        {
-          name: name,
-        }
+      def initialize(attributes = {})
+        @attributes = attributes
+        @name       = @attributes[:name]
       end
 
       # @return [NilClass]

data/lib/vedeu/output/all.rb

@@ -1,21 +1,21 @@
-require_relative 'esc'
-require_relative 'colour_translator'
-require_relative 'background'
-require_relative 'foreground'
-require_relative 'presentation'
-require_relative 'border'
-require_relative 'colour'
-require_relative 'compressor'
-require_relative 'clear/all'
-require_relative 'style'
-require_relative 'text'
-require_relative 'virtual_buffer'
-require_relative 'html_char'
-require_relative 'refresh_group'
-require_relative 'refresh'
-require_relative 'renderers/all'
-require_relative 'output'
-require_relative 'viewport'
-require_relative 'virtual_terminal'
-require_relative 'wordwrap'
-require_relative 'view_helpers/all'
+require 'vedeu/output/esc'
+require 'vedeu/colours/colour_translator'
+require 'vedeu/colours/background'
+require 'vedeu/colours/foreground'
+require 'vedeu/output/presentation'
+require 'vedeu/output/borders'
+require 'vedeu/output/border'
+require 'vedeu/colours/colour'
+require 'vedeu/output/compressor'
+require 'vedeu/output/clear/all'
+require 'vedeu/output/style'
+require 'vedeu/output/text'
+require 'vedeu/output/virtual_buffer'
+require 'vedeu/output/html_char'
+require 'vedeu/output/refresh_group'
+require 'vedeu/output/refresh'
+require 'vedeu/output/renderers/all'
+require 'vedeu/output/output'
+require 'vedeu/output/viewport'
+require 'vedeu/output/virtual_terminal'
+require 'vedeu/output/wordwrap'

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

@@ -9,5 +9,5 @@ module Vedeu
 
 end # Vedeu
 
-require_relative 'named_group'
-require_relative 'named_interface'
+require 'vedeu/output/clear/named_group'
+require 'vedeu/output/clear/named_interface'

data/lib/vedeu/output/html_char.rb

@@ -1,4 +1,4 @@
-require 'vedeu/support/common'
+require 'vedeu/common'
 
 module Vedeu
 

data/lib/vedeu/output/presentation.rb

@@ -6,6 +6,9 @@ module Vedeu
   # @api private
   module Presentation
 
+    # Returns the background colour for the model, or if it does not exist,
+    # returns the parent background colour, or an empty Vedeu::Background.
+    #
     # @return [Vedeu::Background]
     def background
       @background ||= if colour
@@ -17,6 +20,9 @@ module Vedeu
                       end
     end
 
+    # Allows the setting of the background colour by coercing the given value
+    # into a Vedeu::Background colour.
+    #
     # @return [Vedeu::Background]
     def background=(value)
       self.colour = Vedeu::Colour.coerce(
@@ -38,11 +44,17 @@ module Vedeu
                   end
     end
 
+    # Allows the setting of the model's colour by coercing the given value into
+    # a Vedeu::Colour.
+    #
     # @return [Vedeu::Colour]
     def colour=(value)
       @colour = attributes[:colour] = Vedeu::Colour.coerce(value)
     end
 
+    # Returns the foreground colour for the model, or if it does not exist,
+    # returns the parent foreground colour, or an empty Vedeu::Foreground.
+    #
     # @return [Vedeu::Foreground]
     def foreground
       @foreground ||= if colour
@@ -54,6 +66,9 @@ module Vedeu
                       end
     end
 
+    # Allows the setting of the foreground colour by coercing the given value
+    # into a Vedeu::Foreground colour.
+    #
     # @return [Vedeu::Foreground]
     def foreground=(value)
       self.colour = Vedeu::Colour.coerce(
@@ -61,6 +76,9 @@ module Vedeu
         background: colour.background)
     end
 
+    # Returns the parent background colour if a parent colour is available, or
+    # an empty Vedeu::Background.
+    #
     # @return [Vedeu::Background]
     def parent_background
       if parent_colour
@@ -72,11 +90,16 @@ module Vedeu
       end
     end
 
+    # Returns the parent colour if available or NilClass.
+    #
     # @return [String|NilClass]
     def parent_colour
       parent.colour if parent
     end
 
+    # Returns the parent foreground colour if a parent colour is available, or
+    # an empty Vedeu::Foreground.
+    #
     # @return [Vedeu::Foreground]
     def parent_foreground
       if parent_colour
@@ -88,6 +111,8 @@ module Vedeu
       end
     end
 
+    # Returns the parent style if available or NilClass.
+    #
     # @return [String|NilClass]
     def parent_style
       if parent

data/lib/vedeu/output/refresh.rb

@@ -1,4 +1,4 @@
-require_relative 'refresh_group'
+require 'vedeu/output/refresh_group'
 
 module Vedeu
 

data/lib/vedeu/output/refresh_group.rb

@@ -1,4 +1,4 @@
-require_relative 'refresh'
+require 'vedeu/output/refresh'
 
 module Vedeu
 
@@ -46,8 +46,10 @@ module Vedeu
 
     # @return [Set]
     def members
-      fail Vedeu::MissingRequired,
-        'Cannot refresh group with an empty group name.' unless present?(name)
+      unless present?(name)
+        fail Vedeu::MissingRequired,
+             'Cannot refresh group with an empty group name.'
+      end
 
       Vedeu.groups.by_name(name).members
     end

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

@@ -1,11 +1,11 @@
-require_relative 'renderer_options'
-require_relative 'escape_sequence'
-require_relative 'file'
-require_relative 'html'
-require_relative 'json'
-require_relative 'null'
-require_relative 'terminal'
-require_relative 'text'
+require 'vedeu/output/renderers/renderer_options'
+require 'vedeu/output/renderers/escape_sequence'
+require 'vedeu/output/renderers/file'
+require 'vedeu/output/renderers/html'
+require 'vedeu/output/renderers/json'
+require 'vedeu/output/renderers/null'
+require 'vedeu/output/renderers/terminal'
+require 'vedeu/output/renderers/text'
 
 module Vedeu
 

data/lib/vedeu/output/renderers/html.rb

@@ -21,10 +21,10 @@ module Vedeu
         @options[:content] = output
 
         if write_file?
-          super(Vedeu::Template.parse(self, template))
+          super(Vedeu::Templating::Template.parse(self, template))
 
         else
-          Vedeu::Template.parse(self, template)
+          Vedeu::Templating::Template.parse(self, template)
 
         end
       end

data/lib/vedeu/repositories/all.rb

@@ -56,10 +56,8 @@ module Vedeu
 
 end # Vedeu
 
-require_relative 'store'
-require_relative 'registerable'
-require_relative 'collection'
-require_relative 'collections/all'
-require_relative 'model'
-require_relative 'repositories/all'
-require_relative 'repository'
+require 'vedeu/repositories/store'
+require 'vedeu/repositories/registerable'
+require 'vedeu/repositories/collection'
+require 'vedeu/repositories/model'
+require 'vedeu/repositories/repository'

data/lib/vedeu/repositories/collection.rb

@@ -96,4 +96,46 @@ module Vedeu
 
   end # Collection
 
+  # A collection of {Vedeu::Char} instances.
+  #
+  # @api private
+  class Chars < Vedeu::Collection
+
+  end # Chars
+
+  # A collection of {Vedeu::Event} instances.
+  #
+  # @api private
+  class EventCollection < Vedeu::Collection
+
+  end # EventCollection
+
+  # A collection of {Vedeu::Interface} instances.
+  #
+  # @api private
+  class InterfaceCollection < Vedeu::Collection
+
+  end # InterfaceCollection
+
+  # A collection of {Vedeu::Key} instances.
+  #
+  # @api private
+  class Keys < Vedeu::Collection
+
+  end # Keys
+
+  # A collection of {Vedeu::Line} instances.
+  #
+  # @api private
+  class Lines < Vedeu::Collection
+
+  end # Lines
+
+  # A collection of {Vedeu::Stream} instances.
+  #
+  # @api private
+  class Streams < Vedeu::Collection
+
+  end # Streams
+
 end # Vedeu

data/lib/vedeu/repositories/model.rb

@@ -1,4 +1,4 @@
-require 'vedeu/support/common'
+require 'vedeu/common'
 
 module Vedeu
 
@@ -19,7 +19,7 @@ module Vedeu
     #
     module ClassMethods
 
-      # @!attribute [r]
+      # @!attribute [r] repository
       # @return [Vedeu::Repository]
       attr_reader :repository