vedeu 0.6.9 → 0.6.10

data/lib/vedeu/runtime/router.rb

@@ -1,184 +1,190 @@
 module Vedeu
 
-  # Stores all client application controllers with their respective actions.
-  #
-  module Router
+  module Runtime
 
-    include Vedeu::Common
-
-    extend self
-
-    # Registers a controller with the given controller name for the client
-    # application.
+    # Stores all client application controllers with their respective
+    # actions.
     #
-    # @param controller [Symbol]
-    # @param klass [String]
-    # @raise [Vedeu::Error::MissingRequired] When the controller name is not
-    #   given.
-    # @return [void]
-    def add_controller(controller, klass)
-      unless present?(controller)
-        fail Vedeu::Error::MissingRequired,
-             'Cannot store controller without a name attribute.'
-      end
+    module Router
+
+      include Vedeu::Common
+
+      extend self
+
+      # Registers a controller with the given controller name for the
+      # client application.
+      #
+      # @param controller [Symbol]
+      # @param klass [String]
+      # @raise [Vedeu::Error::MissingRequired] When the controller
+      #   name is not given.
+      # @return [void]
+      def add_controller(controller, klass)
+        unless present?(controller)
+          fail Vedeu::Error::MissingRequired,
+               'Cannot store controller without a name attribute.'
+        end
 
-      Vedeu.log(type:    :create,
-                message: "Controller: ':#{controller}'")
+        Vedeu.log(type:    :create,
+                  message: "Controller: ':#{controller}'")
 
-      if registered?(controller)
-        storage[controller].merge!(klass: klass)
+        if registered?(controller)
+          storage[controller].merge!(klass: klass)
 
-      else
-        storage.store(controller, klass: klass, actions: [])
+        else
+          storage.store(controller, klass: klass, actions: [])
+
+        end
 
+        storage
       end
 
-      storage
-    end
+      # Registers an action to the given controller name for the
+      # client application.
+      #
+      # @param controller [Symbol]
+      # @param action [Symbol]
+      # @raise [Vedeu::Error::MissingRequired] When the controller
+      #   name or action name is not given.
+      # @return [void]
+      def add_action(controller, action)
+        if present?(controller) && present?(action)
+          Vedeu.log(type:    :create,
+                    message: "Action: ':#{action}' (for ':#{controller}')")
 
-    # Registers an action to the given controller name for the client
-    # application.
-    #
-    # @param controller [Symbol]
-    # @param action [Symbol]
-    # @raise [Vedeu::Error::MissingRequired] When the controller name or action
-    #   name is not given.
-    # @return [void]
-    def add_action(controller, action)
-      if present?(controller) && present?(action)
-        Vedeu.log(type:    :create,
-                  message: "Action: ':#{action}' (for ':#{controller}')")
+          if registered?(controller)
+            storage[controller][:actions] << action
 
-        if registered?(controller)
-          storage[controller][:actions] << action
+          else
+            add_controller(controller, '')
+            add_action(controller, action)
 
-        else
-          add_controller(controller, '')
-          add_action(controller, action)
+          end
 
-        end
+          storage
 
-        storage
+        else
+          fail Vedeu::Error::MissingRequired,
+               'Cannot store action without a controller or name attribute.'
 
-      else
-        fail Vedeu::Error::MissingRequired,
-             'Cannot store action without a controller or name attribute.'
+        end
+      end
 
+      # Instruct Vedeu to load the client application controller
+      # action with parameters.
+      #
+      # @example
+      #   Vedeu.goto(controller, action, args)
+      #
+      # @param controller [Symbol]
+      # @param action [Symbol]
+      # @param args [void]
+      # @raise [Vedeu::Error::ModelNotFound] When the controller is
+      #   not registered.
+      # @return [void]
+      def goto(controller, action, **args)
+        Vedeu.log(type:    :debug,
+                  message: "Routing: #{controller} #{action}")
+
+        route(controller, action, args) if action_defined?(action, controller)
+      end
+      alias_method :action, :goto
+
+      # Returns a boolean indicating whether the given controller name
+      # is already registered.
+      #
+      # @param controller [Symbol]
+      # @return [Boolean]
+      def registered?(controller)
+        storage.key?(controller)
       end
-    end
 
