vedeu 0.6.44 → 0.6.45

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f4dc70c4f76f9925516a551048473859ddd3dff7
-  data.tar.gz: a3edcec22cc3421ce2c725ea96340587e669f03b
+  metadata.gz: c76c4e0d9abb0d4ce8fd8f6161c07504a3d6cbbb
+  data.tar.gz: 7ee11459a372f200d2d2ae141fc159c96b941fbe
 SHA512:
-  metadata.gz: 08a1c9d7c3a83c44012dd04271e717cf35ddafddde398ef1ea1131eeb6a22045e2fdd34ba1fd7dc32b057477a60214ce1db1ad68eaf3d9f090308dab7236e8a8
-  data.tar.gz: 5fcbbb89449438c488f1206e98a93c7cba96b945de16f2bddc259c5608225c745d7f9f2ce8ac54f57748e630bf53733dc46bf49b22ca796ed3d337dea2b16cb4
+  metadata.gz: cc488bb31f2ba6d6a6fc2dfe6b808ea88dda9627ef7f9b767273ecf00538ef72205f20683ea7f0e6b4d96173d6dcd07b3e3747d6a604d1535dd003979a39d041
+  data.tar.gz: b1683006f7daa19a790928fd58ccd03fab1567064c67240db9813776389d300b65cab261bcf03cacff38e6949661aae2a02c0d86f577176bdeaa4f9103657562

data/lib/vedeu/cursors/cursor.rb

@@ -97,7 +97,7 @@ module Vedeu
         @oy += 1
         @y = coordinate(oy, :y).y
 
-        store
+        store_and_refresh
       end
 
       # Moves the cursor left by one column.
@@ -110,7 +110,7 @@ module Vedeu
         @ox -= 1
         @x = coordinate(ox, :x).x
 
-        store
+        store_and_refresh
       end
 
       # Moves the cursor to the top left of the named interface.
@@ -138,7 +138,7 @@ module Vedeu
         @ox += 1
         @x = coordinate(ox, :x).x
 
-        store
+        store_and_refresh
       end
 
       # Moves the cursor up by one row.
@@ -151,7 +151,7 @@ module Vedeu
         @oy -= 1
         @y = coordinate(oy, :y).y
 
-        store
+        store_and_refresh
       end
 
       # Renders the cursor.
@@ -300,6 +300,17 @@ module Vedeu
         attributes.merge!(x: new_x, y: new_y, ox: new_ox, oy: new_oy)
       end
 
+      # Store the cursor and refresh the cursor.
+      #
+      # @return [void]
+      def store_and_refresh
+        store
+
+        Vedeu.trigger(:_refresh_cursor_, name)
+
+        self
+      end
+
       # Returns the escape sequence for setting the visibility of the
       # cursor.
       #
@@ -340,45 +351,29 @@ module Vedeu
 
   # See {file:docs/cursors.md}
   Vedeu.bind(:_cursor_left_) do |name|
-    cursor = Vedeu.cursors.by_name(name)
-
-    if cursor.visible?
-      cursor.move_left
-
-      Vedeu.trigger(:_refresh_cursor_, name)
+    Vedeu.cursors.by_name(name).tap do |cursor|
+      cursor.move_left if cursor.visible?
     end
   end
 
   # See {file:docs/cursors.md}
   Vedeu.bind(:_cursor_down_) do |name|
-    cursor = Vedeu.cursors.by_name(name)
-
-    if cursor.visible?
-      cursor.move_down
-
-      Vedeu.trigger(:_refresh_cursor_, name)
+    Vedeu.cursors.by_name(name).tap do |cursor|
+      cursor.move_down if cursor.visible?
     end
   end
 
   # See {file:docs/cursors.md}
   Vedeu.bind(:_cursor_up_) do |name|
-    cursor = Vedeu.cursors.by_name(name)
-
-    if cursor.visible?
-      cursor.move_up
-
-      Vedeu.trigger(:_refresh_cursor_, name)
+    Vedeu.cursors.by_name(name).tap do |cursor|
+      cursor.move_up if cursor.visible?
     end
   end
 
   # See {file:docs/cursors.md}
   Vedeu.bind(:_cursor_right_) do |name|
