vedeu 0.4.18 → 0.4.19

data/lib/vedeu/output/viewport.rb

@@ -5,7 +5,6 @@ module Vedeu
   # When a buffer has more lines than the defined height, or more columns than
   # the defined width of the interface, the Viewport class provides 'scrolling'
   # via the cursor's position.
-  #
   class Viewport
 
     extend Forwardable
@@ -72,12 +71,14 @@ module Vedeu
       render.map(&:to_s).join("\n")
     end
 
-    private
+    protected
 
     # @!attribute [r] interface
     # @return [Vedeu::Interface]
     attr_reader :interface
 
+    private
+
     # Returns the visible content for the interface.
     #
     # @note If there are no lines of content, we return an empty array. If there

data/lib/vedeu/output/virtual_terminal.rb

@@ -1,7 +1,6 @@
 module Vedeu
 
   # Represents a {Vedeu::Terminal} view as a grid of {Vedeu::Cell} objects.
-  #
   class VirtualTerminal
 
     # @!attribute [rw] renderer

data/lib/vedeu/output/wordwrap.rb

@@ -1,7 +1,6 @@
 module Vedeu
 
   # Wrap or prune text.
-  #
   class Wordwrap
 
     # @see {Vedeu::Wordwrap#initialize}
@@ -78,7 +77,7 @@ module Vedeu
       end
     end
 
-    private
+    protected
 
     # @!attribute [r] text
     # @return [String]
@@ -88,6 +87,8 @@ module Vedeu
     # @return [Hash]
     attr_reader :options
 
+    private
+
     # @param text_as_lines [Array<String>]
     # @return [Vedeu::Lines]
     def to_line_objects(text_as_lines)

data/lib/vedeu/repositories/all.rb

@@ -1,9 +1,3 @@
-require_relative 'collection'
-require_relative 'collections/all'
-require_relative 'model'
-require_relative 'repositories/all'
-require_relative 'repository'
-
 module Vedeu
 
   # Provides all registered repositories.
@@ -39,3 +33,10 @@ module Vedeu
   end
 
 end # Vedeu
+
+require_relative 'registerable'
+require_relative 'collection'
+require_relative 'collections/all'
+require_relative 'model'
+require_relative 'repositories/all'
+require_relative 'repository'

data/lib/vedeu/repositories/collection.rb

@@ -2,7 +2,6 @@ module Vedeu
 
   # Convert an Array into an object which has some meaning in the context it
   # is being used.
-  #
   class Collection
 
     include Enumerable

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

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

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

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

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

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

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

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

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

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

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

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

data/lib/vedeu/repositories/model.rb

@@ -2,7 +2,6 @@ module Vedeu
 
   # When included into a class, provides the mechanism to store the class in a
   # repository for later retrieval.
-  #
   module Model
 
     # @!attribute [rw] repository

data/lib/vedeu/repositories/registerable.rb

@@ -0,0 +1,29 @@
+module Vedeu
+
+  # Repositories contain registerables, this module provides convenience methods
+  # for them.
+  module Registerable
+
+    # These class methods are mixed into the repository.
+    module ClassMethods
+
+      # @param klass [Class]
+      # @return [Symbol]
+      def null(klass)
+        define_method(:null_model) { klass }
+      end
+
+    end # ClassMethods
+
+    # When this module is included in a class, provide ClassMethods as class
+    # methods for the class.
+    #
+    # @param klass [Class]
+    # @return [void]
+    def self.included(klass)
+      klass.send :extend, ClassMethods
+    end
+
+  end # Registerable
+
+end # Vedeu

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

@@ -1,7 +1,6 @@
 module Vedeu
 
   # Store background colour escape sequences by HTML/CSS code.
-  #
   class BackgroundColours < Colours
 
     # @return [Vedeu::BackgroundColours]

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

@@ -2,7 +2,6 @@ module Vedeu
 
   # Allows the storing of interface/view borders independent of the interface
   # instance.
-  #
   class Borders < Repository
 
     class << self
@@ -17,22 +16,12 @@ module Vedeu
       #
       # @return [Vedeu::Borders]
       def reset!
-        @borders = Vedeu::Borders.register_repository(Vedeu::Border)
+        @borders = Vedeu::Borders.register(Vedeu::Border)
       end
 
     end
 
