inform 0.0.1 → 0.0.2

data/README.md

@@ -21,6 +21,13 @@ Will print:
 This code was taken directly from the our **dew** project and is not ready for prime time. Interfaces,
 requirements, etc will change.
 
+### TODO
+
+ * Make debug, warning, error accept blocks
+ * Refactor tests
+ * Colourisation isn't tested at all - should it be?
+ * RDoc
+ 
 ## License
 
 (The MIT License)

data/examples/frozbot

@@ -0,0 +1,18 @@
+#! /usr/bin/env ruby
+
+require "inform"
+
+class Frozbot
+  attr_reader :name
+
+  def initialize(name)
+    @name = name
+  end
+end
+
+Inform.level = :info
+frozbot = Inform.info("Initializing the frozbot...") do
+  Frozbot.new 'puddy'
+end
+
+Inform.info("Frozbot is %{name}", :name => frozbot.name)

data/inform.gemspec

@@ -11,7 +11,6 @@ Gem::Specification.new do |s|
   s.summary     = %q{Interactive, colourised logging}
   s.description = s.summary
 
-  s.add_runtime_dependency("highline", "~> 1.6.2")
   s.add_development_dependency("rspec", "~> 2.6.0")
   
   s.files         = `git ls-files`.split("\n")

data/lib/inform/version.rb

@@ -1,3 +1,3 @@
 class Inform
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/inform.rb

@@ -1,12 +1,25 @@
 require "inform/version"
-require 'highline/import'
 
 class Inform
-  class << self
-    DEFAULT_LOG_LEVEL = :info
-    LOG_LEVELS = [:debug, :info, :warning, :error]
 
-    # Highline colours at http://highline.rubyforge.org/doc/classes/HighLine.html
+  CLEAR      = "\e[0m"
+
+  BOLD       = "\e[1m"
+  UNDERLINE  = "\e[4m"
+
+  BLACK      = "\e[30m"
+  RED        = "\e[31m"
+  GREEN      = "\e[32m"
+  YELLOW     = "\e[33m"
+  BLUE       = "\e[34m"
+  MAGENTA    = "\e[35m"
+  CYAN       = "\e[36m"
+  WHITE      = "\e[37m"
+
+  DEFAULT_LOG_LEVEL = :info
+  LOG_LEVELS = [:debug, :info, :warning, :error]
+  
+  class << self
 
     def level
       @level.nil? ? DEFAULT_LOG_LEVEL : @level
@@ -18,33 +31,33 @@ class Inform
     end
 
     def debug(message, args=nil)
-      # log(:debug, message)
-      log(:debug, "    <%= color(#{color_args(message, args, :cyan)}, :cyan) %>")
+      log(:debug, "    " + color_args(message, args, CYAN))
     end
 
     def info(message, args=nil)
       if block_given?
-        log(:info, ">>> <%= color(#{color_args(message, args, :blue)}, :blue) %> :", :no_newline => true)
+        log(:info, ">>> " + color_args(message, args, BLUE) + " :", :no_newline => true)
         ret = yield
-        log(:info, "<%= color('Done.', :blue) %>", :continue_line => true, :prefix => '>>> ')
+        log(:info, color('Done.', BLUE), :continue_line => true, :prefix => '>>> ')
         ret
       else
-        log(:info, "*** <%= color(#{color_args(message, args, :green)}, :green) %>")
+        log(:info, "*** " + color_args(message, args, GREEN))
       end
     end
 
     def warning(message, args=nil)
-      log(:warning, "<%= color('WARNING', :yellow, :bold) %>: <%= color(#{color_args(message, args, :yellow)}, :yellow) %>")
+      log(:warning, color('WARNING', YELLOW, BOLD) + ': ' + color_args(message, args, YELLOW))
     end
 
     def error(message, args=nil)
-      log :error, "<%= color('ERROR', :red, :bold) %>: <%= color(#{color_args(message, args, :red)}, :red) %>"
+      log(:error, color('ERROR', RED, BOLD) + ': ' + color_args(message, args, RED))
     end
 
     private
 
     def log message_level, message, opts={}
       if LOG_LEVELS.index(level) <= LOG_LEVELS.index(message_level)
