vedeu 0.6.21 → 0.6.22

data/lib/vedeu/configuration/configuration.rb

@@ -89,8 +89,8 @@ module Vedeu
       end
 
       # Returns whether debugging is enabled or disabled. Default is
-      # false; meaning nothing apart from warnings are written to the
-      # log file.
+      # false; meaning only the top line of a backtrace from an
+      # exception is shown to the user of the client application.
       #
       # @return [Boolean]
       def debug?
@@ -183,6 +183,15 @@ module Vedeu
       end
       alias_method :once, :once?
 
+      # Returns a boolean indicating whether profiling has been
+      # enabled.
+      #
+      # @return [Boolean]
+      def profile?
+        instance.options[:profile]
+      end
+      alias_method :profile, :profile?
+
       # Returns the renderers which should receive output.
       #
       # @return [Array<Class>]
@@ -304,6 +313,7 @@ module Vedeu
         log:           nil,
         log_only:      [],
         once:          false,
+        profile:       false,
         renderers:     [Vedeu::Renderers::Terminal.new],
         root:          nil,
         stdin:         nil,
@@ -335,6 +345,10 @@ module Vedeu
 
   end # Configuration
 
+  require 'vedeu/output/renderers/all'
+
+  Vedeu::Configuration.configure({})
+
   # @!method configure
   #   @see Vedeu::Configuration.configure
   # @!method configuration

data/lib/vedeu/cursors/refresh.rb

@@ -36,7 +36,7 @@ module Vedeu
       def by_name
         Vedeu.log(type: :info, message: "Refreshing cursor: '#{name}'")
 
-        Vedeu.trigger(:_refresh_view_, name) if refresh_view?
+        Vedeu.trigger(:_refresh_view_content_, name) if refresh_view?
 
         cursor.render
       end

data/lib/vedeu/distributed/templates/default_configuration.vedeu

@@ -2,6 +2,7 @@ Vedeu.configure do
   # compression false
   # log         '/tmp/your_app.log'
   # debug!
+  # profile!
   # drb!
   # drb_host    'localhost'
   # drb_port    21420

data/lib/vedeu/editor/document.rb

@@ -58,7 +58,7 @@ module Vedeu
       #
       # @return [void]
       def clear
-        Vedeu.trigger(:_clear_view_, name)
+        Vedeu.trigger(:_clear_view_content_, name)
       end
 
       # Deletes the character from the line where the cursor is
@@ -249,8 +249,6 @@ module Vedeu
           end
         end
 
-        out << border.render
-
         cursor.store
 
         out.flatten

data/lib/vedeu/logging/debug.rb

@@ -10,16 +10,19 @@ module Vedeu
       extend self
 
       # :nocov:
-      # Helps to debug a running application by providing a stack
+      # Helps to profile a running application by providing a stack
       # trace of its execution upon exiting.
       #
       # @example
-      #   Vedeu.debug
+      #   Vedeu.profile('some_file.html') do
+      #     # ... code to profile ...
+      #   end
       #
-      # @param filename [String]
+      # @param filename [String] Optional, and defaults to being
+      #   written to the /tmp directory.
       # @return [void]
-      # @yieldreturn [void] The section of the application to debug.
-      def self.debug(filename = 'profile.html')
+      # @yieldreturn [void] The section of the application to profile.
+      def self.profile(filename = 'profile.html')
         return nil unless block_given?
 
         require 'ruby-prof'
@@ -88,10 +91,10 @@ module Vedeu
   # ruby-prof.
   #
   # @example
-  #   Vedeu.debug
+  #   Vedeu.profile
   #
-  # @!method debug
+  # @!method profile
   # @return [Vedeu::Logging::Debug]
-  def_delegators Vedeu::Logging::Debug, :debug
+  def_delegators Vedeu::Logging::Debug, :profile
 
 end # Vedeu

data/lib/vedeu/logging/timer.rb

@@ -3,18 +3,23 @@ module Vedeu
   module Logging
 
     # Measure the duration. Used for debugging.
+    # The configuration option 'debug' must be set to true to enable
+    # this functionality.
     #
     class Timer
 
       class << self
 
         # Measure the execution time of the code in the given block.
+        # The message provided will have ' took <time>ms.' appended.
         #
         # @example
-        #   Vedeu.timer 'message' do
+        #   Vedeu.timer 'Really complex code' do
         #     # ... code to be measured
         #   end
         #
