vedeu 0.8.8 → 0.8.9

data/lib/vedeu/renderers/all.rb

@@ -21,9 +21,10 @@ module Vedeu
     # @return [Array<void>]
     def clear
       storage.map do |renderer|
-        log('Clearing', renderer)
+        Vedeu.log(type:    :render,
+                  message: "Clearing via #{renderer.class.name}")
 
-        threaded(renderer) { renderer.clear }
+        perform(renderer) { renderer.clear }
       end.each(&:join) if Vedeu.ready?
 
       ''
@@ -49,9 +50,10 @@ module Vedeu
     # @return [Array<void>]
     def render(output)
       storage.map do |renderer|
-        log('Rendering', renderer)
+        Vedeu.log(type:    :render,
+                  message: "Rendering via #{renderer.class.name}")
 
-        threaded(renderer) { renderer.render(output) }
+        perform(renderer) { renderer.render(output) }
       end.each(&:join) if Vedeu.ready?
 
       output
@@ -70,12 +72,16 @@ module Vedeu
       end
     end
 
-    # @param message [String]
-    # @param renderer [Class]
-    # @return [void]
-    def log(message, renderer)
-      Vedeu.log(type:    :render,
-                message: "#{message} via #{renderer.class.name}")
+    # @param renderer [void]
+    # @param block [Proc]
+    def perform(renderer, &block)
+      if Vedeu.config.threaded?
+        threaded(renderer) { yield }
+
+      else
+        unthreaded { yield }
+
+      end
     end
 
     # @return [Mutex]
@@ -105,6 +111,14 @@ module Vedeu
       Vedeu.trigger(:_show_cursor_)
     end
 
+    # @param block [Proc]
+    # @return [void]
+    def unthreaded(&block)
+      toggle_cursor do
+        yield
+      end
+    end
+
   end # Renderers
 
   # @example

data/lib/vedeu/repositories/model.rb

@@ -16,9 +16,7 @@ module Vedeu
       # @return [Vedeu::Repositories::Repository]
       attr_accessor :repository
 
-      # When {Vedeu::Repositories::Model} is included in a class, the
-      # methods within this module are included as class methods on
-      # that class.
+      # Provide additional behaviour as class methods.
       #
       module ClassMethods
 
@@ -68,11 +66,7 @@ module Vedeu
 
       end # ClassMethods
 
-      # When this module is included in a class, provide ClassMethods
-      # as class methods for the class.
-      #
-      # @param klass [Class]
-      # @return [void]
+      # @macro included_module
       def self.included(klass)
         klass.extend(Vedeu::Repositories::Model::ClassMethods)
       end

data/lib/vedeu/repositories/registerable.rb

@@ -9,7 +9,8 @@ module Vedeu
     #
     module Registerable
 
-      # These class methods are mixed into the repository.
+      # Provide additional behaviour as class methods.
+      #
       module ClassMethods
 
         # The null model is used when the repository cannot be found.
@@ -64,9 +65,7 @@ module Vedeu
 
       end # ClassMethods
 
-      # When {Vedeu::Repositories::Registerable} is included in a
-      # class, the methods within this module are included as instance
-      # methods on that class.
+      # Provide additional behaviour as instance methods.
       #
       module InstanceMethods
 
@@ -77,11 +76,7 @@ module Vedeu
 
       end # InstanceMethods
 
-      # When this module is included in a class, provide ClassMethods
-      # as class methods for the class.
-      #
-      # @param klass [Class]
-      # @return [void]
+      # @macro included_module
       def self.included(klass)
         klass.extend(Vedeu::Repositories::Registerable::ClassMethods)
         klass.include(Vedeu::Repositories::Registerable::InstanceMethods)

data/lib/vedeu/runtime/application.rb

@@ -6,6 +6,8 @@ module Vedeu
 
     # Orchestrates the running of the main application loop.
     #
+    # @api private
+    #
     class Application
 
       class << self

data/lib/vedeu/runtime/flags.rb

@@ -6,6 +6,8 @@ module Vedeu
 
     # Home of various runtime flags which Vedeu uses.
     #
+    # @api public
+    #
     class Flags
 
       include Singleton

data/lib/vedeu/runtime/router.rb

@@ -7,6 +7,8 @@ module Vedeu
     # Stores all client application controllers with their respective
     # actions.
     #
+    # @api public
+    #
     module Router
 
       include Vedeu::Common

data/lib/vedeu/support/point.rb

@@ -12,21 +12,21 @@ module Vedeu
     # @param (see #initialize)
     # @macro raise_invalid_syntax
     # @return (see #initialize)
