interact 0.4.8 → 0.5.0

data/lib/interact/pretty.rb

@@ -0,0 +1,93 @@
+require "rbconfig"
+
+# Mix in to your Interactive class to enable user-toggleable colors.
+#
+# Redefine color_enabled? to control color enabling/disabling. Colors will be
+# auto-disabled if the platform is Windows or if $stdout is not a tty.
+#
+# Redefine user_colors to return a hash from tags to color, e.g. from a user's
+# color config file.
+module Interact
+  module Pretty
+    WINDOWS = !!(RbConfig::CONFIG['host_os'] =~ /mingw|mswin32|cygwin/)
+
+    COLOR_CODES = {
+      :black => 0,
+      :red => 1,
+      :green => 2,
+      :yellow => 3,
+      :blue => 4,
+      :magenta => 5,
+      :cyan => 6,
+      :white => 7
+    }
+
+    DEFAULT_COLORS = {
+      :name => :blue,
+      :neutral => :blue,
+      :good => :green,
+      :bad => :red,
+      :error => :magenta,
+      :unknown => :cyan,
+      :warning => :yellow,
+      :instance => :yellow,
+      :number => :green,
+      :prompt => :blue,
+      :yes => :green,
+      :no => :red
+    }
+
+    private
+
+    # override with e.g. option(:color), or whatever toggle you use
+    def color_enabled?
+      true
+    end
+
+    # use colors?
+    def color?
+      color_enabled? && !WINDOWS && $stdout.tty?
+    end
+
+    # redefine to control the tag -> color settings
+    def user_colors
+      DEFAULT_COLORS
+    end
+
+    # colored text
+    #
+    # shouldn't use bright colors, as some color themes abuse
+    # the bright palette (I'm looking at you, Solarized)
+    def c(str, type)
+      return str unless color?
+
+      bright = false
+      color = user_colors[type]
+      if color.to_s =~ /bright-(.+)/
+        bright = true
+        color = $1.to_sym
+      end
+
+      return str unless color
+
+      code = "\e[#{bright ? 9 : 3}#{COLOR_CODES[color]}m"
+      "#{code}#{str.to_s.gsub("\e[0m", "\e[0m#{code}")}\e[0m"
+    end
+
+    # bold text
+    def b(str)
+      return str unless color?
+
+      code = "\e[1m"
+      "#{code}#{str.to_s.gsub("\e[0m", "\e[0m#{code}")}\e[0m"
+    end
+
+    # dim text
+    def d(str)
+      return str unless color?
+
+      code = "\e[2m"
+      "#{code}#{str.to_s.gsub("\e[0m", "\e[0m#{code}")}\e[0m"
+    end
+  end
+end

data/lib/interact/progress.rb

@@ -0,0 +1,114 @@
+require "interact/pretty"
+
+module Interact
+  module Progress
+    include Pretty
+
+    module Dots
+      class << self
+        DOT_COUNT = 3
+        DOT_TICK = 0.15
+
+        def start!
+          @dots ||=
+            Thread.new do
+              before_sync = $stdout.sync
+
+              $stdout.sync = true
+
+              printed = false
+              i = 1
+              until @stop_dots
+                if printed
+                  print "\b" * DOT_COUNT
+                end
+
+                print ("." * i).ljust(DOT_COUNT)
+                printed = true
+
+                if i == DOT_COUNT
+                  i = 0
+                else
+                  i += 1
+                end
+
+                sleep DOT_TICK
+              end
+
+              if printed
+                print "\b" * DOT_COUNT
+                print " " * DOT_COUNT
+                print "\b" * DOT_COUNT
+              end
+
+              $stdout.sync = before_sync
+              @stop_dots = nil
+            end
+        end
+
+        def stop!
+          return unless @dots
+          return if @stop_dots
+          @stop_dots = true
+          @dots.join
+          @dots = nil
+        end
+      end
+    end
+
+    class Skipper
+      def initialize(&ret)
+        @return = ret
+      end
+
+      def skip(&callback)
+        @return.call("SKIPPED", :warning, callback)
+      end
+
+      def give_up(&callback)
+        @return.call("GAVE UP", :bad, callback)
+      end
+
+      def fail(&callback)
+        @return.call("FAILED", :error, callback)
+      end
+    end
+
+    # override to determine whether to show progress
+    def quiet?
+      false
+    end
+
+    def with_progress(message)
+      unless quiet?
+        print message
+        Dots.start!
+      end
+
+      skipper = Skipper.new do |status, color, callback|
+        unless quiet?
+          Dots.stop!
+          puts "... #{c(status, color)}"
+        end
+
+        return callback && callback.call
+      end
+
+      begin
+        res = yield skipper
+        unless quiet?
+          Dots.stop!
+          puts "... #{c("OK", :good)}"
+        end
+        res
+      rescue
+        unless quiet?
+          Dots.stop!
+          puts "... #{c("FAILED", :error)}"
+        end
+
+        raise
+      end
+    end
+  end
+end

data/lib/interact/version.rb

@@ -1,5 +1,5 @@
 # Copyright (c) 2011 Alex Suraci
 
 module Interact
-  VERSION = "0.4.8"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: interact
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 11
   prerelease: 
   segments: 
   - 0
-  - 4
-  - 8
-  version: 0.4.8
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Alex Suraci
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-08-24 00:00:00 Z
+date: 2012-11-28 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
@@ -60,6 +60,8 @@ files:
 - README.md
 - Rakefile
 - lib/interact/interactive.rb
+- lib/interact/pretty.rb
+- lib/interact/progress.rb
 - lib/interact/rewindable.rb
 - lib/interact/version.rb
 - lib/interact.rb