tty 0.0.7 → 0.0.8

data/lib/tty/table/border_dsl.rb

@@ -0,0 +1,247 @@
+# -*- encoding: utf-8 -*-
+
+module TTY
+  class Table
+
+    # A class responsible for bulding and modifying border
+    class BorderDSL
+      extend TTY::Delegatable
+
+      attr_reader :options
+
+      delegatable_method :options, :characters, :style, :separator
+
+      # Initialize a BorderDSL
+      #
+      # @param [Hash] characters
+      #   the border characters
+      #
+      # @return [undefined]
+      #
+      # @api private
+      def initialize(characters=nil, &block)
+        @options = TTY::Table::BorderOptions.new
+        @options.characters = characters if characters
+        yield_or_eval &block if block_given?
+      end
+
+      # Apply style color to the border
+      #
+      # @param [Symbol] style
+      #   the style color for the border
+      #
+      # @return [undefined]
+      #
+      # @api public
+      def style(value)
+        options.style = value
+      end
+
+      # Apply table tuple separator
+      #
+      # @param [Symbol] separator
+      #   the table tuple separator
+      #
+      # @return [undefined]
+      #
+      # @api public
+      def separator(value)
+        options.separator = value
+      end
+
+      # Set top border character
+      #
+      # @param [String] value
+      #   the character value
+      #
+      # @return [undefined]
+      #
+      # @api public
+      def top(value)
+        options.characters['top'] = value
+      end
+
+      # Set top middle border character
+      #
+      # @param [String] value
+      #   the character value
+      #
+      # @return [undefined]
+      #
+      # @api public
+      def top_mid(value)
+        options.characters['top_mid'] = value
+      end
+
+      # Set top left corner border character
+      #
+      # @param [String] value
+      #   the character value
+      #
+      # @return [undefined]
+      #
+      # @api public
+      def top_left(value)
+        options.characters['top_left'] = value
+      end
+
+      # Set top right corner border character
+      #
+      # @param [String] value
+      #   the character value
+      #
+      # @return [undefined]
+      #
+      # @api public
+      def top_right(value)
+        options.characters['top_right'] = value
+      end
+
+      # Set bottom border character
+      #
+      # @param [String] value
+      #   the character value
+      #
+      # @return [undefined]
+      #
+      # @api public
+      def bottom(value)
+        options.characters['bottom'] = value
+      end
+
+      # Set bottom middle border character
+      #
+      # @param [String] value
+      #   the character value
+      #
+      # @return [undefined]
+      #
+      # @api public
+      def bottom_mid(value)
+        options.characters['bottom_mid'] = value
+      end
+
+      # Set bottom left corner border character
+      #
+      # @param [String] value
+      #   the character value
+      #
+      # @return [undefined]
+      #
+      # @api public
+      def bottom_left(value)
+        options.characters['bottom_left'] = value
+      end
+
+      # Set bottom right corner border character
+      #
+      # @param [String] value
+      #   the character value
+      #
+      # @return [undefined]
+      #
+      # @api public
+      def bottom_right(value)
+        options.characters['bottom_right'] = value
+      end
+
+      # Set middle border character
+      #
+      # @param [String] value
+      #   the character value
+      #
+      # @return [undefined]
+      #
+      # @api public
+      def mid(value)
+        options.characters['mid'] = value
+      end
+
+      # Set middle border character
+      #
+      # @param [String] value
+      #   the character value
+      #
+      # @return [undefined]
+      #
+      # @api public
+      def mid_mid(value)
+        options.characters['mid_mid'] = value
+      end
+
+      # Set middle left corner border character
+      #
+      # @param [String] value
+      #   the character value
+      #
+      # @return [undefined]
+      #
+      # @api public
+      def mid_left(value)
+        options.characters['mid_left'] = value
+      end
+
+      # Set middle right corner border character
+      #
+      # @param [String] value
+      #   the character value
+      #
+      # @return [undefined]
+      #
+      # @api public
+      def mid_right(value)
+        options.characters['mid_right'] = value
+      end
+
+      # Set left border character
+      #
+      # @param [String] value
+      #   the character value
+      #
+      # @return [undefined]
+      #
+      # @api public
+      def left(value)
+        options.characters['left'] = value
+      end
+
+      # Set center border character
+      #
+      # @param [String] value
+      #   the character value
+      #
+      # @return [undefined]
+      #
+      # @api public
+      def center(value)
+        options.characters['center'] = value
+      end
+
+      # Set right border character
+      #
+      # @param [String] value
+      #   the character value
+      #
+      # @return [undefined]
+      #
+      # @api public
+      def right(value)
+        options.characters['right'] = value
+      end
+
+  private
+
+    # Evaluate block
+    #
+    # @return [Table]
+    #
+    # @api private
+    def yield_or_eval(&block)
+      return unless block
+      block.arity > 0 ? yield(self) : self.instance_eval(&block)
+    end
+
+    end # BorderDSL
+
+  end # Table
+end # TTY

