vedeu 0.4.18 → 0.4.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9465a952ab6e8149c69de234c8e51c5e6f09a2a2
-  data.tar.gz: 6eb60784e45eea477870787e5a5ced902dc5f1c9
+  metadata.gz: dab76c44fae79844ccc5b6321392ee99a09c23d0
+  data.tar.gz: 43162ef0fdcf20ba49b09957d32316379e3e0583
 SHA512:
-  metadata.gz: 48866fecffced7581f359ed1fb6107aedfa746d1035dd0c26443920b158f090ab45199c0d4cdcb84c4cea5d9aefdcc3210895e9cb86bc6d53e033b71692f646d
-  data.tar.gz: 1774d54f66bf61ff8639891c5ec3572740f9ae8f8be1d7019b9a603315720f17ccf61f92b534fc2c78c4f1a8e80577221bf98e944745966d3753feefb59f0d39
+  metadata.gz: a9774a3562701e47aaacc997d01dd157ce021c46b688adda4f56b4cdffb323c918189bc1038b0af46031aa858825449b865eb77b37b41d482aa106e6120f406e
+  data.tar.gz: 222d43c099bf843b27b616536b10b0cc316c6c0cb9bb09e06606ffd00362aa2ee02eb79f84cd09c4ac437d94270df33ec88a1fd4e328d0a6d22e8f9259b104a2

data/.rubocop.yml

@@ -650,7 +650,7 @@ Metrics/ParameterLists:
   CountKeywordArgs: true
 
 Metrics/PerceivedComplexity:
-  Max: 10
+  Max: 12
 
 ##################### Lint ##################################
 

data/Rakefile

@@ -15,6 +15,7 @@ Rake::TestTask.new(:test) do |t|
   t.libs.push 'test'
   t.pattern = 'test/**/*_test.rb'
   t.verbose = false
+  t.warning = false # set to true for Ruby warnings (ruby -w)
 end
 
 YARD::Rake::YardocTask.new(:yard) do |t|

data/bin/vedeu_drb_server

@@ -6,7 +6,6 @@ $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 require 'vedeu'
 
 # A simple test application for Vedeu.
-#
 class VedeuTestApplication
 
   Vedeu.configure do

data/bin/vedeu_test

@@ -6,7 +6,6 @@ $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 require 'vedeu'
 
 # A simple test application for Vedeu.
-#
 class VedeuTestApp
 
   def self.start(argv = ARGV)

data/config/rubocop_enabled.yml

@@ -161,7 +161,7 @@ Style/DeprecatedHashMethods:
 
 Style/Documentation:
   Description: 'Document classes and non-namespace modules.'
-  Enabled: true
+  Enabled: false
 
 Style/DotPosition:
   Description: 'Checks the position of the dot in multi-line method calls.'

data/examples/borders_app.rb

@@ -6,7 +6,6 @@ $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 require 'vedeu'
 
 # An example application to demonstrate borders.
-#
 class VedeuBordersApp
 
   include Vedeu

data/examples/colours_app.rb

@@ -6,7 +6,6 @@ $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 require 'vedeu'
 
 # An example application to demonstrate colours.
-#
 class VedeuColoursApp
 
   include Vedeu

data/examples/cursor_app.rb

@@ -7,7 +7,6 @@ require 'vedeu'
 
 # An example application to demonstrate cursors; their movement and effect on
 # the viewport of the interface in focus.
-#
 class VedeuCursorApp
 
   include Vedeu

data/examples/drb_app.rb

@@ -6,7 +6,6 @@ $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 require 'vedeu'
 
 # An example application to demonstrate the DRb server.
-#
 class VedeuTestApplication
 
   Vedeu.configure do

data/examples/geometry_app.rb

@@ -6,7 +6,6 @@ $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 require 'vedeu'
 
 # An example application to demonstrate geometry.
-#
 class VedeuGeometryApp
 
   include Vedeu

data/examples/hello_world.rb

