vedeu 0.6.57 → 0.6.58

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f6b535e5cb8b4ba8c6bc115745981c6934a899e4
-  data.tar.gz: 448638ef6471487754a32e81594054b6dae011e6
+  metadata.gz: d33a3d7e8cd6ab472659549aafd770caeadce867
+  data.tar.gz: 7c8de69994fd536b0d42db2d95d09a51610b3eaa
 SHA512:
-  metadata.gz: e62418c3701fd759daa1f2fce52692c92ed9d2c8b8c476acfaa1ab1e40d215d5c14247ba3c1e8b2c940a0201e9707fa0bc91e5ac62e58826cfd11106ba044f30
-  data.tar.gz: 02b5e88a20ee7b1c7e1f04395ba533c34e9325c9a84d7b2b5257f82fd73010fdcf9186e613b13c742c4e815e450273d6569cc86d67e69a39c38c563a28debf62
+  metadata.gz: eebb2b6fecc5b82b8f936d5f57732729db7ec0698eace850ab92e9d048e5aea66196757d3c1a65d5a932f4ee15dd2feae3ee63d24f4ad68a5168969f69d4d1a9
+  data.tar.gz: 3e11185cf8ae5e7862f4f072ddad207cffc17197b086aae08d403afb02eaa281bf8ca92a5df6c3abc61e0144d7e942780831431e0a0e07ec4c2b085ade3e5863

data/lib/vedeu/geometry/all.rb

@@ -26,6 +26,7 @@ require 'vedeu/geometry/dsl'
 require 'vedeu/geometry/coordinate'
 require 'vedeu/geometry/geometry'
 require 'vedeu/geometry/grid'
+require 'vedeu/geometry/move'
 require 'vedeu/geometry/null'
 require 'vedeu/geometry/position'
 require 'vedeu/geometry/repository'

data/lib/vedeu/geometry/geometry.rb

@@ -84,8 +84,8 @@ module Vedeu
 
       # @param (see #initialize)
       # @return (see #initialize)
-      def self.store(attributes)
-        new(attributes).store
+      def self.store(attributes, &block)
+        new(attributes).store(&block)
       end
 
       # Returns a new instance of Vedeu::Geometry::Geometry.
@@ -169,51 +169,6 @@ module Vedeu
         end
       end
 
-      # Moves the geometry down by one row.
-      #
-      # @return [Vedeu::Geometry::Geometry]
-      def move_down
-        return self if yn + 1 > Vedeu.height
-
-        move(y: y + 1, yn: yn + 1) { Vedeu.trigger(:_cursor_down_, name) }
-      end
-
-      # Moves the geometry left by one column.
-      #
-      # @return [Vedeu::Geometry::Geometry]
-      def move_left
-        return self if x - 1 < 1
-
-        move(x: x - 1, xn: xn - 1) { Vedeu.trigger(:_cursor_left_, name) }
-      end
-
-      # Moves the geometry to the top left of the terminal.
-      #
-      # @return [Vedeu::Geometry::Geometry]
-      def move_origin
-        move(x: 1, xn: (xn - x + 1), y: 1, yn: (yn - y + 1)) do
-          Vedeu.trigger(:_cursor_origin_, name)
-        end
-      end
-
-      # Moves the geometry right by one column.
-      #
-      # @return [Vedeu::Geometry::Geometry]
-      def move_right
-        return self if xn + 1 > Vedeu.width
-
-        move(x: x + 1, xn: xn + 1) { Vedeu.trigger(:_cursor_right_, name) }
-      end
-
-      # Moves the geometry up by one column.
-      #
-      # @return [Vedeu::Geometry::Geometry]
-      def move_up
-        return self if y - 1 < 1
-
-        move(y: y - 1, yn: yn - 1) { Vedeu.trigger(:_cursor_up_, name) }
-      end
-
       # Will unmaximise the named interface geometry. Previously, when
       # a geometry was maximised, then triggering the unmaximise event
       # will return it to its usual defined size (terminal size
@@ -259,36 +214,6 @@ module Vedeu
         }
       end
 