data/lib/tty/table/border_options.rb

@@ -0,0 +1,52 @@
+# -*- encoding: utf-8 -*-
+
+module TTY
+  class Table
+
+    # A class that represents table border options
+    class BorderOptions < Struct.new(:characters, :separator, :style)
+
+      # Initialize a BorderOptions
+      #
+      # @api public
+      def initialize(*args)
+        super(*args)
+        self.characters = {} unless characters
+      end
+
+      # Create options instance from hash
+      #
+      # @api public
+      def self.from(value)
+        value ? new.update(value) : new
+      end
+
+      # Set all accessors with hash attributes
+      #
+      # @param [Hash, BorderOptions] obj
+      #
+      # @return [BorderOptions]
+      #
+      # @api public
+      def update(obj)
+        obj.each_pair do |key, value|
+          self.send("#{key}=", value)
+        end
+        self
+      end
+
+      # Convert to hash
+      #
+      # @api public
+      def to_hash
+        hash = {}
+        members.each do |key|
+          value = send(key)
+          hash[key.to_sym] = value if value
+        end
+        hash
+      end
+
+    end # BorderOptions
+  end # Table
+end # TTY

data/lib/tty/table/field.rb

@@ -0,0 +1,101 @@
+# -*- encoding: utf-8 -*-
+
+module TTY
+  class Table
+
+    # A class that represents a unique element in a table.
+    class Field
+      include Equatable
+
+      # The value inside the field
+      #
+      # @api public
+      attr_reader :value
+
+      # TODO: Change to :content to separate value from formatted string
+      attr_writer :value
+
+      # The field value width
+      #
+      # @api public
+      attr_reader :width
+
+      # Number of columns this field spans. Defaults to 1.
+      #
+      attr_reader :colspan
+
+      # Number of rows this field spans. Defaults to 1.
+      #
+      attr_reader :rowspan
+
+      attr_reader :align
+
+      # Initialize a Field
+      #
+      # @example
+      #   field = new TTY::Table::Field 'a1'
+      #   field.value  # => a1
+      #
+      #   field = new TTY::Table::Field {:value => 'a1'}
+      #   field.value  # => a1
+      #
+      #   field = new TTY::Table::Field {:value => 'a1', :align => :center}
+      #   field.value  # => a1
+      #   field.align  # => :center
+      #
+      # @api private
+      def initialize(value)
+        if value.class <= Hash
+          options = value
+          @value = options.fetch(:value)
+        else
+          @value = value
+          options = {}
+        end
+        @width   = options.fetch(:width) { @value.to_s.size }
+        @align   = options.fetch(:align) { nil }
+        @colspan = options.fetch(:colspan) { 1 }
+        @rowspan = options.fetch(:rowspan) { 1 }
+      end
+
+      # Return the width this field would normally have bar other contraints
+      #
+      # @api public
+      def value_width
+        @width
+      end
+
+      def value_height
+        @height
+      end
+
+      def height
+        lines.size
+      end
+
+      # Return number of lines this value spans
+      #
+      def lines
+        value.to_s.split(/\n/)
+      end
+
+      def longest_line
+        lines.max_by(&:length).size
+      end
+
+      # Render value inside this field box
+      #
+      # @api public
+      def render
+      end
+
+      # Return field value
+      #
+      # @api public
+      def to_s
+        value
+      end
+
+    end # Field
+  end # Table
+end # TTY

data/lib/tty/table/header.rb

@@ -0,0 +1,115 @@
+# -*- encoding: utf-8 -*-
+
+require 'tty/vector'
+require 'forwardable'
+
+module TTY
+  class Table
+
+    # Convert an Array row into Header
+    #
+    # @return [TTY::Table::Header]
+    #
+    # @api private
+    def to_header(row)
+      Header.new(row)
+    end
+
+    # A set of header elements that correspond with values in each row
+    class Header < Vector
+      include Equatable
+      extend Forwardable
+
+      def_delegators :@attributes, :join, :map, :map!
+
+      # The header attributes
+      #
+      # @return [Array]
+      #
+      # @api private
+      attr_reader :attributes
+
+      # Initialize a Header
+      #
+      # @return [undefined]
+      #
+      # @api public
+      def initialize(attributes=[])
+        @attributes    = attributes.map { |attr| to_field(attr) }
+        @attribute_for = Hash[@attributes.each_with_index.map.to_a]
+      end
+
+      # Instantiates a new field
+      #
+      # @api public
+      def to_field(options=nil)
+        Field.new(options)
+      end
+
+      # Filter header names including styling background,
+      # text color and capitalization
+      #
+      #
+      def filter
+      end
+
+      # Lookup a column in the header given a name
+      #
+      # @api public
+      def [](attribute)
+        case attribute
+        when Integer
+          @attributes[attribute].value
+        else
+          @attribute_for.fetch(to_field(attribute)) do |header_name|
+            raise UnknownAttributeError, "the header '#{header_name.value}' is unknown"
+          end
+        end
+      end
+      alias :call :[]
+
+      # Set value at index
+      #
+      # @example
+      #   header[attribute] = value
+      #
+      # @api public
+      def []=(attribute, value)
+        self.attributes[attribute] = to_field(value)
+      end
+
+      # Size of the header
+      #
+      # @api public
+      def size
+        to_ary.size
+      end
+      alias :length :size
+
+      # Convert the Header into an Array
+      #
+      # @api public
+      def to_ary
+        attributes.map { |attr| attr.value if attr.value }
+      end
+
+      # Check if this header is equivalent to another header
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      def ==(other)
+        to_a == other.to_a
+      end
+      alias :eql? :==
+
+      # Provide an unique hash value
+      #
+      # @api public
+      def to_hash
+        to_a.hash
+      end
+
+    end # Header
+  end # Table
+end # TTY