-    # @param name [String] The name of the stored border.
-    # @return [Vedeu::Border|Vedeu::Null::Border]
-    def by_name(name)
-      if registered?(name)
-        find(name)
-
-      else
-        Vedeu::Null::Border.new(name)
-
-      end
-    end
+    null Vedeu::Null::Border
 
   end # Borders
 

data/lib/vedeu/repositories/repositories/buffers.rb

@@ -1,7 +1,6 @@
 module Vedeu
 
   # Allows the storing of view buffers.
-  #
   class Buffers < Repository
 
     class << self
@@ -16,22 +15,12 @@ module Vedeu
       #
       # @return [Vedeu::Buffers]
       def reset!
-        @buffers = Vedeu::Buffers.register_repository(Vedeu::Buffer)
+        @buffers = Vedeu::Buffers.register(Vedeu::Buffer)
       end
 
     end
 
-    # @param name [String] The name of the stored buffer.
-    # @return [Vedeu::Buffer|Vedeu::Null::Buffer]
-    def by_name(name)
-      if registered?(name)
-        find(name)
-
-      else
-        Vedeu::Null::Buffer.new(name)
-
-      end
-    end
+    null Vedeu::Null::Buffer
 
   end # Buffers
 

data/lib/vedeu/repositories/repositories/colours.rb

@@ -2,7 +2,6 @@ module Vedeu
 
   # Allows the storing of HTML/CSS colours and their respective escape
   # sequences.
-  #
   class Colours
 
     # @!attribute [r] storage

data/lib/vedeu/repositories/repositories/cursors.rb

@@ -1,7 +1,6 @@
 module Vedeu
 
   # Allows the storing of each interface's cursor.
-  #
   class Cursors < Repository
 
     class << self
@@ -21,7 +20,7 @@ module Vedeu
       #
       # @return [Vedeu::Cursors]
       def reset!
-        @cursors = Vedeu::Cursors.register_repository(Vedeu::Cursor)
+        @cursors = Vedeu::Cursors.register(Vedeu::Cursor)
       end
 
     end

data/lib/vedeu/repositories/repositories/events_repository.rb

@@ -1,7 +1,6 @@
 module Vedeu
 
   # Allows the storing of events.
-  #
   class EventsRepository < Repository
 
     class << self

data/lib/vedeu/repositories/repositories/foreground_colours.rb

@@ -1,7 +1,6 @@
 module Vedeu
 
   # Store foreground colour escape sequences by HTML/CSS code.
-  #
   class ForegroundColours < Colours
 
     # @return [Vedeu::ForegroundColours]

data/lib/vedeu/repositories/repositories/geometries.rb

@@ -2,7 +2,6 @@ module Vedeu
 
   # Allows the storing of interface/view geometry independent of the interface
   # instance.
-  #
   class Geometries < Repository
 
     class << self
@@ -17,22 +16,12 @@ module Vedeu
       #
       # @return [Vedeu::Geometries]
       def reset!
-        @geometries = Vedeu::Geometries.register_repository(Vedeu::Geometry)
+        @geometries = Vedeu::Geometries.register(Vedeu::Geometry)
       end
 
     end
 
-    # @param name [String] The name of the stored geometry.
-    # @return [Vedeu::Geometry|Vedeu::Null::Geometry]
-    def by_name(name)
-      if registered?(name)
-        find(name)
-
-      else
-        Vedeu::Null::Geometry.new(name)
-
-      end
-    end
+    null Vedeu::Null::Geometry
 
   end # Geometries
 

data/lib/vedeu/repositories/repositories/groups.rb

@@ -1,7 +1,6 @@
 module Vedeu
 
   # Allows the storing of view groups.
-  #
   class Groups < Repository
 
     class << self
@@ -16,7 +15,7 @@ module Vedeu
       #
       # @return [Vedeu::Groups]
       def reset!
-        @groups = Vedeu::Groups.register_repository(Vedeu::Group)
+        @groups = Vedeu::Groups.register(Vedeu::Group)
       end
 
     end

data/lib/vedeu/repositories/repositories/interfaces_repository.rb

@@ -1,7 +1,6 @@
 module Vedeu
 
   # Allows the storing of interfaces and views.
-  #
   class InterfacesRepository < Repository
 
     class << self
@@ -16,23 +15,12 @@ module Vedeu
       #
       # @return [Vedeu::InterfacesRepository]
       def reset!
