vedeu 0.2.12 → 0.3.0

data/lib/vedeu/models/border.rb

@@ -1,238 +0,0 @@
-module Vedeu
-
-  #
-  #
-  # @note Refer to UTF-8 U+2500 to U+257F for border characters. More details
-  #   can be found at: http://en.wikipedia.org/wiki/Box-drawing_character
-  #
-  class Border
-
-    # Returns a new instance of Border.
-    #
-    # @param interface [Interface]
-    # @param attributes [Hash]
-    # @return [Border]
-    def initialize(interface, attributes = {})
-      @interface  = interface
-      @attributes = defaults.merge(attributes)
-    end
-
-    def enabled?
-      attributes[:enabled]
-    end
-
-    def bottom?
-      attributes[:show_bottom]
-    end
-
-    def left?
-      attributes[:show_left]
-    end
-
-    def right?
-      attributes[:show_right]
-    end
-
-    def top?
-      attributes[:show_top]
-    end
-
-    def to_s
-      to_viewport.map { |line| line.flatten.join }.join("\n")
-    end
-
-    def to_viewport
-      return viewport unless enabled?
-
-      out = []
-
-      out << top if top?
-
-      viewport[0...height].each do |line|
-        out << [left, line[0...width], right].flatten
-      end
-
-      out << bottom if bottom?
-
-      out
-    end
-
-    private
-
-    attr_reader :attributes, :interface, :attributes
-
-    def bottom
-      return [] unless bottom?
-
-      out = []
-
-      out << bottom_left if left?
-      horizontal_border.each do |border|
-        out << border
-      end
-      out << bottom_right if right?
-
-      out
-    end
-
-    def left
-      return '' unless left?
-
-      vertical_border
-    end
-
-    def right
-      return '' unless right?
-
-      vertical_border
-    end
-
-    def top
-      return [] unless top?
-
-      out = []
-      out << top_left if left?
-      horizontal_border.each do |border|
-        out << border
-      end
-      out << top_right if right?
-
-      out
-    end
-
-    def bottom_left
-      [*presentation, on, bl, off, *reset].join
-    end
-
-    def bottom_right
-      [*presentation, on, br, off, *reset].join
-    end
-
-    def top_left
-      [*presentation, on, tl, off, *reset].join
-    end
-
-    def top_right
-      [*presentation, on, tr, off, *reset].join
-    end
-
-    def width
-      if left? && right?
-        interface.width - 2
-
-      elsif left? || right?
-        interface.width - 1
-
-      else
-        interface.width
-
-      end
-    end
-
-    def height
-      if top? && bottom?
-        interface.height - 2
-
-      elsif top? || bottom?
-        interface.height - 1
-
-      else
-        interface.height
-
-      end
-    end
-
-    def horizontal_border
-      [[*presentation, on, h, off, *reset].join] * width
-    end
-
-    def horizontal_space
-      [' '] * width
-    end
-
-    def vertical_border
-      [*presentation, on, v, off, *reset].join
-    end
-
-    def h
-      attributes[:horizontal]
-    end
-
-    def v
-      attributes[:vertical]
-    end
-
-    def tr
-      attributes[:top_right]
-    end
-
-    def tl
-      attributes[:top_left]
-    end
-
-    def br
-      attributes[:bottom_right]
-    end
-
-    def bl
-      attributes[:bottom_left]
-    end
-
-    def on
-      "\e(0"
-    end
-
-    def off
-      "\e(B"
-    end
-
-    def viewport
-      interface.viewport
-    end
-
-    def presentation
-      [colour.to_s, style.to_s]
-    end
-
-    def reset
-      [interface.colour.to_s, interface.style.to_s]
-    end
-
-    # Returns a new Colour instance.
-    #
-    # @return [Colour]
-    def colour
-      @colour ||= Colour.new(attributes[:colour])
-    end
-
-    # Returns a new Style instance.
-    #
-    # @return [Style]
-    def style
-      @style ||= Style.new(attributes[:style])
-    end
-
-    # The default values for a new instance of Border.
-    #
-    # @return [Hash]
-    def defaults
-      {
-        enabled:      false,
-        show_bottom:  true,
-        show_left:    true,
-        show_right:   true,
-        show_top:     true,
-        bottom_right: "\x6A", # ┘
-        top_right:    "\x6B", # ┐
-        top_left:     "\x6C", # ┌
-        bottom_left:  "\x6D", # └
-        horizontal:   "\x71", # ─
-        colour:       {},
-        style:        [],
-        vertical:     "\x78", # │
-      }
-    end
-
-  end # Border
-
-end # Vedeu

