Contents

module Vedeu

  module Templating

    # Provide helpers to be used with your Vedeu templates.
    #
    module Helpers

      # @param value [String] The HTML/CSS colour.
      # @param block [Proc]
      # @return [Vedeu::Stream]
      # @raise [Vedeu::InvalidSyntax] The required block was not given.
      def background(value, &block)
        define_stream({ background: value }, &block)
      end
      alias_method :bg, :background

      # @param attributes [Hash]
      # @option attributes foreground [String] The HTML/CSS foreground colour.
      # @option attributes background [String] The HTML/CSS background colour.
      # @param block [Proc]
      # @return [Vedeu::Stream]
      # @raise [Vedeu::InvalidSyntax] The required block was not given.
      def colour(attributes = {}, &block)
        define_stream(attributes, &block)
      end

      # @param value [String] The HTML/CSS colour.
      # @param block [Proc]
      # @return [Vedeu::Stream]
      # @raise [Vedeu::InvalidSyntax] The required block was not given.
      def foreground(value, &block)
        define_stream({ foreground: value }, &block)
      end
      alias_method :fg, :foreground

      # @param value [Symbol]
      # @param block [Proc]
      # @return [Vedeu::Stream]
      def style(value, &block)
        define_stream({ style: value }, &block)
      end

      private

      # @see Vedeu::Templating::Helpers#colour
      def define_stream(attributes = {}, &block)
        fail Vedeu::InvalidSyntax, 'block not given' unless block_given?

        encode(
          Vedeu::Stream.build(colour: Vedeu::Colour.new(attributes),
                              style:  Vedeu::Style.new(attributes[:style]),
                              value:  block.call))
      end

      # @param data [String]
      # @return [String]
      def encode(data)
        Vedeu::Templating::Encoder.process(data)
      end

    end # Helpers

  end # Templating

end # Vedeu

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
vedeu-0.5.4	lib/vedeu/templating/helpers.rb
vedeu-0.5.3	lib/vedeu/templating/helpers.rb
vedeu-0.5.2	lib/vedeu/templating/helpers.rb
vedeu-0.5.1	lib/vedeu/templating/helpers.rb
vedeu-0.5.0	lib/vedeu/templating/helpers.rb