vedeu 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3bb700b808027ae0199e3f275aa59204c356e2c4
-  data.tar.gz: 269a2f124899846454acefe97fe50a95dc28ef8d
+  metadata.gz: 4c9a714b2238fa3c5bbdeeccef8713918b40f4f5
+  data.tar.gz: 2f3dd1b000581dacd7f007347333fc5bc6028701
 SHA512:
-  metadata.gz: 79c2059ccd86e0afdf0b4998bb4528ff5a9d0cdf9266583db8b8ae976f7a04c2079e3f362cf503f42e6193f32cbcd95a96edefe47ed9bb5f4fd051b76ad7bf8a
-  data.tar.gz: fc2a6a223a6e9a8b098d02b0c74f08d07d56a3ee0cef6870229ba87f1756d7075e393cd3eb8a409159afc3b8249ce64a1c298e997458000097a385cd033c40e1
+  metadata.gz: e823c499c813c68bf11108eaf1c96de24ec984aff02afa56d240ca00fae273698b51d08b04c9fd85f730a78f9b7e713459b70cecd7316d6affa8e183fd669efb
+  data.tar.gz: 2b92ab94bf23c05680545fdb6e3a2beccda9484809a82b416ef04354e74d6f13113e031c1077ba7c716407c5c1485717a7a0955192890e00152f508ce04134c8

data/docs/borders.md

@@ -5,8 +5,8 @@ The interfaces of Vedeu can each have their own border.
 
 - It has a name. This name associates it with an
   {file:docs/interface.md Interface}.
-- Each of its corners, the horizontal, and the vertical character can
-  be defined as different characters.
+- Each of its corners, the horizontal, and the vertical characters can
+  be defined as different characters, with custom colours and styles.
 - It can have a foreground and a background and style, independent of
   the interface to which it belongs.
 - Each of the sides of the border can be shown or hidden

data/examples/284_slow_rendering.rb

@@ -58,9 +58,9 @@ class EditorApp
     key(:enter) { Vedeu.trigger(:_editor_execute_, :editor_view) }
     key(:insert) do
       Vedeu.log(type:    :debug,
-                message: "Commands: #{Vedeu.all_commands.inspect}")
+                message: "Commands: #{Vedeu.all_commands.inspect}".freeze)
       Vedeu.log(type:    :debug,
-                message: "Keypresses: #{Vedeu.all_keypresses.inspect}")
+                message: "Keypresses: #{Vedeu.all_keypresses.inspect}".freeze)
     end
   end
 

data/examples/dsl_alignment.rb

@@ -100,55 +100,55 @@ class AlignmentApp
   Vedeu.render do
     view(:top_left_view) do
       lines do
-        line "top left"
+        line "top left".freeze
       end
     end
 
     view(:top_centre_view) do
       lines do
-        line "top centre"
+        line "top centre".freeze
       end
     end
 
     view(:top_right_view) do
       lines do
-        line "top right"
+        line "top right".freeze
       end
     end
 
     view(:middle_left_view) do
       lines do
-        line "middle left"
+        line "middle left".freeze
       end
     end
 
     view(:middle_centre_view) do
       lines do
-        line "middle centre"
+        line "middle centre".freeze
       end
     end
 
     view(:middle_right_view) do
       lines do
-        line "middle right"
+        line "middle right".freeze
       end
     end
 
     view(:bottom_left_view) do
       lines do
-        line "bottom left"
+        line "bottom left".freeze
       end
     end
 
     view(:bottom_centre_view) do
       lines do
-        line "bottom centre"
+        line "bottom centre".freeze
       end
     end
 
     view(:bottom_right_view) do
       lines do
-        line "bottom right"
+        line "bottom right".freeze
       end
     end
   end

data/examples/dsl_colours.rb

@@ -35,34 +35,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."
+        line "A line using interface colours.".freeze
         line ""
         line do
           stream do
-            text "Stream { "
-            text "background", background: '#001177'
-            text " }"
+            text "Stream { ".freeze
+            text "background".freeze, background: '#001177'
+            text " }".freeze
           end
         end
         line do
           stream do
-            text "Stream { "
-            text "foreground", foreground: '#aa00ff'
-            text " }"
+            text "Stream { ".freeze
+            text "foreground".freeze, foreground: '#aa00ff'
+            text " }".freeze
           end
         end
         line do
           stream do
-            text "Stream { "
-            text "background", background: '#117700'
-            text " }"
+            text "Stream { ".freeze
+            text "background".freeze, background: '#117700'
+            text " }".freeze
           end
         end
         line do
           stream do
