vedeu 0.7.4 → 0.8.0

data/lib/vedeu/dsl/geometry.rb

@@ -0,0 +1,113 @@
+module Vedeu
+
+  module DSL
+
+    # Provides DSL methods for Vedeu::Geometries::Geometry objects.
+    #
+    # @api public
+    #
+    module Geometry
+
+      # When {Vedeu::DSL::Geometry} is included in a class, the
+      # methods within this module are included as class methods on
+      # that class.
+      #
+      module ClassMethods
+
+        # Specify the geometry of an interface or view with a simple
+        # DSL.
+        #
+        #   # Standalone (preferred):
+        #   Vedeu.geometry :my_interface do
+        #     # ... see {Vedeu::Geometries::DSL}
+        #   end
+        #
+        # @param name [String|Symbol] The name of the interface or
+        #   view to which this geometry belongs.
+        # @param block [Proc]
+        # @raise [Vedeu::Error::MissingRequired|
+        #   Vedeu::Error::RequiresBlock] When a name or block
+        #   respectively are not given.
+        # @return [Vedeu::Geometries::Geometry]
+        # @see Vedeu::Geometries::DSL
+        def geometry(name = nil, &block)
+          # Alternative implementation which treats `Vedeu.geometry`
+          # as `Vedeu.geometries` if no name or block is given.
+          #
+          # if name && block_given?
+          #   Vedeu::Geometries::Geometry.build(name: name, &block).store
+          #
+          # else
+          #   Vedeu.geometries
+          #
+          # end
+
+          fail Vedeu::Error::MissingRequired unless name
+          fail Vedeu::Error::RequiresBlock unless block_given?
+
+          Vedeu::Geometries::Geometry.build(name: name, &block).store
+        end
+
+      end # ClassMethods
+
+      # When {Vedeu::DSL::Geometry} is included in a class, the
+      # methods within this module are included as instance methods on
+      # that class.
+      #
+      module InstanceMethods
+
+        # Specify the geometry of an interface or view with a simple
+        # DSL.
+        #
+        #   # As part of an interface:
+        #   Vedeu.interface :my_interface do
+        #     geometry do
+        #       # ... see {Vedeu::Geometries::DSL}
+        #     end
+        #   end
+        #
+        #   # As part of a view:
+        #   Vedeu.render do
+        #     view :my_interface do
+        #       geometry do
+        #         # ... see {Vedeu::Geometries::DSL}
+        #       end
+        #     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::DSL::Geometry::ClassMethods.geometry}.
+        # @param block [Proc]
+        # @raise [Vedeu::Error::MissingRequired|
+        #   Vedeu::Error::RequiresBlock] When a name or block
+        #   respectively are not given.
+        # @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 # InstanceMethods
+
+      # When this module is included in a class, provide ClassMethods
+      # as class methods and InstanceMethods as instance methods for
+      # the given class.
+      #
+      # @param klass [Class]
+      # @return [void]
+      def self.included(klass)
+        klass.extend(Vedeu::DSL::Geometry::ClassMethods)
+        klass.include(Vedeu::DSL::Geometry::InstanceMethods)
+      end
+
+    end # Geometry
+
+  end # DSL
+
+end # Vedeu

data/lib/vedeu/dsl/string/align.rb

@@ -0,0 +1,127 @@
+module Vedeu
+
+  module DSL
+
+    # Aligns a text value based on given options when building views.
+    #
+    # @api private
+    #
+    class Align
+
+      extend Forwardable
+      include Vedeu::Common
+
+      def_delegators :alignment,
+                     :centre_aligned?,
+                     :left_aligned?,
+                     :right_aligned?,
+                     :unaligned?
+
+      # @param value [String]
+      # @param options [Hash]
+      # @option options align [Symbol]
+      # @option options name [String|Symbol]
+      # @option options pad [String]
+      # @option options width [Fixnum]
+      # @return [Vedeu::DSL::Align]
+      def initialize(value = '', options = {})
+        @value   = value || ''
+        @options = defaults.merge!(options)
+      end
+
+      # @return [String]
+      def text
+        if unaligned?
+          value
+
+        elsif left_aligned?
+          left
+
+        elsif centre_aligned?
+          centre
+
+        elsif right_aligned?
+          right
+
+        else
+          value
+
+        end
+      end
+
+      protected
+
+      # @!attribute [r] options
+      # @return [Hash]
+      attr_reader :options
+
+      # @!attribute [r] value
+      # @return [String]
+      attr_reader :value
+
+      private
+
+      # @return [Vedeu::Coercers::Alignment]
+      def alignment
+        @_alignment ||= Vedeu::Coercers::Alignment.coerce(options[:align])
+      end
+
+      # The value padded to width, centralized.
+      #
+      # @return [String]
+      def centre
+        value.center(width, options[:pad])
+      end
+      alias_method :center, :centre
+
+      # @return [Hash]
+      def defaults
+        {
+          align: :left,
+          name:  nil,
+          pad:   ' ',
+          width: nil,
+        }
+      end
+
+      # @return [NilClass|Vedeu::Geometries::Geometry]
+      def geometry
+        @_geometry ||= Vedeu.geometries.by_name(options[:name])
+      end
+
+      # The value padded to width, left justified.
+      #
+      # @return [String]
+      def left
+        value.ljust(width, options[:pad])
+      end
+
+      # The value padded to width, right justified.
+      #
+      # @return [String]
+      def right
+        value.rjust(width, options[:pad])
+      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
+
+        else
+          value.size
+
+        end
+      end
+
+    end # Align
+
+  end # DSL
+
+end # Vedeu

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

