vedeu 0.4.16 → 0.4.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a9751fe9473165039b61060cd75848373362b2e
-  data.tar.gz: f26036519a3f79b436bbe48dc6ff56c0be95ee5e
+  metadata.gz: adae57ef3023290f75d36a2744e07ef707297278
+  data.tar.gz: ae4a68bbb7eb2254a774a93bfc41eac41b9e57b2
 SHA512:
-  metadata.gz: a6cf213571c0d78127d30f13d5b7371e6f35ed841e5df29943082c43ecf2be8e6254a0959acfeddf119f1f4807a30540948d420399d727c8e3b365da2628c80c
-  data.tar.gz: 65f8b8ab0fe4bfec7074ac7d1c54294b04a764f9e9303fc2da3c27fec296c6c87897ee402f5d04e3289bd46efdc34de635eb6210ed06e1865516f78ddee3e7dd
+  metadata.gz: 70f4525ba7779abc257a051e2c82952f36ec208a207f511d67c70a1eb7e5d8c0ff741c36fc54c887a7265580bfc042e18de418b537af661af332317980806ce6
+  data.tar.gz: be52af102efe89af2e0b17419ce9bae9b815eb45516a72970f7f4efafe74614f8516912e2602fd2c066bdcdad3af1a823bc47cd8b5d32f0da0ea3f824326cf55

data/lib/vedeu/api.rb

@@ -95,8 +95,7 @@ module Vedeu
     #   @see Vedeu::Event.bind
     # @!method unbind
     #   @see Vedeu::Event.unbind
-    def_delegators Vedeu::Event, :bind,
-                   :unbind
+    def_delegators Vedeu::Event, :bind, :unbind
 
     # @!method trigger
     #   @see Vedeu::Trigger.trigger
@@ -106,8 +105,7 @@ module Vedeu
     #   @see Vedeu::Configuration.configure
     # @!method configuration
     #   @see Vedeu::Configuration.configuration
-    def_delegators Vedeu::Configuration, :configure,
-                   :configuration
+    def_delegators Vedeu::Configuration, :configure, :configuration
 
     # @!method border
     #   @see Vedeu::DSL::Border.border
@@ -125,19 +123,13 @@ module Vedeu
     #   @see Vedeu::DSL::Group.group
     def_delegators Vedeu::DSL::Group, :group
 
-    # @!method use
-    #   @see Vedeu::DSL::Use#use
-    def_delegators Vedeu::DSL::Use, :use
-
     # @!method interface
     #   @see Vedeu::DSL::View.interface
     # @!method renders
     #   @see Vedeu::DSL::View.renders
     # @!method views
     #   @see Vedeu::DSL::View.views
-    def_delegators Vedeu::DSL::View, :interface,
-                   :renders,
-                   :views
+    def_delegators Vedeu::DSL::View, :interface, :renders, :views
 
     # @!method focus
     #   @see Vedeu::Focus#focus
@@ -149,11 +141,8 @@ module Vedeu
     #   @see Vedeu::Focus#focus_next
     # @!method focus_previous
     #   @see Vedeu::Focus#focus_previous
-    def_delegators Vedeu::Focus, :focus,
-                   :focus_by_name,
-                   :focussed?,
-                   :focus_next,
-                   :focus_previous
+    def_delegators Vedeu::Focus, :focus, :focus_by_name, :focussed?,
+                   :focus_next, :focus_previous
 
     # @!method log
     #   @see Vedeu::Log.log
@@ -169,16 +158,13 @@ module Vedeu
     #   @see Vedeu::Terminal#width
     # @!method resize
     #   @see Vedeu::Terminal#resize
-    def_delegators Vedeu::Terminal, :height,
-                   :width,
-                   :resize
+    def_delegators Vedeu::Terminal, :height, :width, :resize
 
     # @!method renderer
     #   @see Vedeu::Renderers#renderer
     # @!method renderers
     #   @see Vedeu::Renderers#renderers
-    def_delegators Vedeu::Renderers, :renderer,
-                   :renderers
+    def_delegators Vedeu::Renderers, :renderer, :renderers
 
   end # API
 

data/lib/vedeu/bindings.rb

@@ -93,16 +93,12 @@ module Vedeu
 
     # Hide the cursor of the named interface or interface currently in focus.
     Vedeu.bind(:_cursor_hide_) do |name|
