rdialogy 0.1.0

data/lib/rdialogy/infobox.rb

@@ -0,0 +1,10 @@
+require File.dirname(__FILE__) + '/base'
+
+module RDialogy
+  class InfoBox < Base
+    private
+    def self.command
+      'infobox'
+    end   
+  end
+end

data/lib/rdialogy/inputbox.rb

@@ -0,0 +1,16 @@
+require File.dirname(__FILE__) + '/base'
+
+module RDialogy
+  class InputBox < Base
+    private
+    def self.command
+      'inputbox'
+    end
+
+    def self.args(options={})
+      base_args = super
+      base_args << options[:init] unless options[:init].nil?
+      base_args
+    end
+  end
+end

data/lib/rdialogy/inputmenu.rb

@@ -0,0 +1,41 @@
+require File.dirname(__FILE__) + '/base'
+require File.dirname(__FILE__) + '/menu_item'
+
+module RDialogy
+  class InputMenu < Base
+
+    def self.run(options={})
+      super options, true do |input|
+        if input =~ /^RENAMED/
+          input.split(' ')[1..-1]
+        else
+          input.chomp
+        end
+      end
+    end
+
+# Formats the hash into an ordered list, valid options are:
+# * :text - Title of the widget
+# * :width
+# * :height
+# * :list_height - Number of items to display in the list
+# * :items - Array of MenuItem
+
+    def self.args(options={})
+      options[:items] ||= []
+      options[:list_height] ||= options[:items].count * 3
+
+      options[:items].map! do |item|
+        [item.tag, item.item]
+      end
+
+      super + [options[:list_height]] + options[:items].flatten
+    end
+
+# Maps to the appropriate dialog argument
+    def self.command
+      'inputmenu'
+    end
+
+  end
+end

data/lib/rdialogy/menu.rb

@@ -0,0 +1,22 @@
+require File.dirname(__FILE__) + '/base'
+require File.dirname(__FILE__) + '/menu_item'
+
+module RDialogy
+  class Menu < Base
+    def self.run(options={})
+      super options, true do |input|
+        input.chomp
+      end
+    end
+
+    def self.command
+      'menu'
+    end
+
+    def self.args(options={})
+      options[:items] ||= []
+      options[:list_height] ||= options[:items].count
+      super + [options[:list_height]] + options[:items].map{|e| [e.tag, e.item] }.flatten
+    end
+  end
+end

data/lib/rdialogy/menu_item.rb

@@ -0,0 +1,2 @@
+class MenuItem < Struct.new(:tag, :item, :status)
+end

data/lib/rdialogy/message_box.rb

@@ -0,0 +1,10 @@
+require File.dirname(__FILE__) + '/base'
+
+module RDialogy
+  class MessageBox < Base
+    private
+    def self.command
+      'msgbox'
+    end   
+  end
+end

data/lib/rdialogy/mixedgauge.rb

@@ -0,0 +1,32 @@
+require File.dirname(__FILE__) + '/base'
+require File.dirname(__FILE__) + '/menu_item'
+
+#    A mixedgauge box displays a meter along the bottom of the box.  The meter indicates the percentage.
+#    It also displays a list of the tag- and item-values at the top of the box.
+#    The text is shown as a caption between the list and meter.  The :percent value denotes the initial percentage shown in the
+#    meter.
+#    MixedGauge does not provide any method for updating the percentage in a single instance as Gauge does
+#    The widget accepts no input and returns true.
+
+module RDialogy
+
+  class MixedGauge < Base
+# Valid options:
+# * :text,
+# * :width,
+# * :height,
+# * :percent - The percentage progress indicated by the gauge.
+# * :items - An array of MenuItem objects
+
+    def self.args(options={})
+      options[:percent] ||= 0
+      options[:items] ||= []
+      super + [options[:percent].to_i] + options[:items].map{|e| [e.tag, e.item] }.flatten
+    end
+
+    def self.command
+      'mixedgauge'
+    end
+  end
+end
+

