shellout 0.4 → 0.5

data/lib/shellout/date_query.rb

@@ -0,0 +1,50 @@
+# -*- coding: utf-8 -*-
+require 'shellout/query'
+require 'shellout/date'
+
+module Shellout
+  class DateQuery < Query
+ 
+    def initialize
+      super("Date (?)", "today")
+    end
+   
+    def call
+      loop do
+        date = super
+        return date if date
+      end
+    end
+    
+    private
+    
+    def ask
+      answer = super
+      if answer == '?'
+        print_help
+        return
+      end
+      parse(answer)
+    end
+    
+    def parse(answer)
+      Shellout::Date.from_str(answer)
+    rescue => e
+      puts e.message
+    end
+    
+    def print_help
+      puts <<'EOT'
+Accepted input formats:
+            today - today
+           [+|-]N - ±N days from today
+              D?D - FIXME
+          M?M-D?D - FIXME
+  (YY)?YY-M?M-D?D - FIXME
+
+EOT
+       Shellout::Calendar.new.print3
+    end
+
+  end
+end

data/lib/shellout/menu.rb

@@ -1,8 +1,9 @@
 module Shellout
   class Menu
     
-    def initialize(items)
-      @items = items
+    def initialize(items, zero_item=nil)
+      @items     = items
+      @zero_item = zero_item
     end
     
     def padding; 1; end
@@ -12,6 +13,7 @@ module Shellout
       @items.each_with_index do |item, i|
         out.printf format, i+1, item
       end
+      out.printf format, 0, @zero_item unless @zero_item.nil?
     end
 
     private

data/lib/shellout/menu_query.rb

@@ -0,0 +1,51 @@
+require 'shellout/query'
+require 'shellout'
+
+module Shellout
+  class MenuQuery
+
+    include Shellout
+
+    def initialize(items, last_is_the_zero_item=false)
+      @items = items.is_a?(Array) ? Hash[*(items.zip(items).flatten)] : items
+      @has_a_zero_item = last_is_the_zero_item
+      initialize_menu
+      @prompt_class = Query
+    end
+
+    def call
+      loop do
+        @menu.print
+        answer = ask
+        return answer if answer
+        puts "Invalid user input!"
+      end
+    end
+
+    def prompt_class=(klass)
+      @prompt_class = klass
+    end
+
+    def ask
+      return @items.values[0] if only_one_option?
+      answer = @prompt_class.new('', 1).call.to_i
+      return nil if answer < 0
+      return nil if answer == 0 and !@has_a_zero_item
+      index = (@has_a_zero_item and answer == "0") ? -1 : answer.to_i-1
+      @items.values[index]
+    end
+
+    private
+    
+    def initialize_menu
+      menu_items = @items.keys
+      zero_item  = @has_a_zero_item ? menu_items.pop : nil
+      @menu = Menu(menu_items, zero_item)
+    end
+
+    def only_one_option?
+      @items.length == 1 && !@has_a_zero_item
+    end
+
+  end
+end

data/lib/shellout/paragraph.rb