-    cursor = Vedeu.cursors.by_name(name)
-
-    if cursor.visible?
-      cursor.move_right
-
-      Vedeu.trigger(:_refresh_cursor_, name)
+    Vedeu.cursors.by_name(name).tap do |cursor|
+      cursor.move_right if cursor.visible?
     end
   end
 

data/lib/vedeu/geometry/all.rb

@@ -21,6 +21,7 @@ require 'vedeu/geometry/coordinate'
 require 'vedeu/geometry/dimension'
 require 'vedeu/geometry/x_dimension'
 require 'vedeu/geometry/y_dimension'
+require 'vedeu/geometry/validator'
 require 'vedeu/geometry/dsl'
 require 'vedeu/geometry/coordinate'
 require 'vedeu/geometry/geometry'

data/lib/vedeu/geometry/dsl.rb

@@ -76,6 +76,7 @@ module Vedeu
       include Vedeu::Common
       include Vedeu::DSL
       include Vedeu::DSL::Use
+      include Vedeu::Geometry::Validator
 
       # Specify the geometry of an interface or view with a simple
       # DSL.
@@ -147,22 +148,10 @@ module Vedeu
       #     is not given.
       # @return [Vedeu::Geometry::Geometry]
       def align(vertical, horizontal, width, height)
-        fail Vedeu::Error::InvalidSyntax,
-             'No vertical alignment given. Valid values are :bottom, ' \
-             ':middle, :none, :top.'.freeze unless present?(vertical)
-        fail Vedeu::Error::InvalidSyntax,
-             'No horizontal alignment given. Valid values are :center, ' \
-             ':centre, :left, :none, :right.'.freeze unless present?(horizontal)
-
-        unless vertical == :none
-          fail Vedeu::Error::InvalidSyntax,
-               'No height given.'.freeze if absent?(height)
-        end
-
-        unless horizontal == :none
-          fail Vedeu::Error::InvalidSyntax,
-               'No width given.'.freeze if absent?(width)
-        end
+        validate_vertical_alignment!(vertical)
+        validate_horizontal_alignment!(horizontal)
+        validate_height!(height) unless vertical == :none
+        validate_width!(width)   unless horizontal == :none
 
         horizontal_alignment(horizontal, width)
         vertical_alignment(vertical, height)
@@ -173,11 +162,8 @@ module Vedeu
       # @param width [Fixnum] The number of characters/columns.
       # @return [Vedeu::Geometry::Geometry]
       def horizontal_alignment(value, width)
-        fail Vedeu::Error::InvalidSyntax,
-             'No horizontal alignment given. Valid values are :center, ' \
-             ':centre, :left, :none, :right.'.freeze unless present?(value)
-        fail Vedeu::Error::InvalidSyntax,
-             'No width given.'.freeze unless present?(width)
+        validate_horizontal_alignment!(value)
+        validate_width!(width)
 
         model.horizontal_alignment = Vedeu::Geometry::HorizontalAlignment
           .coerce(value)
@@ -189,11 +175,8 @@ module Vedeu
       # @param height [Fixnum] The number of lines/rows.
       # @return [Vedeu::Geometry::Geometry]
       def vertical_alignment(value, height)
-        fail Vedeu::Error::InvalidSyntax,
-             'No vertical alignment given. Valid values are :bottom, ' \
-             ':middle, :none, :top.'.freeze unless present?(value)
-        fail Vedeu::Error::InvalidSyntax,
-             'No height given.'.freeze unless present?(height)
+        validate_vertical_alignment!(value)
+        validate_height!(height)
 
         model.vertical_alignment = Vedeu::Geometry::VerticalAlignment
           .coerce(value)

data/lib/vedeu/geometry/validator.rb