data/lib/rdialogy/passwordbox.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + '/base'
+
+module RDialogy
+# A password box  is  similar  to  an input box, except that the text the user enters is not displayed.  This is useful when
+# prompting for passwords or other sensitive information.
+  class PasswordBox < Base
+    def self.run(options={})
+      super options, true
+    end
+
+    def self.command
+      'passwordbox'
+    end
+  end
+end

data/lib/rdialogy.rb

@@ -0,0 +1,21 @@
+class Rdialogy
+  VERSION = '0.1.0'
+end
+
+$LOAD_PATH << File.expand_path(File.dirname(__FILE__))
+
+require 'rdialogy/base'
+require 'rdialogy/message_box'
+require 'rdialogy/calendar'
+require 'rdialogy/checklist'
+require 'rdialogy/dselect'
+require 'rdialogy/editbox'
+require 'rdialogy/form'
+require 'rdialogy/gauge'
+require 'rdialogy/inputbox'
+require 'rdialogy/inputmenu'
+require 'rdialogy/infobox'
+require 'rdialogy/fselect'
+require 'rdialogy/menu'
+require 'rdialogy/mixedgauge'
+require 'rdialogy/passwordbox'

data/spec/base_spec.rb

@@ -0,0 +1,30 @@
+require [File.dirname(__FILE__), 'spec_helper'].join '/'
+
+spec_require __FILE__
+
+describe RDialogy::Base do
+  describe ".command" do
+    it "should raise an error" do
+      lambda { RDialogy::Base.command }.should raise_error
+    end
+  end
+
+  describe ".args" do
+    describe "without any options supplied" do
+      it "should return an array of defaults" do
+        RDialogy::Base.args.should == ['default title', 0, 0]
+      end
+    end
+  end
+
+  describe ".add_quotes" do
+    it "should return quoted strings" do
+      RDialogy::Base.add_quotes([1, 2]).should == ["'1'", "'2'"]
+    end
+
+    it "should escape single quotes inside the strings" do
+      RDialogy::Base.add_quotes(["Kitten's feet"]).should == ["'Kitten'\\''s feet'"]
+    end
+  end
+end
+

data/spec/calendar_spec.rb

