vedeu 0.4.13 → 0.4.14

data/lib/vedeu/output/viewport.rb

@@ -11,23 +11,31 @@ module Vedeu
     extend Forwardable
 
     def_delegators :interface,
-                   :geometry,
                    :lines,
                    :lines?,
-                   :cursor
+                   :name,
+                   :visible?
+
+    def_delegators :border,
+                   :bx,
+                   :by,
+                   :height,
+                   :width
 
     def_delegators :cursor,
                    :ox,
                    :oy
 
-    def_delegators :geometry,
-                   :height,
-                   :width
-
     # @param interface [Vedeu::Interface]
     # @return [Array<Array<Vedeu::Char>>]
     def self.render(interface)
-      new(interface).render
+      if interface.visible?
+        new(interface).render
+
+      else
+        []
+
+      end
     end
 
     # Returns an instance of Vedeu::Viewport.
@@ -43,20 +51,17 @@ module Vedeu
     #
     # @return [Array<Array<String>>]
     def render
-      Vedeu.log(type: :output, message: "Rendering: '#{interface.name}'")
+      return [] unless visible?
 
-      out = []
+      Vedeu.log(type: :output, message: "Rendering: '#{name}'")
 
-      show[0...bordered_height].each_with_index do |line, iy|
-        line[0...bordered_width].each_with_index do |column, ix|
-          column.position = IndexPosition[iy,
-                                          ix,
-                                          interface.border.by,
-                                          interface.border.bx]
+      out = []
+      show[0...height].each_with_index do |line, iy|
+        line[0...width].each_with_index do |column, ix|
+          column.position = IndexPosition[iy, ix, by, bx]
           out << column
         end
       end
-
       out
     end
 
@@ -97,7 +102,7 @@ module Vedeu
     #
     # @return [Range]
     def rows
-      top..(top + (height - 1))
+      top..(top + (geometry.height - 1))
     end
 
     # Using the current cursor's x position, return a range of visible columns.
@@ -110,87 +115,46 @@ module Vedeu
     #
     # @return [Range]
     def columns
-      left..(left + (width - 1))
+      left..(left + (geometry.width - 1))
     end
 
-    # Returns the offset for the content based on the offset.
+    # Returns the offset for the content (the number of columns to change the
+    # viewport by on the x axis) determined by the offset (the cursor's x
+    # offset position).
     #
     # @return [Fixnum]
     def left
-      @left ||= reposition_x? ? reposition_x : 0
+      @left ||= (ox >= width && ((ox - width) > 0)) ? ox - width : 0
     end
 
-    # Returns the offset for the content based on the offset.
+    # Returns the offset for the content (the number of rows to change the
+    # viewport by on the y axis) determined by the offset (the cursor's y offset
+    # position.
     #
     # @return [Fixnum]
     def top
-      @top ||= reposition_y? ? reposition_y : 0
-    end
-
-    # Returns a boolean indicating whether the x offset is greater than or equal
-    # to the bordered width.
-    #
-    # @return [Boolean]
-    def reposition_x?
-      ox >= bordered_width
+      @top ||= (oy >= height && ((oy - height) > 0)) ? oy - height : 0
     end
 
-    # Returns a boolean indicating whether the y offset is greater than or equal
-    # to the bordered height.
-    #
-    # @return [Boolean]
-    def reposition_y?
-      oy >= bordered_height
-    end
-
-    # Returns the number of columns to change the viewport by on the x axis,
-    # determined by the position of the x offset.
-    #
-    # @return [Fixnum]
-    def reposition_x
-      ((ox - bordered_width) <= 0) ? 0 : (ox - bordered_width)
-    end
-
-    # Returns the number of rows to change the viewport by on the y axis,
-    # determined by the position of the y offset.
-    #
-    # @return [Fixnum]
-    def reposition_y
-      ((oy - bordered_height) <= 0) ? 0 : (oy - bordered_height)
-    end
-
-    # When the viewport has a border, we need to account for that in our
-    # redrawing.
-    #
-    # @return [Fixnum]
-    def bordered_width
-      return border.width if border?
-
-      width
-    end
-
-    # When the viewport has a border, we need to account for that in our
-    # redrawing.
+    # Return the border associated with the interface we are drawing.
     #
-    # @return [Fixnum]
-    def bordered_height
-      return border.height if border?
-
-      height
+    # @return [Vedeu::Border|Vedeu::NullBorder]
+    def border
+      @border ||= Vedeu.borders.by_name(name)
     end
 
-    # Return the border associated with the interface we are drawing.
+    # Fetch the cursor associated with the interface we are drawing.
     #