@@ -0,0 +1,56 @@
+module Vedeu
+
+  module Geometry
+
+    module Validator
+
+      include Vedeu::Common
+
+      # @param value [Fixnum] The number of lines/rows.
+      # @raise [Vedeu::Error::InvalidSyntax] When the value is nil.
+      # @return [TrueClass]
+      def validate_height!(value)
+        fail Vedeu::Error::InvalidSyntax,
+             'No height given.'.freeze if absent?(value)
+
+        true
+      end
+
+      # @param value [Symbol] One of :center, :centre, :left,
+      #   :none, :right.
+      # @raise [Vedeu::Error::InvalidSyntax] When the value is nil.
+      # @return [TrueClass]
+      def validate_horizontal_alignment!(value)
+        fail Vedeu::Error::InvalidSyntax,
+             'No horizontal alignment given. Valid values are :center, ' \
+             ':centre, :left, :none, :right.'.freeze unless present?(value)
+
+        true
+      end
+
+      # @param vertical [Symbol] One of :bottom, :middle, :none, :top.
+      # @raise [Vedeu::Error::InvalidSyntax] When the value is nil.
+      # @return [TrueClass]
+      def validate_vertical_alignment!(value)
+        fail Vedeu::Error::InvalidSyntax,
+             'No vertical alignment given. Valid values are :bottom, ' \
+             ':middle, :none, :top.'.freeze unless present?(value)
+
+        true
+      end
+
+      # @param value [Fixnum] The number of characters/columns.
+      # @raise [Vedeu::Error::InvalidSyntax] When the value is nil.
+      # @return [TrueClass]
+      def validate_width!(value)
+        fail Vedeu::Error::InvalidSyntax,
+             'No width given.'.freeze if absent?(value)
+
+        true
+      end
+
+    end # Validator
+
+  end # Geometry
+
+end # Vedeu

data/lib/vedeu/output/renderers/file.rb

@@ -22,19 +22,8 @@ module Vedeu
         @options = options || {}
       end
 
-      # Render a cleared output.
+      # Render the output (either content or clearing) to a file.
       #
-      # @param output [Vedeu::Models::Page]
-      # @param opts [Hash]
-      # @return [String]
-      def clear(output = '', opts = {})
-        @options = options.merge!(opts)
-
-        ::File.write(filename, out(output)) if write_file?
-
-        out(output)
-      end
-
       # @param output [Vedeu::Models::Page]
       # @param opts [Hash]
       # @return [String]
@@ -45,6 +34,7 @@ module Vedeu
 
         out(output)
       end
+      alias_method :clear, :render
 
       private
 
@@ -62,11 +52,18 @@ module Vedeu
         end
       end
 
+      # Return the filename given in the options, (or use the
+      # default), and append a timestamp if the :timestamp option was
+      # set to true.
+      #
       # @return [String]
       def filename
         options[:filename] + timestamp
       end
 
+      # Return a timestamp for use as part of the filename if the
+      # :timestamp option was set to true, otherwise an empty string.
+      #
       # @return [Float]
       def timestamp
         if options[:timestamp]
@@ -78,6 +75,8 @@ module Vedeu
         end
       end
 
+      # Returns a boolean indicating whether a file should be written.
+      #
       # @return [Boolean]
       def write_file?
         options[:write_file]

data/lib/vedeu/version.rb

@@ -1,6 +1,6 @@
 module Vedeu
 
   # The current version of Vedeu.
-  VERSION = '0.6.44'.freeze
+  VERSION = '0.6.45'.freeze
 
 end

data/test/lib/vedeu/cursors/cursor_test.rb

@@ -129,6 +129,8 @@ module Vedeu
         let(:ox) { 3 }
         let(:oy) { 2 }
 
+        before { Vedeu.stubs(:trigger).with(:_refresh_cursor_, _name) }
+
         subject { instance.move_down }
 
         it { subject.must_be_instance_of(described) }
@@ -145,6 +147,8 @@ module Vedeu
         let(:ox) { 3 }
         let(:oy) { 2 }
 
+        before { Vedeu.stubs(:trigger).with(:_refresh_cursor_, _name) }
+
         subject { instance.move_left }
 
         it { subject.must_be_instance_of(described) }
@@ -177,6 +181,8 @@ module Vedeu
         let(:ox) { 3 }
         let(:oy) { 2 }
 
+        before { Vedeu.stubs(:trigger).with(:_refresh_cursor_, _name) }
+
         subject { instance.move_right }
 
         it { subject.must_be_instance_of(described) }
@@ -193,6 +199,8 @@ module Vedeu
         let(:ox) { 3 }
         let(:oy) { 2 }
 
+        before { Vedeu.stubs(:trigger).with(:_refresh_cursor_, _name) }
+
         subject { instance.move_up }
 
         it { subject.must_be_instance_of(described) }

data/test/lib/vedeu/geometry/validator_test.rb

