vedeu 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73472624cf09a62012366cd4ef77b96c0a731695
-  data.tar.gz: 2efb14924dbf27185fd43c3083cbd35083e150cb
+  metadata.gz: 6fee0507672be816ff50768dda87bcae402feddf
+  data.tar.gz: 4a8c9d298fda7eaafba079138bf87e408dbd7739
 SHA512:
-  metadata.gz: 738f10f4ec7ffd205ba5efa8b0656ee588fa9464d174350ce37b799549754ead12e874fe6c867d7c04030351afccfb31d68b2f3ad5653c87a5234f73c522a722
-  data.tar.gz: a34a0a4c74a12524101306bebe57d3e30619eb5e846f19ba3f614a4a058befacca8e9d892e3435d42ac881cd26a1bca329d852179c5b1d672197851f826b27fd
+  metadata.gz: 6960df810fcdc92db6d6c0e753d9e8a7e372d33e3deed7bbe374b6dcb91b1243d4027d3445ffdd8a7b1fc9ea5a749f6935935a5eea62f06dbfecd3a892fe5af9
+  data.tar.gz: f40602cd24e26a9395dd95bc7a791b5542da1350f0ede53dc7a8b1af1ffa6835f3cb9810f9b7345b85321b133ff89269d174ceb69f64312bbd81e81330fa94e7

data/Guardfile

@@ -1,4 +1,4 @@
-guard :minitest, all_after_pass: true, env: { 'no_simplecov' => true } do
+guard :minitest, all_after_pass: true, focus_on_failed: true, env: { 'no_simplecov' => true } do
   watch(%r{^test/(.*)_test\.rb})
   watch(%r{^lib/(.+)\.rb}) do |m|
     "test/lib/#{m[1]}_test.rb"

data/README.md

