vedeu 0.8.10 → 0.8.12

data/lib/vedeu/events/repository.rb

@@ -6,6 +6,8 @@ module Vedeu
 
     # Allows the storing of events.
     #
+    # @api private
+    #
     class Repository < Vedeu::Repositories::Repository
 
       singleton_class.send(:alias_method, :events, :repository)
@@ -19,7 +21,7 @@ module Vedeu
         #
         # @return [Vedeu::Events::Repository]
         def reset!
-          @events = new(Vedeu::Events::Collection)
+          @events = new(Vedeu::Events::Events)
         end
         alias reset reset!
 
@@ -34,6 +36,7 @@ module Vedeu
   # @example
   #   Vedeu.events
   #
+  # @api public
   # @!method events
   # @return [Vedeu::Events::Repository]
   def_delegators Vedeu::Events::Repository,

data/lib/vedeu/events/trigger.rb

@@ -9,6 +9,8 @@ module Vedeu
     # events are registered for a name, then the result of each event
     # will be returned as part of a collection.
     #
+    # @api private
+    #
     class Trigger
 
       # Trigger an event by name.
@@ -88,6 +90,7 @@ module Vedeu
 
   end # Events
 
+  # @api public
   # @!method trigger
   #   @see Vedeu::Events::Trigger.trigger
   def_delegators Vedeu::Events::Trigger,

data/lib/vedeu/geometries/dsl/dsl.rb

@@ -411,6 +411,7 @@ module Vedeu
 
   end # Geometries
 
+  # @api public
   # @!method geometry
   #   @see Vedeu::Geometries::DSL.geometry
   def_delegators Vedeu::Geometries::DSL,

data/lib/vedeu/geometries/repository.rb

@@ -23,6 +23,7 @@ module Vedeu
   # @example
   #   Vedeu.geometries
   #
+  # @api public
   # @!method geometries
   # @return [Vedeu::Geometries::Repository]
   def_delegators Vedeu::Geometries::Repository,

data/lib/vedeu/groups/clear.rb

@@ -61,6 +61,7 @@ module Vedeu
 
   end # Groups
 
+  # @api public
   # @!method clear_by_group
   #   @see Vedeu::Groups::Clear.render
   def_delegators Vedeu::Groups::Clear,

data/lib/vedeu/groups/dsl.rb

@@ -95,6 +95,7 @@ module Vedeu
 
   end # Groups
 
+  # @api public
   # @!method group
   #   @see Vedeu::Groups::DSL.group
   def_delegators Vedeu::Groups::DSL,

data/lib/vedeu/groups/group.rb

@@ -179,10 +179,13 @@ module Vedeu
 
   end # Groups
 
+  # @api public
   # @!method hide_group
   #   @see Vedeu::Toggleable::SingletonMethods#hide
+  # @api public
   # @!method show_group
   #   @see Vedeu::Toggleable::SingletonMethods#show
+  # @api public
   # @!method toggle_group
   #   @see Vedeu::Toggleable::SingletonMethods#toggle
   def_delegators Vedeu::Groups::Group,

data/lib/vedeu/groups/repository.rb

@@ -28,6 +28,7 @@ module Vedeu
   # @example
   #   Vedeu.groups
   #
+  # @api public
   # @!method groups
   # @return [Vedeu::Groups::Repository]
   def_delegators Vedeu::Groups::Repository,

data/lib/vedeu/input/capture.rb

@@ -2,7 +2,7 @@
 
 module Vedeu
 
-  # \e
+  # Produces ASCII character 27 which is ESC
   ESCAPE_KEY_CODE = 27
 
   module Input

data/lib/vedeu/input/dsl.rb

@@ -106,6 +106,7 @@ module Vedeu
 
   end # Input
 
+  # @api public
   # @!method keymap
   #   @see Vedeu::Input::DSL.keymap
   def_delegators Vedeu::Input::DSL,

data/lib/vedeu/input/mapper.rb

@@ -166,6 +166,7 @@ module Vedeu
 
   end # Input
 
+  # @api public
   # @!method keypress
   #   @see Vedeu::Input::Mapper.keypress
   def_delegators Vedeu::Input::Mapper,

data/lib/vedeu/input/read.rb

