vedeu 0.6.10 → 0.6.11

data/lib/vedeu/repositories/repository.rb

@@ -1,188 +1,193 @@
 module Vedeu
 
-  # Provides common methods for accessing the various repositories
-  # Vedeu uses.
-  #
-  # @example
-  #   { 'models' => [Model, Model, Model] }
-  #
-  #   { 'models' => [Model] }
-  #
-  class Repository
-
-    include Vedeu::Common
-    include Vedeu::Registerable
-    include Vedeu::Store
-
-    # @!attribute [r] model
-    # @return [void]
-    attr_reader :model
-
-    # @!attribute [r] storage
-    # @return [void]
-    attr_reader :storage
-
-    # Returns a new instance of Vedeu::Repository.
-    #
-    # @param model [Class]
-    # @param storage [Class|Hash]
-    # @return [Vedeu::Repository]
-    def initialize(model = nil, storage = {})
-      @model      = model
-      @storage    = storage
-    end
-
-    # Returns the repository class.
-    #
-    # @return [Class]
-    def repository
-      self.class
-    end
-
-    # Return all the registered models.
-    #
-    # @return [Array<void>] An array containing each stored model.
-    def all
-      return storage.values if storage.is_a?(Hash)
-
-      registered
-    end
+  module Repositories
 
-    # Return the named model or a null object if not registered.
+    # Provides common methods for accessing the various repositories
+    # Vedeu uses.
     #
     # @example
-    #   # Fetch the cursor belonging to the interface of the same
-    #   # name.
-    #   Vedeu.cursors.by_name('some_name')
+    #   { 'models' => [Model, Model, Model] }
     #
-    #   # Fetch the names of the interfaces belonging to this group.
-    #   Vedeu.groups.by_name(name)
+    #   { 'models' => [Model] }
     #
-    # @param name [String] The name of the stored model.
-    # @return [void]
-    def by_name(name)
-      name ||= Vedeu.focus
+    class Repository
+
+      include Vedeu::Common
+      include Vedeu::Repositories::Registerable
+      include Vedeu::Repositories::Store
+
+      # @!attribute [r] model
+      # @return [void]
+      attr_reader :model
+
+      # @!attribute [r] storage
+      # @return [void]
+      attr_reader :storage
+
+      # Returns a new instance of Vedeu::Repositories::Repository.
+      #
+      # @param model [Class]
+      # @param storage [Class|Hash]
+      # @return [Vedeu::Repositories::Repository]
+      def initialize(model = nil, storage = {})
+        @model      = model
+        @storage    = storage
+      end
 
-      if registered?(name)
-        find(name)
+      # Returns the repository class.
+      #
+      # @return [Class]
+      def repository
+        self.class
+      end
 
-      else
-        null_model.new(name: name)
+      # Return all the registered models.
+      #
+      # @return [Array<void>] An array containing each stored model.
+      def all
+        return storage.values if storage.is_a?(Hash)
 
+        registered
       end
-    end
 
-    # Return the model for the interface currently in focus.
-    #
-    # @return [String|NilClass]
-    def current
-      find_or_create(Vedeu.focus) if Vedeu.focus
-    end
+      # Return the named model or a null object if not registered.
+      #
+      # @example
+      #   # Fetch the cursor belonging to the interface of the same
+      #   # name.
+      #   Vedeu.cursors.by_name('some_name')
+      #
+      #   # Fetch the names of the interfaces belonging to this group.
+      #   Vedeu.groups.by_name(name)
+      #
+      # @param name [String] The name of the stored model.
+      # @return [void]
+      def by_name(name)
+        name ||= Vedeu.focus
+
+        if registered?(name)
+          find(name)
+
+        else
+          null_model.new(name: name)
+
+        end
+      end
 
-    # Find the model by name.
-    #
-    # @param name [String]
-    # @return [Hash<String => Object>|NilClass]
-    def find(name)
-      storage[name]
-    end
-
-    # Find the model attributes by name, raises an exception when the
-    # model cannot be found.
-    #
-    # @param name [String]
-    # @raise [Vedeu::Error::ModelNotFound] When the model cannot be
-    #   found with this name.
-    # @return [Hash<String => Object>]
-    def find!(name)
-      find(name) || fail(Vedeu::Error::ModelNotFound,
-                         "Cannot find model by name: '#{name}'")
-    end
-
-    # Find a model by name, registers the model by name when not
-    # found.
-    #
-    # @param name [String]
-    # @return [void]
-    def find_or_create(name)
-      if registered?(name)
-        find(name)
+      # Return the model for the interface currently in focus.
+      #
+      # @return [String|NilClass]
+      def current
+        find_or_create(Vedeu.focus) if Vedeu.focus
+      end
 
