vedeu 0.0.29 → 0.0.30

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e83dcfaeb94f1510b47187400a76e5dd8bba17c
-  data.tar.gz: c53adf0c6ffc23920572cbdd4d34f8290e0286e9
+  metadata.gz: fad9751a79b86fc406d103fe1882055758c9ca52
+  data.tar.gz: 92d0385d33aee322dd606720acf85e2e892058e2
 SHA512:
-  metadata.gz: c929b05c765cbc27391ff4488940675033d0b06786f06a5d85544cc037bfd66d1ee57cfba82bc6ab7b8df0f78f0143986ee362cf58b28a7ff2a3110e3847a087
-  data.tar.gz: 8b244ea995073d9aa966050cb24064a7614e22232efb8b11bef36cb0d73b04240079336fef9b4adfa462d2495bdc739f0264709eceefb0fb371547c52c0c0d8f
+  metadata.gz: 1aa0f28cd2622a96f9bd39b0dfda454efc73e5fc330d6b7387cb74f041bc4b6725ccdd717166311dd4b9c8071b70de6cb50cc40bf6f429bd62a1d797496b9368
+  data.tar.gz: 08607e602dfb5d7a89688069dee68e3a34acf8b3a2f8b725f6c3ecbbaddf8fd65004d1c44dae8a088531c08f108973c95c1288cd22d622a3fca5ba57c84b9991

data/README.md

@@ -34,6 +34,20 @@ Expect proper documentation soon!
                          keyword:  'quit' }
     end
 