-      # When moving an interface;
-      # 1) Reset the alignment and maximised states to false;
-      #    it wont be aligned to a side if moved, and cannot be moved
-      #    if maximised.
-      # 2) Get the current coordinates of the interface, then:
-      # 3) Override the attributes with the new coordinates for
-      #    desired movement; these are usually +/- 1 of the current
-      #    state, depending on direction.
-      #
-      # @param coordinates [Hash<Symbol => Fixnum>]
-      # @option coordinates x [Fixnum] The starting column/character
-      #   position.
-      # @option coordinates xn [Fixnum] The ending column/character
-      #   position.
-      # @option coordinates y [Fixnum] The starting row/line position.
-      # @option coordinates yn [Fixnum] The ending row/line position.
-      # @return [Hash<Symbol => Boolean, Fixnum>]
-      def move(coordinates = {})
-        attrs = attributes.merge!(horizontal_alignment: :none,
-                                  maximised:            false,
-                                  vertical_alignment:   :none)
-                .merge!(coordinates)
-
-        geometry = Vedeu::Geometry::Geometry.store(attrs)
-
-        yield if block_given?
-
-        geometry
-      end
-
       # Returns the default options/attributes for this class.
       #
       # @return [Hash<Symbol => Boolean|Fixnum|NilClass|String|Symbol|

data/lib/vedeu/geometry/move.rb

@@ -0,0 +1,223 @@
+module Vedeu
+
+  module Geometry
+
+    # Move an interface/view via changing its geometry.
+    #
+    # When moving an interface/view;
+    #
+    # 1) Reset the alignment and maximised states to false;
+    #    it wont be aligned to a side if moved, and cannot be moved
+    #    if maximised.
+    # 2) Get the current coordinates of the interface, then:
+    # 3) Override the attributes with the new coordinates for
+    #    desired movement; these are usually +/- 1 of the current
+    #    state, depending on direction.
+    #
+    # @api private
+    #
+    class Move
+
+      extend Forwardable
+
+      def_delegators :geometry,
+                     :x,
+                     :xn,
+                     :y,
+                     :yn
+
+      # @param attributes See #initialize
+      # @return See #move
+      def self.move(attributes = {})
+        new(attributes).move
+      end
+
+      # Returns a new instance of Vedeu::Geometry::Move.
+      #
+      # @param attributes [Hash<Symbol => Boolean|Fixnum|String|
+      #   Symbol|Vedeu::Geometry::Repository]
+      # @option attributes name [String|Symbol] The name of the
+      #   interface/view.
+      # @option attributes direction [Symbol] The direction to move;
+      #   one of: :down, :left, :origin, :right, :up.
+      # @option attributes offset [Fixnum] The number of columns or
+      #   rows to move by.
+      # @return [Vedeu::Geometry::Move]
+      def initialize(attributes = {})
+        defaults.merge!(attributes).each do |key, value|
+          instance_variable_set("@#{key}", value || defaults.fetch(key))
+        end
+      end
+
+      # @return [FalseClass|Vedeu::Geometry::Geometry]
+      def move
+        return false unless valid?
+
+        Vedeu::Geometry::Geometry.store(new_attributes) do
+          update_cursor!
+          refresh!
+        end
+      end
+
+      protected
+
+      # @!attribute [r] direction
+      # @return [Symbol]
+      attr_reader :direction
+
+      # @!attribute [r] name
+      # @return [String|Symbol]
+      attr_reader :name
+
+      # @!attribute [r] offset
+      # @return [Symbol]
+      attr_reader :offset
+
+      private
+
+      # @return [Hash<Symbol => Fixnum|String|Symbol>]
+      def defaults
+        {
+          direction: :none,
+          name:      '',
+          offset:    1,
+        }
+      end
+
+      # @return [Boolean]
+      def direction?
+        direction != :none
+      end
+
+      # Moves the geometry down by the offset.
+      #
+      # @return [Hash<Symbol => Fixnum]
+      def down
+        {
+          y: y + offset,
+          yn: yn + offset,
+        }
+      end
+
+      # @return [Hash<Symbol => Symbol>]
+      def event
+        {
+          down:   :_cursor_down_,
+          left:   :_cursor_left_,
+          origin: :_cursor_origin_,
+          right:  :_cursor_right_,
+          up:     :_cursor_up_,
+        }[direction]
+      end
+
+      # @return [Vedeu::Geometry::Geometry]
+      def geometry
+        Vedeu.geometries.by_name(name)
+      end
+
+      # Moves the geometry left by the offset.
+      #
+      # @return [Hash<Symbol => Fixnum]
+      def left
+        {
+          x: x - offset,
+          xn: xn - offset,
+        }
+      end
+
+      # @return [Hash<Symbol => Boolean|String|Symbol>]
+      def new_attributes
+        geometry.attributes.merge!(unalign_unmaximise).merge!(send(direction))
+      end
+
+      # Moves the geometry to the top left of the terminal.
+      #
+      # @return [Hash<Symbol => Fixnum]
+      def origin
+        {
+          x:  1,
+          xn: (xn - x + 1),
+          y:  1,
+          yn: (yn - y + 1),
+        }
+      end
+
+      # Refresh the screen after moving.
+      #
+      # @return [void]
+      def refresh!
+        Vedeu.trigger(:_movement_refresh_, name)
+      end
+
+      # Moves the geometry right by the offset.
+      #
+      # @return [Hash<Symbol => Fixnum]
+      def right
+        {
+          x: x + offset,
+          xn: xn + offset,
+        }
+      end
+
+      # @return [Hash<Symbol => Boolean|Symbol]
+      def unalign_unmaximise
+        {
+          horizontal_alignment: :none,
+          maximised:            false,
+          vertical_alignment:   :none,
+        }
+      end
+
+      # Moves the geometry up by the offset.
+      #
+      # @return [Hash<Symbol => Fixnum]
+      def up
+        {
+          y: y - offset,
+          yn: yn - offset,
+        }
+      end
+
+      # Refresh the cursor after moving.
+      #
+      # @return [void]
+      def update_cursor!
+        Vedeu.trigger(event, name)
+      end
+
+      # @return [Boolean]
+      def valid?
+        {
+          down:   valid_down?,
+          left:   valid_left?,
+          origin: true,
+          right:  valid_right?,
+          up:     valid_up?,
+        }.fetch(direction, false)
+      end
+
+      # @return [Boolean]
+      def valid_down?
+        yn + offset <= Vedeu.height
+      end
+
+      # @return [Boolean]
+      def valid_left?
+        x - offset >= 1
+      end
+
+      # @return [Boolean]
+      def valid_right?
+        xn + offset <= Vedeu.width
+      end
+
+      # @return [Boolean]
+      def valid_up?
+        y - offset >= 1
+      end
+
+    end # Move
+
+  end # Geometry
+
+end # Vedeu

