vedeu 0.5.13 → 0.6.0

data/lib/vedeu/log/lockless_log_device.rb

@@ -42,7 +42,7 @@ module Vedeu
 
     private
 
-    # @param filename [String]
+    # @param log [String]
     # @return [void]
     def open_logfile(log)
       if FileTest.exist?(log)

data/lib/vedeu/models/escape.rb

@@ -20,10 +20,14 @@ module Vedeu
       @attributes.each { |key, value| instance_variable_set("@#{key}", value) }
     end
 
-    # @return [String]
-    def colour
-      ''
+    # @return [NilClass]
+    def null
+      nil
     end
+    alias_method :background, :null
+    alias_method :colour,     :null
+    alias_method :foreground, :null
+    alias_method :style,      :null
 
     # An object is equal when its values are the same.
     #
@@ -39,11 +43,6 @@ module Vedeu
       Vedeu::Position.coerce(@position)
     end
 
-    # @return [String]
-    def style
-      ''
-    end
-
     # @return [String]
     def to_s
       "#{position}#{value}"

data/lib/vedeu/output/direct.rb

@@ -0,0 +1,59 @@
+module Vedeu
+
+  # Write a string directly to the terminal at defined coordinates.
+  #
+  class Direct
+
+    # @param value [String]
+    # @param x [Fixnum]
+    # @param y [Fixnum]
+    # @return [void]
+    def self.write(value:, x:, y:)
+      new(value: value, x: x, y: y).write
+    end
+
+    # @param value [String]
+    # @param x [Fixnum]
+    # @param y [Fixnum]
+    def initialize(value:, x:, y:)
+      @value = value || ''
+      @x     = x     || 1
+      @y     = y     || 1
+    end
+
+    # @return [void]
+    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::Position.new(y, x).to_s
+    end
+
+  end # Direct
+
+end # Vedeu

data/lib/vedeu/output/renderers/terminal.rb

@@ -28,11 +28,19 @@ module Vedeu
       # @param output [Array<Array<Vedeu::Views::Char>>]
       # @return [Array<Array<Vedeu::Views::Char>>]
       def parsed(output)
+        store!(output)
+
         Vedeu.timer('Compression') do
           Vedeu::Compressor.render(output)
         end
       end
 
+      # @param output [Array<Array<Vedeu::Views::Char>>]
+      # @return [Array<Vedeu::Views::Char>]
+      def store!(output)
+        Vedeu::Terminal::Content.stores(output)
+      end
+
     end # Terminal
 
   end # Renderers

data/lib/vedeu/output/viewport.rb

@@ -155,9 +155,8 @@ module Vedeu
       @by ||= border.by
     end
 
-    # Fetch the cursor associated with the interface/view we are drawing.
-    #
-    # @return (see Vedeu::Cursors#by_name)
+    # @return [Vedeu::Cursor]
+    # @see Vedeu::Cursors#by_name
     def cursor
       @cursor ||= Vedeu.cursors.by_name(name)
     end

data/lib/vedeu/refresh/refresh_cursor.rb

@@ -68,6 +68,7 @@ module Vedeu
     end
 
     # @return [Vedeu::Cursor]
+    # @see Vedeu::Cursors#by_name
     def cursor
       @cursor ||= Vedeu.cursors.by_name(name)
     end

data/lib/vedeu/terminal/content.rb