-    def self.coerce(value: nil, min: 1, max: nil)
+    def self.coerce(value: nil, min: 1, max: Float::INFINITY)
       new(value: value, min: min, max: max).coerce
     end
 
     # @param (see #initialize)
     # @return (see #initialize)
-    def self.valid?(value: nil, min: 1, max: nil)
+    def self.valid?(value: nil, min: 1, max: Float::INFINITY)
       new(value: value, min: min, max: max).valid?
     end
 
     # @param value [Fixnum|NilClass]
     # @param min [Fixnum]
-    # @param max [Fixnum]
+    # @param max [Fixnum|Float::INFINITY]
     # @return [Vedeu::Point]
-    def initialize(value: nil, min: 1, max: nil)
+    def initialize(value: nil, min: 1, max: Float::INFINITY)
       @min   = min
       @max   = max
       @value = value
@@ -67,15 +67,17 @@ module Vedeu
     def min
       return @min if @min.is_a?(Fixnum)
 
-      fail Vedeu::Error::InvalidSyntax, "Expecting 'min' to be a Fixnum."
+      fail Vedeu::Error::InvalidSyntax,
+           "Expecting 'min' to be a Fixnum."
     end
 
     # @macro raise_invalid_syntax
     # @return [Fixnum]
     def max
-      return @max if @max.is_a?(Fixnum)
+      return @max if @max.is_a?(Fixnum) || @max == Float::INFINITY
 
-      fail Vedeu::Error::InvalidSyntax, "Expecting 'max' to be a Fixnum."
+      fail Vedeu::Error::InvalidSyntax,
+           "Expecting 'max' to be a Fixnum or Float::INFINITY."
     end
 
   end # Point

data/lib/vedeu/support/x_coordinate.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Vedeu
+
+  # Provide delegation methods for Vedeu::Geometries::Geometry.
+  #
+  # @api private
+  #
+  class XCoordinate
+
+    # @param geometry [Vedeu::Geometries::Geometry]
+    # @return [Vedeu::XCoordinate]
+    def initialize(geometry)
+      @geometry = geometry
+    end
+
+    # Return the :x value from the geometry.
+    #
+    # @return [Fixnum]
+    def d
+      geometry.x
+    end
+    alias x d
+
+    # Return the :bx value from the geometry.
+    #
+    # @return [Fixnum]
+    def bd
+      geometry.bx
+    end
+    alias bx bd
+
+    # Return the :bxn value from the geometry.
+    #
+    # @return [Fixnum]
+    def bdn
+      geometry.bxn
+    end
+    alias bxn bdn
+
+    # Return the :bordered_width value from the geometry.
+    #
+    # @return [Fixnum]
+    def d_dn
+      geometry.bordered_width
+    end
+    alias bordered_width d_dn
+
+    protected
+
+    # @!attribute [r] geometry
+    # @return [Vedeu::Geometries::Geometry]
+    attr_reader :geometry
+
+  end # XCoordinate
+
+end # Vedeu

data/lib/vedeu/support/y_coordinate.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Vedeu
+
+  # Provide delegation methods for Vedeu::Geometries::Geometry.
+  #
+  # @api private
+  #
+  class YCoordinate
+
+    # @param geometry [Vedeu::Geometries::Geometry]
+    # @return [Vedeu::XCoordinate]
+    def initialize(geometry)
+      @geometry = geometry
+    end
+
+    # Return the :y value from the geometry.
+    #
+    # @return [Fixnum]
+    def d
+      geometry.y
+    end
+    alias y d
+
+    # Return the :by value from the geometry.
+    #
+    # @return [Fixnum]
+    def bd
+      geometry.by
+    end
+    alias by bd
+
+    # Return the :byn value from the geometry.
+    #
+    # @return [Fixnum]
+    def bdn
+      geometry.byn
+    end
+    alias byn bdn
+
+    # Return the :bordered_height value from the geometry.
+    #
+    # @return [Fixnum]
+    def d_dn
+      geometry.bordered_height
+    end
+    alias bordered_height d_dn
+
+    protected
+
+    # @!attribute [r] geometry
+    # @return [Vedeu::Geometries::Geometry]
+    attr_reader :geometry
+
+  end # YCoordinate
+
+end # Vedeu

data/lib/vedeu/terminal/terminal.rb

@@ -5,6 +5,8 @@ module Vedeu
   # This module is the direct interface between Vedeu and your
   # terminal/ console, via Ruby's IO core library.
   #
+  # @api private
+  #
   module Terminal
 
     include Vedeu::Terminal::Mode

data/lib/vedeu/version.rb

@@ -3,6 +3,6 @@
 module Vedeu
 
   # The current version of Vedeu.
-  VERSION = '0.8.8'.freeze
+  VERSION = '0.8.9'.freeze
 
 end

