vedeu 0.4.59 → 0.4.60

data/lib/vedeu/exceptions.rb

@@ -47,6 +47,12 @@ module Vedeu
 
   end # OutOfRange
 
+  # Raised when Vedeu encounters an error.
+  #
+  class VedeuError < StandardError
+
+  end # VedeuError,
+
   # Raised when Vedeu wishes to exit.
   #
   # @see Vedeu::MainLoop

data/lib/vedeu/models/menus.rb

@@ -11,6 +11,7 @@ module Vedeu
     end # Eigenclass
 
     real Vedeu::Menu
+    null Vedeu::Null::Menu
 
   end # Menus
 

data/lib/vedeu/null/menu.rb

@@ -0,0 +1,38 @@
+module Vedeu
+
+  module Null
+
+    # Provides a non-existent model to swallow messages.
+    #
+    class Menu
+
+      # Returns an instance of the Vedeu::Null::Menu class.
+      #
+      # @param attributes [Hash<Symbol => void>]
+      # @option attributes name [String|NilClass]
+      # @return [Vedeu::Null::Menu]
+      def initialize(attributes = {})
+        @attributes = attributes
+        @name       = @attributes[:name]
+      end
+
+      # @return [NilClass]
+      def item
+        nil
+      end
+      alias_method :bottom_item, :item
+      alias_method :current_item, :item
+      alias_method :deselect_item, :item
+      alias_method :items, :item
+      alias_method :next_item, :item
+      alias_method :prev_item, :item
+      alias_method :select_item, :item
+      alias_method :selected_item, :item
+      alias_method :top_item, :item
+      alias_method :view, :item
+
+    end # Menu
+
+  end # Null
+
+end # Vedeu

data/lib/vedeu/output/esc.rb

@@ -5,103 +5,9 @@ module Vedeu
   #
   module Esc
 
+    include Vedeu::EscapeSequences
     extend self
 
-    # Produces the foreground named colour escape sequence hash. The background
-    # escape sequences are also generated from this by adding 10 to the values.
-    # This hash gives rise to methods you can call directly on `Esc` to produce
-    # the desired colours:
-    #
-    # @example
-    #   Esc.red                     # => "\e[31m"
-    #
-    #   Esc.red { 'some text' }     # => "\e[31msome text\e[39m"
-    #
-    #   Esc.on_blue                 # => "\e[44m"
-    #
-    #   Esc.on_blue { 'some text' } # => "\e[44msome text\e[49m"
-    #
-    #   # Valid names:
-    #   :black, :red, :green, :yellow, :blue, :magenta, :cyan, :light_grey,
-    #   :default, :dark_grey, :light_red, :light_green, :light_yellow,
-    #   :light_blue, :light_magenta, :light_cyan, :white
-    #
-    # @return [Hash<Symbol => Fixnum>]
-    def codes
-      {
-        black:         30,
-        red:           31,
-        green:         32,
-        yellow:        33,
-        blue:          34,
-        magenta:       35,
-        cyan:          36,
-        light_grey:    37,
-        default:       39,
-        dark_grey:     90,
-        light_red:     91,
-        light_green:   92,
-        light_yellow:  93,
-        light_blue:    94,
-        light_magenta: 95,
-        light_cyan:    96,
-        white:         97,
-      }
-    end
-    alias_method :foreground_codes, :codes
-
-    # Produces the background named colour escape sequence hash from the
-    # foreground escape sequence hash.
-    #
-    # @return [Hash<Symbol => Fixnum>]
-    def background_codes
-      hash = {}
-      Vedeu::Esc.codes.inject(hash) do |h, (k, v)|
-        h.merge!(k => v + 10)
-      end
-    end
-
-    # Dynamically creates methods for each terminal named colour. When a block
-    # is given, then the colour is reset to 'default' once the block is called.
-    #
-    # @return [String]
-    foreground_codes.each do |key, code|
-      define_method(key) do |&blk|
-        "\e[#{code}m" + (blk ? blk.call + "\e[39m" : '')
-      end
-    end
-
-    background_codes.each do |key, code|
-      define_method('on_' + key.to_s) do |&blk|
-        "\e[#{code}m" + (blk ? blk.call + "\e[49m" : '')
-      end
-    end
-
-    # @return [Hash<Symbol => String>]
-    def actions
-      {
-        hide_cursor:     "\e[?25l",
-        show_cursor:     "\e[?25h",
-        cursor_position: "\e[6n",
-        bg_reset:        "\e[49m",
-        blink:           "\e[5m",
-        blink_off:       "\e[25m",
-        bold:            "\e[1m",
-        bold_off:        "\e[22m",
-        border_on:       "\e(0",
-        border_off:      "\e(B",
-        dim:             "\e[2m",
-        fg_reset:        "\e[39m",
-        negative:        "\e[7m",
-        positive:        "\e[27m",
-        reset:           "\e[0m",
-        underline:       "\e[4m",
-        underline_off:   "\e[24m",
-      }
-    end
-
-    actions.each { |key, code| define_method(key) { code } }
-
     # Return the stream with the escape sequences escaped so that they can be
     # printed to the terminal instead of being interpreted by the terminal which
     # will render them. This way we can see what escape sequences are being sent
