vedeu 0.4.13 → 0.4.14

data/lib/vedeu/debug.rb

@@ -45,7 +45,8 @@ module Vedeu
       # - Creates a call graph report in HTML (separate files per thread)
       # RubyProf::GraphHtmlPrinter
 
-      # - Creates a call graph report in GraphViz's DOT format which can be converted to an image
+      # - Creates a call graph report in GraphViz's DOT format which can be
+      #   converted to an image
       # RubyProf::DotPrinter
 
       # - Creates a call tree report compatible with KCachegrind.

data/lib/vedeu/distributed/client.rb

@@ -1,5 +1,3 @@
-require 'drb'
-
 module Vedeu
 
   module Distributed
@@ -39,7 +37,6 @@ module Vedeu
         puts 'Could not connect to DRb server, URI may be bad.'
 
         :drb_bad_uri
-
       end
 
       # Send input to the DRb server.
@@ -51,7 +48,6 @@ module Vedeu
 
       rescue DRb::DRbConnError
         drb_connection_error
-
       end
       alias_method :read, :input
 
@@ -63,7 +59,6 @@ module Vedeu
 
       rescue DRb::DRbConnError
         drb_connection_error
-
       end
       alias_method :write, :output
 
@@ -77,7 +72,7 @@ module Vedeu
       def shutdown
         server.shutdown
 
-        Process.kill("KILL", server.pid)
+        Process.kill('KILL', server.pid)
 
       rescue DRb::DRbConnError
         drb_connection_error
@@ -87,7 +82,6 @@ module Vedeu
 
       ensure
         :shutdown
-
       end
 
       private

data/lib/vedeu/distributed/server.rb

@@ -1,6 +1,3 @@
-require 'drb'
-require 'singleton'
-
 module Vedeu
 
   module Distributed
@@ -156,7 +153,6 @@ module Vedeu
         end
       rescue NoMethodError # raised when #join is called on NilClass.
         # ...
-
       end
 
       private

data/lib/vedeu/distributed/subprocess.rb

@@ -82,7 +82,7 @@ module Vedeu
 
     # @return [File]
     def file_open
-      @file ||= File.new("/tmp/foo_#{timestamp}", "w", 0755)
+      @file ||= File.new("/tmp/foo_#{timestamp}", 'w', 0755)
     end
     alias_method :file, :file_open
 

data/lib/vedeu/distributed/templates/default_configuration.vedeu

@@ -1,5 +1,5 @@
 Vedeu.configure do
-  colour_mode 16_777_216
+  colour_mode 256
   log         '/tmp/vedeu_test_helper.log'
   debug!
   drb!

data/lib/vedeu/distributed/test_application.rb

@@ -68,22 +68,20 @@ module Vedeu
     def initialize(attributes = {})
       @attributes = defaults.merge!(attributes)
 
-      @attributes.each do |k, v|
-        instance_variable_set("@#{k.to_s}", @attributes[k])
-      end
+      @attributes.each { |k, _| instance_variable_set("@#{k}", @attributes[k]) }
     end
 
     # @param block [Proc]
     # @return [String]
     def build(&block)
-      self.instance_eval(&block) if block_given?
+      instance_eval(&block) if block_given?
 
       Vedeu::Template.parse(self, template)
     end
 
     # @return [String]
     def lib_dir
-      File.dirname(__FILE__) + "/../../../lib"
+      File.dirname(__FILE__) + '/../../../lib'
     end
 
     private

data/lib/vedeu/distributed/uri.rb

@@ -20,9 +20,9 @@ module Vedeu
       # @param host [String] Hostname or IP address.
       # @param port [Fixnum|String]
       # @return [Uri]
-      def initialize(host = 'localhost', port = 21420)
+      def initialize(host = 'localhost', port = 21_420)
         @host = host || 'localhost'
-        @port = port || 21420
+        @port = port || 21_420
       end
 
       # @example

data/lib/vedeu/dsl/all.rb

@@ -1,12 +1,12 @@
 require 'vedeu/dsl/components/all'
 require 'vedeu/dsl/shared/all'
 
-require 'vedeu/dsl/composition'
-require 'vedeu/dsl/group'
-require 'vedeu/dsl/interface'
-require 'vedeu/dsl/line'
-require 'vedeu/dsl/stream'
-require 'vedeu/dsl/view'
+require_relative 'composition'
+require_relative 'group'
+require_relative 'interface'
+require_relative 'line'
+require_relative 'stream'
+require_relative 'view'
 
 module Vedeu
 

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