data/lib/vedeu/geometry/repository.rb

@@ -46,15 +46,15 @@ module Vedeu
     Vedeu.geometries.by_name(name).unmaximise
   end
 
-  %w(down left right up).each do |direction|
-    Vedeu.bind(:"_view_#{direction}_") do |name|
-      Vedeu.geometries.by_name(name).send("move_#{direction}")
-
-      Vedeu.trigger(:_movement_refresh_, name)
+  [:down, :left, :right, :up].each do |direction|
+    Vedeu.bind(:"_view_#{direction}_") do |name, offset|
+      Vedeu::Geometry::Move.move(direction: direction,
+                                 name:      name,
+                                 offset:    offset)
     end
   end
 
-  %w(down left right up).each do |direction|
+  [:down, :left, :right, :up].each do |direction|
     Vedeu.bind_alias(:"_geometry_#{direction}_", :"_view_#{direction}_")
   end
 

data/lib/vedeu/version.rb

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

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

@@ -132,121 +132,6 @@ module Vedeu
         it { subject.maximised.must_equal(true) }
       end
 
-      describe '#move_down' do
-        let(:x)  { 15 }
-        let(:xn) { 25 }
-        let(:y)  { 4 }
-        let(:yn) { 8 }
-
-        subject { instance.move_down }
-
-        it { subject.must_be_instance_of(described) }
-
-        it { subject.y.must_equal(5) }
-        it { subject.yn.must_equal(9) }
-
-        context 'when the move will make the geometry out of bounds' do
-          let(:x)  { 15 }
-          let(:xn) { 25 }
-          let(:y)  { 8 }
-          let(:yn) { 12 }
-
-          it { subject.y.must_equal(8) }
-          it { subject.yn.must_equal(12) }
-        end
-      end
-
-      describe '#move_left' do
-        let(:x)  { 15 }
-        let(:xn) { 25 }
-        let(:y)  { 4 }
-        let(:yn) { 8 }
-
-        subject { instance.move_left }
-
-        it { subject.must_be_instance_of(described) }
-
-        it { subject.x.must_equal(14) }
-        it { subject.xn.must_equal(24) }
-
-        context 'when the move will make the geometry out of bounds' do
-          let(:x)  { 1 }
-          let(:xn) { 11 }
-          let(:y)  { 4 }
-          let(:yn) { 8 }
-
-          it { subject.x.must_equal(1) }
-          it { subject.xn.must_equal(11) }
-        end
-      end
-
-      describe '#move_origin' do
-        let(:x)  { 15 }
-        let(:xn) { 25 }
-        let(:y)  { 4 }
-        let(:yn) { 8 }
-
-        before do
-          Vedeu.stubs(:trigger)
-        end
-
-        subject { instance.move_origin }
-
-        it { subject.must_be_instance_of(described) }
-        it { subject.x.must_equal(1) }
-        it { subject.xn.must_equal(11) }
-        it { subject.y.must_equal(1) }
-        it { subject.yn.must_equal(5) }
-      end
-
-      describe '#move_right' do
-        let(:x)  { 15 }
-        let(:xn) { 25 }
-        let(:y)  { 4 }
-        let(:yn) { 8 }
-
-        subject { instance.move_right }
-
-        it { subject.must_be_instance_of(described) }
-
-        it { subject.x.must_equal(16) }
-        it { subject.xn.must_equal(26) }
-
-        context 'when the move will make the geometry out of bounds' do
-          let(:x)  { 30 }
-          let(:xn) { 40 }
-          let(:y)  { 4 }
-          let(:yn) { 8 }
-
-          it { subject.x.must_equal(30) }
-          it { subject.xn.must_equal(40) }
-        end
-      end
-
-      describe '#move_up' do
-        let(:x)  { 15 }
-        let(:xn) { 25 }
-        let(:y)  { 4 }
-        let(:yn) { 8 }
-
-        subject { instance.move_up }
-
-        it { subject.must_be_instance_of(described) }
-
-        it { subject.y.must_equal(3) }
-        it { subject.yn.must_equal(7) }
-
-        context 'when the move will make the geometry out of bounds' do
-          let(:x)  { 15 }
-          let(:xn) { 25 }
-          let(:y)  { 1 }
-          let(:yn) { 5 }
-
-          it { subject.y.must_equal(1) }
-          it { subject.yn.must_equal(5) }
-        end
-      end
-
       describe '#unmaximise' do
         let(:attributes) {
           {

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

@@ -0,0 +1,176 @@
+require 'test_helper'
+
+module Vedeu
+
+  module Geometry
+
+    describe Move do
+
+      let(:described)  { Vedeu::Geometry::Move }
+      let(:instance)   { described.new(attributes) }
+      let(:direction)  {}
+      let(:_name)      { 'Vedeu::Geometry::Move' }
+      let(:offset)     {}
+      let(:attributes) {
+        {
+          direction: direction,
+          name:      _name,
+          offset:    offset,
+        }
+      }
+      let(:geometry)   {
+        Vedeu::Geometry::Geometry.new(name: _name, x: 2, xn: 8, y: 2, yn: 8)
+      }
+
+      describe '#initialize' do
+        it { instance.must_be_instance_of(described) }
+
+        context 'when a direction is given' do
+          let(:direction) { :left }
+
+          it {
+            instance.instance_variable_get('@direction').must_equal(direction)
+          }
+        end
+
+        context 'when a direction is not given' do
+          it { instance.instance_variable_get('@direction').must_equal(:none) }
+        end
+
+        context 'when a name is given' do
+          it { instance.instance_variable_get('@name').must_equal(_name) }
+        end
+
+        context 'when a name is not given' do
+          let(:_name) {}
+
+          it { instance.instance_variable_get('@name').must_equal('') }
+        end
+
+        context 'when an offset is given' do
+          let(:offset) { 2 }
+
+          it { instance.instance_variable_get('@offset').must_equal(offset) }
+        end
+
+        context 'when an offset is not given' do
+          it { instance.instance_variable_get('@offset').must_equal(1) }
+        end
+      end
+
+      describe '.move' do
+        before do
+          Vedeu.geometries.stubs(:by_name).with(_name).returns(geometry)
+          Vedeu.stubs(:trigger)
+          Vedeu.stubs(:height).returns(10)
+          Vedeu.stubs(:width).returns(10)
+        end
+
+        subject { described.move(attributes) }
+
+        context 'when the direction is :down' do
+          let(:direction) { :down }
+
+          context 'when y + offset > terminal height' do
+            let(:offset) { 3 }
+
+            it { subject.must_equal(false) }
+          end
+
+          context 'when y + offset <= terminal height' do
+            it { subject.must_be_instance_of(Vedeu::Geometry::Geometry) }
+            it { subject.x.must_equal(2) }
+            it { subject.xn.must_equal(8) }
+            it { subject.y.must_equal(3) }
+            it { subject.yn.must_equal(9) }
+          end
+        end
+
+        context 'when the direction is :left' do
+          let(:direction) { :left }
+
+          context 'when x - offset < 1' do
+            let(:offset) { 3 }
+
+            it { subject.must_equal(false) }
+          end
+
+          context 'when x - offset >= 1' do
+            it { subject.must_be_instance_of(Vedeu::Geometry::Geometry) }
+            it { subject.x.must_equal(1) }
+            it { subject.xn.must_equal(7) }
+            it { subject.y.must_equal(2) }
+            it { subject.yn.must_equal(8) }
+          end
+        end
+
+        context 'when the direction is :none' do
+          let(:direction) { :none }
+          let(:offset)    { 1 }
+
+          it { subject.must_equal(false) }
+        end
+
+        context 'when the direction is :origin' do
+          let(:direction) { :origin }
+
+          it { subject.must_be_instance_of(Vedeu::Geometry::Geometry) }
+          it { subject.x.must_equal(1) }
+          it { subject.xn.must_equal(7) }
+          it { subject.y.must_equal(1) }
+          it { subject.yn.must_equal(7) }
+        end
+
+        context 'when the direction is :right' do
+          let(:direction) { :right }
+
+          context 'when xn + offset > terminal width' do
+            let(:offset) { 3 }
+
+            it { subject.must_equal(false) }
+          end
+
+          context 'when xn + offset <= terminal width' do
+            it { subject.must_be_instance_of(Vedeu::Geometry::Geometry) }
+            it { subject.x.must_equal(3) }
+            it { subject.xn.must_equal(9) }
+            it { subject.y.must_equal(2) }
+            it { subject.yn.must_equal(8) }
+          end
+        end
+
+        context 'when the direction is :up' do
+          let(:direction) { :up }
+
+          context 'when y - offset < 1' do
+            let(:offset) { 3 }
+
+            it { subject.must_equal(false) }
+          end
+
+          context 'when y - offset >= 1' do
+            it { subject.must_be_instance_of(Vedeu::Geometry::Geometry) }
+            it { subject.x.must_equal(2) }
+            it { subject.xn.must_equal(8) }
+            it { subject.y.must_equal(1) }
+            it { subject.yn.must_equal(7) }
+          end
+        end
+
+        context 'when the direction is invalid' do
+          let(:direction) { :invalid }
+          let(:offset)    { 1 }
+
+          it { subject.must_equal(false) }
+        end
+      end
+
+      describe '#move' do
+        it { instance.must_respond_to(:move) }
+      end
+
+    end # Move
+
+  end # Geometry
+
+end # Vedeu

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vedeu
 version: !ruby/object:Gem::Version
-  version: 0.6.57
+  version: 0.6.58
 platform: ruby
 authors:
 - Gavin Laking
@@ -420,6 +420,7 @@ files:
 - lib/vedeu/geometry/geometry.rb
 - lib/vedeu/geometry/grid.rb
 - lib/vedeu/geometry/horizontal_alignment.rb
+- lib/vedeu/geometry/move.rb
 - lib/vedeu/geometry/null.rb
 - lib/vedeu/geometry/position.rb
 - lib/vedeu/geometry/repository.rb
@@ -605,6 +606,7 @@ files:
 - test/lib/vedeu/geometry/geometry_test.rb
 - test/lib/vedeu/geometry/grid_test.rb
 - test/lib/vedeu/geometry/horizontal_alignment_test.rb
+- test/lib/vedeu/geometry/move_test.rb
 - test/lib/vedeu/geometry/null_test.rb
 - test/lib/vedeu/geometry/position_test.rb
 - test/lib/vedeu/geometry/repository_test.rb
@@ -817,6 +819,7 @@ test_files:
 - test/lib/vedeu/geometry/geometry_test.rb
 - test/lib/vedeu/geometry/grid_test.rb
 - test/lib/vedeu/geometry/horizontal_alignment_test.rb
+- test/lib/vedeu/geometry/move_test.rb
 - test/lib/vedeu/geometry/null_test.rb
 - test/lib/vedeu/geometry/position_test.rb
 - test/lib/vedeu/geometry/repository_test.rb