vedeu 0.8.10 → 0.8.12

data/lib/vedeu/output/compressors/character.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module Vedeu
+
+  module Output
+
+    module Compressors
+
+      # A simple character based compressor which compressed based on
+      # the previous character's attributes.
+      #
+      # @api private
+      #
+      class Character
+
+        # @param (see #initialize)
+        # @return (see #with)
+        def self.with(content)
+          new(content).with
+        end
+
+        # @param content [Array<void>]
+        # @return [Vedeu::Output::Compressors::Character]
+        def initialize(content)
+          @content = content
+          @colour  = ''
+          @style   = ''
+        end
+
+        # @return [String]
+        def with
+          @same = ''
+          @compress ||= Vedeu.timer(message) do
+            content.map do |cell|
+              rendered = [
+                cell.position.to_s,
+                colour_for(cell),
+                style_for(cell),
+                cell.value,
+              ].join
+
+              if @same == rendered
+                next
+
+              else
+                @same = rendered
+                @same
+
+              end
+            end.join.tap do |out|
+              Vedeu.log(type:    :compress,
+                        message: "#{message} -> #{out.size} characters")
+            end
+          end
+        end
+
+        protected
+
+        # @!attribute [r] content
+        # @return [void]
+        attr_reader :content
+
+        # Compress by not repeatedly sending the same colours for each
+        # character which has the same colours as the last character
+        # output.
+        #
+        # @param char [Vedeu::Cells::Char]
+        # @return [String]
+        def colour_for(char)
+          return '' if char.colour == @colour
+
+          @colour = char.colour
+          @colour.to_s
+        end
+
+        # @return [String]
+        def message
+          "Compression for #{original_size} objects"
+        end
+
+        # @return [Fixnum]
+        def original_size
+          content.size
+        end
+
+        # Compress by not repeatedly sending the same style(s) for each
+        # character which has the same style(s) as the last character
+        # output.
+        #
+        # @param char [Vedeu::Cells::Char]
+        # @return [String]
+        def style_for(char)
+          return '' if char.style == @style
+
+          @style = char.style
+          @style.to_s
+        end
+
+      end # Character
+
+    end # Compressors
+
+  end # Output
+
+end # Vedeu

data/lib/vedeu/output/compressors/simple.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Vedeu
+
+  module Output
+
+    module Compressors
+
+      # A simple compressor which does not compress- it converts each
+      # buffer object into a string and returns the resulting blob of
+      # text.
+      #
+      # @api private
+      #
+      class Simple
+
+        # @param (see #initialize)
+        # @return (see #with)
+        def self.with(content)
+          new(content).with
+        end
+
+        # @param content [Array<void>]
+        # @return [Vedeu::Output::Compressors::Simple]
+        def initialize(content)
+          @content = content
+        end
+
+        # @return [String]
+        def with
+          Vedeu.log(type:    :compress,
+                    message: "No compression for #{original_size} objects -> " \
+                             "#{compress_size} characters")
+
+          compress
+        end
+
+        protected
+
+        # @!attribute [r] content
+        # @return [void]
+        attr_reader :content
+
+        private
+
+        # @return [String]
+        def compress
+          @_compress ||= content.map(&:to_s).join
+        end
+
+        # @return [Fixnum]
+        def compress_size
+          compress.size
+        end
+
+        # @return [Fixnum]
+        def original_size
+          content.size
+        end
+
+      end # Simple
+
+    end # Compressors
+
+  end # Output
+
+end # Vedeu

data/lib/vedeu/output/output.rb

@@ -14,28 +14,28 @@ module Vedeu
 
       class << self
 
-        # @param (see #output)
-        # @return (see #buffer_update)
+        # @param (see Vedeu::Output::Output#initialize)
+        # @return (see Vedeu::Output::Output#buffer_update)
         def buffer_update(output)
           new(output).buffer_update
         end
 
-        # @param (see #output)
-        # @return (see #buffer_write)
+        # @param (see Vedeu::Output::Output#initialize)
+        # @return (see Vedeu::Output::Output#buffer_write)
         def buffer_write(output)
           new(output).buffer_write
         end
 