data/lib/vedeu/models/char.rb

@@ -1,43 +0,0 @@
-module Vedeu
-
-  # A Char represents a single character of the terminal. It is a container for
-  # the a single character in a {Vedeu::Stream}.
-  #
-  # @note The parent of a Char is a Line.
-  # @todo Colour and style is not being correctly reset. (GL 2014-10-19)
-  #
-  # @api private
-  class Char
-
-    include Presentation
-
-    attr_reader :attributes, :parent, :value
-    alias_method :data, :value
-
-    # Returns a new instance of Char.
-    #
-    # @param attributes [Hash]
-    # @return [Char]
-    def initialize(attributes = {})
-      @attributes = defaults.merge(attributes)
-      @parent     = @attributes[:parent]
-      @value      = @attributes[:value]
-    end
-
-    private
-
-    # The default values for a new instance of Char.
-    #
-    # @return [Hash]
-    def defaults
-      {
-        colour: {},
-        parent: nil,
-        style:  [],
-        value:  '',
-      }
-    end
-
-  end # Char
-
-end # Vedeu

data/lib/vedeu/models/composition.rb

@@ -1,72 +0,0 @@
-module Vedeu
-
-  # A composition is a collection of interfaces.
-  #
-  # @api private
-  class Composition
-
-    attr_reader :attributes
-
-    # Builds a new composition, ready to be rendered to the screen.
-    #
-    # @param attributes [Hash]
-    # @param block [Proc]
-    # @return [Hash]
-    def self.build(attributes = {}, &block)
-      new(attributes, &block).attributes
-    end
-
-    # Returns a new instance of Composition.
-    #
-    # @param attributes [Hash]
-    # @param block [Proc]
-    # @return [Composition]
-    def initialize(attributes = {}, &block)
-      @attributes = defaults.merge(attributes)
-
-      if block_given?
-        @self_before_instance_eval = eval('self', block.binding)
-
-        instance_eval(&block)
-      end
-    end
-
-    # Returns a collection of interfaces associated with this composition.
-    #
-    # @return [Array]
-    def interfaces
-      @interfaces ||= Interface.coercer(attributes[:interfaces])
-    end
-
-    # Returns the view attributes for a Composition, which will always be none,
-    # as a composition is a merely a collection of interfaces.
-    #
-    # @return [Hash]
-    def view_attributes
-      {}
-    end
-
-    private
-
-    # The default values for a new instance of Composition.
-    #
-    # @return [Hash]
-    def defaults
-      {
-        interfaces: []
-      }
-    end
-
-    # @param method [Symbol] The name of the method sought.
-    # @param args [Array] The arguments which the method was to be invoked with.
-    # @param block [Proc] The optional block provided to the method.
-    # @return []
-    def method_missing(method, *args, &block)
-      Vedeu.log("Composition#method_missing '#{method}' (args: #{args.inspect})")
-
-      @self_before_instance_eval.send(method, *args, &block) if @self_before_instance_eval
-    end
-
-  end # Composition
-
-end # Vedeu

data/lib/vedeu/models/line.rb

