vedeu 0.6.10 → 0.6.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c164a962e662469f503fd1e4a7c263e6d4c3eace
-  data.tar.gz: 8e28eb50a3e7c7c0f708ec2b118fc8537ecfdf6f
+  metadata.gz: fd5d4c600e6a615165182a1f701d54b8f073b33a
+  data.tar.gz: 30af16d08fc9b2d86a2a4aa998b205cb15f32bd1
 SHA512:
-  metadata.gz: 793c0295ed02d41e9e03b6e61417938f3c715464f4a765ed70f04fa386a9034389f659d9b058b565871d15707418dce5802024283797bcd41ea699570c04b30c
-  data.tar.gz: f15f247cb1fcd786e7479e2851234f38d3c7900de8ad0c6a3c691e6970eeaa91de583adfe01a395614cacf5f9373f870716db6751c18159e9931d677d4200a46
+  metadata.gz: f3b9d230aa8dea217cb114e762be87c5cac80008dc7530522efe51c419358415e5e839139005d8bb2bd898531c1688a03f1e0a8762294e12fd56ae4232349151
+  data.tar.gz: f5f59df013fe45ee4d7aa4241768cea05acd733b45e2a999a235a8916f95beae94bd8137fdd70fbe297a4eae931d01fa14b9510bcf4cfb3622a07f69f2d3ea78

data/lib/vedeu/all.rb

@@ -1,139 +1,53 @@
 require 'vedeu/version'
 require 'vedeu/options'
 
-require 'vedeu/runtime/launcher'
-require 'vedeu/runtime/bootstrap'
 require 'vedeu/error'
-
-require 'vedeu/logging/all'
-
-require 'vedeu/runtime/traps'
 require 'vedeu/common'
-require 'vedeu/runtime/router'
+require 'vedeu/logging/all'
+require 'vedeu/runtime/all'
 
 require 'vedeu/configuration/cli'
 require 'vedeu/configuration/api'
 require 'vedeu/configuration/configuration'
 
-require 'vedeu/terminal/mode'
-require 'vedeu/terminal/terminal'
-require 'vedeu/terminal/buffer'
-
-require 'vedeu/runtime/main_loop'
-require 'vedeu/runtime/flags'
-require 'vedeu/runtime/application'
+require 'vedeu/terminal/all'
+require 'vedeu/repositories/all'
 
-require 'vedeu/repositories/collection'
 require 'vedeu/input/keys'
-require 'vedeu/repositories/repositories'
-
-require 'vedeu/repositories/model'
-require 'vedeu/repositories/store'
-require 'vedeu/repositories/registerable'
-require 'vedeu/repositories/repository'
-
-require 'vedeu/null/null'
-require 'vedeu/null/generic'
-require 'vedeu/null/interface'
-require 'vedeu/null/view'
-
-require 'vedeu/refresh/refresh'
-require 'vedeu/refresh/refresh_group'
 
 require 'vedeu/models/toggleable'
 
-require 'vedeu/esc/actions'
-require 'vedeu/esc/borders'
-require 'vedeu/esc/colours'
-require 'vedeu/esc/esc'
-
+require 'vedeu/esc/all'
+require 'vedeu/null/all'
 require 'vedeu/models/views/all'
-
-require 'vedeu/models/cell'
-require 'vedeu/models/escape'
-require 'vedeu/models/focus'
-require 'vedeu/models/group'
-require 'vedeu/models/groups'
-require 'vedeu/models/row'
-require 'vedeu/models/page'
-
-require 'vedeu/templating/all'
-require 'vedeu/templating/encoder'
-require 'vedeu/templating/decoder'
-require 'vedeu/templating/helpers'
-require 'vedeu/templating/template'
-require 'vedeu/templating/view_template'
-
-require 'vedeu/application/controller'
-require 'vedeu/application/helper'
-require 'vedeu/application/view'
-require 'vedeu/application/application_controller'
-require 'vedeu/application/application_helper'
-require 'vedeu/application/application_view'
-
-require 'vedeu/distributed/uri'
-require 'vedeu/distributed/server'
-require 'vedeu/distributed/client'
-require 'vedeu/distributed/subprocess'
-require 'vedeu/distributed/test_application'
-
-require 'vedeu/dsl/dsl'
-require 'vedeu/dsl/shared'
-require 'vedeu/dsl/use'
-require 'vedeu/dsl/presentation'
-require 'vedeu/dsl/composition'
-require 'vedeu/dsl/group'
-require 'vedeu/dsl/keymap'
-require 'vedeu/dsl/text'
-require 'vedeu/dsl/interface'
-require 'vedeu/dsl/line'
-require 'vedeu/dsl/stream'
-require 'vedeu/dsl/view'
-
+require 'vedeu/models/all'
+require 'vedeu/application/all'
+require 'vedeu/dsl/all'
 require 'vedeu/borders/all'
 require 'vedeu/buffers/all'
 require 'vedeu/colours/all'
 require 'vedeu/cursors/all'