-    # Instruct Vedeu to load the client application controller action with
-    # parameters.
-    #
-    # @example
-    #   Vedeu.goto(controller, action, args)
-    #
-    # @param controller [Symbol]
-    # @param action [Symbol]
-    # @param args [void]
-    # @raise [Vedeu::Error::ModelNotFound] When the controller is not
-    #   registered.
-    # @return [void]
-    def goto(controller, action, **args)
-      Vedeu.log(type:    :debug,
-                message: "Routing: #{controller} #{action}")
-
-      route(controller, action, args) if action_defined?(action, controller)
-    end
-    alias_method :action, :goto
-
-    # Returns a boolean indicating whether the given controller name is already
-    # registered.
-    #
-    # @param controller [Symbol]
-    # @return [Boolean]
-    def registered?(controller)
-      storage.key?(controller)
-    end
+      # Removes all stored controllers with their respective actions.
+      #
+      # @return [Hash<void>]
+      def reset!
+        @storage = in_memory
+      end
+      alias_method :reset, :reset!
 
-    # Removes all stored controllers with their respective actions.
-    #
-    # @return [Hash<void>]
-    def reset!
-      @storage = in_memory
-    end
-    alias_method :reset, :reset!
+      private
 
-    private
+      # Returns a boolean indicating whether the given action name is
+      # defined for the given controller.
+      #
+      # @param action [Symbol]
+      # @param controller [Symbol]
+      # @return [Boolean]
+      def action_defined?(action, controller)
+        if registered?(controller)
+          return true if storage[controller][:actions].include?(action)
 
-    # Returns a boolean indicating whether the given action name is defined for
-    # the given controller.
-    #
-    # @param action [Symbol]
-    # @param controller [Symbol]
-    # @return [Boolean]
-    def action_defined?(action, controller)
-      if registered?(controller)
-        return true if storage[controller][:actions].include?(action)
+          fail Vedeu::Error::ActionNotFound,
+               "#{action} is not registered for #{controller}."
 
-        fail Vedeu::Error::ActionNotFound,
-             "#{action} is not registered for #{controller}."
+        else
+          fail Vedeu::Error::ControllerNotFound,
+               "#{controller} is not registered."
 
-      else
-        fail Vedeu::Error::ControllerNotFound,
-             "#{controller} is not registered."
+        end
+      end
 
+      # Instantiate the given controller by name, the call the action
+      # (method) with any given arguments.
+      #
+      # @param controller [Symbol]
+      # @param action [Symbol]
+      # @param args [Symbol]
+      # @return [void]
+      def route(controller, action, **args)
+        klass = Object.const_get(klass_for(controller)).new(**args)
+        klass.send(action)
       end
-    end
 
-    # Instantiate the given controller by name, the call the action (method)
-    # with any given arguments.
-    #
-    # @param controller [Symbol]
-    # @param action [Symbol]
-    # @param args [Symbol]
-    # @return [void]
-    def route(controller, action, **args)
-      klass = Object.const_get(klass_for(controller)).new(**args)
-      klass.send(action)
-    end
-
-    # Fetch the class for the controller by name.
-    #
-    # @param controller [Symbol]
-    # @raise [Vedeu::Error::MissingRequired] When the given controller name does
-    #   not have a class defined.
-    # @return [String]
-    def klass_for(controller)
-      if registered?(controller) && klass_defined?(controller)
-        storage[controller][:klass]
-
-      else
-        fail Vedeu::Error::MissingRequired,
-             "Cannot route to #{controller} as no class defined."
+      # Fetch the class for the controller by name.
+      #
+      # @param controller [Symbol]
+      # @raise [Vedeu::Error::MissingRequired] When the given
+      #   controller name does not have a class defined.
+      # @return [String]
+      def klass_for(controller)
+        if registered?(controller) && klass_defined?(controller)
+          storage[controller][:klass]
 
+        else
+          fail Vedeu::Error::MissingRequired,
+               "Cannot route to #{controller} as no class defined."
+
+        end
       end
-    end
 
-    # Returns a boolean indicating whether the given controller name has a class
-    # defined.
-    #
-    # @param controller [Symbol]
-    # @return [Boolean]
-    def klass_defined?(controller)
-      present?(storage[controller][:klass])
-    end
+      # Returns a boolean indicating whether the given controller name
+      # has a class defined.
+      #
+      # @param controller [Symbol]
+      # @return [Boolean]
+      def klass_defined?(controller)
+        present?(storage[controller][:klass])
+      end
 
-    # Returns all the stored controllers and their respective actions.
-    #
-    # @return [Hash<Symbol => Hash<Symbol => String|Array<Symbol>>>]
-    def storage
-      @storage ||= in_memory
-    end
+      # Returns all the stored controllers and their respective
+      # actions.
+      #
+      # @return [Hash<Symbol => Hash<Symbol => String|Array<Symbol>>>]
+      def storage
+        @storage ||= in_memory
+      end
 
-    # Returns an empty collection ready for the storing of client application
-    # controllers and actions.
-    #
-    # @return [Hash<void>]
-    def in_memory
-      {}
-    end
+      # Returns an empty collection ready for the storing of client
+      # application controllers and actions.
+      #
+      # @return [Hash<void>]
+      def in_memory
+        {}
+      end
+
+    end # Router
 
