vedeu 0.0.31 → 0.0.32

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29a2d43ab7e7d773c5ad3fcd3d223462808fe191
-  data.tar.gz: 428e31c1b5fb377a92741f3cf7ccaeafd081fe24
+  metadata.gz: a0f9669e1076e596ff5730f44aa1e4563fc24fb6
+  data.tar.gz: 7316c60bdbf2067b1ee27726bd94524f8554af47
 SHA512:
-  metadata.gz: b19757abb7a24b5e3c27db48950075536bd3b85b1d6b448f0041fa206c91af01405e76618f3d5b7644da86d08b0c7cd7a30de2d3438354d755c4d436f11342de
-  data.tar.gz: 0feb617271ee83bf0f3caa26c7adfb294ac6651ddbd3aa014bf14ac2f660f746ae172e568e4cf0407320f63e9ac97c5a6b1eb890bc8cb3ea5d6dfc00ac08fc59
+  metadata.gz: 7233c00d83179e6d1374fca99bea3d477f83e5991e09a8a85211d83c590d47de83ab67adca91c39628f0050240e01921cc932c2cda64826f619fea618b8e0abc
+  data.tar.gz: 758b39394201c72a704d0fce2188272474f4c62ee73ec5589c3938f87fea664c8576b0fb69b67dc0c808a6298e7a7bb3676838694447326d31202182fbf7d33c

data/README.md

@@ -54,8 +54,8 @@ To understand how Vedeu works, you need to familiarise yourself with some terms.
                 y:          1,
                 x:          1,
                 z:          1,