-        # @param (see #output)
-        # @return (see #direct_write)
+        # @param (see Vedeu::Output::Output#initialize)
+        # @return (see Vedeu::Output::Output#direct_write)
         def direct_write(output)
           new(output).direct_write
         end
 
-        # Writes output to the defined renderers.
+        # {include:file:docs/dsl/by_method/render_output.md}
         #
-        # @param (see #output)
-        # @return (see #render_output)
+        # @param (see Vedeu::Output::Output#initialize)
+        # @return (see Vedeu::Output::Output#render_output)
         def render_output(output)
           new(output).render_output
         end
@@ -44,7 +44,7 @@ module Vedeu
 
       # Return a new instance of Vedeu::Output::Output.
       #
-      # @param (see #output)
+      # @param output [String]
       # @return [Vedeu::Output::Output]
       def initialize(output)
         @output = output
@@ -73,6 +73,8 @@ module Vedeu
       # not other renderers.
       #
       # @return [Array<String>|String|NilClass]
+      # @see #buffer_write
+      # @see #direct_write
       def render_output
         if escape?(output)
           direct_write
@@ -94,20 +96,24 @@ module Vedeu
 
   end # Output
 
-  # Write the given output to the configured or default renderers.
-  #
-  # @example
-  #   Vedeu.buffer_update(output)
-  #   Vedeu.buffer_write(output)
-  #   Vedeu.direct_write(output)
-  #   Vedeu.render_output(output)
-  #
+  # @api public
+  # @!method buffer_update
+  # @see file:docs/dsl/by_method/buffer_update.md
+  def_delegators Vedeu::Output::Output, :buffer_update
+
+  # @api public
+  # @!method buffer_write
+  # @see file:docs/dsl/by_method/buffer_write.md
+  def_delegators Vedeu::Output::Output, :buffer_write
+
+  # @api public
+  # @!method direct_write
+  # @see file:docs/dsl/by_method/direct_write.md
+  def_delegators Vedeu::Output::Output, :direct_write
+
+  # @api public
   # @!method render_output
-  # @return (see Vedeu::Output::Output#render_output)
-  def_delegators Vedeu::Output::Output,
-                 :buffer_update,
-                 :buffer_write,
-                 :direct_write,
-                 :render_output
+  # @see file:docs/dsl/by_method/render_output.md
+  def_delegators Vedeu::Output::Output, :render_output
 
 end # Vedeu

data/lib/vedeu/output/write.rb

@@ -109,6 +109,7 @@ module Vedeu
 
   end # Output
 
+  # @api public
   # @!method write
   #   @see Vedeu::Output::Write#write
   def_delegators Vedeu::Output::Write,

data/lib/vedeu/renderers/all.rb

@@ -124,6 +124,7 @@ module Vedeu
   # @example
   #   Vedeu.renderers
   #
+  # @api public
   # @!method renderers
   #   @see Vedeu::Renderers#renderers
   def_delegators Vedeu::Renderers,

data/lib/vedeu/renderers/options.rb

@@ -134,7 +134,7 @@ module Vedeu
         options[:start_row_tag]
       end
 
-      # @return [void]
+      # @return [Array<void>]
       def output
         options[:output]
       end

data/lib/vedeu/renderers/terminal.rb

@@ -24,13 +24,7 @@ module Vedeu
       #
       # @return [String]
       def write
-        if write_file?
-          Vedeu::Terminal.output(write_file)
-
-        else
-          Vedeu::Terminal.output(content)
-
-        end
+        Vedeu.direct_write(writable_data)
       end
 
       private
@@ -43,6 +37,13 @@ module Vedeu
         compression
       end
 
+      # @return [String]
+      def writable_data
+        return write_file if write_file?
+
+        content
+      end
+
     end # Terminal
 
   end # Renderers

data/lib/vedeu/repositories/storage.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   module Repositories

data/lib/vedeu/runtime/application.rb

@@ -82,9 +82,13 @@ module Vedeu
       # @param block [Proc]
       # @return [void]
       def runner(&block)
-        return yield if Vedeu.config.once?
+        if Vedeu.config.once?
+          run_once { yield }
 
