vedeu 0.5.4 → 0.5.5

data/lib/vedeu/dsl/border.rb

@@ -46,7 +46,7 @@ module Vedeu
       def self.border(name, &block)
         fail Vedeu::InvalidSyntax, 'block not given' unless block_given?
 
-        Vedeu::Border.build({ enabled: true, name: name }, &block).store
+        Vedeu::Border.build(enabled: true, name: name, &block).store
       end
 
       # Returns an instance of DSL::Border.

data/lib/vedeu/dsl/composition.rb

@@ -42,7 +42,7 @@ module Vedeu
 
       # Returns an instance of DSL::Composition.
       #
-      # @param model [Vedeu::Composition]
+      # @param model [Vedeu::Views::Composition]
       # @param client [Object]
       # @return [Vedeu::DSL::Composition]
       def initialize(model, client = nil)
@@ -69,7 +69,7 @@ module Vedeu
       #   end
       #
       # @raise [Vedeu::InvalidSyntax] The required block was not given.
-      # @return [Vedeu::InterfaceCollection<Vedeu::Interface>]
+      # @return [Vedeu::Views::Views<Vedeu::Views::View>]
       def view(name = '', &block)
         fail Vedeu::InvalidSyntax, 'block not given' unless block_given?
 
@@ -97,7 +97,7 @@ module Vedeu
       # @param object [Object] The object for which the values of template's
       #   variables can be obtained.
       # @param options [Hash] See {Vedeu::Wordwrap}
-      # @return [Vedeu::InterfaceCollection<Vedeu::Interface>]
+      # @return [Vedeu::Views::Views<Vedeu::Views::View>]
       def template_for(name, filename, object = nil, options = {})
         fail Vedeu::MissingRequired,
              'Cannot render template without the name of the view.' unless name
@@ -124,13 +124,13 @@ module Vedeu
       attr_reader :client
 
       # @!attribute [r] model
-      # @return [Vedeu::Composition]
+      # @return [Vedeu::Views::Composition]
       attr_reader :model
 
       private
 
       # @param name [String]
-      # @param lines [Vedeu::Lines]
+      # @param lines [Vedeu::Views::Lines]
       # @return [Hash]
       def template_attributes(name, lines)
         new_attributes(name).merge!(lines: lines)

data/lib/vedeu/dsl/geometry.rb

@@ -87,7 +87,7 @@ module Vedeu
       def self.geometry(name, &block)
         fail Vedeu::InvalidSyntax, 'block not given' unless block_given?
 
-        Vedeu::Geometry.build({ name: name }, &block).store
+        Vedeu::Geometry.build(name: name, &block).store
       end
 
       # Returns an instance of DSL::Geometry.

data/lib/vedeu/dsl/group.rb

@@ -46,7 +46,7 @@ module Vedeu
       def self.group(name, &block)
         fail Vedeu::InvalidSyntax, 'block not given' unless block_given?
 
-        Vedeu::Group.build({ name: name }, &block).store
+        Vedeu::Group.build(name: name, &block).store
       end
 
       # Returns an instance of DSL::Group.

data/lib/vedeu/dsl/interface.rb

@@ -9,9 +9,78 @@ module Vedeu
       include Vedeu::Common
       include Vedeu::DSL
       include Vedeu::DSL::Presentation
+      include Vedeu::DSL::Shared
       include Vedeu::DSL::Text
       include Vedeu::DSL::Use
 