@@ -9,7 +9,6 @@ trap('INT') { exit! }
 require 'vedeu'
 
 # An example application to demonstrate 'Hello World'.
-#
 class HelloWorldApp
 
   include Vedeu

data/examples/lines_app.rb

@@ -6,7 +6,6 @@ $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 require 'vedeu'
 
 # An example application to demonstrate interface lines.
-#
 class VedeuLinesApp
 
   include Vedeu

data/examples/material_colours_app.rb

@@ -6,7 +6,6 @@ $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 require 'vedeu'
 
 # An example application to demonstrate colours.
-#
 class VedeuMaterialColoursApp
 
   include Vedeu

data/examples/typed_commands/typed_commands_app.rb

@@ -7,7 +7,6 @@ require 'vedeu'
 
 # A simple example application to test the input of commands. This will test
 # the functionality of 'cooked' mode.
-#
 class VedeuTypedCommands
 
   include Vedeu

data/examples/view_templates_app/view_templates_app.rb

@@ -6,7 +6,6 @@ $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 require 'vedeu'
 
 # An example application to demonstrate templates.
-#
 class VedeuViewTemplateApp
 
   include Vedeu

data/lib/vedeu/api.rb

@@ -33,7 +33,8 @@ module Vedeu
   module API
 
     extend Forwardable
-    extend self
+
+    module_function
 
     # @!method borders
     #   @see Vedeu::Borders.borders

data/lib/vedeu/application.rb

@@ -1,7 +1,6 @@
 module Vedeu
 
   # Orchestrates the running of the main application loop.
-  #
   class Application
 
     # @param (see #initialize)
@@ -64,12 +63,14 @@ module Vedeu
       output
     end
 
-    private
+    protected
 
     # @!attribute [r] configuration
     # @return [Configuration]
     attr_reader :configuration
 
+    private
+
     # Runs the application loop either once, or forever (exceptions and signals
     # permitting).
     #

data/lib/vedeu/bindings.rb

@@ -1,5 +1,3 @@
-require 'vedeu/events/event'
-
 module Vedeu
 
   # Creates system events which when called provide a variety of core functions
@@ -171,9 +169,9 @@ module Vedeu
     # Clears the whole terminal space, or the named interface area to be cleared
     # if given.
     Vedeu.bind(:_clear_) do |name|
-      if name && Vedeu.interfaces.registered?(name)
-        Vedeu::Clear.clear(Vedeu.interfaces.find(name), clear_border: true,
-          use_terminal_colours: true)
+      if name
+        Vedeu::Clear.clear(Vedeu.interfaces.by_name(name),
+                           clear_border: true, use_terminal_colours: true)
 
       else
         Vedeu::Terminal.virtual.clear if Vedeu::Configuration.drb?

data/lib/vedeu/buffers/buffer.rb

@@ -1,10 +1,7 @@
-require 'vedeu/repositories/model'
-
 module Vedeu
 
   # The Buffer object represents the states of display for an interface. The
   # states are 'front', 'back' and 'previous'.
-  #
   class Buffer
 
     include Vedeu::Model
@@ -76,10 +73,10 @@ module Vedeu
 
     # @return [void]
     def hide
-      if visible?
-        Vedeu::Visibility.hide(interface)
-        clear
-      end
+      return nil unless visible?
+
+      Vedeu::Visibility.hide(interface)
+      clear
     end
 
     # Return the content for this buffer.
@@ -103,10 +100,10 @@ module Vedeu
 
     # @return [void]
     def show
-      unless visible?
-        Vedeu::Visibility.show(interface)
-        render
-      end
+      return nil if visible?
+
+      Vedeu::Visibility.show(interface)
+      render
     end
 
     private

data/lib/vedeu/buffers/display_buffer.rb

@@ -1,5 +1,3 @@
-require 'vedeu/repositories/all'
-
 module Vedeu
 
   # This module is included in Vedeu::Interface to provide means to store client

