tty 0.0.11 → 0.1.0

data/lib/tty/terminal.rb

@@ -1,8 +1,7 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
   class Terminal
-
     # Return default width of terminal
     #
     # @example
@@ -23,45 +22,30 @@ module TTY
     # @api public
     attr_reader :default_height
 
+    # Return access to color terminal
+    #
+    # @return [TTY::Terminal::Color]
+    #
     # @api public
     attr_reader :color
 
     # Output pager
     #
-    # @return [Pager]
+    # @return [TTY::Terminal::Pager]
     #
     # @api public
     attr_reader :pager
 
-    def initialize
+    # Initialize a Terminal
+    #
+    # @api public
+    def initialize(options = {})
       @color = TTY::Terminal::Color.new(self.color?)
       @echo  = TTY::Terminal::Echo.new
       @pager = TTY::Terminal::Pager
-      @default_width  = 80
-      @default_height = 24
-    end
-
-    # Set default width of terminal
-    #
-    # @param [Integer] width
-    #
-    # @return [Integer]
-    #
-    # @api public
-    def default_width=(width)
-      @default_width = width
-    end
-
-    # Set default height of terminal
-    #
-    # @example
-    #   default_height = TTY::Terminal.default_height
-    #
-    # @return [Integer]
-    #
-    # @api public
-    def default_height=(height)
-      @default_height = height
+      @home  = Home.new
+      @default_width  = options.fetch(:default_width) { 80 }
+      @default_height = options.fetch(:default_height) { 24 }
     end
 
     # Determine current width
@@ -72,9 +56,9 @@ module TTY
     def width
       env_tty_columns = ENV['TTY_COLUMNS']
       if env_tty_columns =~ /^\d+$/
-        result = env_tty_columns.to_i
+        env_tty_columns.to_i
       else
-        result = TTY::System.unix? ? dynamic_width : default_width
+        TTY::System.unix? ? dynamic_width : default_width
       end
     rescue
       default_width
@@ -82,16 +66,18 @@ module TTY
 
     # Determine current height
     #
+    # @return [Integer] height
+    #
     # @api public
     def height
       env_tty_lines = ENV['TTY_LINES']
       if env_tty_lines =~ /^\d+$/
-        result = env_tty_lines.to_i
+        env_tty_lines.to_i
       else
-        result = TTY::System.unix? ? dynamic_height : self.default_height
+        TTY::System.unix? ? dynamic_height : default_height
       end
     rescue
-      self.default_height
+      default_height
     end
 
     # Calculate dynamic width of the terminal
@@ -118,7 +104,7 @@ module TTY
     #
     # @api public
     def dynamic_width_stty
-      %x{stty size 2>/dev/null}.split[1].to_i
+      %x(tty size 2>/dev/null).split[1].to_i
     end
 
     # Detect terminal height with stty utility
@@ -127,7 +113,7 @@ module TTY
     #
     # @api public
     def dynamic_height_stty
-      %x{stty size 2>/dev/null}.split[0].to_i
+      %x(tty size 2>/dev/null).split[0].to_i
     end
 
     # Detect terminal width with tput utility
@@ -136,7 +122,7 @@ module TTY
     #
     # @api public
     def dynamic_width_tput
-      %x{tput cols 2>/dev/null}.to_i
+      %x(tput cols 2>/dev/null).to_i
     end
 
     # Detect terminal height with tput utility
@@ -145,7 +131,7 @@ module TTY
     #
     # @api public
     def dynamic_height_tput
-      %x{tput lines 2>/dev/null}.to_i
+      %x(tput lines 2>/dev/null).to_i
     end
 
     # Check if terminal supports color
@@ -154,7 +140,7 @@ module TTY
     #
     # @api public
     def color?
-      %x{tput colors 2>/dev/null}.to_i > 2
+      %x(tput colors 2>/dev/null).to_i > 2
     end
 
     # Switch echo on
@@ -176,7 +162,7 @@ module TTY
     # @param [Boolean] is_on
     #
     # @api public
-    def echo(is_on=true, &block)
+    def echo(is_on = true, &block)
       @echo.echo(is_on, &block)
     end
 
@@ -186,7 +172,6 @@ module TTY
     #
     # @api public
     def home
-      @home ||= Home.new
       @home.home
     end
 
@@ -199,6 +184,5 @@ module TTY
     def page(text)
       @pager.page(text)
     end
-
   end # Terminal
 end # TTY

data/lib/tty/terminal/color.rb

@@ -1,11 +1,9 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
   class Terminal
-
     # A class responsible for coloring strings.
     class Color
-
       # Embed in a String to clear all previous ANSI sequences.
       CLEAR      = "\e[0m"
       # The start of an ANSI bold sequence.
@@ -13,7 +11,7 @@ module TTY
       # The start of an ANSI underlined sequence.
       UNDERLINE  = "\e[4m"
 
-      STYLES = %w[ BOLD CLEAR UNDERLINE ].freeze
+      STYLES = %w( BOLD CLEAR UNDERLINE ).freeze
 
       # Escape codes for text color.
       BLACK         = "\e[30m"
@@ -60,7 +58,7 @@ module TTY
       # Initialize a Terminal Color
       #
       # @api public
-      def initialize(enabled=false)
+      def initialize(enabled = false)
         @enabled = enabled
       end
 
@@ -73,6 +71,8 @@ module TTY
 
       # Check if coloring is on
       #
+      # @return [Boolean]
+      #
       # @api public
       def enabled?
         @enabled
@@ -134,7 +134,7 @@ module TTY
       #
       # @api public
       def names
-        (STYLES + BACKGROUND_COLORS + TEXT_COLORS).map { |color| color.to_s.downcase }
+        (STYLES + BACKGROUND_COLORS + TEXT_COLORS).map { |col| col.to_s.downcase }
       end
 
       protected
@@ -148,12 +148,10 @@ module TTY
 
       # @api private
       def validate(*colors)
-        unless colors.all? { |color| names.include?(color.to_s) }
-          raise ArgumentError, "Bad color or unintialized constant, valid colors are: #{names.join(', ')}."
-        end
+        return if colors.all? { |color| names.include?(color.to_s) }
+        raise ArgumentError, 'Bad color or unintialized constant, ' \
+          " valid colors are: #{names.join(', ')}."
       end
-
     end # Color
-
-  end
+  end # Terminal
 end # TTY

data/lib/tty/terminal/echo.rb

@@ -1,11 +1,9 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
   class Terminal
-
     # A class responsible for toggling echo.
     class Echo
-
       # Turn echo on
       #
       # @api public
@@ -26,16 +24,15 @@ module TTY
       def echo(is_on=true, &block)
         value = nil
         begin
-          self.off unless is_on
+          off unless is_on
           value = block.call if block_given?
-          self.on
+          on
           return value
         rescue NoMethodError, Interrupt
-          self.on
+          on
           exit
         end
       end
-
     end # Echo
   end # Terminal
 end # TTY

data/lib/tty/terminal/home.rb

@@ -1,11 +1,9 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
   class Terminal
-
     # A class responsible for locating user home
     class Home
-
       # Find user home
       #
       # @api public
@@ -17,15 +15,10 @@ module TTY
             require 'etc'
             File.expand_path("~#{Etc.getlogin}")
           rescue
-            if TTY::System.windows?
-              "C:/"
-            else
-              "/"
-            end
+            TTY::System.windows? ?  'C:/' : '/'
           end
         end
       end
-
-    end #Home
+    end # Home
   end # Terminal
 end # TTY

data/lib/tty/terminal/pager.rb

@@ -1,8 +1,7 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
   class Terminal
-
     # A class responsible for paging text inside terminal
     class Pager
 
@@ -10,14 +9,16 @@ module TTY
 
       attr_reader :text
 
+      @command = nil
+
       # Initialize a Pager
       #
       # @param [String] text
       #   the text to page
       #
       # @api public
-      def initialize(text=nil)
-        @text = text
+      def initialize(text = nil)
+        @text    = text
         @enabled = true
       end
 
