vedeu 0.4.50 → 0.4.51

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a09d46830938e1cc8b738499f0473e18c03cfb9c
-  data.tar.gz: 391122a3f279aded058f010e67eefeb382385dff
+  metadata.gz: 51f8100764995bff505583f3dc874821dcb56fc9
+  data.tar.gz: 9064e5dfd73320ad37281d8cb112d77439ebc641
 SHA512:
-  metadata.gz: bebff5ce0ae54c6880aeb8f6f229661007521a4a029b585f1a6bc0a3b027e548ba93136a5ab60e0570cf0075711c0689e52b263bb8e602ad06bda0e4e726c1fe
-  data.tar.gz: 4dc322f36187484f76665de2eab79f50d2b0ea14b32ca6eba943d6d12c7c87f7593ad37b0a34b014c3188a9a648c21985b7491ad5a6ff69d78427041e195a9e2
+  metadata.gz: ae6180723fb6977e5da0efd16ae9a0250feaa89a1ff5e0d813ae8a24d0c399b9086aaa49ab33940fb9fc5ea9652fadf87fb21933c96af17f201cfdc403d51cf5
+  data.tar.gz: 9aafcd3c738dde584d38ae6dc0a5e26b552c18f2c498d00dca86cf755dfe76b60d3b518e93343304646cb02d856916774c9400ca23c393cd20c8cc10fb16778a

data/Guardfile

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

data/examples/material_colours_app.rb

@@ -21,7 +21,7 @@ class VedeuMaterialColoursApp
   configure do
     # debug!
     log '/tmp/vedeu_material_colours_app.log'
-    # renderers Vedeu::Renderers::File
+    # renderers Vedeu::Renderers::File.new
   end
 
   interface 'main_interface' do

data/examples/panel_app.rb

@@ -21,7 +21,7 @@ class VedeuPanelApp
   configure do
     # debug!
     log '/tmp/vedeu_panel_app.log'
-    # renderers Vedeu::Renderers::File
+    # renderers Vedeu::Renderers::File.new
   end
 
   # line { centre 'Blue',        width: 20, background: '#2196f3' }

data/lib/vedeu/cli/generator/templates/application/config/configuration.erb

@@ -1,7 +1,8 @@
 Vedeu.configure do
-  log         "/tmp/<%= object.name %>.log"
+  # base_path
 
-  colour_mode 16_777_216
+  # colour_mode 16_777_216 # Some terminals don't render colour at all if this
+                           # value is not one of 8, 16, 256 or 16777216.
 
   # debug! # Add "gem 'ruby-prof'" to your Gemfile if uncommenting this line.
   # drb!
@@ -13,6 +14,10 @@ Vedeu.configure do
   # cooked!
   # raw!
 
+  log         "/tmp/<%= object.name %>.log"
+
+  # renderers
+
   # run_once!
 
   # interactive!

data/lib/vedeu/configuration/configuration.rb

@@ -266,7 +266,7 @@ module Vedeu
         interactive:   true,
         log:           nil,
         once:          false,
-        renderers:     [Vedeu::Renderers::Terminal],
+        renderers:     [Vedeu::Renderers::Terminal.new],
         stdin:         nil,
         stdout:        nil,
         stderr:        nil,

data/lib/vedeu/output/border.rb

@@ -161,12 +161,6 @@ module Vedeu
       Vedeu::RenderBorder.with(self)
     end
 
-    # @return [String]
-    def to_s
-      Vedeu::Renderers::Text.render(render)
-    end
-    alias_method :to_str, :to_s
-
     private
 
     # @return [Vedeu::Geometry]

data/lib/vedeu/output/clear/named_interface.rb

@@ -66,8 +66,8 @@ module Vedeu
           @height = geometry.height
           @colour = interface.colour
 
-          @clear ||= Array.new(@width) do |iy|
-            Array.new(@height) do |ix|
+          @clear ||= Array.new(@height) do |iy|
+            Array.new(@width) do |ix|
               Vedeu::Char.new(value:    ' ',
                               colour:   @colour,
                               position: [@y + iy, @x + ix])

data/lib/vedeu/output/output.rb

@@ -1,24 +1,24 @@
 module Vedeu
 
-  # Sends the content to the renderers.
+  # Sends the output to the renderers.
   #
   # @api private
   class Output
 
-    # Writes content to the defined renderers.
+    # Writes output to the defined renderers.
     #
     # @return [Array|String]
     # @see #initialize
-    def self.render(content)
-      new(content).render
+    def self.render(output)
+      new(output).render
     end
 
     # Return a new instance of Vedeu::Output.
     #
