vedeu 0.7.4 → 0.8.0

data/lib/vedeu/dsl/composition.rb

@@ -1,150 +0,0 @@
-module Vedeu
-
-  module DSL
-
-    # DSL for creating collections of interfaces.
-    #
-    # Views with Vedeu are made up of simple building blocks. These
-    # blocks can be arranged in a multitude of ways which I hope is
-    # more than sufficient for your design needs.
-
-    # - A view (`Composition`) is made up of one or more interfaces.
-    # - An interface is an area on the screen where you can take input
-    #   or direct output. You will define it's colour and style, its
-    #   dimensions, including position and give it a name. You can
-    #   then direct the output of a command, or event, to this
-    #   interface and Vedeu will ensure the content is placed there.
-    # - Interfaces (`Interface`) are made up of lines (`Line`), their
-    #   length being the width of the interface and their number being
-    #   the height of the interface.
-    # - An interface with `width: 12, height: 5` will have five lines,
-    #   each made of 12 characters- providing 60 cells. Colours and
-    #   styles are handled by terminal escape sequences and therefore
-    #   do not consume a cell.
-    # - Lines are made up of zero, one or multiple streams which are
-    #   basically subsets of the line.
-    # - An interface, line or stream can have a colour attribute.
-    # - An interface, line or stream can have a style attribute.
-    # - Interfaces have a position (`y`, `x`) on the screen, and a
-    #   size. (`width`, `height`)
-    # - Interfaces can be placed relative to each other based on their
-    #   attributes.
-    #   - An interface has a `top`, `right`, `bottom`, `left`.
-    #   - An interface also has a `north` and `west` (`top` and `left`
-    #     minus 1 respectively).
-    #   - An interface also has a `south` and `east` (`bottom` and
-    #     `right` plus 1 respectively).
-    # - Colours are defined in CSS-style values, i.e. `#ff0000` would
-    #   be red.
-    # - Styles are named. See the table below for supported styles.
-    #
-    class Composition
-
-      include Vedeu::DSL
-
-      # Define a view.
-      #
-      # A view is just an Interface object.
-      #
-      # When a view already exists, we take its attributes and use
-      # them as the basis for the newly defined view. This way we
-      # don't need to specify everything again.
-      #
-      # @todo More documentation required.
-      # @param name [String|Symbol] The name of the interface you are
-      #   targetting for this view.
-      # @param block [Proc] The directives you wish to send to this
-      #   interface.
-      #
-      # @example
-      #   view :my_interface do
-      #     # ...
-      #   end
-      #
-      # @raise [Vedeu::Error::RequiresBlock]
-      # @return [Vedeu::Views::Views<Vedeu::Views::View>]
-      def view(name = '', &block)
-        fail Vedeu::Error::RequiresBlock unless block_given?
-
-        new_model = model.member.build(new_attributes(name), &block)
-
-        model.add(new_model)
-      end
-
-      # Load content from an ERb template.
-      #
-      # @example
-      #   Vedeu.renders do
-      #     template_for(:my_interface,
-      #                  '/path/to/template.erb',
-      #                  @some_object, options)
-      #   end
-      #
-      # @todo More documentation required.
-      #
-      # @param name [String|Symbol] The name of interface for which this
-      #   template's content belongs to.
-      # @param filename [String] The filename (including path) to the
-      #   template to be used. Yoy can use `File.dirname(__FILE__)` to
-      #   use relative paths.
-      # @param object [Object] The object for which the values of
-      #   template's variables can be obtained.
-      # @param options [Hash<Symbol => void>] See {Vedeu::Output::Wordwrap}
-      # @raise [Vedeu::Error::MissingRequired]
-      # @return [Vedeu::Views::Views<Vedeu::Views::View>]
-      def template_for(name, filename, object = nil, options = {})
-        fail Vedeu::Error::MissingRequired,
-             'Cannot render template without the name of the ' \
-             'view.'.freeze unless name
-        fail Vedeu::Error::MissingRequired,
-             'Cannot render template without a filename.'.freeze unless filename
-
-        options.merge!(name: name)
-
-        content = Vedeu::Templating::ViewTemplate.parse(object,
-                                                        filename,
-                                                        options)
-
-        # lines     = Vedeu::Output::Wordwrap.for(content, options)
-
-        new_model = model.member.build(template_attributes(name, content))
-
-        model.add(new_model)
-      end
-
-      private
-
-      # @param name [String|Symbol]
-      # @param lines [Vedeu::Views::Lines]
-      # @return [Hash<Symbol => void>]
-      def template_attributes(name, lines)
-        new_attributes(name).merge!(value: lines)
-      end
-
-      # Return the current attributes combined with the existing
-      # interface attributes defined by the interface.
-      #
-      # @param name [String|Symbol] The name of the interface.
-      # @return [Hash<Symbol => void>]
-      def new_attributes(name)
-        existing_attributes(name).merge!(attributes)
-      end
-
-      # Retrieve the attributes of the interface by name.
-      #
-      # @param name [String|Symbol] The name of the interface.
-      # @return [Hash<Symbol => void>]
-      def existing_attributes(name)
-        interface(name).attributes
-      end
-
-      # @return [Vedeu::Interfaces::Interface]
-      def interface(name)
-        Vedeu.interfaces.by_name(name)
-      end
-
-    end # Composition
-
-  end # DSL
-
-end # Vedeu

data/lib/vedeu/dsl/line.rb

@@ -1,119 +0,0 @@
-module Vedeu
-
-  module DSL
-
-    # Provides methods to be used to define views.
-    #
-    #   Vedeu.renders do
-    #     view :my_interface do
-    #       lines do
-    #         background '#000000'
-    #         foreground '#ffffff'
-    #         line 'This is white text on a black background.'
-    #         line 'Next is a blank line:'
-    #         line ''
-    #
-    #         streams { stream 'We can define ' }
-    #
-    #         streams do
-    #           foreground '#ff0000'
-    #           stream 'parts of a line '
-    #         end
-    #
-    #         streams { stream 'independently using ' }
-    #
-    #         streams do
-    #           foreground '#00ff00'
-    #           stream 'streams.'
-    #         end
-    #       end
-    #     end
-    #   end
-    #
-    class Line
-
-      include Vedeu::DSL
-      include Vedeu::DSL::Presentation
-      include Vedeu::DSL::Text
-
-      # Specify a single line in a view.
-      #
-      #   Vedeu.renders do
-      #     view :my_interface do
-      #       lines do
-      #         line 'some text...'
-      #         # ... some code
-      #
-      #         line 'some more text...'
-      #         # ... some code
-      #       end
-      #     end
-      #   end
-      #
-      # @raise [Vedeu::Error::RequiresBlock]
-      # @return [Vedeu::Views::Lines]
-      def line(value = '', &block)
-        if block_given?
-          content = Vedeu::Views::Line.build(client: client,
-                                             parent: model.parent, &block)
-
-        elsif value
-          content = Vedeu::Views::Line.build(client: client,
-                                             parent: model.parent,
-                                             value:  [build_stream(value)])
-
-        else
-          fail Vedeu::Error::RequiresBlock unless block_given?
-
-        end
-
-        model.parent.add(content)
-      end
-      alias_method :line=, :line
-
-      # Define multiple streams (a stream is a subset of a line).
-      # Uses {Vedeu::DSL::Stream} for all directives within the
-      # required block.
-      #
-      #   Vedeu.renders do
-      #     view :my_interface do
-      #       lines do
-      #         line do
-      #           streams do
-      #             # ... some code
-      #           end
-      #
-      #           stream do
-      #             # ... some code
-      #           end
-      #         end
-      #       end
-      #     end
-      #   end
-      #
-      # @param block [Proc]
-      # @raise [Vedeu::Error::RequiresBlock]
-      # @return [Vedeu::Views::Streams<Vedeu::Views::Stream>]
-      # @see Vedeu::DSL::Stream for subdirectives.
-      def streams(&block)
-        fail Vedeu::Error::RequiresBlock unless block_given?
-
-        model.add(model.member.build(attributes, &block))
-      end
-      alias_method :stream, :streams
-      alias_method :stream=, :streams
-      alias_method :streams=, :streams
-
-      private
-
-      # @param value [String]
-      # @return [Vedeu::Views::Stream]
-      def build_stream(value)
-        Vedeu::Views::Stream.build(client: client, parent: model, value: value)
-      end
-
-    end # Line
-
-  end # DSL
-
-end # Vedeu