@@ -137,6 +137,7 @@ module Vedeu
 
   end # Input
 
+  # @api public
   # @!method read
   #   @see Vedeu::Input::Read#read
   def_delegators Vedeu::Input::Read,

data/lib/vedeu/input/repository.rb

@@ -21,6 +21,7 @@ module Vedeu
   # @example
   #   Vedeu.keymaps
   #
+  # @api public
   # @!method keymaps
   # @return [Vedeu::Input::Repository]
   def_delegators Vedeu::Input::Repository,

data/lib/vedeu/input/store.rb

@@ -63,16 +63,22 @@ module Vedeu
 
   end # Input
 
+  # @api public
   # @!method add_command
   #   @see Vedeu::Input::Store.add_command
+  # @api public
   # @!method add_keypress
   #   @see Vedeu::Input::Store.add_keypress
+  # @api public
   # @!method all_commands
   #   @see Vedeu::Input::Store.all_commands
+  # @api public
   # @!method all_keypresses
   #   @see Vedeu::Input::Store.all_keypresses
+  # @api public
   # @!method last_command
   #   @see Vedeu::Input::Store.last_command
+  # @api public
   # @!method last_keypress
   #   @see Vedeu::Input::Store.last_keypress
   def_delegators Vedeu::Input::Store,

data/lib/vedeu/interfaces/clear.rb

@@ -67,7 +67,7 @@ module Vedeu
         if direct?
           Vedeu.direct_write(optimised_output)
 
-          Vedeu::Buffers::Terminal.update(output)
+          Vedeu.buffer_update(output)
 
         else
           Vedeu.render_output(output)
@@ -227,8 +227,10 @@ module Vedeu
 
   end # Interfaces
 
+  # @api public
   # @!method clear_by_name
   #   @see Vedeu::Interfaces::Clear.clear_by_name
+  # @api public
   # @!method clear_content_by_name
   #   @see Vedeu::Interfaces.Clear.clear_content_by_name
   def_delegators Vedeu::Interfaces::Clear,

data/lib/vedeu/interfaces/dsl.rb

@@ -328,6 +328,7 @@ module Vedeu
 
   end # Interfaces
 
+  # @api public
   # @!method interface
   #   @see Vedeu::Interfaces::DSL.interface
   def_delegators Vedeu::Interfaces::DSL,

data/lib/vedeu/interfaces/interface.rb

@@ -169,10 +169,13 @@ module Vedeu
 
   end # Interfaces
 
+  # @api public
   # @!method hide_interface
   #   @see Vedeu::Toggleable::SingletonMethods#hide
+  # @api public
   # @!method show_interface
   #   @see Vedeu::Toggleable::SingletonMethods#show
+  # @api public
   # @!method toggle_interface
   #   @see Vedeu::Toggleable::SingletonMethods#toggle
   def_delegators Vedeu::Interfaces::Interface,

data/lib/vedeu/interfaces/repository.rb

@@ -39,6 +39,7 @@ module Vedeu
   # @example
   #   Vedeu.interfaces
   #
+  # @api public
   # @!method interfaces
   # @return [Vedeu::Interfaces::Repository]
   def_delegators Vedeu::Interfaces::Repository,

data/lib/vedeu/logging/clock_time.rb

@@ -27,6 +27,7 @@ module Vedeu
 
   end # Logging
 
+  # @api public
   # @!method clock_time
   # {include:file:docs/dsl/by_method/clock_time.md}
   def_delegators Vedeu::Logging::ClockTime,

data/lib/vedeu/logging/debug.rb

@@ -117,12 +117,14 @@ module Vedeu
   end # Logging
 
   # {include:file:docs/dsl/by_method/profile.md}
+  # @api public
   # @!method profile
   # @return [Vedeu::Logging::Debug]
   def_delegators Vedeu::Logging::Debug,
                  :profile
 
   # {include:file:docs/dsl/by_method/debug.md}
+  # @api public
   # @!method debug
   # @return [void]
   def_delegators Vedeu::Logging::Debug,

data/lib/vedeu/logging/log.rb

@@ -166,12 +166,16 @@ module Vedeu
 
   end # Logging
 
+  # @api public
   # @!method log
   #   @see Vedeu::Logging::Log.log