@@ -0,0 +1,31 @@
+module Shellout
+  class Paragraph
+   
+    def initialize(str)
+      @str = str
+      @padding = 0
+      @width   = 80
+    end
+    
+    def width(width)
+      @width = width
+      self
+    end
+    
+    def padding(width)
+      @padding = width
+      self
+    end
+
+    def print(out=$stdout)
+      text_width = @width - @padding
+      text = ' '*@padding + @str
+      # Stolen from ActionView::Helpers::TextHelper#word_wrap
+      p = text.split("\n").collect do |line|
+        line.length > text_width ? line.gsub(/(.{1,#{text_width}})(\s+|$)/, "\\1\n" + ' '*@padding).rstrip : line
+      end * "\n"
+      out.puts p
+    end
+             
+  end
+end

data/lib/shellout/query.rb

@@ -0,0 +1,31 @@
+require 'readline'
+
+module Shellout
+  class Query
+
+    def initialize(question='', default=nil)
+      @question = question + (default.nil? ? '' : " [#{default}]")
+      @default  = default
+      @io       = Readline
+    end
+
+    def io=(io)
+      @io = io
+    end
+
+    def call
+      answer = ask
+      return answer == '' ? @default : answer
+    end
+    
+    private
+    
+    def bold(text); "\e[1m#{text}\e[0m"; end
+
+    def ask
+      answer = @io.readline(bold("#{@question}> "), true)
+      answer.strip
+    end
+    
+  end
+end

data/lib/shellout/task.rb

@@ -0,0 +1,41 @@
+module Shellout
+  class Task
+
+    # For executing sub tasks in correct order, we depend on the fact that
+    # hash iteration is in insert order
+
+    def initialize
+      @sub_tasks    = {}
+      @on_call_done = ->{}
+      yield self if block_given?
+    end
+  
+    def method_missing(name, *args)
+      super unless name =~ /=$/
+      add_sub_task(name.to_s.chop, args.first)
+    end
+    
+    def add_sub_task(name, sub)
+      @sub_tasks[name.to_sym] = sub
+    end
+
+    def printf(format)
+      @sub_tasks['printf'] = -> do
+        super(format, @results)
+      end
+    end
+  
+    def on_call_done(&callback)
+      @on_call_done = callback
+    end
+  
+    def call
+      @results = {}
+      @sub_tasks.each do |k, sub|
+        @results[k] = sub.call
+      end
+      @on_call_done.call
+    end
+
+  end  
+end

data/lib/shellout/version.rb

@@ -1,3 +1,3 @@
 module Shellout
-  VERSION = '0.4'
+  VERSION = '0.5'
 end

data/shellout.gemspec

@@ -16,9 +16,12 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- spec/*`.split("\n")
   s.require_paths = ["lib"]
 
-  s.add_development_dependency "rspec"
-  s.add_development_dependency "guard"
-  s.add_development_dependency "guard-rspec"
+  s.add_development_dependency "rspec", '2.14.1'
+  s.add_development_dependency "guard", '1.8.2'
+  s.add_development_dependency "guard-rspec", '3.0.2'
+  s.add_development_dependency "rake", '10.1.0'
+  s.add_development_dependency "cucumber", '1.3.10'
+  s.add_development_dependency "aruba", '0.5.3'
 
   if RUBY_PLATFORM.downcase.include?("darwin")
     s.add_development_dependency 'rb-fsevent'

data/spec/shellout/calendar_spec.rb

@@ -45,6 +45,35 @@ Mo Tu We Th Fr Sa Su
 17 18 19 20 21 22 23
 24 25 26 27 28 29 \e[7m30\e[0m
 31
+EOC
+    end
+
+    it 'should highlight todays date if calendar is todays month' do
+      Calendar().print(@out)
+      res = @out.string.gsub(/\s+\n/, "\n")
+      res.should == <<EOC
+    October 2011
+Mo Tu We Th Fr Sa Su
+                1  2
+ 3  4  5  6  7  8  9
+10 11 12 13 14 15 16
+17 18 19 20 21 22 23
+24 25 26 27 28 29 \e[7m30\e[0m
+31
+EOC
+    end
+
+    it 'should not highlight todays date if calendar is todays month, but not the same year' do
+      Calendar(Date.new(2012, 10, 30)).print(@out)
+      res = @out.string.gsub(/\s+\n/, "\n")
+      res.should == <<EOC
+    October 2012
+Mo Tu We Th Fr Sa Su
+ 1  2  3  4  5  6  7
+ 8  9 10 11 12 13 14
+15 16 17 18 19 20 21
+22 23 24 25 26 27 28
+29 30 31
 EOC
     end
 
@@ -79,4 +108,4 @@ Mo Tu We Th Fr Sa Su  Mo Tu We Th Fr Sa Su  Mo Tu We Th Fr Sa Su
 EOC
     end
   end
-end
+end

data/spec/shellout/command_loop_spec.rb

@@ -0,0 +1,9 @@
+require 'shellout/command_loop'
+
+module Shellout
+  describe CommandLoop do
+  
+    # It compiles!
+  
+  end
+end

data/spec/shellout/date_query_spec.rb

@@ -0,0 +1,9 @@
+require 'shellout/date_query'
+
+module Shellout
+  describe DateQuery do
+  
+  # It compiles!
+  
+  end
+end

data/spec/shellout/date_spec.rb

@@ -0,0 +1,87 @@
+require 'shellout/date'
+
+module Shellout
+  describe Date do
+    
+    describe "#from_str" do
+      
+      before(:each) do
+        @today = Date.today
+      end
+
+      
+      context "when English date string is given" do
+        it "should parse 'today'" do
+          Date.from_str("today").should == @today
+        end
+
+        it "should parse '' as 'today'" do
+          Date.from_str("").should == @today
+        end
+      end
+   
+   
+      context "when an offset is given" do
+        it "should parse '+1' as tomorrow" do
+          Date.from_str("+1").should == @today+1
+        end
+        
+        it "should parse '-1' as yesterday" do
+          Date.from_str("-1").should == @today-1
+        end
+      end
+
+
+      context "when only the day of month is given" do
+        it "should parse '1'" do
+          Date.from_str("1").should == Date.civil(@today.year, @today.month, 1)
+        end
+        
+        it "should parse '20'" do
+          Date.from_str("20").should == Date.civil(@today.year, @today.month, 20)
+        end
+      end
+
+
+      context "when the month and day of month are given" do
+        it "should parse '11-1'" do
+          Date.from_str("11-1").should == Date.civil(@today.year, 11, 1)
+        end
+        
+        it "should parse '11-01'" do
+          Date.from_str("11-01").should == Date.civil(@today.year, 11, 1)
+        end
+      end
+
+      context "when year, month, and day of month are given" do
+
+        # Two digits in year
+        it "should parse '11-11-11' as 2011-11-11" do
+          Date.from_str("11-11-11").should == Date.civil(2011, 11, 11)
+        end
+        
+        it "should parse '91-11-11' as 1991-11-11" do
+          Date.from_str("91-11-11").should == Date.civil(1991, 11, 11)
+        end
+        
+        # > Two digits in year
+        it "should parse '111-11-1' as 111-11-1" do
+          Date.from_str("111-11-1").should == Date.civil(111, 11, 1)
+        end
+        
+        it "should parse '2008-08-26' as 2008-08-26" do
+          Date.from_str("2008-08-26").should == Date.civil(2008, 8, 26)
+        end
+      end
+      
+      it "should fail on nil" do
+        expect { Date.from_str(nil) }.to raise_error(ArgumentError)
+      end
+      
+      it "should fail on strings containing junk" do
+        expect { Date.from_str("foobar") }.to raise_error(ArgumentError)
+      end
+
+    end
+  end
+end

data/spec/shellout/menu_query_spec.rb

@@ -0,0 +1,39 @@
+require 'shellout/menu_query'
+
+module Shellout
+  describe MenuQuery do
+    
+    describe "#ask" do
+      before :each do
+        @query = MenuQuery.new(%w(a b c))
+      end
+      
+      def make_prompt_return(value)
+        prompt = double('prompt')
+        prompt.stub_chain(:new, :call).and_return(value)
+        @query.prompt_class = prompt    
+      end
+
+      it "should return first element when prompt query returns '1'" do
+        make_prompt_return('1')
+        @query.ask.should == 'a'
+      end
+
+      it "should return second element when prompt query returns '2'" do
+        make_prompt_return('2')
+        @query.ask.should == 'b'
+      end
+
+      it "should return nil if user answer is invalid (too large)" do
+        make_prompt_return('9')
+        @query.ask.should == nil
+      end
+
+      it "should return nil if user answer is invalid (0)" do
+        make_prompt_return('0')
+        @query.ask.should == nil
+      end
+    end
+    
+  end
+end

data/spec/shellout/menu_spec.rb

@@ -1,31 +1,32 @@
 require 'stringio'
 require 'shellout'
 
-describe Shellout::Menu do
+module Shellout
+  describe Menu do
 
-  include Shellout
+    include Shellout
 
-  before(:each) do
-    @out = StringIO.new
-  end
+    before(:each) do
+      @out = StringIO.new
+    end
 
-  it "should work for a basic example" do
-    Menu(%w(a b c)).print(@out)
-    @out.string.should == <<EOT
+    it "should work for a basic example" do
+      Menu(%w(a b c)).print(@out)
+      @out.string.should == <<EOT
  1. a
  2. b
  3. c
 EOT
-  end
+    end
 
-  it "should print nothing when no items are given" do
-    Menu([]).print(@out)
-    @out.string.should == ''
-  end
+    it "should print nothing when no items are given" do
+      Menu([]).print(@out)
+      @out.string.should == ''
+    end
 
-  it "should right justify the menu item number" do
-    Menu(('a'..'j').to_a).print(@out)
-    @out.string.should == <<EOT
+    it "should right justify the menu item number" do
+      Menu(('a'..'j').to_a).print(@out)
+      @out.string.should == <<EOT
   1. a
   2. b
   3. c
@@ -37,7 +38,17 @@ EOT
   9. i
  10. j
 EOT
-  end
+    end
     
-
+    it "should put the zero item last, prefixed by a '0.'" do
+        Menu(%w(a b c), 'd').print(@out)
+        @out.string.should == <<EOT
+ 1. a
+ 2. b
+ 3. c
+ 0. d
+EOT
+    end
+  
+  end
 end