+      class << self
+
+        include Vedeu::Common
+
+        # Register an interface by name which will display output from a event
+        # or command. This provides the means for you to define your the views
+        # of your application without their content.
+        #
+        #   Vedeu.interface 'my_interface' do
+        #     # ... some code
+        #   end
+        #
+        # @param name [String] The name of the interface. Used to reference the
+        #   interface throughout your application's execution lifetime.
+        # @param block [Proc] A set of attributes which define the features of
+        #   the interface.
+        # @raise [Vedeu::InvalidSyntax] The required block was not given.
+        # @return [Vedeu::Interface]
+        # @todo More documentation required.
+        def interface(name, &block)
+          fail Vedeu::InvalidSyntax, 'block not given' unless block_given?
+          fail Vedeu::MissingRequired, 'name not given' unless present?(name)
+
+          add_buffers!(name)
+          add_cursor!(name)
+          add_focusable!(name)
+
+          attributes = { client: client(&block), name: name }
+
+          Vedeu::Interface.build(attributes, &block).store
+        end
+
+        private
+
+        # Registers a set of buffers for the interface unless already
+        # registered, and also adds interface's name to list of focussable
+        # interfaces.
+        #
+        # @see Vedeu::Buffer
+        # @return [void]
+        def add_buffers!(name)
+          Vedeu::Buffer.new(name: name).store
+        end
+
+        # Registers a new cursor for the interface unless already registered.
+        #
+        # @return [void]
+        def add_cursor!(name)
+          Vedeu::Cursor.new(name: name).store
+        end
+
+        # Registers interface name in focus list unless already registered.
+        #
+        # @return [void]
+        def add_focusable!(name)
+          Vedeu.focusable.add(name) unless Vedeu.focusable.registered?(name)
+        end
+
+        # Returns the client object which called the DSL method.
+        #
+        # @param block [Proc]
+        # @return [Object]
+        def client(&block)
+          eval('self', block.binding)
+        end
+
+      end # Eigenclass
+
       # Returns an instance of Vedeu::DSL::Interface.
       #
       # @param model [Vedeu::DSL::Interface]
@@ -22,49 +91,6 @@ module Vedeu
         @client = client
       end
 
-      # Allows the setting of a border for the interface.
-      #
-      # @example
-      #   Vedeu.interface 'my_interface' do
-      #     border do
-      #       # ... see Vedeu::DSL::Border for DSL methods for borders.
-      #     end
-      #   end
-      #
-      # @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 [Vedeu::InvalidSyntax] The required block was not given.
-      # @return [Vedeu::Border]
-      # @see Vedeu::DSL::Border
-      def border(name = nil, &block)
-        fail Vedeu::InvalidSyntax, 'block not given' unless block_given?
-
-        model_name = name ? name : model.name
-
-        border_attrs = attributes.merge!(enabled: true,
-                                         name:    model_name)
-
-        Vedeu::Border.build(border_attrs, &block).store
-      end
-
-      # Applies the default border to the interface.
-      #
-      # @example
-      #   Vedeu.interface 'my_interface' do
-      #     border!
-      #
-      #     # ... some code
-      #   end
-      #
-      # @return [Vedeu::Border]
-      def border!
-        border do
-          # adds default border
-        end
-      end
-
       # Set the cursor visibility on an interface.
       #
       # @param value [Boolean] Any value other than nil or false will evaluate
@@ -141,30 +167,6 @@ module Vedeu
         Vedeu::Focus.add(model.name, true) if present?(model.name)
       end
 
-      # Define the geometry for an interface.
-      #
-      # @example
-      #   Vedeu.interface 'my_interface' do
-      #     geometry do
-      #       # ... see Vedeu::DSL::Geometry for DSL methods for geometries.
-      #     end
-      #   end
-      #
-      # @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 [Vedeu::InvalidSyntax] The required block was not given.
-      # @return [Vedeu::Geometry]
-      # @see Vedeu::DSL::Geometry
-      def geometry(name = nil, &block)
-        fail Vedeu::InvalidSyntax, 'block not given' unless block_given?
-
-        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
       # targetted together; for example you may want to refresh multiple
       # interfaces at once.
@@ -192,32 +194,6 @@ module Vedeu
       end
       alias_method :keys, :keymap
 
-      # Specify multiple lines in a view.
-      #
-      # @param block [Proc]
-      #
-      # @example
-      #   Vedeu.view 'my_interface' do
-      #     lines do
-      #       # ... see {Vedeu::DSL::Line} and {Vedeu::DSL::Stream}
-      #     end
-      #   end
-      #
-      #   Vedeu.view 'my_interface' do
-      #     line do
-      #       # ... see {Vedeu::DSL::Line} and {Vedeu::DSL::Stream}
-      #     end
-      #   end
-      #
-      # @raise [Vedeu::InvalidSyntax] The required block was not given.
-      # @return [Line]
-      def lines(&block)
-        fail Vedeu::InvalidSyntax, 'block not given' unless block_given?
-
-        model.add(model.member.build(attributes, &block))
-      end
-      alias_method :line, :lines
-
       # The name of the interface. Used to reference the interface throughout
       # your application's execution lifetime.
       #