data/lib/vedeu/views/value.rb

@@ -10,9 +10,7 @@ module Vedeu
     #
     module Value
 
-      # Provides view model class methods for Vedeu::Views.
-      #
-      # @api private
+      # Provide additional behaviour as class methods.
       #
       module ClassMethods
 
@@ -58,9 +56,7 @@ module Vedeu
 
       end # ClassMethods
 
-      # Provides view model instance methods for Vedeu::Views.
-      #
-      # @api private
+      # Provide additional behaviour as instance methods.
       #
       module InstanceMethods
 
@@ -128,12 +124,7 @@ module Vedeu
 
       end # InstanceMethods
 
-      # When this module is included in a class, provide ClassMethods
-      # as class methods and InstanceMethods as instance methods for
-      # the given class.
-      #
-      # @param klass [Class]
-      # @return [void]
+      # @macro included_module
       def self.included(klass)
         klass.extend(Vedeu::Views::Value::ClassMethods)
         klass.include(Vedeu::Views::Value::InstanceMethods)

data/test/lib/vedeu/coercers/chars_test.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+module Vedeu
+
+  module Coercers
+
+    describe Chars do
+
+      let(:described) { Vedeu::Coercers::Chars }
+      let(:instance)  { described.new(_value) }
+      let(:_value)    {}
+      let(:klass)     { Vedeu::Views::Chars }
+
+      describe '#initialize' do
+        it { instance.must_be_instance_of(described) }
+        it { instance.instance_variable_get('@value').must_equal(_value) }
+      end
+
+      describe '.coerce' do
+        it { described.must_respond_to(:coerce) }
+      end
+
+      describe '#coerce' do
+        subject { instance.coerce }
+      end
+
+    end # Chars
+
+  end # Coercers
+
+end # Vedeu

data/test/lib/vedeu/coercers/coercer_test.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+module Vedeu
+
+  module Coercers
+
+    describe Coercer do
+
+      let(:described) { Vedeu::Coercers::Coercer }
+      let(:instance)  { described.new(_value) }
+      let(:_value)    {}
+
+      describe '#initialize' do
+        it { instance.must_be_instance_of(described) }
+        it { instance.instance_variable_get('@value').must_equal(_value) }
+      end
+
+      describe '.coerce' do
+        it { described.must_respond_to(:coerce) }
+      end
+
+      describe '#coerce' do
+        subject { instance.coerce }
+
+        it { proc { subject }.must_raise(Vedeu::Error::NotImplemented) }
+      end
+
+    end # Coercer
+
+  end # Coercers
+
+end # Vedeu

data/test/lib/vedeu/coercers/colour_test.rb

@@ -11,6 +11,7 @@ module Vedeu
       let(:described) { Vedeu::Coercers::Colour }
       let(:instance)  { described.new(_value) }
       let(:_value)    {}
+      let(:klass)     { Vedeu::Colours::Colour }
 
       describe '#initialize' do
         it { instance.must_be_instance_of(described) }
@@ -21,7 +22,7 @@ module Vedeu
         subject { described.coerce(_value) }
 
         context 'when the value is nil' do
-          it { subject.must_be_instance_of(Vedeu::Colours::Colour) }
+          it { subject.must_be_instance_of(klass) }
         end
 
         context 'when the value is a Hash' do
@@ -32,7 +33,7 @@ module Vedeu
             }
           }
 
-          it { subject.must_be_instance_of(Vedeu::Colours::Colour) }
+          it { subject.must_be_instance_of(klass) }
           it do
             subject.background.must_be_instance_of(Vedeu::Colours::Background)
           end
@@ -44,19 +45,20 @@ module Vedeu
         context 'when the value is a Vedeu::Colours::Background' do
           let(:_value)   { Vedeu::Colours::Background.new('#aadd00') }
 
-          it { subject.must_be_instance_of(Vedeu::Colours::Colour) }
+          it { subject.must_be_instance_of(klass) }
         end
 
-        context 'when the value is a Vedeu::Colours::Colour' do
-          let(:_value) { Vedeu::Colours::Colour.new }
+        context 'when the value is already the target class' do
+          let(:_value) { klass.new }
 
-          it { subject.must_be_instance_of(Vedeu::Colours::Colour) }
+          it { subject.must_be_instance_of(klass) }
+          it { subject.must_equal(_value) }
         end
 
         context 'when the value is a Vedeu::Colours::Foreground' do
           let(:_value) { Vedeu::Colours::Foreground.new('#448822') }
 
-          it { subject.must_be_instance_of(Vedeu::Colours::Colour) }
+          it { subject.must_be_instance_of(klass) }
         end
 
         context 'when the value is invalid or unsupported' do