tty 0.0.11 → 0.1.0

data/lib/tty/table/indentation.rb

@@ -1,8 +1,7 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
   class Table
-
     # A class responsible for indenting table representation
     class Indentation
 
@@ -48,7 +47,6 @@ module TTY
         line = line.is_a?(Array) ? line[0] : line
         line.insert(0, indentation) if line
       end
-
     end # Indentation
   end # Table
 end # TTY

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

@@ -1,10 +1,11 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
   class Table
     module Operation
-
       # A class representing an alignment of cell data.
+      #
+      # @api private
       class Alignment
         include TTY::Coercion
 
@@ -27,7 +28,7 @@ module TTY
         #   raise if the alignment is not supported type
         #
         # @api private
-        def initialize(type=nil)
+        def initialize(type = nil)
           @type = coerce_to((type || LEFT), Symbol, :to_sym)
           assert_valid_type
         end
@@ -41,9 +42,8 @@ module TTY
         #
         # @api private
         def assert_valid_type
-          unless supported.include? type
-            raise TypeError, "Alignment must be one of: #{supported.join(' ')}"
-          end
+          return if supported.include?(type)
+          fail TypeError, "Alignment must be one of: #{supported.join(' ')}"
         end
 
         # List supported alignment types
@@ -67,7 +67,7 @@ module TTY
         # @return [String] aligned
         #
         # @api public
-        def format(field, column_width, space='')
+        def format(field, column_width, space = '')
           case type
           when :left
             "%-#{column_width}s#{space}" % field.to_s
@@ -78,7 +78,7 @@ module TTY
           end
         end
 
-      private
+        private
 
         # Center aligns field
         #
@@ -101,7 +101,6 @@ module TTY
             "#{field}#{space}"
           end
         end
-
       end # Alignment
     end # Operation
   end # Table

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

@@ -1,15 +1,17 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
   class Table
     module Operation
-
       # A class which responsiblity is to align table rows and header.
       class AlignmentSet < Vector
 
         attr_reader :widths
 
-        def initialize(aligns, widths=nil)
+        # Initialize an AlignmentSet
+        #
+        # @api private
+        def initialize(aligns, widths = nil)
           @elements = convert_to_array(aligns)
           @widths   = widths
         end
@@ -48,7 +50,7 @@ module TTY
           align_field(field, col)
         end
 
-      private
+        private
 
         # Align each field in a row
         #
@@ -68,7 +70,6 @@ module TTY
           alignment    = Alignment.new(field.align || self[col])
           field.value  = alignment.format(field, column_width)
         end
-
       end # AlignmentSet
     end # Operation
   end # Table

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

@@ -1,10 +1,11 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
   class Table
     module Operation
-
       # A class responsible for escaping special chars in a table field
+      #
+      # @api private
       class Escape
 
         # Escape special characters in a table field
@@ -23,7 +24,6 @@ module TTY
             val.dump.gsub('"', '')
           end
         end
-
       end # Escape
     end # Operation
   end # Table

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

@@ -1,12 +1,12 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
   class Table
     module Operation
-
       # A class responsible for transforming table field
+      #
+      # @api private
       class Filter
-
         # Initialize a Filter
         #
         # @api public
@@ -28,7 +28,6 @@ module TTY
         def call(field, row, col)
           field.value = @filter.call(field.value, row, col)
         end
-
       end # Filter
     end # Operation
   end # Table

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

@@ -1,10 +1,11 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
   class Table
     module Operation
-
       # A class responsible for shortening text.
+      #
+      # @api private
       class Truncation
 
         attr_reader :widths
@@ -48,7 +49,6 @@ module TTY
         def truncate(string, width)
           TTY::Text.truncate(string, width)
         end
-
       end # Truncation
     end # Operation
   end # Table

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

@@ -1,10 +1,11 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
   class Table
     module Operation
-
       # A class responsible for wrapping text.
+      #
+      # @api private
       class Wrapped
 
         attr_reader :widths
@@ -51,9 +52,7 @@ module TTY
         def wrap(string, width)
           TTY::Text.wrap(string, width, padding: padding)
         end
-
       end # Wrapped
     end # Operation
   end # Table
 end # TTY
-

data/lib/tty/table/operations.rb

@@ -1,17 +1,24 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
   class Table
-
-    # A class holding table field operations
+    # A class holding table field operations.
+    #
+    # @api private
     class Operations
-
       # The table
       #
       # @api private
       attr_reader :table
       private :table
 
+      # Available operations
+      #
+      # @return [Hash]
+      #
+      # @api public
+      attr_reader :operations
+
       # Initialize Operations
       #
       # @param [TTY::Table] table
@@ -20,23 +27,14 @@ module TTY
       # @return [Object]
       #
       # @api public
-      def initialize(table, renderer=nil)
-        @table = table
-        @renderer = renderer # will be available to each operation
-      end
-
-      # Available operations
-      #
-      # @return [Hash]
-      #
-      # @api public
-      def operations
-        @operations ||= Hash.new { |hash, key| hash[key] = [] }
+      def initialize(table)
+        @table      = table
+        @operations = Hash.new { |hash, key| hash[key] = [] }
       end
 
       # Add operation
       #
-      # @param [Symbol] type
+      # @param [Symbol] operation_type
       #   the operation type
       # @param [Object] object
       #   the callable object
@@ -44,8 +42,8 @@ module TTY
       # @return [Hash]
       #
       # @api public
-      def add(type, object)
-        operations[type] << object
+      def add(operation_type, object)
+        operations[operation_type] << object
       end
 
       # Apply operations to a table row
@@ -59,14 +57,13 @@ module TTY
       #
       # @api public
       def run_operations(*args)