data/lib/vedeu/dsl/keymap.rb

@@ -54,7 +54,7 @@ module Vedeu
       def self.keymap(name, &block)
         Vedeu::Keymap.new(name: name).store
 
-        Vedeu::Keymap.build({ name: name }, &block).store
+        Vedeu::Keymap.build(name: name, &block).store
       end
 
       # Returns an instance of DSL::Keymap.

data/lib/vedeu/dsl/line.rb

@@ -38,7 +38,7 @@ module Vedeu
 
       # Returns an instance of DSL::Line.
       #
-      # @param model [Vedeu::Line]
+      # @param model [Vedeu::Views::Line]
       # @param client [Object]
       # @return [Vedeu::DSL::Line]
       def initialize(model, client = nil)
@@ -60,16 +60,16 @@ module Vedeu
       #   end
       #
       # @raise [Vedeu::InvalidSyntax] When no block or value is provided.
-      # @return [Vedeu::Lines]
+      # @return [Vedeu::Views::Lines]
       def line(value = '', &block)
         if block_given?
-          content = Vedeu::Line.build({ client: client,
-                                        parent: model.parent }, &block)
+          content = Vedeu::Views::Line.build(client: client,
+                                             parent: model.parent, &block)
 
         elsif value
-          content = Vedeu::Line.build(client:  client,
-                                      parent:  model.parent,
-                                      streams: [build_stream(value)])
+          content = Vedeu::Views::Line.build(client:  client,
+                                             parent:  model.parent,
+                                             streams: [build_stream(value)])
 
         else
           fail Vedeu::InvalidSyntax, 'block not given'
@@ -98,7 +98,7 @@ module Vedeu
       #
       # @param block [Proc]
       # @raise [Vedeu::InvalidSyntax] The required block was not given.
-      # @return [Vedeu::Streams<Vedeu::Stream>]
+      # @return [Vedeu::Views::Streams<Vedeu::Views::Stream>]
       # @see Vedeu::DSL::Stream for subdirectives.
       def streams(&block)
         fail Vedeu::InvalidSyntax, 'block not given' unless block_given?
@@ -114,7 +114,7 @@ module Vedeu
       attr_reader :client
 
       # @!attribute [r] model
-      # @return [Vedeu::Line]
+      # @return [Vedeu::Views::Line]
       attr_reader :model
 
       private
@@ -128,9 +128,9 @@ module Vedeu
       end
 
       # @param value [String]
-      # @return [Vedeu::Stream]
+      # @return [Vedeu::Views::Stream]
       def build_stream(value)
-        Vedeu::Stream.build(client: client, parent: model, value: value)
+        Vedeu::Views::Stream.build(client: client, parent: model, value: value)
       end
 
     end # Line

data/lib/vedeu/dsl/shared.rb

@@ -0,0 +1,81 @@
+module Vedeu
+
+  module DSL
+
+    # Provides behaviour to be shared between both {Vedeu::DSL::Interface} and
+    # {Vedeu::DSL::View} objects.
+    #
+    module Shared
+
+      # Allows the setting of a border for the interface.
+      #
+      # @example
+      #   Vedeu.interface 'my_interface' do
+      #     border do
+      #       # ... see Vedeu::DSL::Border for DSL methods for borders.
+      #     end
+      #   end
+      #
+      # @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 [Vedeu::InvalidSyntax] The required block was not given.
+      # @return [Vedeu::Border]
+      # @see Vedeu::DSL::Border
+      def border(name = nil, &block)
+        fail Vedeu::InvalidSyntax, 'block not given' unless block_given?
+
+        model_name = name ? name : model.name
+
+        border_attrs = attributes.merge!(enabled: true,
+                                         name:    model_name)
+
+        Vedeu::Border.build(border_attrs, &block).store
+      end
+
+      # Applies the default border to the interface.
+      #
+      # @example
+      #   Vedeu.interface 'my_interface' do
+      #     border!
+      #
+      #     # ... some code
+      #   end
+      #
+      # @return [Vedeu::Border]
+      def border!
+        border do
+          # adds default border
+        end
+      end
+
+      # Define the geometry for an interface.
+      #
+      # @example
+      #   Vedeu.interface 'my_interface' do
+      #     geometry do
+      #       # ... see Vedeu::DSL::Geometry for DSL methods for geometries.
+      #     end
+      #   end
+      #
+      # @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 [Vedeu::InvalidSyntax] The required block was not given.
+      # @return [Vedeu::Geometry]
+      # @see Vedeu::DSL::Geometry
+      def geometry(name = nil, &block)
+        fail Vedeu::InvalidSyntax, 'block not given' unless block_given?
+
+        model_name = name ? name : model.name
+
+        Vedeu::Geometry.build(name: model_name, &block).store
+      end
+
+    end # Shared
+
+  end # DSL
+
+end # Vedeu