@@ -2,6 +2,3 @@ require_relative 'border'
 require_relative 'geometry'
 require_relative 'keymap'
 require_relative 'menu'
-
-module Vedeu
-end # Vedeu

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

@@ -117,11 +117,13 @@ module Vedeu
       #         # ... or
       #         show_bottom!
       #
-      # @param boolean [Boolean] All values evaluate as true except nil and
+      # @param value [Boolean] All values evaluate as true except nil and
       #   false.
       # @return [Boolean]
-      def bottom(boolean)
-        model.show_bottom = !!boolean
+      def bottom(value)
+        boolean = value ? true : false
+
+        model.show_bottom = boolean
       end
       alias_method :show_bottom, :bottom
 
@@ -147,11 +149,13 @@ module Vedeu
       #         # ... or
       #         show_left!
       #
-      # @param boolean [Boolean] All values evaluate as true except nil and
+      # @param value [Boolean] All values evaluate as true except nil and
       #   false.
       # @return [Boolean]
-      def left(boolean)
-        model.show_left = !!boolean
+      def left(value)
+        boolean = value ? true : false
+
+        model.show_left = boolean
       end
       alias_method :show_left, :left
 
@@ -177,11 +181,13 @@ module Vedeu
       #         # ... or
       #         show_right!
       #
-      # @param boolean [Boolean] All values evaluate as true except nil and
+      # @param value [Boolean] All values evaluate as true except nil and
       #   false.
       # @return [Boolean]
-      def right(boolean)
-        model.show_right = !!boolean
+      def right(value)
+        boolean = value ? true : false
+
+        model.show_right = boolean
       end
       alias_method :show_right, :right
 
@@ -225,11 +231,13 @@ module Vedeu
       #         # ... or
       #         show_top!
       #
-      # @param boolean [Boolean] All values evaluate as true except nil and
+      # @param value [Boolean] All values evaluate as true except nil and
       #   false.
       # @return [Boolean]
-      def top(boolean)
-        model.show_top = !!boolean
+      def top(value)
+        boolean = value ? true : false
+
+        model.show_top = boolean
       end
       alias_method :show_top, :top
 

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

@@ -56,7 +56,9 @@ module Vedeu
       #
       # @return [Boolean]
       def centred(value = true)
-        model.centred = !!value
+        boolean = value ? true : false
+
+        model.centred = boolean
       end
       alias_method :centred!, :centred
 
@@ -76,6 +78,53 @@ 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]
@@ -122,12 +171,20 @@ module Vedeu
       #     xn 37 # end at column 37.
       #     # ...
       #
+      #   geometry 'some_interface' do
+      #     xn  { use('other_interface').right } # if `other_interface` changes
+      #     # ...                                # position, `some_interface`
+      #                                          # will too.
+      #
       # @note
       #   This value will override `width`.
       #
       # @param value [Fixnum]
+      # @param block [Proc]
       # @return [Fixnum]
-      def xn(value)
+      def xn(value = 1, &block)
+        return model.xn = block if block_given?
+
         model.xn = value
       end
 
@@ -160,12 +217,20 @@ module Vedeu
       #     yn 24 # end at row 24.
       #     # ...
       #
+      #   geometry 'some_interface' do
+      #     yn { use('other_interface').bottom } # if `other_interface` changes
+      #     # ...                                # position, `some_interface`
+      #                                          # will too.
+      #
       # @note
       #   This value will override `height`.
       #
       # @param value [Fixnum]
+      # @param block [Proc]
       # @return [Fixnum]
-      def yn(value)
+      def yn(value = 1, &block)
+        return model.yn = block if block_given?
+
         model.yn = value
       end
 

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

@@ -1,4 +1,3 @@
-require 'vedeu/exceptions'
 require 'vedeu/support/common'
 require 'vedeu/input/key'
 
@@ -51,7 +50,7 @@ module Vedeu
       # @todo Try to remember why we need to pre-create the keymap in the
       #   repository.
       def self.keymap(name, &block)
-        Vedeu::Keymap.new({ name: name }).store
+        Vedeu::Keymap.new(name: name).store
 
         Vedeu::Keymap.build({ name: name }, &block).store
       end

data/lib/vedeu/dsl/composition.rb

@@ -69,7 +69,7 @@ module Vedeu
         content = Vedeu::Template.parse(object, filename)
         lines   = Vedeu::Wordwrap.for(content, options)
 
-        new_model = model.member.build(new_attributes(name).merge!({ lines: lines }))
+        new_model = model.member.build(template_attributes(name, lines))
 
         model.add(new_model)
       end