-      else
-        Vedeu.log(type: :store,
-                  message: "Model (#{model}) not found, registering: '#{name}'")
+      # Find the model by name.
+      #
+      # @param name [String]
+      # @return [Hash<String => Object>|NilClass]
+      def find(name)
+        storage[name]
+      end
 
-        model.new(name).store
+      # Find the model attributes by name, raises an exception when
+      # the model cannot be found.
+      #
+      # @param name [String]
+      # @raise [Vedeu::Error::ModelNotFound] When the model cannot be
+      #   found with this name.
+      # @return [Hash<String => Object>]
+      def find!(name)
+        find(name) || fail(Vedeu::Error::ModelNotFound,
+                           "Cannot find model by name: '#{name}'")
       end
-    end
 
-    # @return [String]
-    def inspect
-      "<#{self.class.name}>"
-    end
+      # Find a model by name, registers the model by name when not
+      # found.
+      #
+      # @param name [String]
+      # @return [void]
+      def find_or_create(name)
+        if registered?(name)
+          find(name)
+
+        else
+          Vedeu.log(type: :store,
+                    message: "Model (#{model}) not found, " \
+                             "registering: '#{name}'")
+
+          model.new(name).store
+        end
+      end
 
-    # Returns a boolean indicating whether the named model is
-    # registered.
-    #
-    # @param name [String]
-    # @return [Boolean]
-    def registered?(name)
-      return false if name.nil? || name.empty?
-      return false if empty?
+      # @return [String]
+      def inspect
+        "<#{self.class.name}>"
+      end
 
-      storage.include?(name)
-    end
+      # Returns a boolean indicating whether the named model is
+      # registered.
+      #
+      # @param name [String]
+      # @return [Boolean]
+      def registered?(name)
+        return false if name.nil? || name.empty?
+        return false if empty?
 
-    # Returns the storage with the named model removed, or false when
-    # the model does not exist.
-    #
-    # @param name [String]
-    # @return [Hash|FalseClass]
-    def remove(name)
-      return false if empty?
+        storage.include?(name)
+      end
 
-      if registered?(name)
-        storage.delete(name)
-        storage unless storage.is_a?(Set)
+      # Returns the storage with the named model removed, or false
+      # when the model does not exist.
+      #
+      # @param name [String]
+      # @return [Hash|FalseClass]
+      def remove(name)
+        return false if empty?
 
-      else
-        false
+        if registered?(name)
+          storage.delete(name)
+          storage unless storage.is_a?(Set)
 
-      end
-    end
-    alias_method :destroy,    :remove
-    alias_method :delete,     :remove
-    alias_method :deregister, :remove
+        else
+          false
 
-    # Stores the model instance by name in the repository of the
-    # model.
-    #
-    # @param model [void] A model instance.
-    # @raise [Vedeu::Error::MissingRequired] When the name attribute
-    #   is not defined.
-    # @return [void] The model instance which was stored.
-    def store(model)
-      unless present?(model.name)
-        fail Vedeu::Error::MissingRequired,
-             "Cannot store model '#{model.class}' without a name attribute."
+        end
       end
+      alias_method :destroy,    :remove
+      alias_method :delete,     :remove
+      alias_method :deregister, :remove
+
+      # Stores the model instance by name in the repository of the
+      # model.
+      #
+      # @param model [void] A model instance.
+      # @raise [Vedeu::Error::MissingRequired] When the name attribute
+      #   is not defined.
+      # @return [void] The model instance which was stored.
+      def store(model)
+        unless present?(model.name)
+          fail Vedeu::Error::MissingRequired,
+               "Cannot store model '#{model.class}' without a name attribute."
+        end
+
+        log_store(model)
+
+        storage[model.name] = model
+      end
+      alias_method :register, :store
+      alias_method :add, :store
 
-      log_store(model)
-
-      storage[model.name] = model
-    end
-    alias_method :register, :store
-    alias_method :add, :store
+      private
 
-    private
+      # @return [String]
+      def log_store(model)
+        type = registered?(model.name) ? :update : :create
 
