vedeu 0.6.64 → 0.6.65

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 998283356866d82e0bd3b67de95edd9fbe89fd5f
-  data.tar.gz: 2dd548c709f2b1cda90bc46befe65f666fd28dfd
+  metadata.gz: b7de5e8ce3c945a022377f002d55b636db36d4c4
+  data.tar.gz: 304a938cd7a728def2501a2fbb9c56dc47087c69
 SHA512:
-  metadata.gz: e53be9215177a8cf0aeeab573ca9f0f2a6ef871480b5bd4a1cc5795af184a7efd2c88c8a2188c12ceb9a04e742f3c54e8ed85c89bc733355bd83dceae478bba8
-  data.tar.gz: a4e513ce13024657f52396d7ad249de4f0329e1c9f6b7939bf910b5856ed2f83c9a6a4b88dfc483e2c0ee93463314e57718dff54be5406f61e7bd548eb5953a6
+  metadata.gz: 5319814ddc77d021cc4b9d6c0faeaf0dee1dfbad8fda6aed11999ed3e596ee304dd25c24155aff10968d5a48112ecfff371d8a7b58fd370fc2ee9195444570ba
+  data.tar.gz: 51b151afec06d804cbf24e0a7cf490b434e8d0130d5c993a74e80e93734c22ba00cec0908696fd1bb4d2ce36e6e943a487e7742bdc9b21788ad34476662243fa

data/docs/api.md

@@ -417,6 +417,10 @@ Repository method. Access registered menus.
 
 @todo Add more documentation.
 
+### Vedeu.read
+
+@todo Add more documentation.
+
 ### Vedeu.ready!
 
 @todo Add more documentation.
@@ -506,3 +510,7 @@ Repository method. Access registered renderers.
 ### Vedeu.width
 
 @todo Add more documentation.
+
+### Vedeu.write
+
+@todo Add more documentation.

data/docs/debugging.md

@@ -8,8 +8,9 @@ and hopefully be dropped into a Pry debuggging session:
 
     Vedeu::Terminal.cooked_mode!
     Vedeu::Terminal.open do
+      mouse_off   = Vedeu::EscapeSequences::Esc.string('mouse_x10_off')
       show_cursor = Vedeu::EscapeSequences::Esc.string('show_cursor')
-      Vedeu::Terminal.output(show_cursor)
+      Vedeu::Terminal.output(mouse_off + show_cursor)
 
       require 'pry'
       binding.pry

data/lib/vedeu/application/application_controller.rb

@@ -8,7 +8,7 @@ module Vedeu
 
     include Vedeu::Controller
 
-    # Returns an instance of Vedeu::ApplicationController.
+    # Returns a new instance of Vedeu::ApplicationController.
     #
     # @param params [Hash] The named parameters provided to the
     #   controller which will be used by the actions within the

data/lib/vedeu/common.rb

@@ -28,6 +28,14 @@ module Vedeu
       klass[(klass.rindex('::') + 2)..-1]
     end
 
+    # Returns a boolean indicating whether the value is a Fixnum.
+    #
+    # @param value [Fixnum|void]
+    # @return [Boolean]
+    def numeric?(value)
+      value.is_a?(Fixnum)
+    end
+
     # Returns a boolean indicating whether a variable has a useful
     # value.
     #

data/lib/vedeu/cursors/reposition.rb

@@ -48,6 +48,16 @@ module Vedeu
 
       private
 
+      # @return [Hash<Symbol => Fixnum>]
+      def absolute
+        {
+          x:  coordinate((x - geometry.x), :x).x,
+          y:  coordinate((y - geometry.y), :y).y,
+          ox: 0,
+          oy: 0,
+        }
+      end
+
       # @return [Boolean]
       def absolute?
         mode == :absolute
@@ -116,16 +126,10 @@ module Vedeu
       # @return [Hash<Symbol => Fixnum>]
       def new_attributes
         if absolute? && inside_geometry?