+require 'vedeu/distributed/all'
 require 'vedeu/editor/all'
 require 'vedeu/events/all'
 require 'vedeu/geometry/all'
 require 'vedeu/input/all'
 require 'vedeu/menus/all'
+require 'vedeu/templating/all'
 
 require 'vedeu/output/presentation/presentation'
-
 require 'vedeu/output/direct'
 require 'vedeu/output/clear/named_group'
 require 'vedeu/output/clear/named_interface'
-
 require 'vedeu/output/compressor'
 require 'vedeu/output/text'
 require 'vedeu/output/output'
 require 'vedeu/output/viewport'
 require 'vedeu/output/wordwrap'
-require 'vedeu/output/renderers/renderer_options'
-require 'vedeu/output/renderers/escape_sequence'
-require 'vedeu/output/renderers/file'
-require 'vedeu/output/renderers/html'
-require 'vedeu/output/renderers/json'
-require 'vedeu/output/renderers/null'
-require 'vedeu/output/renderers/terminal'
-require 'vedeu/output/renderers/text'
-require 'vedeu/output/renderers'
-
-require 'vedeu/api/external'
-require 'vedeu/api/internal'
-
-require 'vedeu/bindings/application'
-require 'vedeu/bindings/document'
-require 'vedeu/bindings/drb'
-require 'vedeu/bindings/menus'
-require 'vedeu/bindings/movement'
-require 'vedeu/bindings/focus'
-require 'vedeu/bindings/refresh'
-require 'vedeu/bindings/system'
-require 'vedeu/bindings/visibility'
-require 'vedeu/bindings/bindings'
+require 'vedeu/output/refresh/refresh'
+require 'vedeu/output/refresh/refresh_group'
+require 'vedeu/output/renderers/all'
 
-require 'vedeu/plugins/plugins'
-require 'vedeu/plugins/plugin'
+require 'vedeu/api/all'
+require 'vedeu/bindings/all'
+require 'vedeu/plugins/all'

data/lib/vedeu/api/all.rb

@@ -0,0 +1,15 @@
+module Vedeu
+
+  # The API namespace provides the internal and external API methods
+  # for Vedeu. These methods are convenient ways to perform many
+  # actions and control the behaviour of Vedeu without needing to
+  # know the specific implementations.
+  #
+  module API
+
+  end # API
+
+end # Vedeu
+
+require 'vedeu/api/external'
+require 'vedeu/api/internal'

data/lib/vedeu/api/internal.rb

@@ -2,6 +2,10 @@ module Vedeu
 
   module API
 
+    # The internal API methods allow Vedeu to function and change
+    # without major refactoring. The methods listed here will rarely
+    # be used by client applications.
+    #
     module Internal
 
       extend Forwardable

data/lib/vedeu/application/all.rb

@@ -0,0 +1,6 @@
+require 'vedeu/application/controller'
+require 'vedeu/application/helper'
+require 'vedeu/application/view'
+require 'vedeu/application/application_controller'
+require 'vedeu/application/application_helper'
+require 'vedeu/application/application_view'

data/lib/vedeu/bindings/all.rb

@@ -0,0 +1,32 @@
+module Vedeu
+
+  # Binds various events for running and manipulating Vedeu. When
+  # called provide a variety of core functions and behaviours.
+  # They are soft-namespaced using underscores.
+  #
+  # @note
+  #   The methods these modules use are private, and should not be
+  #   called directly, however the produced events are all public and
+  #   are highly recommended to be used.
+  #
+  #   Unbinding any of these events is likely to cause problems, so I
+  #   would advise leaving them alone. A safe rule: when the name
+  #   starts and ends with an underscore, it's probably used by Vedeu
+  #   internally.
+  #
+  module Bindings
+
+  end # Bindings
+
+end # Vedeu
+
+require 'vedeu/bindings/application'
+require 'vedeu/bindings/document'
+require 'vedeu/bindings/drb'
+require 'vedeu/bindings/menus'
+require 'vedeu/bindings/movement'
+require 'vedeu/bindings/focus'
+require 'vedeu/bindings/refresh'
+require 'vedeu/bindings/system'
+require 'vedeu/bindings/visibility'
+require 'vedeu/bindings/bindings'