-    # @return [Vedeu::Border]
-    def border
-      @border ||= Vedeu.borders.find(interface.name)
+    # @return [Vedeu::Cursor]
+    def cursor
+      @cursor ||= Vedeu.cursors.by_name(name)
     end
 
-    # Returns a boolean indicating the interface we are drawing has a border.
+    # Return the geometry associated with the interface we are drawing.
     #
-    # @return [Boolean]
-    def border?
-      Vedeu.borders.registered?(interface.name)
+    # @return [Vedeu::Geometry|Vedeu::NullGeometry]
+    def geometry
+      @geometry || Vedeu.geometries.by_name(name)
     end
 
   end # Viewport

data/lib/vedeu/output/wordwrap.rb

@@ -15,7 +15,7 @@ module Vedeu
     # @param options [Hash]
     # @option options ellipsis [String] For when using mode `:prune`.
     # @option options mode [Symbol] One of :default, :prune, :wrap
-    # @option options width [Fixnum] The width in characters to prune or wrap to.
+    # @option options width [Fixnum] The width to prune or wrap to.
     # @return [Vedeu::Wordwrap]
     def initialize(text, options = {})
       @text    = text
@@ -24,7 +24,7 @@ module Vedeu
 
     # @return [Vedeu::Lines]
     def content
-      case(mode)
+      case mode
       when :prune then to_line_objects(prune)
       when :wrap  then to_line_objects(wrap)
       else
@@ -63,7 +63,7 @@ module Vedeu
 
           if (line_length += word_length) >= width
             line_length = word_length
-            processed   << reformatted
+            processed << reformatted
             reformatted = []
           end
 
@@ -92,7 +92,7 @@ module Vedeu
     # @return [Vedeu::Lines]
     def to_line_objects(text_as_lines)
       line_objects = Array(text_as_lines).map do |text_line|
-        stream        = Vedeu::Stream.new({ value: text_line })
+        stream        = Vedeu::Stream.new(value: text_line)
         line          = Vedeu::Line.new
         stream.parent = line
         line.add(stream)

data/lib/vedeu/repositories/all.rb

@@ -1,196 +1,39 @@
-require 'vedeu/repositories/collection'
-require 'vedeu/repositories/collections'
-require 'vedeu/repositories/model'
-require 'vedeu/repositories/repository'
+require_relative 'collection'
+require_relative 'collections/all'
+require_relative 'model'
+require_relative 'repositories/all'
+require_relative 'repository'
 
 module Vedeu
 
-  # Allows the storing of interface/view borders independent of the interface
-  # instance.
+  # Provides all registered repositories.
   #
-  class Borders < Repository
+  module Repositories
 
-    # @return [Vedeu::Borders]
-    def self.borders
-      @borders ||= Vedeu::Borders.new(Vedeu::Border)
-    end
-
-  end # Borders
-
-  # Allows the storing of view buffers.
-  #
-  class Buffers < Repository
-
-    # @return [Vedeu::Buffers]
-    def self.buffers
-      @buffers ||= Vedeu::Buffers.new(Vedeu::Buffer)
-    end
-
-  end # Buffers
-
-  # Allows the storing of HTML/CSS colours and their respective escape
-  # sequences.
-  #
-  class Colours
+    extend self
 
-    # @!attribute [r] storage
-    # @return [Hash<String => String>]
-    attr_reader :storage
-
-    # Returns a new instance of Vedeu::Colours.
-    #
-    # @return [Vedeu::Colours]
-    def initialize
-      @storage = {}
-    end
-
-    # Registers a colour with respective escape sequence.
-    #
-    # @return [String]
-    def register(colour, escape_sequence)
-      storage.store(colour, escape_sequence)
+    # @param klass [Class]
+    # @return [Set]
+    def register(klass)
+      storage.add(klass)
     end
 
-    # Returns a boolean indicating whether the colour has been registered.
-    #
-    # @return [Boolean]
-    def registered?(colour)
-      storage.key?(colour)
-    end
-
-    # Removes all stored colours.
-    #
-    # @return [Hash]
+    # @return [TrueClass]
     def reset!
-      storage.clear
-    end
-
-    # Retrieves a registered colour.
-    #
-    # @return [String]
-    def retrieve(colour)
-      storage.fetch(colour, '')
-    end
-
-    # Retrieves a registered colour, or registers the colour with its respective
-    # escape sequence.
-    #
-    # @return [String]
-    def retrieve_or_register(colour, escape_sequence)
-      if registered?(colour)
-        retrieve(colour)
-
-      else
-        register(colour, escape_sequence)
-
-      end
-    end
-
-  end # Colours
-
-  # Store background colour escape sequences by HTML/CSS code.
-  #
-  class BackgroundColours < Colours
-
-    # @return [Vedeu::BackgroundColours]
-    def self.background_colours
-      @background_colours ||= new
-    end
-
-  end # BackgroundColours
-
-  # Store foreground colour escape sequences by HTML/CSS code.
-  #
-  class ForegroundColours < Colours
+      storage.map(&:repository).map { |repository| repository.send(:reset) }
 