+        #   # => 'Really complex code took 0.234ms.'
+        #
         # @param message [String]
         # @param block [Proc]
         # @return [void] The return value of the executed block.
@@ -36,13 +41,22 @@ module Vedeu
       # Write an entry to the log file stating how long a section of
       # code took in milliseconds. Useful for debugging performance.
       #
+      # @raise [Vedeu::Error::RequiresBlock]
       # @return [void] The return value of the executed block.
       def measure
-        work = yield
+        fail Vedeu::Error::RequiresBlock unless block_given?
+
+        if Vedeu::Configuration.debug?
+          work = yield
+
+          Vedeu.log(type: :timer, message: "#{message} took #{elapsed}ms.")
 
-        Vedeu.log(type: :timer, message: "#{message} took #{elapsed}ms.")
+          work
 
-        work
+        else
+          yield
+
+        end
       end
 
       protected

data/lib/vedeu/models/interface.rb

@@ -61,30 +61,42 @@ module Vedeu
         end
       end
 
-      # Hide a named interface buffer, or without a name, the buffer
-      # of the currently focussed interface.
+      # Hide the named interface.
+      #
+      # Will hide the named interface. If the interface is currently
+      # visible, it will be cleared- rendered blank. To show the
+      # interface, the ':_show_interface_' event should be triggered.
+      # Triggering the ':_hide_group_' event to which this named
+      # interface belongs will also hide the interface.
       #
       # @example
+      #   Vedeu.trigger(:_hide_interface_, name)
       #   Vedeu.hide_interface(name)
       #
       # @return [void]
       def hide
         super
 
-        Vedeu.buffers.by_name(name).hide
+        Vedeu.trigger(:_clear_view_, name)
       end
 
-      # Show the named interface buffer, or without a name, the buffer
-      # of the currently focussed interface.
+      # Show the named interface.
+      #
+      # Will hide the named interface. If the interface is currently
+      # visible, it will be cleared- rendered blank. To show the
+      # interface, the ':_show_interface_' event should be triggered.
+      # Triggering the ':_hide_group_' event to which this named
+      # interface belongs will also hide the interface.
       #
       # @example
+      #   Vedeu.trigger(:_show_interface_, name)
       #   Vedeu.show_interface(name)
       #
       # @return [void]
       def show
         super
 
-        Vedeu.buffers.by_name(name).show
+        Vedeu.trigger(:_refresh_view_, name)
       end
 
       private

data/lib/vedeu/models/views/view.rb

@@ -78,16 +78,9 @@ module Vedeu
 
       # @return [Array<Array<Vedeu::Views::Char>>]
       def render
-        return [] unless visible?
+        Vedeu.trigger(:_clear_view_content_, name)
 
-        Vedeu.trigger(:_clear_view_, name)
-
-        output = [
-          Vedeu::Output::Viewport.render(self),
-          Vedeu.borders.by_name(name).render,
-        ]
-
-        output
+        Vedeu::Output::Viewport.render(self)
       end
 
       # Store the view and immediately refresh it; causing to be

data/lib/vedeu/output/clear/interface.rb

@@ -11,6 +11,7 @@ module Vedeu
         # Clear the interface with the given name.
         #
         # @example
+        #   Vedeu.trigger(:_clear_view_, name)
         #   Vedeu.clear_by_name(name)
         #
         # @return [Array<Array<Vedeu::Views::Char>>]
@@ -21,14 +22,31 @@ module Vedeu
         alias_method :clear_by_name, :render
         alias_method :by_name, :render
 
+        # Clear the content of the interface with the given name.
+        #
+        # @example
+        #   Vedeu.trigger(:_clear_view_content_, name)
+        #   Vedeu.clear_content_by_name(name)
+        #
+        # @return [Array<Array<Vedeu::Views::Char>>]
+        # @see #initialize
+        def clear_content_by_name(name)
+          new(name, content_only: true).render
+        end
+
       end # Eigenclass
 
       # Return a new instance of Vedeu::Clear::Interface.
       #
-      # @param name [String|Symbol] The name of the interface to clear.
+      # @param name [String|Symbol] The name of the interface to
+      #   clear.
+      # @param options [Hash]
+      # @option options content_only [Boolean] Only clear the content
+      #   not the border as well. Defaults to false.
       # @return [Vedeu::Clear::Interface]
-      def initialize(name)
-        @name = name
+      def initialize(name, options = {})
+        @name    = name
+        @options = options
       end
 
       # @return [Array<Array<Vedeu::Views::Char>>]