+
+### Some Terms
+
+To understand how Vedeu works, you need to familiarise yourself with some terms.
+
+  - Interface: This is an area on the screen where you can take input or direct output. You will define it's colour and style, its dimensions, including position and give it a name. You can then direct the output of a command to this interface and Vedeu will ensure the content is placed there. Interfaces can be layered, allowing pseudo 3D effects (if that floats your boat), or to provide a richer application experience.
+
+  - Line: An interface is composed of many lines. Their length being the width of the interface and their number being the height of the interface.
+
+  An interface with `width: 12, height: 5` will have five lines, each made of 12 characters.
+
+  - Stream: A stream is a subset of a line. Having streams basically allow us to apply styles and colours to part of a line; their not necessary, but provide you with greater flexibility for your output.
+
+
 ### On Defining Interfaces
 
     interface :main, {
@@ -83,7 +97,18 @@ Geometry for Vedeu, as the same for ANSI terminals, is set top-left, which is po
 
 ### Colours
 
-Vedeu uses HTML/CSS style notation (i.e. '#aadd00').
+Vedeu uses HTML/CSS style notation (i.e. '#aadd00'), they can be used at the stream level, the line level or for the whole interface.
+
+    "colour": { "foreground": "#ff0000", "background": "#ffffff" }
+
+
+### Styles
+
+Vedeu has a range of symbol styles which are compatible with most terminals which are ANSI compatible.
+
+    "style": []
+
+Like colours, they can be defined in either interfaces, for specific lines or within streams. Styles are applied as encountered.
 
 
 ### Layers
@@ -97,7 +122,7 @@ Vedeu uses two rules.
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/vedeu/fork )
+1. Fork it ( http://github.com/gavinlaking/vedeu/fork )
 2. Clone it
 3. `bundle`
 4. `rake` or `bundle exec guard`

data/lib/vedeu/application.rb

@@ -28,8 +28,10 @@ module Vedeu
     def runner
       if interactive?
         interactive { yield }
+
       else
         run_once    { yield }
+
       end
     end
 

data/lib/vedeu/models/composition.rb

@@ -18,14 +18,24 @@ module Vedeu
         interface.enqueue(interface.to_s)
         interface
       end
+
+      self
     end
 
     def to_json
-      Oj.dump(attributes, mode: :compat)
+      Oj.dump(json_attributes, mode: :compat)
     end
 
     def to_s
       interfaces.map(&:to_s).join
     end
+
+    private
+
+    def json_attributes
+      {
+        interfaces: interfaces
+      }
+    end
   end
 end

data/lib/vedeu/models/interface.rb

@@ -4,7 +4,6 @@ require_relative 'presentation'
 require_relative 'line_collection'
 require_relative '../output/interface_renderer'
 require_relative '../support/esc'
-require_relative '../support/cursor'
 require_relative '../support/queue'
 require_relative '../support/terminal'
 
@@ -38,7 +37,7 @@ module Vedeu
     end
 
     def to_json
-      Oj.dump(attributes, mode: :compat)
+      Oj.dump(json_attributes, mode: :compat)
     end
 
     def to_s
@@ -58,5 +57,20 @@ module Vedeu
     def clear_interface
       InterfaceRenderer.clear(self)
     end
+
+    def json_attributes
+      {
+        colour: colour, # TODO: translate back?
+        style:  style,
+        name:   name,
+        lines:  lines,
+        y:      y,
+        x:      x,
+        z:      z,
+        width:  width,
+        height: height,
+        cursor: cursor
+      }
+    end
   end
 end

data/lib/vedeu/models/interface_collection.rb

@@ -1,23 +1,14 @@
 require 'virtus'
 
 require_relative '../repository/interface_repository'
-require_relative 'coercions'
 
 module Vedeu
   class InterfaceCollection < Virtus::Attribute
-    include Coercions
-
     def coerce(values)
-      return [] if empty?(values)
-
-      if multiple?(values)
-        values.map do |value|
-          InterfaceRepository.update(value[:name], value)
-        end
-
-      elsif single?(values)
-        [InterfaceRepository.update(values[:name], values)]
+      return [] if values.nil? || values.empty?
 
+      [values].flatten.map do |value|
+        InterfaceRepository.update(value.fetch(:name, nil), value)
       end
     end
   end

data/lib/vedeu/models/line.rb

@@ -9,14 +9,25 @@ module Vedeu
     include Virtus.model
     include Presentation
 
+    attribute :model,   Hash
     attribute :streams, StreamCollection
 
     def to_json
-      Oj.dump(attributes, mode: :compat)
+      Oj.dump(json_attributes, mode: :compat)
     end
 
     def to_s
       [colour, style, streams].join
     end
+
+    private
+
+    def json_attributes
+      {
+        colour:  colour,
+        style:   style,
+        streams: streams
+      }
+    end
   end
 end

data/lib/vedeu/models/line_collection.rb

@@ -1,26 +1,18 @@
 require 'virtus'
 
 require_relative 'line'
-require_relative 'coercions'
 
 module Vedeu
-  class InvalidLine < StandardError; end
-
   class LineCollection < Virtus::Attribute
-    include Coercions
-
     def coerce(values)
-      return [] if empty?(values)
-
-      if multiple?(values)
-        values.map { |v| Line.new(v) }
+      return [] if values.nil? || values.empty?
 
-      elsif single?(values)
-        [Line.new(values)]
-
-      elsif just_text?(values)
+      if values.is_a?(::String)
         [Line.new({ streams: values })]
 
+      else
+        [values].flatten.map { |value| Line.new(value) }
+
       end
     end
   end

data/lib/vedeu/models/stream.rb

@@ -11,11 +11,21 @@ module Vedeu
     attribute :text, String, default: ''
 
     def to_json
-      Oj.dump(attributes, mode: :compat)
+      Oj.dump(json_attributes, mode: :compat)
     end
 
     def to_s(options = {})
       [colour, style, text].join
     end
+
+    private
+
+    def json_attributes
+      {
+        colour: colour,
+        style:  style,
+        text:   text
+      }
+    end
   end
 end

data/lib/vedeu/models/stream_collection.rb

@@ -1,26 +1,18 @@
 require 'virtus'
 
 require_relative 'stream'
-require_relative 'coercions'
 
 module Vedeu
-  class InvalidStream < StandardError; end
-
   class StreamCollection < Virtus::Attribute
-    include Coercions
-
     def coerce(values)
-      return [] if empty?(values)
-
-      if multiple?(values)
-        values.map { |v| Stream.new(v) }
+      return [] if values.nil? || values.empty?
 
-      elsif single?(values)
-        [Stream.new(values)]
-
-      elsif values.is_a?(String)
+      if values.is_a?(::String)
         [Stream.new({ text: values })]
 
+      else
+        [values].flatten.map { |value| Stream.new(value) }
+
       end
     end
   end

data/lib/vedeu/models/style_collection.rb

@@ -1,21 +1,17 @@
 require 'virtus'
 
-require_relative '../support/cursor'
 require_relative '../support/esc'
-require_relative 'coercions'
 
 module Vedeu
   class StyleCollection < Virtus::Attribute
-    include Coercions
-
     def coerce(values)
-      return '' if empty?(values)
+      return '' if values.nil? || values.empty?
 
-      if multiple?(values)
-        values.map { |value| Esc.stylize(value) }.join
+      if values.is_a?(::Array)
+        values.map { |value| Esc.string(value) }.join
 
-      elsif just_text?(values)
-        Esc.stylize(values)
+      elsif values.is_a?(::String)
+        Esc.string(values)
 
       end
     end

data/lib/vedeu/output/output.rb

@@ -2,12 +2,8 @@ require_relative '../repository/interface_repository'
 require_relative '../support/terminal'
 
 module Vedeu
-  class Output
-    def self.render
-      new.render
-    end
-
-    def initialize; end
+  module Output
+    extend self
 
     def render
       InterfaceRepository.refresh.each do |interface|

data/lib/vedeu/repository/repository.rb

@@ -22,10 +22,6 @@ module Vedeu
       adaptor.create(model)
     end
 
-    def delete(model)
-      adaptor.delete(model)
-    end
-
     def reset
       adaptor.reset(entity)
     end

data/lib/vedeu/support/esc.rb

@@ -1,4 +1,3 @@
-require_relative 'cursor'
 require_relative 'terminal'
 require_relative 'translator'
 
@@ -7,102 +6,49 @@ module Vedeu
     extend self
 
     def background_colour(value = '#000000')
-      [esc, '48;5;', colour_translator(value), 'm'].join
-    end
-
-    def blink
-      [esc, '5m'].join
-    end
-
-    def blink_off
-      [esc, '25m'].join
-    end
-
-    def bold
-      [esc, '1m'].join
-    end
-
-    def bold_off
-      [esc, '21m'].join
-    end
-
-    def clear
-      [esc, '2J'].join
+      ["\e[48;5;", colour_translator(value), 'm'].join
     end
 
     def clear_line
-      [esc, '2K'].join
+      "\e[2K"
     end
 
-    def clear_last_line()
+    def clear_last_line
       set_position((Terminal.height - 1), 1) + clear_line
     end
 
-    # def cursor(value)
-    #   Cursor.
-    # end
-
-    def esc
-      [27.chr, '['].join
-    end
-
     def foreground_colour(value = '#ffffff')
-      [esc, '38;5;', colour_translator(value), 'm'].join
-    end
-#
-    def negative
-      [esc, '7m'].join
-    end
-
-    def positive
-      [esc, '27m'].join
-    end
-
-    def normal
-      [underline_off, bold_off, positive].join
-    end
-
-    def dim
-      [esc, '2m'].join
-    end
-
-    def reset
-      [esc, '0m'].join
+      ["\e[38;5;", colour_translator(value), 'm'].join
     end
 
     def set_position(y = 1, x = 1)
-      [esc, ((y == 0 || y == nil) ? 1 : y), ';', ((x == 0 || x == nil) ? 1 : x), 'H'].join
+      row    = (y == 0 || y == nil) ? 1 : y
+      column = (x == 0 || x == nil) ? 1 : x
+
+      ["\e[", row, ';', column, 'H'].join
     end
 
-    def stylize(value = 'normal')
+    def string(value = 'normal')
       case value
-      when 'blink'         then blink
-      when 'blink_off'     then blink_off
-      when 'bold'          then bold
-      when 'bold_off'      then bold_off
-      when 'clear'         then clear
-      when 'hide_cursor'   then Cursor.hide
-      when 'negative'      then negative
-      when 'positive'      then positive
-      when 'reset'         then reset
-      when 'normal'        then normal
-      when 'dim'           then dim
-      when 'show_cursor'   then Cursor.show
-      when 'underline'     then underline
-      when 'underline_off' then underline_off
+      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 'hide_cursor'   then "\e[?25l"
+      when 'negative'      then "\e[7m"
+      when 'positive'      then "\e[27m"
+      when 'reset'         then "\e[0m"
+      when 'normal'        then "\e[24m\e[21m\e[27m"
+      when 'dim'           then "\e[2m"
+      when 'show_cursor'   then "\e[?25h"
+      when 'underline'     then "\e[4m"
+      when 'underline_off' then "\e[24m"
       else
         ''
       end
     end
 
-    def underline
-      [esc, '4m'].join
-    end
-
-    def underline_off
-      [esc, '24m'].join
-    end
-
     private
 
     def colour_translator(value)