@@ -0,0 +1,83 @@
+require 'test_helper'
+
+module Vedeu
+
+  module Geometry
+
+    class ValidatorTestClass
+      include Vedeu::Geometry::Validator
+    end
+
+    describe Validator do
+
+      let(:included) { Vedeu::Geometry::ValidatorTestClass.new }
+
+      describe '#validate_height!' do
+        let(:_value) {}
+
+        subject { included.validate_height!(_value) }
+
+        context 'when the value is given' do
+          let(:_value) { 11 }
+
+          it { subject.must_equal(true) }
+        end
+
+        context 'when the value is not given' do
+          it { proc { subject }.must_raise(Vedeu::Error::InvalidSyntax) }
+        end
+      end
+
+      describe '#validate_horizontal_alignment!' do
+        let(:_value) {}
+
+        subject { included.validate_horizontal_alignment!(_value) }
+
+        context 'when the value is given' do
+          let(:_value) { :left }
+
+          it { subject.must_equal(true) }
+        end
+
+        context 'when the value is not given' do
+          it { proc { subject }.must_raise(Vedeu::Error::InvalidSyntax) }
+        end
+      end
+
+      describe '#validate_vertical_alignment!' do
+        let(:_value) {}
+
+        subject { included.validate_vertical_alignment!(_value) }
+
+        context 'when the value is given' do
+          let(:_value) { :top }
+
+          it { subject.must_equal(true) }
+        end
+
+        context 'when the value is not given' do
+          it { proc { subject }.must_raise(Vedeu::Error::InvalidSyntax) }
+        end
+      end
+
+      describe '#validate_width!' do
+        let(:_value) {}
+
+        subject { included.validate_width!(_value) }
+
+        context 'when the value is given' do
+          let(:_value) { 11 }
+
+          it { subject.must_equal(true) }
+        end
+
+        context 'when the value is not given' do
+          it { proc { subject }.must_raise(Vedeu::Error::InvalidSyntax) }
+        end
+      end
+
+    end # Validator
+
+  end # Geometry
+
+end # Vedeu

data/test/lib/vedeu/output/renderers/file_test.rb

@@ -27,18 +27,13 @@ module Vedeu
         it { instance.instance_variable_get('@options').must_equal(options) }
       end
 
-      describe '#clear' do
-        subject { instance.clear }
-
-        it { subject.must_be_instance_of(String) }
-        it { subject.must_equal('') }
-      end
-
       describe '#render' do
         let(:_time) { Time.new(2015, 4, 12, 20, 05, 00, "+01:00") }
 
         subject { instance.render(output) }
 
+        it { instance.must_respond_to(:clear) }
+
         # it { subject.must_be_instance_of(String) }
 
         context 'when the filename option is not set' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vedeu
 version: !ruby/object:Gem::Version
-  version: 0.6.44
+  version: 0.6.45
 platform: ruby
 authors:
 - Gavin Laking
@@ -413,6 +413,7 @@ files:
 - lib/vedeu/geometry/null.rb
 - lib/vedeu/geometry/position.rb
 - lib/vedeu/geometry/repository.rb
+- lib/vedeu/geometry/validator.rb
 - lib/vedeu/geometry/vertical_alignment.rb
 - lib/vedeu/geometry/x_dimension.rb
 - lib/vedeu/geometry/y_dimension.rb
@@ -586,6 +587,7 @@ files:
 - test/lib/vedeu/geometry/null_test.rb
 - test/lib/vedeu/geometry/position_test.rb
 - test/lib/vedeu/geometry/repository_test.rb
+- test/lib/vedeu/geometry/validator_test.rb
 - test/lib/vedeu/geometry/vertical_alignment_test.rb
 - test/lib/vedeu/geometry/x_dimension_test.rb
 - test/lib/vedeu/geometry/y_dimension_test.rb
@@ -787,6 +789,7 @@ test_files:
 - test/lib/vedeu/geometry/null_test.rb
 - test/lib/vedeu/geometry/position_test.rb
 - test/lib/vedeu/geometry/repository_test.rb
+- test/lib/vedeu/geometry/validator_test.rb
 - test/lib/vedeu/geometry/vertical_alignment_test.rb
 - test/lib/vedeu/geometry/x_dimension_test.rb
 - test/lib/vedeu/geometry/y_dimension_test.rb