tty 0.0.11 → 0.1.0

data/lib/tty/table/border.rb

@@ -1,8 +1,7 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
   class Table
-
     # Abstract base class that is responsible for building the table border.
     class Border
       include Unicode
@@ -43,7 +42,7 @@ module TTY
       # @api private
       def initialize(column_widths, options = nil)
         if self.class == Border
-          raise NotImplementedError, "#{self} is an abstract class"
+          fail NotImplementedError, "#{self} is an abstract class"
         else
           @widths = column_widths
           @border = TTY::Table::BorderOptions.from options
@@ -215,7 +214,6 @@ module TTY
           left + widths.map { |width| line * width }.join(intersection) + right
         end
       end
-
     end # Border
   end # Table
 end # TTY

data/lib/tty/table/border/ascii.rb

@@ -1,10 +1,11 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
   class Table
     class Border
-
       # A class that represents an ascii border.
+      #
+      # @api private
       class ASCII < Border
 
         def_border do

data/lib/tty/table/border/null.rb

@@ -1,9 +1,8 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
   class Table
     class Border
-
       # A class that represents no border.
       class Null < Border
 
@@ -32,7 +31,6 @@ module TTY
         def bottom_line
           border ? super : nil
         end
-
       end # Null
     end # Border
   end # Table

data/lib/tty/table/border/row_line.rb

@@ -1,12 +1,10 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
   class Table
     class Border
-
       # A class for a table row line chars manipulation
       class RowLine < Struct.new(:left, :center, :right)
-
         # Colorize characters with a given style
         #
         # @api public
@@ -14,7 +12,6 @@ module TTY
           colorized_chars = Border.set_color(style, right, center, left)
           self.right, self.center, self.left = colorized_chars
         end
-
       end # RowLine
     end # Border
   end # Table

data/lib/tty/table/border/unicode.rb

@@ -1,10 +1,11 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
   class Table
     class Border
-
       # A class that represents a unicode border.
+      #
+      # @api private
       class Unicode < Border
 
         def_border do

data/lib/tty/table/border_dsl.rb

@@ -1,15 +1,21 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
   class Table
-
     # A class responsible for bulding and modifying border
+    #
+    # Used internally by {Table::Border} to allow for building custom border
+    # through DSL
+    # @api private
     class BorderDSL
       extend TTY::Delegatable
 
+      # Border options
+      #
+      # @return [Table::BorderOptions]
       attr_reader :options
 
-      delegatable_method :options, :characters, :style, :separator
+      delegatable_method :options, :characters, :style
 
       # Initialize a BorderDSL
       #
@@ -19,7 +25,7 @@ module TTY
       # @return [undefined]
       #
       # @api private
-      def initialize(characters=nil, &block)
+      def initialize(characters = nil, &block)
         @options = TTY::Table::BorderOptions.new
         @options.characters = characters if characters
         yield_or_eval(&block) if block_given?
@@ -46,7 +52,7 @@ module TTY
       #
       # @api public
       def separator(value)
-        options.separator = value
+        value ? options.separator = value : options.separator
       end
 
       # Set top border character
@@ -229,19 +235,17 @@ module TTY
         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
+      private
 
+      # Evaluate block
+      #
+      # @return [Table]
+      #
+      # @api private
+      def yield_or_eval(&block)
+        return unless block
+        block.arity > 0 ? yield(self) : instance_eval(&block)
+      end
     end # BorderDSL
-
   end # Table
 end # TTY

data/lib/tty/table/border_options.rb

@@ -1,11 +1,13 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
   class Table
-
     # A class that represents table border options
+    #
+    # Used internally by {Table::Border} to manage options such as style
+    #
+    # @api private
     class BorderOptions < Struct.new(:characters, :separator, :style)
-
       # Initialize a BorderOptions
       #
       # @api public
@@ -30,7 +32,7 @@ module TTY
       # @api public
       def update(obj)
         obj.each_pair do |key, value|
-          self.send("#{key}=", value)
+          send("#{key}=", value)
         end
         self
       end
@@ -46,7 +48,6 @@ module TTY
         end
         hash
       end
-
     end # BorderOptions
   end # Table
 end # TTY

data/lib/tty/table/column_set.rb