@@ -84,6 +84,13 @@ module Vedeu
       # @return [Composition]
       attr_reader :model
 
+      # @param name [String]
+      # @param lines [Vedeu::Lines]
+      # @return [Hash]
+      def template_attributes(name, lines)
+        new_attributes(name).merge!(lines: lines)
+      end
+
       # @param name [String] The name of the interface.
       # @return [Hash]
       def new_attributes(name)

data/lib/vedeu/dsl/interface.rb

@@ -33,14 +33,19 @@ module Vedeu
 
       # Allows the setting of a border for the interface.
       #
+      # @param name [String] The name of the interface; this is already provided
+      #   when we define the interface or view, setting it here is just
+      #   mirroring functionality of {Vedeu::DSL::Border.border}.
       # @param block [Proc]
       # @raise [InvalidSyntax] The required block was not given.
       # @return [Vedeu::Border]
-      def border(&block)
+      def border(name = nil, &block)
         fail InvalidSyntax, 'block not given' unless block_given?
 
-        border_attrs = attributes.merge!({ enabled: true,
-                                           name:    model.name })
+        model_name = name ? name : model.name
+
+        border_attrs = attributes.merge!(enabled: true,
+                                         name:    model_name)
 
         Vedeu::Border.build(border_attrs, &block).store
       end
@@ -67,8 +72,7 @@ module Vedeu
       #     # ...
       #
       #     cursor false # => hide the cursor for this interface
-      #     cursor :hide # => both of these are equivalent to line above
-      #     cursor nil   #
+      #     cursor nil   # => as above
       #     # ...
       #
       #   view 'my_interface' do
@@ -77,7 +81,9 @@ module Vedeu
       #
       # @return [Cursor]
       def cursor(value = true)
-        Vedeu::Cursor.new({ name: model.name, state: value }).store
+        boolean = value ? true : false
+
+        Vedeu::Cursor.new(name: model.name, visible: boolean).store
       end
 
       # Set the cursor to visible for the interface.
@@ -115,20 +121,24 @@ module Vedeu
 
       # Define the geometry for an interface.
       #
-      # @param block [Proc]
-      #
       # @example
       #   interface 'my_interface' do
       #     geometry do
       #       # ...
       #
+      # @param name [String] The name of the interface; this is already provided
+      #   when we define the interface or view, setting it here is just
+      #   mirroring functionality of {Vedeu::DSL::Geometry.geometry}.
+      # @param block [Proc]
       # @raise [InvalidSyntax] The required block was not given.
       # @return [Geometry]
       # @see Vedeu::DSL::Geometry
-      def geometry(&block)
+      def geometry(name = nil, &block)
         fail InvalidSyntax, 'block not given' unless block_given?
 
-        Vedeu::Geometry.build({ name: model.name }, &block).store
+        model_name = name ? name : model.name
+
+        Vedeu::Geometry.build({ name: model_name }, &block).store
       end
 
       # Specify a group for an interface. Interfaces of the same group can be
@@ -151,7 +161,7 @@ module Vedeu
           Vedeu.groups.find(name).add(model.name)
 
         else
-          new_group = Vedeu::Group.new({ name: name })
+          new_group = Vedeu::Group.new(name: name)
           new_group.add(model.name)
 
         end
@@ -204,6 +214,46 @@ module Vedeu
         model.name = value
       end
 
+      # Set the interface to visible.
+      #
+      # @return [void]
+      def show!
+        visible(true)
+      end
+
+      # Set the interface to invisible.
+      #
+      # @return [void]
+      def hide!
+        visible(false)
+      end
+
+      # Set the visibility of the interface.
+      #
+      # @param value [Boolean] Any value other than nil or false will evaluate
+      #   to true.
+      #
+      # @example
+      #   interface 'my_interface' do
+      #     visible true  # => show the interface
+      #     show!         # => as above
+      #     # ...
+      #
+      #     visible false # => hide the interface
+      #     hide!         # => as above
+      #     # ...
+      #
+      #   view 'my_interface' do
+      #     visible false
+      #     # ...
+      #
+      # @return [void]
+      def visible(value = true)
+        boolean = value ? true : false
+
+        model.visible = boolean
+      end
+
       private
 
       # @!attribute [r] client

data/lib/vedeu/dsl/line.rb

@@ -67,21 +67,21 @@ module Vedeu
       # @return [Vedeu::Lines]
       def line(value = '', &block)
         content = if block_given?