+        end_with_newline = true
         if @need_newline && !opts[:continue_line]
           message = "\n" + message
         end
@@ -52,26 +65,30 @@ class Inform
           message = opts[:prefix] + message
         end
         if opts[:no_newline]
-          message += ' ' # say magic
+          end_with_newline = false
           @need_newline = true
         else
           @need_newline = false
         end
-        say message
+        message += "\n" if end_with_newline
+        print message
       end
     end
 
-    def color_args(message, args, c)
-      message = message % args.inject({}) { |h,(k,v)| h[k] = "#{$terminal.color(v, c, :bold)}#{$terminal.class.const_get(c.to_s.upcase)}" ; h } if args
-      message.inspect
+    def color_args(message, args, *colours)
+      colours = colours.join("")
+      message = colours + message
+      if args
+        args.each do |k, v|
+          v = "#{BOLD}#{v}#{CLEAR}#{colours}"
+          message.gsub!(/%\{#{k}\}/, v)
+        end
+      end
+      message + CLEAR
+    end
+    
+    def color(message, *colours)
+      colours.join("") + message + CLEAR
     end
-  end
-end
-
-class String
-  # Work around Ruby 1.8.x not supporting % args
-  alias_method :percentage, :%
-  def %(arg)
-    arg.is_a?(Hash) ? arg.inject(self) { |res,(k,v)| res.gsub(/%\{#{k}\}/, v) } : self.percentage(arg)
   end
 end

data/spec/inform_spec.rb

@@ -3,7 +3,7 @@ require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
 def should_print method
   describe method do
     it "should print a message" do
-      Inform.should_receive(:say).with(/a special message/)
+      Inform.should_receive(:print).with(/a special message/)
       Inform.send(method, "a special message")
     end
   end
@@ -42,7 +42,7 @@ describe Inform do
   context "with log level debug" do
     before :each do
       Inform.level = :debug
-      Inform.stub(:say => nil) # SSSSSH.
+      Inform.stub(:print => nil) # SSSSSH.
     end
 
     should_print :debug    
@@ -50,19 +50,23 @@ describe Inform do
 
     describe ":info with a block" do
       it "should print out the task being executed" do
-        Inform.should_receive(:say).with(/message/)
+        Inform.should_receive(:print).with(/message/)
         Inform.info("message") { true }
       end
       it "should print Done once the task is complete" do
-        Inform.should_receive(:say).with(/Done/)
+        Inform.should_receive(:print).with(/Done/)
         Inform.info("") { true }
       end
       it "should evaluate the passed block and return the result" do
         Inform.info("") { 'hello' }.should == 'hello'
       end
+      it "should interpolate keyword arguments" do
+        Inform.should_receive(:print).with(/hello.+hey.+you.+goodbye/)
+        Inform.info("hello %{a} %{b} goodbye", :a => 'hey', :b => 'you')
+      end
       it "should allow us to print messages from within a block" do
-        Inform.should_receive(:say).with(/open/)
-        Inform.should_receive(:say).with(/inner/)
+        Inform.should_receive(:print).with(/open/)
+        Inform.should_receive(:print).with(/inner/)
         Inform.info("open") { Inform.debug("inner") }
       end
     end
@@ -100,14 +104,4 @@ describe Inform do
       end
     end
   end
-end
-
-describe String do
-  describe :% do
-    it {
-      (
-        "%{greeting} there %{name}.  How are you today %{name}?" % { :name => 'Ash', :greeting => 'Hi' }
-      ).should == "Hi there Ash.  How are you today Ash?"
-    }
-  end
-end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: inform
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Michael Pearson
@@ -18,26 +18,10 @@ cert_chain: []
 
 date: 2011-06-14 00:00:00 Z
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: highline
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 1
-        - 6
-        - 2
-        version: 1.6.2
-  type: :runtime
-  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -49,7 +33,7 @@ dependencies:
         - 0
         version: 2.6.0
   type: :development
-  version_requirements: *id002
+  version_requirements: *id001
 description: Interactive, colourised logging
 email: 
 - mipearson@gmail.com
@@ -65,6 +49,7 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- examples/frozbot
 - inform.gemspec
 - lib/inform.rb
 - lib/inform/version.rb