@@ -1,9 +1,12 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
   class Table
-
-    # A class that represents table columns properties.
+    # A class that represents table column properties.
+    #
+    # Used by {Table} to manage column sizing.
+    #
+    # @api private
     class ColumnSet
       include Equatable
 
@@ -48,10 +51,12 @@ module TTY
       # @api public
       def self.assert_widths(column_widths, table_widths)
         if column_widths.empty?
-          raise InvalidArgument, 'Value for :column_widths must be a non-empty array'
+          fail InvalidArgument, 'Value for :column_widths must be ' \
+                                 'a non-empty array'
         end
         if column_widths.size != table_widths
-          raise InvalidArgument, 'Value for :column_widths must match table column count'
+          fail InvalidArgument, 'Value for :column_widths must match ' \
+                                 'table column count'
         end
       end
 
@@ -74,7 +79,7 @@ module TTY
         when NilClass
           new(table).extract_widths
         else
-          raise TypeError, 'Invalid type for column widths'
+          fail TypeError, 'Invalid type for column widths'
         end
       end
 
@@ -111,7 +116,6 @@ module TTY
       def self.find_maximum(data, index)
         data.map { |row| (value = row.call(index)) ? value.length : 0 }.max
       end
-
     end # ColumnSet
   end # Table
 end # TTY

data/lib/tty/table/columns.rb

@@ -1,9 +1,12 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
   class Table
-
-    # A class responsible for enforcing column constraints
+    # A class responsible for enforcing column constraints.
+    #
+    # Used internally by {Renderer::Basic} to enforce correct column widths.
+    #
+    # @api private
     class Columns
 
       attr_reader :table
@@ -16,7 +19,7 @@ module TTY
 
       # Initialize a Columns
       #
-      # @param [TTY::Table::Renderer]
+      # @param [TTY::Table::Renderer] renderer
       #
       # @api public
       def initialize(renderer)
@@ -60,14 +63,16 @@ module TTY
         renderer.column_widths.inject(0, &:+) + border_size
       end
 
-      # Return the constrained column widths. Account for table field widths
-      # and any user defined constraints on the table width.
+      # Return the constrained column widths.
+      #
+      # Account for table field widths and any user defined
+      # constraints on the table width.
       #
       # @api public
       def enforce
         assert_minimum_width
 
-        if not renderer.padding.empty?
+        unless renderer.padding.empty?
           renderer.column_widths = adjust_padding
         end
 
@@ -99,9 +104,10 @@ module TTY
       #
       # @api private
       def rotate
-        TTY.shell.warn 'The table size exceeds the currently set width.' +
-        'To avoid error either. Defaulting to vertical orientation.'
-        table.orientation= :vertical
+        TTY.shell.warn 'The table size exceeds the currently set width.' \
+                       'To avoid error either. Defaulting to vertical ' \
+                       'orientation.'
+        table.orientation = :vertical
         table.rotate
       end
 
@@ -138,11 +144,9 @@ module TTY
       # @api private
       def assert_minimum_width
         width = renderer.width
-        if width <= minimum_width
-          raise ResizeError,
-            "Table's width is too small to contain the content " +
-            "(min width #{minimum_width}, currently set #{width})"
-        end
+        return unless width <= minimum_width
+        fail ResizeError, "Table's width is too small to contain the content " \
+                          "(min width #{minimum_width}, currently set #{width})"
       end
 
       # Distribute remaining width to meet the total width requirement.
@@ -161,7 +165,6 @@ module TTY
           width + per_field_width + extra[index]
         end
       end
-
     end # Columns
   end # Table
 end # TTY

data/lib/tty/table/error.rb

@@ -1,8 +1,7 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
   class Table
-
     # Raised when inserting into table with a mismatching row(s)
     class DimensionMismatchError < ArgumentError; end
 
@@ -15,6 +14,5 @@ module TTY
         super("element at(#{i},#{j}) not found")
       end
     end
-
   end # Table
 end # TTY

data/lib/tty/table/field.rb

@@ -1,9 +1,12 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
   class Table
-
     # A class that represents a unique element in a table.
+    #
+    # Used internally by {Table::Row} to define internal structure.
+    #
+    # @api private
     class Field
       include Equatable
 