-        run_many { yield }
+        else
+          run_many { yield }
+
+        end
       end
 
       # For an interactive application we capture input, (usually from
@@ -120,12 +124,21 @@ module Vedeu
         Vedeu::Runtime::Application.restart
       end
 
+      # @param block [Proc]
+      # @return [void]
+      def run_once(&block)
+        yield.tap do
+          # Vedeu.debug(binding)
+        end
+      end
+
       # :nocov:
 
     end # Application
 
   end # Runtime
 
+  # @api public
   # @!method exit
   #   @see Vedeu::Runtime::Application.stop
   def_delegators Vedeu::Runtime::Application,

data/lib/vedeu/runtime/flags.rb

@@ -68,8 +68,12 @@ module Vedeu
 
   # Manipulate the internal flags.
   #
+  # @api public
   # @!method ready?
+  #   @see Vedeu::Runtime::Flags#ready?
+  # @api public
   # @!method ready!
+  #   @see Vedeu::Runtime::Flags#ready!
   # @return [Boolean]
   def_delegators Vedeu::Runtime::Flags,
                  :ready?,

data/lib/vedeu/runtime/router.rb

@@ -170,6 +170,7 @@ module Vedeu
 
   end # Runtime
 
+  # @api public
   # @!method goto
   #   @see Vedeu::Runtime::Router#goto
   def_delegators Vedeu::Runtime::Router,

data/lib/vedeu/sentence.rb

@@ -6,6 +6,8 @@ module Vedeu
   # sentence with the penultimate and ultimate elements separated with
   # the word 'and'.
   #
+  # @api public
+  #
   class Sentence
 
     # @param (see #initialize)

data/lib/vedeu/support/point.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vedeu
 
   # A `Vedeu::Point` represents part of a coordinate within the 2D

data/lib/vedeu/terminal/terminal.rb

@@ -163,6 +163,7 @@ module Vedeu
 
   end # Terminal
 
+  # @api public
   # @!method resize
   #   @see Vedeu::Terminal#resize
   def_delegators Vedeu::Terminal,

data/lib/vedeu/version.rb

@@ -3,6 +3,6 @@
 module Vedeu
 
   # The current version of Vedeu.
-  VERSION = '0.8.10'.freeze
+  VERSION = '0.8.12'.freeze
 
 end

data/lib/vedeu/views/all.rb

@@ -4,6 +4,8 @@ module Vedeu
 
   # View related models.
   #
+  # @api mixed
+  #
   module Views
 
   end # Views

data/lib/vedeu/views/composition.rb

@@ -24,9 +24,11 @@ module Vedeu
 
       # Returns a new instance of Vedeu::Views::Composition.
       #
-      # @param attributes [Hash]
+      # @param attributes [Hash<Symbol => void>]
       # @option attributes client [void]
       # @option attributes colour [Vedeu::Colours::Colour]
+      # @option attributes parent [NilClass] The parent of a
+      #   Vedeu::Views::Composition should be nil.
       # @option attributes style [Vedeu::Presentation::Style]
       # @option attributes value [Vedeu::Views::Views]
       # @return [Vedeu::Views::Composition]
@@ -36,6 +38,8 @@ module Vedeu
         end
       end
 
+      # Adds the child to the collection.
+      #
       # @param child [Vedeu::Views::View]
       # @return [Vedeu::Views::Views]
       def add(child)

data/lib/vedeu/views/line.rb

@@ -56,6 +56,8 @@ module Vedeu
         end
       end
 
+      # Adds the child to the collection.
+      #
       # @param child [Vedeu::Views::Stream]
       # @return [Vedeu::Views::Stream]
       def add(child)

data/lib/vedeu/views/stream.rb

@@ -64,6 +64,8 @@ module Vedeu
         end
       end
 
+      # Adds the child to the collection.
+      #
       # @param child [Vedeu::Views::Stream]
       # @return [Vedeu::Views::Streams]
       def add(child)

data/lib/vedeu/views/view.rb

@@ -53,7 +53,7 @@ module Vedeu
       # @!attribute [rw] wordwrap
       # @return [Boolean]
       attr_accessor :wordwrap