-          Vedeu::Line.build({ client: client,
-                              parent: model.parent }, &block)
+                    Vedeu::Line.build({ client: client,
+                                        parent: model.parent }, &block)
 
-        elsif value
-          stream = Vedeu::Stream.build({ client: client,
-                                         parent: model,
-                                         value: value })
-          Vedeu::Line.build({ client:  client,
-                              parent:  model.parent,
-                              streams: [stream] })
+                  elsif value
+                    stream = Vedeu::Stream.build(client: client,
+                                                 parent: model,
+                                                 value: value)
+                    Vedeu::Line.build(client:  client,
+                                      parent:  model.parent,
+                                      streams: [stream])
 
-        else
-          fail InvalidSyntax, 'block not given'
+                  else
+                    fail InvalidSyntax, 'block not given'
 
-        end
+                  end
 
         model.parent.add(content)
       end

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

@@ -1,7 +1,4 @@
-require 'vedeu/dsl/shared/text'
-require 'vedeu/dsl/shared/colour'
-require 'vedeu/dsl/shared/style'
-require 'vedeu/dsl/shared/use'
-
-module Vedeu
-end # Vedeu
+require_relative 'colour'
+require_relative 'style'
+require_relative 'text'
+require_relative 'use'

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

@@ -36,14 +36,14 @@ module Vedeu
       #
       # @return [String]
       def background(value = '')
-        colour({ background: value })
+        colour(background: value)
       end
       alias_method :bg,      :background
       alias_method :bgcolor, :background
 
       # @see Vedeu::DSL::Colour#background
       def foreground(value = '')
-        colour({ foreground: value })
+        colour(foreground: value)
       end
       alias_method :fg,      :foreground
       alias_method :fgcolor, :foreground

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

@@ -55,24 +55,9 @@ module Vedeu
       #   than the specified width.
       # @return [String]
       def text(value = '', options = {})
-        output = Vedeu::Text.with(value, options.merge!({ anchor: __callee__ }))
+        options.merge!(anchor: __callee__, model: model)
 
-        content = if model.is_a?(Vedeu::Interface)
-          stream = stream_builder({ value: output })
-          Vedeu::Line.build({ streams: [stream], parent: model })
-
-        elsif model.is_a?(Vedeu::Line)
-          stream_builder({ value: output })
-
-        elsif model.is_a?(Vedeu::Stream)
-          stream_builder({ value: output, parent: model.parent })
-
-        else
-          # should never get here
-
-        end
-
-        model.add(content)
+        Vedeu::Text.add(value, options)
       end
       alias_method :align,  :text
       alias_method :center, :text
@@ -80,24 +65,6 @@ module Vedeu
       alias_method :left,   :text
       alias_method :right,  :text
 
-      private
-
-      # @param attrs [Hash]
-      # @return [Vedeu::Stream]
-      def stream_builder(attrs)
-        Vedeu::Stream.build(stream_attributes(attrs))
-      end
-
-      # @param attrs [Hash]
-      # @return [Hash]
-      def stream_attributes(attrs)
-        {
-          colour: model.colour,
-          parent: model,
-          style:  model.style,
-        }.merge!(attrs)
-      end
-
     end # Text
 
   end # DSL

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

@@ -36,8 +36,8 @@ module Vedeu
       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."
+                              'cannot be used, since the interface has not ' \
+                              'been defined.'
         end
 
         Vedeu.interfaces.find(value)

data/lib/vedeu/dsl/view.rb

@@ -69,12 +69,12 @@ module Vedeu
         #
         # @note The views declared within this block are stored in their
         #   respective interface back buffers until a refresh event occurs. When
-        #   the refresh event is triggered, the back buffers are swapped into the
-        #   front buffers and the content here will be rendered to
+        #   the refresh event is triggered, the back buffers are swapped into
+        #   the front buffers and the content here will be rendered to
         #   {Vedeu::Terminal.output}.
         #
-        # @param block [Proc] The directives you wish to send to render. Typically
-        #   includes `view` with associated sub-directives.
+        # @param block [Proc] The directives you wish to send to render.
+        #   Typically includes `view` with associated sub-directives.
         #
         # @example
         #   Vedeu.views do

data/lib/vedeu/events/all.rb

@@ -1,6 +1,4 @@
-require 'vedeu/repositories/collections'
-require 'vedeu/events/event'
-require 'vedeu/events/trigger'
+require 'vedeu/repositories/collections/all'
 
-module Vedeu
-end # Vedeu
+require_relative 'event'
+require_relative 'trigger'