vedeu 0.6.36 → 0.6.37

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3edf1e2bc88b118913301844f044fcd633e8833a
-  data.tar.gz: 4710cf6599d6e1a520f6298431ad7287475dfcf9
+  metadata.gz: 7fba735c3e10acba05e8b802dd3db76f2ebb06e0
+  data.tar.gz: 47bdfcbf57f2e69102f8a3fa489a4b88799a300f
 SHA512:
-  metadata.gz: 0747b79841c05ad9589bfb339e4999665fdf4ad82994a9be7ec566b99303053685665ded9548d9480366226f82206736348a81931916279e7b63037773977c1c
-  data.tar.gz: 5bece749f11c38671a4033d066dbe8efdc610be430232df65017256f978907225636d57a24c778331f1508cedc97e179e98c3f665adc34a85ee9ceadd61e2ada
+  metadata.gz: 828bab91908c976e8e19936576afee8b24ea4fed9ca4748d384bb547ed19edfafaf9f6e4dedd07eb1101f652875eb8ea164ac84621bae1307c7b5b42eaafe3e3
+  data.tar.gz: 4ed3df4d46e4983c3fa205bfbc586530b26096ce2ef561cc6509fa3d8b9dc82ec83f59e5c0195b95e48bb1a37c61e9a7c9c0172043f179833c69ea53edd1fb98

data/.codeclimate.yml

@@ -2,6 +2,6 @@ ratings:
   paths:
     - lib/**
 exclude_paths:
-  - "examples/**/*"
-  - "test/**/*"
-  - "vendor/**/*"
+  - "examples/*"
+  - "test/*"
+  - "vendor/*"

data/.yardopts

@@ -12,9 +12,11 @@ docs/events.md
 docs/geometry.md
 docs/getting_started.md
 docs/group.md
+docs/input.md
 docs/interfaces.md
 docs/keymaps.md
 docs/object_graph.md
+docs/output.md
 docs/view.md
 docs/events/application.md
 docs/events/document.md

data/bin/vedeu_drb_server

@@ -64,7 +64,6 @@ class VedeuTestApplication
   end
 
   Vedeu.geometry :test_interface do
-    # centred!
     height 6
     width  26
     x      4

data/docs/api.md

@@ -67,12 +67,16 @@ See {file:docs/events.md}
   - focus!
   - foreground
   - geometry
-    - alignment
+    - align
     - align_left
     - align_center
     - align_centre
     - align_right
-    - centred (or centred!)
+    - align_top
+    - align_middle
+    - align_bottom
+    - horizontal_alignment
+    - vertical_alignment
     - height
     - width
     - x

data/docs/cell.md

@@ -0,0 +1,9 @@
+# @title Vedeu Cells
+# Vedeu Cells
+
+- A cell represents a single character in the visible terminal space.
+  We could use {file:docs/chars.md Characters} for this, but sometimes
+  a character is empty, and only has a colour and/or style.
+- Cells also represent individual terminal escape sequences. Although
+  most are not visible, in order to correctly render a TTY, they are
+  used.

data/docs/chars.md

@@ -0,0 +1,7 @@
+# @title Vedeu Characters
+# Vedeu Characters
+
+- Characters can have their own background, foreground and styles. See
+  {file:docs/colours_styles.md Colours & Styles} for more details.
+- The character is a fundamental building block of a terminal
+  {file:docs/cell.md Cell}.

data/docs/colours_styles.md

@@ -0,0 +1,8 @@
+# @title Vedeu Colours & Styles
+# Vedeu Colours & Styles
+
+- A colour is made up of a Background and a Foreground.
+
+## Vedeu Background Colours
+
+## Vedeu Foreground Colours

data/docs/dsl.md

@@ -109,11 +109,15 @@ end
 
 ### Setting the interface dimensions
 
