vedeu 0.5.9 → 0.5.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d9f471ab14ab7f5b69de2e0b0c250002f3f1775a
-  data.tar.gz: 471ca4b7ef85a507cf71c0fa64e11844e464f7b0
+  metadata.gz: 1096fd3f0f65d843b0f6f92e4b70a721570f15da
+  data.tar.gz: 808dc9b634727f33c20aa32712e2d6066c759b4d
 SHA512:
-  metadata.gz: 9e68cd9602da230d9b4c38efabaa2c8368d0e2659b6e3d1cbdf2a64522d81d5b5373b48c92ab9e9a86e6631b5fffedadaf1fecc7e3d8f5fc7795b98c4bd9f9db
-  data.tar.gz: d7981f0948f3d7b0521d5cac304deee8f7282601a4c5d71961cd76381e5be7e2c569499292872d5fd94c2c45013c939871584f5e017c6667c8fbed5d2409dc1b
+  metadata.gz: 8cd549653f68705952718d30bd75d653cb17215dd2c30cd7fdbc407e933bb1a831f19f74da3e567c8fa4d610a93f2f93cf9a1ebf4c377a0b468816b8159d0fc9
+  data.tar.gz: 328c6e794c5387531e94a13bc3be5b30facb61697cd531fed4481214b8b56016b3c8aa7e96ec95182319a0577c63af1e96e12b23a344fd38cc4b53f205ae829f

data/examples/material_colours_app.rb

@@ -33,6 +33,7 @@ class VedeuMaterialColoursApp
     border 'main_interface' do
       colour foreground: '#ffffff', background: :default
       title 'Rainbow!'
+      caption('Unicorns!')
     end
     colour foreground: '#ffffff', background: :default
     cursor!
@@ -53,6 +54,7 @@ class VedeuMaterialColoursApp
     border 'other_interface' do
       colour(foreground: '#ffffff', background: :default)
       title('Wow!')
+      caption('Shiny!')
       horizontal('-')
       top_right('+')
       top_left('+')

data/lib/vedeu/bindings/drb.rb

@@ -31,12 +31,14 @@ module Vedeu
       #   Vedeu.trigger(:_drb_input_, data, type)
       #
       # @return [TrueClass]
+      # @see Vedeu::Distributed::Server#input
       def drb_input!
         Vedeu.bind(:_drb_input_) do |data, type|
           Vedeu.log(type: :drb, message: "Sending input (#{type})")
 
           case type
-          when :command then Vedeu.trigger(:_command_, data)
+          when :command  then Vedeu.trigger(:_command_, data)
+          when :keypress then Vedeu.trigger(:_keypress_, data)
           else Vedeu.trigger(:_keypress_, data)
           end
         end

data/lib/vedeu/borders/border.rb

@@ -59,6 +59,10 @@ module Vedeu
     attr_accessor :show_top
     alias_method :top?, :show_top
 
+    # @!attribute [rw] caption
+    # @return [String]
+    attr_accessor :caption
+
     # @!attribute [rw] title
     # @return [String]
     attr_accessor :title
@@ -105,8 +109,10 @@ module Vedeu
     #   is to be shown.
     # @option attributes show_top [Boolean] Indicate whether the top border is
     #   to be shown.
-    # @option attributes title [String] A title bar for when the top border is
-    #   to be shown.
+    # @option attributes title [String] An optional title for when the top
+    #   border is to be shown.
+    # @option attributes caption [String] An optional caption for when the
+    #   bottom border is to be shown.
     # @option attributes top_left [String] The top left border character.
     # @option attributes top_right [String] The top right border character.
     # @option attributes vertical [String] The vertical border character.