data/lib/vedeu/configuration/api.rb

@@ -1,12 +1,9 @@
-require 'vedeu/support/common'
-
 module Vedeu
 
   module Config
 
     # The Configuration::API class parses client application configuration into
     # options used by Vedeu to affect certain behaviours.
-    #
     class API
 
       include Vedeu::Common
@@ -225,7 +222,7 @@ module Vedeu
       # @param value [Boolean]
       # @return [Boolean]
       def trace!(value = true)
-        options[:debug] = true if value === true
+        options[:debug] = true if value
         options[:trace] = value
       end
       alias_method :trace, :trace!

data/lib/vedeu/configuration/cli.rb

@@ -4,7 +4,6 @@ module Vedeu
 
     # The Configuration::CLI class parses command-line arguments using
     # OptionParser into options used by Vedeu to affect certain behaviours.
-    #
     class CLI
 
       # @param (see #initialize)
@@ -28,107 +27,187 @@ module Vedeu
       #
       # @return [Hash]
       def configuration
-        parser = OptionParser.new do |opts|
-          opts.banner = "Usage: #{$PROGRAM_NAME} [options]"
+        setup!
 
-          opts.on('-i', '--interactive',
-                  'Run the application in interactive mode (default).') do
-            options[:interactive] = true
-          end
+        parser.parse!(args)
 
-          opts.on('-I', '--noninteractive', '--standalone',
-                  'Run the application non-interactively; ' \
-                  'i.e. not requiring intervention from the user.') do
-            options[:interactive] = false
-          end
+        Vedeu::Config.log(Esc.blue { '[cli]' }, options)
+      end
 
-          opts.on('-1', '--run-once',
-                  'Run the application loop once.') do
-            options[:once] = true
-          end
+      protected
 
-          opts.on('-n', '--run-many',
-                  'Run the application loop continuously (default).') do
-            options[:once] = false
-          end
+      # @!attribute [r] args
+      # @return [Array<String>]
+      attr_reader :args
 
-          opts.on('-c', '--cooked', 'Run application in cooked mode.') do
-            options[:terminal_mode] = :cooked
-          end
+      # @!attribute [r] options
+      # @return [Hash]
+      attr_reader :options
 
-          opts.on('-r', '--raw', 'Run application in raw mode (default).') do
-            options[:terminal_mode] = :raw
-          end
+      private
 
-          opts.on('-d', '--debug', 'Run application with debugging on.') do
-            options[:debug] = true
-          end
+      # @return [void]
+      def setup!
+        ([:banner] + allowed_options).each { |opt| send(opt) }
+      end
 
-          opts.on('-D', '--trace', 'Run application with debugging on with ' \
-                                   'method and event tracing (noisy!).') do
-            options[:debug] = true
-            options[:trace] = true
-          end
+      # @return [OptionParser]
+      def parser
+        @parser ||= OptionParser.new
+      end
 