data/lib/vedeu/bindings/bindings.rb

@@ -1,19 +1,5 @@
 module Vedeu
 
-  # Binds various events for running and manipulating Vedeu. When
-  # called provide a variety of core functions and behaviours.
-  # They are soft-namespaced using underscores.
-  #
-  # @note
-  #   The methods these modules use are private, and should not be
-  #   called directly, however the produced events are all public and
-  #   are highly recommended to be used.
-  #
-  #   Unbinding any of these events is likely to cause problems, so I
-  #   would advise leaving them alone. A safe rule: when the name
-  #   starts and ends with an underscore, it's probably used by Vedeu
-  #   internally.
-  #
   module Bindings
 
     extend self

data/lib/vedeu/bindings/refresh.rb

@@ -21,7 +21,13 @@ module Vedeu
       # See {file:docs/events/refresh.md#\_refresh_}
       def refresh!
         Vedeu.bind(:_refresh_) do |name|
-          name ? Vedeu::Buffers::Refresh.by_name(name) : Vedeu::Refresh.all
+          if name
+            Vedeu::Buffers::Refresh.by_name(name)
+
+          else
+            Vedeu::Output::Refresh.all
+
+          end
         end
       end
 
@@ -35,7 +41,7 @@ module Vedeu
       # See {file:docs/events/refresh.md#\_refresh_group_}
       def refresh_group!
         Vedeu.bind(:_refresh_group_) do |name|
-          Vedeu::RefreshGroup.by_name(name)
+          Vedeu::Output::RefreshGroup.by_name(name)
         end
       end
 

data/lib/vedeu/bindings/system.rb

@@ -43,6 +43,7 @@ module Vedeu
 
           else
             Vedeu::Terminal.clear
+            Vedeu::Terminal::Buffer.clear
 
           end
         end

data/lib/vedeu/borders/border.rb

@@ -16,7 +16,7 @@ module Vedeu
 
       extend Forwardable
       include Vedeu::Common
-      include Vedeu::Model
+      include Vedeu::Repositories::Model
       include Vedeu::Presentation
 
       def_delegators :geometry,

data/lib/vedeu/borders/repository.rb

@@ -5,7 +5,7 @@ module Vedeu
     # Allows the storing of interface/view borders independent of the
     # interface instance.
     #
-    class Repository < Vedeu::Repository
+    class Repository < Vedeu::Repositories::Repository
 
       singleton_class.send(:alias_method, :borders, :repository)
 

data/lib/vedeu/buffers/buffer.rb

@@ -7,7 +7,7 @@ module Vedeu
     #
     class Buffer
 
-      include Vedeu::Model
+      include Vedeu::Repositories::Model
 
       # The next buffer to be displayed; contains the content which
       # will be shown on next refresh.
@@ -45,9 +45,7 @@ module Vedeu
       # @option attributes repository [Vedeu::Buffers::Repository]
       # @return [Vedeu::Buffers::Buffer]
       def initialize(attributes = {})
-        @attributes = defaults.merge!(attributes)
-
-        @attributes.each do |key, value|
+        defaults.merge!(attributes).each do |key, value|
           instance_variable_set("@#{key}", value)
         end
       end

data/lib/vedeu/buffers/repository.rb

@@ -4,7 +4,7 @@ module Vedeu
 
     # Allows the storing of view buffers.
     #
-    class Repository < Vedeu::Repository
+    class Repository < Vedeu::Repositories::Repository
 
       singleton_class.send(:alias_method, :buffers, :repository)
 

data/lib/vedeu/colours/background.rb

@@ -12,7 +12,7 @@ module Vedeu
 
       # @return [String]
       def named_codes
-        Vedeu::Esc.background_codes[colour]
+        Vedeu::EscapeSequences::Esc.background_codes[colour]
       end
 
       # @return [String]

data/lib/vedeu/colours/backgrounds.rb

@@ -7,7 +7,7 @@ module Vedeu
     class Backgrounds < Vedeu::Colours::Repository
 
       # @return [Vedeu::Colours::Backgrounds]