@@ -179,6 +185,7 @@ module Vedeu
       {
         bottom_left:  Vedeu::EscapeSequences::Borders.bottom_left,
         bottom_right: Vedeu::EscapeSequences::Borders.bottom_right,
+        caption:      '',
         client:       nil,
         colour:       nil,
         enabled:      false,

data/lib/vedeu/borders/render_border.rb

@@ -15,6 +15,7 @@ module Vedeu
                    :bxn,
                    :by,
                    :byn,
+                   :caption,
                    :colour,
                    :enabled?,
                    :height,
@@ -117,11 +118,16 @@ module Vedeu
 
     # Renders the bottom border for the interface.
     #
+    # @note
+    #   If a caption has been specified, then the bottom border will include
+    #   this caption unless the size of the interface is smaller than the padded
+    #   caption length.
+    #
     # @return [String]
     def bottom
       return [] unless bottom?
 
-      [build_bottom_left, build_bottom, build_bottom_right].compact
+      [build_bottom_left, captionbar, build_bottom_right].compact
     end
 
     # @return [Vedeu::Geometry]
@@ -180,8 +186,27 @@ module Vedeu
       [build_top_left, titlebar, build_top_right].compact
     end
 
-    # From the second element of {#title_characters} remove the border from each
-    # {#build_horizontal} Vedeu::Views::Char, and add the title character.
+    # Overwrite the border from {#build_horizontal} on the bottom border to
+    # include the caption if given.
+    #
+    # @return [Array<Vedeu::Views::Char>]
+    def captionbar
+      return build_bottom unless caption? && caption_fits?
+
+      caption_starts_at = (width - caption_characters.size) - 2
+
+      caption_char = 0
+      build_bottom.each_with_index do |char, index|
+        next if index <= caption_starts_at || index > (width - 2)
+
+        char.border  = nil
+        char.value   = caption_characters[caption_char]
+        caption_char += 1
+      end
+    end
+
+    # Overwrite the border from {#build_horizontal} on the top border to
+    # include the title if given.
     #
     # @return [Array<Vedeu::Views::Char>]
     def titlebar
@@ -202,6 +227,13 @@ module Vedeu
       present?(title)
     end
 
+    # Return boolean indicating whether this border has a non-empty caption.
+    #
+    # @return [Boolean]
+    def caption?
+      present?(caption)
+    end
+
     # Return boolean indicating whether the title fits within the width of the
     # top border.
     #
@@ -210,11 +242,24 @@ module Vedeu
       width > title_characters.size
     end
 
+    # Return boolean indicating whether the caption fits within the width of the
+    # bottom border.
+    #
+    # @return [Boolean]
+    def caption_fits?
+      width > caption_characters.size
+    end
+
     # @return [Array<String>]
     def title_characters
       @title_characters ||= title_padded.chars
     end
 
+    # @return [Array<String>]
+    def caption_characters
+      @caption_characters ||= caption_padded.chars
+    end
+
     # Pads the title with a single whitespace either side.
     #
     # @example
@@ -231,6 +276,22 @@ module Vedeu
       truncated_title.center(truncated_title.size + 2)
     end
 
+    # Pads the caption with a single whitespace either side.
+    #
+    # @example
+    #   caption = 'Truncated!'
+    #   width = 20
+    #   # => ' Truncated! '
+    #
+    #   width = 10
+    #   # => ' Trunca '
+    #
+    # @return [String]
+    # @see #truncated_caption
+    def caption_padded
+      truncated_caption.center(truncated_caption.size + 2)
+    end
+
     # Truncates the title to the width of the interface, minus characters needed
     # to ensure there is at least a single character of horizontal border and a
     # whitespace on either side of the title.
@@ -248,6 +309,23 @@ module Vedeu
       title.chomp.slice(0..(width - 5))
     end
 
+    # Truncates the caption to the width of the interface, minus characters
+    # needed to ensure there is at least a single character of horizontal border
+    # and a whitespace on either side of the caption.
+    #
+    # @example
+    #   caption = 'Truncated!'
+    #   width = 20
+    #   # => 'Truncated!'
+    #
+    #   width = 10
+    #   # => 'Trunca'
+    #
+    # @return [String]
+    def truncated_caption
+      caption.chomp.slice(0..(width - 5))
+    end
+
   end # RenderBorder
 
 end # Vedeu

data/lib/vedeu/distributed/server.rb

@@ -61,8 +61,10 @@ module Vedeu
 
       end # Eigenclass
 
-      # @param data [String|Symbol]
-      # @param type [Symbol] Either :keypress or :command.
+      # @param data [String|Symbol] The input to send to Vedeu.
+      # @param type [Symbol] Either :command or :keypress. Will trigger the
+      #   respective capture mode within {Vedeu::Input}, or if not given, will
+      #   treat the data as a keypress.
       # @return [void]
       def input(data, type = :keypress)
         Vedeu.trigger(:_drb_input_, data, type)

data/lib/vedeu/dsl/border.rb

@@ -261,6 +261,23 @@ module Vedeu
         model.title = value
       end
 
+      # If you have you are showing a bottom border, you could add a caption.
+      #
+      #   Vedeu.border 'border_demo' do
+      #     caption 'My Cool Caption'
+      #     # ... some code
+      #   end
+      #
+      # produces, depending on other customisations:
+      #
+      #   +------------------------------ My Cool Caption -+
+      #
+      # @param value [String] The caption.
+      # @return [String]
+      def caption(value)
+        model.caption = value
+      end
+
       # Enable/disable the top border.
       #
       #   Vedeu.border 'border_demo' do

data/lib/vedeu/dsl/group.rb

@@ -34,6 +34,15 @@ module Vedeu
       #     # ... some code
       #   end
       #
+      # or more succinctly:
+      #
+      #   Vedeu.group 'main_screen' do
+      #     members 'editor_interface', 'status_interface', 'command_interface'
+      #     # ... some code
+      #   end
+      #
+      # or when defining an interface:
+      #
       #   Vedeu.interface 'some_interface' do
       #     group 'some_group'
       #     # ... some code
@@ -66,11 +75,23 @@ module Vedeu
       #   end
       #
       # @param interface_name [String]
-      # @return [void]
+      # @return [Vedeu::Group]
       def add(interface_name)
         model.add(interface_name)
       end
 
+      # Add the named interfaces to this group in bulk.
+      #
+      #   Vedeu.group 'main_screen' do
+      #     members ['editor_interface', 'some_interface', 'other_interface']
+      #   end
+      #
+      # @param interface_names [Array<String>]
+      # @return [Array<String>]
+      def members(*interface_names)
+        interface_names.each { |name| add(name) }
+      end
+
     end # Group
 
   end # DSL

data/lib/vedeu/geometry/coordinate.rb

@@ -6,15 +6,13 @@ module Vedeu
 
     extend Forwardable
 
-    def_delegators :border,
-                   :bx,
-                   :bxn,
-                   :by,
-                   :byn,
-                   :height,
-                   :width,
-                   :x,
-                   :y
+    def_delegators :x,
+                   :x_position,
+                   :xn
+
+    def_delegators :y,
+                   :y_position,
+                   :yn
 
     # Returns a new instance of Vedeu::Coordinate.
     #
@@ -28,87 +26,87 @@ module Vedeu
       @oy   = oy
     end
 
-    # Returns the maximum y coordinate for an area.
+    private
+
+    # Provide an instance of Vedeu::GenericCoordinate to determine correct x
+    # related coordinates.
     #
-    # @example
-    #   # y = 2
-    #   # height = 4
-    #   yn # => 6
+    # @return [Vedeu::GenericCoordinate]
+    def x
+      @x ||= Vedeu::GenericCoordinate.new(name: @name, offset: @ox, type: :x)
+    end
+
+    # Provide an instance of Vedeu::GenericCoordinate to determine correct y
+    # related coordinates.
     #
-    # @return [Fixnum]
-    def yn
-      if height <= 0
-        0
+    # @return [Vedeu::GenericCoordinate]
+    def y
+      @y ||= Vedeu::GenericCoordinate.new(name: @name, offset: @oy, type: :y)
+    end
 
-      else
-        y + height
+  end # Coordinate
 
-      end
+  # Crudely corrects out of range values.
+  #
+  class GenericCoordinate
+
+    # Return a new instance of Vedeu::GenericCoordinate.
+    #
+    # @param attributes [Hash]
+    # @option attributes name [String]
+    # @option attributes type [Symbol]
+    # @option attributes offset [Fixnum]
+    # @return [Vedeu::GenericCoordinate]
+    def initialize(attributes = {})
+      @attributes = defaults.merge!(attributes)
+
+      @attributes.each { |key, value| instance_variable_set("@#{key}", value) }
     end
 
-    # Returns the maximum x coordinate for an area.
+    # Returns the maximum coordinate for an area.
     #
     # @example
-    #   # x = 5
-    #   # width = 20
-    #   xn # => 25
+    #   # d = 2
+    #   # d_dn = 4
+    #   dn # => 6
     #
     # @return [Fixnum]
-    def xn
-      if width <= 0
+    def dn
+      if d_dn <= 0
         0
 
       else
-        x + width
+        d + d_dn
 
       end
     end
+    alias_method :xn, :dn
+    alias_method :yn, :dn
 
-    # Returns the y coordinate for a given index.
-    #
-    # @example
-    #   # y_range = [7, 8, 9, 10, 11]
-    #   y_position     # => 7
-    #   y_position(-2) # => 7
-    #   y_position(2)  # => 9
-    #   y_position(7)  # => 11
-    #
-    # @return [Fixnum]
-    def y_position
-      pos = case
-            when oy <= 0       then y
-            when oy > yn_index then yn
-            else
-              y_range[oy]
-            end
-
-      pos = pos < by ? by : pos
-      pos = pos > byn ? byn : pos
-      pos
-    end
-
-    # Returns the x coordinate for a given index.
+    # Returns the coordinate for a given index.
     #
     # @example
-    #   # x_range = [4, 5, 6, 7, 8, 9, 10, 11, 12, 13]
-    #   x_position     # => 4
-    #   x_position(-2) # => 4
-    #   x_position(2)  # => 6
-    #   x_position(15) # => 13
+    #   # d_range = [4, 5, 6, 7, 8, 9, 10, 11, 12, 13]
+    #   position     # => 4
+    #   position(-2) # => 4
+    #   position(2)  # => 6
+    #   position(15) # => 13
     #
     # @return [Fixnum]
-    def x_position
+    def position
       pos = case
-            when ox <= 0       then x
-            when ox > xn_index then xn
+            when offset <= 0       then d
+            when offset > dn_index then dn
             else
-              x_range[ox]
+              d_range[offset]
             end
 
-      pos = pos < bx ? bx : pos
-      pos = pos > bxn ? bxn : pos
+      pos = pos < bd ? bd : pos
+      pos = pos > bdn ? bdn : pos
       pos
     end
+    alias_method :x_position, :position
+    alias_method :y_position, :position
 
     protected
 
@@ -116,13 +114,13 @@ module Vedeu
     # @return [String]
     attr_reader :name
 
-    # @!attribute [r] oy
+    # @!attribute [r] offset
     # @return [Fixnum]
-    attr_reader :oy
+    attr_reader :offset
 
-    # @!attribute [r] ox
-    # @return [Fixnum]
-    attr_reader :ox
+    # @!attribute [r] type
+    # @return [Symbol]
+    attr_reader :type
 
     private
 
@@ -131,66 +129,88 @@ module Vedeu
       @border ||= Vedeu.borders.by_name(name)
     end
 
-    # Returns the maximum y index for an area.
+    # Return the :x or :y value from the border.
     #
-    # @example
-    #   # height = 3
-    #   yn_index # => 2
+    # @return [Fixnum]
+    def d
+      border.send(coordinate_type[0])
+    end
+
+    # Return the :bx or :by value from the border.
     #
     # @return [Fixnum]
-    def yn_index
-      if height < 1
-        0
+    def bd
+      border.send(coordinate_type[1])
+    end
 
-      else
-        height - 1
+    # Return the :bxn or :byn value from the border.
+    #
+    # @return [Fixnum]
+    def bdn
+      border.send(coordinate_type[2])
+    end
 
-      end
+    # Return the :width or :height value from the border.
+    #
+    # @return [Fixnum]
+    def d_dn
+      border.send(coordinate_type[3])
+    end
+
+    # Ascertain the correct methods to use for determining the coordinates.
+    #
+    # @return [Fixnum]
+    def coordinate_type
+      @_type ||= case type
+                 when :x then [:x, :bx, :bxn, :width]
+                 when :y then [:y, :by, :byn, :height]
+                 else
+                   fail Vedeu::InvalidSyntax,
+                        'Coordinate type not given, cannot continue.'
+                 end
     end
 
-    # Returns the maximum x index for an area.
+    # Returns the maximum index for an area.
     #
     # @example
-    #   # width = 6
-    #   xn_index # => 5
+    #   # d_dn = 3
+    #   dn_index # => 2
     #
     # @return [Fixnum]
-    def xn_index
-      if width < 1
+    def dn_index
+      if d_dn < 1
         0
 
       else
-        width - 1
+        d_dn - 1
 
       end
     end
 
-    # Returns an array with all coordinates from x to xn.
+    # Returns an array with all coordinates from d to dn.
     #
     # @example
-    #   # width = 10
-    #   # x = 4
-    #   # xn = 14
-    #   x_range # => [4, 5, 6, 7, 8, 9, 10, 11, 12, 13]
+    #   # d_dn = 10
+    #   # d = 4
+    #   # dn = 14
+    #   d_range # => [4, 5, 6, 7, 8, 9, 10, 11, 12, 13]
     #
     # @return [Array]
-    def x_range
-      (x...xn).to_a
+    def d_range
+      (d...dn).to_a
     end
 
-    # Returns an array with all coordinates from y to yn.
-    #
-    # @example
-    #   # height = 4
-    #   # y  = 7
-    #   # yn  = 11
-    #   y_range # => [7, 8, 9, 10]
+    # The default values for a new instance of this class.
     #
-    # @return [Array]
-    def y_range
-      (y...yn).to_a
+    # @return [Hash]
+    def defaults
+      {
+        name:   '',
+        offset: nil,
+        type:   :x,
+      }
     end
 
-  end # Coordinate
+  end # GenericCoordinate
 
 end # Vedeu

data/lib/vedeu/version.rb

@@ -1,6 +1,6 @@
 module Vedeu
 
   # The current version of Vedeu.
-  VERSION = '0.5.9'
+  VERSION = '0.5.10'
 
 end

data/test/lib/vedeu/borders/border_test.rb

@@ -10,6 +10,7 @@ module Vedeu
       {
         bottom_left:  'm',
         bottom_right: 'j',
+        caption:      '',
         client:       nil,
         colour:       nil,
         enabled:      false,
@@ -56,6 +57,8 @@ module Vedeu
       it { instance.must_respond_to(:bottom_left=) }
       it { instance.must_respond_to(:bottom_right) }
       it { instance.must_respond_to(:bottom_right=) }
+      it { instance.must_respond_to(:caption) }
+      it { instance.must_respond_to(:caption=) }
       it { instance.must_respond_to(:horizontal) }
       it { instance.must_respond_to(:horizontal=) }
       it { instance.must_respond_to(:show_bottom) }

data/test/lib/vedeu/dsl/border_test.rb

@@ -176,6 +176,15 @@ module Vedeu
         it { subject.must_equal('Some title') }
       end
 
+      describe '#caption' do
+        let(:_value) { 'Some caption'}
+
+        subject { instance.caption(_value) }
+
+        it { subject.must_be_instance_of(String) }
+        it { subject.must_equal('Some caption') }
+      end
+
       describe '#top_left' do
         let(:char) { 'A' }
 

data/test/lib/vedeu/dsl/group_test.rb

@@ -47,6 +47,22 @@ module Vedeu
         it { subject.members.must_equal(Set['editor_interface']) }
       end
 
+      describe '#members' do
+        let(:expected) {
+          Set['editor_interface', 'some_interface', 'other_interface']
+        }
+
+        subject {
+          described.group(group_name) do
+            members('editor_interface', 'some_interface', 'other_interface')
+          end
+        }
+
+        it { subject.must_be_instance_of(Vedeu::Group) }
+
+        it { subject.members.must_equal(expected) }
+      end
+
     end # Group
 
     describe 'integration' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vedeu
 version: !ruby/object:Gem::Version
-  version: 0.5.9
+  version: 0.5.10
 platform: ruby
 authors:
 - Gavin Laking
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-10 00:00:00.000000000 Z
+date: 2015-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard