vedeu 0.8.4 → 0.8.5

data/lib/vedeu/geometries/all.rb

@@ -21,5 +21,4 @@ require 'vedeu/geometries/dsl/all'
 require 'vedeu/geometries/geometry'
 require 'vedeu/geometries/move'
 require 'vedeu/geometries/position'
-require 'vedeu/geometries/positionable'
 require 'vedeu/geometries/repository'

data/lib/vedeu/geometries/area/area.rb

@@ -70,14 +70,14 @@ module Vedeu
           d_dn:      attributes[:width],
           maximised: attributes[:maximised],
         }
-        height = Vedeu::Geometries::YDimension.pair(y_attributes)
-        width  = Vedeu::Geometries::XDimension.pair(x_attributes)
+        dy, dyn = Vedeu::Geometries::YDimension.pair(y_attributes)
+        dx, dxn = Vedeu::Geometries::XDimension.pair(x_attributes)
 
         new(name: attributes[:name],
-            y:    height[0],
-            yn:   height[-1],
-            x:    width[0],
-            xn:   width[-1])
+            y:    dy,
+            yn:   dyn,
+            x:    dx,
+            xn:   dxn)
       end
 
       # Returns a new instance of Vedeu::Area.
@@ -205,9 +205,6 @@ module Vedeu
       # @return [Fixnum]
       def height
         (yn - y) + 1
-
-        # (yn - y) + 2
-        # (y..yn).size# + 1
       end
 
       # Returns the width of the interface.
@@ -215,9 +212,6 @@ module Vedeu
       # @return [Fixnum]
       def width
         (xn - x) + 1
-
-        # (xn - x) + 2
-        # (x..xn).size# + 1
       end
 
       # Returns the row above the top by default.

data/lib/vedeu/geometries/area/dimension.rb

@@ -46,11 +46,30 @@ module Vedeu
         end
       end
 
-      # Fetch the coordinates.
+      # Return the coordinate pair.
+      #
+      # 1) If maximised, it will be from the first row/line or column/
+      #    character to the last row/line or column/character of the
+      #    terminal.
       #
       # @return [Array<Fixnum>]
       def pair
-        dimension
+        if maximised?
+          [1, default]
+
+        elsif bottom_aligned? || right_aligned?
+          [start_coordinate, default]
+
+        elsif centre_aligned? || middle_aligned?
+          [centred_d, centred_dn]
+
+        elsif left_aligned? || top_aligned?
+          [1, end_coordinate]
+
+        else
+          [_d, _dn]
+
+        end
       end
 
       protected
@@ -83,43 +102,6 @@ module Vedeu
         @_alignment ||= Vedeu::Coercers::Alignment.coerce(@alignment)
       end
 
-      # Return the dimension.
-      #
-      # 1) If maximised, it will be from the first row/line or column/
-      #    character to the last row/line or column/character of the
-      #    terminal.
-      # 2) If centred,
-      #
-      # @return [Array<Fixnum>]
-      def dimension
-        @dimension = if maximised?
-                       [1, default]
-
-                     elsif bottom_aligned? || right_aligned?
-                       [start_coordinate, default]
-
-                     elsif centre_aligned? || middle_aligned?
-                       [centred_d, centred_dn]
-
-                     elsif left_aligned? || top_aligned?
-                       [1, end_coordinate]
-
-                     else
-                       [_d, _dn]
-
-                     end
-      end
-
-      # Return a boolean indicating we know the length if a we know
-      # either the terminal width or height, or we can determine a
-      # length from the values provided.
-      #
-      # @return [Boolean]
-      # @todo Investigate: should this be && or ||. (GL: 2015-10-16)
-      def length?
-        default && length
-      end
-
       # Provide the number of rows/lines or columns/characters.
       #
       # 1) Use the starting (x or y) and ending (xn or yn) values.
@@ -227,23 +209,18 @@ module Vedeu
       # @return [Fixnum]
       def _dn
         if dn
-          # fail "_dn 1 v:#{d} #{dn}"
           dn
 
         elsif d.nil? && d_dn
-          # fail "_dn 2 v:#{d_dn}"
           d_dn
 
         elsif d && d_dn
-          # fail "_dn 3 v:#{d} #{d_dn}"
           (d + d_dn) - 1
 
         elsif default
-          # fail "_dn 4 v:#{default}"
           default
 
         else
-          # fail "_dn 5 v:1"
           1
 
         end

data/lib/vedeu/geometries/dsl/all.rb

@@ -9,5 +9,4 @@ module Vedeu
 end # Vedeu
 
 require 'vedeu/geometries/dsl/grid'
-require 'vedeu/geometries/dsl/validator'
 require 'vedeu/geometries/dsl/dsl'

data/lib/vedeu/geometries/dsl/dsl.rb

@@ -75,10 +75,10 @@ module Vedeu
     #
     class DSL
 
+      include Vedeu::Common
       include Vedeu::DSL
       include Vedeu::DSL::Geometry
       include Vedeu::DSL::Use
-      include Vedeu::Geometries::Validator
 
       # Align the interface/view horizontally or vertically within
       # the terminal.
