vedeu 0.6.8 → 0.6.9

data/lib/vedeu/models/interfaces.rb

@@ -1,31 +1,35 @@
 module Vedeu
 
-  # Allows the storing of interfaces and views.
-  #
-  class Interfaces < Vedeu::Repository
+  module Models
 
-    singleton_class.send(:alias_method, :interfaces, :repository)
+    # Allows the storing of interfaces and views.
+    #
+    class Interfaces < Vedeu::Repository
 
-    null Vedeu::Null::Interface
-    real Vedeu::Interface
+      singleton_class.send(:alias_method, :interfaces, :repository)
 
-    # Returns the interfaces in zindex order.
-    #
-    # @example
-    #   Vedeu.interfaces.zindexed
-    #
-    # @return [Array<Vedeu::Interface>]
-    # @see Vedeu::DSL::Interface#zindex
-    def zindexed
-      all.sort_by(&:zindex)
-    end
+      null Vedeu::Null::Interface
+      real Vedeu::Models::Interface
+
+      # Returns the interfaces in zindex order.
+      #
+      # @example
+      #   Vedeu.interfaces.zindexed
+      #
+      # @return [Array<Vedeu::Models::Interface>]
+      # @see Vedeu::DSL::Interface#zindex
+      def zindexed
+        all.sort_by(&:zindex)
+      end
+
+    end # Interfaces
 
-  end # Interfaces
+    class Interface
 
-  class Interface
+      repo Vedeu::Models::Interfaces.repository
 
-    repo Vedeu::Interfaces.repository
+    end # Interface
 
-  end # Interface
+  end # Models
 
 end # Vedeu

data/lib/vedeu/models/toggleable.rb

@@ -1,10 +1,10 @@
 module Vedeu
 
-  # This module provides behaviour for certain classes which can be toggled
-  # between being shown and hidden.
+  # This module provides behaviour for certain classes which can be
+  # toggled between being shown and hidden.
   #
-  # Currently using this are: {Vedeu::Cursors::Cursor}, {Vedeu::Group} and
-  # {Vedeu::Interface}.
+  # Currently using this are: {Vedeu::Cursors::Cursor},
+  # {Vedeu::Models::Group} and {Vedeu::Models::Interface}.
   #
   module Toggleable
 

data/lib/vedeu/models/views/char.rb

@@ -37,7 +37,7 @@ module Vedeu
       # @option attributes colour [Vedeu::Colours::Colour]
       # @option attributes parent [Vedeu::Views::Line]
       # @option attributes position [Vedeu::Geometry::Position]
-      # @option attributes style [Vedeu::Style]
+      # @option attributes style [Vedeu::Presentation::Style]
       # @option attributes value [String]
       # @return [Vedeu::Views::Char]
       def initialize(attributes = {})

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

@@ -25,7 +25,7 @@ module Vedeu
       # @param attributes [Hash]
       # @option attributes client [void]
       # @option attributes colour [Vedeu::Colours::Colour]
-      # @option attributes style [Vedeu::Style]
+      # @option attributes style [Vedeu::Presentation::Style]
       # @option attributes value [Vedeu::Views::ViewCollection]
       # @return [Vedeu::Views::Composition]
       def initialize(attributes = {})

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

@@ -27,7 +27,7 @@ module Vedeu
       # @param attributes [Hash]
       # @option attributes colour [Vedeu::Colours::Colour]
       # @option attributes parent [Vedeu::Views::View]
-      # @option attributes style [Vedeu::Style]
+      # @option attributes style [Vedeu::Presentation::Style]
       # @option attributes value [Vedeu::Views::Streams]
       # @return [Vedeu::Views::Line]
       def initialize(attributes = {})

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

@@ -32,7 +32,7 @@ module Vedeu
       #
       # @param attributes [Hash]
       # @option attributes colour [Vedeu::Colours::Colour]
-      # @option attributes style [Vedeu::Style]
+      # @option attributes style [Vedeu::Presentation::Style]
       # @option attributes parent [Vedeu::Views::Line]
       # @option attributes value [String]
       # @return [Vedeu::Views::Stream]

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

@@ -45,7 +45,7 @@ module Vedeu
       # @option attributes value [Vedeu::Views::Lines]
       # @option attributes name [String]
       # @option attributes parent [Vedeu::Views::Composition]
-      # @option attributes style [Vedeu::Style]
+      # @option attributes style [Vedeu::Presentation::Style]
       # @option attributes zindex [Fixnum]
       # @return [Vedeu::Views::View]
       def initialize(attributes = {})

data/lib/vedeu/null/interface.rb

@@ -1,4 +1,4 @@
-require 'vedeu/output/presentation'
+require 'vedeu/output/presentation/presentation'
 
 module Vedeu
 

