tty 0.0.11 → 0.1.0

data/lib/tty/support/coercion.rb

@@ -1,9 +1,8 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
   # A mixin to coerce a value into a specific class.
   module Coercion
-
     # Helper to coerce value into a specific class.
     #
     # @param [Object] object
@@ -14,18 +13,18 @@ module TTY
     #
     # @api public
     def coerce_to(object, cls, method)
-      return object if object.kind_of?(cls)
+      return object if object.is_a?(cls)
 
       begin
         result = object.__send__(method)
       rescue Exception => e
         raise TypeError, "Coercion error #{e.message}"
       end
-      unless result.kind_of? cls
-        raise TypeError, "Coercion error: obj.#{method} did not return a #{cls} (was #{result.class})"
+      unless result.is_a?(cls)
+        fail TypeError, "Coercion error: obj.#{method} did not return " \
+                        "a #{cls} (was #{result.class})"
       end
       result
     end
-
   end # Coercion
 end # TTY

data/lib/tty/support/conversion.rb

@@ -1,9 +1,10 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
-  # A mixin to allow instances conversion to different types
+  # A mixin to allow instances conversion to array type
+  #
+  # @api public
   module Conversion
-
     # Converts the object into an Array. If copy is set to true
     # a copy of object will be made.
     #
@@ -14,7 +15,7 @@ module TTY
     # @return [Array]
     #
     # @api private
-    def convert_to_array(object, copy=false)
+    def convert_to_array(object, copy = false)
       case object
       when Array
         copy ? object.dup : object
@@ -24,11 +25,11 @@ module TTY
         begin
           converted = object.to_ary
         rescue Exception => e
-          raise TTY::TypeError, "Cannot convert #{object.class} into an Array (#{e.message})"
+          raise TTY::TypeError,
+                "Cannot convert #{object.class} into an Array (#{e.message})"
         end
         converted
       end
     end
-
   end # Conversion
 end # TTY

data/lib/tty/support/delegatable.rb

@@ -1,9 +1,8 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
   # A mixin to allow delegetable methods to be added
   module Delegatable
-
     # Create delegator for each specified method
     #
     # @example
@@ -17,11 +16,13 @@ module TTY
     #
     # @api public
     def delegatable_method(source, *methods)
-      methods.each { |method| define_delegatable_method(source, method)}
+      methods.each do |method|
+        define_delegatable_method(source, method)
+      end
       self
     end
 
-  private
+    private
 
     # Create a delegator method for the method name
     #
@@ -39,6 +40,5 @@ module TTY
         end
       RUBY
     end
-
   end # Delegatable
 end # TTY

data/lib/tty/support/unicode.rb

@@ -1,4 +1,4 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
   # A mixin to provide unicode support.
@@ -19,18 +19,17 @@ module TTY
       string
     end
 
-    if "".respond_to?(:encode)
+    if ''.respond_to?(:encode)
       def as_unicode
         yield
       end
     else
       def as_unicode
-        old, $KCODE = $KCODE, "U"
+        old, $KCODE = $KCODE, 'U'
         yield
       ensure
         $KCODE = old
       end
     end
-
   end # Unicode
 end # TTY

data/lib/tty/support/utils.rb

@@ -1,4 +1,4 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
   module Utils
@@ -12,6 +12,5 @@ module TTY
       options = args.last
       options.respond_to?(:to_hash) ? options.to_hash.dup : {}
     end
-
   end # Utils
 end # TTY

data/lib/tty/system.rb

@@ -1,17 +1,16 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 require 'rbconfig'
 
 module TTY
   class System
-
     # Check if windows platform.
     #
     # @return [Boolean]
     #
     # @api public
     def self.windows?
-      RbConfig::CONFIG['host_os'] =~ /msdos|mswin|djgpp|mingw|windows/
+      match_os?(/msdos|mswin|djgpp|mingw|windows/i)
     end
 
     # Check if unix platform
@@ -20,7 +19,16 @@ module TTY
     #
     # @api public
     def self.unix?