-          opts.on('-C', '--colour-mode [COLOURS]', Integer,
+      # @return [Array<Symbol>]
+      def allowed_options
+        [
+          :colour_mode,
+          :cooked,
+          :debug,
+          :drb,
+          :drb_height,
+          :drb_host,
+          :drb_port,
+          :drb_width,
+          :interactive,
+          :log,
+          :raw,
+          :run_many,
+          :run_once,
+          :standalone,
+          :trace,
+        ]
+      end
+
+      # @return [String]
+      def banner
+        parser.banner = "Usage: #{$PROGRAM_NAME} [options]"
+      end
+
+      # @return [OptionParser]
+      def colour_mode
+        parser.on('-C', '--colour-mode [COLOURS]', Integer,
                   'Run application in either `8`, `16`, `256` or `16777216` ' \
                   'colour mode.') do |colours|
-            if [8, 16, 256, 16_777_216].include?(colours)
-              options[:colour_mode] = colours
+          if [8, 16, 256, 16_777_216].include?(colours)
+            options[:colour_mode] = colours
 
-            else
-              options[:colour_mode] = 8
+          else
+            options[:colour_mode] = 8
 
-            end
-          end
-
-          opts.on('-l', '--log [FILENAME]', String,
-                  'Specify the path for the log file.') do |filename|
-            options[:log] = filename
           end
+        end
+      end
 
-          opts.on('--drb', 'Run application with DRb on.') do
-            options[:drb] = true
-          end
+      # @return [OptionParser]
+      def cooked
+        parser.on('-c', '--cooked', 'Run application in cooked mode.') do
+          options[:terminal_mode] = :cooked
+        end
+      end
 
-          opts.on('--drb-host',
-                  'Set the hostname/IP for the DRb server.') do |hostname|
-            # options[:drb]      = true
-            options[:drb_host] = hostname
-          end
+      # @return [OptionParser]
+      def debug
+        parser.on('-d', '--debug', 'Run application with debugging on.') do
+          options[:debug] = true
+        end
+      end
 
-          opts.on('--drb-port', 'Set the port for the DRb server.') do |port|
-            # options[:drb]    = true
-            options[:drb_port] = port
-          end
+      # @return [OptionParser]
+      def drb
+        parser.on('--drb', 'Run application with DRb on.') do
+          options[:drb] = true
+        end
+      end
 
-          opts.on('--drb-height',
+      # @return [OptionParser]
+      def drb_height
+        parser.on('--drb-height',
                   'Set the height for fake terminal.') do |height|
-            # options[:drb]      = true
-            options[:drb_height] = height
-          end
+          # options[:drb]      = true
+          options[:drb_height] = height
+        end
+      end
+
+      # @return [OptionParser]
+      def drb_host
+        parser.on('--drb-host',
+                  'Set the hostname/IP for the DRb server.') do |hostname|
+          # options[:drb]      = true
+          options[:drb_host] = hostname
+        end
+      end
+
+      # @return [OptionParser]
+      def drb_port
+        parser.on('--drb-port', 'Set the port for the DRb server.') do |port|
+          # options[:drb]    = true
+          options[:drb_port] = port
+        end
+      end
 
-          opts.on('--drb-width',
+      # @return [OptionParser]
+      def drb_width
+        parser.on('--drb-width',
                   'Set the width for fake terminal.') do |width|
-            # options[:drb]     = true
-            options[:drb_width] = width
-          end
+          # options[:drb]     = true
+          options[:drb_width] = width
         end
+      end
 
-        parser.parse!(args)
+      # @return [OptionParser]
+      def interactive
+        parser.on('-i', '--interactive',
+                  'Run the application in interactive mode (default).') do
+          options[:interactive] = true
+        end
+      end
 
-        Vedeu::Config.log(Esc.blue { '[cli]' }, options)
+      # @return [OptionParser]
+      def log
+        parser.on('-l', '--log [FILENAME]', String,
+                  'Specify the path for the log file.') do |filename|
+          options[:log] = filename
+        end
       end
 
-      private
+      # @return [OptionParser]
+      def raw
+        parser.on('-r', '--raw', 'Run application in raw mode (default).') do
+          options[:terminal_mode] = :raw
+        end
+      end
 
-      # @!attribute [r] args
-      # @return [Array<String>]
-      attr_reader :args
+      # @return [OptionParser]
+      def run_many
+        parser.on('-n', '--run-many',
+                  'Run the application loop continuously (default).') do
+          options[:once] = false
+        end
+      end
 
-      # @!attribute [r] options
-      # @return [Hash]
-      attr_reader :options
+      # @return [OptionParser]
+      def run_once
+        parser.on('-1', '--run-once', 'Run the application loop once.') do
+          options[:once] = true
+        end
+      end
+
+      # @return [OptionParser]
+      def standalone
+        parser.on('-I', '--noninteractive', '--standalone',
+                  'Run the application non-interactively; ' \
+                  'i.e. not requiring intervention from the user.') do
+          options[:interactive] = false
+        end
+      end
+
+      # @return [OptionParser]
+      def trace
+        parser.on('-D', '--trace', 'Run application with debugging on with ' \
+                                   'method and event tracing (noisy!).') do
+          options[:debug] = true
+          options[:trace] = true
+        end
+      end
 
     end # CLI
 

data/lib/vedeu/configuration/configuration.rb

@@ -1,10 +1,9 @@
 module Vedeu
 
   # Namespace for the API configuration and CLI configuration classes.
-  #
   module Config
 
-    extend self
+    module_function
 
     # Custom log for configuration.
     #

data/lib/vedeu/cursor/cursor.rb

@@ -1,11 +1,7 @@
-require 'vedeu/cursor/all'
-require 'vedeu/geometry/position'
-
 module Vedeu
 
   # Each interface has its own Cursor which maintains the position and
   # visibility of the cursor within that interface.
-  #
   class Cursor
 
     extend Forwardable

data/lib/vedeu/cursor/move.rb

@@ -1,7 +1,3 @@
-require 'vedeu/cursor/cursor'
-require 'vedeu/geometry/coordinate'
-require 'vedeu/geometry/position_validator'
-
 module Vedeu
 
   # Adjusts the position of the cursor. To use this class, call the appropriate
@@ -32,7 +28,6 @@ module Vedeu
   #   The cursor will not exceed the border or boundary of the interface.
   #   The cursor will move freely within the bounds of the interface,
   #     irrespective of content.
-  #
   class Move
 
     extend Forwardable
@@ -122,7 +117,7 @@ module Vedeu
       cursor
     end
 
-    private
+    protected
 
     # @!attribute [r] dx
     # @return [Fixnum]
@@ -136,6 +131,8 @@ module Vedeu
     # @return [String]
     attr_reader :name
 
+    private
+
     # @return [Hash<Symbol => Fixnum, String>]
     def attributes
       cursor.attributes

data/lib/vedeu/cursor/refresh_cursor.rb

@@ -2,7 +2,6 @@ module Vedeu
 
   # Handle the refreshing (redrawing) of a cursor, without redrawing the whole
   # interface; unless the cursor's offset has caused the view to change.
-  #
   class RefreshCursor
 
     extend Forwardable
@@ -37,12 +36,14 @@ module Vedeu
       Vedeu::Terminal.output(new_cursor.to_s)
     end
 
-    private
+    protected
 
     # @!attribute [r] name
     # @return [String]
     attr_reader :name
 
+    private
+
     # @return [Boolean]
     def refresh_view?
       new_cursor.ox >= width || new_cursor.oy >= height
@@ -71,6 +72,15 @@ module Vedeu
       @cursor ||= Vedeu.cursors.by_name(name)
     end
 
+    # Fetch the border by name.
+    #
+    # @note
+    #   Vedeu::Border is used in this way because if there is not a border
+    #   defined, it will fallback to a Vedeu::Null::Border which uses
+    #   Vedeu::Geometry to determine it's dimensions based on the name also.
+    #   When a Vedeu::Geometry cannot be found, this falls back to a
+    #   Vedeu::Null::Geometry which uses the current terminal's dimensions.
+    #
     # @return (see Vedeu::Borders#by_name)
     def border
       @border ||= Vedeu.borders.by_name(name)

data/lib/vedeu/distributed/client.rb

@@ -8,7 +8,6 @@ module Vedeu
     #   client = Vedeu::Distributed::Client.connect("druby://localhost:21420")
     #   client.input('a')
     #   client.output # => 'some content...'
-    #
     class Client
 
       # @param (see #initialize)
@@ -84,12 +83,14 @@ module Vedeu
         :shutdown
       end
 
-      private
+      protected
 
       # @!attribute [r] uri
       # @return [String]
       attr_reader :uri
 
+      private
+
       # @return [void]
       def server
         @server ||= DRbObject.new_with_uri(uri)