vedeu 0.4.13 → 0.4.14

data/lib/vedeu/bindings.rb

@@ -14,14 +14,6 @@ module Vedeu
   #
   module Bindings
 
-    # Vedeu triggers this event when `:_exit_` is triggered. You can hook into
-    # this to perform a special action before the application terminates. Saving
-    # the user's work, session or preferences might be popular here.
-    Vedeu.bind(:_cleanup_) do
-      Vedeu.trigger(:_drb_stop_)
-      Vedeu.trigger(:cleanup)
-    end
-
     Vedeu.bind(:_drb_input_) do |data, type|
       Vedeu.log(type: :drb, message: "Sending input (#{type})")
 
@@ -46,6 +38,14 @@ module Vedeu
     Vedeu.bind(:_drb_status_)  { Vedeu::Distributed::Server.status }
     Vedeu.bind(:_drb_stop_)    { Vedeu::Distributed::Server.stop }
 
+    # Vedeu triggers this event when `:_exit_` is triggered. You can hook into
+    # this to perform a special action before the application terminates. Saving
+    # the user's work, session or preferences might be popular here.
+    Vedeu.bind(:_cleanup_) do
+      Vedeu.trigger(:_drb_stop_)
+      Vedeu.trigger(:cleanup)
+    end
+
     # When triggered, Vedeu will trigger a `:cleanup` event which you can define
     # (to save files, etc) and attempt to exit.
     Vedeu.bind(:_exit_) { Vedeu::Application.stop }
@@ -82,23 +82,27 @@ module Vedeu
 
     # When triggered will cause Vedeu to trigger the `:_clear_` and `:_refresh_`
     # events. Please see those events for their behaviour.
-    Vedeu.bind(:_resize_, { delay: 0.25 }) { Vedeu.resize }
+    Vedeu.bind(:_resize_, delay: 0.25) { Vedeu.resize }
 
-    Vedeu.bind(:tick) { |time| Vedeu.log(type: :debug, message: "Tick: #{time}") }
-    Vedeu.bind(:tock) { |time| Vedeu.log(type: :debug, message: "Tock: #{time}") }
+    Vedeu.bind(:tick) do |time|
+      Vedeu.log(type: :debug, message: "Tick: #{time}")
+    end
+    Vedeu.bind(:tock) do |time|
+      Vedeu.log(type: :debug, message: "Tock: #{time}")
+    end
 
     # Hide the cursor of the named interface or interface currently in focus.
     Vedeu.bind(:_cursor_hide_) do |name|
       named = name ? Vedeu.cursors.by_name(name) : Vedeu.cursor
 
-      Vedeu::Toggle.hide(named)
+      Vedeu::Visibility.hide(named)
     end
 
     # Show the cursor of the named interface or interface currently in focus.
     Vedeu.bind(:_cursor_show_) do |name|
       named = name ? Vedeu.cursors.by_name(name) : Vedeu.cursor
 
-      Vedeu::Toggle.show(named)
+      Vedeu::Visibility.show(named)
     end
 
     # @see {Vedeu::Move}
@@ -182,13 +186,16 @@ module Vedeu
     end
 
     # Clears the spaces occupied by the interfaces belonging to the named group.
-    Vedeu.bind(:_clear_group_) do |name|
-      Vedeu.groups.find(name).members.each do |group_name|
-        Vedeu.trigger(:_clear_, group_name)
+    Vedeu.bind(:_clear_group_) do |group_name|
+      Vedeu.groups.find(group_name).members.each do |interface_name|
+        Vedeu.trigger(:_clear_, interface_name)
       end
     end
 
     # Will cause all interfaces to refresh, or the named interface if given.
+    #
+    # @note
+    #   Hidden interfaces will be still refreshed in memory but not shown.
     Vedeu.bind(:_refresh_) do |name|
       name ? Vedeu::Refresh.by_name(name) : Vedeu::Refresh.all
     end
@@ -219,6 +226,60 @@ module Vedeu
       Vedeu.trigger(:_clear_group_, name)
     end
 