data/lib/vedeu/null/view.rb

@@ -1,4 +1,4 @@
-require 'vedeu/output/presentation'
+require 'vedeu/output/presentation/presentation'
 
 module Vedeu
 

data/lib/vedeu/output/clear/named_interface.rb

@@ -51,7 +51,7 @@ module Vedeu
         @geometry ||= Vedeu.geometries.by_name(name)
       end
 
-      # @see Vedeu::Interfaces#by_name
+      # @see Vedeu::Models::Interfaces#by_name
       def interface
         @interface ||= Vedeu.interfaces.by_name(name)
       end

data/lib/vedeu/output/compressor.rb

@@ -1,85 +1,90 @@
 module Vedeu
 
-  # During the conversion of a Vedeu::Views::Char object into a string of escape
-  # sequences, this class removes multiple occurences of the same escape
-  # sequence, resulting in a smaller payload being sent to the renderer.
-  #
-  class Compressor
-
-    # @param output [Array<Array<Vedeu::Views::Char>>]
-    # @return [String]
-    def self.render(output)
-      new(output).render
-    end
-
-    # Returns a new instance of Vedeu::Compressor.
+  module Output
+
+    # During the conversion of a Vedeu::Views::Char object into a
+    # string of escape sequences, this class removes multiple
+    # occurences of the same escape sequence, resulting in a smaller
+    # payload being sent to the renderer.
     #
-    # @param output [Array<Array<Vedeu::Views::Char>>]
-    # @return [Vedeu::Compressor]
-    def initialize(output)
-      @output = output
-      @colour = ''
-      @style  = ''
-    end
-
-    # @note
-    #   Takes approximately ~25ms for 2100 chars. (2015-07-25)
-    # @return [String]
-    def render
-      if Vedeu::Configuration.compression?
-        compress
-
-      else
-        uncompress
+    class Compressor
+
+      # @param output [Array<Array<Vedeu::Views::Char>>]
+      # @return [String]
+      def self.render(output)
+        new(output).render
+      end
 
+      # Returns a new instance of Vedeu::Output::Compressor.
+      #
+      # @param output [Array<Array<Vedeu::Views::Char>>]
+      # @return [Vedeu::Output::Compressor]
+      def initialize(output)
+        @output = output
+        @colour = ''
+        @style  = ''
       end
-    end
 
-    protected
+      # @note
+      #   Takes approximately ~25ms for 2100 chars. (2015-07-25)
+      # @return [String]
+      def render
+        if Vedeu::Configuration.compression?
+          compress
 
-    # @!attribute [r] output
-    # @return [Array<Array<Vedeu::Views::Char>>]
-    attr_reader :output
+        else
+          uncompress
+
+        end
+      end
 
-    private
+      protected
+
+      # @!attribute [r] output
+      # @return [Array<Array<Vedeu::Views::Char>>]
+      attr_reader :output
+
+      private
+
+      # @return [String]
+      def compress
+        out = ''
+        Array(output).flatten.each do |char|
+          out << char.position.to_s
+          out << colour_for(char)
+          out << style_for(char)
+          out << char.value
+        end
+        out
+      end
 
-    # @return [String]
-    def compress
-      out = ''
-      Array(output).flatten.each do |char|
-        out << char.position.to_s
-        out << colour_for(char)
-        out << style_for(char)
-        out << char.value
+      # @return [String]
+      def uncompress
+        out = ''
+        Array(output).flatten.each { |char| out << char.to_s }
+        out
       end
-      out
-    end
-
-    # @return [String]
-    def uncompress
-      out = ''
-      Array(output).flatten.each { |char| out << char.to_s }
-      out
-    end
-
-    # @param char [Vedeu::Views::Char]
-    # @return [String]
-    def colour_for(char)
-      return '' if char.colour == @colour
-
-      @colour = char.colour
-      @colour.to_s
-    end
-
-    # @param char [Vedeu::Views::Char]
-    # @return [String]
-    def style_for(char)
-      return '' if char.style == @style
-
-      @style = char.style
-      @style.to_s
-    end
-
-  end # Compressor
+
+      # @param char [Vedeu::Views::Char]
+      # @return [String]
+      def colour_for(char)
+        return '' if char.colour == @colour
+
+        @colour = char.colour
+        @colour.to_s
+      end
+
+      # @param char [Vedeu::Views::Char]
+      # @return [String]
+      def style_for(char)
+        return '' if char.style == @style
+
+        @style = char.style
+        @style.to_s
+      end
+
+    end # Compressor
+
+  end # Output
 
 end # Vedeu

data/lib/vedeu/output/direct.rb

@@ -1,62 +1,66 @@
 module Vedeu
 