@@ -0,0 +1,14 @@
+module Vedeu
+
+  # Provides a mechanism to help configure and use Vedeu.
+  #
+  module DSL
+
+  end # DSL
+
+end # Vedeu
+
+require 'vedeu/dsl/string/align'
+require 'vedeu/dsl/string/truncate'
+require 'vedeu/dsl/string/wordwrap'
+require 'vedeu/dsl/string/text'

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

@@ -0,0 +1,107 @@
+module Vedeu
+
+  module DSL
+
+    # Manipulates text values based on given options when building
+    # views.
+    #
+    # @api private
+    #
+    class Text
+
+      include Vedeu::Common
+
+      # @param value [String]
+      # @param options [Vedeu::DSL::Attributes]
+      # @return [Vedeu::DSL::Text]
+      def initialize(value = '', options = {})
+        @value   = value   || ''
+        @options = options || {}
+      end
+
+      # @return [Array<Vedeu::Views::Char>]
+      def chars
+        return [] unless present?(value) && string?(value)
+
+        collection
+      end
+
+      protected
+
+      # @!attribute [r] options
+      # @return [Hash<Symbol => void>]
+      attr_reader :options
+
+      # @!attribute [r] value
+      # @return [NilClass|String]
+      attr_reader :value
+
+      private
+
+      # @return [String]
+      def align
+        Vedeu::DSL::Align.new(value, options).text
+      end
+
+      # @return [NilClass|Vedeu::Coercers::Alignment]
+      def align?
+        options[:align]
+      end
+
+      # @param char [String]
+      # @return [Hash<Symbol => void>]
+      def attributes(char)
+        {
+          colour:   options[:colour],
+          name:     name,
+          parent:   parent,
+          position: nil,
+          style:    options[:style],
+          value:    char,
+        }
+      end
+
+      # @return [Array<Vedeu::Views::Char>]
+      def collection
+        text.chars.map { |char| Vedeu::Views::Char.new(attributes(char)) }
+      end
+
+      # @return [NilClass|String|Symbol]
+      def name
+        options[:name]
+      end
+
+      # @return [NilClass|void]
+      def parent
+        options[:parent]
+      end
+
+      # @return [String]
+      def text
+        if truncate?
+          truncate
+
+        elsif align?
+          align
+
+        else
+          value
+
+        end
+      end
+
+      # @return [String]
+      def truncate
+        Vedeu::DSL::Truncate.new(value, options).text
+      end
+
+      # @return [Boolean|NilClass]
+      def truncate?
+        options[:truncate]
+      end
+
+    end # Text
+
+  end # DSL
+
+end # Vedeu

data/lib/vedeu/dsl/string/truncate.rb

@@ -0,0 +1,111 @@
+module Vedeu
+
+  module DSL
+
+    # Truncates a string to an optional width, or uses the named
+    # geometry width.
+    #
+    # @api private
+    #
+    class Truncate
+
+      include Vedeu::Common
+
+      # Returns a new instance of Vedeu::DSL::Truncate.
+      #
+      # @param value [String]
+      # @param options [Hash<Symbol => Boolean|Fixnum|NilClass|String|
+      #   Symbol]
+      # @option options name [String|Symbol] The name of the geometry
+      #   to use to determine the width if the width option is not
+      #   given.
+      # @option options truncate [Boolean] Whether to truncate the
+      #   value.
+      # @option options width [Fixnum] The width of the new value.
+      # @return [Vedeu::DSL::Truncate]
+      def initialize(value = '', options = {})
+        @value   = value || ''
+        @options = defaults.merge!(options)
+      end
+
+      # @return [String]
+      def text
+        if truncate?
+          truncate
+
+        else
+          value
+
+        end
+      end
+
+      protected
+
+      # @!attribute [r] options
+      # @return [Hash<Symbol => Boolean|Fixnum|NilClass|String|
+      #   Symbol]
+      attr_reader :options
+
+      private
+
+      # @return [Hash<Symbol => Boolean|Fixnum|NilClass|String|
+      #   Symbol]
+      def defaults
+        {
+          name:     nil,
+          truncate: false,
+          width:    nil,
+        }
+      end
+
+      # @return [Vedeu::Geometries::Geometry]
+      def geometry
+        @_geometry ||= Vedeu.geometries.by_name(options[:name])
+      end
+
+      # @return [Boolean]
+      def truncate?
+        truthy?(options[:truncate]) && value.size > width
+      end
+
+      # @return [String]
+      def truncate
+        value.slice(0, width)
+      end
+
+      # @return [String]
+      def value
+        if present?(@value) && string?(@value)
+          @value
+
+        elsif present?(@value)
+          @value.to_s
+
+        else
+          ''
+
+        end
+      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
+
+        else
+          value.size
+
+        end
+      end
+
+    end # Truncate
+
+  end # DSL
+
+end # Vedeu