vedeu 0.3.0 → 0.3.1

data/lib/vedeu/dsl/line.rb

@@ -1,5 +1,4 @@
 require 'vedeu/dsl/shared/all'
-require 'vedeu/support/common'
 
 module Vedeu
 
@@ -37,7 +36,6 @@ module Vedeu
     # @api public
     class Line
 
-      include Vedeu::Common
       include Vedeu::DSL
       include Vedeu::DSL::Colour
       include Vedeu::DSL::Style
@@ -105,7 +103,7 @@ module Vedeu
       def streams(&block)
         fail InvalidSyntax, 'block not given' unless block_given?
 
-        model.add(child.build(attributes, &block))
+        model.add(model.member.build(attributes, &block))
       end
       alias_method :stream, :streams
 
@@ -121,13 +119,6 @@ module Vedeu
         }
       end
 
-      # Return the class name for the children on this model.
-      #
-      # @return [Class]
-      def child
-        Vedeu::Stream
-      end
-
     end # Line
 
   end # DSL

data/lib/vedeu/dsl/stream.rb

@@ -1,5 +1,4 @@
 require 'vedeu/dsl/shared/all'
-require 'vedeu/support/common'
 
 module Vedeu
 
@@ -10,7 +9,6 @@ module Vedeu
     # @api public
     class Stream
 
-      include Vedeu::Common
       include Vedeu::DSL
       include Vedeu::DSL::Colour
       include Vedeu::DSL::Style

data/lib/vedeu/input/key.rb

@@ -5,13 +5,17 @@ module Vedeu
   #
   class Key
 
-    # Creates a new instance of Key.
-    #
-    # @see Vedeu::Key#initialize
-    def self.define(input = nil, &block)
-      fail InvalidSyntax, 'block not given' unless block_given?
+    class << self
+
+      # Creates a new instance of Key.
+      #
+      # @see Vedeu::Key#initialize
+      def build(input = nil, &block)
+        fail InvalidSyntax, 'block not given' unless block_given?
+
+        new(input, &block)
+      end
 
-      new(input, &block)
     end
 
     # Returns a new instance of Key.

data/lib/vedeu/input/keymap.rb

@@ -1,5 +1,4 @@
 require 'vedeu/exceptions'
-require 'vedeu/support/common'
 require 'vedeu/models/model'
 require 'vedeu/dsl/components/keymap'
 
@@ -7,15 +6,16 @@ module Vedeu
 
   class Keymap
 
-    include Vedeu::Common
     include Vedeu::Model
 
+    collection Vedeu::Keys
+    member     Vedeu::Key
+
     attr_accessor :name
-    attr_reader   :keys, :repository
+    attr_reader   :repository
 
     class << self
 
-
       # @option attributes client []
       # @option attributes keys []
       # @option attributes name []
@@ -81,7 +81,7 @@ module Vedeu
     # @return [Vedeu::Keymap]
     def initialize(name = '', keys = [], repository = nil)
       @name       = name
-      @keys       = Vedeu::Model::Collection.coerce(keys)
+      @keys       = keys
       @repository = repository || Vedeu.keymaps
     end
 
@@ -89,10 +89,12 @@ module Vedeu
     def add(key)
       return false unless valid?(key)
 
-      @keys << key
+      @keys = keys.add(key)
+    end
 
-      # immutable Keymap version:
-      # self.new(name, @keys += [key]).store if valid?(key)
+    # @return [Vedeu::Keys]
+    def keys
+      collection.coerce(@keys,  self)
     end
 
     # @param input [String|Symbol]

data/lib/vedeu/models/menu.rb

@@ -1,5 +1,4 @@
 require 'vedeu/models/model'
-require 'vedeu/support/common'
 
 module Vedeu
 
@@ -9,7 +8,6 @@ module Vedeu
   # @api private
   class Menu
 
-    include Vedeu::Common
     include Vedeu::Model
 
     attr_accessor :collection

data/lib/vedeu/models/model.rb

@@ -8,6 +8,25 @@ module Vedeu
 
     attr_reader :repository
 
