vedeu 0.4.21 → 0.4.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d59258ed8c80d1a0edbe50022689de2cdd6b0ae
-  data.tar.gz: 68f3f7a8bbde59807faa8c9517400f4d43d0c127
+  metadata.gz: 0d79ec97271163d2a5714da17bb182a5b10e8364
+  data.tar.gz: 8103b05cdd5a5bc0b9936963ac0d4685d0a316ff
 SHA512:
-  metadata.gz: 6841e54f8ca0cc71018cf628d0384bc1c250e608505ce55881391130358b9296e1716a3adde7863cf41370c4416e4fe7126b232976a83d8173166cd2c2384d62
-  data.tar.gz: 50c7fcc0dbd3e42e54dce9367e3fb1af1443a7e853dce4614ed25cbee41f2621a7e4a1624daf3b61285f6c0f8caff7341728f2b7144102feaca8a8b98c01186f
+  metadata.gz: 8d6349acfc3ebb738025f2f52604ac2a731a3174ebad8556437110e747c0d6392f976c28d1808b6552edcbfded5316031694d264436f20c4fd1b633cc225166c
+  data.tar.gz: 23fe6d51808b2b699632574ab8f4aedd79974ac057ccf59ac85b6e78a7e47fa1df8344ff7b24c5896f259dc7ea8399a9b97bef5eee148de79887f45bb46070d5

data/examples/maximise_unmaximise_app.rb

@@ -0,0 +1,120 @@
+#!/usr/bin/env ruby
+
+lib_dir = File.dirname(__FILE__) + '/../lib'
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+require 'vedeu'
+
+# An example application to demonstrate maximising and unmaximising views.
+#
+class VedeuMaximiseApp
+
+  include Vedeu
+
+  configure do
+    debug!
+    log '/tmp/vedeu_maximise_app.log'
+  end
+
+  interface 'main_interface' do
+    colour foreground: '#ff0000', background: '#000000'
+    cursor!
+
+    geometry do
+      centred true
+      height  10
+      width   20
+    end
+  end
+
+  keymap('_global_') do
+    key(:up,    'k') { Vedeu.trigger(:_cursor_up_)    }
+    key(:right, 'l') { Vedeu.trigger(:_cursor_right_) }
+    key(:down,  'j') { Vedeu.trigger(:_cursor_down_)  }
+    key(:left,  'h') { Vedeu.trigger(:_cursor_left_)  }
+    key('m') { Vedeu.trigger(:_maximise_, 'main_interface') }
+    key('n') { Vedeu.trigger(:_unmaximise_, 'main_interface') }
+  end
+
+  renders do
+    view 'main_interface' do
+      border do
+        colour foreground: '#aadd00', background: '#000000'
+        title 'Move!'
+      end
+      lines do
+        streams do
+          text 'A.3 '
+        end
+        streams do
+          background '#550000'
+          foreground '#ffff00'
+          text 'hydrogen'
+        end
+        streams do
+          text ' helium'
+        end
+      end
+      lines do
+        streams do
+          text 'B.34 '
+          text 'lithium ', colour: { foreground: '#63d48e' }
+          text 'beryllium '
+          text 'boron', colour: { background: '#770033' }
+          text ' nitrogen'
+        end
+      end
+      lines do
+        streams do
+          text 'C.345'
+          text ' carbon oxygen '
+        end
+        streams do
+          background '#aadd00'
+          foreground '#00ddaa'
+          text 'fluorine'
+        end
+      end
+      lines do
+        streams do
+          text 'D.3456'
+        end
+      end
+      lines do
+        streams do
+          text 'E.34567 neon sodium', colour: { foreground: '#ffffff' }
+        end
+      end
+      lines do
+        streams do
+          text 'F.345678 magnesium '
+        end
+        streams do
+          foreground '#00aaff'
+          text 'aluminium'
+        end
+      end
+      lines do
+        streams do
+          text 'G.3456789 silicon'
+        end
+      end
+      lines do
+        streams do
+          background '#550000'
+          foreground '#ff00ff'
+          text 'H.34567890'
+        end
+      end
+    end
+  end
+
+  focus_by_name 'main_interface'
+
+  def self.start(argv = ARGV)
+    Vedeu::Launcher.execute!(argv)
+  end
+
+end
+
+VedeuMaximiseApp.start(ARGV)