-{include:Vedeu::Geometry::DSL#alignment}
+{include:Vedeu::Geometry::DSL#align}
 {include:Vedeu::Geometry::DSL#align_left}
 {include:Vedeu::Geometry::DSL#align_centre}
 {include:Vedeu::Geometry::DSL#align_right}
-{include:Vedeu::Geometry::DSL#centred}
+{include:Vedeu::Geometry::DSL#align_top}
+{include:Vedeu::Geometry::DSL#align_middle}
+{include:Vedeu::Geometry::DSL#align_bottom}
+{include:Vedeu::Geometry::DSL#horizontal_alignment}
+{include:Vedeu::Geometry::DSL#vertical_alignment}
 {include:Vedeu::Geometry::DSL#height}
 {include:Vedeu::Geometry::DSL#width}
 {include:Vedeu::Geometry::DSL#columns}

data/docs/input.md

@@ -0,0 +1,98 @@
+# @title Vedeu Input
+# Vedeu Input
+
+A configured and running client application using Vedeu will spend the
+majority of its time waiting for input from the terminal by the user.
+
+Input in to Vedeu is essentially characters derived from a keypress or
+keypresses, and throughout this document, 'characters' and
+'keypresses' may be used interchangably to mean 'input'.
+
+* It should be noted that data can be also be 'piped' into a Vedeu
+application as input, though at this time, this is not the mode du
+jour.
+
+The input received by Vedeu is handled in one of three ways, depending
+on which mode Vedeu has been configured to use;
+'{file:docs/input.md#label-Raw+Mode raw}' (default),
+'{file:docs/input.md#label-Cooked+Mode cooked}' or
+'{file:docs/input.md#label-Fake+Mode fake}'. See below for details of
+each.
+
+* Vedeu uses Ruby's 'IO/Console' from the standard library to
+facilitate this. For more information relating to this area, consult
+the Ruby documentation, or the 'stty(1)' or 'termios(3)' manpages.
+
+## Raw Mode
+
+This is the default mode for Vedeu. Keypresses or characters are not
+processed by the underlying terminal, but instead sent directly to
+Vedeu to be handled.
+
+    Vedeu.configure do
+      terminal_mode :raw
+
+      # or...
+
+      raw!
+
+      # ...more configuration here
+    end
+
+This mode is generally used to perform an operation dependent on the
+key which was pressed. The configuration of mapping keypresses to
+actions is handled on a per-interface basis; each interface having its
+own keymap which can perform specific actions.
+
+There is also global keymap available to handle certain keypresses
+application-wide, ie. irrespective of the interface or view which is
+currently in focus. The global keymap would specify the keypress
+needed to exit the application, for example.
+
+See {file:docs/keymaps.md Keymaps} for more information.
+
+## Cooked Mode
+
+Here, the input from the user is stored in an internal buffer by the
+terminal itself until a line-feed or carriage-return character is
+encountered. The terminal then sends this stream of characters to
+Vedeu to be processed.
+
+    Vedeu.configure do
+      terminal_mode :cooked
+
+      # or...
+
+      cooked!
+
+      # ...more configuration here
+    end
+
+## Fake Mode
+
+Whilst technically the terminal will be in raw mode, with the 'fake'
+mode, Vedeu attempts to simulate cooked mode but with some additional
+functionality. To do this, Vedeu creates an internal buffer for
+characters resulting from keypresses to be either stored or processed
+immediately.
+
+    Vedeu.configure do
+      terminal_mode :fake
+
+      # or...
+
+      fake!
+
+      # ...more configuration here
+    end
+
+## Mode Switching
+
+During the lifecycle of a Vedeu client application it may be necessary
+to switch between the different modes offered. This is handled by
+triggering the `:\_mode_switch\_` event. By default, this cycles
+through the available modes. When an optional but valid target mode is
+given, that mode will be activated instead.
+
+    Vedeu.trigger(:_mode_switch_, mode) # Valid values for mode are
+                                        # :raw, :cooked or :fake

data/docs/lines.md

@@ -0,0 +1,8 @@
+# @title Vedeu Lines
+# Vedeu Lines
+
+- Lines can have their own background, foreground and styles. See
+  {file:docs/colours_styles.md Colours & Styles} for more details.
+- A line can also be made up of {file:docs/streams.md Streams}.
+- Lines or streams are made up of {file:docs/chars.md Characters}
+

data/docs/output.md

@@ -0,0 +1,2 @@
+# @title Vedeu Output
+# Vedeu Output

data/docs/streams.md

@@ -0,0 +1,6 @@
+# @title Vedeu Streams
+# Vedeu Streams
+
+- Streams can have their own background, foreground and styles. See
+  {file:docs/colours_styles.md Colours & Styles} for more details.
+- A stream is made up of {file:docs/chars.md Characters}.

data/docs/template.md

@@ -0,0 +1,3 @@
+# @title Vedeu View Templates
+# Vedeu View Templates
+

data/docs/view.md

@@ -6,12 +6,9 @@ course) view. This view will contain that which is visible within the
 interface and is determined by the position of the cursor associated
 with the interface.
 
-- A view is made up of lines, made up of characters.
-- Lines can have their own background, foreground and styles.
-- A line can also be made up of streams, a stream itself having its
-  own background, foreground and styles.
-- Lines and streams are made up of characters- again, each with their
-  own background, foreground and styles.
+- A view is made up of {file:docs/lines.md Lines}.
+- A view can also be derived from a
+  {file:docs/templates.md View Template}.
 
 Views can be requested to be drawn immediately on construction, or
 added to a {file:docs/buffer.md Buffer}.

data/examples/dsl_demo_groups.rb

@@ -83,16 +83,24 @@ class DemoGroupsApp
 
   Vedeu.views do
     view(:apple) do
-      line 'apple'
+      lines do
+        line 'apple'
+      end
     end
     view(:banana) do
-      line 'banana'
+      lines do
+        line 'banana'
+      end
     end
     view(:carrot) do
-      line 'carrot'
+      lines do
+        line 'carrot'
+      end
     end
     view(:dill) do
-      line 'dill'
+      lines do
+        line 'dill'
+      end
     end
   end
 

data/examples/dsl_hello_worlds.rb

@@ -27,9 +27,7 @@ class HelloWorldsApp
     background '#000000'
     foreground '#00ff00'
     geometry do
-      centred!
-      height   5
-      width    24
+      align(:middle, :centre, 24, 5)
     end
     # (You usually specify the views outside the interface block).
     Vedeu.views do
@@ -59,9 +57,7 @@ class HelloWorldsApp
     Vedeu.render do
       view :hello do
         geometry do
-          centred!
-          height  5 + 2
-          width   24 + 2
+          align(:middle, :centre, (24 + 2), (5 + 2))
         end
         border do
           colour foreground: ["#00ff00", "#000033", "#cddc39", "#03a9f4"].sample

data/lib/vedeu/distributed/templates/default_geometries.vedeu

@@ -1,5 +1,4 @@
 Vedeu.geometry :test_interface do
-  # centred!
   height 6
   width  26
   x      4

data/lib/vedeu/dsl/view.rb

@@ -17,7 +17,6 @@ module Vedeu
     #
     #   Vedeu.interface :main do
     #     geometry do
-    #       centred!
     #       height 4
     #       width  50
     #     end

data/lib/vedeu/geometry/alignment.rb

@@ -18,6 +18,21 @@ module Vedeu
         new(value).align
       end
 
+      # @param value [NilClass|Symbol|Vedeu::Geometry::Alignment]
+      # @return [Vedeu::Geometry::Alignment]
+      def self.coerce(value = nil)
+        if value.is_a?(self)
+          value
+
+        elsif value.is_a?(Symbol)
+          new(value)
+
+        else
+          new(:none)
+
+        end
+      end
+
       # @param value [NilClass|Symbol]
       # @return [Vedeu::Geometry::Alignment]
       def initialize(value = nil)
@@ -30,11 +45,60 @@ module Vedeu
         fail Vedeu::Error::NotImplemented, 'Subclasses implement this.'.freeze
       end
 
+      # Return a boolean indicating alignment was set to :bottom.
+      #
+      # @return [Boolean]
+      def bottom_aligned?
+        value == :bottom
+      end
+
+      # Return a boolean indicating alignment was set to :centre.
+      #
+      # @return [Boolean]
+      def centre_aligned?
+        value == :centre
+      end
+
+      # Return a boolean indicating alignment was set to :left.
+      #
+      # @return [Boolean]
+      def left_aligned?
+        value == :left
+      end
+
+      # Return a boolean indicating alignment was set to :middle.
+      #
+      # @return [Boolean]
+      def middle_aligned?
+        value == :middle
+      end
+
+      # Return a boolean indicating alignment was set to :right.
+      #
+      # @return [Boolean]
+      def right_aligned?
+        value == :right
+      end
+
+      # Return a boolean indicating alignment was set to :top.
+      #
+      # @return [Boolean]
+      def top_aligned?
+        value == :top
+      end
+
+      # Return a boolean indicating alignment was set to, or is :none.
+      #
+      # @return [Boolean]
+      def unaligned?
+        value == :none
+      end
+
       private
 
       # @return [Boolean]
       def none?
-        @value.nil? || !(@value.is_a?(Symbol))
+        @value == :none || @value.nil? || !(@value.is_a?(Symbol))
       end
 
       # @return [Boolean]

data/lib/vedeu/geometry/area.rb

@@ -40,28 +40,23 @@ module Vedeu
       # @option attributes x_xn [Fixnum]
       # @option attributes x_default [Fixnum]
       # @option attributes maximised [Boolean]
-      # @option attributes centred [Boolean]
       # @option attributes horizontal_alignment [Symbol]
       # @option attributes vertical_alignment [Symbol]
       # @return [Vedeu::Geometry::Area]
       def self.from_attributes(attributes = {})
         y_attributes = {
-          d:                  attributes[:y],
-          dn:                 attributes[:yn],
-          d_dn:               attributes[:y_yn],
-          default:            Vedeu.height,
-          maximised:          attributes[:maximised],
-          centred:            attributes[:centred],
-          vertical_alignment: attributes[:vertical_alignment],
+          d:         attributes[:y],
+          dn:        attributes[:yn],
+          d_dn:      attributes[:y_yn],
+          maximised: attributes[:maximised],
+          alignment: attributes[:vertical_alignment],
         }
         x_attributes = {
-          d:                    attributes[:x],
-          dn:                   attributes[:xn],
-          d_dn:                 attributes[:x_xn],
-          default:              Vedeu.width,
-          maximised:            attributes[:maximised],
-          centred:              attributes[:centred],
-          horizontal_alignment: attributes[:horizontal_alignment],
+          d:         attributes[:x],
+          dn:        attributes[:xn],
+          d_dn:      attributes[:x_xn],
+          maximised: attributes[:maximised],
+          alignment: attributes[:horizontal_alignment],
         }
         y_yn = Vedeu::Geometry::YDimension.pair(y_attributes)
         x_xn = Vedeu::Geometry::XDimension.pair(x_attributes)