@@ -134,6 +134,19 @@ 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.
 
 
+### Templates
+
+The following helpers are available in to the ERBParser.
+
+    foreground (alias: `fg`)
+
+    background (alias: `bg`)
+
+    colour
+
+    style
+
+
 ## Contributing
 
 1. Fork it ( http://github.com/gavinlaking/vedeu/fork )

data/deps.md

@@ -28,12 +28,14 @@ Geometry
   Esc
   Terminal
 
+ERBParser
+
 Esc
   Translator
 
 Events
 
-HashParser
+RawParser
   TextAdaptor
 
 Input
@@ -70,10 +72,14 @@ LineCollection
 
 Menu
 
+MenuParser
+
 Parser
   Composition
-  HashParser
+  ERBParser
+  RawParser
   JSONParser
+  MenuParser
 
 Persistence
   Interface
@@ -102,6 +108,7 @@ Style
   Esc
 
 Template
+  Helpers
 
 Terminal
   Esc
@@ -118,7 +125,6 @@ Wordwrap
 Orphans
 ----------------------------------------------------------------------
 
-Template - orphaned
 Wordwrap - orphaned
 Menu     - orphaned
 
@@ -184,9 +190,12 @@ Launcher
                 Terminal
                   Esc
                     Translator
-        HashParser
+        ERBParser
+          Template
+        RawParser
           TextAdaptor
         JSONParser
+        MenuParser
       Queue
     Terminal
       Esc

data/lib/vedeu.rb

@@ -3,7 +3,7 @@ require 'vedeu/support/builder'
 require 'vedeu/support/events'
 require 'vedeu/support/geometry'
 require 'vedeu/support/menu'
-require 'vedeu/parsing/parser'
+require 'vedeu/parsing/view'
 require 'vedeu/launcher'
 
 module Vedeu

data/lib/vedeu/models/interface.rb

@@ -34,6 +34,10 @@ module Vedeu
       super
     end
 
+    def clear
+      @_clear ||= ClearInterface.call(self)
+    end
+
     def enqueue
       super(self.to_s)
     end
@@ -51,7 +55,7 @@ module Vedeu
         self.current = dequeue
 
       elsif no_content?
-        self.current = ClearInterface.call(self)
+        self.current = clear
 
       else
         self.current

data/lib/vedeu/output/render_interface.rb

@@ -1,5 +1,3 @@
-require 'vedeu/output/clear_interface'
-
 module Vedeu
   class RenderInterface
     def self.call(interface)
@@ -11,7 +9,7 @@ module Vedeu
     end
 
     def render
-      out = [ClearInterface.call(interface)]
+      out = [interface.clear]
       processed_lines.each_with_index do |line, index|
         if index + 1 <= height
           out << interface.origin(index)

data/lib/vedeu/parsing/erb_parser.rb

@@ -0,0 +1,43 @@
+require 'erb'
+require 'vedeu/support/helpers'
+require 'vedeu/parsing/text_adaptor'
+
+module Vedeu
+  class ERBParser
+    include Helpers
+
+    def self.parse(object)
+      new(object).parse
+    end
+
+    def initialize(object)
+      @object = object
+    end
+
+    def parse
+      {
+        interfaces: [{ name: interface, lines: TextAdaptor.adapt(erb_output) }]
+      }
+    end
+
+    private
+
+    attr_reader :object
+
+    def erb_output
+      ERB.new(template, nil, '-').result(get_binding)
+    end
+
+    def interface
+      object.interface
+    end
+
+    def template
+      File.read(object.path)
+    end
+
+    def get_binding
+      object.send(:binding)
+    end
+  end
+end

data/lib/vedeu/parsing/json_parser.rb

@@ -1,13 +1,23 @@
 require 'json'
 
 module Vedeu
-  module JSONParser
-    extend self
+  class JSONParser
+    def self.parse(output)
+      new(output).parse
+    end
+
+    def initialize(output)
+      @output = output
+    end
 
-    def parse(output)
+    def parse
       JSON.load(output, nil, symbolize_names: true)
     rescue JSON::ParserError
       {}
     end
+
+    private
+
+    attr_reader :output
   end
 end

data/lib/vedeu/parsing/menu_parser.rb

@@ -1,16 +1,11 @@
 module Vedeu
   class MenuParser
-    # Convert a Vedeu::Menu into an interface view.
-    #
-    # @param output [Hash] a key/value pair.
-    #
-    # @return [Hash]
-    def self.parse(output = {})
-      new(output).parse
+    def self.parse(menu)
+      new(menu).parse
     end
 
-    def initialize(output = {})
-      @output = output
+    def initialize(menu)
+      @menu = menu
     end
 
     def parse
@@ -19,7 +14,7 @@ module Vedeu
 
     private
 
-    attr_reader :output
+    attr_reader :menu
 
     def interface
       { name: name, lines: lines }
@@ -46,11 +41,11 @@ module Vedeu
     end
 
     def items
-      output.last
+      menu.last
     end
 
     def name
-      output.first
+      menu.first
     end
   end
 end

data/lib/vedeu/parsing/raw_parser.rb

@@ -0,0 +1,34 @@
+require 'vedeu/parsing/text_adaptor'
+
+module Vedeu
+  class RawParser
+    def self.parse(attributes)
+      new(attributes).parse
+    end
+
+    def initialize(attributes)
+      @attributes = attributes
+    end
+
+    def parse
+      { interfaces: interfaces }
+    end
+
+    private
+
+    attr_reader :attributes
+
+    def interfaces
+      stringified_keys.map do |name, content|
+        {
+          name:  name,
+          lines: TextAdaptor.adapt(content)
+        }
+      end
+    end
+
+    def stringified_keys
+      attributes.inject({}) { |a, (k, v)| a[k.to_s] = v; a }
+    end
+  end
+end

data/lib/vedeu/parsing/text_adaptor.rb

@@ -1,11 +1,5 @@
 module Vedeu
   class TextAdaptor
-    # Convert a block of text into a collection of lines.
-    #
-    # @param text [String|Array] a block of text containing new line (\n)
-    #   characters, or a collection of strings.
-    #
-    # @return [Array]
     def self.adapt(text)
       new(text).adapt
     end

data/lib/vedeu/parsing/view.rb

@@ -0,0 +1,46 @@
+require 'vedeu/models/composition'
+require 'vedeu/parsing/erb_parser'
+require 'vedeu/parsing/raw_parser'
+require 'vedeu/parsing/json_parser'
+require 'vedeu/parsing/menu_parser'
+require 'vedeu/parsing/raw_parser'
+
+module Vedeu
+  class View
+    def self.render(type, output)
+      new(type, output).render
+    end
+
+    def initialize(type, output)
+      @type, @output = type, output
+    end
+
+    def render
+      Composition.enqueue(parsed_output)
+    end
+
+    private
+
+    attr_reader :type, :output
+
+    def parsed_output
+      @parsed ||= parser.parse(output)
+    end
+
+    def parser
+      {
+        erb:     ERBParser,
+        json:    JSONParser,
+        hash:    RawParser,
+        menu:    MenuParser,
+        raw:     RawRarser,
+      }.fetch(type)
+    end
+  end
+end
+
+# ERBParser:  { :interface, :path, :object }
+# RawParser: { 'interface_name' => String|Array }
+#             { :interface_name  => String|Array }
+# JSONParser: output (string which is converted into a hash)
+# MenuParser: ['interface_name', Vedeu::Menu instance]

data/lib/vedeu/support/events.rb

@@ -2,37 +2,22 @@ module Vedeu
   class Events
     def initialize(&block)
       @handlers = Hash.new { |h, k| h[k] = [] }
-
-      log("self: #{self.object_id}")
-
       self.instance_eval(&block) if block_given?
-
       self
     end
 
     def add(object, &block)
-      log("self: #{self.object_id}")
-      log("object: #{object.object_id}")
-
       @self_before_instance_eval = eval 'self', block.binding
 
       self.instance_eval(&block)
     end
 
     def on(event, &block)
-      log("self: #{self.object_id}")
-      log("block: #{block.object_id}")
-      log("storing: #{event.inspect}")
-
       handlers[event] << block
     end
 
     def trigger(event, *args)
       handlers[event].each do |handler|
-        log("self: #{self.object_id}")
-        log("handler: #{handler.object_id}")
-        log("running: #{event.inspect}")
-
         handler.call(*args)
       end
     end
@@ -46,9 +31,5 @@ module Vedeu
     private
 
     attr_reader :handlers
-
-    def log(message)
-      Vedeu.log(sprintf("%42s%s", '', message)) if Vedeu.debug?
-    end
   end
 end

data/lib/vedeu/support/geometry.rb

@@ -2,18 +2,13 @@ require 'vedeu/support/esc'
 require 'vedeu/support/terminal'
 
 module Vedeu
+  InvalidHeight    = Class.new(StandardError)
+  InvalidWidth     = Class.new(StandardError)
   OutOfBoundsError = Class.new(StandardError)
 
   class Geometry
     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)