-          cursor.attributes.merge!(x:  coordinate((x - geometry.x), :x).x,
-                                   y:  coordinate((y - geometry.y), :y).y,
-                                   ox: 0,
-                                   oy: 0)
+          cursor.attributes.merge!(absolute)
 
         elsif relative?
-          cursor.attributes.merge!(x:  coordinate(x, :x).x,
-                                   y:  coordinate(y, :y).y,
-                                   ox: x,
-                                   oy: y)
+          cursor.attributes.merge!(relative)
 
         else
           cursor.attributes
@@ -133,6 +137,16 @@ module Vedeu
         end
       end
 
+      # @return [Hash<Symbol => Fixnum>]
+      def relative
+        {
+          x:  coordinate(x, :x).x,
+          y:  coordinate(y, :y).y,
+          ox: x,
+          oy: y,
+        }
+      end
+
       # @return [Boolean]
       def relative?
         mode == :relative

data/lib/vedeu/dsl/dsl.rb

@@ -4,7 +4,7 @@ module Vedeu
   #
   module DSL
 
-    # Returns an instance of the DSL class including {Vedeu::DSL}.
+    # Returns a new instance of the DSL class including {Vedeu::DSL}.
     #
     # @param model [void] The model class which the DSL class is
     #   wrapping.

data/lib/vedeu/input/all.rb

@@ -15,6 +15,7 @@ require 'vedeu/input/key'
 require 'vedeu/input/keymap'
 require 'vedeu/input/mapper'
 require 'vedeu/input/mouse'
+require 'vedeu/input/read'
 require 'vedeu/input/repository'
 require 'vedeu/input/store'
 require 'vedeu/input/translator'

data/lib/vedeu/input/capture.rb

@@ -1,5 +1,7 @@
 module Vedeu
 
+  ESCAPE_KEY_CODE = 27 # \e
+
   module Input
 
     # Captures input from the user terminal via 'getch' and
@@ -7,8 +9,6 @@ module Vedeu
     #
     class Capture
 
-      ESCAPE_KEY_CODE = 27 # \e
-
       extend Forwardable
 
       def_delegators Vedeu::Terminal::Mode,
@@ -93,7 +93,7 @@ module Vedeu
       def input
         keys = console.getch
 
-        if keys.ord == ESCAPE_KEY_CODE
+        if keys.ord == Vedeu::ESCAPE_KEY_CODE
           keys << console.read_nonblock(4) rescue nil
           keys << console.read_nonblock(3) rescue nil
           keys << console.read_nonblock(2) rescue nil

data/lib/vedeu/input/mouse.rb

@@ -14,7 +14,7 @@ module Vedeu
         new(input).click
       end
 
-      # Return an instance of Vedeu::Input::Mouse.
+      # Returns a new instance of Vedeu::Input::Mouse.
       #
       # @param input [String]
       # @return [Vedeu::Input::Mouse]

data/lib/vedeu/input/read.rb