-    # @return [String]
-    def log_store(model)
-      type = registered?(model.name) ? :update : :create
+        Vedeu.log(type: type, message: "#{model.class.name}: '#{model.name}'")
+      end
 
-      Vedeu.log(type: type, message: "#{model.class.name}: '#{model.name}'")
-    end
+    end # Repository
 
-  end # Repository
+  end # Repositories
 
 end # Vedeu

data/lib/vedeu/repositories/store.rb

@@ -1,81 +1,85 @@
 module Vedeu
 
-  # Provides generic repository related behaviour.
-  #
-  module Store
+  module Repositories
 
-    include Enumerable
+    # Provides generic repository related behaviour.
+    #
+    module Store
 
-    # @param block [Proc]
-    # @return [Enumerator]
-    def each(&block)
-      storage.each(&block)
-    end
+      include Enumerable
 
-    # Return a boolean indicating whether the storage is empty.
-    #
-    # @return [Boolean]
-    def empty?
-      storage.empty?
-    end
+      # @param block [Proc]
+      # @return [Enumerator]
+      def each(&block)
+        storage.each(&block)
+      end
 
-    # Returns a boolean indicating whether the named model is
-    # registered.
-    #
-    # @param name [String]
-    # @return [Boolean]
-    def exists?(name)
-      return false if empty? || name.nil? || name.empty?
+      # Return a boolean indicating whether the storage is empty.
+      #
+      # @return [Boolean]
+      def empty?
+        storage.empty?
+      end
 
-      storage.include?(name)
-    end
-    alias_method :registered?, :exists?
+      # Returns a boolean indicating whether the named model is
+      # registered.
+      #
+      # @param name [String]
+      # @return [Boolean]
+      def exists?(name)
+        return false if empty? || name.nil? || name.empty?
 
-    # Returns a collection of the names of all the registered
-    # entities.
-    #
-    # @return [Array]
-    def registered
-      return []           if empty?
-      return storage.keys if storage.is_a?(Hash)
-      return storage.to_a if storage.is_a?(Set)
+        storage.include?(name)
+      end
+      alias_method :registered?, :exists?
 
-      storage
-    end
+      # Returns a collection of the names of all the registered
+      # entities.
+      #
+      # @return [Array]
+      def registered
+        return []           if empty?
+        return storage.keys if storage.is_a?(Hash)
+        return storage.to_a if storage.is_a?(Set)
 
-    # Remove all currently stored data.
-    #
-    # @return [Array|Hash|Set]
-    def reset
-      Vedeu.log(type:    :reset,
-                message: "(#{self.class.name}) #{registered.inspect}")
+        storage
+      end
 
-      @storage = in_memory
-    end
-    alias_method :reset!, :reset
-    alias_method :clear, :reset
+      # Remove all currently stored data.
+      #
+      # @return [Array|Hash|Set]
+      def reset
+        Vedeu.log(type:    :reset,
+                  message: "(#{self.class.name}) #{registered.inspect}")
 
-    # Return the number of entries stored.
-    #
-    # @return [Fixnum]
-    def size
-      storage.size
-    end
+        @storage = in_memory
+      end
+      alias_method :reset!, :reset
+      alias_method :clear, :reset
 
-    # Return whole repository; provides raw access to the storage for
-    # this repository.
-    #
-    # @return [Array|Hash|Set]
-    def storage
-      @storage ||= in_memory
-    end
-    alias_method :all, :storage
-
-    # @return [Hash]
-    def in_memory
-      {}
-    end
-
-  end # Store
+      # Return the number of entries stored.
+      #
+      # @return [Fixnum]
+      def size
+        storage.size
+      end
+
+      # Return whole repository; provides raw access to the storage
+      # for this repository.
+      #
+      # @return [Array|Hash|Set]
+      def storage
+        @storage ||= in_memory
+      end
+      alias_method :all, :storage
+
+      # @return [Hash]
+      def in_memory
+        {}
+      end
+
+    end # Store
+
+  end # Repositories
 
 end # Vedeu

data/lib/vedeu/runtime/all.rb

@@ -0,0 +1,15 @@
+module Vedeu
+
+  module Runtime
+
+  end # Runtime
+
+end # Vedeu
+
+require 'vedeu/runtime/traps'
+require 'vedeu/runtime/launcher'
+require 'vedeu/runtime/bootstrap'
+require 'vedeu/runtime/router'
+require 'vedeu/runtime/main_loop'
+require 'vedeu/runtime/flags'
+require 'vedeu/runtime/application'