-                width:      :auto, # will set to terminal width
-                height:     10,    # also accepts :auto
+                width:      10, # see notes below
+                height:     10,
                 colour: {
                   foreground: '#ffffff',
                   background: '#000000'
@@ -69,8 +69,10 @@ Referring to the above example, interfaces have a name, and various default attr
 `:x`          sets the starting column point.
 `:z`          an integer specifying the z-index of the interface.
               (See Layers)
-`:width`      sets how many characters wide the interface will be.
-`:height`     sets how many characters tall the interface will be.
+
+`:width`      sets character width of the interface
+`:height`     sets character height of the interface
+              Note: not setting a width or height will set the values to the terminal's reported width and height.
 
 `:foreground` sets the default foreground colour. (See Colours)
 `:background` sets the default background colour.

data/lib/vedeu.rb

@@ -4,6 +4,7 @@ require 'logger'
 require_relative 'vedeu/repository/command_repository'
 require_relative 'vedeu/repository/interface_repository'
 require_relative 'vedeu/repository/event_repository'
+require_relative 'vedeu/support/coordinate'
 require_relative 'vedeu/support/exit'
 require_relative 'vedeu/launcher'
 

data/lib/vedeu/models/collection.rb

@@ -0,0 +1,17 @@
+module Vedeu
+  module Collection
+    extend self
+
+    def coercer(value, model, key)
+      return [] if value.nil? || value.empty?
+
+      if value.is_a?(::String)
+        [model.new({ key => value })]
+
+      else
+        [value].flatten.map { |v| model.new(v) }
+
+      end
+    end
+  end
+end

data/lib/vedeu/models/colour.rb

@@ -1,22 +1,44 @@
 require 'oj'
 require 'virtus'
 
-require_relative 'foreground'
-require_relative 'background'
+require_relative '../support/esc'
 
 module Vedeu
   class Colour
     include Virtus.model
 
-    attribute :foreground, Foreground
-    attribute :background, Background
+    attribute :foreground, String
+    attribute :background, String
+
+    def foreground
+      @fg ||= Esc.foreground_colour(css_foreground)
+    end
+
+    def background
+      @bg ||= Esc.background_colour(css_background)
+    end
+
+    def css_foreground
+      @foreground || ''
+    end
+
+    def css_background
+      @background || ''
+    end
 
     def to_json
-      Oj.dump(attributes, mode: :compat)
+      Oj.dump(as_hash, mode: :compat)
     end
 
     def to_s
       foreground + background
     end
+
+    def as_hash
+      {
+        foreground: css_foreground,
+        background: css_background,
+      }
+    end
   end
 end

data/lib/vedeu/models/line_collection.rb

@@ -1,19 +1,14 @@
 require 'virtus'
 
+require_relative 'collection'
 require_relative 'line'
 
 module Vedeu
   class LineCollection < Virtus::Attribute
-    def coerce(values)
-      return [] if values.nil? || values.empty?
-
-      if values.is_a?(::String)
-        [Line.new({ streams: values })]
+    include Collection
 
-      else
-        [values].flatten.map { |value| Line.new(value) }
-
-      end
+    def coerce(values)
+      coercer(values, Line, :streams)
     end
   end
 end

data/lib/vedeu/models/stream.rb

@@ -22,7 +22,7 @@ module Vedeu
 
     def json_attributes
       {
-        colour: colour,
+        colour: colour.as_hash,
         style:  style,
         text:   text
       }

data/lib/vedeu/models/stream_collection.rb

@@ -1,19 +1,14 @@
 require 'virtus'
 
+require_relative 'collection'
 require_relative 'stream'
 
 module Vedeu
   class StreamCollection < Virtus::Attribute
-    def coerce(values)
-      return [] if values.nil? || values.empty?
-
-      if values.is_a?(::String)
-        [Stream.new({ text: values })]
+    include Collection
 
-      else
-        [values].flatten.map { |value| Stream.new(value) }
-
-      end
+    def coerce(values)
+      coercer(values, Stream, :text)
     end
   end
 end

data/lib/vedeu/support/coordinate.rb

@@ -0,0 +1,149 @@
+require_relative 'terminal'
+
+module Vedeu
+  class OutOfBoundsError < StandardError; end
+
+  class Coordinate
+    def initialize(attrs = {})
+      @attrs           = attrs
+      @height          = attrs.fetch(:height)
+      @width           = attrs.fetch(:width)
+      @terminal_height = attrs.fetch(:terminal_height, Terminal.height)
+      @terminal_width  = attrs.fetch(:terminal_width,  Terminal.width)
+      @y               = attrs.fetch(:y, 1)
+      @x               = attrs.fetch(:x, 1)
+      @centred         = attrs.fetch(:centred, true)
+    end
+
+    def terminal_height
+      fail OutOfBoundsError,
+        'Value must be greater than or equal to 1.' if @terminal_height < 1
+
+      if @terminal_height > Terminal.height
+        fail OutOfBoundsError, 'Cannot set terminal_height to be ' \
+                               'greater than the actual terminal ' \
+                               'height.'
+      else
+        @terminal_height
+      end
+    end
+
+    def height
+      fail OutOfBoundsError,
+        'Value must be greater than or equal to 1.' if @height < 1
+
+      if @height > terminal_height
+        fail OutOfBoundsError, 'Cannot set height to be greater ' \
+                               'than the specified or actual '    \
+                               'terminal height.'
+      else
+        @height
+      end
+    end
+
+    def y
+      fail OutOfBoundsError,
+        'Value must be greater than or equal to 1.' if @y < 1
+
+      if @y > height
+        fail OutOfBoundsError, 'Cannot set y position to be greater' \
+                               ' that the specified height or' \
+                               ' actual terminal height.'
+      else
+        @y
+      end
+    end
+
+    def terminal_width
+      fail OutOfBoundsError,
+        'Value must be greater than or equal to 1.' if @terminal_width < 1
+
+      if @terminal_width > Terminal.width
+        fail OutOfBoundsError, 'Cannot set terminal_width to be '  \
+                               'greater than the actual terminal ' \
+                               'width.'
+      else
+        @terminal_width
+      end
+    end
+
+    def width
+      fail OutOfBoundsError,
+        'Value must be greater than or equal to 1.' if @width < 1
+
+      if @width > terminal_width
+        fail OutOfBoundsError, 'Cannot set width to be greater ' \
+                               'than the specified or actual ' \
+                               'terminal width.'
+      else
+        @width
+      end
+    end
+
+    def x
+      fail OutOfBoundsError,
+        'Value must be greater than or equal to 1.' if @x < 1
+
+      if @x > width
+        fail OutOfBoundsError, 'Cannot set x position to be greater' \
+                               ' that the specified width or' \
+                               ' actual terminal width.'
+      else
+        @x
+      end
+    end
+
+    def centred
+      !!(@centred)
+    end
+
+    def centre
+      [(terminal_height / 2), (terminal_width / 2)]
+    end
+
+    def centre_y
+      centre.first
+    end
+
+    def centre_x
+      centre.last
+    end
+
+    def top
+      if centred
+        centre_y - (height / 2)
+      else
+        y
+      end
+    end
+
+    def left
+      if centred
+        centre_x - (width / 2)
+      else
+        x
+      end
+    end
+
+    def bottom
+      top + height
+    end
+
+    def right
+      left + width
+    end
+
+    def position
+      {
+        y:       top,
+        x:       left,
+        height:  height,
+        width:   width,
+        centred: centred,
+        bottom:  bottom,
+        right:   right,
+      }
+    end
+
+  end
+end

data/lib/vedeu/support/esc.rb

@@ -6,6 +6,8 @@ module Vedeu
     extend self
 
     def background_colour(value = '#000000')
+      return '' if value.empty?
+
       ["\e[48;5;", colour_translator(value), 'm'].join
     end
 
@@ -18,6 +20,8 @@ module Vedeu
     end
 
     def foreground_colour(value = '#ffffff')
+      return '' if value.empty?
+
       ["\e[38;5;", colour_translator(value), 'm'].join
     end
 

data/lib/vedeu/support/menu.rb

@@ -0,0 +1,103 @@
+module Vedeu
+  class Menu
+    def initialize(collection)
+      @collection = collection
+      @current    = 0
+      @selected   = nil
+    end
+
+    def current
+      @current
+    end
+
+    def selected
+      @selected
+    end
+
+    def current_item
+      [@current, @collection[@current]]
+    end
+
+    def selected_item
+      return nil unless @selected
+
+      [@selected, @collection[@selected]]
+    end
+
+    def items
+      items = []
+      @collection.each_with_index do |item, index|
+        if index    == @current && index == @selected
+          items << [true, true, item]
+
+        elsif index == @current
+          items << [false, true, item]
+
+        elsif index == @selected
+          items << [true, false, item]
+
+        else
+          items << [false, false, item]
+
+        end
+      end
+      items
+    end
+
+    def render
+      lines = []
+      items.each do |(sel, cur, item)|
+        if sel && cur
+          lines << "*> #{item}"
+
+        elsif cur
+          lines << " > #{item}"
+
+        elsif sel
+          lines << "*  #{item}"
+
+        else
+          lines << "   #{item}"
+
+        end
+      end
+      lines
+    end
+
+    def top
+      @current = 0
+    end
+
+    def bottom
+      @current = last
+    end
+
+    def next
+      @current += 1 if @current < last
+
+      self
+    end
+
+    def prev
+      @current -= 1 if @current > 0
+
+      self
+    end
+
+    def select
+      @selected = @current
+    end
+
+    def deselect
+      @selected = nil
+    end
+
+    def last
+      @collection.size - 1
+    end
+
+    def size
+      @collection.size
+    end
+  end
+end