-            text "Stream { "
-            text "foreground", foreground: '#00aaff'
-            text " }"
+            text "Stream { ".freeze
+            text "foreground".freeze, foreground: '#00aaff'
+            text " }".freeze
           end
         end
       end

data/examples/dsl_editor.rb

@@ -9,8 +9,8 @@ class EditorApp
 
   Vedeu.configure do
     debug!
-    log '/tmp/editor.log'
-    renderers Vedeu::Renderers::File.new(filename: '/tmp/editor.out')
+    log '/tmp/editor.log'.freeze
+    renderers Vedeu::Renderers::File.new(filename: '/tmp/editor.out'.freeze)
     fake!
   end
 
@@ -49,14 +49,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}")
+                message: "Commands: #{Vedeu.all_commands.inspect}".freeze)
       Vedeu.log(type:    :debug,
-                message: "Keypresses: #{Vedeu.all_keypresses.inspect}")
+                message: "Keypresses: #{Vedeu.all_keypresses.inspect}".freeze)
     end
   end
 
-  Vedeu.keymap '_global_' do
-    key('q') { Vedeu.exit }
+  Vedeu.keymap '_global_'.freeze do
+    key('q'.freeze) { Vedeu.exit }
   end
 
   Vedeu.render do
@@ -67,10 +67,10 @@ class EditorApp
   Vedeu.render do
     view(:help_view) do
       lines do
-        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.'
+        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
 
         # @todo Not implemented yet:
         #

data/lib/vedeu/borders/dsl.rb

@@ -110,6 +110,48 @@ module Vedeu
         model.enabled
       end
 
+      # 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
+      #
+      # @param char [String] Character to be used as the top
+      #   horizontal border character.
+      # @param options [Hash<Symbol => Hash<Symbol => String>|String|
+      #   Symbol]
+      # @option options colour [Hash<Symbol => String>]
+      # @option options style [String|Symbol]
+      # @return [String]
+      def top_horizontal(char, options = {})
+        model.top_horizontal = Vedeu::Cells::TopHorizontal
+          .new(attrs(char, options))
+      end
+      alias_method :top_horizontal=, :top_horizontal
+
+      # Set the character to be used to draw the bottom horizontal
+      # part of the border.
+      #
+      #   Vedeu.border :border_demo do
+      #     bottom_horizontal '-'
+      #     # ... some code
+      #   end
+      #
+      # @param char [String] Character to be used as the bottom
+      #   horizontal border character.
+      # @param options [Hash<Symbol => Hash<Symbol => String>|String|
+      #   Symbol]
+      # @option options colour [Hash<Symbol => String>]
+      # @option options style [String|Symbol]
+      # @return [String]
+      def bottom_horizontal(char, options = {})
+        model.bottom_horizontal = Vedeu::Cells::BottomHorizontal
+          .new(attrs(char, options))
+      end
+      alias_method :bottom_horizontal=, :bottom_horizontal
+
       # Set the character to be used to draw a horizontal part of the
       # border.
       #
@@ -350,6 +392,48 @@ module Vedeu
       end
       alias_method :top_right=, :top_right
 
+      # Set the character to be used to draw the left vertical part of
+      # the border.
+      #
+      #   Vedeu.border :border_demo do
+      #     left_vertical '|'
+      #     # ... some code
+      #   end
+      #
+      # @param char [String] Character to be used as the left vertical
+      #   border character.
+      # @param options [Hash<Symbol => Hash<Symbol => String>|String|
+      #   Symbol]
+      # @option options colour [Hash<Symbol => String>]
+      # @option options style [String|Symbol]
+      # @return [String]
+      def left_vertical(char, options = {})
+        model.left_vertical = Vedeu::Cells::LeftVertical
+          .new(attrs(char, options))
+      end
+      alias_method :left_vertical=, :left_vertical
+
+      # 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
+      #
+      # @param char [String] Character to be used as the right
+      #   vertical border character.
+      # @param options [Hash<Symbol => Hash<Symbol => String>|String|
+      #   Symbol]
+      # @option options colour [Hash<Symbol => String>]
+      # @option options style [String|Symbol]
+      # @return [String]
+      def right_vertical(char, options = {})
+        model.right_vertical = Vedeu::Cells::RightVertical
+          .new(attrs(char, options))
+      end
+      alias_method :right_vertical=, :right_vertical
+
       # Set the character to be used to draw a vertical part of the
       # border.
       #

data/lib/vedeu/buffers/empty.rb

@@ -2,7 +2,7 @@ module Vedeu
 
   module Buffers
 