+    # 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.
+    Vedeu.bind(:_hide_interface_) do |name|
+      if name && Vedeu.interfaces.registered?(name)
+        interface = Vedeu.interfaces.find(name)
+
+        if interface.visible?
+          interface = Vedeu::Visibility.hide(interface)
+          Vedeu.buffers.clear(interface.name)
+        end
+      end
+    end
+
+    # Will show the named interface. If the interface is currently invisible, it
+    # will be shown- rendered with its latest content. To hide the interface,
+    # the ':_hide_interface_' event should be triggered.
+    # Triggering the ':_show_group_' event to which this named interface belongs
+    # will also show the interface.
+    Vedeu.bind(:_show_interface_) do |name|
+      if name && Vedeu.interfaces.registered?(name)
+        interface = Vedeu.interfaces.find(name)
+
+        interface = Vedeu::Visibility.show(interface) unless interface.visible?
+
+        Vedeu.buffers.render(interface.name)
+      end
+    end
+
+    # Will toggle the visibility of the named interface. If the interface is
+    # currently visible, the area it occupies will be clears and the interface
+    # will be marked invisible. If the interface is invisible, then the
+    # interface will be marked visible and rendered in the area it occupies.
+    #
+    # @note
+    #   If an interface is marked visible whilst another view is occupying some
+    #   or all of the interface's current position, the interface will overwrite
+    #   this area- this may cause visual corruption.
+    Vedeu.bind(:_toggle_interface_) do |name|
+      if name && Vedeu.interfaces.registered?(name)
+        interface = Vedeu.interfaces.find(name)
+
+        if interface.visible?
+          Vedeu.trigger(:_hide_interface_, name)
+
+        else
+          Vedeu.trigger(:_show_interface_, name)
+
+        end
+      end
+    end
+
   end # Bindings
   # :nocov:
 

data/lib/vedeu/buffers/all.rb

@@ -1,5 +1,2 @@
-require 'vedeu/buffers/buffer'
-require 'vedeu/buffers/display_buffer'
-
-module Vedeu
-end # Vedeu
+require_relative 'buffer'
+require_relative 'display_buffer'

data/lib/vedeu/buffers/buffer.rb

@@ -37,26 +37,33 @@ module Vedeu
     # Return a new instance of Buffer. Generally a Buffer is initialized with
     # only a 'name' and 'back' parameter.
     #
-    # @param name [String] The name of the interface for which the buffer
-    #   belongs.
-    # @param back [Interface]
-    # @param front [Interface]
-    # @param previous [Interface]
+    # @option attributes name [String] The name of the interface for which the
+    #   buffer belongs.
+    # @option attributes back [Interface]
+    # @option attributes front [Interface]
+    # @option attributes previous [Interface]
+    # @option attributes repository [Vedeu::Buffers]
     # @return [Buffer]
-    def initialize(name, back = nil, front = nil, previous = nil, repository = nil)
-      @name       = name
-      @back       = back
-      @front      = front
-      @previous   = previous
-      @repository = repository || Vedeu.buffers
+    def initialize(attributes = {})
+      @attributes = defaults.merge!(attributes)
+
+      @name       = @attributes[:name]
+      @back       = @attributes[:back]
+      @front      = @attributes[:front]
+      @previous   = @attributes[:previous]
+      @repository = @attributes[:repository] || Vedeu.buffers
     end
 
     # Add the content to the back buffer, then update the repository. Returns
-    # boolean indicating that the repository was updated.
+    # boolean indicating that the repository was updated. Here we also apply any
+    # overridden colours or styles in the buffered view to the stored interface.
     #
     # @param content [Interface]
     # @return [Boolean]
     def add(content)
+      content.colour = interface.colour unless content.colour
+      content.style  = interface.style  unless content.style
+
       @back = content
 
       store
@@ -76,22 +83,56 @@ module Vedeu
     # - If the 'previous' buffer is empty, return an empty collection.
     #
     # @return [Array<Hash>]
-    def content
-      if content_for?(:back)
-        swap
+    def render
+      buffer = if content_for?(:back)
+                 swap
+
+                 [front.render]
+
+               elsif content_for?(:front)
+                 [front.render]
+
+               elsif content_for?(:previous)
+                 [previous.render]
+
+               else
+                 []
+
+               end
+
+      Vedeu::Output.render(buffer) unless buffer.empty?
+
+      buffer
+    end
+    alias_method :content, :render
 
-        [front]
+    # Returns the front buffer or, if that is empty, the interface cleared.
+    #
+    # @return [void]
+    def clear
+      buffer = if content_for?(:front)
+                 front.clear.clear
+
+               else
+                 interface.clear.clear
 
-      elsif content_for?(:front)
-        [front]
+               end
 
-      elsif content_for?(:previous)
-        [previous]
+      Vedeu::Output.render(buffer) unless buffer.empty?
 
-      else
-        []
+      buffer
+    end
+
+    private
 
-      end
+    # @return [Hash<Symbol => NilClass, String>]
+    def defaults
+      {
+        back:     nil,
+        front:    nil,
+        name:     '',
+        previous: nil,
+      }
     end
 
     # Return a boolean indicating content was swapped between buffers.