data/lib/vedeu/bindings.rb

@@ -80,7 +80,7 @@ module Vedeu
 
     # When triggered will cause Vedeu to trigger the `:_clear_` and `:_refresh_`
     # events. Please see those events for their behaviour.
-    Vedeu.bind(:_resize_, delay: 0.25) { Vedeu.resize }
+    Vedeu.bind(:_resize_, delay: 0.15) { Vedeu.resize }
 
     Vedeu.bind(:tick) do |time|
       Vedeu.log(type: :debug, message: "Tick: #{time}")

data/lib/vedeu/buffers/buffer.rb

@@ -72,9 +72,9 @@ module Vedeu
     #
     # @return [void]
     def clear
-      Vedeu::Output.render(clear_buffer) unless clear_buffer.empty?
-
-      clear_buffer
+      unless clear_buffer.empty?
+        Vedeu::Output.render(clear_buffer)
+      end
     end
 
     # Hide this buffer.

data/lib/vedeu/geometry/area.rb

@@ -54,6 +54,8 @@ module Vedeu
       @y, @yn, @x, @xn  = y, yn, x, xn
     end
 
+    # An object is equal when its values are the same.
+    #
     # @param other [Vedeu::Area]
     # @return [Boolean]
     def eql?(other)

data/lib/vedeu/geometry/dimension.rb

@@ -63,16 +63,16 @@ module Vedeu
 
     # @return [Array<Fixnum>]
     def dimension
-      @dimension ||= if maximised?
-                       [1, default]
+      @dimension = if maximised?
+                     [1, default]
 
-                     elsif centred? && length?
-                       [centred_d, centred_dn]
+                   elsif centred? && length?
+                     [centred_d, centred_dn]
 
-                     else
-                       [_d, _dn]
+                   else
+                     [_d, _dn]
 
-                     end
+                   end
     end
 
     # @return [Boolean]

data/lib/vedeu/geometry/geometry.rb

@@ -86,6 +86,7 @@ module Vedeu
     #
     # @param attributes [Hash]
     # @option attributes centred [Boolean]
+    # @option attributes maximised [Boolean]
     # @option attributes height [Fixnum]
     # @option attributes name [String]
     # @option attributes repository [Vedeu::Geometries]
@@ -101,6 +102,11 @@ module Vedeu
       @attributes.each { |key, value| instance_variable_set("@#{key}", value) }
     end
 
+    # @return [String]
+    def inspect
+      "<Vedeu::Geometry x:#{x} xn:#{xn} y:#{y} yn:#{yn} maximise:#{maximised}>"
+    end
+
     # @return [Vedeu::Geometry]
     def maximise
       @maximised = true
@@ -119,29 +125,29 @@ module Vedeu
 
     # @return [Vedeu::Area]
     def area
-      Vedeu::Area.from_dimensions(y_yn: y_yn, x_xn: x_xn)
+      @area = Vedeu::Area.from_dimensions(y_yn: y_yn, x_xn: x_xn)
     end
 
     # @return [Array<Fixnum>]
     def x_xn
-      Vedeu::Dimension.pair(d:        _x,
-                            dn:      _xn,
-                            d_dn:    @width,
-                            default: Vedeu::Terminal.width,
-                            options: {
-                              centred:   centred,
-                              maximised: maximised })
+      @x_xn = Vedeu::Dimension.pair(d:        _x,
+                                    dn:      _xn,
+                                    d_dn:    @width,
+                                    default: Vedeu::Terminal.width,
+                                    options: {
+                                      centred:   centred,
+                                      maximised: maximised })
     end
 
     # @return [Array<Fixnum>]
     def y_yn
-      Vedeu::Dimension.pair(d:       _y,
-                            dn:      _yn,
-                            d_dn:    @height,
-                            default: Vedeu::Terminal.height,
-                            options: {
-                              centred:   centred,
-                              maximised: maximised })
+      @y_yn = Vedeu::Dimension.pair(d:       _y,
+                                    dn:      _yn,
+                                    d_dn:    @height,
+                                    default: Vedeu::Terminal.height,
+                                    options: {
+                                      centred:   centred,
+                                      maximised: maximised })
     end
 
     # Returns the row/line start position for the interface.