@@ -1,100 +0,0 @@
-module Vedeu
-
-  # A Line represents a single row of the terminal. It is a container for
-  # {Vedeu::Stream} objects. A line's width is determined by the
-  # {Vedeu::Interface} it belongs to.
-  #
-  # @api private
-  class Line
-
-    include Coercions
-    include Presentation
-
-    attr_reader :attributes, :parent
-
-    # Builds up a new Line object and returns the attributes.
-    #
-    # @param attributes [Hash]
-    # @param block [Proc]
-    # @return [Hash]
-    def self.build(attributes = {}, &block)
-      new(attributes, &block).attributes
-    end
-
-    # Returns a new instance of Line.
-    #
-    # @param attributes [Hash]
-    # @param block [Proc]
-    # @return [Line]
-    def initialize(attributes = {}, &block)
-      @attributes = defaults.merge(attributes)
-      @parent     = @attributes[:parent]
-
-      if block_given?
-        @self_before_instance_eval = eval('self', block.binding)
-
-        instance_eval(&block)
-      end
-    end
-
-    # Returns an array of all the characters with formatting for this line.
-    #
-    # @return [Array]
-    # @see Vedeu::Stream
-    def chars
-      return [] if empty?
-
-      @_chars ||= streams.map(&:chars).flatten
-    end
-
-    # Returns a boolean indicating whether the line has content.
-    #
-    # @return [Boolean]
-    def empty?
-      size == 0
-    end
-
-    # Returns the size of the content in characters without formatting.
-    #
-    # @return [Fixnum]
-    def size
-      streams.map(&:size).inject(0, :+) { |sum, x| sum += x }
-    end
-
-    # Returns a collection of streams associated with this line. This method
-    # also has the alias_method :data, a convenience method to provide
-    # Presentation with a consistent interface.
-    #
-    # @return [Array]
-    def streams
-      @streams ||= Stream.coercer(attributes[:streams])
-    end
-    alias_method :data, :streams
-
-    private
-
-    # The default values for a new instance of Line.
-    #
-    # @return [Hash]
-    def defaults
-      {
-        colour:  {},
-        streams: [],
-        style:   [],
-        parent:  nil,
-      }
-    end
-
-    # @param method [Symbol] The name of the method sought.
-    # @param args [Array] The arguments which the method was to be invoked with.
-    # @param block [Proc] The optional block provided to the method.
-    # @return []
-    def method_missing(method, *args, &block)
-      Vedeu.log("Line#method_missing '#{method}' (args: #{args.inspect})")
-
-      @self_before_instance_eval.send(method, *args, &block) if @self_before_instance_eval
-    end
-
-  end # Line
-
-end # Vedeu

data/lib/vedeu/models/stream.rb

@@ -1,130 +0,0 @@
-module Vedeu
-
-  # A Stream can represent a character or collection of characters as part of a
-  # {Vedeu::Line} which you wish to colour and style independently of the other
-  # characters in that line.
-  #
-  # @api private
-  class Stream
-
-    include Coercions
-    include Presentation
-
-    attr_reader :attributes, :align, :text, :width, :parent
-
-    # Builds up a new Stream object and returns the attributes.
-    #
-    # @param attributes [Hash]
-    # @param block [Proc]
-    # @return [Hash]
-    def self.build(attributes = {}, &block)
-      new(attributes, &block).attributes
-    end
-
-    # Returns a new instance of Stream.
-    #
-    # @param attributes [Hash]
-    # @param block [Proc]
-    # @return [Stream]
-    def initialize(attributes = {}, &block)
-      @attributes = defaults.merge(attributes)
-      @align      = @attributes[:align]
-      @text       = @attributes[:text]
-      @width      = @attributes[:width]
-      @parent     = @attributes[:parent]
-
-      if block_given?
-        @self_before_instance_eval = eval('self', block.binding)
-
-        instance_eval(&block)
-      end
-    end
-
-    # Returns an array of characters, each element is the escape sequences of
-    # colours and styles for this stream, the character itself, and the escape
-    # sequences of colours and styles for the parent of the stream
-    # ({Vedeu::Line}).
-    #
-    # @return [Array]
-    def chars
-      return [] if empty?
-
-      char_attrs = view_attributes.merge!({ parent: parent })
-
-      @_chars ||= content.chars.map do |c|
-        Char.new(char_attrs.merge!({ value: c })).to_s
-      end
-    end
-
-    # Returns the text aligned if a width was set, otherwise just the text. This
-    # method also has the alias_method :data, a convenience method to provide
-    # Presentation with a consistent interface.
-    #
-    # @return [String]
-    def content
-      width? ? aligned : text
-    end
-    alias_method :data, :content
-
-    # Returns a boolean indicating whether the stream has content.
-    #
-    # @return [Boolean]
-    def empty?
-      size == 0
-    end
-
-    # Returns the size of the content in characters without formatting.
-    #
-    # @return [Fixnum]
-    def size
-      content.size
-    end
-
-    private
-
-    # Returns an aligned string if the string is shorter than the specified
-    # width; the excess area being padded by spaces.
-    #
-    # @return [String]
-    def aligned
-      case align
-      when :right  then text.rjust(width,  ' ')
-      when :centre then text.center(width, ' ')
-      else text.ljust(width, ' ')
-      end
-    end
-
-    # Returns a boolean to indicate whether this stream has a width set.
-    #
-    # @return [Boolean]
-    def width?
-      !!width
-    end
-
-    # The default values for a new instance of Stream.
-    #
-    # @return [Hash]
-    def defaults
-      {
-        colour: {},
-        style:  [],
-        text:   '',
-        width:  nil,
-        align:  :left,
-        parent: nil,
-      }
-    end
-
-    # @param method [Symbol] The name of the method sought.
-    # @param args [Array] The arguments which the method was to be invoked with.
-    # @param block [Proc] The optional block provided to the method.
-    # @return []
-    def method_missing(method, *args, &block)
-      Vedeu.log("Stream#method_missing '#{method}' (args: #{args.inspect})")
-
-      @self_before_instance_eval.send(method, *args, &block) if @self_before_instance_eval
-    end
-
-  end # Stream
-
-end # Vedeu

