inform 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in inform.gemspec
+gemspec

data/README.md

@@ -0,0 +1,47 @@
+# Inform
+
+**Inform** prints colourised, interactive logging output to the console.
+
+For example:
+
+    Inform.level = :info
+    frozbot = Inform.info("Initializing the frozbot") do
+      Frozbot.new
+    end
+    
+    Inform.info("Frozbot is %{name}", :name => frozbot.name)
+
+Will print:
+
+    >>> Initializing the frozbot : Done
+    *** Frozbot is myfrozbot
+
+### Caveat
+
+This code was taken directly from the our **dew** project and is not ready for prime time. Interfaces,
+requirements, etc will change.
+
+## License
+
+(The MIT License)
+
+Copyright (c) 2011 PlayUp
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/inform.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "inform/version"
+
+Gem::Specification.new do |s|
+  s.name        = "inform"
+  s.version     = Inform::VERSION
+  s.authors     = ["Michael Pearson", "Chris Ottrey"]
+  s.email       = ["mipearson@gmail.com", ""]
+  s.homepage    = "https://github.com/playup/inform"
+  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")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/inform/version.rb

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

data/lib/inform.rb

@@ -0,0 +1,77 @@
+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
+
+    def level
+      @level.nil? ? DEFAULT_LOG_LEVEL : @level
+    end
+
+    def level= _level
+      raise "Unrecognized log level #{_level} (should be one of #{LOG_LEVELS.join(', ')})" unless LOG_LEVELS.include?(_level)
+      @level = _level
+    end
+
+    def debug(message, args=nil)
+      # log(:debug, message)
+      log(:debug, "    <%= color(#{color_args(message, args, :cyan)}, :cyan) %>")
+    end
+
+    def info(message, args=nil)
+      if block_given?
+        log(:info, ">>> <%= color(#{color_args(message, args, :blue)}, :blue) %> :", :no_newline => true)
+        ret = yield
+        log(:info, "<%= color('Done.', :blue) %>", :continue_line => true, :prefix => '>>> ')
+        ret
+      else
+        log(:info, "*** <%= color(#{color_args(message, args, :green)}, :green) %>")
+      end
+    end
+
+    def warning(message, args=nil)
+      log(:warning, "<%= color('WARNING', :yellow, :bold) %>: <%= color(#{color_args(message, args, :yellow)}, :yellow) %>")
+    end
+
+    def error(message, args=nil)
+      log :error, "<%= color('ERROR', :red, :bold) %>: <%= color(#{color_args(message, args, :red)}, :red) %>"
+    end
+
+    private
+
+    def log message_level, message, opts={}
+      if LOG_LEVELS.index(level) <= LOG_LEVELS.index(message_level)
+        if @need_newline && !opts[:continue_line]
+          message = "\n" + message
+        end
+        if opts[:continue_line] && !@need_newline
+          message = opts[:prefix] + message
+        end
+        if opts[:no_newline]
+          message += ' ' # say magic
+          @need_newline = true
+        else
+          @need_newline = false
+        end
+        say 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
+    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

@@ -0,0 +1,113 @@
+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.send(method, "a special message")
+    end
+  end
+end
+
+def should_not_print method
+  describe method do
+    it "should not print a message" do
+      Inform.should_not_receive(:say)
+      Inform.should_not_receive(:print)
+      Inform.send(method, "a special message")
+    end
+  end
+end
+  
+# TODO: refactor, deal with all combinations of message / log level
+describe Inform do
+  before :each do
+    @oldlevel = Inform.level
+  end
+  after :each do
+    Inform.level = @oldlevel
+  end
+
+  describe :level= do
+    it "should set the log level" do
+      Inform.level = :info
+      Inform.level.should == :info
+    end
+    
+    it "should not allow us to set a log level that isn't recognized" do
+      lambda {Inform.level = :warble}.should raise_error /unrecognized/i
+    end
+  end
+  
+  context "with log level debug" do
+    before :each do
+      Inform.level = :debug
+      Inform.stub(:say => nil) # SSSSSH.
+    end
+
+    should_print :debug    
+    should_print :info    
+
+    describe ":info with a block" do
+      it "should print out the task being executed" do
+        Inform.should_receive(:say).with(/message/)
+        Inform.info("message") { true }
+      end
+      it "should print Done once the task is complete" do
+        Inform.should_receive(:say).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 allow us to print messages from within a block" do
+        Inform.should_receive(:say).with(/open/)
+        Inform.should_receive(:say).with(/inner/)
+        Inform.info("open") { Inform.debug("inner") }
+      end
+    end
+
+    should_print :warning
+    should_print :error
+  end
+  
+  context "with log level set to :info" do
+    before { Inform.level = :info }
+    should_not_print :debug
+    should_print :info
+    should_print :warning
+    should_print :error
+  end
+  
+  context "with log level set to :warning" do
+    before { Inform.level = :warning }
+    should_not_print :debug
+    should_not_print :info
+    should_print :warning
+    should_print :error
+  end
+
+  context "with log level set to :error " do
+    before { Inform.level = :error }
+    should_not_print :debug
+    should_not_print :info
+    should_not_print :warning
+    should_print :error
+    
+    describe :info do
+      it "should still execute the code block" do
+        Inform.info("") { 'hello' }.should == 'hello'
+      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

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require "rspec"
+require "inform"

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: inform
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Michael Pearson
+- Chris Ottrey
+autorequire: 
+bindir: bin
+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 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 2
+        - 6
+        - 0
+        version: 2.6.0
+  type: :development
+  version_requirements: *id002
+description: Interactive, colourised logging
+email: 
+- mipearson@gmail.com
+- ""
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- inform.gemspec
+- lib/inform.rb
+- lib/inform/version.rb
+- spec/inform_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/playup/inform
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Interactive, colourised logging
+test_files: 
+- spec/inform_spec.rb
+- spec/spec_helper.rb