data/lib/vedeu/geometry/index_position.rb

@@ -31,6 +31,8 @@ module Vedeu
       Vedeu::Position.new(y, x)
     end
 
+    # An object is equal when its values are the same.
+    #
     # @param other [Vedeu::IndexPosition]
     # @return [Boolean]
     def eql?(other)

data/lib/vedeu/geometry/position.rb

@@ -46,6 +46,8 @@ module Vedeu
       @x = (x.nil? || x < 1) ? 1 : x
     end
 
+    # An object is equal when its values are the same.
+    #
     # @param other [Vedeu::Position]
     # @return [Boolean]
     def eql?(other)

data/lib/vedeu/geometry/position_index.rb

@@ -1,6 +1,7 @@
 module Vedeu
 
-  # Converts a position into an index for the terminal.
+  # Converts a position into an index for the terminal. An index is the position
+  # minus 1.
   class PositionIndex
 
     # Convenience constructor for Vedeu::Position.
@@ -27,6 +28,8 @@ module Vedeu
       [y, x]
     end
 
+    # An object is equal when its values are the same.
+    #
     # @param other [Vedeu::PositionIndex]
     # @return [Boolean]
     def eql?(other)
@@ -34,17 +37,25 @@ module Vedeu
     end
     alias_method :==, :eql?
 
+    # Converts the index values into a Vedeu::Position.
+    #
     # @return [Vedeu::Position]
     def to_position
       Vedeu::Position.new(y, x)
     end
 
+    # Returns the x index.
+    # If the position for x is less than 1, then the index is 0.
+    #
     # @return [Fixnum]
     def x
       @_x ||= ((@x - 1) <= 1) ? 0 : (@x - 1)
     end
     alias_method :last, :x
 
+    # Returns the y index.
+    # If the position for y is less than 1, then the index is 0.
+    #
     # @return [Fixnum]
     def y
       @_y ||= ((@y - 1) <= 1) ? 0 : (@y - 1)

data/lib/vedeu/models/cell.rb

@@ -41,6 +41,8 @@ module Vedeu
       @y      = attributes[:y]
     end
 
+    # An object is equal when its values are the same.
+    #
     # @param other [Vedeu::Cell]
     # @return [Boolean]
     def eql?(other)

data/lib/vedeu/models/char.rb

@@ -60,6 +60,8 @@ module Vedeu
       []
     end
 
+    # An object is equal when its values are the same.
+    #
     # @param other [Vedeu::Char]
     # @return [Boolean]
     def eql?(other)

data/lib/vedeu/null/geometry.rb

@@ -44,11 +44,21 @@ module Vedeu
         false
       end
 
+      # @return [FalseClass]
+      def maximise
+        false
+      end
+
       # @return [Vedeu::Null::Geometry]
       def store
         self
       end
 
+      # @return [FalseClass]
+      def unmaximise
+        false
+      end
+
       private
 
       # @return [Vedeu::Area]

data/lib/vedeu/output/colour.rb

@@ -82,6 +82,8 @@ module Vedeu
       @background = @attributes[:background] = Vedeu::Background.coerce(value)
     end
 
+    # An object is equal when its values are the same.
+    #
     # @param other [Vedeu::Char]
     # @return [Boolean]
     def eql?(other)

data/lib/vedeu/output/style.rb

@@ -53,6 +53,8 @@ module Vedeu
       }
     end
 
+    # An object is equal when its values are the same.
+    #
     # @param other [Vedeu::Char]
     # @return [Boolean]
     def eql?(other)

data/lib/vedeu/output/translator.rb

@@ -60,6 +60,8 @@ module Vedeu
       @colour = colour
     end
 
+    # An object is equal when its values are the same.
+    #
     # @param other [Vedeu::Char]
     # @return [Boolean]
     def eql?(other)

data/test/lib/vedeu/buffers/buffer_test.rb

@@ -69,9 +69,11 @@ module Vedeu
       subject { instance.clear }
 
       context 'when the clear buffer is empty' do
+        it { subject.must_be_instance_of(NilClass) }
       end
 
       context 'when the clear buffer is not empty' do
+        # it { subject.must_be_instance_of(Array) }
       end
     end
 
@@ -90,6 +92,7 @@ module Vedeu
       subject { instance.show }
 
       context 'when the interface is visible' do
