vedeu 0.8.5 → 0.8.6

data/lib/vedeu/repositories/repository.rb

@@ -151,8 +151,7 @@ module Vedeu
       # @note If a block is given, store the model, return the model
       #   after yielding.
       # @param model [void] A model instance.
-      # @raise [Vedeu::Error::MissingRequired] When the name attribute
-      #   is not defined.
+      # @macro raise_missing_required
       # @return [void] The model instance which was stored.
       def store(model, &block)
         valid_model?(model)
@@ -179,8 +178,8 @@ module Vedeu
                   message: "#{model.class.name}: '#{model.name}'")
       end
 
-      #
       # @param model [void] A model instance.
+      # @macro raise_missing_required
       # @return [Boolean]
       def valid_model?(model)
         fail Vedeu::Error::MissingRequired,

data/lib/vedeu/runtime/router.rb

@@ -18,8 +18,7 @@ module Vedeu
       #
       # @param controller [Symbol]
       # @param klass [String]
-      # @raise [Vedeu::Error::MissingRequired] When the controller
-      #   name is not given.
+      # @macro raise_missing_required
       # @return [void]
       def add_controller(controller, klass)
         unless present?(controller)
@@ -46,8 +45,7 @@ module Vedeu
       #
       # @param controller [Symbol]
       # @param action [Symbol]
-      # @raise [Vedeu::Error::MissingRequired] When the controller
-      #   name or action name is not given.
+      # @macro raise_missing_required
       # @return [void]
       def add_action(controller, action)
         if present?(controller) && present?(action)
@@ -143,8 +141,7 @@ module Vedeu
       # Fetch the class for the controller by name.
       #
       # @param controller [Symbol]
-      # @raise [Vedeu::Error::MissingRequired] When the given
-      #   controller name does not have a class defined.
+      # @macro raise_missing_required
       # @return [String]
       def klass_for(controller)
         if registered?(controller) && klass_defined?(controller)

data/lib/vedeu/support/point.rb

@@ -1,8 +1,16 @@
 module Vedeu
 
+  # A `Vedeu::Point` represents part of a coordinate within the 2D
+  # space of a terminal. This class is specifically used to coerce
+  # a coordinate to be within boundaries. The `min` and `max`
+  # arguments are used to define this boundary.
+  #
+  # @api private
+  #
   class Point
 
     # @param (see #initialize)
+    # @macro raise_invalid_syntax
     # @return (see #initialize)
     def self.coerce(value: nil, min: 1, max: nil)
       new(value: value, min: min, max: max).coerce
@@ -24,6 +32,7 @@ module Vedeu
       @value = value
     end
 
+    # @macro raise_invalid_syntax
     # @return [Vedeu::Point]
     def coerce
       fail Vedeu::Error::InvalidSyntax,
@@ -53,6 +62,7 @@ module Vedeu
 
     private
 
+    # @macro raise_invalid_syntax
     # @return [Fixnum]
     def min
       return @min if @min.is_a?(Fixnum)
@@ -60,6 +70,7 @@ module Vedeu
       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)

data/lib/vedeu/templating/template.rb

@@ -49,8 +49,7 @@ module Vedeu
         File.read(path)
       end
 
-      # @raise [Vedeu::Error::MissingRequired] When the path is empty
-      #   or does not exist.
+      # @macro raise_missing_required
       # @return [String]
       def path
         fail Vedeu::Error::MissingRequired,

data/lib/vedeu/version.rb

@@ -3,6 +3,6 @@
 module Vedeu
 
   # The current version of Vedeu.
-  VERSION = '0.8.5'
+  VERSION = '0.8.6'
 
 end

data/lib/vedeu/views/chars.rb

@@ -13,8 +13,7 @@ module Vedeu
       # @param collection [void]
       # @param parent [Vedeu::Views::Stream]
       # @param name [NilClass|Symbol|String]
-      # @raise [Vedeu::Error::InvalidSyntax] When the collection
-      #   cannot be coerced since it is unrecognised or unsupported.
+      # @macro raise_invalid_syntax
       # @return [Vedeu::Views::Chars]
       def self.coerce(collection = [], parent = nil, name = nil)
         if collection.is_a?(Vedeu::Views::Chars)

