vedeu 0.8.0 → 0.8.1

data/docs/dsl/by_method/refresh.md

@@ -0,0 +1,3 @@
+Send the cells to the renderer and return the rendered result.
+
+    Vedeu.refresh

data/docs/dsl/by_method/resize.md

@@ -0,0 +1,5 @@
+When the terminal emit the 'SIGWINCH' signal, Vedeu can intercept this
+and attempt to redraw the current interface with varying degrees of
+success. Can also be used to simulate a terminal resize.
+
+    Vedeu.resize

data/docs/dsl/by_method/right.md

@@ -0,0 +1,10 @@
+Enable/disable the right border.
+
+    Vedeu.border :border_demo do
+      right true  # or...
+      right false # or...
+      hide_right! # or...
+      show_right!
+      # ... some code
+    end
+

data/docs/dsl/by_method/right_vertical.md

@@ -0,0 +1,8 @@
+Set the character to be used to draw the right vertical part
+of the border.
+
+    Vedeu.border :border_demo do
+      right_vertical '|'
+      # ... some code
+    end
+

data/docs/dsl/by_method/timer.md

@@ -0,0 +1,12 @@
+Measure the execution time of the code in the given block.
+
+The optional message provided will have ' took <time>ms.' appended and
+will appear in the log file if the 'debug!' Vedeu configuration option
+was given.
+
+    Vedeu.timer 'Really complex code' do
+      # ... code to be measured
+    end
+
+    # => 'Really complex code took 0.234ms.'
+

data/docs/dsl/by_method/title.md

@@ -0,0 +1,12 @@
+If you have you are showing a top border, you could add a
+title.
+
+    Vedeu.border :border_demo do
+      title 'My Cool Title'
+      # ... some code
+    end
+
+produces, depending on other customisations:
+
+    +- My Cool Title --------------------------------+
+

data/docs/dsl/by_method/top.md

@@ -0,0 +1,10 @@
+Enable/disable the top border.
+
+    Vedeu.border :border_demo do
+      top true  # or...
+      top false # or...
+      hide_top! # or...
+      show_top!
+      # ... some code
+    end
+

data/docs/dsl/by_method/top_horizontal.md

@@ -0,0 +1,8 @@
+Set the character to be used to draw the top horizontal part
+of the border.
+
+    Vedeu.border :border_demo do
+      top_horizontal '-'
+      # ... some code
+    end
+

data/docs/dsl/by_method/top_left.md

@@ -0,0 +1,8 @@
+Set the character to be used to draw the top left corner of
+the border.
+
+    Vedeu.border :border_demo do
+      top_left '+'
+      # ... some code
+    end
+

data/docs/dsl/by_method/top_right.md

@@ -0,0 +1,8 @@
+Set the character to be used to draw the top right corner of
+the border.
+
+    Vedeu.border :border_demo do
+      top_right '+'
+      # ... some code
+    end
+

data/docs/dsl/by_method/vertical.md

@@ -0,0 +1,7 @@
+Set the character to be used to draw a vertical part of the border.
+
+    Vedeu.border :border_demo do
+      vertical '|'
+
+      # ... some code
+    end

data/docs/dsl/by_method/width.md

@@ -0,0 +1,7 @@
+Returns the total width (number of columns/characters) of the
+current terminal.
+
+    Vedeu.width # => provides the width via the Vedeu API.
+
+See {Vedeu::Terminal#size} for more information about the reported
+terminal size.

data/examples/284_slow_rendering.rb

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+# frozen_string_literal: true
+
 require 'bundler/setup'
 require 'vedeu'
 
@@ -10,7 +12,8 @@ class EditorApp
   Vedeu.configure do
     debug!
     log '/tmp/284_slow_rendering.log'
-    # renderers Vedeu::Renderers::File.new(filename: '/tmp/284_slow.out')
+    # renderers(Vedeu::Renderers::Terminal.new,
+    #           Vedeu::Renderers::File.new(filename: '/tmp/284_slow.out'))
     fake!
   end
 
@@ -58,9 +61,9 @@ class EditorApp
     key(:enter) { Vedeu.trigger(:_editor_execute_, :editor_view) }
     key(:insert) do
       Vedeu.log(type:    :debug,
-                message: "Commands: #{Vedeu.all_commands.inspect}".freeze)
+                message: "Commands: #{Vedeu.all_commands.inspect}")
       Vedeu.log(type:    :debug,
-                message: "Keypresses: #{Vedeu.all_keypresses.inspect}".freeze)
+                message: "Keypresses: #{Vedeu.all_keypresses.inspect}")
     end
   end
 

data/examples/dsl_alignment.rb

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+# frozen_string_literal: true
+
 require 'bundler/setup'
 require 'vedeu'
 
@@ -8,8 +10,12 @@ class AlignmentApp
   Vedeu.bind(:_initialize_) { Vedeu.trigger(:_refresh_) }
 
   Vedeu.configure do
+    debug!
     log '/tmp/alignment.log'
