lolize 0.0.2 → 0.0.3

data/.travis.yml

@@ -0,0 +1,9 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - rbx
+  - rbx-2.0
+  - ree
+  - jruby
+  - ruby-head
+

data/Gemfile.lock

@@ -1,13 +1,14 @@
 PATH
   remote: .
   specs:
-    lolize (0.0.1)
+    lolize (0.0.3)
       paint (~> 0.8.3)
 
 GEM
   remote: http://rubygems.org/
   specs:
     paint (0.8.3)
+    rake (0.9.2)
 
 PLATFORMS
   ruby
@@ -15,3 +16,4 @@ PLATFORMS
 DEPENDENCIES
   lolize!
   paint (~> 0.8.3)
+  rake

data/README.md

@@ -4,16 +4,43 @@ Colorize your ruby output with rainbow :)
 
 The colorize algorithm is based on [lolcat](https://github.com/busyloop/lolcat).
 
+## Installation
+
+    gem install lolize
+
+You need 256-color terminal for best experience.
+
 ## How to lolize
 
-In your ruby code/irb:
+Just require `lolize/auto`. it will automatically hook your `$stdout` and `$stderr`. 
+
+### Bundler Gemfile
+
+For example, you can do this in your rails project: 
+
+    # Gemfile
+    gem 'lolize', :require => 'lolize/auto'
+
+![Rails with lolize](http://miaout17.github.com/lolize/lolize-rails.png)
+
+### Any Ruby, anywhere
+
+Here is the snippet:
 
     gem 'lolize'
     require 'lolize/auto'
 
-Bundler Gemfile:
+You can even do this in your compass `config.rb`:
 
-    gem 'lolize', :require => 'lolize/auto'
+![Compass watch with lolize](http://miaout17.github.com/lolize/lolize-compass.png)
+
+## Don't colorize everything please
+
+    gem 'lolize'
+    require 'lolize'
+    colorizer = Lolize::Colorizer.new
+    colorizer.write "Hello, World\n"*5
+    puts "I AM WHITE" # This is clean
 
 ## Why lolize
 
@@ -26,15 +53,16 @@ If you try this:
     rails c 2>&1 | lolcat
 
 You will find that the last line won't be displayed forever.
-
-After some googling, I think it need 
+It seems hard to solve this problem, some platform-dependent C-extension is needed. 
 
 ## Caution
 
 * This is just a fun project
-* If something gets wrong within output hook, the program might crash silently
 * Never use this in your production project!!!!
+  * It will slow your console output
+  * If something gets wrong within output hook, the program might crash silently
 
 ## License
 
 MIT License
+

data/Rakefile

@@ -1,2 +1,13 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+task :default do
+  # A very simple "DONT CRASH TEST", I just want to ensure this won't crash the program
+  require 'lolize'
+  colorizer = Lolize::Colorizer.new
+  colorizer.write "*****\n"*5
+
+  5.times { puts "*"*5 }
+  require 'lolize/auto'
+  5.times { puts "*"*5 }
+end

data/lib/lolize.rb

@@ -1,2 +1,7 @@
 require 'lolize/version'
 require 'lolize/colorizer'
+require 'lolize/hooker'
+
+module Lolize
+  extend Lolize::Hooker
+end

data/lib/lolize/auto.rb

@@ -1,5 +1,5 @@
 require 'lolize'
 
-Lolize::Colorizer.lolize($stdout)
-Lolize::Colorizer.lolize($stderr)
+Lolize.lolize! $stdout
+Lolize.lolize! $stderr
 

data/lib/lolize/colorizer.rb

@@ -1,17 +1,12 @@
 require 'paint'
-require 'singleton'
 
 module Lolize
   class Colorizer
-    include Singleton
 
-    def self.lolize(output)
-      class << output
-        alias :raw_write :write
-        def write(s)
-          ::Lolize::Colorizer.instance.write(s)
-        end
-      end
+    RAW_WRITE_METHOD = :write_without_lolize
+
+    def self.instance
+      @instance ||= Lolize::Colorizer.new
     end
 
     def initialize
@@ -23,6 +18,8 @@ module Lolize
       @state = :normal
     end
 
+    # The algorithm is from lolcat (https://github.com/busyloop/lolcat)
+    # lolcat is released with WTFPL
     def rainbow
       red = Math.sin(@freq*@color + 0) * 127 + 128
       green = Math.sin(@freq*@color + 2*Math::PI/3) * 127 + 128
@@ -51,7 +48,13 @@ module Lolize
     end
 
     def raw_write(s)
-      $stdout.raw_write(s)
+      if $stdout.respond_to?(RAW_WRITE_METHOD)
+        # if $stdout is hook
+        $stdout.send(RAW_WRITE_METHOD, s)
+      else
+        # $stdout is not hooked
+        $stdout.write(s)
+      end
     end
   end
 end

data/lib/lolize/hooker.rb

@@ -0,0 +1,12 @@
+module Lolize
+  module Hooker
+    def lolize!(output)
+      class << output
+        alias_method (::Lolize::Colorizer::RAW_WRITE_METHOD), :write
+        def write(s)
+          ::Lolize::Colorizer.instance.write(s)
+        end
+      end
+    end
+  end
+end

data/lib/lolize/version.rb

@@ -1,3 +1,3 @@
 module Lolize
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lolize.gemspec

@@ -20,4 +20,5 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency 'paint', '~> 0.8.3'
+  s.add_development_dependency 'rake'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: lolize
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - miaout17
@@ -34,6 +34,20 @@ dependencies:
         version: 0.8.3
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
 description: Colorize your ruby stdout with Lolcat
 email: 
 - miaout17@gmail.com
@@ -45,6 +59,7 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - MIT-LICENSE
@@ -53,6 +68,7 @@ files:
 - lib/lolize.rb
 - lib/lolize/auto.rb
 - lib/lolize/colorizer.rb
+- lib/lolize/hooker.rb
 - lib/lolize/version.rb
 - lolize.gemspec
 has_rdoc: true