shellout 0.4 → 0.5

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3

data/.travis.yml

@@ -0,0 +1,2 @@
+rvm:
+    - 1.9.3

data/CHANGES

@@ -1,3 +1,8 @@
+2013-12-02: version 0.5
+
+ - Fixed a bug in the calendar causing it to highlight a date in the
+   future that has the same month and day in month as today.
+
 2011-12-03: version 0.4
 
  - Added a class for printing menus

data/Gemfile

@@ -1,4 +1,3 @@
-source "http://rubygems.org"
-
-gemspec
+source 'https://rubygems.org'
 
+gemspec

data/README.md

@@ -1,3 +1,5 @@
+[![Build Status](https://secure.travis-ci.org/kjellm/shellout.png)](http://travis-ci.org/kjellm/shellout)
+
 Shellout
 ========
 
@@ -19,62 +21,63 @@ Usage
 
 ### Shadowboxes
 
-    Shadowbox("Hello world").print
+    > Shadowbox("Hello world").print
     
-    # ┌──────────────────────────────────────────┐ 
-    # │               Hello world                │▒
-    # └──────────────────────────────────────────┘▒
-    #   ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
+    ┌──────────────────────────────────────────┐ 
+    │               Hello world                │▒
+    └──────────────────────────────────────────┘▒
+      ▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒
 
 ### Tables
 
-    Table(headers: %w{Team Points},
-	        rows: [['Man City', 22],
-	               ['Man Utd', 20],
-	               ['Chelsea', 19],
-	               ['Newcastle', 16]]).print
+    > Table(headers: %w{Team Points},
+    	       rows: [['Man City', 22],
+    	              ['Man Utd', 20],
+    	              ['Chelsea', 19],
+    	              ['Newcastle', 16]]).print
 	
-    # ┌───────────┬────────┐
-    # │   Team    │ Points │
-    # ├───────────┼────────┤
-    # │ Man City  │     22 │
-    # │ Man Utd   │     20 │
-    # │ Chelsea   │     19 │
-    # │ Newcastle │     16 │
-    # └───────────┴────────┘
+    ┌───────────┬────────┐
+    │   Team    │ Points │
+    ├───────────┼────────┤
+    │ Man City  │     22 │
+    │ Man Utd   │     20 │
+    │ Chelsea   │     19 │
+    │ Newcastle │     16 │
+    └───────────┴────────┘
   
 
 ### Calendars
 
-    today = Date.today # => "2011-10-31"
+    > today = Date.today
+     => #<Date: 2011-10-31 (...)>
     
-    Calendar(today).print
+    > Calendar(today).print
     
-    #     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 30
-    # 31
+         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 30
+     31
     
-    Calendar(today).print3
+    > Calendar(today).print3
     
-    #                                 2011
-    #      September                October                 November
-    # Mo Tu We Th Fr Sa Su    Mo Tu We Th Fr Sa Su    Mo Tu We Th Fr Sa Su
-    #           1  2  3  4                    1  2        1  2  3  4  5  6
-    #  5  6  7  8  9 10 11     3  4  5  6  7  8  9     7  8  9 10 11 12 13
-    # 12 13 14 15 16 17 18    10 11 12 13 14 15 16    14 15 16 17 18 19 20
-    # 19 20 21 22 23 24 25    17 18 19 20 21 22 23    21 22 23 24 25 26 27
-    # 26 27 28 29 30          24 25 26 27 28 29 30    28 29 30
-    #                         31
+                                     2011
+          September                October                 November
+     Mo Tu We Th Fr Sa Su    Mo Tu We Th Fr Sa Su    Mo Tu We Th Fr Sa Su
+               1  2  3  4                    1  2        1  2  3  4  5  6
+      5  6  7  8  9 10 11     3  4  5  6  7  8  9     7  8  9 10 11 12 13
+     12 13 14 15 16 17 18    10 11 12 13 14 15 16    14 15 16 17 18 19 20
+     19 20 21 22 23 24 25    17 18 19 20 21 22 23    21 22 23 24 25 26 27
+     26 27 28 29 30          24 25 26 27 28 29 30    28 29 30
+                             31
 
 
 ### Menus
 
-    Menu([
+    > Menu([
       "Do this",
       "No, this",
       "Or, maybe this",
@@ -89,18 +92,18 @@ Usage
       "Might as well choose this one",
     ]).print
     
-    #  1. Do this
-    #  2. No, this
-    #  3. Or, maybe this
-    #  4. Forget it, this is the right choice
-    #  5. Amazing things will happen if you choose this
-    #  6. Ignore #5. Pick me!
-    #  7. I'm the obvious choice
-    #  8. There is no end to the awesomeness that will come from choosing this
-    #  9. Don't choose this
-    # 10. Or this
-    # 11. Things are getting worse
-    # 12. Might as well choose this one
+      1. Do this
+      2. No, this
+      3. Or, maybe this
+      4. Forget it, this is the right choice
+      5. Amazing things will happen if you choose this
+      6. Ignore #5. Pick me!
+      7. I'm the obvious choice
+      8. There is no end to the awesomeness that will come from choosing this
+      9. Don't choose this
+     10. Or this
+     11. Things are getting worse
+     12. Might as well choose this one
 
 Bugs
 ----
@@ -111,7 +114,7 @@ Report bugs to <http://github.com/kjellm/shellout/issues>
 Author
 ------
 
-Kjell-Magne Øierud &lt;kjellm AT acm DOT org&gt;
+Kjell-Magne Øierud &lt;kjellm AT oierud DOT net&gt;
 
 
 License
@@ -119,7 +122,7 @@ License
 
 (The MIT License)
 
-Copyright © 2011 Kjell-Magne Øierud
+Copyright © 2011-2013 Kjell-Magne Øierud
 
 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

data/Rakefile

@@ -1 +1,8 @@
-require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new

data/example/bin/hunger.rb

@@ -0,0 +1,67 @@
+#!/usr/bin/env ruby
+
+require 'shellout'
+require 'shellout/command_loop'
+require 'shellout/date_query'
+require 'shellout/menu_query'
+require 'shellout/task'
+require 'shellout/query'
+
+class App
+
+  include Shellout
+
+  def initialize
+    @session = []
+  end
+
+  def define_course_task(dishes)
+    Task.new do |t|
+      t.dish     = MenuQuery.new(dishes)
+      t.quantity = Query.new('How many?', 1)
+      t.printf("%{quantity} %{dish} added to your order\n")
+      t.on_call_done do
+        @session << t
+      end
+    end
+  end
+  
+  def main
+  
+    starters_task    = define_course_task(%w(Gazpacho Bruschetta))
+    main_course_task = define_course_task(%w(Pizza Pasta))
+    desserts_task    = define_course_task(%w(Gelato Tiramisu))
+  
+    checkout_task = Task.new do |t|
+      t.date = DateQuery.new
+      t.name = Query.new("Your name")
+      t.on_call_done do
+        confirmed = Query.new("Confirm (y|n)").call
+        @session = [] if confirmed == 'y'
+      end
+    end
+    
+    view_order_task = ->do
+      #FIXME ugly
+      rows = @session.map do |t|
+        [t.instance_variable_get(:@results)[:quantity], t.instance_variable_get(:@results)[:dish]]
+      end
+      Table(headers: %w(quantity dish), rows: rows).print
+    end
+    
+    main_menu_items = {
+      "Starters"      => starters_task,
+      "Main courses"  => main_course_task,
+      "Desserts"      => desserts_task,
+      "View Order"    => view_order_task,
+      "Checkout"      => checkout_task,
+      "Exit"          => ->{ exit }
+    }
+    main_menu = MenuQuery.new(main_menu_items, true)
+    
+    Shadowbox("Give up to your hunger!").print
+    CommandLoop.new(main_menu).call
+  end
+end
+
+App.new.main

data/example/features/order_a_pizza.feature

@@ -0,0 +1,12 @@
+Feature: Order a Pizza
+  As a pathetic person who is unable to make my own supper
+  I want to order a pizza for tomorrows supper
+  In order to not starve to death
+  
+  Scenario: Order a Pizza
+    Given that hunger is running
+    When I choose main course from the main menu
+     And I choose Pizza from the main course menu
+     And I choose the default quantity
+     And I quit 
+    Then I should see "1 Pizza added to your order"

data/example/features/start_the_app.feature

@@ -0,0 +1,11 @@
+Feature: Start the app
+  As a user of the system
+  I want to be able to start the system
+  In order to be able to use the system
+  
+  Scenario: Start the app
+    Given that hunger is not running
+    When I start hunger
+     And I quit
+    Then I shall see a greeting
+     And I shall see the main menu

data/example/features/step_definitions/hunger_steps.rb

@@ -0,0 +1,71 @@
+Given /^that hunger is not running$/ do
+end
+
+When /^I start hunger$/ do
+  steps %{When I run `hunger.rb` interactively}
+end
+
+When /^I quit$/ do
+  steps %{When I type "6"}
+end
+
+Then /^I shall see a greeting$/ do
+  steps %{Then the stdout should contain "Give up to your hunger!"}
+end
+
+Then /^I shall see the main menu$/ do
+  steps %{Then the stdout should contain:
+    """
+     1. Starters
+     2. Main courses
+     3. Desserts
+     4. View Order
+     5. Checkout
+     0. Exit
+    """
+    }
+end
+
+Given /^that hunger is running$/ do
+  steps %{When I start hunger}
+end
+
+When /^I choose main course from the main menu$/ do
+  steps %{When I type "2"}
+end
+
+When /^I choose Pizza from the main course menu$/ do
+  steps %{When I type "1"}
+end
+
+When /^I choose the default quantity$/ do
+  steps %{When I type ""}
+end
+
+Then /^I should see "([^"]*)"$/ do |arg1|
+  steps %{Then the stdout should contain "#{arg1}"}
+end
+
+Given /^I order (\d+) Pizza$/ do |quantity|
+  steps %{
+    When I type "2"
+    When I type "1"
+    When I type "#{quantity}"
+  }
+end
+
+Given /^I order (\d+) Gelato$/ do |quantity|
+  steps %{
+    When I type "3"
+    When I type "1"
+    When I type "#{quantity}"
+  }
+end
+
+Given /^I choose to view ordered dishes$/ do
+  steps %{When I type "4"}
+end
+
+Then /^I should see:$/ do |string|
+  steps %{Then the stdout should contain "#{string}"}
+end

data/example/features/support/env.rb

@@ -0,0 +1 @@
+require 'aruba/cucumber'

data/example/features/view_order.feature

@@ -0,0 +1,14 @@
+Feature: View ordered dishes
+  As a user
+  I want to be able to see what I have ordered
+  So that I can verify that the system has gotten it right
+  
+  Scenario: view ordered dishes
+    Given that hunger is running
+      And I order 1 Pizza
+      And I order 2 Gelato
+      And I choose to view ordered dishes
+      And I quit
+     Then I should see "┌──────────┬────────┐\n│ quantity │  dish  │\n├──────────┼────────┤\n│        1 │ Pizza  │\n│        2 │ Gelato │\n└──────────┴────────┘"
+     #FIXME Could not get multiline pystrings to work (lexing error)
+

data/lib/shellout/calendar.rb

@@ -63,7 +63,7 @@ module Shellout
       # FIXME: UGLY!!!
       foo = dates.map do |for_date|
         bar = days(for_date)
-        if is_current_month?(for_date)
+        if is_current_month?(for_date) && is_current_year?(for_date)
           bar.map! {|d| d == Date.today.day  ? ansi_reverse_color(d) : d}
         end
         bar
@@ -91,6 +91,10 @@ module Shellout
       Date.today.month == date.month
     end
     
+    def is_current_year?(date)
+      Date.today.year == date.year
+    end
+    
     def days(for_date)
       days = (1..last_day_of_month(for_date).day).to_a
       unshift_empty_strings_for_missing_week(days, for_date)
@@ -117,4 +121,4 @@ module Shellout
     
     
   end
-end
+end

data/lib/shellout/command_loop.rb

@@ -0,0 +1,21 @@
+
+module Shellout
+  class CommandLoop
+    
+    def initialize(menu)
+      @menu = menu
+    end
+    
+    def call
+      loop do
+        begin
+          task = @menu.call
+          task.call
+        rescue Interrupt    # ^C
+          puts              # Add a new line in case we are prompting
+        end
+      end
+    end
+    
+  end
+end

data/lib/shellout/date.rb

@@ -0,0 +1,55 @@
+require 'date'
+
+module Shellout
+  class Date < ::Date
+    
+    def self.from_str(date_str, base=Date.today)
+      raise ArgumentError.new("Can't convert nil to a Date") \
+        if date_str.nil?
+      
+      args = [date_str, base]
+      return parse_str_from_english(*args) \
+          || parse_str_from_offset(*args)  \
+          || parse_str_from_ymd(*args)     \
+          || (raise ArgumentError.new(
+                "Failed to convert String(#{date_str}) to a Date"))
+    end
+
+    private
+
+    def self.parse_str_from_english(date_str, base)
+      return base if date_str == 'today' || date_str.empty?
+      return nil
+    end
+      
+    def self.parse_str_from_offset(date_str, base)
+      return case date_str.chars.first
+      when '-'
+        base - Integer(date_str[1..-1])
+      when '+'
+        base + Integer(date_str[1..-1])
+      else
+        nil
+      end
+    end
+      
+    def self.parse_str_from_ymd(date_str, base)
+      date = date_str.split('-').collect {|d| d.to_i}
+      case date.length
+      when 1
+        return Date.civil(base.year, base.month, *date)
+      when 2
+        return Date.civil(base.year, *date)
+      when 3
+        if date[0] < 70
+          date[0] += 2000 
+        elsif date[0] < 100
+          date[0] += 1900
+        end 
+        return Date.civil(*date)
+      end
+      return nil
+    end
+    
+  end
+end