vedeu 0.6.48 → 0.6.49

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9759381f1db665ae94ab60090c238d752bbdc117
-  data.tar.gz: ac4f61ccd7ed1156dc851b590afe18d957ec2b97
+  metadata.gz: 40290f698e67f6437fbc9b2727e8cdfe54d68a6d
+  data.tar.gz: 259c3305848dd4a9dc9b58332051ebf4987b1f99
 SHA512:
-  metadata.gz: 20aa205043bf1c5563dd7814f26fc3edd2c26dc3b4edfd65ba85534a3e9294f38c682f1dcd662add1152d93ff3358544679c0bd8db784f54ba7aa59fff0ec1d0
-  data.tar.gz: d0ed14b86e102240df0609974d09dc6530c6e75cfc0dd86afa17b892ad19074427ac9b24459b9a3209c2d7792ff888b70732ee9a4edad8c92de8401575d93966
+  metadata.gz: 34e50c0fa3539b628e7592fb0f19b4d9cc20ff7a3d9808bcb515c24fb06c8590e1e26f73c538276716bdc33f1296aa1c9ba710cd768d2ec6409de7cb19b574a4
+  data.tar.gz: 234914b85448331f85d85db2b754b917d71c5e7c76675a5d1ce68fd2af8c37ca3f7701ad76d2df0eb017d99b76b6bf078b1e438cbd7798b751184fb31ada2d09

data/.rubocop.yml

@@ -79,6 +79,9 @@ Style/IndentHash:
     - special_inside_parentheses
     - consistent
 
+Style/MultilineOperationIndentation:
+  Enabled: false
+
 Style/ModuleFunction:
   Enabled: false
 

data/README.md

