vedeu 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 831514463a8bea83f3e218ddd59dccc347049e34
-  data.tar.gz: 2e6f495bc8b2bed85942a4335ff3b3bca86b07dd
+  metadata.gz: 7c4536e9fdde25f748de839f9a992e805b97f308
+  data.tar.gz: 0a951cfde4234e720dcbdf943bf6f91c2b95dc41
 SHA512:
-  metadata.gz: 9de37b9db1bc093309b4465f0ca3104b29ff9e2870b3a0eca008a9040e2c3317063ea74f4b67436a32dc952310f7314e05751fade11f0f7532ba18fc7757499f
-  data.tar.gz: 0d681db9caef7bebfbb5fcb01b48f3a4890ef8d62d8594c8efb496d7a7c8189ca1f46a02a3794d5775a4ba56696feedddb0760727900f219467860fa7c7377b3
+  metadata.gz: f92b9b9b3bdccb7a55df3aedddde6bd9ae67a88925c1c1584d274ebcdab52a98624377968ff91f8a1f61c854567cd363e848cb67d356665e4bf7be02b07ff8b2
+  data.tar.gz: 839cbdab1f3b684e35874975b2dc6c2052487edb94cdbef65aa12c72282ab679b711fac9dc11743a85849d1e817e4992143760509541e1adaac65cc3ed283d8e

data/Guardfile

@@ -5,3 +5,8 @@ guard :minitest, all_after_pass: true, focus_on_failed: true, env: { 'no_simplec
   end
   watch(%r{^test/test_helper\.rb})       { 'test' }
 end
+
+guard :bundler do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end

data/README.md

@@ -58,6 +58,20 @@ Expect proper documentation soon!
     end
 
 
+### Building Views
+
+Views with Vedeu are made up of simple building blocks. These blocks can be arranged in a multitude of ways which I hope is more than sufficient for your design needs.
+
+- Interfaces (`Interface`) are made up of lines. (`Line`)
+- Lines are made up of zero, one or multiple streams. (`Stream`)
+- An interface, line or stream can have a colour (`colour`) attribute.
+- An interface, line or stream can have a style (`style`) attribute.
+- Interfaces have a position (`y`, `x`) on the screen, and a size. (`width`, `height`)
+- Interfaces can be placed relative to each other based on their attributes. (`top`, `right`, `bottom`, `left`)
+- Colours are defined in CSS-style values, i.e. `#ff0000` would be red.
+- Styles are named. See the table below for supported styles.
+
+
 ### Some Terms
 
 To understand how Vedeu works, you need to familiarise yourself with some terms.
@@ -133,6 +147,26 @@ Vedeu has a range of symbol styles which are compatible with most terminals whic
 
 Like colours, they can be defined in either interfaces, for specific lines or within streams. Styles are applied as encountered.
 
+| Style name    | Escape Sequence          |
+|---------------|--------------------------|
+| bg_reset      | `\e[48;2;49m`            |
+| blink         | `\e[5m`                  |
+| blink_off     | `\e[25m`                 |
+| bold          | `\e[1m`                  |
+| bold_off      | `\e[21m`                 |
+| clear         | `\e[2J`                  |
+| colour_reset  | `\e[38;2;39m\e[48;2;49m` |
+| fg_reset      | `\e[38;2;39m`            |
+| hide_cursor   | `\e[?25l`                |
+| negative      | `\e[7m`                  |
+| positive      | `\e[27m`                 |
+| reset         | `\e[0m`                  | 
+| normal        | `\e[24m\e[21m\e[27m`     |
+| dim           | `\e[2m`                  |
+| show_cursor   | `\e[?25h`                |
+| underline     | `\e[4m`                  |
+| underline_off | `\e[24m`                 |
+
 
 ### Templates
 

data/deps.md

@@ -26,7 +26,7 @@ Geometry
 ERBParser
 
 Esc
-  Translator
+  ColourTranslator
 
 Events
 
@@ -113,7 +113,7 @@ Terminal
 
 TextAdaptor
 
-Translator
+ColourTranslator
 
 Wordwrap
 
@@ -140,7 +140,7 @@ Launcher
       Queue
       Terminal
         Esc
-          Translator
+          ColourTranslator
     Process
       Parser
         Composition
@@ -150,41 +150,41 @@ Launcher
                 ClearInterface
                 Colour
                   Esc
-                    Translator
+                    ColourTranslator
                 Geometry
                   Esc
-                    Translator
+                    ColourTranslator
                   Terminal
                     Esc
-                      Translator
+                      ColourTranslator
                 LineCollection
                   Collection
                   Line
                     Colour
                       Esc
-                        Translator
+                        ColourTranslator
                     StreamCollection
                       Collection
                       Stream
                         Colour
                           Esc
-                            Translator
+                            ColourTranslator
                         Style
                           Esc
-                            Translator
+                            ColourTranslator
                     Style
                       Esc
-                        Translator
+                        ColourTranslator
 
                 Queue
                 RenderInterface
                   ClearInterface
                 Style
                   Esc
-                    Translator
+                    ColourTranslator
                 Terminal
                   Esc
-                    Translator
+                    ColourTranslator
         ERBParser
           Template
         RawParser
@@ -194,5 +194,5 @@ Launcher
       Queue
     Terminal
       Esc
-        Translator
+        ColourTranslator
   Configuration

data/lib/vedeu.rb

@@ -3,7 +3,7 @@ require 'vedeu/support/interface_template'
 require 'vedeu/support/events'
 require 'vedeu/support/interface_store'
 
-require 'vedeu/support/geometry'
+require 'vedeu/models/geometry'
 require 'vedeu/support/menu'
 require 'vedeu/output/view'
 require 'vedeu/launcher'

data/lib/vedeu/instrumentation.rb

@@ -70,7 +70,7 @@ module Vedeu
       def defaults
         {
           event: 'call',
-          klass: /^Vedeu::(?!.*Instrumentation|Interface|Line|Stream|Style|Colour|Geometry|Terminal|Esc|Translator).*/
+          klass: /^Vedeu::(?!.*Instrumentation|Interface|Line|Stream|Style|Colour|Geometry|Terminal|Esc|ColourTranslator).*/
         }
       end
 

data/lib/vedeu/models/geometry.rb

@@ -0,0 +1,76 @@
+require 'virtus'
+
+require 'vedeu/support/esc'
+require 'vedeu/support/terminal'
+
+module Vedeu
+  class Geometry
+    include Virtus.model
+
+    attribute :y,       Integer, default: 1
+    attribute :x,       Integer, default: 1
+    attribute :width,   Integer, default: Terminal.width
+    attribute :height,  Integer, default: Terminal.height
+    attribute :centred, Boolean, default: false
+
+    def origin(index = 0)
+      Esc.set_position(virtual_y[index], left)
+    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,
+        top:     top,
+        bottom:  bottom,
+        left:    left,
+        right:   right,
+      }
+    end
+
+    private
+
+    def centre
+      @_centre ||= Terminal.centre
+    end
+
+    def centre_y
+      centre.first
+    end
+
+    def centre_x
+      centre.last
+    end
+
+    def virtual_y
+      @_virtual_y ||= (top..bottom).to_a
+    end
+  end
+end