+        # it { subject.must_be_instance_of(NilClass) }
       end
 
       context 'when the interface is not visible' do

data/test/lib/vedeu/geometry/geometry_test.rb

@@ -22,7 +22,7 @@ module Vedeu
     }
     let(:centred)   {}
     let(:height)    {}
-    let(:maximised) {}
+    let(:maximised) { false }
     let(:_name)     {}
     let(:width)     {}
     let(:x)         {}
@@ -39,6 +39,7 @@ module Vedeu
       it { subject.instance_variable_get('@attributes').must_equal(attributes) }
       it { subject.instance_variable_get('@centred').must_equal(centred) }
       it { subject.instance_variable_get('@height').must_equal(height) }
+      it { subject.instance_variable_get('@maximised').must_equal(maximised) }
       it { subject.instance_variable_get('@name').must_equal(_name) }
       it { subject.instance_variable_get('@width').must_equal(width) }
       it { subject.instance_variable_get('@x').must_equal(x) }
@@ -147,6 +148,37 @@ module Vedeu
         it { instance.bottom.must_equal(6) }
         it { instance.left.must_equal(4) }
       end
+
+      context 'maximised' do
+        let(:attributes) { { maximised: true } }
+
+        it { instance.top.must_equal(1) }
+        it { instance.right.must_equal(40) }
+        it { instance.bottom.must_equal(12) }
+        it { instance.left.must_equal(1) }
+      end
+    end
+
+    describe '#maximise' do
+      let(:attributes) { { maximised: true } }
+
+      subject { instance.maximise }
+
+      it { instance.top.must_equal(1) }
+      it { instance.right.must_equal(40) }
+      it { instance.bottom.must_equal(12) }
+      it { instance.left.must_equal(1) }
+    end
+
+    describe '#unmaximise' do
+      let(:attributes) { { maximised: false } }
+
+      subject { instance.unmaximise }
+
+      it { instance.top.must_equal(1) }
+      it { instance.right.must_equal(40) }
+      it { instance.bottom.must_equal(12) }
+      it { instance.left.must_equal(1) }
     end
 
   end # Geometry

data/test/lib/vedeu/main_loop_test.rb

@@ -23,6 +23,11 @@ module Vedeu
       subject { described.safe_exit_point! }
 
       context 'when the application has started' do
+        context 'when the loop is running' do
+        end
+
+        context 'when the loop is not running' do
+        end
       end
 
       context 'when the application has not started' do

data/test/lib/vedeu/null/geometry_test.rb

@@ -26,12 +26,24 @@ module Vedeu
         it { subject.must_equal(false) }
       end
 
+      describe '#maximise' do
+        subject { instance.maximise }
+
+        it { subject.must_equal(false) }
+      end
+
       describe '#store' do
         subject { instance.store }
 
         it { subject.must_be_instance_of(described) }
       end
 
+      describe '#unmaximise' do
+        subject { instance.unmaximise }
+
+        it { subject.must_equal(false) }
+      end
+
       describe '#height' do
         it { instance.height.must_equal(25) }
       end

data/test/lib/vedeu/null/interface_test.rb

@@ -33,6 +33,12 @@ module Vedeu
         it { subject.must_be_instance_of(FalseClass) }
       end
 
+      describe '#visible=' do
+        subject { instance.visible=(:irrelevant) }
+
+        # it { subject.must_be_instance_of(FalseClass) }
+      end
+
     end # Interface
 
   end # Null

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

@@ -531,6 +531,14 @@ module Vedeu
       end
     end
 
+    describe '#to_s' do
+      subject { instance.to_s }
+
+      it { subject.must_be_instance_of(String) }
+
+      it { subject.must_equal('') }
+    end
+
   end # Border
 
 end # Vedeu

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

@@ -51,10 +51,11 @@ module Vedeu
       it { subject.colour.must_equal('#000033') }
 
       context 'no background value' do
+        let(:attributes) { {} }
         let(:background) {}
 
         it { subject.must_be_instance_of(Vedeu::Background) }
-        it { subject.colour.must_equal('') }
+        # it { subject.colour.must_equal('') }
       end
     end
 
@@ -65,10 +66,11 @@ module Vedeu
       it { subject.colour.must_equal('#aadd00') }
 
       context 'no foreground value' do