data/lib/vedeu/runtime/launcher.rb

@@ -1,15 +1,16 @@
 module Vedeu
 
-  # This class ensures that STDIN, STDOUT and STDERR point to the correct
-  # places. It also handles the initial configuration of the application,
-  # the starting of the application, the handling of uncaught exceptions and
-  # finally the exiting of the application with the correct exit code.
+  # This class ensures that STDIN, STDOUT and STDERR point to the
+  # correct places. It also handles the initial configuration of the
+  # application, the starting of the application, the handling of
+  # uncaught exceptions and finally the exiting of the application
+  # with the correct exit code.
   #
   class Launcher
 
     # @!attribute [r] exit_code
-    # @return [Fixnum] Return value indicating successful execution (0) or an
-    #   error occurred (1).
+    # @return [Fixnum] Return value indicating successful execution
+    #   (0) or an error occurred (1).
     attr_reader :exit_code
 
     # :nocov:
@@ -45,9 +46,9 @@ module Vedeu
     end
 
     # :nocov:
-    # If debugging is enabled, execute the application within the debugging
-    # context. At the moment, this simple uses 'ruby-prof' to profile the
-    # running application.
+    # If debugging is enabled, execute the application within the
+    # debugging context. At the moment, this simple uses 'ruby-prof'
+    # to profile the running application.
     #
     # @return [void]
     def debug_execute!
@@ -63,9 +64,10 @@ module Vedeu
     end
     # :nocov:
 
-    # Alters the STD[IN|OUT|ERR] to those requested by the client application,
-    # then starts the application. If an uncaught exception occurs during the
-    # application runtime, we exit ungracefully with any error message(s).
+    # Alters the STD[IN|OUT|ERR] to those requested by the client
+    # application, then starts the application. If an uncaught
+    # exception occurs during the application runtime, we exit
+    # ungracefully with any error message(s).
     #
     # @return [void]
     def execute!
@@ -95,7 +97,8 @@ module Vedeu
     private
 
     # :nocov:
-    # Terminates the application after resetting $stdin, $stdout and $stderr.
+    # Terminates the application after resetting $stdin, $stdout and
+    # $stderr.
     #
     # @return [void]
     def terminate!
@@ -109,9 +112,9 @@ module Vedeu
     end
     # :nocov:
 
-    # Use the arguments passed on the command-line along with those defined by
-    # the client application and Vedeu's defaults to configure the client
-    # application.
+    # Use the arguments passed on the command-line along with those
+    # defined by the client application and Vedeu's defaults to
+    # configure the client application.
     #
     # @return [Vedeu::Configuration]
     def configuration

data/lib/vedeu/templating/all.rb

@@ -7,3 +7,9 @@ module Vedeu
   end # Templating
 
 end # Vedeu
+
+require 'vedeu/templating/encoder'
+require 'vedeu/templating/decoder'
+require 'vedeu/templating/helpers'
+require 'vedeu/templating/template'
+require 'vedeu/templating/view_template'

data/lib/vedeu/terminal/all.rb

@@ -0,0 +1,14 @@
+module Vedeu
+
+  # This module is the direct interface between Vedeu and your
+  # terminal/ console, via Ruby's IO core library.
+  #
+  module Terminal
+
+  end # Terminal
+
+end # Vedeu
+
+require 'vedeu/terminal/mode'
+require 'vedeu/terminal/terminal'
+require 'vedeu/terminal/buffer'

data/lib/vedeu/terminal/buffer.rb

@@ -2,13 +2,14 @@ module Vedeu
 
   module Terminal
 
-    # All output will be written to this singleton, and #render will be called
-    # at the end of each run of {Vedeu::MainLoop}; effectively rendering this
-    # buffer to each registered renderer. This buffer is not cleared after this
-    # action though, as subsequent actions will modify the contents. This means
-    # that individual parts of Vedeu can write content here at various points
-    # and only at the end of each run of {Vedeu::MainLoop} will it be actually
-    # output 'somewhere'.
+    # All output will be written to this singleton, and #render will
+    # be called at the end of each run of {Vedeu::MainLoop};
+    # effectively rendering this buffer to each registered renderer.
+    # This buffer is not cleared after this action though, as
+    # subsequent actions will modify the contents. This means that
+    # individual parts of Vedeu can write content here at various
+    # points and only at the end of each run of {Vedeu::MainLoop} will
+    # it be actually output 'somewhere'.
     #
     module Buffer