@@ -12,6 +15,11 @@ module TTY
       # @api public
       attr_reader :value
 
+      # The name for the value
+      #
+      # @api public
+      attr_reader :name
+
       # TODO: Change to :content to separate value from formatted string
       attr_writer :value
 
@@ -33,18 +41,31 @@ module TTY
       # Initialize a Field
       #
       # @example
-      #   field = new TTY::Table::Field 'a1'
+      #   field = TTY::Table::Field.new 'a1'
       #   field.value  # => a1
       #
-      #   field = new TTY::Table::Field {:value => 'a1'}
+      # @example
+      #   field = TTY::Table::Field.new value: 'a1'
       #   field.value  # => a1
       #
-      #   field = new TTY::Table::Field {:value => 'a1', :align => :center}
+      # @example
+      #   field = TTY::Table::Field.new value: 'a1', align: :center
       #   field.value  # => a1
       #   field.align  # => :center
       #
       # @api private
       def initialize(value)
+        options  = extract_options(value)
+        @width   = options.fetch(:width) { @value.to_s.size }
+        @align   = options.fetch(:align) { nil }
+        @colspan = options.fetch(:colspan) { 1 }
+        @rowspan = options.fetch(:rowspan) { 1 }
+      end
+
+      # Extract options and set value
+      #
+      # @api private
+      def extract_options(value)
         if value.class <= Hash
           options = value
           @value = options.fetch(:value)
@@ -52,10 +73,7 @@ module TTY
           @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 }
+        options
       end
 
       # Return the width this field would normally have bar other contraints
@@ -69,8 +87,9 @@ module TTY
         @height
       end
 
-      # Return number of lines this value spans. A distinction is being made
-      # between escaped and non-escaped strings.
+      # Return number of lines this value spans.
+      #
+      # A distinction is being made between escaped and non-escaped strings.
       #
       # @return [Array[String]]
       #
@@ -115,7 +134,6 @@ module TTY
       def to_s
         value
       end
-
     end # Field
   end # Table
 end # TTY

data/lib/tty/table/header.rb

@@ -1,11 +1,10 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 require 'tty/vector'
 require 'forwardable'
 
 module TTY
   class Table
-
     # Convert an Array row into Header
     #
     # @return [TTY::Table::Header]
@@ -15,7 +14,7 @@ module TTY
       Header.new(row)
     end
 
-    # A set of header elements that correspond with values in each row
+    # A set of header elements that correspond to values in each row
     class Header < Vector
       include Equatable
       extend Forwardable
@@ -35,20 +34,26 @@ module TTY
       # @return [undefined]
       #
       # @api public
-      def initialize(attributes=[])
+      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
       #
+      # @param [String,Hash] attribute
+      #   the attribute value to convert to field object
+      #
       # @api public
-      def to_field(options=nil)
-        Field.new(options)
+      def to_field(attribute = nil)
+        Field.new(attribute)
       end
 
       # Lookup a column in the header given a name
       #
+      # @param [Integer, String] attribute
+      #   the attribute to look up by
+      #
       # @api public
       def [](attribute)
         case attribute
@@ -56,7 +61,8 @@ module TTY
           @attributes[attribute].value
         else
           @attribute_for.fetch(to_field(attribute)) do |header_name|
-            raise UnknownAttributeError, "the header '#{header_name.value}' is unknown"
+            fail UnknownAttributeError,
+                 "the header '#{header_name.value}' is unknown"
           end
         end
       end
@@ -75,11 +81,13 @@ module TTY
       #
       # @api public
       def []=(attribute, value)
-        self.attributes[attribute] = to_field(value)
+        attributes[attribute] = to_field(value)
       end
 
       # Size of the header
       #
+      # @return [Integer]
+      #
       # @api public
       def size
         to_ary.size
@@ -97,6 +105,8 @@ module TTY
 
       # Convert the Header into an Array
       #
+      # @return [Array]
+      #
       # @api public
       def to_ary
         attributes.map { |attr| attr.value if attr }
@@ -118,7 +128,6 @@ module TTY
       def to_hash
         to_a.hash
       end
-
     end # Header
   end # Table
 end # TTY