-      RbConfig::CONFIG['host_os'] =~ /(aix|darwin|linux|(net|free|open)bsd|cygwin|solaris|irix|hpux)/i
+      match_os?(/(aix|darwin|linux|(net|free|open)bsd|cygwin|solaris|irix|hpux)/i)
+    end
+
+    # Check if platform matches given systems
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def self.match_os?(matcher)
+      !!(RbConfig::CONFIG['host_os'] =~ matcher)
     end
 
     # Find an executable in the PATH
@@ -39,7 +47,7 @@ module TTY
     #
     # @api public
     def self.exists?(name)
-      !!self.which(name)
+      !!which(name)
     end
 
     # Proxy to editor object
@@ -50,6 +58,5 @@ module TTY
     def self.editor
       TTY::System::Editor
     end
-
   end # System
 end # TTY

data/lib/tty/system/editor.rb

@@ -1,22 +1,24 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 require 'shellwords'
 
 module TTY
   class System
-
     # A class responsible for launching an editor
+    #
+    # @api private
     class Editor
-
       attr_reader :file
 
+      @command = nil
+
       # Initialize an Editor
       #
       # @param [String] file
       #
       # @api public
       def initialize(file)
-        @file = file
+        @file    = file
       end
 
       # List possible executable for editor command
@@ -25,7 +27,7 @@ module TTY
       #
       # @api private
       def self.executables
-        [ ENV['VISUAL'], ENV['EDITOR'], 'vi', 'emacs' ]
+        [ENV['VISUAL'], ENV['EDITOR'], 'vi', 'emacs']
       end
 
       # Find available command
@@ -36,7 +38,7 @@ module TTY
       #
       # @api public
       def self.available(*commands)
-        commands = commands.empty? ? self.executables : commands
+        commands = commands.empty? ? executables : commands
         commands.compact.uniq.find { |cmd| System.exists?(cmd) }
       end
 
@@ -48,7 +50,7 @@ module TTY
       #
       # @api public
       def self.command(*commands)
-        @command = if (@command && commands.empty?)
+        @command = if @command && commands.empty?
           @command
         else
           available(*commands)
@@ -66,9 +68,8 @@ module TTY
       #
       # @api public
       def self.open(file)
-        unless self.command
-          raise CommandInvocationError, "Please export $VISUAL or $EDITOR"
-          exit 1
+        unless command
+          fail CommandInvocationError, 'Please export $VISUAL or $EDITOR'
         end
 
         new(file).invoke
@@ -80,7 +81,14 @@ module TTY
       #
       # @api private
       def build
-        escaped_file = if System.unix?
+        "#{Editor.command} #{escape_file}"
+      end
+
+      # Escape file path
+      #
+      # @api private
+      def escape_file
+        if System.unix?
           # Escape file string so it can be safely used in a Bourne shell
           Shellwords.shellescape(file)
         elsif System.windows?
@@ -88,7 +96,6 @@ module TTY
         else
           file
         end
-        "#{Editor.command} #{escaped_file}"
       end
 
       # Inovke editor command in a shell
@@ -99,13 +106,9 @@ module TTY
       def invoke
         command_invocation = build
         status = system(*Shellwords.split(command_invocation))
-
-        unless status
-          raise CommandInvocationError, "`#{command_invocation}` failed with status: #{$? ? $?.exitstatus : nil}"
-          exit status
-        end
+        return status if status
+        fail CommandInvocationError, "`#{command_invocation}` failed with status: #{$? ? $?.exitstatus : nil}"
       end
-
     end # Editor
   end # System
 end # TTY

data/lib/tty/system/which.rb

@@ -1,11 +1,10 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
   class System
-
     # A class responsible for finding an executable in the PATH
     class Which
-
+      # The command to find
       attr_reader :command
 
       # Initialize a Which
@@ -38,7 +37,7 @@ module TTY
             return exec if File.executable? exec
           end
         end
-        return nil
+        nil
       end
 
       # Find default system paths
@@ -47,7 +46,6 @@ module TTY
       def default_system_path
         ENV['PATH'].split(File::PATH_SEPARATOR)
       end