-        types = args
+        operation_types = args
         table.each_with_index do |val, row, col|
-          types.each do |type|
+          operation_types.each do |type|
             operations[type].each { |op| op.call(val, row, col) }
           end
         end
       end
-
     end # Operations
   end # Table
 end # TTY

data/lib/tty/table/orientation.rb

@@ -1,11 +1,11 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
   class Table
-
     # A class representing table orientation
+    #
+    # @api private
     class Orientation
-
       # The name for the orientation
       #
       # @api public
@@ -30,7 +30,8 @@ module TTY
         when /v|ert(ical)?/i
           Vertical.new :vertical
         else
-          raise InvalidOrientationError, "orientation must be one of :horizontal, :vertical"
+          fail InvalidOrientationError,
+               'orientation must be one of :horizontal, :vertical'
         end
       end
 
@@ -51,7 +52,6 @@ module TTY
       def horizontal?
         name == :horizontal
       end
-
     end # Orientation
   end # Table
 end # TTY

data/lib/tty/table/orientation/horizontal.rb

@@ -1,21 +1,25 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
   class Table
-
     # A class representing table orientation
     class Orientation
-
       # A class responsible for horizontal table transformation
       class Horizontal < Orientation
-
+        # Rotate table horizontally
+        #
+        # @param [Table] table
+        #
+        # @return [nil]
+        #
+        # @api public
         def transform(table)
           table.rotate_horizontal
         end
 
         # Slice vertical table data into horizontal
         #
-        # @param [TTY::Table] table
+        # @param [Table] table
         #
         # @api public
         def slice(table)
@@ -38,7 +42,6 @@ module TTY
           end
           [head, body]
         end
-
       end # Horizontal
     end # Orientation
   end # Table

data/lib/tty/table/orientation/vertical.rb

@@ -1,21 +1,25 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
   class Table
-
     # A class representing table orientation
     class Orientation
-
       # A class responsible for vertical table transformation
       class Vertical < Orientation
-
+        # Rotate table vertically
+        #
+        # @param [Table] table
+        #
+        # @return [nil]
+        #
+        # @api public
         def transform(table)
           table.rotate_vertical
         end
 
         # Slice horizontal table data into vertical
         #
-        # @param [TTY::Table] table
+        # @param [Table] table
         #
         # @api public
         def slice(table)
@@ -24,11 +28,10 @@ module TTY
 
           head = header ? header : (0..row_size).map { |n| (n + 1).to_s }
 
-          (0...row_size).inject([]) do |array, index|
+          (0...row_size).reduce([]) do |array, index|
             array + head.zip(table.rows[index]).map { |row| table.to_row(row) }
           end
         end
-
       end # Vertical
     end # Orientation
   end # Table

data/lib/tty/table/padder.rb

@@ -1,12 +1,18 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
   class Table
-
     # A class responsible for processing table field padding
+    #
+    # Used internally by {Table::Renderer}
+    #
+    # @api private
     class Padder
       include TTY::Equatable
 
+      # Padding for the table cells
+      #
+      # @return [Array[Integer]]
       attr_reader :padding
 
       # Initialize a Padder
@@ -18,15 +24,32 @@ module TTY
 
       # Parse padding options
       #
+      # Turn possible values into 4 element array
+      #
+      # @example
+      #   padder = TTY::Table::Padder.parse(5)
+      #   padder.padding # => [5, 5, 5, 5]
+      #
       # @param [Object] value
       #
       # @return [TTY::Padder]
+      #   the new padder with padding values
       #
       # @api public
       def self.parse(value = nil)
-        return value if value.kind_of?(self)
+        return value if value.is_a?(self)
 
-        padding = if value.class <= Numeric
+        new(convert_to_ary(value))
+      end
+
+      # Convert value to 4 element array
+      #
+      # @return [Array[Integer]]
+      #   the 4 element padding array
+      #
+      # @api private
+      def self.convert_to_ary(value)
+        if value.class <= Numeric
           [value, value, value, value]
         elsif value.nil?
           []
@@ -35,9 +58,8 @@ module TTY
         elsif value.size == 4
           value
         else
-          raise ArgumentError, 'Wrong :padding parameter, must be an array'
+          fail ArgumentError, 'Wrong :padding parameter, must be an array'
         end
-        new(padding)
       end
 
       # Top padding
@@ -53,6 +75,8 @@ module TTY
       #
       # @param [Integer] val
       #
+      # @return [nil]
+      #
       # @api public
       def top=(value)
         @padding[0] = value
@@ -89,6 +113,8 @@ module TTY
       #
       # @param [Integer] value
       #
+      # @return [nil]
+      #
       # @api public
       def bottom=(value)
         @padding[2] = value
@@ -107,6 +133,8 @@ module TTY
       #
       # @param [Integer] value
       #
+      # @return [nil]
+      #
       # @api public
       def left=(value)
         @padding[3] = value
@@ -114,6 +142,8 @@ module TTY
 
       # Check if padding is set
       #
+      # @return [Boolean]
+      #
       # @api public
       def empty?
         padding.empty?
@@ -125,7 +155,7 @@ module TTY
       #
       # @api public
       def vertical?
-        top.nonzero? or bottom.nonzero?
+        top.nonzero? || bottom.nonzero?
       end
 
       # Check if horizontal padding is applied
@@ -134,9 +164,17 @@ module TTY
       #
       # @api public
       def horizontal?
-        left.nonzero? or right.nonzero?
+        left.nonzero? || right.nonzero?
       end
 
+      # String represenation of this padder with padding values
+      #
+      # @return [String]
+      #
+      # @api public
+      def to_s
+        inspect
+      end
     end # Padder
   end # Table
 end # TTY