-  end # Router
+  end # Runtime
 
 end # Vedeu

data/lib/vedeu/templating/decoder.rb

@@ -2,7 +2,8 @@ module Vedeu
 
   module Templating
 
-    # Converts an encoded string back into an object or collection of objects.
+    # Converts an encoded string back into an object or collection of
+    # objects.
     #
     class Decoder
 
@@ -20,7 +21,8 @@ module Vedeu
         @data = data
       end
 
-      # Converts an encoded string back into an object or collection of objects.
+      # Converts an encoded string back into an object or collection
+      # of objects.
       #
       # @return [Object]
       def process
@@ -35,7 +37,8 @@ module Vedeu
 
       private
 
-      # Convert the marshalled object or objects back into an object(s).
+      # Convert the marshalled object or objects back into an
+      # object(s).
       #
       # @return [Object]
       def demarshal
@@ -49,8 +52,8 @@ module Vedeu
         Zlib::Inflate.inflate(decode64)
       end
 
-      # Decode the Base64 string into a compressed, marshalled object or
-      # objects.
+      # Decode the Base64 string into a compressed, marshalled object
+      # or objects.
       #
       # @return [String]
       def decode64

data/lib/vedeu/templating/encoder.rb

@@ -2,7 +2,8 @@ module Vedeu
 
   module Templating
 
-    # Converts an object or collection of objects into an encoded String.
+    # Converts an object or collection of objects into an encoded
+    # String.
     #
     class Encoder
 
@@ -20,7 +21,8 @@ module Vedeu
         @data = data
       end
 
-      # Converts an object or collection of objects into an encoded String.
+      # Converts an object or collection of objects into an encoded
+      # String.
       #
       # @return [String]
       def process
@@ -42,8 +44,8 @@ module Vedeu
         "{{#{encode64}}}"
       end
 
-      # Encode the compressed, marshalled object or objects into a Base64
-      # string.
+      # Encode the compressed, marshalled object or objects into a
+      # Base64 string.
       #
       # @return [String]
       def encode64

data/lib/vedeu/templating/template.rb

@@ -47,8 +47,8 @@ module Vedeu
         File.read(path)
       end
 
-      # @raise [Vedeu::Error::MissingRequired] When the path is empty or does
-      #   not exist.
+      # @raise [Vedeu::Error::MissingRequired] When the path is empty
+      #   or does not exist.
       # @return [String]
       def path
         fail Vedeu::Error::MissingRequired,

data/lib/vedeu/templating/view_template.rb

@@ -2,7 +2,8 @@ module Vedeu
 
   module Templating
 
-    # Extend Template to provide client application view specific parsing.
+    # Extend Template to provide client application view specific
+    # parsing.
     #
     class ViewTemplate < Template
 
@@ -48,8 +49,8 @@ module Vedeu
 
       private
 
-      # Return the interface colours if a name option is set, otherwise use the
-      # default colours.
+      # Return the interface colours if a name option is set,
+      # otherwise use the default colours.
       #
       # @return [Vedeu::Colours::Colour|Hash<Symbol => Symbol>]
       def default_colour
@@ -65,8 +66,8 @@ module Vedeu
         end
       end
 
-      # Return the interface style(s) if a name option is set, otherwise use the
-      # default style.
+      # Return the interface style(s) if a name option is set,
+      # otherwise use the default style.
       #
       # @return [Symbol]
       def default_style
@@ -95,8 +96,8 @@ module Vedeu
         line.split(/({{\s*[^}]+\s*}})/)
       end
 
-      # Convert the content into an array of strings without the line ending
-      # character.
+      # Convert the content into an array of strings without the line
+      # ending character.
       #
       # @return [Array<String>]
       def lines

data/lib/vedeu/terminal/buffer.rb

