zerenity 1.3

data/CHANGELOG

@@ -0,0 +1,21 @@
+= Zerenity Changelog
+== 1.3
+* Added a color selection dialog
+== 1.2
+* Added the scale dialog, allowing the user to use a slider to choose a numerical value.
+== 1.1
+* From this version the OK button is set as the default widget. Pressing Enter
+  in a dialog will cause it to be fired. If you do not want your dialog to have 
+  this behavior set the :activatesDefault option to false. Note that certain widgets
+  (List, FileSelection and TextInfo when :editable is set) do not allow this as Enter
+  could be used for other actions. Originally suggested by Justin Collins.
+* Instead of passing a Gtk::VBox to the build and retrieve_selection methods, now 
+  pass in the parent Gtk::Dialog. 
+== 1.0
+* Added significant unit testing and code coverage testing.
+== 0.9
+* Added a :password option to the Entry dialog. When set to true it will
+  treat the text entry like a password entry and replaces the characters
+  entered with a '*'.
+== 0.8
+* Initial release.

data/README

@@ -0,0 +1,63 @@
+= Zerenity
+
+== Version
+1.3
+
+== Author
+Farrel Lifson http://www.lifson.info http://www.aimred.com
+
+== Contributors
+Daniel Lucraft http://www.daniellucraft.com
+
+== Synopsis 
+Zerenity is an almost clone of Zenity(http://freshmeat.net/projects/zenity) for Ruby. It allows for the easy creation of simple graphical dialogs from a Ruby script.
+
+== Features
+Zerenity allows for the creation of the following dialogs
+* Date selection
+* Text entry
+* Error display 
+* File/directory selection
+* Information display 
+* List display and selection 
+* Progress display
+* Question display
+* Text information display and editing 
+* Warning display 
+* Sliding scales
+* Color selection
+
+== Dependencies
+Zerenity requires GTK2(http://www.gtk.org) and Ruby/GTK2(http://ruby-gnome2.sourceforge.jp/hiki.cgi).
+
+== Installation
+Zerenity is avaiable as a Ruby gem. Links to the latest release can be found at http://www.aimred.com/files/projects/zerenity.
+
+The code is also available via it's Github repository at http://github.com/farrel/zerenity/tree/master 
+
+== Example Usage
+=== User Input and Display
+ require 'zerenity'
+
+ if (name = Zerenity::Entry(:text=>"What is your name?")) 
+   Zerenity::Info(:text=>"Hello #{name}")
+ else
+   puts "No name entered"
+ end
+
+=== Progress
+ require 'zerenity'
+
+ fileList = filesToProcess(folder)
+ Zerenity::Progress(:text=>'Processing files',:autoClose=>true) do |progress|
+  fileList.each_index do |file,index|
+    processFile(file)
+    progress.update(index/fileList.length,"#{100*index/fileList.length}% processed...")
+  end
+ end
+
+== License
+Zerenity is released under the BSD license.
+
+== Copyright 
+(c) 2006 - 2009 Farrel Lifson 

data/examples/example_calendar.rb

@@ -0,0 +1,6 @@
+require('zerenity/calendar')
+
+date = Zerenity::Calendar(:text=>"What day is your birthday?",:title=>"Please select a date")
+
+puts "You selected #{date.to_s}" if date
+puts "You didn't select a date" unless date

data/examples/example_colorselection.rb

@@ -0,0 +1,5 @@
+require( 'zerenity/colorselection' )
+
+color = Zerenity::ColorSelection( :title => "Choose a color" )
+
+puts "You chose #{ color || 'nothing' }"

data/examples/example_entry.rb

@@ -0,0 +1,16 @@
+require('zerenity/entry')
+
+name = Zerenity::Entry(:text=>"Please enter your name", :ok_button => "Go!", :cancel_button => "Forget it")
+puts "Hello #{name}" if name
+puts "You did not enter your name" unless name
+
+text = Zerenity::Entry(:text=>"Please enter your password",:password=>true)
+puts "Your password is: #{text}" if text
+puts "You did not enter your password" unless text
+
+if (text = Zerenity::Entry(:text=>"Please enter your name. Click OK to close dialog.",:activatesDefault=>false, :string => name))
+  puts "Hello #{text}"
+else
+  puts "You did not enter your name"
+end
+

data/examples/example_error.rb

@@ -0,0 +1,3 @@
+require 'zerenity/error'
+
+Zerenity::Error(:text=>"An error has occured.",:title=>"Oops!")

data/examples/example_fileselection.rb

@@ -0,0 +1,26 @@
+require('zerenity/fileselection')
+
+fileName = Zerenity::FileSelection(:title=>"Which file do you want?",:filename=>File.expand_path(__FILE__),:action=>:open)
+
+puts "You chose #{fileName}" if fileName
+puts "You did not select a file" unless fileName
+
+fileNames = Zerenity::FileSelection(:title=>"Please choose the required files",:multiple=>true)
+
+if fileNames
+  puts "You chose the following files"
+  fileNames.each do |fileName|
+    puts "\t#{fileName}"
+  end
+else
+  puts "You did not choose any files"
+end
+
+filename = Zerenity::FileSelection(:title=>"Save file as",:action=>:save)
+filename ? puts("File saved as #{filename}") : puts("No file saved")
+
+folder = Zerenity::FileSelection(:title=>"Select a folder",:action=>:select_folder,:multiple=>true)
+folder ? puts("You selected folder #{folder}") : puts("You did not choose a folder") 
+
+folder = Zerenity::FileSelection(:title=>"Create folder",:action=>:create_folder)
+folder ? puts("Created folder #{folder}") : puts("You did not create a folder") 

data/examples/example_info.rb

@@ -0,0 +1,3 @@
+require("zerenity/info")
+
+Zerenity::Info(:text=>"Hello, world",:title=>"Hello!")

data/examples/example_list.rb

@@ -0,0 +1,10 @@
+require('zerenity/list')
+
+choice = Zerenity::List(:columns=>["Food","Energy"],:data=>[["Chips","200KJ"],["Chocolate","300KJ"]])
+choice ? puts("You chose #{choice[0]} which has #{choice[1]} of energy.") : puts("You didn't choose an item.") 
+
+choice = Zerenity::List(:columns=>["Selected","Food","Energy"],:data=>[[true,"Chips","200KJ"],[false,"Chocolate","300KJ"],[false,"Pretzels","250KJ"]],:radiolist=>true)
+choice ? puts("You chose #{choice[0]} which has #{choice[1]} of energy.") : puts("You didn't choose an item.") 
+
+choices = Zerenity::List(:columns=>["Selected","Food","Energy"],:data=>[[true,"Chips","200KJ"],[false,"Chocolate","300KJ"],[false,"Pretzels","250KJ"]],:checklist=>true,:title=>"Please select snacks")
+choices ? choices.each {|row| puts("You chose #{row[0]} which has #{row[1]} of energy.")} : puts("You did not choose any items") 

data/examples/example_progress.rb

@@ -0,0 +1,40 @@
+require('zerenity/progress')
+
+Zerenity::Progress(:title=>"Normal",:text=>"Building index") do |progress|
+  0.step(1,0.01) do |number|
+    progress.update(number,"#{(number*100).to_i}%")
+    sleep(0.02)
+  end
+end
+
+Zerenity::Progress(:title=>"Normal pulse",:text=>"Querying Database")  do |progress| 
+  0.step(1,0.01) do
+    progress.pulse
+    sleep(0.02)
+  end
+  progress.update(1,"Finished")
+end
+
+cancelled = Zerenity::Progress(:cancellable=>true,:text=>"Press Cancel To End Rendering",:title=>"Cancellabe") do |progress|
+  while !progress.cancelled?
+    progress.pulse("Processing")
+    sleep(0.02)
+  end
+  0.step(1,0.02) do |number|
+    progress.update(1.0-number,"Cleaning up")
+    sleep(0.01)
+  end
+  progress.update(0,"Finished")
+end
+
+if cancelled 
+  puts "Updating has been cancelled." 
+end
+
+Zerenity::Progress(:autoClose=>true,:text=>"Copying kernel...",:title=>"Auto close") do |progress|
+  0.step(1,0.02) do |number|
+    progress.update(number)
+    sleep(0.03)
+  end
+end
+  

data/examples/example_question.rb

@@ -0,0 +1,4 @@
+require('zerenity/question')
+
+choice = Zerenity::Question(:text=>"Process images?")
+choice ? (puts "OK") : (puts "CANCEL")

data/examples/example_textinfo.rb

@@ -0,0 +1,11 @@
+require('zerenity/textinfo')
+
+Zerenity::TextInfo(:title=>"Source file: #{$0}",:text=>File.new($0).read)
+
+text =  Zerenity::TextInfo(:title=>"Editable Text",:editable=>true)
+if text
+  puts "You entered:"
+  puts text
+else
+  puts "You clicked cancel"
+end

data/examples/example_warning.rb

@@ -0,0 +1,3 @@
+require 'zerenity/warning'
+
+Zerenity::Warning(:text=>"An error could occur",:title=>"Danger!")

data/lib/zerenity.rb

@@ -0,0 +1,14 @@
+require('zerenity/base')
+require('zerenity/calendar')
+require('zerenity/entry')
+require('zerenity/error')
+require('zerenity/fileselection')
+require('zerenity/info')
+require('zerenity/list')
+require('zerenity/messagedialog')
+require('zerenity/progress')
+require('zerenity/question')
+require('zerenity/scale')
+require('zerenity/textinfo')
+require('zerenity/warning')
+require('zerenity/colorselection')

data/lib/zerenity/base.rb

@@ -0,0 +1,50 @@
+require 'gtk2'
+
+# Zerenity provides a number of simple graphical dialogs.
+#
+# ==== Global Options
+# [:title] The text displayed in the title bar.
+# [:text] The text that will be displayed in the dialog (if needed).
+# [:activatesDefault] If set to false disables the firing of the OK
+#                     button when the Enter key is pressed. 
+module Zerenity
+  CLICKED = "clicked"
+  class Base # :nodoc:
+    def self.check(options)
+      options[:activatesDefault] = (options[:activatesDefault].nil? || options[:activatesDefault]) 
+      options[:title] ||= ""
+      options[:text] ||= ""
+    end
+
+    def self.build(dialog, options)
+      options[:ok_button] = dialog.add_button(options[:ok_button]||Gtk::Stock::OK, 
+                                              Gtk::Dialog::RESPONSE_OK)
+      options[:cancel_button] = dialog.add_button(options[:cancel_button]||Gtk::Stock::CANCEL,
+                                                  Gtk::Dialog::RESPONSE_CANCEL)
+      dialog.set_default_response(Gtk::Dialog::RESPONSE_OK) if options[:activatesDefault] 
+    end
+    
+    def self.run(options)
+      Gtk.init
+      self.check(options)
+      dialog = Gtk::Dialog.new(options[:title])
+      self.build(dialog,options)
+      result = nil
+      options[:ok_button].signal_connect(CLICKED) do
+        result = self.retrieve_selection(dialog,options)
+        dialog.destroy
+        Gtk.main_quit
+      end
+      options[:cancel_button].signal_connect(CLICKED) do
+        dialog.destroy
+        Gtk.main_quit
+      end
+      dialog.show_all
+      Gtk.main
+      return result 
+    end
+
+    def self.retrieve_selection(dialog,options)
+    end
+  end
+end

data/lib/zerenity/calendar.rb

@@ -0,0 +1,26 @@
+require 'zerenity/base'
+
+module Zerenity
+  # Creates a calendar dialog allowing the user to select a date. Returns
+  # a Time object representing the selected date or nil if Cancel is
+  # clicked.
+  #
+  # ==== Example Usage
+  #  date = Zerenity::Calendar(:text=>"Please select a date")
+  def self.Calendar(options={})
+    Calendar.run(options)
+  end
+ 
+  class Calendar < Zerenity::Base # :nodoc:
+    def self.build(dialog,options)
+      super(dialog,options)
+      dialog.vbox.add(Gtk::Label.new(options[:text],false))
+      dialog.vbox.add(Gtk::Calendar.new) 
+    end
+
+    def self.retrieve_selection(dialog,options)
+      super(dialog,options)
+      Time.local(*dialog.vbox.children[1].date)
+    end
+  end
+end

data/lib/zerenity/colorselection.rb

@@ -0,0 +1,30 @@
+require 'zerenity/base'
+
+module Zerenity
+  # Displays a color selection dialog. Returns the value of the color selected
+  # as #rrrrggggbbbb, where r, g and b are hex digits representing the red, 
+  # green and blue components respectively
+  #
+  #  ====Example Usage:
+  #   Zereity::ColorSelection( :title => "Select a color" )
+  def self.ColorSelection( options = {} )  
+    ColorSelection.run( options )
+  end
+
+  class ColorSelection < Base # :nodoc:
+    def self.run( options )
+      self.check( options )
+      Gtk.init
+      color_selection = Gtk::ColorSelectionDialog.new( options[ :title ])
+      result = nil
+      color_selection.run do |response|
+        if ( response == Gtk::Dialog::RESPONSE_OK )
+          # I don't have the latest Ruby/GNOME2 on my system so this mimics current_color.to_s
+          result = "##{ color_selection.colorsel.current_color.to_a.map{|channel| channel.to_s(16).rjust(4,'0').upcase }.join }"
+        end
+      end
+      color_selection.destroy
+      return result
+    end
+  end
+end

data/lib/zerenity/entry.rb

@@ -0,0 +1,36 @@
+require('zerenity/base')
+
+module Zerenity
+  # Displays a text entry box. Returns the text entered or nil if 
+  # Cancel is pressed.
+  #
+  # ====Options
+  # [:password] When set to true all all characters in the text
+  #             entry area will be masked by the '*' character.
+  # ====Example Usage
+  #  name = Zerenity::Entry(:text=>"Please enter your name.")
+  def self.Entry(options={})
+      Entry.run(options)
+  end
+  
+  class Entry < Base # :nodoc:
+    def self.check(options)
+      super(options)
+    end
+
+    def self.build(dialog,options)
+      super(dialog,options)
+      dialog.vbox.add(Gtk::Label.new(options[:text],false))
+      entry = Gtk::Entry.new
+      entry.text = options[:string] if options[:string]
+      entry.set_visibility(!options[:password])
+      entry.set_activates_default(options[:activatesDefault])
+      dialog.vbox.add(entry)
+    end
+
+    def self.retrieve_selection(dialog,options)
+      super(dialog,options)
+      dialog.vbox.children[1].text
+    end
+  end
+end

data/lib/zerenity/error.rb

@@ -0,0 +1,17 @@
+require 'zerenity/messagedialog'
+
+module Zerenity
+  # Displays an error dialog.
+  # ====Example Usage
+  #  Zerenity::Error(:text=>"An error has occured. Please check the system log.")
+  def self.Error(options={})
+    Error.run(options)
+  end
+
+  class Error < MessageDialog # :nodoc: 
+      def self.check(options)
+        super(options)
+        options[:type] = Gtk::MessageDialog::ERROR  
+      end
+  end
+end

data/lib/zerenity/fileselection.rb

@@ -0,0 +1,68 @@
+require 'zerenity/base'
+
+module Zerenity
+  # Displays a file/directory selection dialog. Returns the name(s)
+  # of the files/directories chosen or nil if Cancel is pressed.
+  #
+  # ====Options
+  # [:filename] The file to selected initially
+  # [:multiple] If set to true multiple files/directories can be selected 
+  #             and an array of file/directory names will be returned.
+  # [:action] The default behavour is to select a file but this can be 
+  #           overridden by setting the action key to one of the following values: 
+  #           [:save] Save a file 
+  #           [:select_folder] Select a folder
+  #           [:create_folder] Create a folder - note this will actually create
+  #                            the directory.
+  #
+  # ====Example Usage:
+  #  Zerenity::FileSelection(:title=>"Select a directory", :action=>:select_folder)
+  def self.FileSelection(options={})
+    FileSelection.run(options)
+  end
+
+  class FileSelection < Base # :nodoc:
+    def self.check(options)
+      super(options)
+      options[:action] = (case options[:action]
+      when :save:
+        Gtk::FileChooser::ACTION_SAVE
+      when :select_folder:
+        Gtk::FileChooser::ACTION_SELECT_FOLDER
+      when :create_folder:
+        Gtk::FileChooser::ACTION_CREATE_FOLDER
+      else
+        Gtk::FileChooser::ACTION_OPEN
+      end)
+      options[:title] ||= ""
+      options[:filename] ||= nil
+      options[:multiple] ||= false
+    end
+    
+    def self.run(options)
+      self.check(options)
+      Gtk.init
+      fileSelection = Gtk::FileChooserDialog.new(
+        options[:title],
+        nil,
+        options[:action],
+        nil,
+        [Gtk::Stock::CANCEL,Gtk::Dialog::RESPONSE_CANCEL],
+        [Gtk::Stock::OK,Gtk::Dialog::RESPONSE_OK])
+      fileSelection.set_filename(options[:filename]) if options[:filename]
+      fileSelection.set_select_multiple(true) if options[:multiple]
+      result = nil 
+      fileSelection.run do |response|
+        if (response == Gtk::Dialog::RESPONSE_OK)
+          if options[:multiple] 
+            result = fileSelection.filenames
+          else
+             result = fileSelection.filename
+          end
+        end
+      end
+      fileSelection.destroy
+      return result
+    end
+  end
+end