+    module ClassMethods
+
+      # Provide a convenient way to define the child or children of a model.
+      #
+      # @param klass [Class] The member (singular) or collection (multiple)
+      #   class name for the respective model.
+      # @return []
+      def child(klass)
+        send(:define_method, __callee__) { klass }
+      end
+      alias_method :member,     :child
+      alias_method :collection, :child
+
+    end # ClassMethods
+
+    def self.included(klass)
+      klass.send :extend, ClassMethods
+    end
+
     # Returns a DSL instance responsible for defining the DSL methods of this
     # model.
     #
@@ -20,6 +39,7 @@ module Vedeu
       Object.const_get(dsl_class).new(self, client)
     end
 
+    # @todo Perhaps some validation could be added here?
     # @return [void] The model instance stored in the repository.
     def store
       repository.store(self) # if valid?

data/lib/vedeu/models/view/composition.rb

@@ -16,6 +16,9 @@ module Vedeu
     include Vedeu::Presentation
     include Vedeu::Model
 
+    collection Vedeu::Interfaces
+    member     Vedeu::Interface
+
     attr_reader  :interfaces
     alias_method :value, :interfaces
 
@@ -77,23 +80,7 @@ module Vedeu
 
     # @return [Vedeu::Interfaces]
     def interfaces
-      children.coerce(@interfaces, self)
-    end
-
-    private
-
-    # Return the class name for the children on this model.
-    #
-    # @return [Class]
-    def child
-      Vedeu::Interface
-    end
-
-    # Return the class name for the children on this model.
-    #
-    # @return [Class]
-    def children
-      Vedeu::Interfaces
+      collection.coerce(@interfaces, self)
     end
 
   end # Composition

data/lib/vedeu/models/view/interface.rb

@@ -1,4 +1,3 @@
-require 'vedeu/support/common'
 require 'vedeu/support/content_geometry'
 require 'vedeu/models/model'
 require 'vedeu/presentation/presentation'
@@ -6,6 +5,7 @@ require 'vedeu/buffers/display_buffer'
 require 'vedeu/buffers/buffer'
 
 require 'vedeu/models/view/lines'
+require 'vedeu/models/view/line'
 
 module Vedeu
 
@@ -18,11 +18,13 @@ module Vedeu
 
     extend Forwardable
 
-    include Vedeu::Common
     include Vedeu::Model
     include Vedeu::Presentation
     include Vedeu::DisplayBuffer
 
+    collection Vedeu::Lines
+    member     Vedeu::Line
+
     attr_accessor :border,
       :colour,
       :delay,
@@ -155,7 +157,7 @@ module Vedeu
 
     # @return [Vedeu::Lines]
     def lines
-      children.coerce(@lines, self)
+      collection.coerce(@lines, self)
     end
     alias_method :content, :lines
     alias_method :value, :lines
@@ -167,9 +169,11 @@ module Vedeu
       lines.any?
     end
 
-    # @return []
+    # Renders the interface with a border if one is defined.
+    #
+    # @return [Array]
     def render
-      if border
+      if border?
         border.render
 
       else
@@ -194,22 +198,6 @@ module Vedeu
       Vedeu::Viewport.show(self)
     end
 
-    private
-
-    # Return the class name for the children on this model.
-    #
-    # @return [Class]
-    def child
-      Vedeu::Line
-    end
-
-    # Return the class name for the children on this model.
-    #
-    # @return [Class]
-    def children
-      Vedeu::Lines
-    end
-
   end # Interface
 
 end # Vedeu

data/lib/vedeu/models/view/line.rb

@@ -15,6 +15,9 @@ module Vedeu
     include Vedeu::Model
     include Vedeu::Presentation
 
+    collection Vedeu::Streams
+    member     Vedeu::Stream
+
     attr_accessor :parent,
       :streams
 
@@ -103,7 +106,7 @@ module Vedeu
 
     # @return [Vedeu::Streams]
     def streams
-      children.coerce(@streams, self)
+      collection.coerce(@streams, self)
     end
 
     # Delegate to Vedeu::Interface#width if available.
@@ -113,22 +116,6 @@ module Vedeu
       parent.width if parent
     end
 