data/lib/vedeu/models/style.rb

@@ -1,52 +0,0 @@
-module Vedeu
-
-  # Converts the style value or value collection into a terminal escape
-  # sequence. Unrecognised values are discarded- an empty string is returned.
-  #
-  # @api private
-  class Style
-
-    include Vedeu::Common
-
-    attr_reader :attributes, :values
-
-    # Return a new instance of Style.
-    #
-    # @param values [String|Array] The style value or values collection.
-    # @return [Style]
-    def initialize(values)
-      @values = values
-    end
-
-    # Return an attributes hash for this class.
-    #
-    # @return [Hash]
-    def attributes
-      {
-        style: values
-      }
-    end
-
-    # Return the terminal escape sequences for the values provided.
-    #
-    # @return [String]
-    def to_s
-      escape_sequences
-    end
-
-    private
-
-    # Converts the style or styles into terminal escape sequences.
-    #
-    # @return [String]
-    def escape_sequences
-      return '' unless defined_value?(values)
-
-      @_sequences ||= Array(values).flatten.map do |value|
-        Esc.string(value)
-      end.join
-    end
-
-  end # Style
-
-end # Vedeu

data/lib/vedeu/repositories/buffers.rb

@@ -1,52 +0,0 @@
-module Vedeu
-
-  # Stores interface views to be later combined with interface geometry to be
-  # displayed.
-  #
-  # @api private
-  module Buffers
-
-    include Repository
-    extend self
-
-    # Add an interface view into the back buffer. If the buffer is already
-    # registered, then we preserve its front buffer. Returns the name of the
-    # buffer added to storage.
-    #
-    # @param attributes [Hash]
-    # @return [String] The name of the buffer that has been added.
-    def add(attributes)
-      validate_attributes!(attributes)
-
-      name = attributes[:name]
-
-      if registered?(name)
-        Vedeu.log("Adding new content to existing buffer: '#{name}'")
-
-        find(name).add(attributes)
-
-      else
-        Vedeu.log("Adding new buffer: '#{name}'")
-
-        model.new({ name: name }).add(attributes)
-
-      end
-
-      name
-    end
-
-    private
-
-    # @return [Class] The model class for this repository.
-    def model
-      Vedeu::Buffer
-    end
-
-    # @return [Hash]
-    def in_memory
-      {}
-    end
-
-  end # Buffers
-
-end # Vedeu