-      alias_method :wordwrap?, :wordwrap
+      alias wordwrap? wordwrap
 
       # @!attribute [rw] zindex
       # @return [Fixnum]
@@ -78,6 +78,8 @@ module Vedeu
         end
       end
 
+      # Adds the child to the collection.
+      #
       # @param child [Vedeu::Views::Line]
       # @return [Vedeu::Views::Lines]
       def add(child)

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

@@ -23,12 +23,6 @@ module Vedeu
         it { subject.must_be_instance_of(Hash) }
       end
 
-      describe '#cell?' do
-        subject { instance.cell? }
-
-        it { subject.must_equal(false) }
-      end
-
       describe '#name=' do
         subject { instance.name=(_value) }
 

data/test/lib/vedeu/cells/char_test.rb

@@ -23,12 +23,6 @@ module Vedeu
         end
       end
 
-      describe '#cell?' do
-        subject { instance.cell? }
-
-        it { subject.must_equal(false) }
-      end
-
       describe '#text' do
         subject { instance.text }
 

data/test/lib/vedeu/cells/clear_test.rb

@@ -17,12 +17,6 @@ module Vedeu
       }
       let(:_value) { ' ' }
 
-      describe '#cell?' do
-        subject { instance.cell? }
-
-        it { subject.must_equal(false) }
-      end
-
       describe '#value' do
         subject { instance.value }
 

data/test/lib/vedeu/cells/cursor_test.rb

@@ -25,10 +25,6 @@ module Vedeu
         it { instance.instance_variable_get('@value').must_equal(_value) }
       end
 
-      describe '#cell?' do
-        it { instance.cell?.must_equal(false) }
-      end
-
       describe '#null' do
         it { instance.null.must_equal(nil) }
         it { instance.background.must_equal(nil) }

data/test/lib/vedeu/cells/empty_test.rb

@@ -39,12 +39,6 @@ module Vedeu
         it { instance.must_respond_to(:value) }
       end
 
-      describe '#cell?' do
-        subject { instance.cell? }
-
-        it { subject.must_equal(true) }
-      end
-
       describe '#eql?' do
         let(:other) { instance }
 

data/test/lib/vedeu/cells/escape_test.rb

@@ -25,10 +25,6 @@ module Vedeu
         it { instance.instance_variable_get('@value').must_equal(_value) }
       end
 
-      describe '#cell?' do
-        it { instance.cell?.must_equal(false) }
-      end
-
       describe '#null' do
         it { instance.null.must_equal(nil) }
         it { instance.background.must_equal(nil) }

data/test/lib/vedeu/common_test.rb

@@ -63,16 +63,6 @@ module Vedeu
       end
     end
 
-    describe '#become' do
-      let(:instance)   { Vedeu::Cells::Border.new }
-      let(:klass)      { Vedeu::Cells::Char }
-      let(:attributes) { instance.attributes }
-
-      subject { instance.become(klass, attributes) }
-
-      it { subject.must_be_instance_of(Vedeu::Cells::Char) }
-    end
-
     describe '#boolean' do
       subject { instance.boolean(_value) }
 

data/test/lib/vedeu/events/{collection_test.rb → events_test.rb}

@@ -6,9 +6,9 @@ module Vedeu
 
   module Events
 
-    describe Collection do
+    describe Events do
 
-      let(:described) { Vedeu::Events::Collection }
+      let(:described) { Vedeu::Events::Events }
       let(:instance)  { described.new }
 
       it { described.superclass.must_equal(Vedeu::Repositories::Collection) }
@@ -17,7 +17,7 @@ module Vedeu
         it { instance.must_be_instance_of(described) }
       end
 
-    end # Collection
+    end # Events
 
   end # Events
 

data/test/lib/vedeu/events/repository_test.rb

@@ -18,7 +18,7 @@ module Vedeu
         it { described.must_respond_to(:reset) }
 
         it do
-          described.expects(:new).with(Vedeu::Events::Collection)
+          described.expects(:new).with(Vedeu::Events::Events)
           subject
         end
       end