@@ -0,0 +1,88 @@
+module Vedeu
+
+  module Terminal
+
+    # A permanent copy of the terminal output.
+    #
+    module Content
+
+      include Vedeu::Common
+      extend self
+
+      # @param char [Vedeu::Views::Char]
+      # @return [Boolean]
+      def valid?(char)
+        char.respond_to?(:position) &&
+          present?(char.position.y) &&
+          present?(char.position.x)
+      end
+
+      # @param char [Vedeu::Views::Char]
+      # @return [Vedeu::Views::Char]
+      def store(char)
+        # value = {}
+        # value[:background] = char.background.to_s if char.background
+        # value[:foreground] = char.foreground.to_s if char.foreground
+        # value[:style]      = char.style.to_s      if char.style
+        # value[:value]      = char.value           if char.value
+        # value[:x]          = char.position.x      if char.position.x
+        # value[:y]          = char.position.y      if char.position.y
+
+        storage[char.position.y][char.position.x] = char.value if valid?(char)
+
+        char
+      end
+
+      # @param chars [Array<Vedeu::Views::Char>]
+      # @return [Array<Vedeu::Views::Char>]
+      def stores(chars)
+        Array(chars).flatten.map { |char| store(char) }
+      end
+
+      # @return [Hash<String => String>|NilClass]
+      def write
+        filename = "/tmp/vedeu/content_#{Time.now.to_f}"
+
+        File.write(filename, storage.inspect) if Vedeu::Configuration.log?
+      end
+
+      # @return [Array<String>]
+      def reprocess
+        out = []
+        storage.each do |y, line|
+          line.each do |x, value|
+            out << Vedeu::Views::Char.new(position: [y, x], value: value).to_s
+          end
+        end
+
+        Vedeu::Terminal.clear
+
+        Vedeu::Terminal.output(out.join)
+      end
+
+      # @return [Hash]
+      def reset
+        @storage = in_memory
+      end
+
+      private
+
+      # Returns an empty collection ready for the storing terminal content.
+      #
+      # @return [Hash]
+      def in_memory
+        Hash.new { |h, k| h[k] = {} }
+      end
+
+      # Access to the storage for this repository.
+      #
+      # @return [Array]
+      def storage
+        @storage ||= in_memory
+      end
+
+    end # Content
+
+  end # Terminal
+
+end # Vedeu

data/lib/vedeu/terminal/mode.rb

@@ -0,0 +1,79 @@
+module Vedeu
+
+  module Terminal
+
+    # Store the current mode of the terminal.
+    #
+    module Mode
+
+      extend self
+
+      # Returns a boolean indicating whether the terminal is currently in
+      # `cooked` mode.
+      #
+      # @return [Boolean]
+      def cooked_mode?
+        mode == :cooked
+      end
+
+      # Sets the terminal in to `cooked` mode.
+      #
+      # @return [Symbol]
+      def cooked_mode!
+        @mode = :cooked
+      end
+
+      # Returns a boolean indicating whether the terminal is currently in `fake`
+      # mode.
+      #
+      # @return [Boolean]
+      def fake_mode?
+        mode == :fake
+      end
+
+      # Sets the terminal in to `fake` mode.
+      #
+      # @return [Symbol]
+      def fake_mode!
+        @mode = :fake
+      end
+
+      # Returns a boolean indicating whether the terminal is currently in `raw`
+      # mode.
+      #
+      # @return [Boolean]
+      def raw_mode?
+        mode == :raw
+      end
+
+      # Sets the terminal in to `raw` mode.
+      #
+      # @return [Symbol]
+      def raw_mode!
+        @mode = :raw
+      end
+
+      # Toggles the terminal's mode between `cooked`, `fake` and `raw`,
+      # depending on its current mode.
+      #
+      # @return [Symbol]
+      def switch_mode!
+        return fake_mode!   if raw_mode?
+        return cooked_mode! if fake_mode?
+
+        raw_mode!
+      end
+
+      # Returns the mode of the terminal, either `:cooked`, `:fake` or `:raw`.
+      # Can change throughout the lifespan of the client application.
+      #
+      # @return [Symbol]
+      def mode
+        @mode ||= Vedeu::Configuration.terminal_mode
+      end
+
+    end # Mode
+
+  end # Terminal
+
+end # Vedeu

data/lib/vedeu/{terminal.rb → terminal/terminal.rb}

@@ -5,7 +5,7 @@ module Vedeu
   #
   module Terminal
 
-    include Vedeu::TerminalMode
+    include Vedeu::Terminal::Mode
     extend self
 
     # Opens a terminal screen in either `raw` or `cooked` mode. On exit,