-  # Write a string directly to the terminal at defined coordinates.
-  #
-  class Direct
-
-    # @param value [String]
-    # @param x [Fixnum]
-    # @param y [Fixnum]
-    # @return [String]
-    def self.write(value:, x:, y:)
-      new(value: value, x: x, y: y).write
-    end
-
-    # Returns a new instance of Vedeu::Direct.
+  module Output
+
+    # Write a string directly to the terminal at defined coordinates.
     #
-    # @param value [String]
-    # @param x [Fixnum]
-    # @param y [Fixnum]
-    # @return [Vedeu::Direct]
-    def initialize(value:, x:, y:)
-      @value = value || ''
-      @x     = x     || 1
-      @y     = y     || 1
-    end
-
-    # @return [String]
-    def write
-      Vedeu::Terminal.output(output)
-
-      output
-    end
-
-    protected
-
-    # @attribute [r] value
-    # @return [String]
-    attr_reader :value
-
-    # @attribute [r] x
-    # @return [Fixnum]
-    attr_reader :x
-
-    # @attribute [r] y
-    # @return [Fixnum]
-    attr_reader :y
-
-    private
-
-    # @return [String]
-    def output
-      (Array(position) + Array(value)).join
-    end
-
-    # @return [String]
-    def position
-      Vedeu::Geometry::Position.new(y, x).to_s
-    end
-
-  end # Direct
+    class Direct
+
+      # @param value [String]
+      # @param x [Fixnum]
+      # @param y [Fixnum]
+      # @return [String]
+      def self.write(value:, x:, y:)
+        new(value: value, x: x, y: y).write
+      end
+
+      # Returns a new instance of Vedeu::Output::Direct.
+      #
+      # @param value [String]
+      # @param x [Fixnum]
+      # @param y [Fixnum]
+      # @return [Vedeu::Output::Direct]
+      def initialize(value:, x:, y:)
+        @value = value || ''
+        @x     = x     || 1
+        @y     = y     || 1
+      end
+
+      # @return [String]
+      def write
+        Vedeu::Terminal.output(output)
+
+        output
+      end
+
+      protected
+
+      # @attribute [r] value
+      # @return [String]
+      attr_reader :value
+
+      # @attribute [r] x
+      # @return [Fixnum]
+      attr_reader :x
+
+      # @attribute [r] y
+      # @return [Fixnum]
+      attr_reader :y
+
+      private
+
+      # @return [String]
+      def output
+        (Array(position) + Array(value)).join
+      end
+
+      # @return [String]
+      def position
+        Vedeu::Geometry::Position.new(y, x).to_s
+      end
+
+    end # Direct
+
+  end # Output
 
 end # Vedeu

data/lib/vedeu/output/output.rb

@@ -1,43 +1,48 @@
 module Vedeu
 
-  # Sends the output to the renderers.
-  #
-  class Output
+  module Output
 
-    # Writes output to the defined renderers.
+    # Sends the output to the renderers.
     #
-    # @return [Array|String]
-    # @see #initialize
-    def self.render(output)
-      new(output).render
-    end
+    class Output
+
+      # Writes output to the defined renderers.
+      #
+      # @return [Array|String]
+      # @see #initialize
+      def self.render(output)
+        new(output).render
+      end
 
-    # Return a new instance of Vedeu::Output.
-    #
-    # @param output [Array<Array<Vedeu::Views::Char>>]
-    # @return [Vedeu::Output]
-    def initialize(output)
-      @output = output
-    end
+      # Return a new instance of Vedeu::Output::Output.
+      #
+      # @param output [Array<Array<Vedeu::Views::Char>>]
+      # @return [Vedeu::Output::Output]
+      def initialize(output)
+        @output = output
+      end
 
-    # Send the view to the renderers.
-    #
-    # @return [Array]
-    def render
-      if Vedeu::Configuration.drb?
-        Vedeu.trigger(:_drb_store_output_, output)
+      # Send the view to the renderers.
+      #
+      # @return [Array]
+      def render
+        if Vedeu::Configuration.drb?
+          Vedeu.trigger(:_drb_store_output_, output)
+
+          # Vedeu::Renderers::HTML.
+          # to_file(Vedeu::Buffers::VirtualBuffers.retrieve)
+        end
 
-        # Vedeu::Renderers::HTML.to_file(Vedeu::VirtualBuffers.retrieve)
+        Vedeu.renderers.render(output) if Vedeu.ready?
       end
 
-      Vedeu.renderers.render(output) if Vedeu.ready?
-    end
+      protected
 
-    protected
+      # @!attribute [r] output
+      # @return [Array<Array<Vedeu::Views::Char>>]
+      attr_reader :output
 
-    # @!attribute [r] output
-    # @return [Array<Array<Vedeu::Views::Char>>]
-    attr_reader :output
+    end # Output
 
   end # Output