@@ -1,6 +1,5 @@
 [![Code Climate](https://codeclimate.com/github/gavinlaking/vedeu.png)](https://codeclimate.com/github/gavinlaking/vedeu)
 [![Build Status](https://travis-ci.org/gavinlaking/vedeu.svg?branch=master)](https://travis-ci.org/gavinlaking/vedeu)
-[![Test Coverage](https://codeclimate.com/github/gavinlaking/vedeu/badges/coverage.svg)](https://codeclimate.com/github/gavinlaking/vedeu/coverage)
 
 # Vedeu
 

data/examples/dsl_menus.rb

@@ -0,0 +1,239 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'vedeu'
+
+# If you have cloned this repository from GitHub, you can run this example:
+#
+#     bundle exec ./examples/dsl_menus.rb
+#
+class DSLMenus
+  include Vedeu
+
+  Vedeu.bind(:_initialize_) {
+    Vedeu.trigger(:_show_group_, :file_browser)
+    Vedeu.trigger(:_refresh_group_, :file_browser)
+  }
+
+  Vedeu.configure do
+    debug!
+    log '/tmp/dsl_menus.log'
+  end
+
+  Vedeu.interface :files do
+    border do
+      title 'Files'
+    end
+    foreground '#ffffff'
+    geometry do
+      width  columns(3) - 1
+      height Vedeu.height - 1
+      x  1
+      y  1
+    end
+    group :file_browser
+    keymap do
+      key('k', :up) do
+        Vedeu.trigger(:_menu_prev_, :files)
+        Vedeu.trigger(:update)
+      end
+      key('j', :down) do
+        Vedeu.trigger(:_menu_next_, :files)
+        Vedeu.trigger(:update)
+      end
+      key(:enter) do
+        Vedeu.trigger(:_menu_select_, :files)
+        Vedeu.trigger(:update)
+      end
+    end
+  end
+
+  Vedeu.interface :contents do
+    border do
+      title 'Contents'
+    end
+    foreground '#ffffff'
+    geometry do
+      width  Vedeu.width - (columns(3) - 1)
+      height Vedeu.height - 1
+      x  use(:files).east
+      y  1
+    end
+    group :file_browser
+    keymap do
+      key('k', :up) do
+        Vedeu.trigger(:_cursor_up_, :contents)
+      end
+      key('j', :down) do
+        Vedeu.trigger(:_cursor_down_, :contents)
+      end
+    end
+  end
+
+  Vedeu.keymap '_global_' do
+    key('q')        { Vedeu.exit }
+    key(:shift_tab) { Vedeu.trigger(:_focus_prev_) }
+    key(:tab)       { Vedeu.trigger(:_focus_next_) }
+  end
+
+  # Orchestrates the user interactions with the application.
+  #
+  class Controller
+    def initialize(args = [])
+      @args = args
+
+      menu = Vedeu.menu(:files) { items(files) }
+
+      Vedeu.bind :update do
+        FilesView.new.show
+        ContentsView.new.show
+        Vedeu.trigger(:_refresh_group_, :file_browser)
+      end
+
+      FilesView.new.show
+    end
+
+    private
+
+    attr_reader :args
+
+    def files
+      @files ||= Files.new(args).all_files
+    end
+  end
+
+  # Get all the files in the current or specified directory.
+  #
+  class Files
+    def initialize(args = [])
+      @args = args
+    end
+
+    def all_files
+      @_all_files ||= files.map { |file| SomeFile.new(file) }.sort_by(&:name)
+    end
+
+    private
+
+    attr_reader :args
+
+    def files
+      @_files ||= Dir.glob(recursive).select { |file| File.file?(file) }
+    end
+
+    def recursive
+      directory + '/*'
+    end
+
+    def directory
+      args.first || '.'
+    end
+  end
+
+  # A class to wrap a file, providing its name and contents (in the
+  # form of 'data').
+  #
+  class SomeFile
+    attr_reader :file
+
+    def initialize(file)
+      @file = file
+    end
+
+    def name
+      file.to_s
+    end
+
+    def data
+      @data ||= Contents.new(file).contents
+    end
+  end
+
+  # The contents of a file.
+  #
+  class Contents
+    attr_reader :path
+
+    def initialize(path)
+      @path = path
+    end
+
+    def contents
+      File.readlines(path)
+    end
+  end
+
+  # Displays a list of files from the current or specified directory.
+  #
+  class FilesView
+    def show
+      Vedeu.renders do
+        view :files do
+          files_menu.each do |sel, cur, item|
+            if sel && cur
+              line do
+                stream do
+                  text "\u{25B6}> #{item.name}"
+                end
+              end
+
+            elsif cur
+              line do
+                stream do
+                  text " > #{item.name}"
+                end
+              end
+
+            elsif sel
+              line do
+                stream do
+                  text "\u{25B6}  #{item.name}"
+                end
+              end
+
+            else
+               line do
+                 stream do
+                   text "   #{item.name}"
+                 end
+               end
+            end
+          end
+        end
+      end
+    end
+
+    def files_menu
+      @files_menu ||= Vedeu.trigger(:_menu_view_, :files)
+    end
+  end
+
+  # Displays the contents of a selected file.
+  #
+  class ContentsView
+    def show
+      Vedeu.renders do
+        view :contents do
+          open_file.data.each do |data_line|
+            line do
+              text "#{data_line.chomp}"
+            end
+          end if open_file
+        end
+      end
+    end
+
+    def open_file
+      @file_contents ||= Vedeu.trigger(:_menu_selected_, :files)
+    end
+  end
+
+  def self.start(argv = ARGV)
+    Controller.new(argv)
+
+    Vedeu::Launcher.execute!(argv)
+  end
+
+end # DSLMenus
+
+DSLMenus.start

data/lib/vedeu/borders/all.rb

@@ -33,6 +33,7 @@ module Vedeu
 
 end # Vedeu
 
+require 'vedeu/borders/title'
 require 'vedeu/borders/border'
 require 'vedeu/borders/dsl'
 require 'vedeu/borders/null'

data/lib/vedeu/borders/border.rb

@@ -66,15 +66,15 @@ module Vedeu
       attr_accessor :show_top
       alias_method :top?, :show_top
 
-      # @!attribute [rw] caption
-      # @return [String] An optional caption for when the bottom
+      # # @!attribute [rw] caption
+      # # @return [String] An optional caption for when the bottom
       #   border is to be shown.
-      attr_accessor :caption
+      # attr_accessor :caption
 
       # @!attribute [rw] title
       # @return [String] An optional title for when the top
       #   border is to be shown.
-      attr_accessor :title
+      # attr_accessor :title
 
       # @!attribute [rw] top_left
       # @return [String] The character to be used for the top left
@@ -204,6 +204,28 @@ module Vedeu
         (enabled? && bottom?) ? yn - 1 : yn
       end
 
+      # @return [Vedeu::Borders::Caption]
+      def caption
+        Vedeu::Borders::Caption.coerce(@caption, width)
+      end
+
+      # @param value [String]
+      # @return [Vedeu::Borders::Caption]
+      def caption=(value)
+        @caption = Vedeu::Borders::Caption.coerce(value, width)
+      end
+
+      # @return [Vedeu::Borders::Title]
+      def title
+        Vedeu::Borders::Title.coerce(@title, width)
+      end
+
+      # @param value [String]
+      # @return [Vedeu::Borders::Title]
+      def title=(value)
+        @title = Vedeu::Borders::Title.coerce(value, width)
+      end
+
       # Returns a DSL instance responsible for defining the DSL
       # methods of this model.
       #

data/lib/vedeu/borders/dsl.rb

@@ -233,9 +233,10 @@ module Vedeu
       #   +- My Cool Title --------------------------------+
       #
       # @param value [String] The title.
-      # @return [String]
+      # @return [Vedeu::Borders::Title]
       def title(value)
         model.title = value
+        model.title
       end
       alias_method :title=, :title
 
@@ -252,9 +253,10 @@ module Vedeu
       #   +------------------------------ My Cool Caption -+
       #
       # @param value [String] The caption.
-      # @return [String]
+      # @return [Vedeu::Borders::Caption]
       def caption(value)
         model.caption = value
+        model.caption
       end
       alias_method :caption=, :caption
 

data/lib/vedeu/borders/refresh.rb

@@ -230,17 +230,17 @@ module Vedeu
       #
       # @return [Array<Vedeu::Views::Char>]
       def captionbar
-        return build_bottom unless caption? && caption_fits?
+        return build_bottom if caption.empty?
 
-        caption_starts_at = (width - caption_characters.size) - 2
+        caption_starts_at = (width - caption.size) - 2
 
-        caption_char = 0
+        caption_index = 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
+          char.border   = nil
+          char.value    = caption.characters[caption_index]
+          caption_index += 1
         end
       end
 
@@ -249,126 +249,16 @@ module Vedeu
       #
       # @return [Array<Vedeu::Views::Char>]
       def titlebar
-        return build_top unless title? && title_fits?
+        return build_top if title.empty?
 
         build_top.each_with_index do |char, index|
-          next if index == 0 || index > title_characters.size
+          next if index == 0 || index > title.size
 
           char.border = nil
-          char.value  = title_characters[(index - 1)]
+          char.value  = title.characters[index - 1]
         end
       end
 
-      # Return boolean indicating whether this border has a non-empty
-      # title.
-      #
-      # @return [Boolean]
-      def title?
-        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.
-      #
-      # @return [Boolean]
-      def title_fits?
-        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
-      #   title = 'Truncated!'
-      #   width = 20
-      #   # => ' Truncated! '
-      #
-      #   width = 10
-      #   # => ' Trunca '
-      #
-      # @return [String]
-      # @see #truncated_title
-      def title_padded
-        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.
-      #
-      # @example
-      #   title = 'Truncated!'
-      #   width = 20
-      #   # => 'Truncated!'
-      #
-      #   width = 10
-      #   # => 'Trunca'
-      #
-      # @return [String]
-      def truncated_title
-        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 # Refresh
 
   end # Borders

data/lib/vedeu/borders/title.rb

@@ -0,0 +1,138 @@
+module Vedeu
+
+  module Borders
+
+    # When a {Vedeu::Borders::Border} has a title, truncate it if the
+    # title is longer than the interface is wide, and pad with a space
+    # either side.
+    #
+    class Title
+
+      # @param value [String|Vedeu::Borders::Title|
+      #   Vedeu::Borders::Caption]
+      # @param width [Fixnum]
+      # @return [Vedeu::Borders::Title|Vedeu::Borders::Caption]
+      def self.coerce(value = '', width = Vedeu.width)
+        if value.is_a?(self)
+          value
+
+        else
+          new(value, width)
+
+        end
+      end
+
+      # Returns a new instance of Vedeu::Borders::Title or
+      # Vedeu::Borders::Caption.
+      #
+      # @param value [String|Vedeu::Borders::Title|
+      #   Vedeu::Borders::Caption]
+      # @param width [Fixnum]
+      # @return [Vedeu::Borders::Title|Vedeu::Borders::Caption]
+      def initialize(value = '', width = Vedeu.width)
+        @value = value
+        @width = width
+      end
+
+      # Return the padded, truncated value as an Array of String.
+      #
+      # @return [Array<String>]
+      def characters
+        pad.chars
+      end
+
+      # Return boolean indicating whether the value is empty.
+      #
+      # @return [Boolean]
+      def empty?
+        value.empty?
+      end
+
+      # An object is equal when its values are the same.
+      #
+      # @param other [Vedeu::Borders::Title]
+      # @return [Boolean]
+      def eql?(other)
+        self.class == other.class && value == other.value
+      end
+      alias_method :==, :eql?
+
+      # Return the size of the padded, truncated value.
+      #
+      # @return [Fixnum]
+      def size
+        pad.size
+      end
+
+      # Convert the value to a string.
+      #
+      # @return [String]
+      def to_s
+        value.to_s
+      end
+
+      # Return the value or an empty string.
+      #
+      # @return [String]
+      def value
+        @value || ''
+      end
+      alias_method :title, :value
+      alias_method :caption, :value
+
+      private
+
+      # Pads the value with a single whitespace either side.
+      #
+      # @example
+      #   value = 'Truncated!'
+      #   width = 20
+      #   # => ' Truncated! '
+      #
+      #   width = 10
+      #   # => ' Trunca '
+      #
+      # @return [String]
+      # @see #truncate
+      def pad
+        truncate.center(truncate.size + 2)
+      end
+
+      # Truncates the value 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 value.
+      #
+      # @example
+      #   value = 'Truncated!'
+      #   width = 20
+      #   # => 'Truncated!'
+      #
+      #   width = 10
+      #   # => 'Trunca'
+      #
+      # @return [String]
+      def truncate
+        title.chomp.slice(0...(width - 4))
+      end
+
+      # Return the given width or the width of the terminal.
+      #
+      # @return [Fixnum]
+      def width
+        @width || Vedeu.width
+      end
+
+    end # Title
+
+    # When a {Vedeu::Borders::Border} has a caption, truncate it if
+    # the caption is longer than the interface is wide, and pad with a
+    # space either side.
+    #
+    class Caption < Title
+
+    end # Caption
+
+  end # Borders
+
+end # Vedeu

data/lib/vedeu/buffers/refresh.rb

@@ -70,7 +70,7 @@ module Vedeu
       # @return [Hash<Symbol => Boolean>]
       def defaults
         {
-          content_only: false,
+          content_only: false
         }
       end
 

data/lib/vedeu/dsl/view.rb

@@ -190,6 +190,14 @@ module Vedeu
 
         private
 
+        # Returns the client object which called the DSL method.
+        #
+        # @param block [Proc]
+        # @return [Object]
+        def client(&block)
+          eval('self', block.binding)
+        end
+
         # Creates a new Vedeu::Views::Composition which may contain
         # one or more views (Vedeu::Views::View objects).
         #
@@ -202,6 +210,9 @@ module Vedeu
           Vedeu::Views::Composition.build(attrs, &block)
         end
 
+        # Creates a new Vedeu::Views::Composition which may contain
+        # one or more views (Vedeu::Views::View objects).
+        #
         # Stores each of the views defined in their respective buffers
         # ready to be rendered on next refresh.
         #

data/lib/vedeu/editor/all.rb

@@ -13,6 +13,7 @@ require 'vedeu/editor/cropper'
 require 'vedeu/editor/delete'
 require 'vedeu/editor/editor'
 require 'vedeu/editor/insert'
+require 'vedeu/editor/item'
 require 'vedeu/editor/line'
 require 'vedeu/editor/lines'
 require 'vedeu/editor/cursor'

data/lib/vedeu/editor/item.rb

@@ -0,0 +1,71 @@
+module Vedeu
+
+  module Editor
+
+    # Fetches an item from a collection.
+    #
+    class Item
+
+      # @param collection [Vedeu::Editor::Line|Vedeu::Editor::Lines]
+      # @param index [Fixnum]
+      # @return [String|Vedeu::Editor::Line]
+      def self.by_index(collection, index = nil)
+        new(collection, index).by_index
+      end
+
+      # Returns a new instance of Vedeu::Editor::Item.
+      #
+      # @param collection [Vedeu::Editor::Line|Vedeu::Editor::Lines]
+      # @param index [Fixnum]
+      # @return [Vedeu::Editor::item]
+      def initialize(collection, index = nil)
+        @collection = collection
+        @index      = index
+      end
+
+      # @return [String|Vedeu::Editor::Line]
+      def by_index
+        return nil unless size > 0
+
+        if index.nil? || index > size
+          collection[-1]
+
+        elsif index <= 0
+          collection[0]
+
+        elsif index > 0 && index <= size
+          collection[index]
+
+        end
+      end
+
+      protected
+
+      # @!attribute [r] collection
+      # @return [Vedeu::Editor::Line|Vedeu::Editor::Lines]
+      attr_reader :collection
+
+      # @!attribute [r] index
+      # @return [Fixnum]
+      attr_reader :index
+
+      private
+
+      # Returns the size of the collection or 0.
+      #
+      # @return [Fixnum]
+      def size
+        if collection
+          collection.size
+
+        else
+          0
+
+        end
+      end
+
+    end # Item
+
+  end # Editor
+
+end # Vedeu

data/lib/vedeu/editor/line.rb

@@ -39,8 +39,7 @@ module Vedeu
         line[index]
       end
 
-      # Return the character from the line positioned at the given
-      # index.
+      # Return the character at the given index.
       #
       # @param index [Fixnum|NilClass]
       # @return [String|NilClass]
@@ -48,16 +47,7 @@ module Vedeu
         return ''       if line && line.empty?
         return line[-1] unless index
 
-        if index <= 0
-          line[0]
-
-        elsif index && index <= size
-          line[index]
-
-        else
-          line[-1]
-
-        end
+        Vedeu::Editor::Item.by_index(line, index)
       end
 
       # Delete the character from the line positioned at the given

data/lib/vedeu/editor/lines.rb

@@ -131,18 +131,7 @@ module Vedeu
         return Vedeu::Editor::Line.new unless lines
         return Vedeu::Editor::Line.coerce(lines[-1]) unless index
 
-        indexed = if index <= 0
-                    lines[0]
-
-                  elsif index && index <= size
-                    lines[index]
-
-                  else
-                    lines[-1]
-
-                  end
-
-        Vedeu::Editor::Line.coerce(indexed)
+        Vedeu::Editor::Line.coerce(Vedeu::Editor::Item.by_index(lines, index))
       end
 
       # Return the number of lines.

data/lib/vedeu/geometry/alignment.rb

@@ -33,6 +33,8 @@ module Vedeu
         end
       end
 
+      # Returns a new instance of Vedeu::Geometry::Alignment.
+      #
       # @param value [NilClass|Symbol]
       # @return [Vedeu::Geometry::Alignment]
       def initialize(value = nil)

data/lib/vedeu/interfaces/dsl.rb

@@ -242,6 +242,7 @@ module Vedeu
       def show!
         visible(true)
       end
+      alias_method :visible!, :show!
 
       # Set the interface to invisible.
       #

data/lib/vedeu/logging/ips.rb

@@ -13,6 +13,8 @@ module Vedeu
         attr_accessor :samples
         attr_accessor :benchmark
 
+        # Returns a new instance of Vedeu::Logging::Debug::IPS.
+        #
         # @return [Vedeu::Logging::Debug::IPS]
         def initialize
           @old_stdout = $stdout

data/lib/vedeu/models/toggleable.rb

@@ -91,6 +91,8 @@ module Vedeu
       alias_method :toggle_group,     :toggle
       alias_method :toggle_interface, :toggle
 
+      # Hide the cursor if visible.
+      #
       # @example
       #   Vedeu.hide_cursor(name)
       #
@@ -101,6 +103,8 @@ module Vedeu
         hide(name) if cursor_visible?(name)
       end
 
+      # Show the cursor if not already visible.
+      #
       # @example
       #   Vedeu.show_cursor(name)
       #
@@ -108,9 +112,11 @@ module Vedeu
       # @return [void]
       # @see Vedeu::Toggleable#show
       def show_cursor(name = Vedeu.focus)
-        show(name) if cursor_visible?(name)
+        show(name) unless cursor_visible?(name)
       end
 
+      # Toggle the cursor visibility.
+      #
       # @example
       #   Vedeu.toggle_cursor(name)
       #
@@ -118,11 +124,13 @@ module Vedeu
       # @return [void]
       # @see Vedeu::Toggleable#toggle
       def toggle_cursor(name = Vedeu.focus)
-        toggle(name) if cursor_visible?(name)
+        toggle(name)
       end
 
       private
 
+      # Returns a boolean indicating whether the cursor is visible.
+      #
       # @param name [String|Symbol]
       # @return [Boolean]
       def cursor_visible?(name)

data/lib/vedeu/output/presentation/style.rb

@@ -46,7 +46,7 @@ module Vedeu
       # @return [Hash<Symbol => Array<String|Symbol>|String|Symbol>]
       def attributes
         {
-          style: value,
+          style: value
         }
       end
 

data/lib/vedeu/runtime/flags.rb

@@ -50,7 +50,7 @@ module Vedeu
       # @return [Hash]
       def defaults
         {
-          ready: false,
+          ready: false
         }
       end
 

data/lib/vedeu/runtime/launcher.rb

@@ -74,6 +74,7 @@ module Vedeu
                  uncaught_exception.message
                end
 
+      Vedeu.log(type: :error, message: output)
       Vedeu.log_stdout(type: :error, message: output)
     end
 

data/lib/vedeu/version.rb

@@ -1,6 +1,6 @@
 module Vedeu
 
   # The current version of Vedeu.
-  VERSION = '0.6.48'.freeze
+  VERSION = '0.6.49'.freeze
 
 end

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

@@ -55,8 +55,6 @@ module Vedeu
           instance.must_respond_to(:bottom_left=)
           instance.must_respond_to(:bottom_right)
           instance.must_respond_to(:bottom_right=)
-          instance.must_respond_to(:caption)
-          instance.must_respond_to(:caption=)
           instance.must_respond_to(:horizontal)
           instance.must_respond_to(:horizontal=)
           instance.must_respond_to(:show_bottom)
@@ -71,8 +69,6 @@ module Vedeu
           instance.must_respond_to(:show_top)
           instance.must_respond_to(:top?)
           instance.must_respond_to(:show_top=)
-          instance.must_respond_to(:title)
-          instance.must_respond_to(:title=)
           instance.must_respond_to(:top_left)
           instance.must_respond_to(:top_left=)
           instance.must_respond_to(:top_right)

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

@@ -173,8 +173,8 @@ module Vedeu
 
         subject { instance.title(_value) }
 
-        it { subject.must_be_instance_of(String) }
-        it { subject.must_equal('Some title') }
+        it { subject.must_be_instance_of(Vedeu::Borders::Title) }
+        it { subject.title.must_equal('Some title') }
         it { instance.must_respond_to(:title=) }
       end
 
@@ -183,8 +183,8 @@ module Vedeu
 
         subject { instance.caption(_value) }
 
-        it { subject.must_be_instance_of(String) }
-        it { subject.must_equal('Some caption') }
+        it { subject.must_be_instance_of(Vedeu::Borders::Caption) }
+        it { subject.caption.must_equal('Some caption') }
         it { instance.must_respond_to(:caption=) }
       end
 
@@ -223,7 +223,7 @@ module Vedeu
 
         it 'allows the use of another models attributes' do
           subject
-          Vedeu.borders.by_name('other_border').title.must_equal('Some border')
+          Vedeu.borders.by_name('other_border').title.to_s.must_equal('Some border')
         end
       end
 

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

@@ -0,0 +1,101 @@
+require 'test_helper'
+
+module Vedeu
+
+  module Borders
+
+    describe Title do
+
+      let(:described) { Vedeu::Borders::Title }
+      let(:instance)  { described.new(_value, width) }
+      let(:_value)    { 'Aluminium' }
+      let(:width)     { 10 }
+
+      describe '#initialize' do
+        it { instance.must_be_instance_of(described) }
+        it { instance.instance_variable_get('@value').must_equal(_value) }
+        it { instance.instance_variable_get('@width').must_equal(width) }
+      end
+
+      describe '.coerce' do
+        subject { described.coerce(_value, width) }
+
+        context 'when the value is an instance of Vedeu::Borders::Title' do
+          let(:_value) { Vedeu::Borders::Title.new('Aluminium', 10) }
+
+          it { subject.must_equal(_value) }
+        end
+
+        context 'when the value is not an instance of Vedeu::Borders::Title' do
+          it { subject.must_equal(instance) }
+        end
+      end
+
+      describe '#characters' do
+        subject { instance.characters }
+
+        it { subject.must_equal([' ', 'A', 'l', 'u', 'm', 'i', 'n', ' ']) }
+      end
+
+      describe '#empty?' do
+        subject { instance.empty? }
+
+        context 'when the value is empty' do
+          let(:_value) { '' }
+
+          it { subject.must_equal(true) }
+        end
+
+        context 'when the value is not empty' do
+          it { subject.must_equal(false) }
+        end
+      end
+
+      describe '#eql?' do
+        let(:other) { instance }
+
+        subject { instance.eql?(other) }
+
+        it { subject.must_equal(true) }
+
+        context 'when different to other' do
+          let(:other) { described.new('Vanadium') }
+
+          it { subject.must_equal(false) }
+        end
+      end
+
+      describe '#size' do
+        subject { instance.size }
+
+        it { subject.must_equal(8) }
+      end
+
+      describe '#to_s' do
+        subject { instance.to_s }
+
+        it { subject.must_equal('Aluminium') }
+      end
+
+      describe '#value' do
+        subject { instance.value }
+
+        it { instance.must_respond_to(:title) }
+        it { instance.must_respond_to(:caption) }
+
+        context 'when the value is nil' do
+          let(:_value) {}
+
+          it { subject.must_equal('') }
+        end
+
+        context 'when the value is not nil' do
+          it { subject.must_equal('Aluminium') }
+        end
+      end
+
+    end # Title
+
+  end # Borders
+
+end # Vedeu

data/test/lib/vedeu/editor/item_test.rb

@@ -0,0 +1,73 @@
+require 'test_helper'
+
+module Vedeu
+
+  module Editor
+
+    describe Item do
+
+      let(:described)  { Vedeu::Editor::Item }
+      let(:instance)   { described.new(collection, index) }
+      let(:collection) {}
+      let(:index)      {}
+
+      describe '#initialize' do
+        it { instance.must_be_instance_of(described) }
+        it { instance.instance_variable_get('@collection').must_equal(collection) }
+        it { instance.instance_variable_get('@index').must_equal(index) }
+      end
+
+      describe '.by_index' do
+        subject { described.by_index(collection, index) }
+
+        context 'when the collection is empty or nil' do
+          it { subject.must_equal(nil) }
+        end
+
+        context 'when the collection is not empty' do
+          let(:collection) { [:hydrogen, :helium, :lithium] }
+
+          context 'when the index is nil' do
+            it 'returns the last item' do
+              subject.must_equal(:lithium)
+            end
+          end
+
+          context 'when the index is greater than the size of the collection' do
+            let(:index) { 4 }
+
+            it 'returns the last item' do
+              subject.must_equal(:lithium)
+            end
+          end
+
+          context 'when the index < 0' do
+            let(:index) { -2 }
+
+            it { subject.must_equal(:hydrogen) }
+          end
+
+          context 'when the index == 0' do
+            let(:index) { 0 }
+
+            it { subject.must_equal(:hydrogen) }
+          end
+
+          context 'when the index > 0 and the index is less than the size of ' \
+                  'the collection' do
+            let(:index) { 1 }
+
+            it { subject.must_equal(:helium) }
+          end
+        end
+      end
+
+      describe '#by_index' do
+        it { instance.must_respond_to(:by_index) }
+      end
+
+    end # Item
+
+  end # Editor
+
+end # Vedeu

data/test/lib/vedeu/models/toggleable_test.rb

@@ -16,9 +16,10 @@ module Vedeu
 
   describe Toggleable do
 
-    let(:described) { Vedeu::Toggleable }
-    let(:instance) { Vedeu::ToggleableTestClass.new(visible) }
-    let(:visible) { false }
+    let(:described)          { Vedeu::Toggleable }
+    let(:described_included) { Vedeu::ToggleableTestClass }
+    let(:instance)           { described_included.new(visible) }
+    let(:visible)            { false }
 
     describe 'accessors' do
       it {
@@ -78,22 +79,40 @@ module Vedeu
       end
     end
 
-    describe '#hide_cursor' do
-      subject { instance.hide_cursor }
+    describe '.hide_cursor' do
+      subject { described_included.hide_cursor }
 
-      # @todo Add more tests.
+      context 'when the cursor is visible' do
+        # @todo Add more tests.
+      end
+
+      context 'when the cursor is not visible' do
+        # @todo Add more tests.
+      end
     end
 
-    describe '#show_cursor' do
-      subject { instance.show_cursor }
+    describe '.show_cursor' do
+      subject { described_included.show_cursor }
+
+      context 'when the cursor is visible' do
+        # @todo Add more tests.
+      end
 
-      # @todo Add more tests.
+      context 'when the cursor is not visible' do
+        # @todo Add more tests.
+      end
     end
 
-    describe '#toggle_cursor' do
-      subject { instance.toggle_cursor }
+    describe '.toggle_cursor' do
+      subject { described_included.toggle_cursor }
+
+      context 'when the cursor is visible' do
+        # @todo Add more tests.
+      end
 
-      # @todo Add more tests.
+      context 'when the cursor is not visible' do
+        # @todo Add more tests.
+      end
     end
   end # Toggleable
 

data/vedeu.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'minitest-reporters', '1.1.5'
   spec.add_development_dependency 'mocha',              '1.1.0'
   spec.add_development_dependency 'pry',                '0.10.3'
-  spec.add_development_dependency 'rubocop',            '0.34.2'
+  spec.add_development_dependency 'rubocop',            '0.35.0'
   spec.add_development_dependency 'simplecov',          '0.10.0'
   spec.add_development_dependency 'simplecov-console',  '0.2.0'
   spec.add_development_dependency 'yard',               '0.8.7.6'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vedeu
 version: !ruby/object:Gem::Version
-  version: 0.6.48
+  version: 0.6.49
 platform: ruby
 authors:
 - Gavin Laking
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.34.2
+        version: 0.35.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.34.2
+        version: 0.35.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -317,6 +317,7 @@ files:
 - examples/dsl_editor.rb
 - examples/dsl_hello_worlds.rb
 - examples/dsl_horizontal_alignment.rb
+- examples/dsl_menus.rb
 - examples/dsl_vertical_alignment.rb
 - lib/vedeu.rb
 - lib/vedeu/all.rb
@@ -333,6 +334,7 @@ files:
 - lib/vedeu/borders/null.rb
 - lib/vedeu/borders/refresh.rb
 - lib/vedeu/borders/repository.rb
+- lib/vedeu/borders/title.rb
 - lib/vedeu/buffers/all.rb
 - lib/vedeu/buffers/buffer.rb
 - lib/vedeu/buffers/null.rb
@@ -387,6 +389,7 @@ files:
 - lib/vedeu/editor/document.rb
 - lib/vedeu/editor/editor.rb
 - lib/vedeu/editor/insert.rb
+- lib/vedeu/editor/item.rb
 - lib/vedeu/editor/line.rb
 - lib/vedeu/editor/lines.rb
 - lib/vedeu/editor/repository.rb
@@ -526,6 +529,7 @@ files:
 - test/lib/vedeu/borders/null_test.rb
 - test/lib/vedeu/borders/refresh_test.rb
 - test/lib/vedeu/borders/repository_test.rb
+- test/lib/vedeu/borders/title_test.rb
 - test/lib/vedeu/buffers/buffer_test.rb
 - test/lib/vedeu/buffers/null_test.rb
 - test/lib/vedeu/buffers/refresh_test.rb
@@ -565,6 +569,7 @@ files:
 - test/lib/vedeu/editor/document_test.rb
 - test/lib/vedeu/editor/editor_test.rb
 - test/lib/vedeu/editor/insert_test.rb
+- test/lib/vedeu/editor/item_test.rb
 - test/lib/vedeu/editor/line_test.rb
 - test/lib/vedeu/editor/lines_test.rb
 - test/lib/vedeu/editor/repository_test.rb
@@ -729,6 +734,7 @@ test_files:
 - test/lib/vedeu/borders/null_test.rb
 - test/lib/vedeu/borders/refresh_test.rb
 - test/lib/vedeu/borders/repository_test.rb
+- test/lib/vedeu/borders/title_test.rb
 - test/lib/vedeu/buffers/buffer_test.rb
 - test/lib/vedeu/buffers/null_test.rb
 - test/lib/vedeu/buffers/refresh_test.rb
@@ -768,6 +774,7 @@ test_files:
 - test/lib/vedeu/editor/document_test.rb
 - test/lib/vedeu/editor/editor_test.rb
 - test/lib/vedeu/editor/insert_test.rb
+- test/lib/vedeu/editor/item_test.rb
 - test/lib/vedeu/editor/line_test.rb
 - test/lib/vedeu/editor/lines_test.rb
 - test/lib/vedeu/editor/repository_test.rb