vedeu 0.7.4 → 0.8.0

data/lib/vedeu/dsl/text.rb

@@ -1,98 +0,0 @@
-
-module Vedeu
-
-  module DSL
-
-    # Provides helper methods for building views.
-    #
-    module Text
-
-      # Specify the content for a view. Provides the means to align a
-      # string (or object responding to `to_s`), and add it as a Line
-      # or to the Stream.
-      #
-      # @note If using the convenience methods; left, centre, center
-      #   or right, then a specified anchor will be ignored.
-      #
-      # @example
-      #   lines do
-      #     centre '...'
-      #   end
-      #
-      #   line do
-      #     right '...'
-      #   end
-      #
-      #   line do
-      #     stream do
-      #       text '...'
-      #     end
-      #   end
-      #
-      #   left 'This will be left aligned.', width: 35
-      #   # => 'This will be left aligned.         '
-      #
-      #   centre 'This will be aligned centrally.', width: 35
-      #   # => '  This will be aligned centrally.  '
-      #   # centre is also aliased to center
-      #
-      #   right 'This will be right aligned.', width: 35
-      #   # => '        This will be right aligned.'
-      #
-      #   right 'This will be right aligned.', width: 35,
-      #     anchor: centre
-      #
-      #   text 'This will be truncated here. More text here.',
-      #     width: 28 # => 'This will be truncated here.'
-      #
-      #   text 'Padded with hyphens.', width: 25, pad: '-',
-      #     anchor: :right # => '-----Padded with hyphens.'
-      #
-      # @param value [String|Object] A string or object that responds
-      #   to `to_s`.
-      # @param options [Hash<Symbol => void>] Text options.
-      # @option options :anchor [Symbol] One of `:left`,
-      #   `:centre`/`:center`, or `:right`.
-      # @option options :width [Integer|NilClass] The width of the
-      #   text stream to add. If the `string` provided is longer than
-      #   this value, the string will be truncated. If no width is
-      #   provided in the context of 'lines', then the interface width
-      #   is used. If no width is provided in the context of a
-      #   'stream', then no alignment will occur.
-      # @option options :pad [String] The character to use to pad the
-      #   width, by default uses an empty space (0x20). Only when the
-      #   string is shorter than the specified width.
-      # @return [String]
-      def text(value = '', options = {})
-        options.merge!(text_options).merge!(anchor: __callee__)
-
-        Vedeu::Output::Text.add(value, options)
-      end
-      alias_method :text=,   :text
-      alias_method :align,   :text
-      alias_method :center,  :text
-      alias_method :centre,  :text
-      alias_method :left,    :text
-      alias_method :right,   :text
-      alias_method :align=,  :text
-      alias_method :center=, :text
-      alias_method :centre=, :text
-      alias_method :left=,   :text
-      alias_method :right=,  :text
-
-      private
-
-      # @return [Hash<Symbol => void>]
-      def text_options
-        {
-          client: client,
-          model:  model,
-          name:   model.name,
-        }
-      end
-
-    end # Text
-
-  end # DSL
-
-end # Vedeu

data/lib/vedeu/geometries/alignment/all.rb

@@ -1,11 +0,0 @@
-module Vedeu
-
-  module Geometries
-
-  end # Geometries
-
-end # Vedeu
-
-require 'vedeu/geometries/alignment/alignment'
-require 'vedeu/geometries/alignment/horizontal_alignment'
-require 'vedeu/geometries/alignment/vertical_alignment'

data/lib/vedeu/geometries/alignment/horizontal_alignment.rb

@@ -1,27 +0,0 @@
-module Vedeu
-
-  module Geometries
-
-    # Provides the mechanism to align an interface/view horizontally
-    # within the available terminal space.
-    #
-    # @api private
-    #
-    class HorizontalAlignment < Vedeu::Geometries::Alignment
-
-      # @raise [Vedeu::Error::InvalidSyntax] When the value is not one
-      #   of :bottom, :centre, :left, :middle, :right, :top.
-      # @return [Symbol]
-      def align
-        return value if valid?
-
-        fail Vedeu::Error::InvalidSyntax,
-             'No horizontal alignment value given. Valid values are :center, ' \
-             ':centre, :left, :none, :right.'.freeze
-      end
-
-    end # HorizontalAlignment
-
-  end # Geometries
-
-end # Vedeu

data/lib/vedeu/geometries/alignment/vertical_alignment.rb