@@ -124,7 +30,6 @@ module Vedeu
       return '' if value.empty?
 
       send(value.to_sym)
-
     rescue NoMethodError
       ''
     end

data/lib/vedeu/plugins.rb

@@ -0,0 +1,82 @@
+module Vedeu
+
+  # A class responsible for managing plugins installation.
+  #
+  class Plugins
+
+    # Returns a new instance of Vedeu::Plugins.
+    #
+    # @return [Vedeu::Plugins]
+    def initialize
+      @plugins = []
+    end
+
+    # Loads all plugins that are not enabled.
+    #
+    # @return [void]
+    def load
+      plugins.each do |plugin|
+        plugin.load! unless plugin.enabled?
+      end
+    end
+
+    # Register plugin with name in an internal array.
+    #
+    # @param name [String]
+    # @param plugin [Vedeu::Plugin]
+    # @return [void]
+    def register(name, plugin = false)
+      if plugin && !loaded?(name)
+        plugins << plugin
+      end
+    end
+
+    # Find all installed plugins and store them.
+    #
+    # @return [void]
+    def find
+      Gem.refresh
+
+      Gem::Specification.each do |gem|
+        next unless gem.name =~ /^#{prefix}/
+        plugin_name = gem.name[/^#{prefix}-(.*)/, 1]
+        register(plugin_name, Plugin.new(plugin_name, gem))
+      end
+
+      plugins
+    end
+
+    # Return a list of all plugin names as strings.
+    #
+    # @return [void]
+    def names
+      plugins.reduce({}) do |hash, plugin|
+        hash[plugin.name] = plugin
+        hash
+      end
+    end
+
+    protected
+
+    # @!attribute [r] input
+    # @return [Array<String>]
+    attr_accessor :plugins
+
+    private
+
+    # Returns a boolean indicating whether a plugin is already loaded.
+    #
+    # @param name [String]
+    # @return [Boolean]
+    def loaded?(name)
+      plugins.any? { |plugin| plugin.gem_name == name }
+    end
+
+    # @return [String]
+    def prefix
+      'vedeu'
+    end
+
+  end # Plugins
+
+end # Vedeu

data/lib/vedeu/plugins/plugin.rb

@@ -0,0 +1,53 @@
+module Vedeu
+
+  # A class responsible for plugin loading.
+  #
+  class Plugin
+
+    # @!attribute [r] name
+    # @return [String]
+    attr_reader :name
+
+    # @!attribute [r] gem
+    # @return [String]
+    attr_reader :gem
+
+    # @!attribute [r] gem_name
+    # @return [String]
+    attr_reader :gem_name
+
+    # @!attribute [rw] enabled
+    # @return [Boolean]
+    attr_accessor :enabled
+    alias_method :enabled?, :enabled
+
+    # Returns a new instance of Vedeu::Plugin.
+    #
+    # @param name [String] The plugin name.
+    # @param gem [Gem::Specification] The RubyGems gem.
+    # @return [Vedeu::Plugin]
+    def initialize(name, gem)
+      @name     = name
+      @gem      = gem
+      @gem_name = "vedeu-#{name}"
+      @enabled  = false
+    end
+
+    # Load the plugin (require the gem).
+    #
+    # @return [void]
+    def load!
+      begin
+        require gem_name unless enabled?
+      rescue LoadError => error
+        fail VedeuError, "Unable to load plugin #{gem_name} due to #{error}."
+      rescue => error
+        fail VedeuError, "require '#{gem_name}' failed with #{error}."
+      end
+
+      @enabled = true
+    end
+
+  end # Plugin
+
+end # Vedeu

data/lib/vedeu/version.rb

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

data/test/lib/vedeu/api_test.rb

@@ -11,6 +11,10 @@ module Vedeu
     it { Vedeu.must_respond_to(:configuration) }
     it { Vedeu.must_respond_to(:cursor) }
     it { Vedeu.must_respond_to(:cursors) }
+    it { Vedeu.must_respond_to(:drb_restart) }
+    it { Vedeu.must_respond_to(:drb_start) }
+    it { Vedeu.must_respond_to(:drb_status) }
+    it { Vedeu.must_respond_to(:drb_stop) }
     it { Vedeu.must_respond_to(:border) }
     it { Vedeu.must_respond_to(:geometry) }
     it { Vedeu.must_respond_to(:group) }

data/test/lib/vedeu/colours/escape_sequences_test.rb

@@ -0,0 +1,100 @@
+require 'test_helper'
+
+module Vedeu
+
+	describe EscapeSequences do
+
+    let(:described) { Vedeu::EscapeSequences }
+
+    before { Vedeu::Terminal.stubs(:size).returns([80, 25]) }
+
+    describe 'foreground colour methods' do
+      it { described.black.must_equal("\e[30m") }
+      it { described.red.must_equal("\e[31m") }
+      it { described.green.must_equal("\e[32m") }
+      it { described.yellow.must_equal("\e[33m") }
+      it { described.blue.must_equal("\e[34m") }
+      it { described.magenta.must_equal("\e[35m") }
+      it { described.cyan.must_equal("\e[36m") }
+      it { described.light_grey.must_equal("\e[37m") }
+      it { described.default.must_equal("\e[39m") }
+      it { described.dark_grey.must_equal("\e[90m") }
+      it { described.light_red.must_equal("\e[91m") }
+      it { described.light_green.must_equal("\e[92m") }
+      it { described.light_yellow.must_equal("\e[93m") }
+      it { described.light_blue.must_equal("\e[94m") }
+      it { described.light_magenta.must_equal("\e[95m") }
+      it { described.light_cyan.must_equal("\e[96m") }
+      it { described.white.must_equal("\e[97m") }
+
+      it 'returns an escape sequence for the foreground colour and resets ' \
+         'after calling the block' do
+        described.cyan do
+          'ununpentium'
+        end.must_equal("\e[36mununpentium\e[39m")
+      end
+    end
+
+    describe '.codes' do
+      it { described.codes.must_be_instance_of(Hash) }
+      it { described.must_respond_to(:foreground_codes) }
+    end
+
+    describe '.background_codes' do
+      it { described.background_codes.must_be_instance_of(Hash) }
+    end
+
+    describe 'background colour methods' do
+      it { described.on_black.must_equal("\e[40m") }
+      it { described.on_red.must_equal("\e[41m") }
+      it { described.on_green.must_equal("\e[42m") }
+      it { described.on_yellow.must_equal("\e[43m") }
+      it { described.on_blue.must_equal("\e[44m") }
+      it { described.on_magenta.must_equal("\e[45m") }
+      it { described.on_cyan.must_equal("\e[46m") }
+      it { described.on_light_grey.must_equal("\e[47m") }
+      it { described.on_default.must_equal("\e[49m") }
+      it { described.on_dark_grey.must_equal("\e[100m") }
+      it { described.on_light_red.must_equal("\e[101m") }
+      it { described.on_light_green.must_equal("\e[102m") }
+      it { described.on_light_yellow.must_equal("\e[103m") }
+      it { described.on_light_blue.must_equal("\e[104m") }
+      it { described.on_light_magenta.must_equal("\e[105m") }
+      it { described.on_light_cyan.must_equal("\e[106m") }
+      it { described.on_white.must_equal("\e[107m") }
+
+      it 'returns an escape sequence for the background colour and resets ' \
+         'after calling the block' do
+        described.on_red do
+          'livermorium'
+        end.must_equal("\e[41mlivermorium\e[49m")
+      end
+    end
+
+    describe 'action methods' do
+      it { described.hide_cursor.must_equal("\e[?25l") }
+      it { described.show_cursor.must_equal("\e[?25h") }
+      it { described.cursor_position.must_equal("\e[6n") }
+      it { described.bg_reset.must_equal("\e[49m") }
+      it { described.blink.must_equal("\e[5m") }
+      it { described.blink_off.must_equal("\e[25m") }
+      it { described.bold.must_equal("\e[1m") }
+      it { described.bold_off.must_equal("\e[22m") }
+      it { described.border_on.must_equal("\e(0") }
+      it { described.border_off.must_equal("\e(B") }
+      it { described.dim.must_equal("\e[2m") }
+      it { described.fg_reset.must_equal("\e[39m") }
+      it { described.negative.must_equal("\e[7m") }
+      it { described.positive.must_equal("\e[27m") }
+      it { described.reset.must_equal("\e[0m") }
+      it { described.underline.must_equal("\e[4m") }
+      it { described.underline_off.must_equal("\e[24m") }
+    end
+
+    describe '.actions' do
+      it { described.actions.must_be_instance_of(Hash) }
+    end
+
+	end # EscapeSequences
+
+end # Vedeu

data/test/lib/vedeu/null/menu_test.rb

@@ -0,0 +1,47 @@
+require 'test_helper'
+
+module Vedeu
+
+  module Null
+
+  	describe Menu do
+
+      let(:described)  { Vedeu::Null::Menu }
+      let(:instance)   { described.new(attributes) }
+      let(:attributes) {
+        {
+          name: _name
+        }
+      }
+      let(:_name) { 'null_geometry' }
+
+      describe '#initialize' do
+        it { instance.must_be_instance_of(described) }
+        it {
+          instance.instance_variable_get('@attributes').must_equal(attributes)
+        }
+        it { instance.instance_variable_get('@name').must_equal(_name) }
+      end
+
+      describe 'alias methods' do
+        it { instance.must_respond_to(:bottom_item) }
+        it { instance.must_respond_to(:current_item) }
+        it { instance.must_respond_to(:deselect_item) }
+        it { instance.must_respond_to(:items) }
+        it { instance.must_respond_to(:next_item) }
+        it { instance.must_respond_to(:prev_item) }
+        it { instance.must_respond_to(:select_item) }
+        it { instance.must_respond_to(:selected_item) }
+        it { instance.must_respond_to(:top_item) }
+        it { instance.must_respond_to(:view) }
+      end
+
+      describe '#item' do
+        it { instance.item.must_equal(nil) }
+      end
+
+  	end # Menu
+
+  end # Null
+
+end # Vedeu