vedeu 0.6.63 → 0.6.64

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62cdfdd3391cb52b378f21160f57a5f0b1bd7792
-  data.tar.gz: 1253650d2091f8d085a6ba99cfb6e035aae658e8
+  metadata.gz: 998283356866d82e0bd3b67de95edd9fbe89fd5f
+  data.tar.gz: 2dd548c709f2b1cda90bc46befe65f666fd28dfd
 SHA512:
-  metadata.gz: 2cfc8ed0ff83a941c2692d1d68ea36cfd9e4022b6796efefd9b254942cc947dd29b9267090c9ddb625948edbff56074c9a7268c9339dd30ca3ab86121c52ef06
-  data.tar.gz: 3a6780083ee0f2b053aaa8dd3450173c53b0020e7909753141b8d8d6660258a6d413d91747670e2c5efca3a76fbaec2be319e851f2b5860094352edcc0b5c560
+  metadata.gz: e53be9215177a8cf0aeeab573ca9f0f2a6ef871480b5bd4a1cc5795af184a7efd2c88c8a2188c12ceb9a04e742f3c54e8ed85c89bc733355bd83dceae478bba8
+  data.tar.gz: a4e513ce13024657f52396d7ad249de4f0329e1c9f6b7939bf910b5856ed2f83c9a6a4b88dfc483e2c0ee93463314e57718dff54be5406f61e7bd548eb5953a6

data/.yardopts

@@ -1,6 +1,8 @@
 --private
 --protected
 --embed-mixins
+--tag api_method:"API Method"
+--tag api_event:"API Event"
 -
 docs/api.md
 docs/borders.md

data/docs/api.md

@@ -43,18 +43,6 @@ See {file:docs/configuration.md}
 
 See {file:docs/events.md}
 
-## Borders
-
-### Vedeu.border
-
-## Geometry
-
-### Vedeu.geometry
-
-## Groups
-
-### Vedeu.group
-
 ## Input
 
 ### Vedeu.keypress
@@ -144,36 +132,377 @@ See {file:docs/events.md}
 ## Renderers
 
 ### Vedeu.renderer
-### Vedeu.renderers
 
-## Repositories
 
-These are collections which you can access:
+# API Methods
+
+### Vedeu.add_command
+
+@todo Add more documentation.
+
+### Vedeu.add_keypress
+
+@todo Add more documentation.
+
+### Vedeu.all_commands
+
+@todo Add more documentation.
+
+### Vedeu.all_keypresses
+
+@todo Add more documentation.
 
 ### Vedeu.background_colours
-### Vedeu.foreground_colours
+
+Repository method. Access registered background colours.
+
+    Vedeu.background_colours # => [Vedeu::Colours::Backgrounds]
+
+    Vedeu.background_colours.all # => [Hash<String => String>]
+
+
+### Vedeu.bind
+
+@todo Add more documentation.
+
+### Vedeu.bind_alias
+
+@todo Add more documentation.
+
+### Vedeu.border
+
+@todo Add more documentation.
+
 ### Vedeu.borders
+
+Repository method. Access registered borders.
+
+    Vedeu.borders # [Vedeu::Borders::Repository]
+
+    Vedeu.borders.all # [Array<Vedeu::Borders::Border>]
+
+### Vedeu.bound?
+
+@todo Add more documentation.
+
+### Vedeu.buffer_update
+
+@todo Add more documentation.
+
+### Vedeu.buffer_write
+
+@todo Add more documentation.
+
 ### Vedeu.buffers
+
+Repository method. Access registered borders.
+
+    Vedeu.buffers # [Vedeu::Buffers::Repository]
+
+    Vedeu.buffers.all # [Array<Vedeu::Buffers::Buffer>]
+
+### Vedeu.clear
+
+@todo Add more documentation.
+
+### Vedeu.clear_by_group
+
+@todo Add more documentation.
+
+### Vedeu.clear_by_name
+
+@todo Add more documentation.
+
+### Vedeu.clear_content_by_name
+
+@todo Add more documentation.
+
+### Vedeu.clock_time
+
+@todo Add more documentation.
+
+### Vedeu.configuration
+
+@todo Add more documentation.
+
+### Vedeu.configure
+
+@todo Add more documentation.
+
+### Vedeu.cursor
+
+@todo Add more documentation.
+
 ### Vedeu.cursors
+
+Repository method. Access registered cursors.
+
+    Vedeu.cursors # [Vedeu::Cursors::Repository]
+
+    Vedeu.cursors.all # [Array<Vedeu::Cursors::Cursor>]
+
+### Vedeu.direct_write
+
+@todo Add more documentation.
+
+### Vedeu.documents
+
+@todo Add more documentation.
+
+### Vedeu.drb_restart
+
+@todo Add more documentation.
+
+### Vedeu.drb_start
+
+@todo Add more documentation.
+
+### Vedeu.drb_status
+
+@todo Add more documentation.
+
+### Vedeu.drb_stop
+
+@todo Add more documentation.
+
 ### Vedeu.events
-### Vedeu.geometries
-### Vedeu.groups
-### Vedeu.interfaces
-### Vedeu.keymaps
-### Vedeu.menus
 
-## Miscellany
+Repository method. Access registered events.
+
+    Vedeu.events # [Vedeu::Events::Repository]
+
+    Vedeu.events.all # [Array<Vedeu::Events::Collection>]
+
+### Vedeu.exit
+
+@todo Add more documentation.
 
-### Vedeu.cursor
 ### Vedeu.focus
+
+@todo Add more documentation.
+
 ### Vedeu.focus_by_name
-### Vedeu.focussed?
+
+@todo Add more documentation.
+
 ### Vedeu.focus_next
+
+@todo Add more documentation.
+
 ### Vedeu.focus_previous
+
+@todo Add more documentation.
+
+### Vedeu.focussed?
+
+@todo Add more documentation.
+
+### Vedeu.foreground_colours
+
+Show all the registered foreground colours.
+
+    Vedeu.foreground_colours.all # => [Hash<String => String>]
+
+    Vedeu.foreground_colours # => [Vedeu::Colours::Foregrounds]
+
+### Vedeu.geometries
+
+Repository method. Access registered interface/view geometry.
+
+    Vedeu.geometries # [Vedeu::Geometries::Repository]
+
+    Vedeu.geometries.all # [Array<Vedeu::Geometries::Geometry>]
+
+### Vedeu.geometry
+
+@todo Add more documentation.
+
+### Vedeu.goto
+
+@todo Add more documentation.
+
+### Vedeu.group
+
+@todo Add more documentation.
+
+### Vedeu.groups
+
+Repository method. Access registered groups.
+
+    Vedeu.groups # [Vedeu::Groups::Repository]
+
+    Vedeu.groups.all # [Array<Vedeu::Groups::Group>]
+
 ### Vedeu.height
+
+@todo Add more documentation.
+
+### Vedeu.hide_cursor
+
+@todo Add more documentation.
+
+### Vedeu.hide_group
+
+@todo Add more documentation.
+
+### Vedeu.hide_interface
+
+@todo Add more documentation.
+
+### Vedeu.interface
+
+@todo Add more documentation.
+
+### Vedeu.interfaces
+
+Repository method. Access registered interfaces.
+
+    Vedeu.interfaces # [Vedeu::Interfaces::Repository]
+
+    Vedeu.interfaces.all # [Array<Vedeu::Interfaces::Interface>]
+
+### Vedeu.keymap
+
+@todo Add more documentation.
+
+### Vedeu.keymaps
+
+Repository method. Access registered keymaps.
+
+    Vedeu.keymaps # [Vedeu::Input::Repository]
+
+    Vedeu.keymaps.all # [Array<Vedeu::Input::Keymap>]
+
+### Vedeu.keypress
+
+@todo Add more documentation.
+
+### Vedeu.keys
+
+@todo Add more documentation.
+
+### Vedeu.last_command
+
+@todo Add more documentation.
+
+### Vedeu.last_keypress
+
+@todo Add more documentation.
+
 ### Vedeu.log
-### Vedeu.log_stdout
+
+@todo Add more documentation.
+
 ### Vedeu.log_stderr
+
+@todo Add more documentation.
+
+### Vedeu.log_stdout
+
+@todo Add more documentation.
+
+### Vedeu.menu
+
+@todo Add more documentation.
+
+### Vedeu.menus
+
+Repository method. Access registered menus.
+
+    Vedeu.menus # [Vedeu::Menus::Repository]
+
+    Vedeu.menus.all # [Array<Vedeu::Menus::Menu>]
+
+### Vedeu.profile
+
+@todo Add more documentation.
+
+### Vedeu.ready!
+
+@todo Add more documentation.
+
+### Vedeu.ready?
+
+@todo Add more documentation.
+
+### Vedeu.refresh
+
+@todo Add more documentation.
+
+### Vedeu.render
+
+@todo Add more documentation.
+
+### Vedeu.render_output
+
+@todo Add more documentation.
+
+### Vedeu.renderer
+
+@todo Add more documentation.
+
+### Vedeu.renderers
+
+Repository method. Access registered renderers.
+
+    Vedeu.renderers # [Vedeu::Renderers]
+
+### Vedeu.renders
+
+@todo Add more documentation.
+
+### Vedeu.renders
+
+@todo Add more documentation.
+
 ### Vedeu.resize
+
+@todo Add more documentation.
+
+### Vedeu.show_cursor
+
+@todo Add more documentation.
+
+### Vedeu.show_group
+
+@todo Add more documentation.
+
+### Vedeu.show_interface
+
+@todo Add more documentation.
+
 ### Vedeu.timer
+
+@todo Add more documentation.
+
+### Vedeu.toggle_cursor
+
+@todo Add more documentation.
+
+### Vedeu.toggle_group
+
+@todo Add more documentation.
+
+### Vedeu.toggle_interface
+
+@todo Add more documentation.
+
+### Vedeu.trigger
+
+@todo Add more documentation.
+
+### Vedeu.unbind
+
+@todo Add more documentation.
+
+### Vedeu.view
+
+@todo Add more documentation.
+
+### Vedeu.views
+
+@todo Add more documentation.
+
 ### Vedeu.width
+
+@todo Add more documentation.

data/docs/group.md

@@ -11,3 +11,43 @@ Groups.
     multiple groups.
 - They can be visible or invisible, this affects all of the members of
   the group.
+
+## API
+
+### All groups
+
+This repository contains all the registered groups for a client
+application. They can be listed via:
+
+    Vedeu.groups.all
+
+### An individual group
+
+You can access an individual group by name:
+
+    Vedeu.groups.find(:name)
+
+    # or...
+
+    Vedeu.groups.by_name(:name)
+
+### Hiding a group
+
+You can hide a group, and all of its interfaces/views:
+
+    Vedeu.trigger(:_hide_group_, :name)
+
+    # or...
+
+    Vedeu.hide_group(:name)
+
+### Showing a group
+
+You can show a group, and all of its interfaces/views:
+
+    Vedeu.trigger(:_show_group_, :name)
+
+    # or...
+
+    Vedeu.show_group(:name)
+

data/lib/vedeu/borders/caption.rb

@@ -10,10 +10,10 @@ module Vedeu
     #
     class Caption < Title
 
-      # Overwrite the border from {#build_horizontal} on the bottom
-      # border to include the caption if given.
+      # Overwrite the border from
+      # {Vedeu::Borders::Border#build_horizontal} on the bottom border
+      # to include the caption if given.
       #
-      # @param [Array<Vedeu::Views::Char>]
       # @return [Array<Vedeu::Views::Char>]
       def render
         return chars if empty?

data/lib/vedeu/borders/title.rb

@@ -41,10 +41,10 @@ module Vedeu
       end
       alias_method :==, :eql?
 
-      # Overwrite the border from {#build_horizontal} on the top
-      # border to include the title if given.
+      # Overwrite the border from
+      # {Vedeu::Borders::Border#build_horizontal} on the top border to
+      # include the title if given.
       #
-      # @param [Array<Vedeu::Views::Char>]
       # @return [Array<Vedeu::Views::Char>]
       def render
         return chars if empty?

data/lib/vedeu/colours/repository.rb

@@ -10,6 +10,7 @@ module Vedeu
       # @!attribute [r] storage
       # @return [Hash<String => String>]
       attr_reader :storage
+      alias_method :all, :storage
 
       # Returns a new instance of Vedeu::Colours::Repository.
       #

data/lib/vedeu/colours/translator.rb

@@ -185,17 +185,17 @@ module Vedeu
       #
       # @return [String]
       def rgb
-        if Vedeu::Configuration.colour_mode == 16_777_216
-          if registered?(colour)
-            retrieve(colour)
+        if registered?(colour)
+          retrieve(colour)
 
-          else
+        else
+          if Vedeu::Configuration.colour_mode == 16_777_216
             register(colour, format(rgb_prefix, *css_to_rgb))
 
-          end
+          else
+            register(colour, numbered)
 
-        else
-          numbered
+          end
 
         end
       end

data/lib/vedeu/geometries/move.rb

@@ -97,7 +97,7 @@ module Vedeu
 
       # @return [Vedeu::Geometries::Geometry]
       def geometry
-        Vedeu.geometries.by_name(name)
+        @geometry ||= Vedeu.geometries.by_name(name)
       end
 
       # Moves the geometry left by the offset.

data/lib/vedeu/menus/all.rb

@@ -11,5 +11,4 @@ end # Vedeu
 
 require 'vedeu/menus/dsl'
 require 'vedeu/menus/menu'
-require 'vedeu/menus/null'
 require 'vedeu/menus/repository'

data/lib/vedeu/menus/repository.rb

@@ -9,7 +9,7 @@ module Vedeu
       singleton_class.send(:alias_method, :menus, :repository)
 
       real Vedeu::Menus::Menu
-      null Vedeu::Menus::Null
+      null Vedeu::Menus::Menu
 
     end # Repository
 

data/lib/vedeu/version.rb

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

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

@@ -15,38 +15,38 @@ module Vedeu
           width:  width,
         }
       }
-      let(:height) { 10 }
+      let(:height) { 3 }
       let(:_name)  {}
-      let(:width)  { 30 }
+      let(:width)  { 9 }
 
       before do
-        Vedeu.stubs(:height).returns(12)
-        Vedeu.stubs(:width).returns(36)
+        Vedeu.stubs(:height).returns(4)
+        Vedeu.stubs(:width).returns(12)
       end
 
       describe '#initialize' do
         it { instance.must_be_instance_of(described) }
 
         context 'when the height is given' do
-          it { instance.instance_variable_get('@height').must_equal(10) }
+          it { instance.instance_variable_get('@height').must_equal(3) }
         end
 
         context 'when the height not is given' do
           let(:height) {}
 
-          it { instance.instance_variable_get('@height').must_equal(12) }
+          it { instance.instance_variable_get('@height').must_equal(4) }
         end
 
         it { instance.instance_variable_get('@name').must_equal(_name) }
 
         context 'when the width is given' do
-          it { instance.instance_variable_get('@width').must_equal(30) }
+          it { instance.instance_variable_get('@width').must_equal(9) }
         end
 
         context 'when the width not is given' do
           let(:width) {}
 
-          it { instance.instance_variable_get('@width').must_equal(36) }
+          it { instance.instance_variable_get('@width').must_equal(12) }
         end
       end
 
@@ -63,8 +63,8 @@ module Vedeu
         it { subject.first.must_be_instance_of(Array) }
         it { subject.first.first.must_be_instance_of(Vedeu::Models::Cell) }
 
-        it { subject.size.must_equal(10) }
-        it { subject.first.size.must_equal(30) }
+        it { subject.size.must_equal(3) }
+        it { subject.first.size.must_equal(9) }
         it { subject.first.first.position.must_equal(position) }
       end
 

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

@@ -41,6 +41,12 @@ module Vedeu
       end
 
       describe '#refresh' do
