vedeu 0.6.9 → 0.6.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa52a712311446668b8375072ffb067393505997
-  data.tar.gz: 27a321fa1c2ee654042819f339e5cb59a004a472
+  metadata.gz: c164a962e662469f503fd1e4a7c263e6d4c3eace
+  data.tar.gz: 8e28eb50a3e7c7c0f708ec2b118fc8537ecfdf6f
 SHA512:
-  metadata.gz: f0a88fdd9757f20a6b4533b0e623c442b86487fbe3786293fd34323e1d5435352e73c41f6fe153bab9759eb1183615df21a8de50769aa43db1d57fa18e56b901
-  data.tar.gz: 8d1182b45e8085ce541777444a813919b65f61e2afd0cbfd46d0c6a75cce0743e4e2cea163516240d969def501b6ed3356d3b4235afc75f72cc987c0512a4470
+  metadata.gz: 793c0295ed02d41e9e03b6e61417938f3c715464f4a765ed70f04fa386a9034389f659d9b058b565871d15707418dce5802024283797bcd41ea699570c04b30c
+  data.tar.gz: f15f247cb1fcd786e7479e2851234f38d3c7900de8ad0c6a3c691e6970eeaa91de583adfe01a395614cacf5f9373f870716db6751c18159e9931d677d4200a46

data/LICENSE.txt