+      @attrs = attrs
     end
 
     def origin(index = 0)
@@ -21,59 +16,31 @@ module Vedeu
     end
 
     def terminal_height
-      fail_if_less_than_one(@terminal_height)
-
-      fail_if_out_of_bounds('terminal_height',
-                            @terminal_height,
-                            Terminal.height)
-
-      @terminal_height
+      @terminal_height ||= attrs_terminal_height
     end
 
     def height
-      fail_if_less_than_one(@height)
-
-      fail_if_out_of_bounds('height', @height, terminal_height)
-
-      @height
+      @height ||= attrs_height
     end
 
     def y
-      fail_if_less_than_one(@y)
-
-      fail_if_out_of_bounds('y', @y, terminal_height)
+      @y ||= attrs_y
+    end
 
-      @y
+    def x
+      @x ||= attrs_x
     end
 
     def terminal_width
-      fail_if_less_than_one(@terminal_width)
-
-      fail_if_out_of_bounds('terminal_width',
-                            @terminal_width,
-                            Terminal.width)
-
-      @terminal_width
+      @terminal_width ||= attrs_terminal_width
     end
 
     def width
-      fail_if_less_than_one(@width)
-
-      fail_if_out_of_bounds('width', @width, terminal_width)
-
-      @width
-    end
-
-    def x
-      fail_if_less_than_one(@x)
-
-      fail_if_out_of_bounds('x', @x, terminal_width)
-
-      @x
+      @width ||= attrs_width
     end
 
     def centred
-      !!(@centred)
+      @centred ||= attrs_centred
     end
 
     def centre
@@ -128,6 +95,60 @@ module Vedeu
 
     private
 
+    attr_reader :attrs
+
+    def attrs_height
+      height = attrs.fetch(:height)
+      fail_if_less_than_one(height)
+      fail_if_out_of_bounds('height', height, terminal_height)
+      height
+    rescue KeyError
+      fail InvalidHeight, 'An Interface must have a height attribute.'
+    end
+
+    def attrs_terminal_height
+      terminal_height = attrs.fetch(:terminal_height, Terminal.height)
+      fail_if_less_than_one(terminal_height)
+      fail_if_out_of_bounds('terminal_height', terminal_height, Terminal.height)
+      terminal_height
+    end
+
+    def attrs_y
+      y = attrs.fetch(:y, 1)
+      fail_if_less_than_one(y)
+      fail_if_out_of_bounds('y', y, terminal_height)
+      y
+    end
+
+    def attrs_x
+      x = attrs.fetch(:x, 1)
+      fail_if_less_than_one(x)
+      fail_if_out_of_bounds('x', x, terminal_width)
+      x
+    end
+
+    def attrs_terminal_width
+      terminal_width = attrs.fetch(:terminal_width, Terminal.width)
+      fail_if_less_than_one(terminal_width)
+      fail_if_out_of_bounds('terminal_width',
+                            terminal_width,
+                            Terminal.width)
+      terminal_width
+    end
+
+    def attrs_width
+      width = attrs.fetch(:width)
+      fail_if_less_than_one(width)
+      fail_if_out_of_bounds('width', width, terminal_width)
+      width
+    rescue KeyError
+      fail InvalidWidth, 'An Interface must have a width attribute.'
+    end
+
+    def attrs_centred
+      !!(attrs.fetch(:centred, true))
+    end
+
     def fail_if_less_than_one(value)
       fail OutOfBoundsError,
         'Value must be greater than or equal to 1.' if value < 1
@@ -147,6 +168,5 @@ module Vedeu
     def virtual_y(index = 0)
       ((top..bottom).to_a)[index]
     end
-
   end
 end