@@ -44,16 +62,50 @@ module Vedeu
 
       private
 
+      # @see Vedeu::Borders::Repository#by_name
+      def border
+        @border ||= Vedeu.borders.by_name(name)
+      end
+
+      # @return [Vedeu::Colours::Colour]
+      def colour
+        interface.colour
+      end
+
+      # @return [Boolean]
+      def content_only?
+        options[:content_only]
+      end
+
+      # @return [Hash<Symbol => Boolean>]
+      def defaults
+        {
+          content_only: false,
+        }
+      end
+
       # @see Vedeu::Geometry::Repository#by_name
       def geometry
         @geometry ||= Vedeu.geometries.by_name(name)
       end
 
+      # @return [Fixnum]
+      def height
+        return border.height if content_only?
+
+        geometry.height
+      end
+
       # @see Vedeu::Models::Interfaces#by_name
       def interface
         @interface ||= Vedeu.interfaces.by_name(name)
       end
 
+      # @return [Hash<Symbol => Boolean>]
+      def options
+        defaults.merge!(@options)
+      end
+
       # For each visible line of the interface, set the foreground and
       # background colours to those specified when the interface was
       # defined, then starting write space characters over the area
@@ -61,12 +113,12 @@ module Vedeu
       #
       # @return [Array<Array<Vedeu::Views::Char>>]
       def output
-        Vedeu.timer("Clearing: '#{name}'") do
-          @y      = geometry.y
-          @x      = geometry.x
-          @width  = geometry.width
-          @height = geometry.height
-          @colour = interface.colour
+        Vedeu.timer("Clearing #{clearing}: '#{name}'") do
+          @y      = y
+          @x      = x
+          @width  = width
+          @height = height
+          @colour = colour
 
           @clear ||= Array.new(@height) do |iy|
             Array.new(@width) do |ix|
@@ -78,6 +130,34 @@ module Vedeu
         end
       end
 
+      # @return [String]
+      def clearing
+        return '(content only)' if content_only?
+
+        '(all)'
+      end
+
+      # @return [Fixnum]
+      def width
+        return border.width if content_only?
+
+        geometry.width
+      end
+
+      # @return [Fixnum]
+      def y
+        return border.by if content_only?
+
+        geometry.y
+      end
+
+      # @return [Fixnum]
+      def x
+        return border.bx if content_only?
+
+        geometry.x
+      end
+
     end # Interface
 
   end # Clear
@@ -86,4 +166,8 @@ module Vedeu
   #   @see Vedeu::Clear::Interface.render
   def_delegators Vedeu::Clear::Interface, :clear_by_name
 
+  # @!method clear_content_by_name
+  #   @see Vedeu::Clear::Interface.clear_content_by_name
+  def_delegators Vedeu::Clear::Interface, :clear_content_by_name
+
 end # Vedeu

data/lib/vedeu/output/direct.rb

@@ -26,8 +26,6 @@ module Vedeu
 
       # @return [String]
       def write
-        Vedeu.log(type:    :output,
-                  message: 'Directly writing output to terminal.')
         Vedeu::Terminal.output(output)
 
         output

data/lib/vedeu/output/viewport.rb

@@ -42,29 +42,16 @@ module Vedeu
 
       # Returns the content for the view.
       #
-      # @return [Array<Array<String>>]
+      # @return [Array<Array<String>>|NilClass]
       def render
-        return [] unless visible?
-
-        Vedeu.timer("Rendering: '#{name}'") do
-          out = []
-
-          show.each_with_index do |line, iy|
-            line.each_with_index do |column, ix|
-              column.position = [by + iy, bx + ix]
-              out << column
-            end
-          end
-
-          out
-        end
+        Vedeu::Output::Output.render(output) if visible?
       end
 
       # Returns a string representation of the viewport.
       #
       # @return [String]
       def to_s
-        render.map(&:to_s).join("\n")
+        Array(render).map(&:to_s).join("\n")
       end
       alias_method :to_str, :to_s
 
@@ -76,6 +63,21 @@ module Vedeu
 
       private
 
+      def output
+        Vedeu.timer("Rendering: '#{name}'") do
+          out = []
+
+          show.each_with_index do |line, iy|
+            line.each_with_index do |column, ix|
+              column.position = [by + iy, bx + ix]
+              out << column
+            end
+          end
+
+          out
+        end
+      end
+
       # Returns the visible content for the view.
       #
       # @note If there are no lines of content, we return an empty