@@ -0,0 +1,132 @@
+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'.
+    #
+    module Buffer
+
+      extend self
+
+      # Return a grid of {Vedeu::Models::Cell} objects defined by the
+      # height and width of this virtual terminal.
+      #
+      # @return [Array<Array<Vedeu::Models::Cell>>]
+      def buffer
+        @output ||= empty_buffer.dup
+      end
+      alias_method :cells, :buffer
+
+      # @return [Array<Array<Vedeu::Models::Cell>>]
+      def empty_buffer
+        Array.new(Vedeu.height) do |y|
+          Array.new(Vedeu.width) do |x|
+            Vedeu::Models::Cell.new(position: [y + 1, x + 1])
+          end
+        end
+      end
+
+      # @return [Vedeu::Models::Page]
+      def output
+        Vedeu::Models::Page.coerce(buffer)
+      end
+
+      # Read a single cell from the virtual terminal.
+      #
+      # @note
+      #   Given two actual coordinates (y, x) e.g. (1, 1)
+      #   Convert to coordinate indices (cy, cx) e.g. (0, 0)
+      #   Fetch the row at cy and return the cell from cx
+      #
+      # @param y [Fixnum] The row/line coordinate.
+      # @param x [Fixnum] The column/character coordinate.
+      # @return [Vedeu::Views::Char]
+      def read(y, x)
+        cy, cx = Vedeu::Geometry::Position[y, x].as_indices
+
+        row  = fetch(cells, cy)
+        cell = fetch(row, cx)
+
+        cell
+      end
+
+      # Send the cells to the renderer and return the rendered result.
+      #
+      # @return [String|void] Most likely to be a String.
+      def render
+        Vedeu.renderers.render(output) if Vedeu.ready?
+      end
+
+      # Removes all content from the virtual terminal; effectively
+      # clearing it.
+      #
+      # @return [Array<Array<Vedeu::Models::Cell>>]
+      def reset
+        @output = empty_buffer
+      end
+      alias_method :clear, :reset
+
+      # Write a collection of cells to the virtual terminal.
+      #
+      # @param value [Array<Array<Vedeu::Views::Char>>]
+      # @return [Array<Array<Vedeu::Views::Char>>]
+      def write(value)
+        values = Array(value).flatten
+
+        values.each do |v|
+          buffer[v.position.y][v.position.x] = v if valid_position?(v)
+        end
+
+        self
+      end
+
+      private
+
+      # @param from [Array] An Array of rows, or an Array of cells.
+      # @param which [Fixnum] A Fixnum representing the index; the row
+      #   number or the cell number for a row.
+      # @return [Array<Vedeu::Views::Char>|Array]
+      def fetch(from, which)
+        from[which] || []
+      end
+
+      # Returns a boolean indicating the value has a position
+      # attribute.
+      #
+      # @param value [void]
+      # @return [Boolean]
+      def position?(value)
+        value.respond_to?(:position) &&
+          value.position.is_a?(Vedeu::Geometry::Position)
+      end
+
+      # Returns a boolean indicating the value has a position
+      # attribute and is within the terminal boundary.
+      #
+      # @param value [void]
+      # @return [Boolean]
+      def valid_position?(value)
+        position?(value) && within_terminal_boundary?(value)
+      end
+
+      # Returns a boolean indicating the position of the value object
+      # is valid for this terminal.
+      #
+      # @param value [void]
+      # @return [Boolean]
+      def within_terminal_boundary?(value)
+        value.position.y > 0 && value.position.y <= Vedeu.height &&
+          value.position.x > 0 && value.position.x <= Vedeu.width
+      end
+
+    end # Buffer
+
+  end # Terminal
+
+end # Vedeu

data/lib/vedeu/terminal/terminal.rb

@@ -207,11 +207,6 @@ module Vedeu
       IO.console
     end
 
-    # @return [Vedeu::Buffers::VirtualBuffer]
-    def virtual
-      @virtual ||= Vedeu::Buffers::VirtualBuffer.new(height, width)
-    end
-
   end # Terminal
 
 end # Vedeu

data/lib/vedeu/version.rb

@@ -1,6 +1,6 @@
 module Vedeu
 
   # The current version of Vedeu.
-  VERSION = '0.6.9'
+  VERSION = '0.6.10'
 
 end

data/lib/vedeu.rb

@@ -53,8 +53,8 @@ module Vedeu
   # @param receiver [void]
   # @return [void]
   def included(receiver)
-    receiver.send(:include, API)
-    receiver.extend(API)
+    receiver.send(:include, Vedeu::API::External)
+    receiver.extend(Vedeu::API::External)
   end
   # :nocov:
 

data/out_

@@ -0,0 +1,50 @@
+<html>
+  <head>
+    <style type='text/css'>
+      body {
+        background:#000;
+      }
+      td {
+        border:1px #171717 solid;
+        font-size:12px;
+        font-family:monospace;
+        height:18px;
+        margin:1px;
+        text-align:center;
+        vertical-align:center;
+        width:18px;
+      }
+    </style>
+  </head>
+  <body>
+    <table>
+      <tr>
+
+</tr>
+<tr>
+
+</tr>
+<tr>
+
+</tr>
+<tr>
+
+</tr>
+<tr>
+
+</tr>
+<tr>
+
+</tr>
+<tr>
+
+</tr>
+<tr>
+
+</tr>
+<tr>
+
+</tr>
+    </table>
+  </body>
+</html>