@@ -36,8 +37,8 @@ module TTY
       #
       # @api private
       def self.executables
-        [ ENV['GIT_PAGER'], `git config --get-all core.pager`.split.first,
-          ENV['PAGER'], 'less -isr', 'more', 'cat', 'pager' ]
+        [ENV['GIT_PAGER'], `git config --get-all core.pager`.split.first,
+         ENV['PAGER'], 'less -isr', 'more', 'cat', 'pager']
       end
 
       # Find first available system command for paging
@@ -48,7 +49,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
 
@@ -59,7 +60,8 @@ module TTY
         !!available
       end
 
-      # Finds command to execute pager from shell commands unless configured is provided.
+      # Finds command to execute pager from shell commands
+      # unless configured is provided.
       #
       # @param [Array[String]] commands
       #
@@ -67,7 +69,7 @@ module TTY
       #
       # @api private
       def self.command(*commands)
-        @command = if (@command && commands.empty?)
+        @command = if @command && commands.empty?
           @command
         else
           available(*commands)
@@ -89,7 +91,6 @@ module TTY
           BasicPager.new(text).page
         end
       end
-
     end # Pager
   end # Terminal
 end # TTY

data/lib/tty/terminal/pager/basic.rb

@@ -1,14 +1,12 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
   class Terminal
-
     # A class responsible for paging text
     class BasicPager < Pager
-
       PROMPT_HEIGHT = 3
 
-      PAGE_BREAK = "--- Press enter/return to continue (or q to quit) ---"
+      PAGE_BREAK = '--- Press enter/return to continue (or q to quit) ---'
 
       # Use ruby to page output text
       #
@@ -37,7 +35,7 @@ module TTY
           question = TTY.shell.ask "\n#{PAGE_BREAK}"
           return false if question.read_string[/q/i]
         end
-        return true
+        true
       end
 
       # Determine current page size
@@ -46,7 +44,6 @@ module TTY
       def page_size
         @page_size ||= TTY.terminal.height - PROMPT_HEIGHT
       end
-
     end # BasicPager
   end # Terminal
 end # TTY

data/lib/tty/terminal/pager/system.rb

@@ -1,11 +1,9 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
   class Terminal
-
     # A class responsible for paging text
     class SystemPager < Pager
-
       # Use system command to page output text
       #
       # @api public
@@ -24,7 +22,7 @@ module TTY
           begin
             Kernel.exec(Pager.command)
           rescue
-            Kernel.exec "/bin/sh", "-c", command
+            Kernel.exec '/bin/sh', '-c', command
           end
         else
           # child process
@@ -33,7 +31,6 @@ module TTY
           read_io.close
         end
       end
-
     end # SystemPager
   end # Terminal
 end # TTY

data/lib/tty/text.rb

@@ -1,13 +1,11 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 module TTY
-
   # A class responsible for text manipulations
   class Text
+    SPACE = ' '
 
-    SPACE = " ".freeze
-
-    NEWLINE = "\n".freeze
+    NEWLINE = "\n"
 
     DEFAULT_WIDTH = 80.freeze
 
@@ -24,9 +22,9 @@ module TTY
     #   the second string for comparison
     #
     # @example
-    #   distance("which", "witch")
-    #   # => 2
+    #   distance("which", "witch")  # => 2
     #
+    # @api public
     def self.distance(first, second, *args)
       Distance.new(first, second, *args).distance
     end
@@ -50,10 +48,10 @@ module TTY
     #   wrap("Some longish text", 8)
     #    # => "Some\nlongish\ntext"
     #
-    #   wrap("Some longish text", :length => 8)
+    #   wrap("Some longish text", length: 8)
     #    # => "Some\nlongish\ntext"
     #
-    #   wrap("Some longish text", 8, :indent => 4)
+    #   wrap("Some longish text", 8, indent: 4)
     #    # => >    Some
     #         >    longish
     #         >    text
@@ -96,6 +94,5 @@ module TTY
     def self.truncate(text, *args)
       Truncation.new(text, *args).truncate
     end
-
   end # Text
 end # TTY