vedeu 0.6.35 → 0.6.36

data/lib/vedeu/geometry/geometry.rb

@@ -31,9 +31,13 @@ module Vedeu
                      :height,
                      :width
 
-      # @!attribute [rw] alignment
+      # @!attribute [rw] horizontal_alignment
       # @return [Symbol]
-      attr_accessor :alignment
+      attr_accessor :horizontal_alignment
+
+      # @!attribute [rw] vertical_alignment
+      # @return [Symbol]
+      attr_accessor :vertical_alignment
 
       # @!attribute [rw] centred
       # @return [Boolean]
@@ -85,6 +89,8 @@ module Vedeu
       # Returns a new instance of Vedeu::Geometry::Geometry.
       #
       # @param attributes [Hash]
+      # @option attributes horizontal_alignment [Symbol]
+      # @option attributes vertical_alignment [Symbol]
       # @option attributes centred [Boolean]
       # @option attributes maximised [Boolean]
       # @option attributes height [Fixnum]
@@ -105,18 +111,19 @@ module Vedeu
       # @return [Hash]
       def attributes
         {
-          alignment:  @alignment,
-          client:     @client,
-          centred:    @centred,
-          height:     height,
-          maximised:  @maximised,
-          name:       @name,
-          repository: @repository,
-          width:      width,
-          x:          x,
-          xn:         xn,
-          y:          y,
-          yn:         yn,
+          client:               @client,
+          centred:              @centred,
+          height:               height,
+          horizontal_alignment: @horizontal_alignment,
+          maximised:            @maximised,
+          name:                 @name,
+          repository:           @repository,
+          vertical_alignment:   @vertical_alignment,
+          width:                width,
+          x:                    x,
+          xn:                   xn,
+          y:                    y,
+          yn:                   yn,
         }
       end
 
@@ -227,15 +234,16 @@ module Vedeu
       # @return [Hash<Symbol => Boolean, Fixnum>]
       def area_attributes
         {
-          alignment: @alignment,
-          centred:   @centred,
-          maximised: @maximised,
-          x:         @x.is_a?(Proc)      ? @x.call      : @x,
-          xn:        @xn.is_a?(Proc)     ? @xn.call     : @xn,
-          x_xn:      @width.is_a?(Proc)  ? @width.call  : @width,
-          y:         @y.is_a?(Proc)      ? @y.call      : @y,
-          yn:        @yn.is_a?(Proc)     ? @yn.call     : @yn,
-          y_yn:      @height.is_a?(Proc) ? @height.call : @height,
+          centred:              @centred,
+          horizontal_alignment: @horizontal_alignment,
+          maximised:            @maximised,
+          vertical_alignment:   @vertical_alignment,
+          x:                    @x.is_a?(Proc)      ? @x.call      : @x,
+          xn:                   @xn.is_a?(Proc)     ? @xn.call     : @xn,
+          x_xn:                 @width.is_a?(Proc)  ? @width.call  : @width,
+          y:                    @y.is_a?(Proc)      ? @y.call      : @y,
+          yn:                   @yn.is_a?(Proc)     ? @yn.call     : @yn,
+          y_yn:                 @height.is_a?(Proc) ? @height.call : @height,
         }
       end
 
@@ -257,9 +265,10 @@ module Vedeu
       # @option coordinates yn [Fixnum] The ending row/line position.
       # @return [Hash<Symbol => Boolean, Fixnum>]
       def move(coordinates = {})
-        attrs = attributes.merge!(alignment: :none,
-                                  centred:   false,
-                                  maximised: false)
+        attrs = attributes.merge!(centred:              false,
+                                  horizontal_alignment: :none,
+                                  maximised:            false,
+                                  vertical_alignment:   :none)
                 .merge!(coordinates)
 
         Vedeu::Geometry::Geometry.store(attrs)
@@ -270,21 +279,32 @@ module Vedeu
       # @return [Hash]
       def defaults
         {
-          alignment:  Vedeu::Geometry::Alignment.align(:none),
-          client:     nil,
-          centred:    false,
-          height:     nil,
-          maximised:  false,
-          name:       nil,
-          repository: Vedeu.geometries,
-          width:      nil,
-          x:          nil,
-          xn:         nil,
-          y:          nil,
-          yn:         nil,
+          client:               nil,
+          centred:              false,
+          height:               nil,
+          horizontal_alignment: default_horizontal_alignment,
+          maximised:            false,
+          name:                 nil,
+          repository:           Vedeu.geometries,
+          vertical_alignment:   default_vertical_alignment,
+          width:                nil,
+          x:                    nil,
+          xn:                   nil,
+          y:                    nil,
+          yn:                   nil,
         }
       end
 