@@ -107,8 +148,6 @@ module Vedeu
       true
     end
 
-    private
-
     # Return a boolean indicating content presence on the buffer type.
     #
     # @param buffer [Symbol] One of; :back, :front or :previous.
@@ -120,6 +159,11 @@ module Vedeu
       true
     end
 
+    # @return [Vedeu::Interface]
+    def interface
+      @interface ||= Vedeu.interfaces.find(name)
+    end
+
   end # Buffer
 
 end # Vedeu

data/lib/vedeu/buffers/display_buffer.rb

@@ -48,7 +48,7 @@ module Vedeu
         Vedeu.buffers.find(name).add(self)
 
       else
-        Vedeu::Buffer.new(name, self).store
+        Vedeu::Buffer.new(name: name, back: self).store
 
       end
 
@@ -59,9 +59,7 @@ module Vedeu
     #
     # @return [Interface]
     def store_focusable
-      unless Vedeu.focusable.registered?(name)
-        Vedeu.focusable.add(name)
-      end
+      Vedeu.focusable.add(name) unless Vedeu.focusable.registered?(name)
 
       self
     end
@@ -70,9 +68,7 @@ module Vedeu
     #
     # @return [Interface]
     def store_cursor
-      unless Vedeu.cursors.registered?(name)
-        Vedeu::Cursor.new({ name: name }).store
-      end
+      Vedeu::Cursor.new(name: name).store unless Vedeu.cursors.registered?(name)
 
       self
     end

data/lib/vedeu/configuration/all.rb

@@ -1,6 +1,3 @@
-require 'vedeu/configuration/cli'
-require 'vedeu/configuration/api'
-require 'vedeu/configuration/configuration'
-
-module Vedeu
-end # Vedeu
+require_relative 'cli'
+require_relative 'api'
+require_relative 'configuration'

data/lib/vedeu/configuration/api.rb

@@ -34,11 +34,10 @@ module Vedeu
       #
       # @return [Hash<Symbol => Boolean, Fixnum, String>]
       def configuration
-        options.merge!({
-          system_keys: Configuration.default_system_keys.merge!(system_keys)
-        }) if system_keys.any?
+        new_system_keys = Configuration.default_system_keys.merge!(system_keys)
+        options.merge!(system_keys: new_system_keys) if system_keys.any?
 
-        Vedeu::Config.log('API', options)
+        Vedeu::Config.log(Esc.green { '[api]' }, options)
       end
 
       # Sets boolean to allow user input. The default behaviour of Vedeu is to
@@ -238,6 +237,12 @@ module Vedeu
       #     colour_mode 256
       #     ...
       #
+      # @note
+      #   iTerm 2 on Mac OSX will handle the true colour setting (16777216),
+      #   whereas Terminator on Linux will not display colours correctly. For
+      #   compatibility across platforms, it is recommended to either not set
+      #   the colour mode at all and allow it to be detected, or use 256 here.
+      #
       # @param value [Fixnum]
       # @raise [InvalidSyntax] When the value parameter is not one of +8+, +16+,
       #   +256+ or +16777216+.
@@ -261,6 +266,25 @@ module Vedeu
         options[:log] = filename
       end
 
+      # Sets the renderers for Vedeu. Each renderer added must have the class
+      # method '.render' defined as this will be called when rendering content.
+      #
+      # @example
+      #   Vedeu.configure do
+      #     renderer MyRenderer
+      #     ...
+      #
+      #   Vedeu.configure do
+      #     renderers MyRenderer, MyOtherRenderer
+      #     ...
+      #
+      # @param renderer [Array<Class>|Class]
+      # @return [Array<Class>]
+      def renderer(*renderer)
+        options[:renderers] = Vedeu::Configuration.renderers + renderer
+      end
+      alias_method :renderers, :renderer
+
       # Sets the value of STDIN.
       #
       # @example

data/lib/vedeu/configuration/cli.rb

@@ -1,5 +1,3 @@
-require 'optparse'
-
 module Vedeu
 
   module Config
@@ -39,8 +37,8 @@ module Vedeu
           end
 
           opts.on('-I', '--noninteractive', '--standalone',
-                  'Run the application non-interactively; i.e. not requiring ' \
-                  'intervention from the user.') do
+                  'Run the application non-interactively; ' \
+                  'i.e. not requiring intervention from the user.') do
             options[:interactive] = false
           end
 
