vedeu 0.5.3 → 0.5.4

data/lib/vedeu/distributed/server.rb

@@ -86,7 +86,7 @@ module Vedeu
       def restart
         log('Attempting to restart')
 
-        return not_enabled unless drb?
+        return not_enabled unless Vedeu::Configuration.drb?
 
         if drb_running?
           log('Restarting')
@@ -112,7 +112,7 @@ module Vedeu
       #
       # @return [void]
       def shutdown
-        return not_enabled unless drb?
+        return not_enabled unless Vedeu::Configuration.drb?
 
         stop if drb_running?
 
@@ -127,7 +127,7 @@ module Vedeu
       def start
         log('Attempting to start')
 
-        return not_enabled unless drb?
+        return not_enabled unless Vedeu::Configuration.drb?
 
         if drb_running?
           log('Already started')
@@ -147,7 +147,7 @@ module Vedeu
       def status
         log('Fetching status')
 
-        return not_enabled unless drb?
+        return not_enabled unless Vedeu::Configuration.drb?
 
         if drb_running?
           log('Running')
@@ -168,7 +168,7 @@ module Vedeu
       def stop
         log('Attempting to stop')
 
-        return not_enabled unless drb?
+        return not_enabled unless Vedeu::Configuration.drb?
 
         if drb_running?
           log('Stopping')
@@ -193,26 +193,11 @@ module Vedeu
 
       private
 
-      # @return [Boolean]
-      def drb?
-        Vedeu::Configuration.drb?
-      end
-
-      # @return [String]
-      def drb_host
-        Vedeu::Configuration.drb_host
-      end
-
       # @return [|NilClass]
       def drb_running?
         DRb.thread
       end
 
-      # @return [Fixnum|String]
-      def drb_port
-        Vedeu::Configuration.drb_port
-      end
-
       # @return [void]
       def log(message)
         Vedeu.log(type: :drb, message: "#{message}: '#{uri}'")
@@ -227,7 +212,8 @@ module Vedeu
 
       # @return [String]
       def uri
-        Vedeu::Distributed::Uri.new(drb_host, drb_port).to_s
+        Vedeu::Distributed::Uri.new(Vedeu::Configuration.drb_host,
+                                    Vedeu::Configuration.drb_port).to_s
       end
 
     end # Server

data/lib/vedeu/dsl/view.rb

@@ -81,6 +81,8 @@ module Vedeu
 
       class << self
 
+        include Vedeu::Common
+
         # Register an interface by name which will display output from a event
         # or command. This provides the means for you to define your the views
         # of your application without their content.
@@ -89,11 +91,6 @@ module Vedeu
         #     # ... some code
         #   end
         #
-        #   Vedeu.interface do
-        #     name 'interfaces_must_have_a_name'
-        #     # ... some code
-        #   end
-        #
         # @param name [String] The name of the interface. Used to reference the
         #   interface throughout your application's execution lifetime.
         # @param block [Proc] A set of attributes which define the features of
@@ -101,8 +98,13 @@ module Vedeu
         # @raise [Vedeu::InvalidSyntax] The required block was not given.
         # @return [Vedeu::Interface]
         # @todo More documentation required.
-        def interface(name = '', &block)
+        def interface(name, &block)
           fail Vedeu::InvalidSyntax, 'block not given' unless block_given?
+          fail Vedeu::MissingRequired, 'name not given' unless present?(name)
+
+          add_buffers!(name)
+          add_cursor!(name)
+          add_focusable!(name)
 
           attributes = { client: client(&block), name: name }
 
@@ -199,6 +201,29 @@ module Vedeu
 
         private
 