@@ -1,27 +0,0 @@
-module Vedeu
-
-  module Geometries
-
-    # Provides the mechanism to align an interface/view vertically
-    # within the available terminal space.
-    #
-    # @api private
-    #
-    class VerticalAlignment < Vedeu::Geometries::Alignment
-
-      # @raise [Vedeu::Error::InvalidSyntax] When the value is not one
-      #   of :bottom, :centre, :left, :middle, :right, :top.
-      # @return [Symbol]
-      def align
-        return value if valid?
-
-        fail Vedeu::Error::InvalidSyntax,
-             'No vertical alignment value given. Valid values are :bottom, ' \
-             ':middle, :none, :top.'.freeze
-      end
-
-    end # VerticalAlignment
-
-  end # Geometries
-
-end # Vedeu

data/lib/vedeu/output/text.rb

@@ -1,275 +0,0 @@
-module Vedeu
-
-  module Output
-
-    # Present a string (or object responding to `to_s`).
-    #
-    class Text
-
-      include Vedeu::Common
-
-      # @see Vedeu::DSL::Text#text
-      def self.add(value = '', options = {})
-        new(value, options).add
-      end
-
-      # @see Vedeu::DSL::Text#text
-      def self.with(value = '', options = {})
-        new(value, options).aligned
-      end
-
-      # Returns a new instance of Vedeu::Output::Text.
-      #
-      # @param value [String]
-      # @param options [Hash]
-      # @option options anchor [Symbol] See {Text#anchor}
-      # @option options background [String]
-      # @option options colour [Hash|NilClass]
-      # @option options foreground [String]
-      # @option options model
-      #   [Vedeu::Views::View|Vedeu::Views::Line|Vedeu::Views::Stream]
-      # @option options mode (see Vedeu::Output::Wordwrap#mode)
-      # @option options name [String|Symbol]
-      # @option options pad [String]
-      # @option options width [Integer]
-      # @return [Vedeu::Output::Text]
-      def initialize(value = '', options = {})
-        @value   = value
-        @options = defaults.merge!(options)
-      end
-
-      # Aligns the value.
-      #
-      # @return [String]
-      def aligned
-        return string unless width
-
-        return truncated if truncate?
-
-        case anchor
-        when :align, :left, :text then left
-        when :centre, :center     then centre
-        when :right               then right
-        else
-          left
-        end
-      end
-
-      # Adds the content to the model.
-      #
-      # @return [void]
-      def add
-        if wrap?
-          model.add(wrapped)
-
-        else
-          model.add(content)
-
-        end
-      end
-
-      protected
-
-      # @!attribute [r] value
-      # @return [String]
-      attr_reader :value
-
-      # @!attribute [r] options
-      # @return [Hash]
-      attr_reader :options
-
-      private
-
-      # @return [Symbol] One of :align, :centre, :center, :left,
-      #   :right, :text
-      def anchor
-        options[:anchor]
-      end
-
-      # The string padded to width, centralized.
-      #
-      # @return [String]
-      def centre
-        string.center(width, pad)
-      end
-
-      # @return [Object]
-      def client
-        options[:client]
-      end
-
-      # If a colour, background or foreground option is set, use them
-      # as the colour settings for the new Vedeu::Views::Stream.
-      #
-      # @return [void]
-      def colour
-        if options[:colour] || options[:background] || options[:foreground]
-          Vedeu::Colours::Colour.coerce(options)
-
-        else
-          model.colour
-
-        end
-      end
-
-      # Returns either a Vedeu::Views::Line or Vedeu::Views::Stream
-      # containing the text value.
-      #
-      # @return [Vedeu::Views::Line|Vedeu::Views::Stream]
-      def content
-        return stream unless model.is_a?(Vedeu::Views::View)
-
-        stream.parent = line
-        line.add(stream)
-        line
-      end
-
-      # The default values for a new instance of this class.
-      #
-      # @return [Hash<Symbol => NilClass, String, Symbol>]
-      def defaults
-        {
-          client: nil,
-          anchor: :left,
-          colour: nil,
-          model:  nil,
-          mode:   :default,
-          name:   '',
-          pad:    ' ',
-          width:  nil,
-        }
-      end
-
-      # @return [NilClass|Vedeu::Geometries::Geometry]
-      def geometry
-        Vedeu.geometries.by_name(name)
-      end
-
-      # The string padded to width, left justified.
-      #
-      # @return [String]
-      def left
-        string.ljust(width, pad)
-      end
-
-      # @return [Vedeu::Views::Line]
-      def line
-        @line ||= Vedeu::Views::Line.build(parent: parent, client: client)
-      end
-
-      # Returns the model option when set.
-      #
-      # @return [Vedeu::Views::View|
-      #          Vedeu::Views::Line|
-      #          Vedeu::Null::Generic|
-      #          Vedeu::Views::Stream]
-      def model
-        @model ||= options[:model] || Vedeu::Null::Generic.new
-      end
-
-      # @see Vedeu::Output::Wordwrap#mode
-      # @return [Symbol]
-      def mode
-        options[:mode]
-      end
-
-      # @return [String|Symbol]
-      def name
-        options[:name]
-      end
-
-      # The character to use for padding the string.
-      #
-      # @return [String]
-      def pad
-        options[:pad]
-      end
-
-      # Returns the parent for the new Vedeu::Views::Stream.
-      #
-      # @return [void]
-      def parent
-        model.is_a?(Vedeu::Views::Stream) ? model.parent : model
-      end
-
-      # The string padded to width, right justified.
-      #
-      # @return [String]
-      def right
-        string.rjust(width, pad)
-      end
-
-      # Builds and returns a new Vedeu::Views::Stream.
-      #
-      # @return [void]
-      def stream
-        @stream ||= Vedeu::Views::Stream.build(client: client,
-                                               colour: colour,
-                                               parent: parent,
-                                               style:  style,
-                                               value:  aligned)
-      end
-
-      # The string, coerced.
-      #
-      # @return [String]
-      def string
-        value.to_s
-      end
-
-      # Returns the model's styles.
-      #
-      # @return [void]
-      def style
-        model.style
-      end
-
-      # Return a boolean indicating that the string is greater than
-      # the width.
-      #
-      # @return [Boolean]
-      def truncate?
-        string.size > width
-      end
-
-      # Return the string truncated to the width.
-      #
-      # @return [String]
-      def truncated
-        string.slice(0, width)
-      end
-
-      # Return the width of the interface when a name is given,
-      # otherwise use the given width.
-      #
-      # @return [Fixnum]
-      def width
-        if present?(options[:width])
-          options[:width]
-
-        elsif present?(options[:name])
-          geometry.bordered_width
-
-        end
-      end
-
-      # Return a boolean indicating whether the string should be
-      # wrapped.
-      #
-      # @return [Boolean]
-      def wrap?
-        options[:mode] == :wrap
-      end
-
-      # Return the content as wrapped lines.
-      #
-      # @return [Vedeu::Views::Lines]
-      def wrapped
-        Vedeu::Output::Wordwrap.for(string, options)
-      end
-
-    end # Text
-
-  end # Output
-
-end # Vedeu