@@ -0,0 +1,133 @@
+module Vedeu
+
+  module Input
+
+    # Directly read from the terminal.
+    #
+    # @example
+    #   Vedeu.read(input, options)
+    #
+    # @api private
+    #
+    class Read
+
+      include Vedeu::Common
+
+      # @api public
+      # @see Vedeu::Input::Read#initialize
+      def self.read(input = nil, options = {})
+        new(input, options).read
+      end
+
+      # Returns a new instance of Vedeu::Input::Read.
+      #
+      # @param input [NilClass|String]
+      # @param options [Hash<Symbol => Symbol]
+      # @option mode [Symbol] Either :cooked (default) or :raw
+      # @return [Vedeu::Input::Read]
+      def initialize(input = nil, options = {})
+        @input   = input
+        @options = options
+      end
+
+      # @return [String]
+      def read
+        if cooked?
+          Vedeu.trigger(:_command_, input)
+
+        else
+          Vedeu.trigger(:_keypress_, input)
+
+        end
+
+        input
+      end
+
+      protected
+
+      # @!attribute [r] input
+      # @return [NilClass|String]
+      attr_reader :input
+
+      private
+
+      # @return [IO]
+      def console
+        @console ||= Vedeu::Terminal.console
+      end
+
+      # @return [Boolean]
+      def cooked?
+        mode == :cooked
+      end
+
+      # @return [Hash<Symbol => Symbol>]
+      def defaults
+        {
+          mode: :cooked
+        }
+      end
+
+      # @return [String]
+      def input
+        @_input ||= if input?
+                      @input
+
+                    elsif cooked?
+                      console.gets.chomp
+
+                    else
+                      keys = console.getch
+
+                      if keys.ord == Vedeu::ESCAPE_KEY_CODE
+                        keys << console.read_nonblock(4) rescue nil
+                        keys << console.read_nonblock(3) rescue nil
+                        keys << console.read_nonblock(2) rescue nil
+                      end
+
+                      Vedeu::Input::Translator.translate(keys)
+
+                    end
+      end
+
+      # @return [Boolean]
+      def input?
+        present?(@input)
+      end
+
+      # @return [Symbol]
+      def mode
+        fail Vedeu::Error::InvalidSyntax,
+             'mode option must be `:raw` or `:cooked`.' unless valid_mode?
+
+        options[:mode]
+      end
+
+      # @return [Array<Symbol>]
+      def modes
+        [
+          :cooked,
+          :raw,
+        ]
+      end
+
+      # @return [Hash<Symbol => Symbol>]
+      def options
+        defaults.merge!(@options)
+      end
+
+      # @return [Boolean]
+      def valid_mode?
+        modes.include?(options[:mode])
+      end
+
+    end # Read
+
+  end # Input
+
+  # @!method read
+  #   @see Vedeu::Input::Read#read
+  def_delegators Vedeu::Input::Read,
+                 :read
+
+end # Vedeu

data/lib/vedeu/models/page.rb

@@ -38,7 +38,7 @@ module Vedeu
         end
       end
 
-      # Returns an instance of Vedeu::Models::Page.
+      # Returns a new instance of Vedeu::Models::Page.
       #
       # @param rows [Array<NilClass|Vedeu::Models::Row>]
       # @return [Vedeu::Models::Page]

data/lib/vedeu/models/row.rb

@@ -30,7 +30,7 @@ module Vedeu
         end
       end
 
-      # Returns an instance of Vedeu::Models::Row.
+      # Returns a new instance of Vedeu::Models::Row.
       #
       # @param cells [Array<NilClass|void>]
       # @return [Vedeu::Models::Row]

data/lib/vedeu/null/generic.rb

@@ -14,7 +14,7 @@ module Vedeu
       # @return [String|Symbol]
       attr_reader :name
 
-      # Returns an instance of the Vedeu::Null::Generic class.
+      # Returns a new instance of the Vedeu::Null::Generic class.
       #
       # @param attributes [Hash<Symbol => void>]
       # @option attributes name [String|Symbol|NilClass]

data/lib/vedeu/output/all.rb

@@ -14,3 +14,4 @@ require 'vedeu/output/wordwrap'
 require 'vedeu/output/presentation/all'
 require 'vedeu/output/refresh'
 require 'vedeu/output/renderers/all'
+require 'vedeu/output/write'

data/lib/vedeu/output/viewport.rb

@@ -34,7 +34,7 @@ module Vedeu
         new(view).render
       end
 
-      # Returns an instance of Vedeu::Output::Viewport.
+      # Returns a new instance of Vedeu::Output::Viewport.
       #
       # @param view [Vedeu::Views::View]
       # @return [Vedeu::Output::Viewport]

data/lib/vedeu/output/write.rb

