palaver 0.2.0 → 0.3.0

data/ReleaseNotes

@@ -0,0 +1,28 @@
+Release notes for Palaver 0.3.0
+===============================
+
+New features:
+
+- Support for the "passwordform" dialog (github issue #16)
+- Support foor the "gaugle" dialog (githus issue #5)
+- Support for options affecting multiple dialogs types in the DialogFactory instead of the
+  individual dialog classes.
+- Support for the following options has been implemented for all currently support dialog types:
+  - ascii-lines
+  - no-lines
+  - aspect
+  - backtitle
+  - begin
+  - cancel-label
+
+
+Incompatabilities with previous versions:
+
+- The PasswordBox class no longer accepts the 'insecure' option, which has been moved to the
+  DialogFactory. See examples/passwordbox.rb.
+
+
+Release notes for Palaver 0.2.0
+===============================
+
+Despite the version number, this was the first release of Palaver.

data/examples/calendar.rb

@@ -1,12 +1,14 @@
 require 'palaver'
 require 'date'
 
-dialog_factory = Palaver::DialogFactory.new
+dialog_factory = Palaver::DialogFactory.new(:begin => [2,2],
+                                            :backtitle => "Defaults to a nasty period",
+                                            :cancel_label => "Forget it...")
 
 # Using the hash based API with the calendar dialog
 start_date = dialog_factory.calendar(:text => "Choose the start date", :date => Date.new(1939,9,1)).show
 
-# Using the block based API with the calendar dialog. This probably doesn'palaver'
+# Using the block based API with the calendar dialog. This probably doesn't make sense for a 
 # simple widget like the calendar.
 end_date = dialog_factory.calendar { text "Choose the end date"; date Date.new(1945,9,2); }.show
 

data/examples/gauge.rb

@@ -0,0 +1,24 @@
+require 'palaver'
+
+early_finish = ARGV[0] ? ARGV[0].to_i : nil
+
+dialog_factory = Palaver::DialogFactory.new(:backtitle => "Waiting for progress")
+
+gauge = dialog_factory.gauge {
+  text "Gauge, block style"
+  inital_percentage 22
+}
+
+gauge.show
+
+(22..100).each do |p|
+  if p == early_finish then
+    gauge.close
+    break
+  end
+  sleep_duration = p > 98 ? 10 : 0.1
+  sleep sleep_duration
+  gauge.percentage(p)
+end
+
+

data/examples/passwordbox.rb

@@ -1,16 +1,17 @@
 require 'palaver'
 
-dialog_factory = Palaver::DialogFactory.new
+dialog_factory =
+  if ARGV[0] == "secure" then
+    Palaver::DialogFactory.new(:ascii_lines)
+  else
+    Palaver::DialogFactory.new(:insecure, :no_lines)
+  end
 
 # Using the hash based API to ask for a password
 hash_pw = dialog_factory.passwordbox(:text => "Please enter password, hash style").show
-hash_pw_insec = dialog_factory.passwordbox(:text => "Please enter password, more usable hash style", :insecure => true).show
 # Using the block based API to ask for a password
-block_pw = dialog_factory.passwordbox{ text "Please enter passwrod, block style" }.show
-block_pw_insec = dialog_factory.passwordbox{ insecure; text "Please enter passwrod, more usable block style" }.show
+block_pw = dialog_factory.passwordbox{ text "Please enter password, block style" }.show
 
 puts "Hash password: #{hash_pw}"
-puts "Hash password (entered in less secure way): #{hash_pw_insec}"
 puts "Block password: #{block_pw}"
-puts "Block parssword (entered ien less secure way): #{block_pw_insec}"
 

data/examples/passwordform.rb

@@ -0,0 +1,22 @@
+require 'palaver'
+
+
+dialog_factory =
+  if ARGV[0] == "secure" then
+    Palaver::DialogFactory.new
+  else
+    Palaver::DialogFactory.new(:insecure)
+  end
+
+answers = dialog_factory.passwordform {
+  text "Foos and their secret texts"
+  height 10
+  form_height 5
+  entry :first, "First foo", 1, 0, "", 1, 15, 20, 200
+  entry :second, "Second foo", 1, 40, "", 1, 55, 20, 200
+  entry :third, "Third foo", 3, 0, "", 3, 15, 20, 200
+}.show
+
+answers.keys.each do |k|
+  puts "#{k}: #{answers[k]}"
+end

data/examples/yesno.rb

@@ -1,6 +1,6 @@
 require 'palaver'
 
-dialog_factory = Palaver::DialogFactory.new
+dialog_factory = Palaver::DialogFactory.new(:backtitle => "Yes/No questions R us", :aspect => 40)
 
 # Using the hash based API, which makes most sense for this kind of dialog
 likes_hash_based_api = dialog_factory.yesno(:text => "Do you like the hash based API?").show

data/lib/palaver.rb

@@ -15,4 +15,6 @@ require 'palaver/passwordbox.rb'
 require 'palaver/dselect.rb'
 require 'palaver/fselect.rb'
 require 'palaver/form.rb'
+require 'palaver/passwordform.rb'
+require 'palaver/gauge.rb'
 require 'palaver/dialog_factory.rb'

data/lib/palaver/base.rb

@@ -2,6 +2,8 @@
 # See LICENSE file for licensing information.
 
 module Palaver
+  attr_reader :common_options
+  
   class Base
     def initialize(options)
       @text = nil
@@ -10,6 +12,7 @@ module Palaver
 
       options.each do |option,value|
         case option
+        when :common_options then @common_options = value
         when :width then self.width(value)
         when :height then self.height(value)
         when :text then self.text(value)

data/lib/palaver/baseform.rb

@@ -0,0 +1,96 @@
+# Copyright (c) 2012, Peter Allin <peter@peca.dk> All rights reserved.
+# See LICENSE file for licensing information.
+
+module Palaver
+
+  class BaseForm < Palaver::Base
+    def initialize(dialogcmd, options)
+      super(options)
+      @dialogcmd = dialogcmd
+      @entries = []
+      @form_height = nil
+      @simple_display_width = nil
+      @simple_text_length = nil
+    end
+
+    def show
+      text_width = @entries.map { |e| e.text_width }.max
+      @entries.each { |e| e.update_value_x text_width }
+      
+      cmd_intro = "dialog #@common_options --#@dialogcmd '#@text' #@height #@width #@form_height "
+      cmd_entries = @entries.map { |e| e.to_cmd_s }.join(' ')
+
+      result = nil
+      with_tempfile do |tfpath|
+        cmd = "#{cmd_intro} #{cmd_entries} 2> #{tfpath}"
+        success = system cmd
+        result = read_dialog_output tfpath
+      end
+      
+      return result
+    end
+
+    private
+
+    class Entry
+      attr_reader :field_id, :text
+      
+      def initialize(id, text, text_y, text_x, default_value, value_y, value_x, field_length, input_length)
+        @field_id = id
+        @text = text
+        @text_y = text_y
+        @text_x = text_x
+        @default_value = default_value
+        @value_y = value_y
+        @value_x = value_x
+        @field_length = field_length
+        @input_length = input_length
+      end
+
+      def text_width
+        @text.length + 2
+      end
+
+      def update_value_x(min)
+        @value_x = [ @value_x ? @value_x : 0, min ].max
+      end
+      
+      def to_cmd_s
+        "'#@text' #@text_y #@text_x '#@default_value' #@value_y #@value_x #@field_length #@input_length"
+      end
+    end
+
+    def read_dialog_output(fname)
+      lines = File.read(fname).split("\n")
+      result = {}
+      lines.each_with_index { |l,i| result[@entries[i].field_id] = l }
+      return result
+    end
+    
+    def form_height(val)
+      @form_height = val
+    end
+
+    def entry(id, title, text_y, text_x, default_value, value_y, value_x, field_length, input_length)
+      newentry = Entry.new(id, title, text_y, text_x, default_value, value_y, value_x, field_length, input_length)
+      @entries.push newentry
+    end
+
+    def simple_display_width(width)
+      @simple_display_width = width
+    end
+
+    def simple_text_length(length)
+      @simple_text_length = length
+    end
+
+    def simple_entry(id, title, default_value)
+      @simple_next_y = 1 if not @simple_next_y
+      newentry = Entry.new(id, title, @simple_next_y, 0, default_value, @simple_next_y, nil, @simple_display_width, @simple_text_length)
+      @entries.push newentry
+      @simple_next_y = @simple_next_y + 1
+    end
+    
+  end
+  
+end

data/lib/palaver/calendar.rb

@@ -30,10 +30,10 @@ module Palaver
         end
       chosen_date = nil
       with_tempfile do |tfpath|
-        cmd = 'dialog --calendar "%s" %d %d %d %d %d 2> %s' % [ @text,
-                                                                @height, @width, 
-                                                                day, month, year,
-                                                                tfpath ]
+        cmd = "dialog #@common_options --calendar '%s' %d %d %d %d %d 2> %s" % [ @text,
+                                                                                 @height, @width, 
+                                                                                 day, month, year,
+                                                                                 tfpath ]
         success = system cmd
         chosen_date = Date.strptime(File.read(tfpath), "%d/%m/%Y") if success
       end

data/lib/palaver/checklist.rb

@@ -12,7 +12,7 @@ module Palaver
     def show
       choices = nil
       with_tempfile do |fname|
-        cmd = "dialog --checklist '#@text' #@height #@width #@list_height #{options_string_with_status} 2> #{fname}"
+        cmd = "dialog #@common_options --checklist '#@text' #@height #@width #@list_height #{options_string_with_status} 2> #{fname}"
         success = system cmd
         if success then
           choices = File.read(fname).split(" ").map { |s| s[1..-2] }

data/lib/palaver/dialog_factory.rb

@@ -17,15 +17,51 @@ module Palaver
       :passwordbox => PasswordBox,
       :dselect => DSelect,
       :fselect => FSelect,
-      :form => Form
+      :form => Form,
+      :passwordform => PasswordForm,
+      :gauge => Gauge
     }
 
+    def initialize(*options)
+      options.each do |option|
+        case option
+        when :insecure then @insecure = true
+        when :ascii_lines then @ascii_lines = true
+        when :no_lines then @no_lines = true
+        end
+
+        if option.class == Hash then
+          option.each do |k,v|
+            case k
+              when :aspect then @aspect = v
+              when :backtitle then @backtitle = v
+              when :begin then @begin = v
+              when :cancel_label then @cancel_label = v
+            end
+          end
+        end
+      end
+    end
+
+    def common_options
+      options = []
+      options.push("--insecure") if @insecure
+      options.push("--ascii-lines") if @ascii_lines
+      options.push("--no-lines") if @no_lines
+      options.push("--aspect #@aspect") if @aspect
+      options.push("--backtitle '#@backtitle'") if @backtitle
+      options.push("--begin #{@begin[0]} #{@begin[1]}") if @begin
+      options.push("--cancel-label '#@cancel_label'") if @cancel_label
+      return options.join(" ")
+    end
+    
     private
 
     def method_missing(methodsym, *args, &block)
       if @@dialog_types.has_key? methodsym then
         c = @@dialog_types[methodsym]
         options = args.size == 1 ? args[0] : {}
+        options[:common_options] = common_options
         return make_dialog(c, options, &block)
       else
         raise NoMethodError.new("Undefined method: #{methodsym} for #{self}", methodsym)

data/lib/palaver/form.rb

@@ -1,95 +1,14 @@
 # Copyright (c) 2012, Peter Allin <peter@peca.dk> All rights reserved.
 # See LICENSE file for licensing information.
 
+require 'palaver/baseform.rb'
+
 module Palaver
 
-  class Form < Palaver::Base
+  class Form < Palaver::BaseForm
     def initialize(options)
-      super(options)
-      @entries = []
-      @form_height = nil
-      @simple_display_width = nil
-      @simple_text_length = nil
-    end
-
-    def show
-      text_width = @entries.map { |e| e.text_width }.max
-      @entries.each { |e| e.update_value_x text_width }
-      
-      cmd_intro = "dialog --form '#@text' #@height #@width #@form_height "
-      cmd_entries = @entries.map { |e| e.to_cmd_s }.join(' ')
-
-      result = nil
-      with_tempfile do |tfpath|
-        cmd = "#{cmd_intro} #{cmd_entries} 2> #{tfpath}"
-        success = system cmd
-        result = read_dialog_output tfpath
-      end
-      
-      return result
-    end
-
-    private
-
-    class Entry
-      attr_reader :field_id, :text
-      
-      def initialize(id, text, text_y, text_x, default_value, value_y, value_x, field_length, input_length)
-        @field_id = id
-        @text = text
-        @text_y = text_y
-        @text_x = text_x
-        @default_value = default_value
-        @value_y = value_y
-        @value_x = value_x
-        @field_length = field_length
-        @input_length = input_length
-      end
-
-      def text_width
-        @text.length + 2
-      end
-
-      def update_value_x(min)
-        @value_x = [ @value_x ? @value_x : 0, min ].max
-      end
-      
-      def to_cmd_s
-        "'#@text' #@text_y #@text_x '#@default_value' #@value_y #@value_x #@field_length #@input_length"
-      end
-    end
-
-    def read_dialog_output(fname)
-      lines = File.read(fname).split("\n")
-      result = {}
-      lines.each_with_index { |l,i| result[@entries[i].field_id] = l }
-      return result
+      super("form", options)
     end
-     
-    def form_height(val)
-      @form_height = val
-    end
-
-    def entry(id, title, text_y, text_x, default_value, value_y, value_x, field_length, input_length)
-      newentry = Entry.new(id, title, text_y, text_x, default_value, value_y, value_x, field_length, input_length)
-      @entries.push newentry
-    end
-
-    def simple_display_width(width)
-      @simple_display_width = width
-    end
-
-    def simple_text_length(length)
-      @simple_text_length = length
-    end
-
-    def simple_entry(id, title, default_value)
-      @simple_next_y = 1 if not @simple_next_y
-      newentry = Entry.new(id, title, @simple_next_y, 0, default_value, @simple_next_y, nil, @simple_display_width, @simple_text_length)
-      @entries.push newentry
-      @simple_next_y = @simple_next_y + 1
-    end
-
   end
   
 end

data/lib/palaver/gauge.rb

@@ -0,0 +1,35 @@
+# Copyright (c) 2012, Peter Allin <peter@peca.dk> All rights reserved.
+# See LICENSE file for licensing information.
+
+module Palaver
+  class Gauge < Palaver::Base
+
+    def initialize(options)
+      @inital_percentage = 0
+      super(options)
+    end
+
+    def show
+      cmd = "dialog #@common_options --gauge '#@text' #@height #@width #@inital_percentage"
+      @pipe = IO.popen(cmd,"w")
+    end
+
+    def percentage(p)
+      if @pipe then
+        @pipe.puts p
+      else
+        @inital_percentage = p
+      end
+    end
+
+    def close
+      @pipe.close
+    end
+    
+    private
+    
+    def inital_percentage(percentage)
+      @inital_percentage = percentage
+    end
+  end
+end

data/lib/palaver/infobox.rb

@@ -8,7 +8,7 @@ module Palaver
     end
 
     def show
-      cmd = "dialog --infobox '#@text' #@height #@width"
+      cmd = "dialog #@common_options --infobox '#@text' #@height #@width"
       system cmd
     end
   end

data/lib/palaver/inputbox.rb

@@ -22,7 +22,7 @@ module Palaver
     def show
       answer = nil
       with_tempfile do |fname|
-        cmd = "dialog --inputbox '#@text' #@height #@width '#@initial' 2> #{fname}"
+        cmd = "dialog #@common_options --inputbox '#@text' #@height #@width '#@initial' 2> #{fname}"
         success = system cmd
         if success  then
           answer = File.read(fname)

data/lib/palaver/menu.rb

@@ -12,7 +12,7 @@ module Palaver
     def show
       chosen = nil
       with_tempfile do |fname|
-        cmd = "dialog --menu '#@text' #@height #@width #@list_height #{options_string_no_status} 2> #{fname}"
+        cmd = "dialog #@common_options --menu '#@text' #@height #@width #@list_height #{options_string_no_status} 2> #{fname}"
         sucess = system cmd
         if sucess then
           chosen = File.read(fname)

data/lib/palaver/msgbox.rb

@@ -8,7 +8,7 @@ module Palaver
     end
 
     def show
-      cmd = "dialog --msgbox '#@text' #@height #@width"
+      cmd = "dialog #@common_options --msgbox '#@text' #@height #@width"
       system cmd
     end    
   end

data/lib/palaver/passwordbox.rb

@@ -5,26 +5,12 @@ module Palaver
   class PasswordBox < Palaver::Base
     def initialize(options)
       super(options)
-      @insecure = false
-
-      options.each do |option,value|
-        case option
-        when :insecure then self.insecure(value)
-        end
-      end
-    end
-
-    def insecure(should_be_insecure=true)
-      @insecure = should_be_insecure
     end
 
-    
     def show
       answer = nil
       with_tempfile do |fname|
-        insecure = @insecure ? "--insecure" : ""
-        cmd = "dialog #{insecure} --passwordbox '#@text' #@height #@width 2> #{fname}"
-        #puts cmd
+        cmd = "dialog #@common_options --passwordbox '#@text' #@height #@width 2> #{fname}"
         success = system cmd
         if success  then
           answer = File.read(fname)

data/lib/palaver/passwordform.rb

@@ -0,0 +1,10 @@
+# Copyright (c) 2012, Peter Allin <peter@peca.dk> All rights reserved.
+# See LICENSE file for licensing information.
+
+module Palaver
+  class PasswordForm < Palaver::BaseForm
+    def initialize(options)
+      super("passwordform", options)
+    end
+  end
+end

data/lib/palaver/pathselect.rb

@@ -20,10 +20,10 @@ module Palaver
     end
 
     def show
-      raise "CAn't open a #{dialog_name} dialog with a path" if not @path
+      raise "Can't open a #{dialog_name} dialog with a path" if not @path
       chosen_file = nil
       with_tempfile do |tfpath|
-        cmd = "dialog --#{dialog_name} '#@path' #@height #@width 2> #{tfpath}"
+        cmd = "dialog #@common_options --#{dialog_name} '#@path' #@height #@width 2> #{tfpath}"
         puts cmd
         success = system cmd
         chosen_file = File.read(tfpath) if success

data/lib/palaver/pause.rb

@@ -18,7 +18,7 @@ module Palaver
     end
 
     def show
-      cmd = "dialog --pause '#@text' #@height #@width #@seconds"
+      cmd = "dialog #@common_options --pause '#@text' #@height #@width #@seconds"
       rc = system cmd
       return rc
     end

data/lib/palaver/radiolist.rb

@@ -12,7 +12,7 @@ module Palaver
     def show
       chosen = nil
       with_tempfile do |fname|
-        cmd = "dialog --radiolist '#@text' #@height #@width #@list_height #{options_string_with_status} 2> #{fname}"
+        cmd = "dialog #@common_options --radiolist '#@text' #@height #@width #@list_height #{options_string_with_status} 2> #{fname}"
         sucess = system cmd
         if sucess then
           chosen = File.read(fname)

data/lib/palaver/textbox.rb

@@ -13,7 +13,7 @@ module Palaver
     end
     
     def show
-      cmd = "dialog --textbox '#@filename' #@height #@width"
+      cmd = "dialog #@common_options --textbox '#@filename' #@height #@width"
       system cmd
     end
     

data/lib/palaver/yesno.rb

@@ -8,7 +8,7 @@ module Palaver
     end
 
     def show
-      cmd = "dialog --yesno '#@text' #@height #@width"
+      cmd = "dialog #@common_options --yesno '#@text' #@height #@width"
       rc = system cmd
       return  rc
     end

data/palaver.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "palaver"
-  s.version = "0.2.0"
+  s.version = "0.3.0"
   s.platform = Gem::Platform::RUBY
   s.authors = [ "Peter Allin" ]
   s.email = [ "peter@peca.dk" ]

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: palaver
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: 
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Peter Allin
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-07-10 00:00:00 Z
+date: 2012-09-23 00:00:00 Z
 dependencies: []
 
 description: Uses the 'dialog' program to create Ruby applications with text based user interfaces
@@ -32,35 +32,41 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- ReleaseNotes
 - examples/calendar.rb
 - examples/checklist.rb
 - examples/dselect.rb
 - examples/form.rb
 - examples/form_simple.rb
 - examples/fselect.rb
+- examples/gauge.rb
 - examples/infobox.rb
 - examples/inputbox.rb
 - examples/menu.rb
 - examples/msgbox.rb
 - examples/passwordbox.rb
+- examples/passwordform.rb
 - examples/pause.rb
 - examples/radiolist.rb
 - examples/textbox.rb
 - examples/yesno.rb
 - lib/palaver.rb
 - lib/palaver/base.rb
+- lib/palaver/baseform.rb
 - lib/palaver/calendar.rb
 - lib/palaver/checklist.rb
 - lib/palaver/dialog_factory.rb
 - lib/palaver/dselect.rb
 - lib/palaver/form.rb
 - lib/palaver/fselect.rb
+- lib/palaver/gauge.rb
 - lib/palaver/infobox.rb
 - lib/palaver/inputbox.rb
 - lib/palaver/list_with_options.rb
 - lib/palaver/menu.rb
 - lib/palaver/msgbox.rb
 - lib/palaver/passwordbox.rb
+- lib/palaver/passwordform.rb
 - lib/palaver/pathselect.rb
 - lib/palaver/pause.rb
 - lib/palaver/radiolist.rb