-    # Provides a grid of Vedeu::Models::Cell objects at the given
+    # Provides a grid of Vedeu::Cells::Empty objects at the given
     # height and width.
     #
     # @api private
@@ -14,12 +14,12 @@ module Vedeu
       # @return [NilClass|String|Symbol]
       attr_reader :name
 
-      # @return [Array<Array<Vedeu::Models::Cell>>]
+      # @return [Array<Array<Vedeu::Cells::Empty>>]
       def buffer
         Array.new(height) do |y|
           if y > 0
             Array.new(width) do |x|
-              Vedeu::Models::Cell.new(name: name, position: [y, x]) if x > 0
+              Vedeu::Cells::Empty.new(name: name, position: [y, x]) if x > 0
             end.compact
           end
         end.compact

data/lib/vedeu/buffers/terminal.rb

@@ -87,7 +87,7 @@ module Vedeu
 
       private
 
-      # Return a grid of {Vedeu::Models::Cell} objects defined by the
+      # Return a grid of {Vedeu::Cells::Empty} objects defined by the
       # height and width of this virtual terminal.
       #
       # @return [Vedeu::Buffers::View]

data/lib/vedeu/buffers/view.rb

@@ -63,7 +63,7 @@ module Vedeu
                             width:  geometry.bordered_width).buffer
       end
 
-      # @return [Array<Vedeu::Models::Cell>]
+      # @return [Array<Vedeu::Cells::Empty>]
       def current
         @current ||= buffer
       end

data/lib/vedeu/cells/borders/all.rb

@@ -6,6 +6,7 @@ module Vedeu
 
 end # Vedeu
 
+require 'vedeu/cells/borders/corner'
 require 'vedeu/cells/borders/horizontal'
 require 'vedeu/cells/borders/bottom_horizontal'
 require 'vedeu/cells/borders/bottom_left'

data/lib/vedeu/cells/borders/bottom_left.rb

@@ -7,12 +7,7 @@ module Vedeu
     #
     # @api private
     #
-    class BottomLeft < Vedeu::Cells::Border
-
-      # @return [Vedeu::Geometries::Position]
-      def position
-        @position = defaults[:position]
-      end
+    class BottomLeft < Vedeu::Cells::Corner
 
       # @return [Symbol]
       def type

data/lib/vedeu/cells/borders/bottom_right.rb

@@ -7,12 +7,7 @@ module Vedeu
     #
     # @api private
     #
-    class BottomRight < Vedeu::Cells::Border
-
-      # @return [Vedeu::Geometries::Position]
-      def position
-        @position = defaults[:position]
-      end
+    class BottomRight < Vedeu::Cells::Corner
 
       # @return [Symbol]
       def type

data/lib/vedeu/cells/borders/corner.rb

@@ -0,0 +1,20 @@
+module Vedeu
+
+  module Cells
+
+    # Provides the position information to draw a border corner.
+    #
+    # @api private
+    #
+    class Corner < Vedeu::Cells::Border
+
+      # @return [Vedeu::Geometries::Position]
+      def position
+        @position = defaults[:position]
+      end
+
+    end # Corner
+
+  end # Cells
+
+end # Vedeu

data/lib/vedeu/cells/borders/top_left.rb

@@ -7,12 +7,7 @@ module Vedeu
     #
     # @api private
     #
-    class TopLeft < Vedeu::Cells::Border
-
-      # @return [Vedeu::Geometries::Position]
-      def position
-        @position = defaults[:position]
-      end
+    class TopLeft < Vedeu::Cells::Corner
 
       # @return [Symbol]
       def type

data/lib/vedeu/cells/borders/top_right.rb

@@ -7,12 +7,7 @@ module Vedeu
     #
     # @api private
     #
-    class TopRight < Vedeu::Cells::Border
-
-      # @return [Vedeu::Geometries::Position]
-      def position
-        @position = defaults[:position]
-      end
+    class TopRight < Vedeu::Cells::Corner
 
       # @return [Symbol]
       def type

data/lib/vedeu/cells/empty.rb

@@ -43,6 +43,28 @@ module Vedeu
       end
       alias_method :==, :eql?
 
+      # @return [Hash]
+      def to_hash
+        {
+          colour:   colour.to_s,
+          style:    style.to_s,
+          value:    value.to_s,
+          position: position.to_s,
+        }
+      end
+
+      # @param _options [Hash] Ignored.
+      # @return [String]
+      def to_html(_options = {})
+        ''
+      end
+
+      # @return [String]
+      def to_s
+        value.to_s
+      end
+      alias_method :to_str, :to_s
+
       private
 
       # @return [Hash<Symbol => Hash<void>|NilClass|String>]