-    private
-
-    # Return the class name for the children on this model.
-    #
-    # @return [Class]
-    def child
-      Vedeu::Stream
-    end
-
-    # Return the class name for the children on this model.
-    #
-    # @return [Class]
-    def children
-      Vedeu::Streams
-    end
-
   end # Line
 
 end # Vedeu

data/lib/vedeu/models/view/stream.rb

@@ -13,6 +13,9 @@ module Vedeu
     include Vedeu::Model
     include Vedeu::Presentation
 
+    collection Vedeu::Chars
+    member     Vedeu::Char
+
     attr_accessor :parent,
       :value
 
@@ -85,7 +88,7 @@ module Vedeu
       return [] if value.empty?
 
       value.chars.map do |char|
-        child.new(char, parent, colour, style, nil).to_s
+        member.new(char, parent, colour, style, nil).to_s
       end
     end
 
@@ -123,22 +126,6 @@ module Vedeu
       parent.width if parent
     end
 
-    private
-
-    # Return the class name for the children on this model.
-    #
-    # @return [Class]
-    def child
-      Vedeu::Char
-    end
-
-    # Return the class name for the collection of children on this model.
-    #
-    # @return [Class]
-    def children
-      Vedeu::Chars
-    end
-
   end # Stream
 
 end # Vedeu

data/lib/vedeu/output/all.rb

@@ -2,6 +2,7 @@ require 'vedeu/output/border'
 require 'vedeu/output/compositor'
 require 'vedeu/output/output'
 require 'vedeu/output/viewport'
+require 'vedeu/output/wordwrap'
 require 'vedeu/output/writer'
 
 module Vedeu

data/lib/vedeu/output/border.rb

@@ -124,14 +124,14 @@ module Vedeu
 
     # Set the border colour.
     #
-    # @return []
+    # @return [Vedeu::Colour]
     def colour=(value)
       @colour = Colour.coerce(value)
     end
 
     # Set the border style.
     #
-    # @return []
+    # @return [Vedeu::Style]
     def style=(value)
       @style = Style.coerce(value)
     end

data/lib/vedeu/output/compositor.rb

@@ -1,5 +1,3 @@
-require 'vedeu/support/common'
-
 module Vedeu
 
   # Before the content of the buffer can be output to the terminal, if there are
@@ -14,8 +12,6 @@ module Vedeu
   # @api private
   class Compositor
 
-    include Vedeu::Common
-
     # Convenience method to initialize a new Compositor and call its {#compose}
     # method.
     #

data/lib/vedeu/output/wordwrap.rb