data/lib/tty/table/operation/alignment_set.rb

@@ -27,13 +27,18 @@ module TTY
           map { |alignment| alignment }
         end
 
-        # Align table header
+        # Evaluate alignment of the provided row
+        #
+        # @param [Array] row
+        #  the table row
+        # @param [Hash] options
+        #  the table options
         #
         # @return [Array[String]]
         #
         # @api public
-        def align_header(header, options={})
-          align_row(header, options)
+        def call(row, options={})
+          align_row(row, options)
         end
 
         # Align the supplied rows with the correct alignment.
@@ -50,7 +55,7 @@ module TTY
 
       private
 
-        # Align each cell in a row
+        # Align each field in a row
         #
         # @param [Object] row
         #
@@ -60,14 +65,13 @@ module TTY
         #
         # @api private
         def align_row(row, options={})
-          line = []
-          row.each_with_index do |cell, index|
+          index = 0
+          row.map! do |field|
             column_width = options[:column_widths][index]
-            alignment = Alignment.new self[index]
-
-            line << alignment.format(cell, column_width)
+            alignment    = Alignment.new(field.align || self[index])
+            index += 1
+            alignment.format(field, column_width)
           end
-          line
         end
 
       end # AlignmentSet

data/lib/tty/table/operation/truncation.rb

@@ -6,7 +6,23 @@ module TTY
 
       # A class responsible for shortening text.
       class Truncation
-        include Unicode
+
+        # Apply truncation to a row
+        #
+        # @param [Array] row
+        #   the table row
+        #
+        # @return [Array[String]]
+        #
+        # @api public
+        def call(row, options={})
+          index = 0
+          row.map! do |field|
+            width = options.fetch(:column_widths, {})[index] || field.width
+            index += 1
+            field.value = truncate(field.value, width)
+          end
+        end
 
         # Shorten given string with traling character.
         #
@@ -14,22 +30,12 @@ module TTY
         #   the string to truncate
         # @param [Integer] width
         #   the maximum width
-        # @param [String] trailing
-        #   the trailing character
         #
         # @return [String]
         #
         # @api public
-        def truncate(string, width, trailing = '…')
-          as_unicode do
-            chars = string.chars.to_a
-            if chars.length < width
-              chars.join
-            else
-              traling_size = trailing.chars.to_a.size
-              ( chars[0, width - traling_size].join ) + trailing
-            end
-          end
+        def truncate(string, width)
+          TTY::Text.truncate(string, width)
         end
 
       end # Truncation

data/lib/tty/table/operation/wrapped.rb

@@ -6,7 +6,23 @@ module TTY
 
       # A class responsible for wrapping text.
       class Wrapped
-        include Unicode
+
+        # Apply truncation to a row
+        #
+        # @param [Array] row
+        #   the table row
+        #
+        # @return [Array[String]]
+        #
+        # @api public
+        def call(row, options={})
+          index = 0
+          row.map! do |field|
+            width = options.fetch(:column_widths, {})[index] || field.width
+            index += 1
+            field.value = wrap(field.value, width)
+          end
+        end
 
         # Wrap a long string according to the width.
         #
@@ -14,17 +30,12 @@ module TTY
         #   the string to wrap
         # @param [Integer] width
         #   the maximum width
-        # @param [Boolean] addnewline
-        #   add new line add the end
+        #
+        # @return [String]
         #
         # @api public
         def wrap(string, width)
-          as_unicode do
-            chars = string.chars.to_a
-            return string if chars.length <= width
-            idx = width
-            return chars[0, idx].join + "\n" + wrap(chars[idx..-1].join, width)
-          end
+          TTY::Text.wrap(string, width)
         end
 
       end # Wrapped