coral_core 0.1.2

data/spec/coral_core/interface_spec.rb

@@ -0,0 +1,489 @@
+
+require 'spec_helper'
+
+module Coral
+
+  describe Interface do
+
+    #---------------------------------------------------------------------------
+    # UI functionality
+    
+    describe "#say" do
+    
+      #-------------------------------------------------------------------------
+      # Delegation
+      
+      it "can delegate to another class that contains this method" do
+        output  = double('output')
+        output.should_receive(:puts).with('message')
+        
+        ui = Interface.new({
+          :output  => output,
+          :printer => :puts,
+        })        
+        Interface.new({ :ui_delegate => ui }).say(:info, 'message')
+      end
+      
+      #-------------------------------------------------------------------------
+      # Output formats
+
+      it "prints a message with default options" do
+        output1 = double('output1')
+        output1.should_receive(:puts).with('message')
+        
+        Interface.new({ :output => output1 }).say(:info, 'message')
+        
+        output2 = double('output2')
+        output2.should_receive(:puts).with('[component] message')
+        
+        Interface.new({
+          :resource => 'component', 
+          :output   => output2, 
+        }).say(:info, 'message')      
+      end
+      
+      #---
+      
+      it "prints a message with and without newlines included" do
+        output1 = double('output1')
+        output1.should_receive(:puts).with('message')
+        
+        test = Interface.new({ :output => output1 })
+        test.say(:info, 'message', { :new_line => true })
+        
+        output2 = double('output2')
+        output2.should_receive(:print).with('message')
+        
+        test = Interface.new({ :output => output2 })
+        test.say(:info, 'message', { :new_line => false })      
+      end
+      
+      #---
+      
+      it "routes message to output and error channels based on type given" do       
+        [:info, :warn, :success].each do |type|
+          output = double('output')
+          output.should_receive(:puts).with('message')
+        
+          Interface.new({
+            :output  => output,
+            :printer => :puts,
+            :color   => false,
+          }).say(type, 'message')
+        end
+        
+        error = double('error')
+        error.should_receive(:puts).with('message')
+        
+        Interface.new({
+          :error   => error,
+          :printer => :puts,
+          :color   => false,
+        }).say(:error, 'message')   
+      end
+      
+      #---
+      
+      it "routes message to output and error channels based on channel given" do
+        [:info, :warn, :success].each do |type|
+          output = double('output')
+          output.should_receive(:puts).with('message')
+        
+          Interface.new({
+            :output  => output,
+            :printer => :puts,
+          }).say(:info, 'message', { :channel => type })        
+        end
+        
+        error = double('error')
+        error.should_receive(:puts).with('message')
+        
+        Interface.new({
+          :error   => error,
+          :printer => :puts,
+          :color   => false,
+        }).say(:info, 'message', { :channel => :error })
+      end  
+    end
+    
+    #---
+    
+    describe "#ask" do
+    
+      #-------------------------------------------------------------------------
+      # Delegation
+      
+      it "can delegate to another class that contains this method"
+      
+      #-------------------------------------------------------------------------
+      # Input
+      
+      it "displays a prompt and returns user feedback"
+    end
+    
+    #---
+    
+    describe "#info" do
+    
+      #-------------------------------------------------------------------------
+      # Delegation
+      
+      it "can delegate to another class that contains this method" do
+        output  = double('output')
+        output.should_receive(:puts).with('message')
+        
+        ui = Interface.new({
+          :output  => output,
+          :printer => :puts,
+        })        
+        Interface.new({ :ui_delegate => ui }).info('message')
+      end
+      
+      #-------------------------------------------------------------------------
+      # Printing
+      
+      it "prints an uncolored information message" do
+        output = double('output')
+        output.should_receive(:puts).with('message')
+        
+        Interface.new({ 
+          :output  => output,
+          :printer => :puts, 
+        }).info('message')
+      end    
+    end
+    
+    #---
+    
+    describe "#warn" do
+    
+      #-------------------------------------------------------------------------
+      # Delegation
+      
+      it "can delegate to another class that contains this method" do
+        output  = double('output')
+        output.should_receive(:puts).with('message')
+        
+        ui = Interface.new({
+          :output  => output,
+          :printer => :puts,
+          :color   => false,
+        })        
+        Interface.new({ :ui_delegate => ui }).warn('message')
+      end
+      
+      #-------------------------------------------------------------------------
+      # Printing
+      
+      it "prints an uncolored warning message" do
+        output = double('output')
+        output.should_receive(:puts).with('message')
+        
+        Interface.new({ 
+          :output  => output,
+          :printer => :puts,
+          :color   => false, 
+        }).warn('message')
+      end
+      
+      #---
+      
+      it "prints a colored warning message" do
+        output = double('output')
+        output.should_receive(:print).with(/^\e\[33mmessage\e\[0m$/)
+        
+        Interface.new({ 
+          :output => output,
+          :color  => true, 
+        }).warn('message', { :new_line => false })
+      end    
+    end
+    
+    #---
+    
+    describe "#error" do
+    
+      #-------------------------------------------------------------------------
+      # Delegation
+      
+      it "can delegate to another class that contains this method" do
+        error  = double('error')
+        error.should_receive(:puts).with('message')
+        
+        ui = Interface.new({
+          :error   => error,
+          :printer => :puts,
+          :color   => false,
+        })        
+        Interface.new({ :ui_delegate => ui }).error('message')
+      end
+      
+      #-------------------------------------------------------------------------
+      # Printing
+      
+      it "prints an uncolored error message" do
+        error = double('error')
+        error.should_receive(:puts).with('message')
+        
+        Interface.new({ 
+          :error   => error,
+          :printer => :puts,
+          :color   => false, 
+        }).error('message')
+      end
+      
+      #---
+      
+      it "prints a colored error message" do
+        error = double('error')
+        error.should_receive(:print).with(/^\e\[31mmessage\e\[0m$/)
+        
+        Interface.new({ 
+          :error => error,
+          :color => true, 
+        }).error('message', { :new_line => false })
+      end 
+    end
+    
+    #---
+    
+    describe "#success" do
+    
+      #-------------------------------------------------------------------------
+      # Delegation
+      
+      it "can delegate to another class that contains this method" do
+        output  = double('output')
+        output.should_receive(:puts).with('message')
+        
+        ui = Interface.new({
+          :output  => output,
+          :printer => :puts,
+          :color   => false,
+        })        
+        Interface.new({ :ui_delegate => ui }).success('message')
+      end
+      
+      #-------------------------------------------------------------------------
+      # Printing
+      
+      it "prints an uncolored success message" do
+        output = double('output')
+        output.should_receive(:puts).with('message')
+        
+        Interface.new({ 
+          :output  => output,
+          :printer => :puts,
+          :color   => false, 
+        }).success('message')
+      end
+      
+      #---
+      
+      it "prints a colored success message" do
+        output = double('output')
+        output.should_receive(:print).with(/^\e\[32mmessage\e\[0m$/)
+        
+        Interface.new({ 
+          :output => output,
+          :color  => true, 
+        }).success('message', { :new_line => false })
+      end  
+    end
+  
+    #---------------------------------------------------------------------------
+    # Utilities
+    
+    describe "#format_message" do
+    
+      #-------------------------------------------------------------------------
+      # Delegation
+      
+      it "can delegate to another class that contains this method" do
+        message = Interface.new({ 
+          :ui_delegate => Interface.new('delegate')
+        }).format_message(:info, 'message', { :prefix => true })
+        
+        message.should == '[delegate] message'
+      end
+    
+      #-------------------------------------------------------------------------
+      # Prefix specifications
+      
+      it "returns without a prefix because no resource" do
+        message = Interface.new.format_message(:info, 'message', { :prefix => true })
+        message.should == 'message'
+      end
+      
+      #---
+      
+      it "returns without a prefix because prefix is false" do
+        message = Interface.new('component').format_message(:info, 'message', { :prefix => false })
+        message.should == 'message'
+      end
+      
+      #---
+            
+      it "returns without a prefix because no prefix option given" do
+        message = Interface.new('component').format_message(:info, 'message')
+        message.should == 'message'
+      end
+      
+      #---
+            
+      it "returns with a prefix if resource and prefix option given" do
+        message = Interface.new('component').format_message(:info, 'message', { :prefix => true })
+        message.should == '[component] message'
+      end
+      
+      #-------------------------------------------------------------------------
+      # Color specifications
+      
+      it "formats a error message in red if color enabled" do
+        message = Interface.new({
+          :resource => 'component',
+          :color    => true,
+        }).format_message(:error, 'message')
+        message.should match(/^\e\[31mmessage\e\[0m$/)
+      end
+      
+      #---
+      
+      it "formats a warning message in yellow if color enabled" do
+        message = Interface.new({
+          :resource => 'component',
+          :color    => true,
+        }).format_message(:warn, 'message')
+        message.should match(/^\e\[33mmessage\e\[0m$/)
+      end
+      
+      #---
+      
+      it "formats a success message in green if color enabled" do
+        message = Interface.new({
+          :resource => 'component',
+          :color    => true,
+        }).format_message(:success, 'message')
+        message.should match(/^\e\[32mmessage\e\[0m$/)
+      end
+    end
+    
+    #---------------------------------------------------------------------------
+    
+    describe "#safe_puts" do
+    
+      #-------------------------------------------------------------------------
+      # Delegation
+      
+      it "can delegate to another class that contains this method" do
+        output  = double('output')
+        output.should_receive(:puts).with('message')
+        
+        ui = Interface.new({
+          :output  => output,
+          :printer => :puts,
+        })        
+        Interface.new({ :ui_delegate => ui }).safe_puts('message')
+      end
+      
+      #-------------------------------------------------------------------------
+      # Instance configuration
+      
+      it "prints an empty string unless message given" do
+        output  = double('output')
+        output.should_receive(:puts).with('')
+        
+        Interface.new({
+          :output  => output,
+          :printer => :puts,
+        }).safe_puts()
+      end
+      
+      #---
+      
+      it "prints to different output channels if they are given" do
+        output1 = double('output1')
+        output1.should_receive(:puts).with('message')
+        
+        test = Interface.new({
+          :output  => output1,
+          :printer => :puts,
+        })
+        test.safe_puts('message')
+        
+        output2 = double('output2')
+        output2.should_receive(:puts).with('message')
+        
+        test.output = output2
+        test.safe_puts('message')
+      end
+      
+      #---
+      
+      it "prints with puts if puts printer option given" do
+        output = double('output')
+        output.should_receive(:puts).with('message')
+        
+        Interface.new({
+          :output  => output,
+          :printer => :puts,
+        }).safe_puts('message')
+      end
+      
+      #---
+      
+      it "prints with print if print printer option given" do
+        output = double('output')
+        output.should_receive(:print).with('message')
+        
+        Interface.new({
+          :output  => output,
+          :printer => :print,
+        }).safe_puts('message')
+      end
+      
+      #-------------------------------------------------------------------------
+      # Method configuration
+      
+      it "can override the instance output channel" do
+        output1 = double('output1')
+        output1.should_not_receive(:puts).with('message')
+        
+        output2 = double('output2')
+        output2.should_receive(:puts).with('message')
+        
+        Interface.new({
+          :output  => output1,
+          :printer => :puts,
+        }).safe_puts('message', { :channel => output2 })  
+      end
+      
+      #---
+      
+      it "can override the instance printer handler" do
+        output = double('output')
+        output.should_not_receive(:puts).with('message')
+        output.should_receive(:print).with('message')
+        
+        Interface.new({
+          :output  => output,
+          :printer => :puts,
+        }).safe_puts('message', { :printer => :print })
+      end
+    end
+    
+    #---------------------------------------------------------------------------
+    
+    describe "#check_delegate" do
+      
+      it "returns false if no delegate exists" do
+        Interface.new.check_delegate('safe_puts').should be_false
+      end
+      it "returns true if a delegate exists and it implements given method" do
+        test = Interface.new({ :ui_delegate => Interface.new })
+        test.check_delegate('safe_puts').should be_true
+        test.check_delegate('nonexistent').should be_false
+      end
+    end  
+  end
+end

data/spec/coral_mock_input.rb

@@ -0,0 +1,29 @@
+
+class MockInput
+
+  #-----------------------------------------------------------------------------
+  # Constructor / Destructor
+  
+  def initialize(strings)
+    if strings.is_a?(String)
+      strings = [ strings ]
+    end
+    @strings = strings
+  end
+  
+  #---
+  
+  def self.with(strings)
+    $stdin = self.new(strings)
+    yield
+  ensure
+    $stdin = STDIN
+  end
+  
+  #-----------------------------------------------------------------------------
+  # Accessors / Modifiers
+
+  def gets
+    return @strings.shift
+  end  
+end

data/spec/coral_test_kernel.rb

@@ -0,0 +1,22 @@
+
+module Kernel
+
+  #-----------------------------------------------------------------------------
+  # Utilities
+
+  def capture
+    out     = StringIO.new
+    $stdout = out
+    
+    error   = StringIO.new
+    $stderr = error
+    
+    # Go do stuff!
+    yield    
+    return out, error
+    
+  ensure
+    $stdout = STDOUT
+    $stderr = STDERR
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+
+require 'rspec'
+require 'stringio'
+require 'coral_core'
+
+require 'coral_test_kernel'
+require 'coral_mock_input'
+
+#-------------------------------------------------------------------------------
+
+RSpec.configure do |config|
+  config.mock_framework = :rspec
+  config.color_enabled  = true
+  config.formatter      = 'documentation'
+end