data/test/lib/vedeu/dsl/composition_test.rb

@@ -1,67 +0,0 @@
-require 'test_helper'
-
-module Vedeu
-
-  module DSL
-
-    describe Composition do
-
-      let(:described) { Vedeu::DSL::Composition }
-      let(:instance)  { described.new(model) }
-      let(:model)     { Vedeu::Views::Composition.new }
-      let(:client)    {}
-
-      describe '#view' do
-        subject {
-          instance.view('dysprosium') do
-            # ...
-          end
-        }
-
-        it { subject.must_be_instance_of(Vedeu::Views::ViewCollection) }
-        it { subject[0].must_be_instance_of(Vedeu::Views::View) }
-
-        context 'when the block is not given' do
-          it { proc { instance.view }.must_raise(Vedeu::Error::RequiresBlock) }
-        end
-      end
-
-      describe '#template_for' do
-        let(:_name)    {}
-        let(:filename) {}
-        let(:object)   {}
-        let(:content)  { "Hydrogen\nCarbon\nOxygen\nNitrogen" }
-        let(:options)  { {} }
-
-        subject { instance.template_for(_name, filename, object, options) }
-
-        context 'when the name of the view is not given' do
-          let(:filename) { 'my_interface.erb' }
-
-          it { proc { subject }.must_raise(Vedeu::Error::MissingRequired) }
-        end
-
-        context 'when the filename of the template is not given' do
-          let(:_name) { 'my_interface' }
-
-          it { proc { subject }.must_raise(Vedeu::Error::MissingRequired) }
-        end
-
-        context 'when the name and filename are given' do
-          let(:_name) { 'my_interface' }
-          let(:filename) { 'my_interface.erb' }
-
-          before do
-            Vedeu::Templating::ViewTemplate.expects(:parse).
-              with(object, filename, options).returns(content)
-          end
-
-          it { subject.must_be_instance_of(Vedeu::Views::ViewCollection) }
-        end
-      end
-
-    end # Composition
-
-  end # DSL
-
-end # Vedeu