@@ -94,8 +92,8 @@ module Vedeu
           end
 
           opts.on('--drb-host',
-            'Set the hostname/IP for the DRb server.') do |hostname|
-            #options[:drb]      = true
+                  'Set the hostname/IP for the DRb server.') do |hostname|
+            # options[:drb]      = true
             options[:drb_host] = hostname
           end
 
@@ -104,12 +102,14 @@ module Vedeu
             options[:drb_port] = port
           end
 
-          opts.on('--drb-height', 'Set the height for fake terminal of the DRb server.') do |height|
+          opts.on('--drb-height',
+                  'Set the height for fake terminal.') do |height|
             # options[:drb]      = true
             options[:drb_height] = height
           end
 
-          opts.on('--drb-width', 'Set the width for fake terminal of the DRb server.') do |width|
+          opts.on('--drb-width',
+                  'Set the width for fake terminal.') do |width|
             # options[:drb]     = true
             options[:drb_width] = width
           end
@@ -117,7 +117,7 @@ module Vedeu
 
         parser.parse!(args)
 
-        Vedeu::Config.log('CLI', options)
+        Vedeu::Config.log(Esc.blue { '[cli]' }, options)
       end
 
       private

data/lib/vedeu/configuration/configuration.rb

@@ -1,8 +1,3 @@
-require 'singleton'
-
-require 'vedeu/configuration/api'
-require 'vedeu/configuration/cli'
-
 module Vedeu
 
   # Namespace for the API configuration and CLI configuration classes.
@@ -19,7 +14,7 @@ module Vedeu
     def log(from, options)
       options.each do |option, value|
         Vedeu.log(type:    :config,
-                  message: "#{from} #{option.to_s}: #{value.to_s}")
+                  message: "#{from} #{option}: #{value}")
       end
     end
 
@@ -142,6 +137,13 @@ module Vedeu
       end
       alias_method :once, :once?
 
+      # Returns the renderers which should receive output.
+      #
+      # @return [Array<Class>]
+      def renderers
+        instance.options[:renderers]
+      end
+
       # Returns the redefined setting for STDIN.
       #
       # @return [File|IO]
@@ -236,9 +238,10 @@ module Vedeu
       @options.merge!(opts)
 
       @options.merge!(Config::API.configure(&block)) if block_given?
-
       @options.merge!(Config::CLI.configure(args)) if args.any?
 
+      Vedeu::Renderers.renderer(*@options[:renderers])
+
       Vedeu::Configuration
     end
 
@@ -267,6 +270,7 @@ module Vedeu
         interactive:   true,
         log:           '/tmp/vedeu.log',
         once:          false,
+        renderers:     [Vedeu::TerminalRenderer],
         stdin:         nil,
         stdout:        nil,
         stderr:        nil,

data/lib/vedeu/cursor/all.rb

@@ -1,8 +1,5 @@
 require 'vedeu/repositories/all'
-require 'vedeu/cursor/cursor'
-require 'vedeu/cursor/move'
-require 'vedeu/cursor/refresh_cursor'
-require 'vedeu/cursor/toggle'
 
-module Vedeu
-end # Vedeu
+require_relative 'cursor'
+require_relative 'move'
+require_relative 'refresh_cursor'

data/lib/vedeu/cursor/cursor.rb

@@ -1,6 +1,5 @@
 require 'vedeu/cursor/all'
 require 'vedeu/geometry/position'
-require 'vedeu/support/visible'
 
 module Vedeu
 
@@ -10,10 +9,6 @@ module Vedeu
   class Cursor
 
     extend Forwardable
-
-    def_delegators :state, :visible?,
-      :invisible?
-
     include Vedeu::Model
 
     # @!attribute [r] attributes
@@ -36,6 +31,11 @@ module Vedeu
     # @return [Boolean|Symbol]
     attr_reader :state
 
+    # @!attribute [r] visible
+    # @return [Boolean|Symbol]
+    attr_reader :visible
+    alias_method :visible?, :visible
+
     # @!attribute [r] x
     # @return [Fixnum]
     attr_reader :x
@@ -52,8 +52,7 @@ module Vedeu
     # @option attributes ox [Fixnum] The offset x coordinate.
     # @option attributes oy [Fixnum] The offset y coordinate.
     # @option attributes repository [Vedeu::Repository]
-    # @option attributes state [Boolean|Symbol] The visibility of the cursor,
-    #   either +true+ or +false+, +:hide+ or +:show+.
+    # @option attributes visible [Boolean] The visibility of the cursor.
     # @option attributes x [Fixnum] The terminal x coordinate for the cursor.
     # @option attributes y [Fixnum] The terminal y coordinate for the cursor.
     #