+      # @return [Symbol]
+      def default_horizontal_alignment
+        Vedeu::Geometry::HorizontalAlignment.align(:none)
+      end
+
+      # @return [Symbol]
+      def default_vertical_alignment
+        Vedeu::Geometry::VerticalAlignment.align(:none)
+      end
+
     end # Geometry
 
   end # Geometry

data/lib/vedeu/geometry/horizontal_alignment.rb

@@ -0,0 +1,25 @@
+module Vedeu
+
+  module Geometry
+
+    # Provides the mechanism to align an interface/view horizontally
+    # within the available terminal space.
+    #
+    class HorizontalAlignment < Vedeu::Geometry::Alignment
+
+      # @raise [Vedeu::Error::InvalidSyntax] When the value is not one
+      #   of :bottom, :centre, :left, :middle, :right, :top.
+      # @return [Symbol]
+      def align
+        return value if valid?
+
+        fail Vedeu::Error::InvalidSyntax,
+             'No horizontal alignment value given. Valid values are :center, ' \
+             ':centre, :left, :none, :right.'.freeze
+      end
+
+    end # HorizontalAlignment
+
+  end # Geometry
+
+end # Vedeu

data/lib/vedeu/geometry/vertical_alignment.rb

@@ -0,0 +1,25 @@
+module Vedeu
+
+  module Geometry
+
+    # Provides the mechanism to align an interface/view vertically
+    # within the available terminal space.
+    #
+    class VerticalAlignment < Vedeu::Geometry::Alignment
+
+      # @raise [Vedeu::Error::InvalidSyntax] When the value is not one
+      #   of :bottom, :centre, :left, :middle, :right, :top.
+      # @return [Symbol]
+      def align
+        return value if valid?
+
+        fail Vedeu::Error::InvalidSyntax,
+             'No vertical alignment value given. Valid values are :bottom, ' \
+             ':middle, :none, :top.'.freeze
+      end
+
+    end # VerticalAlignment
+
+  end # Geometry
+
+end # Vedeu

data/lib/vedeu/geometry/x_dimension.rb

@@ -0,0 +1,33 @@
+module Vedeu
+
+  module Geometry
+
+    # The X Dimension provides the width of an entity.
+    #
+    class XDimension < Vedeu::Geometry::Dimension
+
+      private
+
+      # @return [Symbol]
+      def alignment
+        horizontal_alignment
+      end
+
+      # @return [Hash<Symbol => NilClass,Boolean,Symbol>]
+      def defaults
+        super.merge!(
+          default:              Vedeu.width,
+          horizontal_alignment: default_alignment,
+        )
+      end
+
+      # @return [Symbol]
+      def default_alignment
+        Vedeu::Geometry::HorizontalAlignment.align(:none)
+      end
+
+    end # XDimension
+
+  end # Geometry
+
+end # Vedeu

data/lib/vedeu/geometry/y_dimension.rb

@@ -0,0 +1,33 @@
+module Vedeu
+
+  module Geometry
+
+    # The Y Dimension provides the height of an entity.
+    #
+    class YDimension < Vedeu::Geometry::Dimension
+
+      private
+
+      # @return [Symbol]
+      def alignment
+        vertical_alignment
+      end
+
+      # @return [Hash<Symbol => NilClass,Boolean,Symbol>]
+      def defaults
+        super.merge!(
+          default:            Vedeu.height,
+          vertical_alignment: default_alignment,
+        )
+      end
+
+      # @return [Symbol]
+      def default_alignment
+        Vedeu::Geometry::VerticalAlignment.align(:none)
+      end
+
+    end # YDimension
+
+  end # Geometry
+
+end # Vedeu

data/lib/vedeu/output/compressor.rb

@@ -13,18 +13,21 @@ module Vedeu
 
       # @param (see #initialize)
       # @return [String]
-      def self.render(output)
-        new(output).render
+      def self.render(output, options = {})
+        new(output, options).render
       end
 
       # Returns a new instance of Vedeu::Output::Compressor.
       #
       # @param output [Array<Array<Vedeu::Views::Char>>]
+      # @param options [Hash]
+      # @option options compression [Boolean]
       # @return [Vedeu::Output::Compressor]