data/lib/vedeu/views/lines.rb

@@ -11,8 +11,7 @@ module Vedeu
     class Lines < Vedeu::Repositories::Collection
 
       # @param (see Vedeu::Repositories::Collection#initialize)
-      # @raise [Vedeu::Error::InvalidSyntax] When the collection
-      #   cannot be coerced since it is unrecognised or unsupported.
+      # @macro raise_invalid_syntax
       # @return [Vedeu::Views::Lines]
       def self.coerce(collection = [], parent = nil, name = nil)
         if collection.is_a?(Vedeu::Views::Lines)

data/lib/vedeu/views/streams.rb

@@ -11,8 +11,7 @@ module Vedeu
     class Streams < Vedeu::Repositories::Collection
 
       # @param (see Vedeu::Repositories::Collection#initialize)
-      # @raise [Vedeu::Error::InvalidSyntax] When the collection
-      #   cannot be coerced since it is unrecognised or unsupported.
+      # @macro raise_invalid_syntax
       # @return [Vedeu::Views::Streams]
       def self.coerce(collection = [], parent = nil, name = nil)
         if collection.is_a?(Vedeu::Views::Streams)

data/lib/vedeu/views/view.rb

@@ -113,8 +113,7 @@ module Vedeu
       #
       # @param refresh [Boolean] Should the buffer of the view be
       #   refreshed once stored? Default: false.
-      # @raise [Vedeu::Error::MissingRequired] When the name of the
-      #   view is not defined.
+      # @macro raise_missing_required
       # @return [Vedeu::Views::View]
       def update_buffer(refresh = false)
         if present?(name)

data/test/lib/vedeu/buffers/empty_test.rb

@@ -90,8 +90,8 @@ module Vedeu
         it { subject.first.must_be_instance_of(Array) }
         it { subject.first.first.must_be_instance_of(Vedeu::Cells::Empty) }
 
-        it { subject.size.must_equal(height) }
-        it { subject.first.size.must_equal(width) }
+        it { subject.size.must_equal(height + 1) }
+        it { subject.first.size.must_equal(width + 1) }
         it { subject.first.first.position.must_equal(position) }
       end
 

data/test/lib/vedeu/common_test.rb

@@ -123,6 +123,28 @@ module Vedeu
       end
     end
 
+    describe '#escape?' do
+      subject { instance.escape?(_value) }
+
+      context 'when the value is a Vedeu::Cells::Escape' do
+        let(:_value) { Vedeu::Cells::Escape.new(value: "\e[0m") }
+
+        it { subject.must_equal(true) }
+      end
+
+      context 'when the value is a Vedeu::Cells::Cursor' do
+        let(:_value) { Vedeu::Cells::Cursor.new(value: "\e[?25h") }
+
+        it { subject.must_equal(true) }
+      end
+
+      context 'when the value is anything else' do
+        let(:_value) { 'anything' }
+
+        it { subject.must_equal(false) }
+      end
+    end
+
     describe '#falsy?' do
       subject { instance.falsy?(_value) }
 

data/test/lib/vedeu/output/output_test.rb

@@ -26,7 +26,7 @@ module Vedeu
         end
 
         context 'when the output is not empty' do
-          let(:output) { Vedeu::Models::Page.new }
+          let(:output) { Vedeu::Cells::Char.new(value: 'a') }
 
           it do
             Vedeu::Buffers::Terminal.expects(:write).with(output)
@@ -74,7 +74,7 @@ module Vedeu
           end
 
           context 'and the output is not an escape sequence' do
-            let(:output) { Vedeu::Models::Page.new }
+            let(:output) { Vedeu::Cells::Char.new(value: 'a') }
 
             it do
               Vedeu::Buffers::Terminal.expects(:write).with(output)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vedeu
 version: !ruby/object:Gem::Version
-  version: 0.8.5
+  version: 0.8.6
 platform: ruby
 authors:
 - Gavin Laking
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-11 00:00:00.000000000 Z
+date: 2016-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard