vedeu 0.6.58 → 0.6.59

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d33a3d7e8cd6ab472659549aafd770caeadce867
-  data.tar.gz: 7c8de69994fd536b0d42db2d95d09a51610b3eaa
+  metadata.gz: e5813addb77c651976f42073bc53aab1b4af606a
+  data.tar.gz: 3cb787a6bb92c95ef9a883eced3c6452afdccf8b
 SHA512:
-  metadata.gz: eebb2b6fecc5b82b8f936d5f57732729db7ec0698eace850ab92e9d048e5aea66196757d3c1a65d5a932f4ee15dd2feae3ee63d24f4ad68a5168969f69d4d1a9
-  data.tar.gz: 3e11185cf8ae5e7862f4f072ddad207cffc17197b086aae08d403afb02eaa281bf8ca92a5df6c3abc61e0144d7e942780831431e0a0e07ec4c2b085ade3e5863
+  metadata.gz: b55242a13ddc309b76455ccb9938abf0f2c517f448b82a43f885cede2e82616c2b6c9419f80f48b7283f4fcda220cc3d5eb1b31b74e719ebb751d1d9f7ed4849
+  data.tar.gz: e8005cd4ff555b0a51cfbbba53401cf2040291382c6b87f7687c1553c97a9c24f6eb6f308c2d4df106c5e2a5b728b7c36e93599bdc61eb3cded59be34e77dfc2

data/lib/vedeu/buffers/empty.rb

@@ -8,29 +8,12 @@ module Vedeu
     # @api private
     class Empty
 
+      include Vedeu::Repositories::Defaults
+
       # @!attribute [r] name
       # @return [NilClass|String|Symbol]
       attr_reader :name
 
-      # Returns a new instance of Vedeu::Buffers::Empty.
-      #
-      # @note
-      #   If a particular key is missing from the attributes
-      #   parameter, then it is added with the respective value from
-      #   #defaults.
-      #
-      # @param attributes [Hash<Symbol => Fixnum, NilClass, String,
-      #   Symbol]
-      # @option attributes name [NilClass|String|Symbol]
-      # @option attributes height [Fixnum]
-      # @option attributes width [Fixnum]
-      # @return [Vedeu::Buffers::Empty]
-      def initialize(attributes = {})
-        defaults.merge!(attributes).each do |key, value|
-          instance_variable_set("@#{key}", value || defaults.fetch(key))
-        end
-      end
-
       # @return [Array<Array<Vedeu::Models::Cell>>]
       def buffer
         Array.new(width) do |y|
@@ -62,7 +45,7 @@ module Vedeu
 
       # Returns the default options/attributes for this class.
       #
-      # @return [Hash<Symbol => void>]
+      # @return [Hash<Symbol => Fixnum|NilClass|String|Symbol>]
       def defaults
         {
           height: Vedeu.height,

data/lib/vedeu/buffers/view.rb

@@ -8,16 +8,7 @@ module Vedeu
     #
     class View
 
-      # Returns a new instance of Vedeu::Buffers::View.
-      #
-      # @param attributes [Hash<Symbol => NilClass|String|Symbol]
-      # @option attributes name [NilClass|String|Symbol]
-      # @return [Vedeu::Buffers::View]
-      def initialize(attributes = {})
-        defaults.merge!(attributes).each do |key, value|
-          instance_variable_set("@#{key}", value || defaults.fetch(key))
-        end
-      end
+      include Vedeu::Repositories::Defaults
 
       private
 

data/lib/vedeu/editor/document.rb

@@ -8,6 +8,7 @@ module Vedeu
     #
     class Document
 
+      include Vedeu::Repositories::Defaults
       include Vedeu::Repositories::Model
       extend Forwardable
 
@@ -18,7 +19,8 @@ module Vedeu
                      :y
 
       # @!attribute [r] attributes
-      # @return [Hash]
+      # @return [Hash<Symbol => String|Symbol|
+      #   Vedeu::Repositories::Repository>]
       attr_reader :attributes
 
       # @!attribute [rw] data
@@ -37,26 +39,6 @@ module Vedeu
         new(attributes).store
       end
 
-      # Returns a new instance of Vedeu::Editor::Document.
-      #
-      # @note
-      #   If a particular key is missing from the attributes
-      #   parameter, then it is added with the respective value from
-      #   #defaults.
-      #
-      # @param attributes [Hash<Symbol => String|Symbol|
-      #   Vedeu::Repositories::Repository>]
-      # @option attributes data [String]
-      # @option attributes name [String|Symbol]
-      # @option attributes repository
-      #   [Vedeu::Repositories::Repository]
-      # @return [Vedeu::Editor::Document]
-      def initialize(attributes = {})
-        defaults.merge!(attributes).each do |key, value|
-          instance_variable_set("@#{key}", value || defaults.fetch(key))
-        end
-      end
-
       # Returns the document as a string with line breaks if there is
       # more than one line.
       #

data/lib/vedeu/geometry/all.rb

@@ -27,6 +27,5 @@ 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/move.rb

@@ -18,6 +18,7 @@ module Vedeu
     #
     class Move
 
+      include Vedeu::Repositories::Defaults
       extend Forwardable
 
       def_delegators :geometry,
@@ -32,23 +33,6 @@ module Vedeu
         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?
@@ -62,15 +46,16 @@ module Vedeu
       protected
 
       # @!attribute [r] direction
-      # @return [Symbol]
+      # @return [Symbol] The direction to move; one of: :down, :left,
+      #   :origin, :right, :up.
       attr_reader :direction
 
       # @!attribute [r] name
-      # @return [String|Symbol]
+      # @return [String|Symbol] The name of the interface/view.
       attr_reader :name
 
       # @!attribute [r] offset
-      # @return [Symbol]
+      # @return [Symbol] The number of columns or rows to move by.
       attr_reader :offset
 
       private

data/lib/vedeu/geometry/repository.rb

@@ -9,7 +9,7 @@ module Vedeu
 
       singleton_class.send(:alias_method, :geometries, :repository)
 
-      null Vedeu::Geometry::Null
+      null Vedeu::Geometry::Geometry, height: Vedeu.height, width: Vedeu.width
       real Vedeu::Geometry::Geometry
 
     end # Repository

data/lib/vedeu/models/cell.rb

@@ -8,6 +8,8 @@ module Vedeu
     #
     class Cell
 
+      include Vedeu::Repositories::Defaults
+
       # @!attribute [r] colour
       # @return [NilClass|String]
       attr_reader :colour
@@ -24,27 +26,6 @@ module Vedeu
       # @return [NilClass|String]
       attr_reader :value
 
-      # Returns a new instance of Vedeu::Models::Cell.
-      #
-      # @note
-      #   If a particular key is missing from the attributes
-      #   parameter, then it is added with the respective value from
-      #   #defaults.
-      #
-      # @param attributes [Hash<Symbol => Array<Symbol|String>,
-      #                                   Fixnum, String, Symbol]
-      # @option attributes colour [NilClass|String]
-      # @option attributes style
-      #   [NilClass|Array<Symbol|String>|Symbol|String]
-      # @option attributes value [NilClass|String]
-      # @option attributes position [Vedeu::Geometry::Position]
-      # @return [Vedeu::Models::Cell]
-      def initialize(attributes = {})
-        defaults.merge!(attributes).each do |key, value|
-          instance_variable_set("@#{key}", value || defaults.fetch(key))
-        end
-      end
-
       # @return [Boolean]
       def cell?
         true

data/lib/vedeu/repositories/all.rb

@@ -9,6 +9,7 @@ module Vedeu
 end # Vedeu
 
 require 'vedeu/repositories/collection'
+require 'vedeu/repositories/defaults'
 require 'vedeu/repositories/repositories'
 require 'vedeu/repositories/model'
 require 'vedeu/repositories/store'

data/lib/vedeu/repositories/defaults.rb

@@ -0,0 +1,33 @@
+module Vedeu
+
+  module Repositories
+
+    # Some classes expect a certain set of attributes when
+    # initialized, this module uses the #defaults method of the class
+    # to provide missing attribute keys (and values).
+    #
+    # @api private
+    #
+    module Defaults
+
+      # Returns a new instance of the class including this module.
+      #
+      # @note
+      #   If a particular key is missing from the attributes
+      #   parameter, then it is added with the respective value from
+      #   #defaults.
+      #
+      # @param attributes [Hash]
+      # @return [void] A new instance of the class including this
+      #   module.
+      def initialize(attributes = {})
+        defaults.merge!(attributes).each do |key, value|
+          instance_variable_set("@#{key}", value || defaults.fetch(key))
+        end
+      end
+
+    end # Defaults
+
+  end # Repositories
+
+end # Vedeu

data/lib/vedeu/repositories/registerable.rb

@@ -13,9 +13,11 @@ module Vedeu
         # The null model is used when the repository cannot be found.
         #
         # @param klass [Class]
+        # @param attributes [Hash]
         # @return [Symbol]
-        def null(klass)
-          define_method(:null_model) { klass }
+        def null(klass, attributes = {})
+          define_method(:null_model)      { klass }
+          define_method(:null_attributes) { attributes }
         end
 
         # The real model is the usual model to use for a given

data/lib/vedeu/repositories/repository.rb

@@ -65,7 +65,17 @@ module Vedeu
       def by_name(name = Vedeu.focus)
         return find(name) if present?(name) && registered?(name)
 
-        null_model.new(name: name)
+        attrs = if null_attributes.any?
+                  null_attributes.merge!(name: name)
+
+                else
+                  {
+                    name: name
+                  }
+
+                end
+
+        null_model.new(attrs)
       end
 
       # Return the model for the interface currently in focus.

data/lib/vedeu/version.rb

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

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

@@ -0,0 +1,15 @@
+require 'test_helper'
+
+module Vedeu
+
+  module Repositories
+
+    describe Defaults do
+
+      # @todo Add more tests.
+
+    end # Defaults
+
+  end # Repositories
+
+end # Vedeu

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

@@ -26,7 +26,9 @@ module Vedeu
         it { RegisterableTestClass.must_respond_to(:null) }
 
         it { subject.must_respond_to(:null_model) }
+        it { subject.must_respond_to(:null_attributes) }
         it { subject.null_model.must_equal(Vedeu::Repositories::ModelTestClass) }
+        it { subject.null_attributes.must_equal({}) }
       end
 
       describe '.real' do

data/test/support/examples/material_colours_app.rb

@@ -27,6 +27,28 @@ class VedeuMaterialColoursApp
     # width  20
   end
 
+  # Borders can be defined as standalone declarations.
+  Vedeu.border 'no_bottom' do
+    background  '#000000'
+    foreground  '#ffffff'
+    show_bottom false
+  end
+  Vedeu.border 'no_left' do
+    background  '#000000'
+    foreground  '#ffffff'
+    show_left false
+  end
+  Vedeu.border 'no_right' do
+    background  '#000000'
+    foreground  '#ffffff'
+    show_right false
+  end
+  Vedeu.border 'no_top' do
+    background  '#000000'
+    foreground  '#ffffff'
+    show_top false
+  end
+
   Vedeu.interface 'main_interface' do
     border 'main_interface' do
       colour foreground: '#ffffff', background: :default
@@ -98,7 +120,7 @@ class VedeuMaterialColoursApp
       height 4
       width  10
     end
-    colour  foreground: '#000000', background: '#9c27b0'
+    colour  foreground: '#ffffff', background: '#9c27b0'
   end
 
   Vedeu.interface 'no_bottom' do
@@ -108,7 +130,7 @@ class VedeuMaterialColoursApp
       height 4
       width  10
     end
-    colour  foreground: '#000000', background: '#673ab7'
+    colour  foreground: '#ffffff', background: '#673ab7'
   end
 
   Vedeu.interface 'no_left' do
@@ -118,7 +140,7 @@ class VedeuMaterialColoursApp
       height 4
       width  10
     end
-    colour  foreground: '#000000', background: '#3f51b5'
+    colour  foreground: '#ffffff', background: '#3f51b5'
   end
 
   Vedeu.interface 'no_right' do
@@ -128,7 +150,7 @@ class VedeuMaterialColoursApp
       height 4
       width  10
     end
-    colour  foreground: '#000000', background: '#2196f3'
+    colour  foreground: '#ffffff', background: '#2196f3'
   end
 
   Vedeu.interface 'custom_corners' do
@@ -138,7 +160,7 @@ class VedeuMaterialColoursApp
       height 4
       width  10
     end
-    colour  foreground: '#000000', background: '#03a9f4'
+    colour  foreground: '#ffffff', background: '#03a9f4'
   end
 
   Vedeu.interface 'custom_sides' do
@@ -153,6 +175,7 @@ class VedeuMaterialColoursApp
 
   # Borders can be defined as part of the interface definition.
   Vedeu.interface 'only_top' do
+    colour  foreground: '#ffffff', background: '#009688'
     border do
       foreground  '#ffffff'
       show_right  false
@@ -165,10 +188,10 @@ class VedeuMaterialColoursApp
       height 4
       width  10
     end
-    colour  foreground: '#ffffff', background: '#009688'
   end
 
   Vedeu.interface 'only_bottom' do
+    colour  foreground: '#000000', background: '#8bc34a'
     border do
       foreground  '#000000'
       show_top   false
@@ -181,10 +204,10 @@ class VedeuMaterialColoursApp
       height 4
       width  10
     end
-    colour  foreground: '#000000', background: '#8bc34a'
   end
 
   Vedeu.interface 'only_left' do
+    colour  foreground: '#000000', background: '#cddc39'
     border do
       foreground  '#000000'
       show_top    false
@@ -197,10 +220,10 @@ class VedeuMaterialColoursApp
       height 4
       width  10
     end
-    colour  foreground: '#000000', background: '#cddc39'
   end
 
   Vedeu.interface 'only_right' do
+    colour  foreground: '#000000', background: '#ffeb3b'
     border do
       foreground  '#000000'
       show_top    false
@@ -213,7 +236,6 @@ class VedeuMaterialColoursApp
       height 4
       width  10
     end
-    colour  foreground: '#000000', background: '#ffeb3b'
   end
 
   Vedeu.interface 'custom_colour' do
@@ -248,23 +270,7 @@ class VedeuMaterialColoursApp
     zindex(0)
   end
 
-  # Borders can be defined as standalone declarations.
-  Vedeu.border 'no_bottom' do
-    foreground  '#ffffff'
-    show_bottom false
-  end
-  Vedeu.border 'no_left' do
-    foreground  '#ffffff'
-    show_left false
-  end
-  Vedeu.border 'no_right' do
-    foreground  '#ffffff'
-    show_right false
-  end
-  Vedeu.border 'no_top' do
-    foreground  '#ffffff'
-    show_top false
-  end
+
 
   Vedeu.keymap('_global_') do
     key(:up)    { Vedeu.trigger(:_cursor_up_)    }
@@ -509,7 +515,7 @@ class VedeuMaterialColoursApp
     end
     view('custom_corners') do
       border do
-        foreground   '#ffffff'
+        foreground   '#000000'
         top_right    'B'
         top_left     'A'
         bottom_right 'D'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vedeu
 version: !ruby/object:Gem::Version
-  version: 0.6.58
+  version: 0.6.59
 platform: ruby
 authors:
 - Gavin Laking
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-16 00:00:00.000000000 Z
+date: 2015-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
@@ -421,7 +421,6 @@ files:
 - 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
 - lib/vedeu/geometry/validator.rb
@@ -504,6 +503,7 @@ files:
 - lib/vedeu/plugins/plugins.rb
 - lib/vedeu/repositories/all.rb
 - lib/vedeu/repositories/collection.rb
+- lib/vedeu/repositories/defaults.rb
 - lib/vedeu/repositories/model.rb
 - lib/vedeu/repositories/registerable.rb
 - lib/vedeu/repositories/repositories.rb
@@ -607,7 +607,6 @@ files:
 - 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
 - test/lib/vedeu/geometry/validator_test.rb
@@ -677,6 +676,7 @@ files:
 - test/lib/vedeu/plugins/plugin_test.rb
 - test/lib/vedeu/plugins/plugins_test.rb
 - test/lib/vedeu/repositories/collection_test.rb
+- test/lib/vedeu/repositories/defaults_test.rb
 - test/lib/vedeu/repositories/model_test.rb
 - test/lib/vedeu/repositories/registerable_test.rb
 - test/lib/vedeu/repositories/repositories_test.rb
@@ -820,7 +820,6 @@ test_files:
 - 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
 - test/lib/vedeu/geometry/validator_test.rb
@@ -890,6 +889,7 @@ test_files:
 - test/lib/vedeu/plugins/plugin_test.rb
 - test/lib/vedeu/plugins/plugins_test.rb
 - test/lib/vedeu/repositories/collection_test.rb
+- test/lib/vedeu/repositories/defaults_test.rb
 - test/lib/vedeu/repositories/model_test.rb
 - test/lib/vedeu/repositories/registerable_test.rb
 - test/lib/vedeu/repositories/repositories_test.rb

data/lib/vedeu/geometry/null.rb

@@ -1,66 +0,0 @@
-module Vedeu
-
-  module Geometry
-
-    # Provides a non-existent model to swallow messages.
-    #
-    # @api private
-    #
-    class Null < Vedeu::Null::Generic
-
-      extend Forwardable
-
-      def_delegators :area,
-                     :bordered_height,
-                     :bordered_width,
-                     :bottom,
-                     :bx,
-                     :bxn,
-                     :by,
-                     :byn,
-                     :east,
-                     :height,
-                     :left,
-                     :north,
-                     :right,
-                     :south,
-                     :top,
-                     :west,
-                     :width,
-                     :x,
-                     :xn,
-                     :y,
-                     :yn
-
-      # @!attribute [rw] maximised
-      # @return [Boolean]
-      attr_accessor :maximised
-
-      # @!attribute [r] name
-      # @return [NilClass|String|Symbol]
-      attr_reader :name
-
-      # Returns a new instance of Vedeu::Geometry::Null.
-      #
-      # @param attributes [Hash<Symbol => void>]
-      # @option attributes name [String|Symbol|NilClass]
-      # @return [Vedeu::Geometry::Null]
-      def initialize(attributes = {})
-        @attributes = attributes
-        @name       = @attributes[:name]
-        @maximised  = @attributes.fetch(:maximised, false)
-      end
-
-      private
-
-      # @return [Vedeu::Geometry::Area]
-      def area
-        @area ||= Vedeu::Geometry::Area.from_attributes(y_default: Vedeu.height,
-                                                        x_default: Vedeu.width)
-      end
-
-    end # Null
-
-  end # Geometry
-
-end # Vedeu

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

@@ -1,72 +0,0 @@
-require 'test_helper'
-
-module Vedeu
-
-  module Geometry
-
-    describe Null do
-
-      let(:described) { Vedeu::Geometry::Null }
-      let(:instance)  { described.new(attributes) }
-      let(:attributes){
-        {
-          name: _name
-        }
-      }
-      let(:_name)     { 'null_geometry' }
-
-      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
-
-      describe 'accessors' do
-        it { instance.must_respond_to(:maximised) }
-        it { instance.must_respond_to(:maximised=) }
-        it { instance.must_respond_to(:name) }
-      end
-
-      describe '#height' do
-        before { Vedeu::Terminal.stubs(:size).returns([25, 40]) }
-
-        it { instance.height.must_equal(25) }
-      end
-
-      describe '#width' do
-        before { Vedeu::Terminal.stubs(:size).returns([25, 40]) }
-
-        it { instance.width.must_equal(40) }
-      end
-
-      describe '#x' do
-        before { Vedeu::Terminal.stubs(:size).returns([25, 40]) }
-
-        it { instance.x.must_equal(1) }
-      end
-
-      describe '#xn' do
-        before { Vedeu::Terminal.stubs(:size).returns([25, 40]) }
-
-        it { instance.xn.must_equal(40) }
-      end
-
-      describe '#y' do
-        before { Vedeu::Terminal.stubs(:size).returns([25, 40]) }
-
-        it { instance.y.must_equal(1) }
-      end
-
-      describe '#yn' do
-        before { Vedeu::Terminal.stubs(:size).returns([25, 40]) }
-
-        it { instance.yn.must_equal(25) }
-      end
-
-    end # Null
-
-  end # Geometry
-
-end # Vedeu