data/lib/vedeu/dsl/stream.rb

@@ -10,9 +10,9 @@ module Vedeu
       include Vedeu::DSL::Presentation
       include Vedeu::DSL::Text
 
-      # Returns an instance of DSL::Stream.
+      # Returns an instance of Vedeu::DSL::Stream.
       #
-      # @param model [Vedeu::Stream]
+      # @param model [Vedeu::Views::Stream]
       # @param client [Object]
       # @return [Vedeu::DSL::Stream]
       def initialize(model, client = nil)
@@ -36,7 +36,7 @@ module Vedeu
       attr_reader :client
 
       # @!attribute [r] model
-      # @return [Stream]
+      # @return [Vedeu::Views::Stream]
       attr_reader :model
 
       private

data/lib/vedeu/dsl/view.rb

@@ -8,9 +8,10 @@ module Vedeu
     #
     # Both of these approaches require that you have defined an interface (or
     # 'visible area') first. You can find out how to define an interface with
-    # Vedeu here. The examples in 'Immediate Render' and 'Deferred View' use
-    # these interface definitions: (Note: should you use these examples, ensure
-    # your terminal is at least 70 characters in width and 5 lines in height.)
+    # Vedeu below or in {Vedeu::DSL::Interface}. The examples in 'Immediate
+    # Render' and 'Deferred View' use these interface definitions: (Note: should
+    # you use these examples, ensure your terminal is at least 70 characters in
+    # width and 5 lines in height.)
     #
     #   Vedeu.interface 'main' do
     #     geometry do
@@ -79,38 +80,17 @@ module Vedeu
     #
     class View
 
+      include Vedeu::Common
+      include Vedeu::DSL
+      include Vedeu::DSL::Presentation
+      include Vedeu::DSL::Shared
+      include Vedeu::DSL::Text
+      include Vedeu::DSL::Use
+
       class << self
 
         include Vedeu::Common
 
-        # Register an interface by name which will display output from a event
-        # or command. This provides the means for you to define your the views
-        # of your application without their content.
-        #
-        #   Vedeu.interface 'my_interface' do
-        #     # ... some code
-        #   end
-        #
-        # @param name [String] The name of the interface. Used to reference the
-        #   interface throughout your application's execution lifetime.
-        # @param block [Proc] A set of attributes which define the features of
-        #   the interface.
-        # @raise [Vedeu::InvalidSyntax] The required block was not given.
-        # @return [Vedeu::Interface]
-        # @todo More documentation required.
-        def interface(name, &block)
-          fail Vedeu::InvalidSyntax, 'block not given' unless block_given?
-          fail Vedeu::MissingRequired, 'name not given' unless present?(name)
-
-          add_buffers!(name)
-          add_cursor!(name)
-          add_focusable!(name)
-
-          attributes = { client: client(&block), name: name }
-
-          Vedeu::Interface.build(attributes, &block).store
-        end
-
         # Directly write a view buffer to the terminal. Using this method means
         # that the refresh event does not need to be triggered after creating
         # the views, though can be later triggered when needed.