-      named = name ? Vedeu.cursors.by_name(name) : Vedeu.cursor
-
-      Vedeu::Visibility.hide(named)
+      Vedeu::Visibility.for_cursor(name).hide
     end
 
     # Show the cursor of the named interface or interface currently in focus.
     Vedeu.bind(:_cursor_show_) do |name|
-      named = name ? Vedeu.cursors.by_name(name) : Vedeu.cursor
-
-      Vedeu::Visibility.show(named)
+      Vedeu::Visibility.for_cursor(name).show
     end
 
     # @see {Vedeu::Move}

data/lib/vedeu/buffers/buffer.rb

@@ -43,27 +43,21 @@ module Vedeu
     # @option attributes front [Interface]
     # @option attributes previous [Interface]
     # @option attributes repository [Vedeu::Buffers]
-    # @return [Buffer]
+    # @return [Vedeu::Buffer]
     def initialize(attributes = {})
       @attributes = defaults.merge!(attributes)
 
-      @name       = @attributes[:name]
-      @back       = @attributes[:back]
-      @front      = @attributes[:front]
-      @previous   = @attributes[:previous]
-      @repository = @attributes[:repository] || Vedeu.buffers
+      @attributes.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
     end
 
-    # Add the content to the back buffer, then update the repository. Returns
-    # boolean indicating that the repository was updated. Here we also apply any
-    # overridden colours or styles in the buffered view to the stored interface.
+    # Add the content to the back buffer, then update the repository.
+    # Returns boolean indicating that the repository was updated.
     #
-    # @param content [Interface]
+    # @param content [Vedeu::Interface]
     # @return [Boolean]
     def add(content)
-      content.colour = interface.colour unless content.colour
-      content.style  = interface.style  unless content.style
-
       @back = content
 
       store
@@ -82,24 +76,8 @@ module Vedeu
     #   'previous' buffer.
     # - If the 'previous' buffer is empty, return an empty collection.
     #
-    # @return [Array<Hash>]
+    # @return [Array<Array<Array<Vedeu::Char>>>]
     def render
-      buffer = if content_for?(:back)
-                 swap
-
-                 [front.render]
-
-               elsif content_for?(:front)
-                 [front.render]
-
-               elsif content_for?(:previous)
-                 [previous.render]
-
-               else
-                 []
-
-               end
-
       Vedeu::Output.render(buffer) unless buffer.empty?
 
       buffer
@@ -117,6 +95,22 @@ module Vedeu
 
     private
 
+    # @return [Array<Array<Array<Vedeu::Char>>>]
+    def buffer
+      swap if content_for?(:back)
+
+      if content_for?(:front)
+        [front.render]
+
+      elsif content_for?(:previous)
+        [previous.render]
+
+      else
+        []
+
+      end
+    end
+
     # @return [void]
     def clear_buffer
       @clear_buffer ||= Vedeu::Clear.new(view).clear
@@ -125,10 +119,11 @@ module Vedeu
     # @return [Hash<Symbol => NilClass, String>]
     def defaults
       {
-        back:     nil,
-        front:    nil,
-        name:     '',
-        previous: nil,
+        back:       nil,
+        front:      nil,
+        name:       '',
+        previous:   nil,
+        repository: Vedeu.buffers,
       }
     end
 

data/lib/vedeu/cursor/cursor.rb

@@ -8,8 +8,11 @@ module Vedeu
   #
   class Cursor
 
+    extend Forwardable
     include Vedeu::Model
 
+    def_delegators Vedeu::Esc, :hide_cursor, :show_cursor
+
     # @!attribute [r] attributes
     # @return [Hash]
     attr_reader :attributes
@@ -133,10 +136,10 @@ module Vedeu
     # @return [String]
     def visibility
       if visible?
-        Vedeu::Esc.string('show_cursor')
+        show_cursor
 
       else
-        Vedeu::Esc.string('hide_cursor')
+        hide_cursor
 
       end
     end

data/lib/vedeu/distributed/all.rb

@@ -1,8 +1,8 @@
-require 'vedeu/distributed/uri'
-require 'vedeu/distributed/server'
-require 'vedeu/distributed/client'
-require 'vedeu/distributed/subprocess'
-require 'vedeu/distributed/test_application'
+require_relative 'uri'
+require_relative 'server'
+require_relative 'client'
+require_relative 'subprocess'
+require_relative 'test_application'
 
 module Vedeu
 

data/lib/vedeu/distributed/server.rb

@@ -66,7 +66,7 @@ module Vedeu
 
       # @return [void]
       def restart