+  # @api public
   # @!method log_stdout
   #   @see Vedeu::Logging::Log.log_stdout
+  # @api public
   # @!method log_stderr
   #   @see Vedeu::Logging::Log.log_stderr
+  # @api public
   # @!method log_timestamp
   #   @see Vedeu::Logging::Log.log_timestamp
   def_delegators Vedeu::Logging::Log,

data/lib/vedeu/logging/timer.rb

@@ -86,6 +86,7 @@ module Vedeu
   end # Logging
 
   # {include:file:docs/dsl/by_method/timer.md}
+  # @api public
   # @!method timer
   #   @see Vedeu::Logging::Timer.timer
   def_delegators Vedeu::Logging::Timer,

data/lib/vedeu/menus/menu.rb

@@ -211,6 +211,7 @@ module Vedeu
 
   end # Menus
 
+  # @api public
   # @!method menu
   #   @see Vedeu::Menus::DSL.menu
   def_delegators Vedeu::Menus::DSL,

data/lib/vedeu/menus/repository.rb

@@ -22,6 +22,7 @@ module Vedeu
   # @example
   #   Vedeu.menus
   #
+  # @api public
   # @!method menus
   # @return [Vedeu::Menus::Repository]
   def_delegators Vedeu::Menus::Repository,

data/lib/vedeu/models/focus.rb

@@ -246,16 +246,22 @@ module Vedeu
 
   end # Models
 
+  # @api public
   # @!method focus
   #   @see Vedeu::Models::Focus#focus
+  # @api public
   # @!method focus?
   #   @see Vedeu::Models::Focus#focus?
+  # @api public
   # @!method focus_by_name
   #   @see Vedeu::Models::Focus#focus_by_name
+  # @api public
   # @!method focussed?
   #   @see Vedeu::Models::Focus#focussed?
+  # @api public
   # @!method focus_next
   #   @see Vedeu::Models::Focus#focus_next
+  # @api public
   # @!method focus_previous
   #   @see Vedeu::Models::Focus#focus_previous
   def_delegators Vedeu::Models::Focus,

data/lib/vedeu/output/all.rb

@@ -11,6 +11,7 @@ module Vedeu
 
 end # Vedeu
 
+require 'vedeu/output/compressors/all'
 require 'vedeu/output/compressor_cache'
 require 'vedeu/output/compressor'
 require 'vedeu/output/output'

data/lib/vedeu/output/compressor.rb

@@ -31,18 +31,17 @@ module Vedeu
       def initialize(output, options = {})
         @output  = output
         @options = options
-        @colour  = ''
-        @style   = ''
       end
 
       # @note
       #   - Takes approximately ~6ms for 2100 chars. (2015-11-25)
       #   - Takes approximately ~25ms for 2100 chars. (2015-07-25)
       # @return [String]
+      # @return [Array<void>|String]
       def render
-        return cached if compression?
+        return [] unless output?
 
-        uncompress
+        Vedeu::Output::CompressorCache.cache(content, compression?)
       end
 
       protected
@@ -53,114 +52,28 @@ module Vedeu
 
       private
 
+      # Returns the output with all of the empty cells removed to make
+      # compression faster.
+      #
       # @return [Array]
       def content
-        @content ||= if present?(output)
-                       output.content.reject(&:cell?)
-
-                     else
-                       []
-
-                     end
-      end
-
-      # @return [Array<void>|String]
-      def cached
-        cached_original   = Vedeu::Output::CompressorCache.read(:original)
-        cached_compressed = Vedeu::Output::CompressorCache.read(:compressed)
-
-        if content.size == cached_original.size && content == cached_original
-          cached_compressed
-
-        else
-          Vedeu::Output::CompressorCache.write(:original, content)
-          Vedeu::Output::CompressorCache.write(:compressed, compress)
-          compress
-
-        end
-      end
-
-      # @return [String]
-      def compress
-        message = "Compression for #{content.size} objects"
-
-        @same = ''
-        @compress ||= Vedeu.timer(message) do
-          out = content.map do |cell|
-            rendered = [
-              # position_for(cell),
-              cell.position.to_s,
-              colour_for(cell),
-              style_for(cell),
-              cell.value,
-            ].join
-
-            if @same == rendered
-              next
-
-            else
-              @same = rendered
-              @same
-
-            end
-          end.join
-
+        output.content.reject do |cell|
+          cell.class == Vedeu::Cells::Empty
+        end.tap do |cells|
           Vedeu.log(type:    :compress,
-                    message: "#{message} -> #{out.size} characters")
-
-          out
+                    message: "Orignal size: #{content_size} / " \
+                             "New size: #{cells.size}")
         end
       end
 