-    # @param content [Array<Array<Vedeu::Char>>]
+    # @param output [Array<Array<Vedeu::Char>>]
     # @return [Output]
-    def initialize(content)
-      @content = content
+    def initialize(output)
+      @output = output
     end
 
     # Send the view to the renderers.
@@ -26,19 +26,19 @@ module Vedeu
     # @return [Array]
     def render
       if Vedeu::Configuration.drb?
-        Vedeu.trigger(:_drb_store_output_, content)
+        Vedeu.trigger(:_drb_store_output_, output)
 
-        Vedeu::Renderers::HTML.to_file(Vedeu::VirtualBuffer.retrieve)
+        # Vedeu::Renderers::HTML.to_file(Vedeu::VirtualBuffer.retrieve)
       end
 
-      Vedeu.renderers.render(content)
+      Vedeu.renderers.render(output)
     end
 
     protected
 
-    # @!attribute [r] content
+    # @!attribute [r] output
     # @return [Array<Array<Vedeu::Char>>]
-    attr_reader :content
+    attr_reader :output
 
   end # Output
 

data/lib/vedeu/output/render_border.rb

@@ -46,7 +46,7 @@ module Vedeu
     # Returns a new instance of Vedeu::RenderBorder.
     #
     # @param border [Vedeu::Border]
-    # @return [Vedeu::Renderers::Border]
+    # @return [Vedeu::RenderBorder]
     def initialize(border)
       @border = border
     end

data/lib/vedeu/output/renderers/all.rb

@@ -28,15 +28,18 @@ module Vedeu
     end
 
     # @example
-    #   Vedeu.renderers.render(*args)
+    #   Vedeu.renderers.render(output)
     #
+    # @api public
+    # @param output [void]
     # @return [Array<void>]
-    def render(*args)
+    def render(output)
       threads = storage.map do |renderer|
         Thread.new(renderer) do
           mutex.synchronize do
             Vedeu.log(type: :debug, message: "Rendering with: '#{renderer}'")
-            renderer.render(*args)
+
+            renderer.render(output)
           end
         end
       end
@@ -51,6 +54,7 @@ module Vedeu
     # @note
     #   A renderer class must respond to the '.render' class method.
     #
+    # @api public
     # @param renderers [Class]
     # @return [Set]
     def renderer(*renderers)
@@ -62,18 +66,19 @@ module Vedeu
     # @example
     #   Vedeu.renderers.reset
     #
+    # @api public
     # @return [Set]
     def reset
       @storage = Set.new
     end
 
+    private
+
     # @return [Set]
     def storage
       @storage ||= reset
     end
 
-    private
-
     # @return [Mutex]
     def mutex
       @mutex ||= Mutex.new

data/lib/vedeu/output/renderers/escape_sequence.rb

@@ -7,39 +7,37 @@ module Vedeu
     # @api private
     class EscapeSequence
 
-      # @param output [Array<Array<Vedeu::Char>>]
-      # @return [String]
-      def self.render(output)
-        new(output).render
-      end
-
       # Returns a new instance of Vedeu::Renderers::EscapeSequence.
       #
-      # @param output [Array<Array<Vedeu::Char>>]
-      def initialize(output)
-        @output = output
+      # @param options [Hash]
+      def initialize(options = {})
+        @options = options || {}
       end
 
+      # Render the output with the escape sequences escaped.
+      #
+      # @param output [Array<Array<Vedeu::Char>>]
       # @return [String]
-      def render
-        parsed
+      def render(output)
+        @parsed ||= Array(output).flatten.map do |char|
+          Esc.escape(char.to_s) + "\n"
+        end.join
       end
 
-      protected
-
-      # @!attribute [r] output
-      # @return [Array<Array<Vedeu::Char>>]
-      attr_reader :output
-
       private
 
-      # Escapes the escape sequences.
+      # Combines the options provided at instantiation with the default values.
       #
-      # @return [String]
-      def parsed
-        @parsed ||= Array(output).flatten.map do |char|
-          Esc.escape(char.to_s) + "\n"
-        end.join
+      # @return [Hash<Symbol => void>]
+      def options
+        defaults.merge!(@options)
+      end
+
+      # The default values for a new instance of this class.
+      #
+      # @return [Hash<Symbol => void>]
+      def defaults
+        {}
       end
 
     end # EscapeSequence

data/lib/vedeu/output/renderers/file.rb

@@ -7,46 +7,27 @@ module Vedeu
     # @api private
     class File
 
-      # @return [String]
-      # @see Vedeu::Renderers::File#initialize
-      def self.render(output, options = {})
-        new(output, options).render
-      end
-
       # Returns a new instance of Vedeu::Renderers::File.
       #