@@ -0,0 +1,114 @@
+module Vedeu
+
+  module Output
+
+    # Directly write to the terminal.
+    #
+    # @example
+    #   Vedeu.write(output, options)
+    #
+    # @api private
+    #
+    class Write
+
+      include Vedeu::Common
+      include Vedeu::Presentation
+
+      # @api public
+      # @see Vedeu::Output::Write#initialize
+      def self.write(output = nil, options = {})
+        new(output, options).write
+      end
+
+      # Returns a new instance of Vedeu::Output::Write.
+      #
+      # @param output [String]
+      # @param options [Hash<Symbol => Fixnum>]
+      # @option x [Fixnum]
+      # @option y [Fixnum]
+      # @option colour [Hash<Symbol => String>]
+      # @option style [Array<Symbol>|Symbol]
+      # @return [Vedeu::Output::Write]
+      def initialize(output = nil, options = {})
+        @output  = output
+        @options = options
+      end
+
+      # @return [NilClass]
+      def parent
+        nil
+      end
+
+      # @return [Vedeu::Geometries::Position]
+      def position(pos = position_start)
+        Vedeu::Geometries::Position.coerce(pos)
+      end
+
+      # @return [Array<String>]
+      def write
+        Vedeu.direct_write(to_s)
+
+        to_s
+      end
+
+      protected
+
+      # @!attribute [r] output
+      # @return [String]
+      attr_reader :output
+      alias_method :value, :output
+
+      private
+
+      # @return [Hash<Symbol => Fixnum>]
+      def defaults
+        {
+          x: 1,
+          y: 1,
+        }
+      end
+
+      # @return [Hash<Symbol => Fixnum>]
+      def options
+        defaults.merge!(@options)
+      end
+      alias_method :attributes, :options
+
+      # @return [String]
+      def output
+        @output.to_s
+      end
+
+      # @return [Hash<Symbol => Fixnum>]
+      def position_start
+        {
+          x: options[:x],
+          y: options[:y],
+        }
+      end
+
+      # @return [Hash<Symbol => Fixnum>]
+      def position_end
+        {
+          x: options[:x] + output.size,
+          y: options[:y],
+        }
+      end
+
+      # @return [String]
+      def to_s
+        @_to_s ||= super +
+                   Vedeu::EscapeSequences::Esc.reset +
+                   position(position_end)
+      end
+
+    end # Write
+
+  end # Output
+
+  # @!method write
+  #   @see Vedeu::Output::Write#write
+  def_delegators Vedeu::Output::Write,
+                 :write
+
+end # Vedeu

data/lib/vedeu/version.rb

@@ -1,6 +1,6 @@
 module Vedeu
 
   # The current version of Vedeu.
-  VERSION = '0.6.64'.freeze
+  VERSION = '0.6.65'.freeze
 
 end

data/test/lib/vedeu/common_test.rb

@@ -19,7 +19,7 @@ module Vedeu
   describe Common do
 
     let(:described) { Vedeu::VedeuCommonClass }
-    let(:instance) { described.new }
+    let(:instance)  { described.new }
 
     describe '#absent?' do
       subject { instance.undefined_value_test(_value) }
@@ -58,6 +58,22 @@ module Vedeu
       it { subject.must_equal('VedeuCommonClass') }
     end
 
+    describe '#numeric?' do
+      let(:_value) {}
+
+      subject { instance.numeric?(_value) }
+
+      context 'when the value is numeric' do
+        let(:_value) { 16 }
+
+        it { subject.must_equal(true) }
+      end
+
+      context 'when the value is not numeric' do
+        it { subject.must_equal(false) }
+      end
+    end
+
     describe '#present?' do
       subject { instance.defined_value_test(_value) }
 

data/test/lib/vedeu/input/read_test.rb