-    renderers Vedeu::Renderers::File.new(filename: '/tmp/alignment.out')
+    renderers(Vedeu::Renderers::Terminal.new,
+              Vedeu::Renderers::File.new(filename: '/tmp/alignment.out'))
+    run_once!
+    standalone!
   end
 
   Vedeu.interface :top_left_view do
@@ -93,62 +99,58 @@ class AlignmentApp
     end
   end
 
-  Vedeu.keymap '_global_' do
-    key('q') { Vedeu.exit }
-  end
-
   Vedeu.render do
     view(:top_left_view) do
       lines do
-        line "top left".freeze
+        line "top left"
       end
     end
 
     view(:top_centre_view) do
       lines do
-        line "top centre".freeze
+        line "top centre"
       end
     end
 
     view(:top_right_view) do
       lines do
-        line "top right".freeze
+        line "top right"
       end
     end
 
     view(:middle_left_view) do
       lines do
-        line "middle left".freeze
+        line "middle left"
       end
     end
 
     view(:middle_centre_view) do
       lines do
-        line "middle centre".freeze
+        line "middle centre"
       end
     end
 
     view(:middle_right_view) do
       lines do
-        line "middle right".freeze
+        line "middle right"
       end
     end
 
     view(:bottom_left_view) do
       lines do
-        line "bottom left".freeze
+        line "bottom left"
       end
     end
 
     view(:bottom_centre_view) do
       lines do
-        line "bottom centre".freeze
+        line "bottom centre"
       end
     end
 
     view(:bottom_right_view) do
       lines do
-        line "bottom right".freeze
+        line "bottom right"
       end
     end
   end

data/examples/dsl_colours.rb

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+# frozen_string_literal: true
+
 require 'bundler/setup'
 require 'vedeu'
 
@@ -10,7 +12,8 @@ class ColoursApp
   Vedeu.configure do
     debug!
     log '/tmp/colours.log'
-    renderers Vedeu::Renderers::File.new(filename: '/tmp/colours.out')
+    renderers(Vedeu::Renderers::Terminal.new,
+              Vedeu::Renderers::File.new(filename: '/tmp/colours.out'))
   end
 
   Vedeu.interface :interface_colours_view do
@@ -35,34 +38,34 @@ class ColoursApp
       # line "test" - does not work, (wrong number of args for lines dsl/view.rb:240)
 
       lines do
-        line "A line using interface colours.".freeze
+        line "A line using interface colours."
         line ""
         line do
           stream do
-            text "Stream { ".freeze
-            text "background".freeze, background: '#001177'
-            text " }".freeze
+            text "Stream { "
+            text "background", background: '#001177'
+            text " }"
           end
         end
         line do
           stream do
-            text "Stream { ".freeze
-            text "foreground".freeze, foreground: '#aa00ff'
-            text " }".freeze
+            text "Stream { "
+            text "foreground", foreground: '#aa00ff'
+            text " }"
           end
         end
         line do
           stream do
-            text "Stream { ".freeze
-            text "background".freeze, background: '#117700'
-            text " }".freeze
+            text "Stream { "
+            text "background", background: '#117700'
+            text " }"
           end
         end
         line do
           stream do
-            text "Stream { ".freeze
-            text "foreground".freeze, foreground: '#00aaff'
-            text " }".freeze
+            text "Stream { "
+            text "foreground", foreground: '#00aaff'
+            text " }"
           end
         end
       end

data/examples/dsl_demo_groups.rb

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+# frozen_string_literal: true
+
 require 'bundler/setup'
 require 'vedeu'
 
@@ -15,6 +17,7 @@ class DemoGroupsApp
   }
 
   Vedeu.configure do
+    debug!
     log '/tmp/demo_groups.log'
   end
 

data/examples/dsl_editor.rb

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+# frozen_string_literal: true
+
 require 'bundler/setup'
 require 'vedeu'
 
@@ -9,8 +11,9 @@ class EditorApp
 
   Vedeu.configure do
     debug!
-    log '/tmp/editor.log'.freeze
-    renderers Vedeu::Renderers::File.new(filename: '/tmp/editor.out'.freeze)
+    log '/tmp/editor.log'
+    renderers(Vedeu::Renderers::Terminal.new,
+              Vedeu::Renderers::File.new(filename: '/tmp/editor.out'))
     fake!
   end
 
@@ -49,14 +52,14 @@ class EditorApp
     key(:enter)  { Vedeu.trigger(:_editor_insert_line_, :editor_view) }
     key(:insert) do
       Vedeu.log(type:    :debug,
-                message: "Commands: #{Vedeu.all_commands.inspect}".freeze)
+                message: "Commands: #{Vedeu.all_commands.inspect}")
       Vedeu.log(type:    :debug,
-                message: "Keypresses: #{Vedeu.all_keypresses.inspect}".freeze)
+                message: "Keypresses: #{Vedeu.all_keypresses.inspect}")
     end
   end
 
-  Vedeu.keymap '_global_'.freeze do
-    key('q'.freeze) { Vedeu.exit }
+  Vedeu.keymap '_global_' do
+    key('q') { Vedeu.exit }
   end
 
   Vedeu.render do