@@ -100,12 +100,7 @@ module Vedeu
       #   - When the vertical is given (and not :none) and the height
       #     is not given.
       # @return [Vedeu::Geometries::Geometry]
-      def align(vertical, horizontal, width, height)
-        validate_vertical_alignment!(vertical)
-        validate_horizontal_alignment!(horizontal)
-        validate_height!(height) unless vertical == :none
-        validate_width!(width)   unless horizontal == :none
-
+      def align(vertical: :none, horizontal: :none, width: nil, height: nil)
         horizontal_alignment(horizontal, width)
         vertical_alignment(vertical, height)
       end
@@ -114,26 +109,22 @@ module Vedeu
       #   :right.
       # @param width [Fixnum] The number of characters/columns.
       # @return [Vedeu::Geometries::Geometry]
-      def horizontal_alignment(value, width)
-        validate_horizontal_alignment!(value)
-        validate_width!(width)
+      def horizontal_alignment(value = :none, width = nil)
+        alignment = Vedeu::Coercers::HorizontalAlignment.validate(value)
 
-        model.horizontal_alignment = Vedeu::Coercers::HorizontalAlignment
-          .coerce(value)
-        model.width = width
+        model.width = width if width
+        model.horizontal_alignment = alignment
         model
       end
 
       # @param value [Symbol] One of :bottom, :middle, :none, :top.
       # @param height [Fixnum] The number of lines/rows.
       # @return [Vedeu::Geometries::Geometry]
-      def vertical_alignment(value, height)
-        validate_vertical_alignment!(value)
-        validate_height!(height)
+      def vertical_alignment(value = :none, height = nil)
+        alignment = Vedeu::Coercers::VerticalAlignment.validate(value)
 
-        model.vertical_alignment = Vedeu::Coercers::VerticalAlignment
-          .coerce(value)
-        model.height = height
+        model.height = height if height
+        model.vertical_alignment = alignment
         model
       end
 
@@ -148,7 +139,7 @@ module Vedeu
       #     # vertical_alignment(:bottom, 30)
       #
       #     # or you can use: (see notes)
-      #     # align(:bottom, :none, Vedeu.width, 30)
+      #     # align(vertical: :bottom, height: 30)
       #
       #     # ... some code
       #   end
@@ -161,7 +152,7 @@ module Vedeu
       # @raise [Vedeu::Error::InvalidSyntax] When the height is not
       #   given.
       # @return [Vedeu::Geometries::Geometry]
-      def align_bottom(height)
+      def align_bottom(height = nil)
         vertical_alignment(:bottom, height)
       end
 
@@ -175,7 +166,7 @@ module Vedeu
       #     # horizontal_alignment(:centre, 30)
       #
       #     # or you can use: (see notes)
-      #     # align(:none, :centre, 30, Vedeu.height)
+      #     # align(horizontal: :centre, width: 30)
       #
       #     # ... some code
       #   end
@@ -190,7 +181,7 @@ module Vedeu
       # @raise [Vedeu::Error::InvalidSyntax] When the width is not
       #   given.
       # @return [Vedeu::Geometries::Geometry]
-      def align_centre(width)
+      def align_centre(width = nil)
         horizontal_alignment(:centre, width)
       end
       alias_method :align_center, :align_centre
@@ -205,7 +196,7 @@ module Vedeu
       #     # horizontal_alignment(:left, 30)
       #
       #     # or you can use: (see notes)
-      #     # align(:none, :left, 30, Vedeu.height)
+      #     # align(horizontal: :left, width: 30)
       #
       #     # ... some code
       #   end
@@ -218,7 +209,7 @@ module Vedeu
       # @raise [Vedeu::Error::InvalidSyntax] When the width is not
       #   given.
       # @return [Vedeu::Geometries::Geometry]
-      def align_left(width)
+      def align_left(width = nil)
         horizontal_alignment(:left, width)
       end
 
@@ -233,7 +224,7 @@ module Vedeu
       #     # vertical_alignment(:middle, 30)
       #
       #     # or you can use: (see notes)
-      #     # align(:middle, :none, Vedeu.width, 30)
+      #     # align(vertical: :middle, height: 30)
       #
       #     # ... some code
       #   end
@@ -246,7 +237,7 @@ module Vedeu
       # @raise [Vedeu::Error::InvalidSyntax] When the height is not
       #   given.
       # @return [Vedeu::Geometries::Geometry]
-      def align_middle(height)
+      def align_middle(height = nil)
         vertical_alignment(:middle, height)
       end
 
@@ -260,7 +251,7 @@ module Vedeu
       #     # horizontal_alignment(:right, 30)
       #
       #     # or you can use: (see notes)
-      #     # align(:none, :right, 30, Vedeu.height)
+      #     # align(horizontal: :right, width: 30)
       #
       #     # ... some code
       #   end
@@ -273,7 +264,7 @@ module Vedeu
       # @raise [Vedeu::Error::InvalidSyntax] When the width is not
       #   given.
       # @return [Vedeu::Geometries::Geometry]
-      def align_right(width)
+      def align_right(width = nil)
         horizontal_alignment(:right, width)
       end
 