-      def initialize(output)
-        @output = output
-        @colour = ''
-        @style  = ''
+      def initialize(output, options = {})
+        @output  = output
+        @options = options
+        @colour  = ''
+        @style   = ''
       end
 
       # @note

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

@@ -24,31 +24,54 @@ module Vedeu
 
       # Render a cleared output.
       #
+      # @param output [Vedeu::Models::Page]
+      # @param opts [Hash]
       # @return [String]
-      def clear(output = '')
-        ::File.write(filename, output) if write_file?
+      def clear(output = '', opts = {})
+        @options = options.merge!(opts)
+
+        ::File.write(filename, out(output)) if write_file?
 
-        output
+        out(output)
       end
 
       # @param output [Vedeu::Models::Page]
+      # @param opts [Hash]
       # @return [String]
-      def render(output)
-        ::File.write(filename, output) if write_file?
+      def render(output = '', opts = {})
+        @options = options.merge!(opts)
+
+        ::File.write(filename, out(output)) if write_file?
 
-        output
+        out(output)
       end
 
       private
 
+      def out(output)
+        if compress?
+          Vedeu::Output::Compressor.render(output, options)
+
+        else
+          output
+
+        end
+      end
+
       # @return [String]
       def filename
-        options[:filename] + "_#{timestamp}".freeze
+        options[:filename] + timestamp
       end
 
       # @return [Float]
       def timestamp
-        Time.now.to_f if options[:timestamp]
+        if options[:timestamp]
+          "_#{Time.now.to_f}".freeze
+
+        else
+          ''.freeze
+
+        end
       end
 
       # @return [Boolean]
@@ -61,9 +84,10 @@ module Vedeu
       # @return [Hash]
       def defaults
         {
-          filename:   'out',
-          timestamp:  false,
-          write_file: true,
+          compression: Vedeu::Configuration.compression?,
+          filename:    'out',
+          timestamp:   false,
+          write_file:  true,
         }
       end
 

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

@@ -20,7 +20,7 @@ module Vedeu
       def clear
         json = parse({})
 
-        super(json)
+        super(json, { compression: false })
 
         json
       end
@@ -30,7 +30,7 @@ module Vedeu
       def render(output)
         json = parse(output)
 
-        super(json)
+        super(json, { compression: false })
 
         json
       end

data/lib/vedeu/version.rb

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

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

@@ -18,79 +18,13 @@ module Vedeu
       describe '.align' do
         subject { described.align(_value) }
 
-        context 'when the value is nil' do
-          it { subject.must_equal(:none) }
-        end
-
-        context 'when the value is not a Symbol' do
-          let(:_value) { 'invalid' }
-
-          it { subject.must_equal(:none) }
-        end
-
-        context 'when the value is :center' do
-          let(:_value) { :center }
-
-          it { subject.must_equal(:centre) }
-        end
-
-        context 'when the value is :centre' do
-          let(:_value) { :centre }
-
-          it { subject.must_equal(:centre) }
-        end
-
-        context 'when the value is :left' do
-          let(:_value) { :left }
-
-          it { subject.must_equal(:left) }
-        end
-
-        context 'when the value is :right' do
-          let(:_value) { :right }
-
-          it { subject.must_equal(:right) }
-        end
-
-        context 'when the value is :alignment' do
-          let(:_value) { :alignment }
-
-          it { subject.must_equal(:none) }
-        end
-
-        context 'when the value is :align_center' do
-          let(:_value) { :align_center }
-
-          it { subject.must_equal(:centre) }
-        end
-
-        context 'when the value is :align_centre' do
-          let(:_value) { :align_centre }
-
-          it { subject.must_equal(:centre) }
-        end
-
-        context 'when the value is :align_left' do
-          let(:_value) { :align_left }
-
-          it { subject.must_equal(:left) }
-        end
-
-        context 'when the value is :align_right' do
-          let(:_value) { :align_right }
-
-          it { subject.must_equal(:right) }
-        end
-
-        context 'when the value is :align_invalid' do
-          let(:_value) { :align_invalid }
-
-          it { proc { subject }.must_raise(Vedeu::Error::InvalidSyntax) }
-        end
+        it { proc { subject }.must_raise(Vedeu::Error::NotImplemented) }
       end
 
       describe '#align' do
-        it { instance.must_respond_to(:align) }
+        subject { instance.align }
+
+        it { proc { subject }.must_raise(Vedeu::Error::NotImplemented) }
       end
 
     end # Alignment