@@ -0,0 +1,102 @@
+require 'test_helper'
+
+module Vedeu
+
+  module Input
+
+    describe Read do
+
+      let(:described) { Vedeu::Input::Read }
+      let(:instance)  { described.new(input, options) }
+      let(:input)     {}
+      let(:options)   {
+        {
+          mode: mode
+        }
+      }
+      let(:mode) { :cooked }
+
+      describe '#initialize' do
+        it { instance.must_be_instance_of(described) }
+        it { instance.instance_variable_get('@input').must_equal(input) }
+        it { instance.instance_variable_get('@options').must_equal(options) }
+      end
+
+      describe '.read' do
+        subject { described.read(input, options) }
+
+        context 'when the mode is :cooked' do
+          context 'when input was given' do
+            let(:input) { 'Some text...' }
+
+            it {
+              Vedeu.expects(:trigger).with(:_command_, input)
+              subject.must_equal(input)
+            }
+          end
+
+          context 'when input was not given' do
+            let(:some_input) { "Some text...\n" }
+            let(:chomped)    { 'Some text...' }
+
+            it {
+              Vedeu::Terminal.console.expects(:gets).returns(some_input)
+              Vedeu.expects(:trigger).with(:_command_, chomped)
+              subject.must_equal(chomped)
+            }
+          end
+        end
+
+        context 'when the mode is :raw' do
+          let(:mode) { :raw }
+
+          context 'when input was given' do
+            let(:input) { 'S' }
+
+            it {
+              Vedeu.expects(:trigger).with(:_keypress_, input)
+              subject.must_equal(input)
+            }
+          end
+
+          context 'when input was not given' do
+            let(:some_input) { 'T' }
+            let(:translated) { 'T' }
+
+            it {
+              Vedeu::Terminal.console.expects(:getch).returns(some_input)
+              Vedeu::Input::Translator.expects(:translate).returns(translated)
+              Vedeu.expects(:trigger).with(:_keypress_, translated)
+              subject.must_equal(translated)
+            }
+
+            context 'but a special key is pressed' do
+              let(:some_input) { "\e[23;2~" }
+              let(:translated) { :shift_f11 }
+
+              it {
+                Vedeu::Terminal.console.expects(:getch).returns(some_input)
+                Vedeu::Input::Translator.expects(:translate).returns(translated)
+                Vedeu.expects(:trigger).with(:_keypress_, translated)
+                subject.must_equal(translated)
+              }
+            end
+          end
+        end
+
+        context 'when the mode is invalid' do
+          let(:mode) { :invalid }
+
+          it { proc { subject }.must_raise(Vedeu::Error::InvalidSyntax) }
+        end
+      end
+
+      describe '#read' do
+        it { instance.must_respond_to(:read) }
+      end
+
+    end # Read
+
+  end # Input
+
+end # Vedeu

data/test/lib/vedeu/logging/ips_test.rb

@@ -13,7 +13,7 @@ module Vedeu
 
         describe '#initialize' do
           it { instance.must_be_instance_of(described) }
-          it { instance.instance_variable_get('@old_stdout').must_be_instance_of(StringIO) }
+          it { instance.instance_variable_get('@old_stdout').wont_equal(nil) }
           it { instance.instance_variable_get('@samples').must_equal({}) }
           it { instance.instance_variable_get('@benchmark').must_be_instance_of(Benchmark::IPS::Job) }
           it { instance.instance_variable_get('@count').must_equal(0) }

data/test/lib/vedeu/output/write_test.rb