-      # @see Vedeu::Repository
+      # @see Vedeu::Repositories::Repository
       def self.background_colours
         @background_colours ||= new
       end

data/lib/vedeu/colours/foreground.rb

@@ -12,7 +12,7 @@ module Vedeu
 
       # @return [String]
       def named_codes
-        Vedeu::Esc.foreground_codes[colour]
+        Vedeu::EscapeSequences::Esc.foreground_codes[colour]
       end
 
       # @return [String]

data/lib/vedeu/colours/foregrounds.rb

@@ -7,7 +7,7 @@ module Vedeu
     class Foregrounds < Vedeu::Colours::Repository
 
       # @return [Vedeu::Colours::Foregrounds]
-      # @see Vedeu::Repository
+      # @see Vedeu::Repositories::Repository
       def self.foreground_colours
         @foreground_colours ||= new
       end

data/lib/vedeu/colours/translator.rb

@@ -96,7 +96,7 @@ module Vedeu
       alias_method :to_s, :escape_sequence
       alias_method :to_str, :escape_sequence
 
-      # @param options [Hash] Ignored.
+      # @param _options [Hash] Ignored.
       # @return [String]
       def to_html(_options = {})
         return colour if rgb?
@@ -142,7 +142,8 @@ module Vedeu
       # Returns an escape sequence for a named background colour.
       #
       # @note
-      #   Valid names can be found at {Vedeu::Esc#codes}
+      #   Valid names can be found at
+      #   {Vedeu::EscapeSequences::Esc#codes}
       #
       # @return [String]
       def named
@@ -154,7 +155,7 @@ module Vedeu
       #
       # @return [Boolean]
       def valid_name?
-        Vedeu::Esc.codes.keys.include?(colour)
+        Vedeu::EscapeSequences::Esc.codes.keys.include?(colour)
       end
 
       # Returns a boolean indicating whether the colour provided is a

data/lib/vedeu/configuration/api.rb

@@ -35,7 +35,8 @@ module Vedeu
       #
       # @return [Hash<Symbol => Boolean, Fixnum, String>]
       def configuration
-        Vedeu::Config.log(Esc.green { '[api]' }, options)
+        Vedeu::Config
+          .log(Vedeu::EscapeSequences::Esc.green { '[api]' }, options)
       end
 
       # Sets boolean to allow user input. The default behaviour of

data/lib/vedeu/configuration/cli.rb

@@ -35,7 +35,7 @@ module Vedeu
 
         parser.parse!(args)
 
-        Vedeu::Config.log(Esc.blue { '[cli]' }, options)
+        Vedeu::Config.log(Vedeu::EscapeSequences::Esc.blue { '[cli]' }, options)
       end
 
       protected

data/lib/vedeu/cursors/cursor.rb

@@ -7,7 +7,7 @@ module Vedeu
     #
     class Cursor
 
-      include Vedeu::Model
+      include Vedeu::Repositories::Model
       include Vedeu::Toggleable
       extend Forwardable
 
@@ -52,7 +52,8 @@ module Vedeu
       #   this cursor belongs to.
       # @option attributes ox [Fixnum] The offset x coordinate.
       # @option attributes oy [Fixnum] The offset y coordinate.
-      # @option attributes repository [Vedeu::Repository]
+      # @option attributes repository
+      #   [Vedeu::Repositories::Repository]
       # @option attributes visible [Boolean] The visibility of the
       #   cursor.
       # @option attributes x [Fixnum] The terminal x coordinate for
@@ -75,10 +76,7 @@ module Vedeu
       def move_down
         @oy += 1
 
-        @attributes = attributes.merge!(x:  x,
-                                        y:  coordinate.y_position,
-                                        ox: ox,
-                                        oy: oy)
+        @attributes = new_attributes(coordinate.y_position, x, oy, ox)
 
         Vedeu::Cursors::Cursor.new(@attributes).store
       end
@@ -89,10 +87,7 @@ module Vedeu
       def move_left
         @ox -= 1
 
-        @attributes = attributes.merge!(x:  coordinate.x_position,
-                                        y:  y,
-                                        ox: ox,
-                                        oy: oy)
+        @attributes = new_attributes(y, coordinate.x_position, oy, ox)
 
         Vedeu::Cursors::Cursor.new(@attributes).store
       end
@@ -112,10 +107,7 @@ module Vedeu
       def move_right
         @ox += 1
 