+        # Registers a set of buffers for the interface unless already registered,
+        # and also adds interface's name to list of focussable interfaces.
+        #
+        # @see Vedeu::Buffer
+        # @return [void]
+        def add_buffers!(name)
+          Vedeu::Buffer.new(name: name).store
+        end
+
+        # Registers a new cursor for the interface unless already registered.
+        #
+        # @return [void]
+        def add_cursor!(name)
+          Vedeu::Cursor.new(name: name).store
+        end
+
+        # Registers interface name in focus list unless already registered.
+        #
+        # @return [void]
+        def add_focusable!(name)
+          Vedeu.focusable.add(name) unless Vedeu.focusable.registered?(name)
+        end
+
         # Returns the client object which called the DSL method.
         #
         # @param block [Proc]

data/lib/vedeu/internal_api.rb

@@ -118,6 +118,13 @@ module Vedeu
     # @return [Vedeu::Menus]
     def_delegators Vedeu::Menus, :menus
 
+    # Manipulate the internal flags.
+    #
+    # @!method ready?
+    # @!method ready!
+    # @return [Boolean]
+    def_delegators Vedeu::Flags, :ready?, :ready!
+
     # @example
     #   Vedeu.renderer
     #   Vedeu.renderers

data/lib/vedeu/log/log.rb

@@ -97,7 +97,10 @@ module Vedeu
       def log(message:, force: false, type: :info)
         output = log_entry(type, message)
 
-        logger.debug(output) if enabled? || force
+        if (enabled? || force) && (Vedeu::Configuration.log_only.empty? ||
+                   Vedeu::Configuration.log_only.include?(type))
+          logger.debug(output)
+        end
 
         output
       end
@@ -135,7 +138,7 @@ module Vedeu
       #   combined.
       # @return [String]
       def formatted_message(message)
-        "#{timestamp}#{message}\n"
+        "#{timestamp}#{message}\n" if message
       end
 
       # Returns the message:

data/lib/vedeu/models/escape.rb

@@ -7,15 +7,17 @@ module Vedeu
     # @!attribute [r] value
     # @return [String]
     attr_reader :value
-    alias_method :to_s, :value
-    alias_method :to_str, :value
 
     # Returns a new instance of Vedeu::Escape.
     #
-    # @param value [String]
+    # @param attributes [String]
+    # @option attributes position [Vedeu::Position|Array<Fixnum>]
+    # @option attributes value [String]
     # @return [Vedeu::Escape]
-    def initialize(value)
-      @value = value
+    def initialize(attributes = {})
+      @attributes = defaults.merge!(attributes)
+
+      @attributes.each { |key, value| instance_variable_set("@#{key}", value) }
     end
 
     # @return [String]
@@ -41,7 +43,7 @@ module Vedeu
 
     # @return [String]
     def position
-      ''
+      Vedeu::Position.coerce(@position)
     end
 
     # @return [String]
@@ -49,6 +51,22 @@ module Vedeu
       ''
     end
 
+    # @return [String]
+    def to_s
+      "#{position}#{value}"
+    end
+    alias_method :to_str, :to_s
+
+    private
+
+    # @return [Hash]
+    def defaults
+      {
+        position: [1, 1],
+        value:    '',
+      }
+    end
+
   end # Escape
 
 end # Vedeu

data/lib/vedeu/models/interface.rb

@@ -124,16 +124,14 @@ module Vedeu
     def render
       return [] unless visible?
 
-      Vedeu.trigger(:_hide_cursor_, name)
-
       output = [
+        Vedeu.trigger(:_hide_cursor_, name),
         Vedeu::Clear::NamedInterface.render(name),
         Vedeu::Viewport.render(self),
         Vedeu.borders.by_name(name).render,
+        Vedeu.trigger(:_show_cursor_, name)
       ]
 
-      Vedeu.trigger(:_show_cursor_, name)
-
       output
     end
 
@@ -150,16 +148,6 @@ module Vedeu
       Vedeu.buffers.by_name(name).show
     end
 
-    # @return [Vedeu::Interface]
-    def store
-      super
-
-      store_new_buffer
-      store_focusable
-      store_cursor
-      store_group
-    end
-
     private
 
     # The default values for a new instance of this class.