@@ -0,0 +1,146 @@
+module Vedeu
+
+  class Wordwrap
+
+    # @param text [String]
+    # @param options [Hash]
+    # @option options ellipsis [String]
+    # @option options width [Fixnum]
+    # @return [Vedeu::Wordwrap]
+    def initialize(text, options = {})
+      @text    = text
+      @options = defaults.merge(options)
+    end
+
+    # @return [Array<String>|String]
+    def prune
+      return text if text.size <= pruned_width
+
+      processed = []
+
+      if split_lines.size > 1
+        processed = split_lines.reduce([]) do |acc, line|
+          acc << ellipsis_string(line)
+        end
+
+      else
+        processed = ellipsis_string(text)
+
+      end
+
+      processed
+    end
+
+    # @return [String]
+    def wrap
+      processed = []
+      text.split(/\n/).map do |unprocessed|
+        line_length = 0
+        reformatted = []
+
+        unprocessed.split(/\s/).map do |word|
+          word_length = word.length + 1
+
+          if (line_length += word_length) >= width
+            line_length = word_length
+            processed   << reformatted
+            reformatted = []
+          end
+
+          reformatted << word
+        end
+
+        processed << reformatted
+      end
+
+      processed.reduce([]) do |output, line|
+        output << line.join(' ')
+      end
+    end
+
+    def as_lines
+      if __callee__ == :prune_as_lines
+        to_line_objects(prune)
+
+      elsif __callee__ == :wrap_as_lines
+        to_line_objects(wrap)
+
+      else
+        to_line_objects(split_lines)
+
+      end
+    end
+    alias_method :prune_as_lines, :as_lines
+    alias_method :wrap_as_lines, :as_lines
+
+    private
+
+    attr_reader :text, :options
+
+    # @param text_as_lines [Array<String>]
+    # @return [Vedeu::Lines]
+    def to_line_objects(text_as_lines)
+      line_objects = Array(text_as_lines).map do |text_line|
+        stream        = Vedeu::Stream.new(text_line)
+        line          = Vedeu::Line.new
+        stream.parent = line
+        line.add(stream)
+        line
+      end
+      Vedeu::Lines.new(line_objects)
+    end
+
+    # @return [Array<String>]
+    def split_lines
+      text.split(/\n/)
+    end
+
+    # @return [String]
+    def output
+      processed.reduce([]) do |output, line|
+        output << line.join(' ')
+      end.join("\n")
+    end
+
+    # @return [String]
+    def ellipsis_string(string)
+      if string.size < ellipsis.size
+        prune_string(string)
+
+      else
+        [prune_string(string), ellipsis].join
+
+      end
+    end
+
+    # @return [String]
+    def prune_string(string)
+      string.chomp.slice(0..pruned_width)
+    end
+
+    # @return [Fixnum]
+    def pruned_width
+      width - ellipsis.size
+    end
+
+    # @return [String]
+    def ellipsis
+      options.fetch(:ellipsis)
+    end
+
+    # @return [Fixnum]
+    def width
+      options.fetch(:width)
+    end
+
+    # @return [Hash]
+    def defaults
+      {
+        ellipsis: '...',
+        width:    70,
+      }
+    end
+
+  end # Wordwrap
+
+end # Vedeu

data/lib/vedeu/repositories/repository.rb

@@ -123,8 +123,9 @@ module Vedeu
 
       end
     end
-    alias_method :destroy, :remove
-    alias_method :delete,  :remove
+    alias_method :destroy,    :remove
+    alias_method :delete,     :remove
+    alias_method :deregister, :remove
 
     # Reset the repository.
     #

data/lib/vedeu/support/console.rb

@@ -5,12 +5,6 @@ module Vedeu
 
   class Console
 
-    attr_reader :height,
-      :width
-
-    alias_method :yn, :height
-    alias_method :xn, :width
-
     # @param height [Fixnum]
     # @param width [Fixnum]
     def initialize(height = 25, width = 80)
@@ -56,17 +50,46 @@ module Vedeu
       centre.last
     end
 
+    # @param block [Proc]
+    # @return [Proc]
+    def cooked(&block)
+      yield
+    end
+
+    # @return [Fixnum]
+    def height
+      @height
+    end
+    alias_method :tyn, :height
+    alias_method :yn, :height
+
     # @return [Fixnum]
     def origin
       1
     end
     alias_method :x, :origin
     alias_method :y, :origin
+    alias_method :tx, :origin
+    alias_method :ty, :origin
+
+    # @param block [Proc]
+    # @return [Proc]
+    def raw(&block)
+      yield
+    end
 
     # @return [Array]
     def size
       [height, width]
     end
+    alias_method :winsize, :size
+
+    # @return [Fixnum]
+    def width
+      @width
+    end
+    alias_method :txn, :width
+    alias_method :xn, :width
 
   end # Console
 

data/lib/vedeu/support/content_geometry.rb

@@ -15,6 +15,8 @@ module Vedeu
       :x,
       :y
 
+    # @param interface [Vedeu::Interface]
+    # @return [Vedeu::ContentGeometry]
     def initialize(interface)
       @interface = interface
     end

data/lib/vedeu/support/coordinate.rb

@@ -4,10 +4,15 @@ module Vedeu
   class Coordinate
 
     attr_reader :height,
-                :width,
-                :x,
-                :y
-
+      :width,
+      :x,
+      :y
+
+    # @param height [Fixnum]
+    # @param width [Fixnum]
+    # @param x [Fixnum]
+    # @param y [Fixnum]
+    # @return [Vedeu::Coordinate]
     def initialize(height, width, x, y)
       @height = height
       @width  = width