-    # @return [Vedeu::ForegroundColours]
-    def self.foreground_colours
-      @foreground_colours ||= new
+      true
     end
 
-  end # ForegroundColours
+    private
 
-  # Allows the storing of each interface's cursor.
-  #
-  class Cursors < Repository
-
-    # @return [Vedeu::Cursors]
-    def self.cursors
-      @cursors ||= Vedeu::Cursors.new(Vedeu::Cursor)
-    end
-
-    # @return [Vedeu::Cursor]
-    def self.cursor
-      cursors.current
-    end
-
-  end # Cursors
-
-  # Allows the storing of events.
-  #
-  class EventsRepository < Repository
-
-    # @return [Vedeu::EventsRepository]
-    def self.events
-      @events ||= Vedeu::EventsRepository.new(Vedeu::Events)
-    end
-
-  end # EventsRepository
-
-  # Allows the storing of interface/view geometry independent of the interface
-  # instance.
-  #
-  class Geometries < Repository
-
-    # @return [Vedeu::Geometries]
-    def self.geometries
-      @geometries ||= Vedeu::Geometries.new(Vedeu::Geometry)
-    end
-
-  end # Geometries
-
-  # Allows the storing of view groups.
-  #
-  class Groups < Repository
-
-    # @return [Vedeu::Groups]
-    def self.groups
-      @groups ||= Vedeu::Groups.new(Vedeu::Group)
-    end
-
-  end # Groups
-
-  # Allows the storing of interfaces and views.
-  #
-  class InterfacesRepository < Repository
-
-    # @return [Vedeu::InterfacesRepository]
-    def self.interfaces
-      @interfaces ||= Vedeu::InterfacesRepository.new(Vedeu::Interface)
-    end
-
-  end # InterfacesRepository
-
-  # Allows the storing of keymaps.
-  #
-  class Keymaps < Repository
-
-    # @return [Vedeu::Keymaps]
-    def self.keymaps
-      @keymaps ||= Vedeu::Keymaps.new(Vedeu::Keymap)
-    end
-
-  end # Keymaps
-
-  # Allows the storing of menus by name.
-  #
-  class Menus < Repository
-
-    # @return [Vedeu::Menus]
-    def self.menus
-      @menus ||= Vedeu::Menus.new(Vedeu::Menu)
+    # Access to the storage for this repository.
+    #
+    # @return [Array]
+    def storage
+      @storage ||= Set.new
     end
 
-  end # Menus
+  end
 
 end # Vedeu

data/lib/vedeu/repositories/collection.rb

@@ -7,6 +7,11 @@ module Vedeu
 
     include Enumerable
 
+    # @!attribute [r] collection
+    # @return [Array|Vedeu::Collection]
+    attr_reader :collection
+    alias_method :all, :collection
+
     # @!attribute [rw] parent
     # @return [Fixnum]
     attr_accessor :parent
@@ -20,7 +25,7 @@ module Vedeu
     # @param name [String|NilClass]
     # @return [Vedeu::Collection]
     def self.coerce(collection = [], parent = nil, name = nil)
-      if collection.kind_of?(Vedeu::Collection)
+      if collection.is_a?(Vedeu::Collection)
         collection
 
       else
@@ -46,7 +51,7 @@ module Vedeu
     # @param value [Fixnum]
     # @return [void]
     def [](value)
-      @collection[value]
+      collection[value]
     end
 
     # Adds an entry to the collection.
@@ -58,40 +63,33 @@ module Vedeu
     end
     alias_method :<<, :add
 
-    # Returns the whole collection.
-    #
-    # @return [Array]
-    def all
-      @collection
-    end
-
     # Provides iteration over the collection.
     #
     # @param block [Proc]
     # @return [Enumerator]
     def each(&block)
-      @collection.each(&block)
+      collection.each(&block)
     end
 
     # Returns a boolean indicating whether the collection is empty.
     #
     # @return [Boolean]
     def empty?
-      @collection.empty?
+      collection.empty?
     end
 
     # Returns the size of the collection.
     #
     # @return [Fixnum]
     def size
-      @collection.size
+      collection.size
     end
 
     # Returns the collection as a String.
     #
     # @return [String]
     def to_s
-      @collection.map(&:to_s).join
+      collection.map(&:to_s).join
     end
 
   end # Collection

data/lib/vedeu/repositories/collections/all.rb