data/lib/vedeu/null/buffer.rb

@@ -22,35 +22,21 @@ module Vedeu
       end
 
       # @return [NilClass]
-      def clear
-        nil
-      end
-
-      # @return [NilClass]
-      def hide
+      def null(*)
         nil
       end
+      alias_method :add, :null
+      alias_method :clear, :null
+      alias_method :hide, :null
+      alias_method :render, :null
+      alias_method :show, :null
+      alias_method :toggle, :null
 
       # @return [Boolean]
       def null?
         true
       end
 
-      # @return [NilClass]
-      def render
-        nil
-      end
-
-      # @return [NilClass]
-      def show
-        nil
-      end
-
-      # @return [NilClass]
-      def toggle
-        nil
-      end
-
     end # Buffer
 
   end # Null

data/lib/vedeu/null/generic.rb

@@ -17,35 +17,24 @@ module Vedeu
       end
 
       # @return [NilClass]
-      def add(*)
-        nil
-      end
-
-      # @return [NilClass]
-      def colour
+      def null(*)
         nil
       end
+      alias_method :add, :null
+      alias_method :colour, :null
+      alias_method :parent, :null
+      alias_method :style, :null
 
       # @return [Boolean]
       def null?
         true
       end
 
-      # @return [NilClass]
-      def parent
-        nil
-      end
-
       # @return [Vedeu::Null::Generic]
       def store
         self
       end
 
-      # @return [NilClass]
-      def style
-        nil
-      end
-
       # The generic null should not be visible.
       #
       # @return [FalseClass]

data/lib/vedeu/null/interface.rb

@@ -35,27 +35,20 @@ module Vedeu
       end
 
       # @return [NilClass]
-      def hide
+      def null
         nil
       end
+      alias_method :hide, :null
+      alias_method :parent, :null
+      alias_method :show, :null
+      alias_method :toggle, :null
+      alias_method :zindex, :null
 
       # @return [Boolean]
       def null?
         true
       end
 
-      # The null interface should not have a parent.
-      #
-      # @return [NilClass]
-      def parent
-        nil
-      end
-
-      # @return [NilClass]
-      def show
-        nil
-      end
-
       # Pretend to store this model in the repository.
       #
       # @return [Vedeu::Null::Interface]
@@ -63,11 +56,6 @@ module Vedeu
         self
       end
 
-      # @return [NilClass]
-      def toggle
-        nil
-      end
-
       # The null interface should not be visible.
       #
       # @return [FalseClass]

data/lib/vedeu/runtime/bootstrap.rb

@@ -113,7 +113,7 @@ module Vedeu
 
     # @return [Class]
     def root
-      Object.const_get(Vedeu::Configuration.root) if Vedeu::Configuration.root
+      Vedeu::Configuration.root if Vedeu::Configuration.root
     end
 
   end # Bootstrap

data/lib/vedeu/runtime/flags.rb

@@ -0,0 +1,57 @@
+module Vedeu
+
+  # Home of various runtime flags which Vedeu uses.
+  #
+  class Flags
+
+    include Singleton
+
+    class << self
+
+      # @return [Boolean]
+      def ready!
+        instance.options[:ready] = true
+      end
+
+      # @return [Boolean]
+      def ready?
+        instance.options[:ready]
+      end
+
+      # Reset the flags to the default values.
+      #
+      # @return [Hash]
+      def reset!
+        instance.reset!
+      end
+
+    end # Eigenclass
+
+    # @!attribute [rw]
+    # @return [Hash]
+    attr_accessor :options
+
+    # Create a new singleton instance of Vedeu::Flags.
+    #
+    # @return [Vedeu::Flags]
+    def initialize
+      self.options = defaults
+    end
+
+    # @return [Hash]
+    def reset!
+      self.options = defaults
+    end
+
+    private
+
+    # @return [Hash]
+    def defaults
+      {
+        ready: false,
+      }
+    end
+
+  end # Flags
+
+end # Vedeu