console_util 0.2.0 → 0.3.0

data/lib/console_util/version.rb

@@ -1,3 +1,3 @@
 module ConsoleUtil
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/console_util.rb

@@ -2,6 +2,8 @@ require 'console_util/color'
 
 module ConsoleUtil
   class << self
+    attr_reader :suppressed_output
+    
     # Monkey-patch the ActiveRecord connection to output the SQL query before
     # executing it.
     def output_sql_to_console(options = {})
@@ -37,5 +39,122 @@ module ConsoleUtil
         model_match[1].classify.constantize if model_match
       end
     end
+    
+    # Allows you to filter output to the console using grep
+    # Ex:
+    #   def foo
+    #     puts "Some debugging output here"
+    #     puts "The value of x is y"
+    #     puts "The value of foo is bar"
+    #   end
+    # 
+    #   grep_stdout(/value/) { foo }
+    #   # => The value of x is y
+    #   # => The value of foo is bar
+    #   # => nil
+    def grep_stdout(expression)
+      # First we need to create a ruby "pipe" which is two sets of IO subclasses
+      # the first is read only (which represents a fake $stdin) and the second is
+      # write only (which represents a fake $stdout).
+      placeholder_in, placeholder_out = IO.pipe
+      
+      # This child process handles the grep'ing.  Its done in a child process so that
+      # it can operate in parallel with the main process.
+      pid = fork {
+        # sync $stdout so we can report any matches asap
+        $stdout.sync
+        
+        # replace $stdout with placeholder_out
+        $stdin.reopen(placeholder_in)
+        
+        # we have to close both placeholder_out and placeholder_in because all instances
+        # of an IO stream must be closed in order for it to ever reach EOF.  There's two
+        # in this method; one in the child process and one in the main process.
+        placeholder_in.close
+        placeholder_out.close
+        
+        # loop continuously until we reach EOF (which happens when all
+        # instances of placeholder_out have closed)
+        read_buffer = ''
+        loop do
+          begin
+            match     = nil
+            next_read = $stdin.readpartial(4096)
+            
+            read_buffer << next_read
+            if line_match = read_buffer.match(/^(.*\n)(.*)$/m)
+              match = line_match[1].grep(expression)  # grep complete lines
+              read_buffer = line_match[2]           # save remaining partial line for the next iteration
+            end
+          rescue EOFError
+            match = read_buffer.grep(expression)  # grep any remaining partial line at EOF
+            break
+          end
+          
+          if match && !match.empty?
+            print match
+          end
+        end
+      }
+      
+      # Save the original stdout out to a variable so we can use it again after this
+      # method is done
+      original_stdout = $stdout
+      
+      # Redirect stdout to our pipe
+      $stdout = placeholder_out
+      
+      # sync $stdout so that we can start operating on it as soon as possible
+      $stdout.sync
+      
+      # allow the block to execute and save its return value
+      return_value = yield
+      
+      # Set stdout back to the original so output will flow again
+      $stdout = original_stdout
+      
+      # close the main instances of placeholder_in and placeholder_out
+      placeholder_in.close
+      placeholder_out.close
+      
+      # Wait for the child processes to finish
+      Process.wait pid
+      
+      # Because the connection to the database has a tendency to go away when calling this, reconnect here
+      # if we're using ActiveRecord
+      if defined?(ActiveRecord)
+        suppress_stdout { ActiveRecord::Base.verify_active_connections! }
+      end
+      
+      # return the value of the block
+      return_value
+    end
+
+    # Allows you to suppress $stdout but allows you to send certain messages to $stdout
+    # Ex:
+    #   def foo
+    #     puts "lots of stuff directed to $stdout that I don't want to see."
+    #   end
+    #   
+    #   suppress_stdout do |stdout|
+    #     stdout.puts "About to call #foo"
+    #     foo
+    #     stdout.puts "Called foo"
+    #   end
+    #   # => About to call #foo
+    #   # => Called foo
+    #   # => <# The result of #foo >
+    def suppress_stdout
+      original_stdout = $stdout
+      $stdout = output_buffer = StringIO.new
+      begin
+        return_value = yield(original_stdout)
+      ensure
+        $stdout = original_stdout
+        @suppressed_output ||= ""
+        @suppressed_output << output_buffer.string
+      end
+      return_value
+    end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: console_util
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: 
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Clyde Law
@@ -15,7 +15,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-02 00:00:00 Z
+date: 2012-07-19 00:00:00 -07:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rails
@@ -51,6 +52,7 @@ files:
 - lib/console_util.rb
 - lib/console_util/color.rb
 - lib/console_util/version.rb
+has_rdoc: true
 homepage: http://github.com/FutureAdvisor/console_util
 licenses: 
 - MIT
@@ -80,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: console_util
-rubygems_version: 1.7.2
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Contains various utilities for working in the Rails console.