data/lib/vedeu/models/interface.rb

@@ -6,7 +6,7 @@ require 'vedeu/models/colour'
 require 'vedeu/models/style'
 require 'vedeu/output/clear_interface'
 require 'vedeu/output/render_interface'
-require 'vedeu/support/geometry'
+require 'vedeu/models/geometry'
 require 'vedeu/support/queue'
 require 'vedeu/support/terminal'
 
@@ -17,18 +17,14 @@ module Vedeu
     include Vedeu::Queue
     include Virtus.model
 
-    attribute :name,    String
-    attribute :lines,   LineCollection
-    attribute :colour,  Colour,  default: Colour.new
-    attribute :style,   Style,   default: ''
-    attribute :y,       Integer, default: 1
-    attribute :x,       Integer, default: 1
-    attribute :width,   Integer, default: Terminal.width
-    attribute :height,  Integer, default: Terminal.height
-    attribute :current, String,  default: ''
-    attribute :cursor,  Boolean, default: true
-    attribute :centred, Boolean, default: false
-    attribute :delay,   Float,   default: 0
+    attribute :name,     String
+    attribute :lines,    LineCollection
+    attribute :colour,   Colour,   default: Colour.new
+    attribute :style,    Style,    default: ''
+    attribute :geometry, Geometry, default: Geometry.new
+    attribute :current,  String,   default: ''
+    attribute :cursor,   Boolean,  default: true
+    attribute :delay,    Float,    default: 0
 
     def initialize(attributes = {})
       super
@@ -46,14 +42,6 @@ module Vedeu
       super(self.to_s)
     end
 
-    def geometry
-      @_geometry ||= Geometry.new(attributes)
-    end
-
-    def origin(index = 0)
-      geometry.origin(index)
-    end
-
     def refresh
       if enqueued?
         self.current = dequeue

data/lib/vedeu/models/stream.rb

@@ -7,12 +7,24 @@ module Vedeu
   class Stream
     include Virtus.model
 
-    attribute :colour, Colour, default: Colour.new
-    attribute :style,  Style,  default: ''
-    attribute :text,   String, default: ''
+    attribute :colour, Colour,  default: Colour.new
+    attribute :style,  Style,   default: ''
+    attribute :text,   String,  default: ''
+    attribute :width,  Integer
+    attribute :align,  Symbol,  default: :left # :centre, :right
 
     def to_s(options = {})