@@ -0,0 +1,41 @@
+require [File.dirname(__FILE__), 'spec_helper'].join '/'
+
+spec_require __FILE__
+
+describe RDialogy::Calendar do
+  describe ".command" do
+    it "should return calendar" do
+      RDialogy::Calendar.command.should == 'calendar'
+    end
+  end
+
+  describe ".run" do
+    before :each do
+      require 'stringio'
+
+      data = StringIO.new "01/05/2010\n"
+      tmp = mock('tempfile')
+      Tempfile.stub!(:new).and_return(tmp)
+      tmp.stub!(:path).and_return('/tmp/tempfile')
+      tmp.stub!(:readline).and_return { data.readline }
+      tmp.stub!(:close)
+
+      @expectation = "dialog --calendar 'hello world' '0' '0'"
+    end
+
+    describe "with no date arguments" do
+      it "should call external dialog" do
+        RDialogy::Calendar.should_receive(:system).with(/#{@expectation}/)
+        RDialogy::Calendar.run(:text => 'hello world').should == Time.mktime(2010, 5, 1)
+      end
+    end
+
+    describe "with date arguments" do
+      it "should call external dialog with the date arguments after the normal ones" do
+        RDialogy::Calendar.should_receive(:system).with(/#{@expectation} '17' '11' '1985'/)
+        args = { :text => 'hello world', :year => 1985, :month => 11, :day => 17 }
+        RDialogy::Calendar.run(args)
+      end
+    end
+  end
+end

data/spec/checklist_spec.rb

@@ -0,0 +1,41 @@
+require [File.dirname(__FILE__), 'spec_helper'].join '/'
+
+spec_require __FILE__
+
+describe RDialogy::Checklist do
+  describe ".command" do
+    it "should return checklist" do
+      RDialogy::Checklist.command.should == 'checklist'
+    end
+  end
+
+  describe ".run" do
+    before :each do
+      require 'stringio'
+
+      data = StringIO.new '"bread" "milk"' + "\n"
+
+      tmp = mock('tempfile')
+      Tempfile.stub!(:new).and_return(tmp)
+      tmp.stub!(:path).and_return('/tmp/tempfile')
+      tmp.stub!(:readline).and_return { data.readline }
+      tmp.stub!(:close)
+
+      @items = %w(bread milk cheese).map{|e| MenuItem.new(e, e)}
+      @expectation = "dialog --checklist 'hello world' '0' '0' '3'"
+    end
+
+    describe "with no :list_height" do
+      it "should use the number of _items_ as list height" do
+        RDialogy::Checklist.should_receive(:system).with(/#{@expectation}/)
+        RDialogy::Checklist.run(:text => 'hello world', :items => @items)
+      end
+    end
+
+    it "should return an array of the selected tags" do
+      args = { :text => 'hello world', :items => @items }
+      RDialogy::Checklist.should_receive(:system).with(/#{@expectation}/)
+      RDialogy::Checklist.run(args).should == ['bread', 'milk']
+    end
+  end
+end

data/spec/dselect_spec.rb

@@ -0,0 +1,38 @@
+require [File.dirname(__FILE__), 'spec_helper'].join '/'
+
+spec_require __FILE__
+
+describe RDialogy::DSelect do
+  describe ".command" do
+    it "should return 'dselect'" do
+      RDialogy::DSelect.command.should == 'dselect'
+    end
+  end
+
+  describe ".run" do
+    before :each do
+      require 'stringio'
+
+      data = StringIO.new '/var/www/Eliza_Dushku'
+
+      tmp = mock('tempfile')
+      Tempfile.stub!(:new).and_return(tmp)
+      tmp.stub!(:path).and_return('/tmp/tempfile')
+      tmp.stub!(:readline).and_return { data.readline }
+      tmp.stub!(:close)
+
+      @expectation = "dialog --dselect '/var/www' '0' '0'"
+    end
+
+    it "should use :path as the first argument" do
+      RDialogy::DSelect.should_receive(:system).with(/#{@expectation}/)
+      RDialogy::DSelect.run(:path => '/var/www')
+    end
+
+    it "should return a string" do
+      args = { :path => '/var/www' }
+      RDialogy::DSelect.should_receive(:system).with(/#{@expectation}/)
+      RDialogy::DSelect.run(args).should == '/var/www/Eliza_Dushku'
+    end
+  end
+end

data/spec/form_spec.rb

@@ -0,0 +1,47 @@
+require [File.dirname(__FILE__), 'spec_helper'].join '/'
+
+spec_require __FILE__
+
+describe RDialogy::Form do
+  describe ".command" do
+    it 'should return "form"' do
+      RDialogy::Form.command.should == 'form'
+    end
+  end
+
+    describe ".run" do
+    before :each do
+      require 'stringio'
+
+      data = StringIO.new "Paul\n42\n"
+
+      tmp = mock('tempfile')
+      Tempfile.stub!(:new).and_return(tmp)
+      tmp.stub!(:path).and_return('/tmp/tempfile')
+      tmp.stub!(:readline).and_return { data.readline }
+      tmp.stub!(:close)
+
+      @items = [
+        ['name', 1, 1, '', 1, 5, 5, 10],
+        ['age', 2, 1, '', 2, 5, 5, 10]
+      ]
+      @expectation = "dialog --form 'hello world' '0' '0' '2' " +
+        @items.flatten.map{|e| "'#{e}'" }.join(' ')
+
+      @items.map!{|e| FormField.new(*e)}
+    end
+
+    describe "with no :list_height" do
+      it "should use the number of _items_ as list height" do
+        RDialogy::Form.should_receive(:system).with(/#{@expectation}/)
+        RDialogy::Form.run(:text => 'hello world', :items => @items)
+      end
+    end
+
+    it "should return an hash of the user inputs" do
+      args = { :text => 'hello world', :items => @items }
+      RDialogy::Form.should_receive(:system).with(/#{@expectation}/)
+      RDialogy::Form.run(args).should == {'name' => 'Paul', 'age' => '42' }
+    end
+  end
+end

data/spec/fselect_spec.rb

@@ -0,0 +1,11 @@
+require [File.dirname(__FILE__), 'spec_helper'].join '/'
+
+spec_require __FILE__
+
+describe RDialogy::FSelect do
+  describe ".command" do
+    it "should return 'fselect'" do
+      RDialogy::FSelect.command.should == 'fselect'
+    end
+  end
+end

data/spec/infobox_spec.rb

@@ -0,0 +1,18 @@
+require [File.dirname(__FILE__), 'spec_helper'].join '/'
+
+spec_require __FILE__
+
+describe RDialogy::InfoBox do
+  describe ".command" do
+    it "should return infobox" do
+      RDialogy::InfoBox.command.should == 'infobox'
+    end
+  end
+
+  describe ".run" do
+    it "should return dialog run string" do
+      RDialogy::InfoBox.should_receive(:system).with("dialog --infobox 'hello world' '0' '0'")
+      RDialogy::InfoBox.run(:text => 'hello world')
+    end
+  end
+end

data/spec/inputbox_spec.rb

@@ -0,0 +1,30 @@
+require [File.dirname(__FILE__), 'spec_helper'].join '/'
+
+spec_require __FILE__
+
+describe RDialogy::InputBox do
+  describe ".command" do
+    it "should return inputbox" do
+      RDialogy::InputBox.command.should == 'inputbox'
+    end
+  end
+
+  describe ".args" do
+    before :each do
+      @args = { :text => "Hello", :height => 4, :width => 5 }
+    end
+
+    describe "when :init is not an option" do
+      it "should call dialog with base args only" do
+        RDialogy::InputBox.args(@args).should == ['Hello', 4, 5]
+      end
+    end
+
+    describe "when :init is an option" do
+      it "should call dialog with base args + the value of init" do
+        @args[:init] = "Catfish"
+        RDialogy::InputBox.args(@args).should == ['Hello', 4, 5, 'Catfish']
+      end
+    end
+  end
+end

data/spec/inputmenu_spec.rb

@@ -0,0 +1,56 @@
+require [File.dirname(__FILE__), 'spec_helper'].join '/'
+require 'stringio'
+
+spec_require __FILE__
+
+describe RDialogy::InputMenu do
+  describe ".command" do
+    it "should return inputmenu" do
+      RDialogy::InputMenu.command.should == 'inputmenu'
+    end
+  end
+
+  describe ".run" do
+    def stub_tempfile(value)
+      data = StringIO.new value
+
+      tmp = mock('tempfile')
+      Tempfile.stub!(:new).and_return(tmp)
+      tmp.stub!(:path).and_return('/tmp/tempfile')
+      tmp.stub!(:readline).and_return { data.readline }
+      tmp.stub!(:close)
+    end
+
+    before :each do
+      @items = %w(grapes bread milk cheese).map{|e| MenuItem.new(e, e)}
+      RDialogy::InputMenu.stub!(:system)
+    end
+
+    describe "when the user doesn't rename an object" do
+      it "should return the tag of the object as a string" do
+        stub_tempfile "grapes\n"
+        RDialogy::InputMenu.run(:text => 'hello world', :items => @items).should == 'grapes'
+      end
+    end
+
+    describe "when the user does rename an object" do
+      it "should return an array containing the tag and the new value" do
+        stub_tempfile "RENAMED grapes sultanas\n"
+        RDialogy::InputMenu.run(:text => 'hi', :items => @items).should == ['grapes', 'sultanas']
+      end
+    end
+  end
+
+  describe ".args" do
+    before :each do
+      @items = %w(grapes bread milk cheese).map{|e| MenuItem.new(e, e)}
+      @args = {:text => "hello world", :items => @items }
+    end
+    
+    describe "list height" do
+      it "should be 3 times the number of list elements" do
+        RDialogy::InputMenu.args(@args)[3].should == 12
+      end
+    end
+  end
+end

data/spec/menu_spec.rb

@@ -0,0 +1,41 @@
+require [File.dirname(__FILE__), 'spec_helper'].join '/'
+
+spec_require __FILE__
+
+describe RDialogy::Menu do
+  describe ".command" do
+    it "should return menu" do
+      RDialogy::Menu.command.should == 'menu'
+    end
+  end
+
+  describe ".run" do
+    before :each do
+      require 'stringio'
+
+      data = StringIO.new 'bread' + "\n"
+
+      tmp = mock('tempfile')
+      Tempfile.stub!(:new).and_return(tmp)
+      tmp.stub!(:path).and_return('/tmp/tempfile')
+      tmp.stub!(:readline).and_return { data.readline }
+      tmp.stub!(:close)
+
+      @items = %w(bread milk cheese).map{|e| MenuItem.new(e, e)}
+      @expectation = "dialog --menu 'hello world' '0' '0' '3'"
+    end
+
+    describe "with no :list_height" do
+      it "should use the number of _items_ as list height" do
+        RDialogy::Menu.should_receive(:system).with(/#{@expectation}/)
+        RDialogy::Menu.run(:text => 'hello world', :items => @items)
+      end
+    end
+
+    it "should return a string that is the tag of the selected item" do
+      args = { :text => 'hello world', :items => @items }
+      RDialogy::Menu.should_receive(:system).with(/#{@expectation}/)
+      RDialogy::Menu.run(args).should == 'bread'
+    end
+  end
+end

data/spec/message_box_spec.rb

@@ -0,0 +1,18 @@
+require [File.dirname(__FILE__), 'spec_helper'].join '/'
+
+spec_require __FILE__
+
+describe RDialogy::MessageBox do
+  describe ".command" do
+    it "should return msgbox" do
+      RDialogy::MessageBox.command.should == 'msgbox'
+    end
+  end
+
+  describe ".run" do
+    it "should return dialog run string" do
+      RDialogy::MessageBox.should_receive(:system).with("dialog --msgbox 'hello world' '0' '0'")
+      RDialogy::MessageBox.run(:text => 'hello world')
+    end
+  end
+end

data/spec/passwordbox_spec.rb

@@ -0,0 +1,29 @@
+require [File.dirname(__FILE__), 'spec_helper'].join '/'
+
+spec_require __FILE__
+
+describe RDialogy::PasswordBox do
+  describe ".command" do
+    it "should return passwordbox" do
+      RDialogy::PasswordBox.command.should == 'passwordbox'
+    end
+  end
+
+  describe ".run" do
+    it "should return the string that is input by the user" do
+      require 'stringio'
+
+      data = StringIO.new "sexmachine41"
+
+      tmp = mock('tempfile')
+      Tempfile.stub!(:new).and_return(tmp)
+      tmp.stub!(:path).and_return('/tmp/tempfile')
+      tmp.stub!(:readline).and_return { data.readline }
+      tmp.stub!(:close)
+
+      expectation = /--passwordbox 'Enter password'/
+      RDialogy::PasswordBox.should_receive(:system).with(expectation)
+      RDialogy::PasswordBox.run(:text => "Enter password").should == "sexmachine41"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+$LOAD_PATH << File.dirname(__FILE__)+'/../lib/rdialogy'
+
+def spec_require(file)
+	#puts $LOAD_PATH.inspect
+	require file.scan(/.*\/(.*)_spec.rb/).flatten.first
+end