-       log('Attempting to restart')
+        log('Attempting to restart')
 
         return not_enabled unless drb?
 

data/lib/vedeu/dsl/components/border.rb

@@ -25,8 +25,7 @@ module Vedeu
     class Border
 
       include Vedeu::DSL
-      include Vedeu::DSL::Colour
-      include Vedeu::DSL::Style
+      include Vedeu::DSL::Presentation
 
       # Specify the border of an interface or view with a simple DSL.
       #

data/lib/vedeu/dsl/components/geometry.rb

@@ -78,53 +78,6 @@ module Vedeu
         model.height = value
       end
 
-      # Use the geometry of another interface as the basis for the geometry you
-      # are creating.
-      #
-      # @example
-      #   geometry 'some_interface' do
-      #     use 'other_interface' # will fetch the geometry of 'other_interface'
-      #     # ...
-      #
-      #   geometry 'other_interface' do
-      #     centred!
-      #     height 4
-      #     # ...
-      #
-      #   geometry 'some_interface' do
-      #     use 'other_interface' # will fetch the geometry of 'other_interface'
-      #     centred false
-      #     # ...
-      #
-      # @note
-      #   - When using 'use', the 'other_interface' (from the example) must
-      #     already exist.
-      #   - When using 'use', note that geometry defined before it's invocation
-      #     will be overwritten by 'other_interface',
-      #   - and geometry defined after will overwrite the inherited geometry.
-      #   - Special geometry settings, like 'centred' also cause unexpected
-      #     behaviour. If 'other_interface' was centred, then 'some_interface'
-      #     will also be centred, to disable this, declare 'some_interface' to
-      #     not be centred.
-      #
-      # @param name [String] The name of the interface you wish to use the
-      #   geometry of.
-      # @raise [ModelNotFound] When the geometry to be used does not exist yet.
-      # @return [Vedeu::Geometry]
-      # def use(name)
-      #   if Vedeu.geometries.registered?(name)
-      #     other = Vedeu.geometries.find(name).dup
-      #     other.name = name
-      #     @model = other
-      #     @model.store
-
-      #   else
-      #     fail ModelNotFound, "Cannot use the geometry of '#{name}', as it " \
-      #                         "is not yet defined."
-
-      #   end
-      # end
-
       # Specify the number of characters/columns wide the interface will be.
       #
       # @param value [Fixnum]

data/lib/vedeu/dsl/interface.rb

@@ -16,8 +16,7 @@ module Vedeu
 
       include Vedeu::Common
       include Vedeu::DSL
-      include Vedeu::DSL::Colour
-      include Vedeu::DSL::Style
+      include Vedeu::DSL::Presentation
       include Vedeu::DSL::Text
       include Vedeu::DSL::Use
 
@@ -152,19 +151,13 @@ module Vedeu
       #
       # @param name [String] The name of the group to which this interface
       #   should belong.
-      # @return [String]
+      # @return [Vedeu::Group]
       def group(name)
         return false unless defined_value?(name)
-        model.group = name
-
-        if Vedeu.groups.registered?(name)
-          Vedeu.groups.find(name).add(model.name)
 
-        else
-          new_group = Vedeu::Group.new(name: name)
-          new_group.add(model.name)
+        model.group = name
 
-        end
+        Vedeu.groups.by_name(name).add(model.name)
       end
 
       # @see Vedeu::DSL::Keymap.keymap

data/lib/vedeu/dsl/line.rb

@@ -38,8 +38,7 @@ module Vedeu
     class Line
 
       include Vedeu::DSL
-      include Vedeu::DSL::Colour
-      include Vedeu::DSL::Style
+      include Vedeu::DSL::Presentation
       include Vedeu::DSL::Text
 
       # Returns an instance of DSL::Line.

data/lib/vedeu/dsl/shared/all.rb

@@ -1,4 +1,3 @@
-require_relative 'colour'
-require_relative 'style'
+require_relative 'presentation'
 require_relative 'text'
 require_relative 'use'

data/lib/vedeu/dsl/shared/{colour.rb → presentation.rb}

@@ -2,12 +2,12 @@ module Vedeu
 
   module DSL
 
-    # Provides colour helpers for use in the {Vedeu::DSL::Interface},
+    # Provides colour and style helpers for use in the {Vedeu::DSL::Interface},
     # {Vedeu::DSL::Line} and {Vedeu::DSL::Stream} classes.
     #
     # @api public
     #