-      [colour, style, text].join
+      if width
+        aligned = case align
+        when :left   then text.ljust(width,  ' ')
+        when :right  then text.rjust(width,  ' ')
+        when :centre then text.center(width, ' ')
+        end
+
+        [colour, style, aligned].join
+      else
+        [colour, style, text].join
+      end
     end
   end
 end

data/lib/vedeu/output/clear_interface.rb

@@ -10,9 +10,9 @@ module Vedeu
 
     def clear
       interface_lines.inject([colours]) do |line, index|
-        line << interface.origin(index)
-        line << ' ' * interface.width
-        line << interface.origin(index)
+        line << interface.geometry.origin(index)
+        line << ' ' * interface.geometry.width
+        line << interface.geometry.origin(index)
       end.join
     end
 
@@ -25,7 +25,7 @@ module Vedeu
     end
 
     def interface_lines
-      interface.height.times
+      interface.geometry.height.times
     end
   end
 end

data/lib/vedeu/{support/translator.rb → output/colour_translator.rb}

@@ -1,5 +1,5 @@
 module Vedeu
-  class Translator
+  class ColourTranslator
     def self.translate(html_colour = '')
       new(html_colour).translate
     end

data/lib/vedeu/output/erb_parser.rb

@@ -12,6 +12,7 @@ module Vedeu
 
     def initialize(object)
       @object = object
+      @output = ''
     end
 
     def parse
@@ -29,6 +30,16 @@ module Vedeu
 
     attr_reader :object
 
+    def capture(&block)
+      erbout = eval('_erbout', block.binding)
+      erbout_length = erbout.length
+      block.call
+      erbout_addition = erbout[erbout_length..-1]
+      erbout[erbout_length..-1] = ''
+      erbout_addition = erbout_addition.join if erbout_addition.is_a? Array
+      erbout_addition
+    end
+
     def erb_output
       ERB.new(template, nil, '-').result(get_binding)
     end

data/lib/vedeu/output/raw_parser.rb

@@ -22,11 +22,19 @@ module Vedeu
       stringified_keys.map do |name, content|
         {
           name:  name,
-          lines: TextAdaptor.adapt(content)
+          lines: lines(content)
         }
       end
     end
 
+    def lines(content)
+      if content.is_a?(Array) && content.first.is_a?(Hash)
+        content
+      else
+        TextAdaptor.adapt(content)
+      end
+    end
+
     def stringified_keys
       attributes.inject({}) { |a, (k, v)| a[k.to_s] = v; a }
     end

data/lib/vedeu/output/render_interface.rb

@@ -12,7 +12,7 @@ module Vedeu
       out = [interface.clear]
       processed_lines.each_with_index do |line, index|
         if index + 1 <= height
-          out << interface.origin(index)
+          out << interface.geometry.origin(index)
           out << line.to_s
         end
       end
@@ -61,11 +61,11 @@ module Vedeu
     end
 
     def height
-      interface.height
+      interface.geometry.height
     end
 
     def width
-      interface.width
+      interface.geometry.width
     end
   end
 end

data/lib/vedeu/support/esc.rb

@@ -1,17 +1,17 @@
-require 'vedeu/support/translator'
+require 'vedeu/output/colour_translator'
 
 module Vedeu
   module Esc
     extend self
 
-    def background_colour(value = '#000000')
-      return '' if value.empty?
+    def background_colour(value = '')
+      return '' if value.nil? || value.empty?
 
       ["\e[48;5;", colour_translator(value), 'm'].join
     end
 
-    def foreground_colour(value = '#ffffff')
-      return '' if value.empty?
+    def foreground_colour(value = '')
+      return '' if value.nil? || value.empty?
 
       ["\e[38;5;", colour_translator(value), 'm'].join
     end
@@ -25,12 +25,14 @@ module Vedeu
 
     def string(value = '')
       case value
+      when 'bg_reset'      then "\e[48;2;49m"
       when 'blink'         then "\e[5m"
       when 'blink_off'     then "\e[25m"
       when 'bold'          then "\e[1m"
       when 'bold_off'      then "\e[21m"
       when 'clear'         then "\e[2J"
       when 'colour_reset'  then "\e[38;2;39m\e[48;2;49m"
+      when 'fg_reset'      then "\e[38;2;39m"
       when 'hide_cursor'   then "\e[?25l"
       when 'negative'      then "\e[7m"
       when 'positive'      then "\e[27m"
@@ -48,7 +50,7 @@ module Vedeu
     private
 
     def colour_translator(value)
-      Translator.translate(value)
+      ColourTranslator.translate(value)
     end
   end
 end