-        @interfaces = Vedeu::InterfacesRepository.
-          register_repository(Vedeu::Interface)
+        @interfaces = Vedeu::InterfacesRepository.register(Vedeu::Interface)
       end
 
     end
 
-    # @param name [String]
-    # @return [Vedeu::Interface|Vedeu::Null::Interface]
-    def by_name(name)
-      if registered?(name)
-        find(name)
-
-      else
-        Vedeu::Null::Interface.new(name: name)
-
-      end
-    end
+    null Vedeu::Null::Interface
 
   end # InterfacesRepository
 

data/lib/vedeu/repositories/repositories/keymaps.rb

@@ -1,7 +1,6 @@
 module Vedeu
 
   # Allows the storing of keymaps.
-  #
   class Keymaps < Repository
 
     class << self
@@ -16,7 +15,7 @@ module Vedeu
       #
       # @return [Vedeu::Keymaps]
       def reset!
-        @keymaps = Vedeu::Keymaps.register_repository(Vedeu::Keymap)
+        @keymaps = Vedeu::Keymaps.register(Vedeu::Keymap)
       end
 
     end

data/lib/vedeu/repositories/repositories/menus.rb

@@ -1,7 +1,6 @@
 module Vedeu
 
   # Allows the storing of menus by name.
-  #
   class Menus < Repository
 
     class << self
@@ -16,7 +15,7 @@ module Vedeu
       #
       # @return [Vedeu::Menus]
       def reset!
-        @menus = Vedeu::Menus.register_repository(Vedeu::Menu)
+        @menus = Vedeu::Menus.register(Vedeu::Menu)
       end
 
     end

data/lib/vedeu/repositories/repository.rb

@@ -1,5 +1,3 @@
-require 'vedeu/models/all'
-require 'vedeu/storage/store'
 require 'vedeu/support/common'
 
 module Vedeu
@@ -10,10 +8,10 @@ module Vedeu
   #   { 'models' => [Model, Model, Model] }
   #
   #   { 'models' => [Model] }
-  #
   class Repository
 
     include Vedeu::Common
+    include Vedeu::Registerable
     include Vedeu::Store
 
     # @!attribute [r] model
@@ -27,7 +25,7 @@ module Vedeu
     # @param model [Class]
     # @param storage [Class|Hash]
     # @return [Vedeu::Repository]
-    def self.register_repository(model = nil, storage = {})
+    def self.register(model = nil, storage = {})
       new(model, storage).tap do |klass|
         Vedeu::Repositories.register(klass.repository)
       end
@@ -50,6 +48,18 @@ module Vedeu
       self.class # .name
     end
 
+    # @param name [String] The name of the stored model.
+    # @return [void]
+    def by_name(name)
+      if registered?(name)
+        find(name)
+
+      else
+        null_model.new(name)
+
+      end
+    end
+
     # Return the model for the interface currently in focus.
     #
     # @return [String|NilClass]
@@ -90,7 +100,6 @@ module Vedeu
         model.new(name).store
       end
     end
-    alias_method :by_name, :find_or_create
 
     # @return [String]
     def inspect

data/lib/vedeu/storage/all.rb

@@ -3,4 +3,3 @@ require_relative 'store'
 require_relative 'associative_store'
 require_relative 'conveyor_store'
 require_relative 'fifo_store'
-

data/lib/vedeu/storage/associative_store.rb

@@ -3,7 +3,6 @@ module Vedeu
   # Name/Value storage.
   #
   #   name: [value]
-  #
   class AssociativeStore
 
     include Vedeu::Store

data/lib/vedeu/storage/conveyor_store.rb

@@ -2,7 +2,6 @@ module Vedeu
 
   # Conveyor belt like storage. The belt can move forward (`load_next`) or
   # backwards (`load_previous`), or a named entry can be retrieved.
-  #
   class ConveyorStore
 
     include Vedeu::Store

data/lib/vedeu/storage/fifo_store.rb

@@ -3,7 +3,6 @@ module Vedeu
   # First-in first-out storage.
   #
   #   in -> [3] -> [2] -> [1] -> out
-  #
   class FifoStore
 
     include Vedeu::Store

data/lib/vedeu/support/log.rb

@@ -1,9 +1,6 @@
-require 'vedeu/configuration/configuration'
-
 module Vedeu
 
   # Allows the creation of a lock-less log device.
-  #
   class MonoLogger < Logger
 
     # Create a trappable Logger instance.