@@ -288,7 +279,7 @@ module Vedeu
       #     # vertical_alignment(:top, 30)
       #
       #     # or you can use: (see notes)
-      #     # align(:top, :none, Vedeu.width, 30)
+      #     # align(vertical: :top, height: 30)
       #
       #     # ... some code
       #   end
@@ -301,7 +292,7 @@ module Vedeu
       # @raise [Vedeu::Error::InvalidSyntax] When the height is not
       #   given.
       # @return [Vedeu::Geometries::Geometry]
-      def align_top(height)
+      def align_top(height = nil)
         vertical_alignment(:top, height)
       end
 

data/lib/vedeu/geometries/geometry.rb

@@ -189,6 +189,12 @@ module Vedeu
 
       private
 
+      # @todo Investigate the differences between memoizing this and
+      #   not memoizing. Memoizing saves ~80ms on running test suite
+      #   and considerably impacts app responsiveness, however changes
+      #   to the geometry (such as movement or maximising) are not
+      #   reflected. (GL: 2016-01-11)
+      #
       # @return [Vedeu::Geometries::Area]
       def area
         Vedeu::Geometries::Area.from_attributes(area_attributes)

data/lib/vedeu/geometries/position.rb

@@ -44,6 +44,9 @@ module Vedeu
         elsif value.is_a?(Hash)
           new(value.fetch(:y, 1), value.fetch(:x, 1))
 
+        elsif value.is_a?(NilClass)
+          nil
+
         end
       end
 
@@ -53,8 +56,8 @@ module Vedeu
       # @param x [Fixnum] The column/character position.
       # @return [Vedeu::Geometries::Position]
       def initialize(y = 1, x = 1)
-        @y = (y.nil? || y < 1) ? 1 : y
-        @x = (x.nil? || x < 1) ? 1 : x
+        @y = Vedeu::Point.coerce(value: y, max: Vedeu.height).value
+        @x = Vedeu::Point.coerce(value: x, max: Vedeu.width).value
 
         freeze
       end
@@ -87,7 +90,7 @@ module Vedeu
       # @param other [Vedeu::Geometries::Position]
       # @return [Boolean]
       def eql?(other)
-        self.class == other.class && (x == other.x && y == other.y)
+        self.class == other.class && x == other.x && y == other.y
       end
       alias_method :==, :eql?
 

data/lib/vedeu/geometries/repository.rb

@@ -11,7 +11,7 @@ module Vedeu
 
       singleton_class.send(:alias_method, :geometries, :repository)
 
-      null Vedeu::Geometries::Geometry, height: Vedeu.height, width: Vedeu.width
+      null Vedeu::Geometries::Geometry
       real Vedeu::Geometries::Geometry
 
     end # Repository

data/lib/vedeu/input/mouse.rb

@@ -48,6 +48,7 @@ module Vedeu
                     message: 'Vedeu does not support mouse button ' \
                              "'#{button}' yet.")
 
+          false
         end
       end
 

data/lib/vedeu/logging/log.rb

@@ -26,14 +26,11 @@ module Vedeu
         #
         # @return [String]
         def log(message:, force: false, type: :info)
-          output = log_entry(type, message)
-
-          if (Vedeu.config.log? || force) &&
-             Vedeu.config.loggable?(type)
+          if (Vedeu.config.log? || force) && Vedeu.config.loggable?(type)
+            output = log_entry(type, message)
             logger.debug(output)
+            output
           end
-
-          output
         end
 
         # Write a message to STDOUT.

data/lib/vedeu/menus/dsl.rb

@@ -20,8 +20,7 @@ module Vedeu
         # @param name [String|Symbol] The name of the interface or
         #   view to which this menu belongs.
         # @param block [Proc] A set of attributes which define the
-        #   features of the menu. See {Vedeu::Menus::DSL#items} and
-        #   {Vedeu::Menus::DSL#name}.
+        #   features of the menu.
         #
         # @example
         #   Vedeu.menu :my_interface do
@@ -35,9 +34,9 @@ module Vedeu
         #     # ...
         #   end
         #
-        # @raise [Vedeu::Error::MissingRequired|
-        #   Vedeu::Error::RequiresBlock] When a name or block
-        #   respectively are not given.
+        # @macro raise_requires_block
+        # @raise [Vedeu::Error::MissingRequired] When a name is not
+        #   given.
         # @return [API::Menu]
         def menu(name, &block)
           fail Vedeu::Error::MissingRequired unless name

data/lib/vedeu/output/compressor.rb

@@ -84,15 +84,25 @@ module Vedeu
       def compress
         message = "Compression for #{content.size} objects"
 
+        @same = ''
         @compress ||= Vedeu.timer(message) do
           out = content.map do |cell|
-            [
+            rendered = [
               # position_for(cell),
               cell.position.to_s,
               colour_for(cell),
               style_for(cell),
               cell.value,
             ].join
+
+            if @same == rendered
+              next
+
+            else
+              @same = rendered
+              @same
+
+            end
           end.join
 
           Vedeu.log(type:    :compress,