@@ -0,0 +1,8 @@
+require 'vedeu/repositories/collection'
+
+require_relative 'chars'
+require_relative 'events'
+require_relative 'interfaces'
+require_relative 'keys'
+require_relative 'lines'
+require_relative 'streams'

data/lib/vedeu/repositories/collections/chars.rb

@@ -0,0 +1,9 @@
+module Vedeu
+
+  # A collection of {Vedeu::Char} instances.
+  #
+  class Chars < Vedeu::Collection
+
+  end # Chars
+
+end # Vedeu

data/lib/vedeu/repositories/collections/events.rb

@@ -0,0 +1,9 @@
+module Vedeu
+
+  # A collection of {Vedeu::Event} instances.
+  #
+  class Events < Vedeu::Collection
+
+  end # Events
+
+end # Vedeu

data/lib/vedeu/repositories/collections/interfaces.rb

@@ -0,0 +1,9 @@
+module Vedeu
+
+  # A collection of {Vedeu::Interface} instances.
+  #
+  class Interfaces < Vedeu::Collection
+
+  end # Interfaces
+
+end # Vedeu

data/lib/vedeu/repositories/collections/keys.rb

@@ -0,0 +1,9 @@
+module Vedeu
+
+  # A collection of {Vedeu::Key} instances.
+  #
+  class Keys < Vedeu::Collection
+
+  end # Keys
+
+end # Vedeu

data/lib/vedeu/repositories/collections/lines.rb

@@ -0,0 +1,9 @@
+module Vedeu
+
+  # A collection of {Vedeu::Line} instances.
+  #
+  class Lines < Vedeu::Collection
+
+  end # Lines
+
+end # Vedeu

data/lib/vedeu/repositories/collections/streams.rb

@@ -0,0 +1,9 @@
+module Vedeu
+
+  # A collection of {Vedeu::Stream} instances.
+  #
+  class Streams < Vedeu::Collection
+
+  end # Streams
+
+end # Vedeu

data/lib/vedeu/repositories/model.rb

@@ -5,9 +5,9 @@ module Vedeu
   #
   module Model
 
-    # @!attribute [r] repository
+    # @!attribute [rw] repository
     # @return [Vedeu::Repository]
-    attr_reader :repository
+    attr_accessor :repository
 
     # When {Vedeu::Model} is included in a class, the methods within this module
     # are included as class methods on that class.
@@ -40,6 +40,11 @@ module Vedeu
       alias_method :member,     :child
       alias_method :collection, :child
 
+      def repository(klass, as:)
+        self.repository = as
+        klass.register(as, self)
+      end
+
       private
 
       # The default values for a new instance of this class.

data/lib/vedeu/repositories/repositories/all.rb

@@ -0,0 +1,14 @@
+require 'vedeu/repositories/repository'
+
+require_relative 'colours'
+require_relative 'background_colours'
+require_relative 'foreground_colours'
+require_relative 'borders'
+require_relative 'buffers'
+require_relative 'cursors'
+require_relative 'events_repository'
+require_relative 'geometries'
+require_relative 'groups'
+require_relative 'interfaces_repository'
+require_relative 'keymaps'
+require_relative 'menus'

data/lib/vedeu/repositories/repositories/background_colours.rb

@@ -0,0 +1,14 @@
+module Vedeu
+
+  # Store background colour escape sequences by HTML/CSS code.
+  #
+  class BackgroundColours < Colours
+
+    # @return [Vedeu::BackgroundColours]
+    def self.background_colours
+      @background_colours ||= new
+    end
+
+  end # BackgroundColours
+
+end # Vedeu

data/lib/vedeu/repositories/repositories/borders.rb

@@ -0,0 +1,38 @@
+module Vedeu
+
+  # Allows the storing of interface/view borders independent of the interface
+  # instance.
+  #
+  class Borders < Repository
+
+    # @return [Vedeu::Borders]
+    def self.borders
+      @borders ||= reset! # Vedeu::Borders.new(Vedeu::Border)
+    end
+
+    # @return [Vedeu::Borders]
+    def self.repository
+      Vedeu.borders
+    end
+
+    # @return [Vedeu::Borders]
+    def self.reset!
+      @borders = Vedeu::Borders.register_repository(Vedeu::Border)
+    end
+
+    # @param name [String] The name of the stored border.
+    # @return [Vedeu::Border|Vedeu::NullBorder|NilClass]
+    def by_name(name)
+      if registered?(name)
+        find(name)
+
+      elsif Vedeu.interfaces.registered?(name)
+        interface = Vedeu.interfaces.find(name)
+        Vedeu::NullBorder.new(interface)
+
+      end
+    end
+
+  end # Borders
+
+end # Vedeu