@@ -61,9 +60,7 @@ module Vedeu
     def initialize(attributes = {})
       # Hack because Repository#by_name creates Cursor objects with just a
       # name.
-      if attributes.is_a?(String)
-        attributes = { name: attributes }
-      end
+      attributes = { name: attributes } if attributes.is_a?(String)
 
       @attributes = defaults.merge!(attributes)
 
@@ -71,7 +68,7 @@ module Vedeu
       @ox         = @attributes.fetch(:ox)
       @oy         = @attributes.fetch(:oy)
       @repository = @attributes.fetch(:repository)
-      @state      = Vedeu::Visible.coerce(@attributes.fetch(:state))
+      @visible    = @attributes.fetch(:visible)
       @x          = @attributes.fetch(:x)
       @y          = @attributes.fetch(:y)
 
@@ -80,7 +77,12 @@ module Vedeu
 
     # @return [String]
     def inspect
-      "<Vedeu::Cursor (#{name}, #{state}, x:#{x}, y:#{y}, ox:#{ox}, oy:#{oy})>"
+      "<Vedeu::Cursor (#{name}, " \
+      "#{visible}, "              \
+      "x:#{x}, "                  \
+      "y:#{y}, "                  \
+      "ox:#{ox}, "                \
+      "oy:#{oy})>"
     end
 
     # Returns an escape sequence to position the cursor and set its visibility.
@@ -114,7 +116,7 @@ module Vedeu
         ox:         0,
         oy:         0,
         repository: Vedeu.cursors,
-        state:      false,
+        visible:    false,
         x:          1,
         y:          1,
       }
@@ -131,7 +133,13 @@ module Vedeu
     #
     # @return [String]
     def visibility
-      state.cursor
+      if visible?
+        Vedeu::Esc.string('show_cursor')
+
+      else
+        Vedeu::Esc.string('hide_cursor')
+
+      end
     end
 
   end # Cursor

data/lib/vedeu/cursor/move.rb

@@ -38,13 +38,13 @@ module Vedeu
     extend Forwardable
 
     def_delegators :@interface, :border,
-                                :border?,
-                                :geometry
+                   :border?,
+                   :geometry
 
     def_delegators :geometry, :left,
-                              :top,
-                              :height,
-                              :width
+                   :top,
+                   :height,
+                   :width
 
     # Returns an instance of Vedeu::Move.
     #
@@ -174,29 +174,19 @@ module Vedeu
 
     # @return [PositionValidator]
     def validator
-      @validator ||= Vedeu::PositionValidator.validate(interface,
-                                                      coordinate.x_position(ox),
-                                                      coordinate.y_position(oy))
+      @validator ||= Vedeu::PositionValidator.validate(interface.name,
+                                                       x_position,
+                                                       y_position)
     end
 
-    # Apply the direction amount to the cursor offset. If the offset is less
-    # than 0, correct to 0.
-    #
     # @return [Fixnum]
-    def ox
-      ox = cursor.ox + dx
-      ox = 0 if ox < 0
-      ox
+    def x_position
+      coordinate.x_position(ox)
     end
 
-    # Apply the direction amount to the cursor offset. If the offset is less
-    # than 0, correct to 0.
-    #
     # @return [Fixnum]
-    def oy
-      oy = cursor.oy + dy
-      oy = 0 if oy < 0
-      oy
+    def y_position
+      coordinate.y_position(oy)
     end
 
     # @return [Coordinate]
@@ -225,6 +215,26 @@ module Vedeu
       width
     end
 
+    # Apply the direction amount to the cursor offset. If the offset is less
+    # than 0, correct to 0.
+    #
+    # @return [Fixnum]
+    def ox
+      ox = cursor.ox + dx
+      ox = 0 if ox < 0
+      ox
+    end
+
+    # Apply the direction amount to the cursor offset. If the offset is less
+    # than 0, correct to 0.
+    #
+    # @return [Fixnum]
+    def oy
+      oy = cursor.oy + dy
+      oy = 0 if oy < 0
+      oy
+    end
+
   end # Move
 
 end # Vedeu

data/lib/vedeu/cursor/refresh_cursor.rb

@@ -53,7 +53,7 @@ module Vedeu
 
     # @return [Vedeu::PositionValidator]
     def validated_position
-      @position ||= Vedeu::PositionValidator.validate(interface,
+      @position ||= Vedeu::PositionValidator.validate(interface.name,
                                                       cursor.x,
                                                       cursor.y)
     end