-      # @param output [String]
       # @param options [Hash]
       # @option options filename [String] Provide a filename for the output.
       #   Defaults to 'out'.
       # @option options timestamp [Boolean] Append a timestamp to the filename.
       # @return [Vedeu::Renderers::File]
-      def initialize(output, options = {})
-        @output  = output
-        @options = options
+      def initialize(options = {})
+        @options = options || {}
       end
 
+      # @param output [Array<Array<Vedeu::Char>>]
       # @return [String]
-      def render
-        ::File.open(path, 'w') { |f| f.write(parsed) }
+      def render(output)
+        ::File.write(filename, output) if write_file?
 
-        parsed
+        output
       end
 
-      protected
-
-      # @!attribute [r] output
-      # @return [String]
-      attr_reader :output
-      alias_method :parsed, :output
-
       private
 
-      # @return [String]
-      def path
-        "/tmp/#{filename}"
-      end
-
       # @return [String]
       def filename
         if timestamp?
@@ -70,6 +51,13 @@ module Vedeu
         false
       end
 
+      # @return [Boolean]
+      def write_file?
+        options[:write_file]
+      end
+
+      # Combines the options provided at instantiation with the default values.
+      #
       # @return [Hash]
       def options
         defaults.merge!(@options)
@@ -80,8 +68,9 @@ module Vedeu
       # @return [Hash]
       def defaults
         {
-          filename:  'out',
-          timestamp: false,
+          filename:   'out',
+          timestamp:  false,
+          write_file: true,
         }
       end
 

data/lib/vedeu/output/renderers/html.rb

@@ -5,51 +5,34 @@ module Vedeu
     # Renders a {Vedeu::VirtualBuffer} or {Vedeu::Output} as a HTML table.
     #
     # @api private
-    class HTML
-
-      # @param output [Array<Array<Vedeu::Char>>]
-      # @return [String]
-      def self.render(output)
-        new(output).to_file
-      end
-
-      # @param output [Array<Array<Vedeu::Char>>]
-      # @param path [String]
-      # @return [String]
-      def self.to_file(output, path = nil)
-        new(output).to_file(path)
-      end
+    class HTML < Vedeu::Renderers::File
 
       # Returns a new instance of Vedeu::Renderers::HTML.
       #
-      # @param output [Array<Array<Vedeu::Char>>]
+      # @param options [Hash]
       # @return [Vedeu::Renderers::HTML]
-      def initialize(output)
-        @output = output
+      def initialize(options = {})
+        @options = options || {}
       end
 
+      # @param output [Array<Array<Vedeu::Char>>]
       # @return [String]
-      def render
-        Vedeu::Template.parse(self, template)
-      end
+      def render(output)
+        @options[:content] = output
 
-      # Writes the parsed template to a file (at the given path) and returns the
-      # contents.
-      #
-      # @param path [String]
-      # @return [String]
-      def to_file(path = file_path)
-        content = render
+        if write_file?
+          super(Vedeu::Template.parse(self, template))
 
-        ::File.open(path, 'w') { |file| file.write(content) }
+        else
+          Vedeu::Template.parse(self, template)
 
-        content
+        end
       end
 
       # @return [String]
       def html_body
         out = ''
-        Array(output).each do |line|
+        Array(content).each do |line|
           out << "<tr>\n"
           line.each do |char|
             if char.is_a?(Vedeu::Char)
@@ -62,27 +45,38 @@ module Vedeu
         out
       end
 
-      protected
+      private
 
-      # @!attribute [r] output
       # @return [Array<Array<Vedeu::Char>>]
-      attr_reader :output
-
-      private
+      def content
+        options[:content]
+      end
 
       # @return [String]
       def template
-        ::File.dirname(__FILE__) + '/../templates/html_renderer.vedeu'
+        options[:template]
       end
 
-      # @return [String]
-      def file_path
-        "/tmp/vedeu_html_#{timestamp}.html"
+      # Combines the options provided at instantiation with the default values.
+      #
+      # @return [Hash<Symbol => void>]
+      def options
+        defaults.merge!(@options)
+      end
+
+      # The default values for a new instance of this class.
+      #
+      # @return [Hash<Symbol => void>]
+      def defaults
+        {
+          content:  '',
+          template: default_template,
+        }
       end
 
-      # return [Fixnum]
-      def timestamp
-        @timestamp ||= Time.now.to_i
+      # @return [String]
+      def default_template
+        ::File.dirname(__FILE__) + '/../templates/html_renderer.vedeu'
       end
 
     end # HTML