-        @attributes = attributes.merge!(x:  coordinate.x_position,
-                                        y:  y,
-                                        ox: ox,
-                                        oy: oy)
+        @attributes = new_attributes(y, coordinate.x_position, oy, ox)
 
         Vedeu::Cursors::Cursor.new(@attributes).store
       end
@@ -126,10 +118,7 @@ module Vedeu
       def move_up
         @oy -= 1
 
-        @attributes = attributes.merge!(x:  x,
-                                        y:  coordinate.y_position,
-                                        ox: ox,
-                                        oy: oy)
+        @attributes = new_attributes(coordinate.y_position, x, oy, ox)
 
         Vedeu::Cursors::Cursor.new(@attributes).store
       end
@@ -143,14 +132,14 @@ module Vedeu
 
       # Arbitrarily move the cursor to a given position.
       #
-      # @param new_y [Fixnum] The row/line position.
-      # @param new_x [Fixnum] The column/character position.
+      # @param new_oy [Fixnum] The row/line position.
+      # @param new_ox [Fixnum] The column/character position.
       # @return [Vedeu::Cursors::Cursor]
-      def reposition(new_y, new_x)
-        @attributes = attributes.merge!(x:  coordinate.x_position,
-                                        y:  coordinate.y_position,
-                                        ox: new_x,
-                                        oy: new_y)
+      def reposition(new_oy, new_ox)
+        @attributes = new_attributes(coordinate.y_position,
+                                     coordinate.x_position,
+                                     new_oy,
+                                     new_ox)
 
         Vedeu::Cursors::Cursor.new(@attributes).store
       end
@@ -280,12 +269,23 @@ module Vedeu
         }
       end
 
+      # @return [Hash]
+      def new_attributes(new_y = y, new_x = x, new_oy = oy, new_ox = ox)
+        attributes.merge!(x: new_x, y: new_y, ox: new_ox, oy: new_oy)
+      end
+
       # Returns the escape sequence for setting the visibility of the
       # cursor.
       #
       # @return [String]
       def visibility
-        value = visible? ? Vedeu::Esc.show_cursor : Vedeu::Esc.hide_cursor
+        value = if visible?
+                  Vedeu::EscapeSequences::Esc.show_cursor
+
+                else
+                  Vedeu::EscapeSequences::Esc.hide_cursor
+
+                end
 
         Vedeu::Models::Escape.new(position: position, value: value)
       end

data/lib/vedeu/cursors/repository.rb

@@ -4,7 +4,7 @@ module Vedeu
 
     # Allows the storing of each interface's cursor.
     #
-    class Repository < Vedeu::Repository
+    class Repository < Vedeu::Repositories::Repository
 
       singleton_class.send(:alias_method, :cursors, :repository)
 

data/lib/vedeu/distributed/all.rb

@@ -0,0 +1,16 @@
+module Vedeu
+
+  # Provides a mechanism to control a running client application via
+  # DRb.
+  #
+  module Distributed
+
+  end # Distributed
+
+end # Vedeu
+
+require 'vedeu/distributed/uri'
+require 'vedeu/distributed/server'
+require 'vedeu/distributed/client'
+require 'vedeu/distributed/subprocess'
+require 'vedeu/distributed/test_application'

data/lib/vedeu/distributed/test_application.rb

@@ -66,9 +66,9 @@ module Vedeu
     # @option attributes views [String]
     # @return [Vedeu::TestApplication]
     def initialize(attributes = {})
-      @attributes = defaults.merge!(attributes)
-
-      @attributes.each { |k, _| instance_variable_set("@#{k}", @attributes[k]) }
+      defaults.merge!(attributes).each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
     end
 
     # @param block [Proc]

data/lib/vedeu/dsl/all.rb

@@ -0,0 +1,22 @@
+module Vedeu
+
+  # Provides a mechanism to help configure and use Vedeu.
+  #
+  module DSL
+
+  end # DSL
+
+end # Vedeu
+
+require 'vedeu/dsl/dsl'
+require 'vedeu/dsl/shared'
+require 'vedeu/dsl/use'
+require 'vedeu/dsl/presentation'
+require 'vedeu/dsl/composition'
+require 'vedeu/dsl/group'
+require 'vedeu/dsl/keymap'
+require 'vedeu/dsl/text'
+require 'vedeu/dsl/interface'
+require 'vedeu/dsl/line'
+require 'vedeu/dsl/stream'
+require 'vedeu/dsl/view'