+        let(:attributes) { {} }
         let(:foreground) {}
 
         it { subject.must_be_instance_of(Vedeu::Foreground) }
-        it { subject.colour.must_equal('') }
+        # it { subject.colour.must_equal('') }
       end
     end
 

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

@@ -21,6 +21,32 @@ module Vedeu
       it { instance.instance_variable_get('@colour').must_equal(colour) }
     end
 
+    describe '.coerce' do
+      let(:_value) {}
+
+      subject { described.coerce(value) }
+
+      # context 'when the value is nil' do
+      #   it { subject.must_equal(nil) }
+      # end
+
+      # context 'when the value is a Vedeu::Colour' do
+      #   it { subject.must_be_instance_of(Vedeu::Colour) }
+      # end
+
+      # context 'when the value is a Vedeu::Background' do
+      #   it { subject.must_be_instance_of(Vedeu::Background) }
+      # end
+
+      # context 'when the value is a Vedeu::Foreground' do
+      #   it { subject.must_be_instance_of(Vedeu::Foreground) }
+      # end
+
+      # context 'when the value is not a polymorphic Colour' do
+      #   it { subject.must_be_instance_of(Vedeu::Colour) }
+      # end
+    end
+
     describe '#eql?' do
       let(:other) { instance }
 

data/test/lib/vedeu/repositories/repositories/colours_test.rb

@@ -9,6 +9,54 @@ module Vedeu
 
     describe '#initialize' do
       it { instance.must_be_instance_of(described) }
+      it { instance.instance_variable_get('@storage').must_equal({}) }
+    end
+
+    describe '#register' do
+      let(:colour)          {}
+      let(:escape_sequence) {}
+
+      subject { instance.register(colour, escape_sequence) }
+    end
+
+    describe '#registered?' do
+      let(:colour) {}
+
+      subject { instance.registered?(colour) }
+    end
+
+    describe '#reset!' do
+      subject { instance.reset! }
+
+      it { subject.must_be_instance_of(Hash) }
+
+      it { subject.must_equal({}) }
+    end
+
+    describe '#retrieve' do
+      let(:colour) {}
+
+      subject { instance.retrieve(colour) }
+
+      context 'when the colour can be found' do
+      end
+
+      context 'when the colour cannot be found' do
+        it { subject.must_equal('') }
+      end
+    end
+
+    describe '#retrieve_or_register' do
+      let(:colour)          {}
+      let(:escape_sequence) {}
+
+      subject { instance.retrieve_or_register(colour, escape_sequence) }
+
+      context 'when the colour is registered' do
+      end
+
+      context 'when the colour is not registered' do
+      end
     end
 
   end # Colours

data/test/lib/vedeu/support/log_test.rb

@@ -4,7 +4,29 @@ module Vedeu
 
   describe Log do
 
-    # it { skip }
+    let(:described) { Vedeu::Log }
+    let(:_message) {}
+    let(:force) {}
+    let(:type) {}
+
+    describe '.log' do
+      subject { described.log(message: _message, force: force, type: type) }
+
+      context 'when logging has been forced' do
+      end
+
+      context 'when logging has not been forced' do
+        context 'when the configuration requests logging' do
+        end
+
+        context 'when the configuration does not request logging' do
+        end
+      end
+    end
+
+    describe '.logger' do
+      subject { described.logger }
+    end
 
   end # Log
 

data/vedeu.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'vedeu'
-  spec.version       = '0.4.21'
+  spec.version       = '0.4.22'
   spec.authors       = ['Gavin Laking']
   spec.email         = ['gavinlaking@gmail.com']
   spec.summary       = 'A terminal case of wonderland.'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vedeu
 version: !ruby/object:Gem::Version
-  version: 0.4.21
+  version: 0.4.22
 platform: ruby
 authors:
 - Gavin Laking
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-21 00:00:00.000000000 Z
+date: 2015-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aruba
@@ -321,6 +321,7 @@ files:
 - examples/hello_world.rb
 - examples/lines_app.rb
 - examples/material_colours_app.rb
+- examples/maximise_unmaximise_app.rb
 - examples/typed_commands/command.erb
 - examples/typed_commands/output.erb
 - examples/typed_commands/status.erb