-      # @return [String]
-      def uncompress
-        out = content.map(&:to_s).join
-
-        Vedeu.log(type:    :compress,
-                  message: "No compression: #{content.size} objects -> " \
-                           "#{out.size} characters")
-
-        out
-      end
-
-      # Compress by not repeatedly sending a position when only the x
-      # coordinate has changed; i.e. we are on the same line, just
-      # advancing a character.
-      #
-      # @param char [Vedeu::Cells::Char]
-      # @return [String]
-      def position_for(char)
-        return '' unless char.position
-        return '' if char.position.y == @y
-
-        @y = char.position.y
-        char.position.to_s
+      # @return [Fixnum]
+      def content_size
+        output.content.size
       end
 
-      # 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
-
-      # 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
+      # @return [Boolean]
+      def output?
+        present?(output)
       end
 
     end # Compressor

data/lib/vedeu/output/compressor_cache.rb

@@ -16,41 +16,64 @@ module Vedeu
       extend self
       extend Vedeu::Repositories::Storage
 
-      # @param key [NilClass|Symbol]
-      # @return [Array<void>]
-      def read(key)
-        storage.fetch(key, [])
+      # @param content [Array<void>]
+      # @return [String]
+      def cache(content, compression = false)
+        write(content, compression) unless empty?(content) || cached?(content)
+
+        compression ? read(:compress) : read(:uncompress)
       end
 
-      # @param key [NilClass|Symbol]
-      # @param value [Array|NilClass]
-      # @return [Hash<Symbol => Array<void>>]
-      def write(key, value)
-        return storage if invalid_key?(key) || invalid_value?(value)
+      private
 
-        storage.merge!(key => value)
+      # @param content [Array<void>]
+      # @return [Boolean]
+      def cached?(content)
+        content.size == read(:original).size && content == read(:original)
       end
 
-      private
+      # @param content [Array<void>]
+      # @return [String]
+      def compress(content)
+        Vedeu::Output::Compressors::Character.with(content)
+      end
 
-      # @return [Hash<Symbol => Array<void>>]
+      # @param content [Array<void>]
+      # @return [Boolean]
+      def empty?(content)
+        content.nil? || content.empty?
+      end
+
+      # @return [Hash<Symbol => Array<void>, String>]
       def in_memory
         {
-          compressed: '',
+          compress:   '',
           original:   [],
+          uncompress: '',
         }
       end
 
       # @param key [NilClass|Symbol]
-      # @return [Boolean]
-      def invalid_key?(key)
-        key.nil? || !in_memory.keys.include?(key)
+      # @return [Array<void>]
+      def read(key)
+        storage.fetch(key, [])
       end
 
-      # @param value [Array|NilClass]
-      # @return [Boolean]
-      def invalid_value?(value)
-        value.nil? || value.empty?
+      # @param content [Array<void>]
+      # @return [String]
+      def uncompress(content)
+        Vedeu::Output::Compressors::Simple.with(content)
+      end
+
+      # @param content [Array<void>]
+      # @param compression [Boolean]
+      # @return [Hash<Symbol => Array<void>>]
+      def write(content, compression = false)
+        storage[:original] = content
+
+        storage[:uncompress] = uncompress(content)
+
+        storage[:compress] = compress(content)
       end
 
     end # CompressorCache

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Vedeu
+
+  module Output
+
+    # Provides different mechanisms to compress content. Compressing
+    # content is performed to:
+    #
+    # 1) Reduce the amount of data sent to the renderer with each
+    #    refresh or render.
+    # 2) Reduce the time spent converting a terminal buffer into data
+    #    suitable to send to the renderer.
+    #
+    # @api private
+    #
+    module Compressors
+
+    end # Compressors
+
+  end # Output
+
+end # Vedeu
+
+require 'vedeu/output/compressors/simple'
+require 'vedeu/output/compressors/character'