@@ -0,0 +1,92 @@
+require 'test_helper'
+
+module Vedeu
+
+  module Output
+
+    describe Write do
+
+      let(:described) { Vedeu::Output::Write }
+      let(:instance)  { described.new(output, options) }
+      let(:output)    {}
+      let(:options)   { {} }
+
+      describe '#initialize' do
+        it { instance.must_be_instance_of(described) }
+        it { instance.instance_variable_get('@output').must_equal(output) }
+        it { instance.instance_variable_get('@options').must_equal(options) }
+      end
+
+      describe '.write' do
+        before do
+          Vedeu::Terminal.stubs(:output)
+        end
+
+        subject { described.write(output, options) }
+
+        context 'when the output is empty' do
+          let(:expected) { "\e[1;1H\e[0m\e[1;1H" }
+
+          it { subject.must_equal(expected) }
+        end
+
+        context 'when the output is not empty' do
+          let(:output)   { 'Some text...' }
+          let(:expected) { "\e[1;1HSome text...\e[0m\e[1;13H" }
+
+          it { subject.must_equal(expected) }
+        end
+
+        context 'when a colour is provided' do
+          let(:output) { 'Some text...' }
+          let(:options) {
+            {
+              colour: { background: '#ff0000', foreground: '#ffff00' }
+            }
+          }
+          let(:expected) {
+            "\e[1;1H"            \
+            "\e[38;2;255;255;0m" \
+            "\e[48;2;255;0;0m"   \
+            "Some text..."       \
+            "\e[0m"              \
+            "\e[1;13H"           \
+          }
+
+          it { subject.must_equal(expected) }
+        end
+
+        context 'when a style is provided' do
+          let(:output) { 'Some text...' }
+          let(:options) {
+            {
+              style: :underline,
+            }
+          }
+          let(:expected) { "\e[1;1H\e[4mSome text...\e[0m\e[1;13H" }
+
+          it { subject.must_equal(expected) }
+        end
+      end
+
+      describe '#parent' do
+        subject { instance.parent }
+
+        it { subject.must_equal(nil) }
+      end
+
+      describe '#position' do
+        subject { instance.position }
+
+        it { subject.must_be_instance_of(Vedeu::Geometries::Position) }
+      end
+
+      describe '#write' do
+        it { instance.must_respond_to(:write) }
+      end
+
+    end # Write
+
+  end # Output
+
+end # Vedeu

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vedeu
 version: !ruby/object:Gem::Version
-  version: 0.6.64
+  version: 0.6.65
 platform: ruby
 authors:
 - Gavin Laking
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-22 00:00:00.000000000 Z
+date: 2015-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
@@ -440,6 +440,7 @@ files:
 - lib/vedeu/input/keymap.rb
 - lib/vedeu/input/mapper.rb
 - lib/vedeu/input/mouse.rb
+- lib/vedeu/input/read.rb
 - lib/vedeu/input/repository.rb
 - lib/vedeu/input/store.rb
 - lib/vedeu/input/translator.rb
@@ -497,6 +498,7 @@ files:
 - lib/vedeu/output/text.rb
 - lib/vedeu/output/viewport.rb
 - lib/vedeu/output/wordwrap.rb
+- lib/vedeu/output/write.rb
 - lib/vedeu/plugins/all.rb
 - lib/vedeu/plugins/plugin.rb
 - lib/vedeu/plugins/plugins.rb
@@ -623,6 +625,7 @@ files:
 - test/lib/vedeu/input/keymap_test.rb
 - test/lib/vedeu/input/mapper_test.rb
 - test/lib/vedeu/input/mouse_test.rb
+- test/lib/vedeu/input/read_test.rb
 - test/lib/vedeu/input/repository_test.rb
 - test/lib/vedeu/input/store_test.rb
 - test/lib/vedeu/input/translator_test.rb
@@ -671,6 +674,7 @@ files:
 - test/lib/vedeu/output/text_test.rb
 - test/lib/vedeu/output/viewport_test.rb
 - test/lib/vedeu/output/wordwrap_test.rb
+- test/lib/vedeu/output/write_test.rb
 - test/lib/vedeu/plugins/plugin_test.rb
 - test/lib/vedeu/plugins/plugins_test.rb
 - test/lib/vedeu/repositories/assemblage_test.rb
@@ -835,6 +839,7 @@ test_files:
 - test/lib/vedeu/input/keymap_test.rb
 - test/lib/vedeu/input/mapper_test.rb
 - test/lib/vedeu/input/mouse_test.rb
+- test/lib/vedeu/input/read_test.rb
 - test/lib/vedeu/input/repository_test.rb
 - test/lib/vedeu/input/store_test.rb
 - test/lib/vedeu/input/translator_test.rb
@@ -883,6 +888,7 @@ test_files:
 - test/lib/vedeu/output/text_test.rb
 - test/lib/vedeu/output/viewport_test.rb
 - test/lib/vedeu/output/wordwrap_test.rb
+- test/lib/vedeu/output/write_test.rb
 - test/lib/vedeu/plugins/plugin_test.rb
 - test/lib/vedeu/plugins/plugins_test.rb
 - test/lib/vedeu/repositories/assemblage_test.rb