@@ -67,10 +70,10 @@ class EditorApp
   Vedeu.render do
     view(:help_view) do
       lines do
-        line 'Type into the editor dialog above,'.freeze
-        line 'and press Escape. This will trigger the'.freeze
-        line ':command event with the contents of '.freeze
-        line 'the view.'.freeze
+        line 'Type into the editor dialog above,'
+        line 'and press Escape. This will trigger the'
+        line ':command event with the contents of '
+        line 'the view.'
 
         # @todo Not implemented yet:
         #

data/examples/dsl_hello_worlds.rb

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+# frozen_string_literal: true
+
 require 'bundler/setup'
 require 'vedeu'
 

data/examples/dsl_horizontal_alignment.rb

@@ -1,5 +1,7 @@
 #!/usr/bin/env ruby
 
+# frozen_string_literal: true
+
 require 'bundler/setup'
 require 'vedeu'
 
@@ -18,19 +20,6 @@ class HorizontalAlignmentApp
     geometry_stats(:right_interface)
   end
 
-  def self.border_stats(name)
-    Vedeu.borders.by_name(name)
-  end
-  def self.bl
-    border_stats(:left_interface)
-  end
-  def self.bc
-    border_stats(:centre_interface)
-  end
-  def self.br
-    border_stats(:right_interface)
-  end
-
   class CentreHorizontalAlignmentView
     def render
       Vedeu.render do
@@ -39,8 +28,8 @@ class HorizontalAlignmentApp
             line "x:#{gc.x}, xn:#{gc.xn} (w:#{gc.width})"
             line "y:#{gc.y}, yn:#{gc.yn} (h:#{gc.height})"
             line ""
-            line "bx:#{bc.bx}, bxn:#{bc.bxn} (bw:#{bc.width})"
-            line "by:#{bc.by}, byn:#{bc.byn} (bh:#{bc.height})"
+            line "bx:#{gc.bx}, bxn:#{gc.bxn} (bw:#{gc.width})"
+            line "by:#{gc.by}, byn:#{gc.byn} (bh:#{gc.height})"
             line ""
             line "The 'h', 'j', 'k' and 'l' keys will"
             line "move this view left, down, up, and"
@@ -55,17 +44,15 @@ class HorizontalAlignmentApp
     def gc
       Vedeu.geometries.by_name(:centre_interface)
     end
-
-    def bc
-      Vedeu.borders.by_name(:centre_interface)
-    end
   end
 
   Vedeu.bind(:_initialize_) { Vedeu.trigger(:_refresh_) }
 
   Vedeu.configure do
-    log '/tmp/horizontal_alignment.log'
-    renderers Vedeu::Renderers::File.new(filename: '/tmp/horizontal_alignment.out')
+    debug!
+    log '/tmp/vedeu_horizontal.log'
+    renderers(Vedeu::Renderers::Terminal.new,
+              Vedeu::Renderers::File.new(filename: '/tmp/vedeu_horizontal.out'))
   end
 
   Vedeu.interface :left_interface do
@@ -150,8 +137,8 @@ class HorizontalAlignmentApp
         line "x:#{gl.x}, xn:#{gl.xn} (w:#{gl.width})"
         line "y:#{gl.y}, yn:#{gl.yn} (h:#{gl.height})"
         line ""
-        line "bx:#{bl.bx}, bxn:#{bl.bxn} (bw:#{bl.width})"
-        line "by:#{bl.by}, byn:#{bl.byn} (bh:#{bl.height})"
+        line "bx:#{gl.bx}, bxn:#{gl.bxn} (bw:#{gl.width})"
+        line "by:#{gl.by}, byn:#{gl.byn} (bh:#{gl.height})"
       end
     end
 
@@ -160,8 +147,8 @@ class HorizontalAlignmentApp
         line "x:#{gc.x}, xn:#{gc.xn} (w:#{gc.width})"
         line "y:#{gc.y}, yn:#{gc.yn} (h:#{gc.height})"
         line ""
-        line "bx:#{bc.bx}, bxn:#{bc.bxn} (bw:#{bc.width})"
-        line "by:#{bc.by}, byn:#{bc.byn} (bh:#{bc.height})"
+        line "bx:#{gc.bx}, bxn:#{gc.bxn} (bw:#{gc.width})"
+        line "by:#{gc.by}, byn:#{gc.byn} (bh:#{gc.height})"
         line ""
         line "The 'h', 'j', 'k' and 'l' keys will"
         line "move this view left, down, up, and"
@@ -177,8 +164,8 @@ class HorizontalAlignmentApp
         line "x:#{gr.x}, xn:#{gr.xn} (w:#{gr.width})"
         line "y:#{gr.y}, yn:#{gr.yn} (h:#{gr.height})"
         line ""
-        line "bx:#{br.bx}, bxn:#{br.bxn} (bw:#{br.width})"
-        line "by:#{br.by}, byn:#{br.byn} (bh:#{br.height})"
+        line "bx:#{gr.bx}, bxn:#{gr.bxn} (bw:#{gr.width})"
+        line "by:#{gr.by}, byn:#{gr.byn} (bh:#{gr.height})"
       end
     end
   end