+        let(:output) {
+          Vedeu::Buffers::View.new(name: 'Vedeu::Buffers::Terminal')
+        }
+
+        before { Vedeu::Models::Page.stubs(:coerce).returns(output) }
+
         subject { described.refresh }
 
         it {

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

@@ -22,6 +22,15 @@ module Vedeu
         Vedeu::Geometries::Geometry.new(name: _name, x: 2, xn: 8, y: 2, yn: 8)
       }
 
+      before do
+        Vedeu.stubs(:trigger).with(:_movement_refresh_, _name)
+        Vedeu.stubs(:trigger).with(:_cursor_down_, _name)
+        Vedeu.stubs(:trigger).with(:_cursor_left_, _name)
+        Vedeu.stubs(:trigger).with(:_cursor_origin_, _name)
+        Vedeu.stubs(:trigger).with(:_cursor_right_, _name)
+        Vedeu.stubs(:trigger).with(:_cursor_up_, _name)
+      end
+
       describe '#initialize' do
         it { instance.must_be_instance_of(described) }
 
@@ -61,7 +70,6 @@ module Vedeu
       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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vedeu
 version: !ruby/object:Gem::Version
-  version: 0.6.63
+  version: 0.6.64
 platform: ruby
 authors:
 - Gavin Laking
@@ -460,7 +460,6 @@ files:
 - lib/vedeu/menus/all.rb
 - lib/vedeu/menus/dsl.rb
 - lib/vedeu/menus/menu.rb
-- lib/vedeu/menus/null.rb
 - lib/vedeu/menus/repository.rb
 - lib/vedeu/models/all.rb
 - lib/vedeu/models/cell.rb
@@ -641,7 +640,6 @@ files:
 - test/lib/vedeu/logging/timer_test.rb
 - test/lib/vedeu/menus/dsl_test.rb
 - test/lib/vedeu/menus/menu_test.rb
-- test/lib/vedeu/menus/null_test.rb
 - test/lib/vedeu/menus/repository_test.rb
 - test/lib/vedeu/models/cell_test.rb
 - test/lib/vedeu/models/escape_test.rb
@@ -854,7 +852,6 @@ test_files:
 - test/lib/vedeu/logging/timer_test.rb
 - test/lib/vedeu/menus/dsl_test.rb
 - test/lib/vedeu/menus/menu_test.rb
-- test/lib/vedeu/menus/null_test.rb
 - test/lib/vedeu/menus/repository_test.rb
 - test/lib/vedeu/models/cell_test.rb
 - test/lib/vedeu/models/escape_test.rb

data/lib/vedeu/menus/null.rb

@@ -1,25 +0,0 @@
-module Vedeu
-
-  module Menus
-
-    # Provides a non-existent model to swallow messages.
-    #
-    # @api private
-    #
-    class Null < Vedeu::Null::Generic
-
-      # Returns an instance of the Vedeu::Menus::Null class.
-      #
-      # @param attributes [Hash<Symbol => void>]
-      # @option attributes name [String|Symbol|NilClass]
-      # @return [Vedeu::Menus::Null]
-      def initialize(attributes = {})
-        @attributes = attributes
-        @name       = @attributes[:name]
-      end
-
-    end # Null
-
-  end # Menus
-
-end # Vedeu

data/test/lib/vedeu/menus/null_test.rb

@@ -1,30 +0,0 @@
-require 'test_helper'
-
-module Vedeu
-
-  module Menus
-
-    describe Null do
-
-      let(:described)  { Vedeu::Menus::Null }
-      let(:instance)   { described.new(attributes) }
-      let(:_name)      { 'null_menu' }
-      let(:attributes) {
-        {
-          name: _name
-        }
-      }
-
-      describe '#initialize' do
-        it { instance.must_be_instance_of(described) }
-        it {
-          instance.instance_variable_get('@attributes').must_equal(attributes)
-        }
-        it { instance.instance_variable_get('@name').must_equal(_name) }
-      end
-
-    end # Null
-
-  end # Menus
-
-end # Vedeu