@@ -16,7 +16,7 @@ module Vedeu
     def open
       fail Vedeu::InvalidSyntax, 'block not given' unless block_given?
 
-      if raw_mode?
+      if raw_mode? || fake_mode?
         console.raw    { initialize_screen(mode) { yield } }
 
       else
@@ -34,29 +34,13 @@ module Vedeu
     def input
       Vedeu.log(type: :input, message: 'Waiting for user input...')
 
-      keys_or_cmd = if raw_mode?
-                      keys = console.getch
-
-                      if keys.ord == 27 # \e
-                        begin
-                          keys << console.read_nonblock(5)
-                        rescue
-                          nil
-                        end
-                        begin
-                          keys << console.read_nonblock(4)
-                        rescue
-                          nil
-                        end
-                      end
-                      keys
-
-                    else
-                      console.gets.chomp
-
-                    end
-
-      keys_or_cmd
+      if raw_mode? || fake_mode?
+        Vedeu::Editor::Capture.read(console)
+
+      else
+        console.gets.chomp
+
+      end
     end
     alias_method :read, :input
 

data/lib/vedeu/version.rb

@@ -1,6 +1,6 @@
 module Vedeu
 
   # The current version of Vedeu.
-  VERSION = '0.5.13'
+  VERSION = '0.6.0'
 
 end

data/test/lib/vedeu/bindings/focus_test.rb

@@ -0,0 +1,19 @@
+require 'test_helper'
+
+module Vedeu
+
+  module Bindings
+
+    describe Focus do
+
+      context 'the system events needed by Vedeu to run are defined' do
+        it { Vedeu.bound?(:_focus_by_name_).must_equal(true) }
+        it { Vedeu.bound?(:_focus_next_).must_equal(true) }
+        it { Vedeu.bound?(:_focus_prev_).must_equal(true) }
+      end
+
+    end # Focus
+
+  end # Bindings
+
+end # Vedeu

data/test/lib/vedeu/bindings/refresh_test.rb

@@ -0,0 +1,19 @@
+require 'test_helper'
+
+module Vedeu
+
+  module Bindings
+
+    describe Refresh do
+
+      context 'the system events needed by Vedeu to run are defined' do
+        it { Vedeu.bound?(:_refresh_).must_equal(true) }
+        it { Vedeu.bound?(:_refresh_cursor_).must_equal(true) }
+        it { Vedeu.bound?(:_refresh_group_).must_equal(true) }
+      end
+
+    end # Refresh
+
+  end # Bindings
+
+end # Vedeu

data/test/lib/vedeu/bindings/system_test.rb

@@ -10,18 +10,13 @@ module Vedeu
         it { Vedeu.bound?(:_cleanup_).must_equal(true) }
         it { Vedeu.bound?(:_clear_).must_equal(true) }
         it { Vedeu.bound?(:_command_).must_equal(true) }
+        it { Vedeu.bound?(:_editor_).must_equal(true) }
         it { Vedeu.bound?(:_exit_).must_equal(true) }
-        it { Vedeu.bound?(:_focus_by_name_).must_equal(true) }
-        it { Vedeu.bound?(:_focus_next_).must_equal(true) }
-        it { Vedeu.bound?(:_focus_prev_).must_equal(true) }
         it { Vedeu.bound?(:_initialize_).must_equal(true) }
         it { Vedeu.bound?(:_keypress_).must_equal(true) }
         it { Vedeu.bound?(:_log_).must_equal(true) }
         it { Vedeu.bound?(:_maximise_).must_equal(true) }
         it { Vedeu.bound?(:_mode_switch_).must_equal(true) }
-        it { Vedeu.bound?(:_refresh_).must_equal(true) }
-        it { Vedeu.bound?(:_refresh_cursor_).must_equal(true) }
-        it { Vedeu.bound?(:_refresh_group_).must_equal(true) }
         it { Vedeu.bound?(:_resize_).must_equal(true) }
         it { Vedeu.bound?(:_unmaximise_).must_equal(true) }
       end