@@ -147,7 +127,7 @@ module Vedeu
         # @param block [Proc] The directives you wish to send to render.
         #   Typically includes `view` with associated sub-directives.
         # @raise [Vedeu::InvalidSyntax] The required block was not given.
-        # @return [Array<Interface>]
+        # @return [Array<View>]
         def render(&block)
           fail Vedeu::InvalidSyntax, 'block not given' unless block_given?
 
@@ -191,39 +171,15 @@ module Vedeu
         # @param block [Proc] The directives you wish to send to render.
         #   Typically includes `view` with associated sub-directives.
         # @raise [Vedeu::InvalidSyntax] The required block was not given.
-        # @return [Array<Interface>]
-        def view(&block)
+        # @return [Array<View>]
+        def views(&block)
           fail Vedeu::InvalidSyntax, 'block not given' unless block_given?
 
           store(:store_deferred, &block)
         end
-        alias_method :views, :view
 
         private
 
-        # Registers a set of buffers for the interface unless already registered,
-        # and also adds interface's name to list of focussable interfaces.
-        #
-        # @see Vedeu::Buffer
-        # @return [void]
-        def add_buffers!(name)
-          Vedeu::Buffer.new(name: name).store
-        end
-
-        # Registers a new cursor for the interface unless already registered.
-        #
-        # @return [void]
-        def add_cursor!(name)
-          Vedeu::Cursor.new(name: name).store
-        end
-
-        # Registers interface name in focus list unless already registered.
-        #
-        # @return [void]
-        def add_focusable!(name)
-          Vedeu.focusable.add(name) unless Vedeu.focusable.registered?(name)
-        end
-
         # Returns the client object which called the DSL method.
         #
         # @param block [Proc]
@@ -232,14 +188,14 @@ module Vedeu
           eval('self', block.binding)
         end
 
-        # Creates a new Composition which may contain one or more views
-        # (Interface objects).
+        # Creates a new Vedeu::Views::Composition which may contain one or more
+        # views (Vedeu::Views::View objects).
         #
         # @param client [Object]
         # @param block [Proc]
-        # @return [Vedeu::Composition]
+        # @return [Vedeu::Views::Composition]
         def composition(client, &block)
-          Vedeu::Composition.build({ client: client }, &block)
+          Vedeu::Views::Composition.build(client: client, &block)
         end
 
         # Stores each of the views defined in their respective buffers ready to
@@ -251,13 +207,69 @@ module Vedeu
         # @param block [Proc]
         # @return [Array]
         def store(method, &block)
-          composition(client(&block), &block).interfaces.map do |interface|
-            interface.public_send(method)
+          composition(client(&block), &block).views.map do |view|
+            view.public_send(method)
           end
         end
 
       end # Eigenclass
 
+      # Returns an instance of Vedeu::DSL::View.
+      #
+      # @param model [Vedeu::DSL::View]
+      # @param client [Object]
+      # @return [Vedeu::DSL::View]
+      def initialize(model, client = nil)
+        @model  = model
+        @client = client
+      end
+
+      # Specify multiple lines in a view.
+      #
+      # @param block [Proc]
+      #
+      # @example
+      #   Vedeu.view 'my_interface' do
+      #     lines do
+      #       # ... see {Vedeu::DSL::Line} and {Vedeu::DSL::Stream}
+      #     end
+      #   end
+      #
+      #   Vedeu.view 'my_interface' do
+      #     line do
+      #       # ... see {Vedeu::DSL::Line} and {Vedeu::DSL::Stream}
+      #     end
+      #   end
+      #
+      # @raise [Vedeu::InvalidSyntax] The required block was not given.
+      # @return [Vedeu::Views::Line]
+      def lines(&block)
+        fail Vedeu::InvalidSyntax, 'block not given' unless block_given?
+
+        model.add(model.member.build(attributes, &block))
+      end
+      alias_method :line, :lines
+
+      protected
+
+      # @!attribute [r] client
+      # @return [Object]
+      attr_reader :client
+
+      # @!attribute [r] model
+      # @return [Vedeu::Views::View]
+      attr_reader :model
+
+      private
+
+      # @return [Hash]
+      def attributes
+        {
+          client: client,
+          parent: model,
+        }
+      end
+
     end # View
 
   end # DSL