data/lib/vedeu/support/options.rb

@@ -3,7 +3,6 @@ module Vedeu
   # Converts an options Hash into a class containing methods for each of the
   # keys, which when called returns the value associated. When the value is
   # either true or false, an additional predicate method is created.
-  #
   class Options
 
     # @!attribute [r] _defined
@@ -36,12 +35,14 @@ module Vedeu
       self
     end
 
-    private
+    protected
 
     # @!attribute [r] _options
     # @return [Hash]
     attr_reader :_options
 
+    private
+
     # @param alias_name [String|Symbol]
     # @param method_name [String|Symbol]
     # @return [void]

data/lib/vedeu/support/template.rb

@@ -1,9 +1,6 @@
-require 'erb'
-
 module Vedeu
 
   # Generic class to loading a template and parsing it via ERb.
-  #
   class Template
 
     # @param object [Class]
@@ -27,12 +24,14 @@ module Vedeu
       ERB.new(load, nil, '-').result(binding)
     end
 
-    private
+    protected
 
     # @!attribute [r] object
     # @return [Class]
     attr_reader :object
 
+    private
+
     # @return [String]
     def load
       File.read(path)

data/lib/vedeu/support/terminal.rb

@@ -1,6 +1,4 @@
 require 'vedeu/configuration/configuration'
-require 'vedeu/output/esc'
-require 'vedeu/support/log'
 
 module Vedeu
 

data/lib/vedeu/support/trace.rb

@@ -1,7 +1,3 @@
-require 'vedeu/configuration/configuration'
-require 'vedeu/output/esc'
-require 'vedeu/support/log'
-
 module Vedeu
 
   # :nocov:
@@ -9,7 +5,6 @@ module Vedeu
   # occurs inside Vedeu. This is very useful (to me!) for debugging. Running
   # this will make your application less responsive, and the tests
   # excruciatingly slow to run.
-  #
   class Trace
 
     # @todo
@@ -48,11 +43,15 @@ module Vedeu
     # - (id) the method name being traced,
     # - (vars) any local variables belonging to the method.
     #
+    # @note
+    #   Arguments to set_trace_func proc:
+    #     |event, file, line, id, binding, name|
+    #
     # @todo Deprecate, and use TracePoint instead.
     #
     # @return [NilClass|String]
     def trace
-      set_trace_func proc { |event, _file, _line, id, binding, name|
+      set_trace_func proc { |event, _, _, id, binding, name|
         if event == watched && id != :log && classes.include?(name.to_s)
           vars = variables(binding)
 
@@ -163,7 +162,7 @@ module Vedeu
     #
     # @return [Set]
     def vedeu_exceptions
-      Vedeu::Exceptions.to_set
+      Vedeu::EXCEPTIONS.to_set
     end
 
     # Returns a set of classes to ignore during tracing.

data/lib/vedeu/support/visibility.rb

@@ -1,7 +1,6 @@
 module Vedeu
 
   # Change the visibility of the given model.
-  #
   class Visibility
 
     # @param name [String]
@@ -70,7 +69,7 @@ module Vedeu
       end
     end
 
-    private
+    protected
 
     # @!attribute [r] model
     # @return [void]

data/lib/vedeu.rb

@@ -3,6 +3,7 @@ $LOAD_PATH.unshift($LIB_DIR) unless $LOAD_PATH.include?($LIB_DIR)
 
 require 'date'
 require 'drb'
+require 'erb'
 require 'forwardable'
 require 'io/console'
 require 'json'
@@ -16,7 +17,6 @@ require 'time'
 require 'vedeu/support/log'
 
 # Vedeu is a GUI framework for terminal/console applications written in Ruby.
-#
 module Vedeu
 
   extend Forwardable
@@ -67,7 +67,7 @@ module Vedeu
   #
   # VedeuInterrupt: Raised when Vedeu wishes to exit.
   #
-  Exceptions = %w(
+  EXCEPTIONS = %w(
     ModelNotFound
     InvalidSyntax
     MissingRequired
@@ -76,9 +76,7 @@ module Vedeu
     OutOfRange
     VedeuInterrupt
   )
-  Exceptions.each { |e| const_set(e, Class.new(StandardError)) }
-
-  private
+  EXCEPTIONS.each { |e| const_set(e, Class.new(StandardError)) }
 
 end # Vedeu