vedeu 0.6.34 → 0.6.35

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 12cdb96715e44a6ed789be72c594f11a2fca50c4
-  data.tar.gz: 5fb1b73c0e64a16bfaa3c227169fec1ad8d69475
+  metadata.gz: 19a9f0cb2cd4e5abc3c7df887e379390215d4a98
+  data.tar.gz: 42cd6518e55b29886c270ba7f41c7938087faf7a
 SHA512:
-  metadata.gz: dcce80eac99efd8c58394bf7bc595ce26ec4534288357894afbbbb7ac7abe76dd4b4f1f80f5500b6208dbfe0be58882ad7c455a4e6f669d937a0b866ab2958df
-  data.tar.gz: e55fbfa42ce9f608f0f28dffa9584f763a5f6ae8126e03de8c841fde5377612d67d7437a33b5962c63119a14eccce43b1cf4e0933982b65e1751ba7372080638
+  metadata.gz: 4aab96b5aca113d6e65b34c58d35a9cd7a277c81e1c12ad80a0cc5734df760e1e8737677464eeb8758d9b110eea806c34f22dc6205f39db0d9aa03ff6a6a3041
+  data.tar.gz: 56be459ebb0bbac1184447c6badc767624743dd7b224b5b86bf5480e41aef4dbae2fa6ad56b50f42987855c6f7e7066c852815c2f37800d8978d878fd2b28d8b

data/docs/api.md

@@ -67,6 +67,11 @@ See {file:docs/events.md}
   - focus!
   - foreground
   - geometry
+    - alignment
+    - align_left
+    - align_center
+    - align_centre
+    - align_right
     - centred (or centred!)
     - height
     - width

data/docs/dsl.md

@@ -109,6 +109,10 @@ end
 
 ### Setting the interface dimensions
 