data/lib/vedeu/dsl/lines.rb

@@ -1,23 +0,0 @@
-module Vedeu
-
-  module DSL
-
-    # Provides the mechanism to add lines to a view via the DSL.
-    #
-    class Lines
-
-      # @raise [Vedeu::Error::RequiresBlock]
-      # @return [Vedeu::Views::Lines]
-      # def lines(&block)
-      #   fail Vedeu::Error::RequiresBlock unless block_given?
-
-      #   client = eval('self', block.binding)
-
-      #   # Vedeu::Models::Lines.new
-      # end
-
-    end # Lines
-
-  end # DSL
-
-end # Vedeu

data/lib/vedeu/dsl/shared.rb

@@ -1,85 +0,0 @@
-module Vedeu
-
-  module DSL
-
-    # Provides behaviour to be shared between both
-    # {Vedeu::Interfaces::DSL} 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::Borders::DSL for DSL methods for
-      #       #     borders.
-      #     end
-      #   end
-      #
-      # @param name [String|Symbol] 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::Borders::DSL.border}.
-      # @param block [Proc]
-      # @raise [Vedeu::Error::RequiresBlock]
-      # @return [Vedeu::Borders::Border]
-      # @see Vedeu::Borders::DSL
-      def border(name = nil, &block)
-        fail Vedeu::Error::RequiresBlock unless block_given?
-
-        model_name = name ? name : model.name
-
-        border_attrs = attributes.merge!(enabled: true,
-                                         name:    model_name)
-
-        Vedeu::Borders::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::Borders::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::Geometries::DSL for DSL methods for
-      #       #     geometries.
-      #     end
-      #   end
-      #
-      # @param name [String|Symbol] 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::Geometries::DSL.geometry}.
-      # @param block [Proc]
-      # @raise [Vedeu::Error::RequiresBlock]
-      # @return [Vedeu::Geometries::Geometry]
-      # @see Vedeu::Geometries::DSL
-      def geometry(name = nil, &block)
-        fail Vedeu::Error::RequiresBlock unless block_given?
-
-        model_name = name ? name : model.name
-
-        Vedeu::Geometries::Geometry.build(name: model_name, &block).store
-      end
-
-    end # Shared
-
-  end # DSL
-
-end # Vedeu

data/lib/vedeu/dsl/stream.rb

@@ -1,40 +0,0 @@
-module Vedeu
-
-  module DSL
-
-    # Provides methods to be used to define views.
-    #
-    class Stream
-
-      include Vedeu::DSL
-      include Vedeu::DSL::Presentation
-      include Vedeu::DSL::Text
-
-      # @param block [Proc]
-      # @raise [Vedeu::Error::RequiresBlock]
-      # @return [void]
-      def stream(&block)
-        fail Vedeu::Error::RequiresBlock unless block_given?
-
-        model.add(model.class.build(attributes, &block))
-      end
-
-      private
-
-      # Returns the default attributes for the new model.
-      #
-      # Overrides {Vedeu::DSL#attributes}.
-      #
-      # @return [Hash<Symbol => void>]
-      def attributes
-        {
-          client: client,
-          parent: model.parent,
-        }
-      end
-
-    end # Stream
-
-  end # DSL
-
-end # Vedeu

data/lib/vedeu/dsl/streams.rb

@@ -1,23 +0,0 @@
-module Vedeu
-
-  module DSL
-
-    # Provides the mechanism to add streams to a line via the DSL.
-    #
-    class Streams
-
-      # @raise [Vedeu::Error::RequiresBlock]
-      # @return [Vedeu::Views::Streams]
-      # def streams(&block)
-      #   fail Vedeu::Error::RequiresBlock unless block_given?
-
-      #   client = eval('self', block.binding)
-
-      #   # Vedeu::Models::Stream.new
-      # end
-
-    end # Streams
-
-  end # DSL
-
-end # Vedeu