-    module Colour
+    module Presentation
 
       # Define the background colour for an interface, line, or a stream. When
       # called with a block, will create a new stream with the background colour
@@ -41,7 +41,7 @@ module Vedeu
       alias_method :bg,      :background
       alias_method :bgcolor, :background
 
-      # @see Vedeu::DSL::Colour#background
+      # @see Vedeu::DSL::Presentation#background
       def foreground(value = '')
         colour(foreground: value)
       end
@@ -78,7 +78,30 @@ module Vedeu
         model.colour = Vedeu::Colour.coerce(attributes)
       end
 
-    end # Colour
+      # Define a style or styles for an interface, line or a stream.
+      #
+      # @param value [Array<Symbol>|Array<String>|Symbol|String]
+      #
+      # @example
+      #   interface 'my_interface' do
+      #     style 'normal'
+      #     ...
+      #
+      #   lines do
+      #     style ['bold', 'underline']
+      #     ...
+      #
+      #   stream do
+      #     style 'blink'
+      #     ...
+      #
+      # @return [Vedeu::Style]
+      def style(value)
+        model.style = Vedeu::Style.coerce(value)
+      end
+      alias_method :styles, :style
+
+    end # Presentation
 
   end # DSL
 

data/lib/vedeu/dsl/shared/use.rb

@@ -6,41 +6,62 @@ module Vedeu
     #
     module Use
 
-      extend self
-
-      # Use the specified interface; useful for sharing attributes with other
-      # interfaces. Any public method of {Vedeu::Interface} is available.
+      # Duplicate a stored model.
+      #
+      # This DSL method copies the attributes of a stored model, changes the
+      # name to that of the current model, and stores the duplicate as a new
+      # model in model's repository.
       #
       # @example
-      #   Vedeu.interface 'my_interface' do
-      #     # use the delay of another interface
-      #     delay Vedeu.use('my_other_interface').delay
-      #     # ...
+      #   # Here the attributes of 'my_geometry' are used to create the
+      #   # new model 'my_other_geometry'.
+      #   Vedeu.geometry 'my_other_geometry' do
+      #     duplicate('my_geometry')
       #   end
       #
-      #   Vedeu.interface 'my_interface' do
-      #     geometry do
-      #       # use the width of another interface
-      #       width Vedeu.use('my_other_interface').width
-      #       # ...
-      #     end
-      #   end
+      # @note
+      #   - Only models of the same repository can be used in this way.
+      #   - If the stored model cannot be found, the duplicate may not have
+      #     the values you required.
+      #   - Values defined before will be overwritten by the new values from
+      #     the stored model.
+      #   - Values defined after will overwrite the values of the new
+      #     duplicate model.
       #
-      #   Vedeu.use('my_other_interface').width # can be used in your code to
-      #                                         # get this value
-      #
-      # @param value [String] The name of the interface you wish to use.
-      #   Typically used when defining interfaces to share geometry.
-      # @raise [ModelNotFound] The interface has not yet been defined.
-      # @return [Vedeu::Interface]
-      def use(value)
-        if Vedeu.interfaces.registered?(value) == false
-          fail ModelNotFound, "The properties of this interface (#{value}) " \
-                              'cannot be used, since the interface has not ' \
-                              'been defined.'
-        end
+      # @param name [String] The name of the model to duplicate.
+      # @return [void] The new model based on the original.
+      def duplicate(name)
+        duplicated      = model.repository.by_name(name).dup
+        duplicated.name = model.name
+        duplicated.store
+      end
 
-        Vedeu.interfaces.find(value)
+      # Use the attribute of stored model.
+      #
+      # This DSL method provides access to a stored model by name. You can
+      # then request an attribute of that model for use within the current
+      # model.
+      #
+      # @example
+      #   # Here the character used for 'my_border' is used in
+      #   # 'my_other_border'.
+      #   Vedeu.border 'my_other_border' do
+      #     top_right use('my_border').top_right
+      #   end
+      #
+      # @note
+      #   - Only models of the same repository can be used in this way.
+      #   - If the stored model cannot be found, a ModelNotFound exception may
+      #     be raised, or the request for an attribute may raise a
+      #     NoMethodError exception.
+      #
+      # @param name [String] The name of the model with the value you wish to
+      #   use.
+      # @raise [ModelNotFound|NoMethodError] The model or attribute cannot be
+      #   found.
+      # @return [void] The stored model.
+      def use(name)
+        model.repository.by_name(name)
       end
 
     end # Use