+{include:Vedeu::Geometry::DSL#alignment}
+{include:Vedeu::Geometry::DSL#align_left}
+{include:Vedeu::Geometry::DSL#align_centre}
+{include:Vedeu::Geometry::DSL#align_right}
 {include:Vedeu::Geometry::DSL#centred}
 {include:Vedeu::Geometry::DSL#height}
 {include:Vedeu::Geometry::DSL#width}

data/docs/geometry.md

@@ -24,5 +24,8 @@ of the terminal.
 - Geometry can be maximised- to use all the available terminal space.
 - It can also be unmaximised- to return to the pre-defined dimensions
   as mentioned above.
+- Geometry can be aligned; either left, centre or right. When defined
+  in this way, the 'x', 'xn', 'y' and 'yn' parameters will be
+  calculated automatically.
 - Geometry like a {file:docs/cursors.md Cursor}, via events can be
   moved; left, right, up or down.

data/examples/alignment.rb

@@ -0,0 +1,183 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'vedeu'
+
+class AlignmentApp
+
+  def self.geometry_stats(name)
+    Vedeu.geometries.by_name(name)
+  end
+  def self.gl
+    geometry_stats(:left_interface)
+  end
+  def self.gc
+    geometry_stats(:centre_interface)
+  end
+  def self.gr
+    geometry_stats(:right_interface)
+  end
+
+  def self.border_stats(name)
+    Vedeu.borders.by_name(name)
+  end
+  def self.bl
+    border_stats(:left_interface)
+  end
+  def self.bc
+    border_stats(:centre_interface)
+  end
+  def self.br
+    border_stats(:right_interface)
+  end
+
+  class CentreAlignmentView
+    def render
+      Vedeu.render do
+        view(:centre_interface) do
+          lines do
+            line "x:#{gc.x}, xn:#{gc.xn} (w:#{gc.width})"
+            line "y:#{gc.y}, yn:#{gc.yn} (h:#{gc.height})"
+            line ""
+            line "bx:#{bc.bx}, bxn:#{bc.bxn} (bw:#{bc.width})"
+            line "by:#{bc.by}, byn:#{bc.byn} (bh:#{bc.height})"
+            line ""
+            line "The 'h', 'j', 'k' and 'l' keys will"
+            line "move this view left, down, up, and"
+            line "right respectively."
+          end
+        end
+      end
+
+      Vedeu.trigger(:_refresh_view, :centre_interface)
+    end
+
+    def gc
+      Vedeu.geometries.by_name(:centre_interface)
+    end
+
+    def bc
+      Vedeu.borders.by_name(:centre_interface)
+    end
+  end
+
+  Vedeu.bind(:_initialize_) { Vedeu.trigger(:_refresh_) }
+
+  Vedeu.configure do
+    log './tmp/alignment.log'
+    renderers Vedeu::Renderers::File.new(filename: './tmp/alignment.out')
+  end
+
+  Vedeu.interface :left_interface do
+    border do
+      title 'Align: Left'
+    end
+    geometry do
+      alignment :left, 30
+
+      # or you can use:
+      # align_left 30
+
+      height 10
+    end
+  end
+
+  Vedeu.interface :centre_interface do
+    border do
+      title 'Align: Centre'
+    end
+    geometry do
+      alignment :centre, 40
+
+      # or you can use:
+      # align_centre 30
+
+      height 15
+    end
+  end
+
+  Vedeu.interface :right_interface do
+    border do
+      title 'Align: Right'
+    end
+    geometry do
+      alignment :right, 30
+
+      # or you can use:
+      # align_right 30
+
+      height 10
+    end
+  end
+
+  Vedeu.keymap '_global_' do
+    key('q') { Vedeu.exit }
+
+    key('h') {
+      Vedeu.trigger(:_view_left_, :centre_interface)
+
+      AlignmentApp::CentreAlignmentView.new.render
+    }
+    key('j') {
+      Vedeu.trigger(:_view_down_, :centre_interface)
+
+      AlignmentApp::CentreAlignmentView.new.render
+    }
+    key('k') {
+      Vedeu.trigger(:_view_up_, :centre_interface)
+
+      AlignmentApp::CentreAlignmentView.new.render
+    }
+    key('l') {
+      Vedeu.trigger(:_view_right_, :centre_interface)
+
+      AlignmentApp::CentreAlignmentView.new.render
+    }
+  end
+
+  Vedeu.render do
+    view(:left_interface) do
+      lines do
+        line "x:#{gl.x}, xn:#{gl.xn} (w:#{gl.width})"
+        line "y:#{gl.y}, yn:#{gl.yn} (h:#{gl.height})"
+        line ""
+        line "bx:#{bl.bx}, bxn:#{bl.bxn} (bw:#{bl.width})"
+        line "by:#{bl.by}, byn:#{bl.byn} (bh:#{bl.height})"
+      end
+    end
+
+    view(:centre_interface) do
+      lines do
+        line "x:#{gc.x}, xn:#{gc.xn} (w:#{gc.width})"
+        line "y:#{gc.y}, yn:#{gc.yn} (h:#{gc.height})"
+        line ""
+        line "bx:#{bc.bx}, bxn:#{bc.bxn} (bw:#{bc.width})"
+        line "by:#{bc.by}, byn:#{bc.byn} (bh:#{bc.height})"
+        line ""
+        line "The 'h', 'j', 'k' and 'l' keys will"
+        line "move this view left, down, up, and"
+        line "right respectively. The coordinates"
+        line "will not change in this example"
+        line "because they have not been"
+        line "instructed to do so."
+      end
+    end
+
+    view(:right_interface) do
+      lines do
+        line "x:#{gr.x}, xn:#{gr.xn} (w:#{gr.width})"
+        line "y:#{gr.y}, yn:#{gr.yn} (h:#{gr.height})"
+        line ""
+        line "bx:#{br.bx}, bxn:#{br.bxn} (bw:#{br.width})"
+        line "by:#{br.by}, byn:#{br.byn} (bh:#{br.height})"
+      end
+    end
+  end
+
+  def self.start(argv = ARGV)
+    Vedeu::Launcher.execute!(argv)
+  end
+
+end # AlignmentApp
+
+AlignmentApp.start

data/lib/vedeu/cursors/cursor.rb

@@ -158,7 +158,7 @@ module Vedeu
       #
       # @return [Array<Vedeu::Models::Escape>]
       def render
-        Vedeu.log(type: :info, message: "Refreshing cursor: '#{name}'".freeze)
+        Vedeu.log(message: "Refreshing cursor: '#{name}'".freeze)
 
         Vedeu.render_output(escape_sequence)
       end

data/lib/vedeu/geometry/alignment.rb

@@ -0,0 +1,87 @@
+module Vedeu
+
+  module Geometry
+
+    # Provides the mechanism to align an interface/view horizontally
+    # to the available terminal space.
+    #
+    class Alignment
+
+      # @param (see #initialize)
+      # @return (see #align)
+      def self.align(value = nil)
+        new(value).align
+      end
+
+      # @param value [NilClass|Symbol]
+      # @return [Vedeu::Geometry::Alignment]
+      def initialize(value = nil)
+        @value = value
+      end
+
+      # @raise [Vedeu::Error::InvalidSyntax] When the value is not one
+      #   of :centre, :left, :right
+      # @return [Symbol]
+      def align
+        return value if valid?
+
+        fail Vedeu::Error::InvalidSyntax,
+             'Cannot align as value is invalid or undefined.'.freeze
+      end
+
+      private
+
+      # @return [Boolean]
+      def align_value?
+        @value.to_s.start_with?('align_')
+      end
+
+      # @return [Symbol]
+      def coerced_value
+        coerced = @value.to_s.gsub!('align_', '').to_sym
+
+        coerced == :center ? :centre : coerced
+      end
+
+      # @return [Boolean]
+      def none?
+        @value.nil? || !(@value.is_a?(Symbol)) || @value == :alignment
+      end
+
+      # @return [Boolean]
+      def valid?
+        values.include?(value)
+      end
+
+      # @return [Symbol]
+      def value
+        @_value ||= if none?
+                      :none
+
+                    elsif @value == :center
+                      :centre
+
+                    elsif align_value?
+                      coerced_value
+
+                    else
+                      @value.to_sym
+
+                    end
+      end
+
+      # @return [Array<Symbol>]
+      def values
+        [
+          :centre,
+          :left,
+          :none,
+          :right,
+        ]
+      end
+
+    end # Alignment
+
+  end # Geometry
+
+end # Vedeu

data/lib/vedeu/geometry/all.rb

@@ -13,6 +13,7 @@ module Vedeu
 
 end # Vedeu
 
+require 'vedeu/geometry/alignment'
 require 'vedeu/geometry/area'
 require 'vedeu/geometry/coordinate'
 require 'vedeu/geometry/dimension'

data/lib/vedeu/geometry/area.rb

@@ -39,7 +39,9 @@ module Vedeu
       # @option attributes xn [Fixnum]
       # @option attributes x_xn [Fixnum]
       # @option attributes x_default [Fixnum]
-      # @option attributes options [Hash<Symbol => Boolean>]
+      # @option attributes maximised [Boolean]
+      # @option attributes centred [Boolean]
+      # @option attributes alignment [Symbol]
       # @return [Vedeu::Geometry::Area]
       def self.from_attributes(attributes = {})
         y_attributes = {
@@ -49,6 +51,7 @@ module Vedeu
           default:   Vedeu.height,
           maximised: attributes[:maximised],
           centred:   attributes[:centred],
+          # alignment: attributes[:alignment],
         }
         x_attributes = {
           d:         attributes[:x],
@@ -57,6 +60,7 @@ module Vedeu
           default:   Vedeu.width,
           maximised: attributes[:maximised],
           centred:   attributes[:centred],
+          alignment: attributes[:alignment],
         }
         y_yn = Vedeu::Geometry::Dimension.pair(y_attributes)
         x_xn = Vedeu::Geometry::Dimension.pair(x_attributes)

data/lib/vedeu/geometry/dimension.rb

@@ -22,7 +22,9 @@ module Vedeu
       # @option attributes d_dn [Fixnum|NilClass] A width or a height.
       # @option attributes default [Fixnum|NilClass]
       #   The terminal width or height.
-      # @option attributes options [Hash]
+      # @option attributes maximised [Boolean]
+      # @option attributes centered [Boolean]
+      # @option attributes alignment [Symbol]
       # @return [Vedeu::Geometry::Dimension]
       def initialize(attributes = {})
         defaults.merge!(attributes).each do |key, value|
@@ -54,19 +56,19 @@ module Vedeu
       protected
 
       # @!attribute [r] d
-      # @return [Fixnum|NilClass]
+      # @return [Fixnum|NilClass] The starting value (y or x).
       attr_reader :d
 
       # @!attribute [r] dn
-      # @return [Fixnum|NilClass]
+      # @return [Fixnum|NilClass] The ending value (yn or xn).
       attr_reader :dn
 
       # @!attribute [r] d_dn
-      # @return [Fixnum|NilClass]
+      # @return [Fixnum|NilClass] A width or a height.
       attr_reader :d_dn
 
       # @!attribute [r] default
-      # @return [Fixnum|NilClass]
+      # @return [Fixnum|NilClass] The terminal width or height.
       attr_reader :default
 
       # @!attribute [r] maximised
@@ -79,13 +81,33 @@ module Vedeu
       attr_reader :centred
       alias_method :centred?, :centred
 
+      # @!attribute [r] alignment
+      # @return [Symbol]
+      attr_reader :alignment
+
       private
 
+      # 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 centre_aligned?
+                       [centred_d, centred_dn]
+
+                     elsif left_aligned?
+                       [1, left_dn]
+
+                     elsif right_aligned?
+                       [right_d, default]
+
                      elsif centred? && length?
                        [centred_d, centred_dn]
 
@@ -95,11 +117,22 @@ module Vedeu
                      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 GL 2015-10-16 Investigate: should this be && or ||.
       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.
+      # 2) Or use the width or height value.
+      # 3) Or use the default/current terminal width or height value.
+      #
       # @return [Fixnum|NilClass]
       def length
         if d && dn
@@ -108,7 +141,7 @@ module Vedeu
         elsif d_dn
           d_dn
 
-        elsif default
+        else
           default
 
         end
@@ -116,16 +149,56 @@ module Vedeu
 
       # Ascertains the centred starting coordinate.
       #
+      # @example
+      #    default = 78 # => 39
+      #    length = 24 # => 12
+      #    centred_d = 27 # (39 - 12 = 27)
+      #
       # @return [Fixnum]
       def centred_d
-        (default / 2) - (length / 2)
+        d = (default / 2) - (length / 2)
+        d < 1 ? 1 : d
       end
 
       # Ascertains the centred ending coordinate.
       #
+      # @example
+      #    default = 78 # => 39
+      #    length = 24 # => 12
+      #    centred_dn = 51 # (39 + 12 = 51)
+      #
       # @return [Fixnum]
       def centred_dn
-        (default / 2) + (length / 2)
+        dn = (default / 2) + (length / 2)
+        dn > default ? default : dn
+      end
+
+      # @return [Fixnum]
+      def left_dn
+        if d_dn
+          (d_dn > default) ? default : d_dn
+
+        elsif dn
+          dn
+
+        else
+          default
+
+        end
+      end
+
+      # @return [Fixnum]
+      def right_d
+        if d_dn
+          (default - d_dn) < 1 ? 1 : (default - d_dn)
+
+        elsif d
+          d
+
+        else
+          1
+
+        end
       end
 
       # Fetch the starting coordinate, or use 1 when not set.
@@ -139,10 +212,10 @@ module Vedeu
       #
       # 1) if an end value was given, use that.
       # 2) if a start value wasn't given, but a width or height was,
-      #    use the width or height
+      #    use the width or height.
       # 3) if a start value was given and a width or height was given,
       #    add the width or height to the start and minus 1.
-      # 4) otherwise, use the terminal default width or height
+      # 4) otherwise, use the terminal default width or height.
       #
       # @return [Fixnum]
       def _dn
@@ -155,12 +228,36 @@ module Vedeu
         elsif d && d_dn
           (d + d_dn) - 1
 
-        else
+        elsif default
           default
 
+        else
+          1
+
         end
       end
 
+      # Return a boolean indicating alignment was set to :left.
+      #
+      # @return [Boolean]
+      def left_aligned?
+        alignment == :left
+      end
+
+      # Return a boolean indicating alignment was set to :centre.
+      #
+      # @return [Boolean]
+      def centre_aligned?
+        alignment == :centre
+      end
+
+      # Return a boolean indicating alignment was set to :right.
+      #
+      # @return [Boolean]
+      def right_aligned?
+        alignment == :right
+      end
+
       # Returns the default options/attributes for this class.
       #
       # @return [Hash<Symbol => NilClass,Boolean>]
@@ -172,6 +269,7 @@ module Vedeu
           default:   nil,
           centred:   false,
           maximised: false,
+          alignment: Vedeu::Geometry::Alignment.align(:none),
         }
       end