-
     end # Which
   end # System
 end # TTY

data/lib/tty/table.rb

@@ -1,4 +1,4 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 require 'forwardable'
 require 'tty/table/renderer'
@@ -8,7 +8,6 @@ require 'tty/table/header'
 require 'tty/table/row'
 
 module TTY
-
   # A core class intended for storing data in a structured, tabular form.
   # Once the data is stored in a TTY::Table various operations can be performed
   # before the information is dumped into a stdout.
@@ -60,11 +59,11 @@ module TTY
     # Create a new Table where each argument is a row
     #
     # @example
-    #   table = TTY::Table.new[['a1', 'a2'], ['b1', 'b2']]
+    #   table = TTY::Table[['a1', 'a2'], ['b1', 'b2']]
     #
     # @api public
     def self.[](*rows)
-      self.new(rows: rows)
+      new(rows: rows)
     end
 
     # Instantiate a new Table
@@ -79,7 +78,7 @@ module TTY
     #
     # @example of parameters passed as options
     #   rows  = [ ['a1', 'a2'], ['b1', 'b2'] ]
-    #   table = Table.new :header => ['Header 1', 'Header 2'], :rows => rows
+    #   table = Table.new header: ['Header 1', 'Header 2'], rows: rows
     #
     # @example of parameters passed as hash
     #   Table.new [ {'Header1' => ['a1','a2'], 'Header2' => ['b1', 'b2'] }] }
@@ -110,7 +109,7 @@ module TTY
     # @return [TTY::Table]
     #
     # @api private
-    def initialize(options={}, &block)
+    def initialize(options = {}, &block)
       validate_options! options
       @header        = (value = options[:header]) ? Header.new(value) : nil
       @rows          = coerce(options.fetch(:rows) { Row.new([]) })
@@ -138,7 +137,7 @@ module TTY
     #
     # @api public
     def orientation=(value)
-      @orientation = Orientation.coerce value
+      @orientation = Orientation.coerce(value)
     end
 
     # Marks this table as rotated
@@ -175,26 +174,25 @@ module TTY
     #
     # @api private
     def rotate_horizontal
-      if rotated?
-        head, body = orientation.slice(self)
-        if header && header.empty?
-          @header = head[0]
-          @rows   = body.map {|row| to_row(row, @header)}
-        else
-          @rows  = body.map { |row| to_row(row) }
-        end
+      return unless rotated?
+      head, body = orientation.slice(self)
+      if header && header.empty?
+        @header = head[0]
+        @rows   = body.map { |row| to_row(row, @header) }
+      else
+        @rows = body.map { |row| to_row(row) }
       end
     end
 
     # Lookup element of the table given a row(i) and column(j)
     #
     # @api public
-    def [](row_index, column_index=false)
+    def [](row_index, column_index = false)
       return row(row_index) unless column_index
       if row_index >= 0 && column_index >= 0
         rows.fetch(row_index) { return nil }[column_index]
       else
-        raise TTY::Table::TupleMissing.new(row_index, column_index)
+        fail TTY::Table::TupleMissing.new(row_index, column_index)
       end
     end
     alias at        []
@@ -334,8 +332,7 @@ module TTY
     # @api public
     # TODO: renmae to columns_size
     def column_size
-      return rows[0].size if rows.size > 0
-      return 0
+      rows.size > 0 ? rows[0].size : 0
     end
 
     # Return the number of rows
@@ -398,7 +395,7 @@ module TTY
     # @param [Hash] options
     #   the renderer options
     #
-    def renderer(type=:basic, options={})
+    def renderer(type = :basic, options = {})
       @renderer ||= Renderer.select(type).new(self, options)
     end
 
@@ -473,8 +470,7 @@ module TTY
     # @api private
     def yield_or_eval(&block)
       return unless block
-      block.arity > 0 ? yield(self) : self.instance_eval(&block)
+      block.arity > 0 ? yield(self) : instance_eval(&block)
     end
-
   end # Table
 end # TTY