@@ -5,7 +5,7 @@ Copyright (c) 2013 Steve Klabnik - Monologger
 Copyright (c) 2013 Michael Grosser - Ruco
                    (https://github.com/grosser/ruco)
                    Note: Code from ruco's Window class was used as basis of
-                   Vedeu::Viewport.
+                   Vedeu::Output::Viewport.
 Copyright (c) 2012 Piotr Murach - TTY
                    (https://github.com/peter-murach/tty)
                    Note: Code used from Plugins infrastructure.

data/lib/vedeu/all.rb

@@ -17,7 +17,7 @@ require 'vedeu/configuration/configuration'
 
 require 'vedeu/terminal/mode'
 require 'vedeu/terminal/terminal'
-require 'vedeu/terminal/content'
+require 'vedeu/terminal/buffer'
 
 require 'vedeu/runtime/main_loop'
 require 'vedeu/runtime/flags'
@@ -121,8 +121,8 @@ require 'vedeu/output/renderers/terminal'
 require 'vedeu/output/renderers/text'
 require 'vedeu/output/renderers'
 
-require 'vedeu/api'
-require 'vedeu/internal_api'
+require 'vedeu/api/external'
+require 'vedeu/api/internal'
 
 require 'vedeu/bindings/application'
 require 'vedeu/bindings/document'

data/lib/vedeu/api/external.rb

@@ -0,0 +1,194 @@
+module Vedeu
+
+  module API
+
+    # Provides the API to Vedeu. Methods therein, and classes
+    # belonging to this module expose Vedeu's core functionality.
+    #
+    # These methods are used in a variety of ways, sometimes in
+    # combination:
+    #
+    #   # with parameters
+    #   Vedeu.method_name(*params)
+    #
+    #   # with a block
+    #   Vedeu.method_name(*params) do
+    #     # ...
+    #   end
+    #
+    #   # with other methods
+    #   Vedeu.method_name.other_method
+    #
+    module External
+
+      extend Forwardable
+
+      module_function
+
+      # @!method configure
+      #   @see Vedeu::Configuration.configure
+      # @!method configuration
+      #   @see Vedeu::Configuration.configuration
+      def_delegators Vedeu::Configuration, :configure, :configuration
+
+      # @!method cursor
+      # @return [Vedeu::Cursors::Cursor]
+      def_delegators Vedeu::Cursors::Repository, :cursor
+
+      # @!method drb_restart
+      #   @see Vedeu::Distributed::Server#restart
+      # @!method drb_start
+      #   @see Vedeu::Distributed::Server#start
+      # @!method drb_status
+      #   @see Vedeu::Distributed::Server#status
+      # @!method drb_stop
+      #   @see Vedeu::Distributed::Server#stop
+      def_delegators Vedeu::Distributed::Server, :drb_restart, :drb_start,
+                     :drb_status, :drb_stop
+
+      # @!method border
+      #   @see Vedeu::Borders::DSL.border
+      def_delegators Vedeu::Borders::DSL, :border
+
+      # @!method geometry
+      #   @see Vedeu::Geometry::DSL.geometry
+      def_delegators Vedeu::Geometry::DSL, :geometry
+
+      # @!method group
+      #   @see Vedeu::DSL::Group.group
+      def_delegators Vedeu::DSL::Group, :group
+
+      # @!method keymap
+      #   @see Vedeu::DSL::Keymap.keymap
+      def_delegators Vedeu::DSL::Keymap, :keymap
+
+      # @!method interface
+      #   @see Vedeu::DSL::Interface.interface
+      def_delegators Vedeu::DSL::Interface, :interface
+
+      # @!method render
+      #   @see Vedeu::DSL::View.render
+      # @!method renders
+      #   @see Vedeu::DSL::View.renders
+      # @!method views
+      #   @see Vedeu::DSL::View.views
+      def_delegators Vedeu::DSL::View, :renders, :render, :views
+
+      # @!method bind
+      #   @see Vedeu::Events::Event.bind
+      # @!method bound?
+      #   @see Vedeu::Events::Event.bound?
+      # @!method unbind
+      #   @see Vedeu::Events::Event.unbind
+      def_delegators Vedeu::Events::Event, :bind, :bound?, :unbind
+
+      # @!method bind_alias
+      #   @see Vedeu::Events::Aliases#bind_alias
+      # @!method unbind_alias
+      #   @see Vedeu::Events::Aliases#unbind_alias
+      def_delegators Vedeu::Events::Aliases, :bind_alias, :unbind_alias
+
+      # @!method focus
+      #   @see Vedeu::Models::Focus#focus
+      # @!method focus_by_name
+      #   @see Vedeu::Models::Focus#focus_by_name
+      # @!method focussed?
+      #   @see Vedeu::Models::Focus#focussed?
+      # @!method focus_next
+      #   @see Vedeu::Models::Focus#focus_next
+      # @!method focus_previous
+      #   @see Vedeu::Models::Focus#focus_previous
+      def_delegators Vedeu::Models::Focus, :focus, :focus_by_name, :focussed?,
+                     :focus_next, :focus_previous
+
+      # @!method log
+      #   @see Vedeu::Logging::Log.log
+      # @!method log_stdout
+      #   @see Vedeu::Logging::Log.log_stdout
+      # @!method log_stderr
+      #   @see Vedeu::Logging::Log.log_stderr
+      def_delegators Vedeu::Logging::Log, :log, :log_stdout, :log_stderr
+
+      # @!method keypress
+      #   @see Vedeu::Input::Mapper.keypress
+      def_delegators Vedeu::Input::Mapper, :keypress
+
+      # @!method menu
+      #   @see Vedeu::Menus::Menu.menu
+      def_delegators Vedeu::Menus::Menu, :menu
+
+      # @!method goto
+      #   @see Vedeu::Runtime::Router#goto
+      def_delegators Vedeu::Runtime::Router, :goto
+
+      # @!method height
+      #   @see Vedeu::Terminal#height
+      def_delegators Vedeu::Terminal, :height
+
+      # @!method width
+      #   @see Vedeu::Terminal#width
+      def_delegators Vedeu::Terminal, :width
+
+      # @!method trigger
+      #   @see Vedeu::Events::Trigger.trigger
+      def_delegators Vedeu::Events::Trigger, :trigger
+
+      # @!method exit
+      #   @see Vedeu::Runtime::Application.stop
+      def_delegators Vedeu::Runtime::Application, :exit
+
+      # @!method clear
+      #   @see Vedeu::Terminal#clear
+      def_delegators Vedeu::Terminal, :clear
+
+      # @!method clear_by_name
+      #   @see Vedeu::Clear::NamedInterface.render
+      def_delegators Vedeu::Clear::NamedInterface, :clear_by_name
+
+      # @!method clear_by_group
+      #   @see Vedeu::Clear::NamedGroup.render
+      def_delegators Vedeu::Clear::NamedGroup, :clear_by_group
+
+      # @!method hide_cursor
+      #   @see Vedeu::Cursors::Cursor#hide
+      def_delegators Vedeu::Cursors::Cursor, :hide_cursor
+
+      # @!method show_cursor
+      #   @see Vedeu::Cursors::Cursor#show
+      def_delegators Vedeu::Cursors::Cursor, :show_cursor
+
+      # @!method toggle_cursor
+      #   @see Vedeu::Cursors::Cursor#toggle
+      def_delegators Vedeu::Cursors::Cursor, :toggle_cursor
+
+      # @!method hide_group
+      #   @see Vedeu::Models::Group#hide
+      def_delegators Vedeu::Models::Group, :hide_group
+
+      # @!method show_group
+      #   @see Vedeu::Models::Group#show
+      def_delegators Vedeu::Models::Group, :show_group
+
+      # @!method toggle_group
+      #   @see Vedeu::Models::Group#toggle
+      def_delegators Vedeu::Models::Group, :toggle_group
+
+      # @!method hide_interface
+      #   @see Vedeu::Models::Interface#hide
+      def_delegators Vedeu::Models::Interface, :hide_interface
+
+      # @!method show_interface
+      #   @see Vedeu::Models::Interface#show
+      def_delegators Vedeu::Models::Interface, :show_interface
+
+      # @!method toggle_interface
+      #   @see Vedeu::Models::Interface#toggle
+      def_delegators Vedeu::Models::Interface, :toggle_interface
+
+    end # External
+
+  end # API
+
+  extend Vedeu::API::External
+
+end # Vedeu

data/lib/vedeu/api/internal.rb

@@ -0,0 +1,173 @@
+module Vedeu
+
+  module API
+
+    module Internal
+
+      extend Forwardable
+
+      module_function
+
+      # Manipulate the repository of background colours.
+      #
+      # @example
+      #   Vedeu.background_colours
+      #
+      # @!method background_colours
+      # @return [Vedeu::Colours::Backgrounds]
+      def_delegators Vedeu::Colours::Backgrounds, :background_colours
+
+      # Manipulate the repository of borders.
+      #
+      # @example
+      #   Vedeu.borders
+      #
+      # @!method borders
+      # @return [Vedeu::Borders::Repository]
+      def_delegators Vedeu::Borders::Repository, :borders
+
+      # Manipulate the repository of buffers.
+      #
+      # @example
+      #   Vedeu.buffers
+      #
+      # @!method buffers
+      # @return [Vedeu::Buffers::Repository]
+      def_delegators Vedeu::Buffers::Repository, :buffers
+
+      # Manipulate the repository of cursors.
+      #
+      # @example
+      #   Vedeu.cursors
+      #
+      # @!method cursors
+      # @return [Vedeu::Cursors::Repository]
+      def_delegators Vedeu::Cursors::Repository, :cursors
+
+      # Allow debugging via the creation of stack traces courtesy of
+      # ruby-prof.
+      #
+      # @example
+      #   Vedeu.debug
+      #
+      # @!method debug
+      # @return [Vedeu::Logging::Debug]
+      def_delegators Vedeu::Logging::Debug, :debug
+
+      # Manipulate the repository of documents.
+      #
+      # @example
+      #   Vedeu.documents
+      #
+      # @!method documents
+      # @return [Vedeu::Editor::Documents]
+      def_delegators Vedeu::Editor::Documents, :documents
+
+      # Manipulate the repository of events.
+      #
+      # @example
+      #   Vedeu.events
+      #
+      # @!method events
+      # @return [Vedeu::Events::Repository]
+      def_delegators Vedeu::Events::Repository, :events
+
+      # Manipulate the repository of foreground colours.
+      #
+      # @example
+      #   Vedeu.foreground_colours
+      #
+      # @!method foreground_colours
+      # @return [Vedeu::Colours::Foregrounds]
+      def_delegators Vedeu::Colours::Foregrounds, :foreground_colours
+
+      # Manipulate the repository of geometries.
+      #
+      # @example
+      #   Vedeu.geometries
+      #
+      # @!method geometries
+      # @return [Vedeu::Geometry::Repository]
+      def_delegators Vedeu::Geometry::Repository, :geometries
+
+      # Manipulate the repository of groups.
+      #
+      # @example
+      #   Vedeu.groups
+      #
+      # @!method groups
+      # @return [Vedeu::Models::Groups]
+      def_delegators Vedeu::Models::Groups, :groups
+
+      # Manipulate the repository of interfaces.
+      #
+      # @example
+      #   Vedeu.interfaces
+      #
+      # @!method interfaces
+      # @return [Vedeu::Models::Interfaces]
+      def_delegators Vedeu::Models::Interfaces, :interfaces
+
+      # Manipulate the repository of keymaps.
+      #
+      # @example
+      #   Vedeu.keymaps
+      #
+      # @!method keymaps
+      # @return [Vedeu::Input::Keymaps]
+      def_delegators Vedeu::Input::Keymaps, :keymaps
+
+      # Manipulate the repository of menus.
+      #
+      # @example
+      #   Vedeu.menus
+      #
+      # @!method menus
+      # @return [Vedeu::Menus::Repository]
+      def_delegators Vedeu::Menus::Repository, :menus
+
+      # Manipulate the internal flags.
+      #
+      # @!method ready?
+      # @!method ready!
+      # @return [Boolean]
+      def_delegators Vedeu::Runtime::Flags, :ready?, :ready!
+
+      # @example
+      #   Vedeu.renderer
+      #   Vedeu.renderers
+      #
+      # @!method renderer
+      #   @see Vedeu::Renderers#renderer
+      # @!method renderers
+      #   @see Vedeu::Renderers#renderers
+      def_delegators Vedeu::Renderers, :renderer, :renderers
+
+      # Instruct the terminal to resize. This will happen
+      # automatically as the terminal recieves SIGWINCH signals.
+      #
+      # @example
+      #   Vedeu.resize
+      #
+      # @!method resize
+      #   @see Vedeu::Terminal#resize
+      def_delegators Vedeu::Terminal, :resize
+
+      # Measure the execution time of the code in the given block.
+      #
+      # @example
+      #   Vedeu.timer do
+      #     # ... some code here ...
+      #   end
+      #
+      # @!method timer
+      #   @see Vedeu::Logging::Timer.timer
+      def_delegators Vedeu::Logging::Timer, :timer
+
+    end # Internal
+
+  end # API
+
+  extend Vedeu::API::Internal
+
+end # Vedeu

data/lib/vedeu/application/controller.rb

@@ -31,7 +31,8 @@ module Vedeu
       def controller(controller_name = nil)
         @controller_name = controller_name
 
-        Vedeu::Router.add_controller(controller_name, ancestors[0].to_s)
+        Vedeu::Runtime::Router.add_controller(controller_name,
+                                              ancestors[0].to_s)
       end
       alias_method :controller_name, :controller
 
@@ -64,7 +65,7 @@ module Vedeu
       # @return [Array<Symbol>]
       def action(*action_names)
         action_names.each do |action_name|
-          Vedeu::Router.add_action(@controller_name, action_name)
+          Vedeu::Runtime::Router.add_action(@controller_name, action_name)
         end
       end
       alias_method :action_name, :action

data/lib/vedeu/bindings/application.rb

@@ -21,7 +21,7 @@ module Vedeu
       # See {file:docs/events/application.md#\_goto_}
       def goto!
         Vedeu.bind(:_goto_) do |controller, action, **args|
-          Vedeu::Router.goto(controller, action, **args)
+          Vedeu::Runtime::Router.goto(controller, action, **args)
         end
 
         Vedeu.bind_alias(:_action_, :_goto_)

data/lib/vedeu/bindings/drb.rb

@@ -40,15 +40,14 @@ module Vedeu
       # See {file:docs/events/drb.md#\_drb_retrieve_output_}
       def drb_retrieve_output!
         Vedeu.bind(:_drb_retrieve_output_) do
-          Vedeu::Buffers::VirtualBuffers.retrieve
+          Vedeu::Terminal::Buffer.output
         end
       end
 
       # See {file:docs/events/drb.md#\_drb_store_output_}
       def drb_store_output!
         Vedeu.bind(:_drb_store_output_) do |data|
-          Vedeu::Buffers::VirtualBuffers
-            .store(Vedeu::Buffers::VirtualBuffer.output(data))
+          Vedeu::Terminal::Buffer.write(data)
         end
       end
 

data/lib/vedeu/bindings/movement.rb

@@ -23,7 +23,7 @@ module Vedeu
 
       # See {file:docs/events/movement.md#\_cursor_up_down_left_right_}
       def directional!
-        [:down, :left, :right, :up].each do |direction|
+        %w(down left right up).each do |direction|
           Vedeu.bind("_cursor_#{direction}_".to_sym) do |name|
             Vedeu.cursors.by_name(name).send("move_#{direction}")
 

data/lib/vedeu/buffers/all.rb

@@ -22,5 +22,3 @@ require 'vedeu/buffers/buffer'
 require 'vedeu/buffers/null'
 require 'vedeu/buffers/repository'
 require 'vedeu/buffers/refresh'
-require 'vedeu/buffers/virtual_buffer'
-require 'vedeu/buffers/virtual_buffers'

data/lib/vedeu/colours/translator.rb

@@ -96,8 +96,9 @@ module Vedeu
       alias_method :to_s, :escape_sequence
       alias_method :to_str, :escape_sequence
 
+      # @param options [Hash] Ignored.
       # @return [String]
-      def to_html
+      def to_html(_options = {})
         return colour if rgb?
 
         ''

data/lib/vedeu/common.rb

@@ -34,9 +34,11 @@ module Vedeu
       name
     end
 
-    # Returns a boolean indicating whether a variable has a useful value.
+    # Returns a boolean indicating whether a variable has a useful
+    # value.
     #
-    # @param variable [String|Symbol|Array|Fixnum] The variable to check.
+    # @param variable [String|Symbol|Array|Fixnum] The variable to
+    #   check.
     # @return [Boolean]
     def present?(variable)
       return true if variable.is_a?(Fixnum)

data/lib/vedeu/configuration/api.rb

@@ -313,7 +313,7 @@ module Vedeu
       # @param renderer [Array<Class>|Class]
       # @return [Array<Class>]
       def renderer(*renderer)
-        options[:renderers] = Vedeu::Configuration.renderers + renderer
+        options[:renderers] = renderer
       end
       alias_method :renderers, :renderer
 

data/lib/vedeu/configuration/cli.rb

@@ -17,7 +17,7 @@ module Vedeu
       #
       # Configure Vedeu via command-line arguments. Options set here
       # via arguments override the client application configuration
-      # set via {Vedeu::API#configure}.
+      # set via {Vedeu::API::External#configure}.
       #
       # @param args [Array]
       # @return [Vedeu::Configuration::CLI]

data/lib/vedeu/cursors/repository.rb

@@ -11,7 +11,7 @@ module Vedeu
       class << self
 
         # @return [Vedeu::Cursors::Cursor]
-        # @see Vedeu::API.cursor
+        # @see Vedeu::API::External.cursor
         def cursor
           cursors.by_name(Vedeu.focus) if Vedeu.focus
         end

data/lib/vedeu/editor/insert.rb

@@ -29,16 +29,8 @@ module Vedeu
       # @return [Vedeu::Editor::Line|Vedeu::Editor::Lines]
       def insert
         if index
-          if index <= 0
-            collection.insert(0, entity)
+          collection.insert(index, entity)
 
-          elsif index >= size
-            collection << entity
-
-          else
-            collection.insert(index, entity)
-
-          end
         else
           collection << entity
 
@@ -55,14 +47,21 @@ module Vedeu
       # @return [String]
       attr_reader :entity
 
-      # @!attribute [r] index
-      # @return [Fixnum]
-      attr_reader :index
-
       # @!attribute [r] size
       # @return [Fixnum]
       attr_reader :size
 
+      private
+
+      # @return [Fixnum]
+      def index
+        return nil unless @index
+
+        @index = 0    if @index < 0
+        @index = size if @index > size
+        @index
+      end
+
     end # Insert
 
   end # Editor

data/lib/vedeu/geometry/position.rb

@@ -23,7 +23,7 @@ module Vedeu
         new(y, x)
       end
 
-      # @param value [Array<Fixnum>|Vedeu::Position]
+      # @param value [Array<Fixnum>|Vedeu::Geometry::Position]
       # @return [Vedeu::Geometry::Position]
       def self.coerce(value)
         if value.is_a?(self)

data/lib/vedeu/models/cell.rb

@@ -18,14 +18,6 @@ module Vedeu
       # @return [NilClass|String]
       attr_reader :value
 
-      # @!attribute [r] x
-      # @return [NilClass|Fixnum]
-      attr_reader :x
-
-      # @!attribute [r] y
-      # @return [NilClass|Fixnum]
-      attr_reader :y
-
       # Returns a new instance of Vedeu::Models::Cell.
       #
       # @param attributes [Hash<Symbol => Array<Symbol|String>,
@@ -34,14 +26,11 @@ module Vedeu
       # @option attributes style
       #   [NilClass|Array<Symbol|String>|Symbol|String]
       # @option attributes value [NilClass|String]
-      # @option attributes x [NilClass|Fixnum]
-      # @option attributes y [NilClass|Fixnum]
+      # @option attributes position [Vedeu::Geometry::Position]
       # @return [Vedeu::Models::Cell]
       def initialize(attributes = {})
-        @attributes = defaults.merge!(attributes)
-
-        @attributes.each do |key, value|
-          instance_variable_set("@#{key}", value)
+        defaults.merge!(attributes).each do |key, value|
+          instance_variable_set("@#{key}", value || defaults.fetch(key))
         end
       end
 
@@ -50,11 +39,37 @@ module Vedeu
       # @param other [Vedeu::Models::Cell]
       # @return [Boolean]
       def eql?(other)
-        self.class == other.class && value == other.value && x == other.x &&
-          y == other.y
+        self.class == other.class && value == other.value &&
+          position == other.position
       end
       alias_method :==, :eql?
 
+      # @return [Vedeu::Geometry::Position]
+      def position
+        Vedeu::Geometry::Position.coerce(@position)
+      end
+
+      # @return [Hash]
+      def to_hash
+        {
+          colour:   colour.to_s,
+          style:    style.to_s,
+          value:    value.to_s,
+          position: position.to_s,
+        }
+      end
+
+      # @param options [Hash] Ignored.
+      # @return [String]
+      def to_html(_options = {})
+        ''
+      end
+
+      # @return [String]
+      def to_s
+        value.to_s
+      end
+
       private
 
       # Returns the default options/attributes for this class.
@@ -62,11 +77,10 @@ module Vedeu
       # @return [Hash<Symbol => void>]
       def defaults
         {
-          colour: nil,
-          style:  nil,
-          value:  nil,
-          x:      nil,
-          y:      nil,
+          colour:   nil,
+          style:    nil,
+          value:    '',
+          position: [1, 1],
         }
       end