eft 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 801797fc4df36523e6baaad909c55c6cb0221d60
+  data.tar.gz: f3496e92b58c74b9d1cfa9b3624e06c0f79b34b5
+SHA512:
+  metadata.gz: 208b327f0aa6d1ead392ca2682113dfea63807361abdc942f5e64417f9da5bf89763652926c8aaf2165524254aaa3c8b1d1dc1094f43321c5ab53bba3808a508
+  data.tar.gz: 8ea0d807d62731ffaca846db012209d848cd05f4f97a94131e3c47fcc184cb694bd9bff84603938d00c6e44c276704daa862cddc0bd6bd5eddf3d540c2d18784

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/README.md

@@ -0,0 +1,57 @@
+[]: {{{1
+
+    File        : README.md
+    Maintainer  : Felix C. Stegerman <flx@obfusk.net>
+    Date        : 2014-02-20
+
+    Copyright   : Copyright (C) 2014  Felix C. Stegerman
+    Version     : v0.4.0
+
+[]: }}}1
+
+[![Gem Version](https://badge.fury.io/rb/eft.png)](http://badge.fury.io/rb/eft)
+
+## Description
+[]: {{{1
+
+  eft - ruby + whiptail
+
+  Eft is a ruby dsl that wraps `whiptail` [1] to display dialog boxes;
+  see `example.rb` for examples.
+
+```ruby
+Eft.ask('What is your name?') do |q|
+  q.on_ok { |name| puts "Hello, #{name}!" }
+end
+```
+
+[]: }}}1
+
+## Specs & Docs
+
+```bash
+$ rake spec   # TODO
+$ rake docs
+```
+
+## TODO
+
+  * specs! (how to automate tests of whiptail? - I don't know!)
+  * --noitem?
+  * choose between whiptail and dialog?
+  * extend w/ dialog's other dialogs?
+  * remove dependency on obfusk-util?
+
+## License
+
+  LGPLv3+ [2].
+
+## References
+
+  [1] Newt (and whiptail)
+  --- http://en.wikipedia.org/wiki/Newt_(programming_library)
+
+  [2] GNU Lesser General Public License, version 3
+  --- http://www.gnu.org/licenses/lgpl-3.0.html
+
+[]: ! ( vim: set tw=70 sw=2 sts=2 et fdm=marker : )

data/Rakefile

@@ -0,0 +1,55 @@
+desc 'Run specs'
+task :spec do
+  puts 'No automated tests yet - please manually test the example'
+  # sh 'rspec -c'
+end
+
+desc 'Run specs verbosely'
+task 'spec:verbose' do
+  puts 'No automated tests yet - please manually test the example'
+  # sh 'rspec -cfd'
+end
+
+desc 'Run specs verbosely, view w/ less'
+task 'spec:less' do
+  puts 'No automated tests yet - please manually test the example'
+  # sh 'rspec -cfd --tty | less -R'
+end
+
+desc 'Check for warnings'
+task :warn do
+  sh 'ruby -w -I lib -I ../rb-obfusk-util/lib -r eft -e ""'
+end
+
+desc 'Run example'
+task :example do
+  sh 'ruby -w -I lib -I ../rb-obfusk-util/lib example.rb'
+end
+
+desc 'Generate docs'
+task :docs do
+  sh 'yardoc | cat'
+end
+
+desc 'List undocumented objects'
+task 'docs:undoc' do
+  sh 'yard stats --list-undoc'
+end
+
+desc 'Cleanup'
+task :clean do
+  sh 'rm -rf .yardoc/ doc/ *.gem'
+end
+
+desc 'Build SNAPSHOT gem'
+task :snapshot do
+  v = Time.new.strftime '%Y%m%d%H%M%S'
+  f = 'lib/eft/version.rb'
+  sh "sed -ri~ 's!(SNAPSHOT)!\\1.#{v}!' #{f}"
+  sh 'gem build eft.gemspec'
+end
+
+desc 'Undo SNAPSHOT gem'
+task 'snapshot:undo' do
+  sh 'git checkout -- lib/eft/version.rb'
+end

data/eft.gemspec

@@ -0,0 +1,32 @@
+require File.expand_path('../lib/eft/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'eft'
+  s.homepage    = 'https://github.com/obfusk/eft'
+  s.summary     = 'ruby + whiptail'
+
+  s.description = <<-END.gsub(/^ {4}/, '')
+    ruby + whiptail
+
+    Eft is a ruby dsl that wraps whiptail to display dialog boxes.
+  END
+
+  s.version     = Eft::VERSION
+  s.date        = Eft::DATE
+
+  s.authors     = [ 'Felix C. Stegerman' ]
+  s.email       = %w{ flx@obfusk.net }
+
+  s.licenses    = %w{ LGPLv3+ }
+
+  s.files       = %w{ .yardopts README.md Rakefile } \
+                + %w{ eft.gemspec example.rb } \
+                + Dir['lib/**/*.rb']
+
+  s.add_runtime_dependency 'obfusk-util'
+
+  s.add_development_dependency 'rake'
+# s.add_development_dependency 'rspec'
+
+  s.required_ruby_version = '>= 1.9.1'
+end

data/example.rb

@@ -0,0 +1,64 @@
+require 'eft'
+
+Eft.menu('Choices:', selected: 'bar', title: 'Menu',
+         backtitle: 'Choose!') do |m|
+  m.on('foo', 'Do The Foo') do |x|
+    Eft.ask('What is your name?', ok_button: 'Next',
+            default: 'Anonymous') do |q1|
+      q1.on_ok do |name|
+        Eft.ask_pass('Secret?', ok_button: 'Go!') do |q2|
+          q2.on_ok do |sec|
+            Eft.show_msg "Welcome #{name}, your secret is #{sec}"
+          end
+        end
+      end
+    end
+  end
+  m.on('bar', 'Do Bar!') do |x|
+    Eft.ask_yesno 'Is everything going well?' do |q|
+      q.on_yes  { puts 'Nice!' }
+      q.on_no   { puts 'Too bad!' }
+    end
+  end
+  m.on('baz', 'Baz!?') do |x|
+    Eft.gauge '...', 0, title: 'Progress' do |mv|
+      0.upto(100) do |i|
+        i % 5 == 0 ? mv[i, "We're at ##{i} ..."] : mv[i]
+        sleep 0.05
+      end
+    end
+  end
+  m.on('qux', 'Quixotic?') do |x|
+    Eft.show_info 'Hi!'
+  end
+  m.on('quux', 'Quixotic!') do |x|
+    Eft.show_text file: '/etc/services', scroll: true
+  end
+  m.on('quuux', 'There\'s more ...') do |x|
+    Eft.check 'Which ones?' do |c|
+      c.choice('1', 'One')
+      c.choice('2', 'Two', true)
+      c.choice('3', 'Three')
+      c.on_ok do |choices|
+        Eft.show_text text: choices*10*"\n", title: 'Multiplied!'
+      end
+    end
+  end
+  m.on('almost there', 'Just one more') do |x|
+    Eft.radio 'One or none' do |c|
+      c.choice('1', 'One')
+      c.choice('2', 'Two')
+      c.on_ok { |choice| puts "You chose: #{choice || 'none!?'}" }
+    end
+  end
+  m.on('last one', 'Really! I promise.') do |x|
+    Eft.radio 'Which one?', selected: '2' do |c|
+      c.choice('1', 'One')
+      c.choice('2', 'Two')
+      c.choice('3', 'Three')
+      c.on_ok { |choice| puts "You chose: #{choice}" }
+    end
+  end
+  m.on_cancel { puts 'Not interested.' }
+  m.on_esc    { puts 'Escaped!' }
+end

data/lib/eft/version.rb

@@ -0,0 +1,4 @@
+module Eft
+  VERSION = '0.4.0'
+  DATE    = '2014-02-20'
+end

data/lib/eft.rb

@@ -0,0 +1,322 @@
+# --                                                            ; {{{1
+#
+# File        : eft.rb
+# Maintainer  : Felix C. Stegerman <flx@obfusk.net>
+# Date        : 2014-02-20
+#
+# Copyright   : Copyright (C) 2014  Felix C. Stegerman
+# Licence     : LGPLv3+
+#
+# --                                                            ; }}}1
+
+require 'tempfile'
+
+require 'obfusk/util/run'
+require 'obfusk/util/term'
+
+module Eft
+
+  OU = Obfusk::Util
+
+  # --
+
+  # NB: dialog works as well as whiptail, but these options will be
+  # incompatible: --*-button (is: --*-label), --scrolltext
+
+  WHIPTAIL    = 'whiptail'
+  EXIT        = { ok_yes: 0, cancel_no: 1, esc: 255 }
+  CHECK_OPTS  = ['--separate-output']
+
+  OPT         = ->(o,x) { o.select { |k,v| OPTS[x][k] }
+                              .map { |k,v| OPTS[x][k][v] } }
+  ON_OFF      = ->(x) { x ? 'on' : 'off' }
+
+  # --
+
+  # translate method to option
+  WHAT = {                                                      # {{{1
+    show_info:  '--infobox'     , show_msg:   '--msgbox'    ,
+    show_text:  '--textbox'     , ask:        '--inputbox'  ,
+    ask_pass:   '--passwordbox' , ask_yesno:  '--yesno'     ,
+    menu:       '--menu'        , check:      '--checklist' ,
+    radio:      '--radiolist'   , gauge:      '--gauge'     ,
+  }                                                             # }}}1
+
+  # options per category
+  OPTS = {                                                      # {{{1
+    all: {
+      title:          ->(t) { ['--title', t] },
+      backtitle:      ->(t) { ['--backtitle', t] },
+      scroll:         ->(b) { b ? ['--scrolltext'] : [] },      # ????
+    },
+    ok: {
+      ok_button:      ->(t) { ['--ok-button', t] },
+    },
+    cancel: {
+      cancel_button:  ->(t) { ['--cancel-button', t] },
+      no_cancel:      ->(b) { b ? ['--nocancel'] : [] },
+    },
+    yes: {
+      yes_button:     ->(t) { ['--yes-button', t] },
+    },
+    no: {
+      no_button:      ->(t) { ['--no-button', t] },
+      default_no:     ->(b) { b ? ['--default-no'] : [] },
+    },
+    menu: {
+      selected:       ->(i) { ['--default-item', i] },
+    },
+  }                                                             # }}}1
+
+  # --
+
+  class Error < RuntimeError; end
+
+  # configuration class
+  class Cfg                                                     # {{{1
+    # set from hash, pass to block, freeze
+    def initialize(cfg = {}, &b)
+      @cfg = cfg; b[self] if b; @cfg.freeze
+    end
+
+    # call if set
+    def call(k, *a)
+      @cfg[k][*a] if @cfg[k]
+    end
+
+    # nothing by default
+    def _opts; [] end
+  end                                                           # }}}1
+
+  #
+
+  module CfgEsc   ; def on_esc(&b)    @cfg[:on_esc]     = b end; end
+  module CfgOK    ; def on_ok(&b)     @cfg[:on_ok]      = b end; end
+  module CfgCancel; def on_cancel(&b) @cfg[:on_cancel]  = b end; end
+  module CfgYes   ; def on_yes(&b)    @cfg[:on_yes]     = b end; end
+  module CfgNo    ; def on_no(&b)     @cfg[:on_no]      = b end; end
+
+  #
+
+  class CfgShowInfo   < Cfg                                   ; end
+  class CfgShowMsg    < Cfg; include CfgEsc, CfgOK            ; end
+  class CfgShowText   < Cfg; include CfgEsc, CfgOK            ; end
+  class CfgAsk        < Cfg; include CfgEsc, CfgOK, CfgCancel ; end
+  class CfgAskPass    < Cfg; include CfgEsc, CfgOK, CfgCancel ; end
+  class CfgAskYesNo   < Cfg; include CfgEsc, CfgYes, CfgNo    ; end
+  class CfgGauge      < Cfg                                   ; end
+
+  #
+
+  # menu config
+  class CfgMenu < Cfg                                           # {{{1
+    include CfgEsc, CfgOK, CfgCancel
+
+    def initialize(*a, &b)
+      @menu = []; super; @menu.freeze
+    end
+
+    # add menu item
+    def on(tag, item, &b)
+      @menu << { tag: tag, item: item, block: b }
+    end
+
+    def _menu; @menu end
+  end                                                           # }}}1
+
+  # checkboxes config
+  class CfgCheck < Cfg                                          # {{{1
+    include CfgEsc, CfgOK, CfgCancel
+
+    def initialize(*a, &b)
+      @check = []; super; @check.freeze
+    end
+
+    # add a choice
+    def choice(tag, item, selected = false)
+      @check << { tag: tag, item: item, selected: selected }
+    end
+
+    def _check; @check end
+    def _opts; CHECK_OPTS; end
+  end                                                           # }}}1
+
+  # radiolist config
+  class CfgRadio < Cfg                                          # {{{1
+    include CfgEsc, CfgOK, CfgCancel
+
+    def initialize(*a, &b)
+      @radio = []; super; @radio.freeze
+    end
+
+    # add a choice
+    def choice(tag, item)
+      @radio << { tag: tag, item: item }
+    end
+
+    def _radio; @radio end
+  end                                                           # }}}1
+
+  # --
+
+  # show message w/o buttons, don't clear screen
+  def self.show_info(text, opts = {})
+    _whip :show_info, text, CfgShowInfo.new, opts
+  end
+
+  # show message w/ OK button
+  def self.show_msg(text, opts = {}, &b)
+    c = CfgShowMsg.new(&b)
+    _whip(:show_msg, text, c, opts) { c.call :on_ok }
+  end
+
+  # show file contents or text w/ OK button
+  def self.show_text(opts = {}, &b)
+    _file_or_temp opts do |f|
+      c = CfgShowText.new(&b)
+      _whip(:show_text, f, c, opts) { c.call :on_ok }
+    end
+  end
+
+  # --
+
+  # ask for input w/ OK/Cancel buttons (and default)
+  def self.ask(text, opts = {}, &b)
+    c = CfgAsk.new(&b); a = opts[:default] ? [opts[:default]] : []
+    _whip(:ask, text, c, opts, a) do |lines|
+      c.call :on_ok, lines.first
+    end
+  end
+
+  # ask for password w/ OK/Cancel buttons
+  def self.ask_pass(text, opts = {}, &b)
+    c = CfgAskPass.new(&b)
+    _whip(:ask_pass, text, c, opts) do |lines|
+      c.call :on_ok, lines.first
+    end
+  end
+
+  # ask w/ Yes/No buttons
+  def self.ask_yesno(text, opts = {}, &b)
+    c = CfgAskYesNo.new(&b)
+    _whip(:ask_yesno, text, c, opts) { c.call :on_yes }
+  end
+
+  # --
+
+  # choose from menu w/ OK/Cancel buttons
+  def self.menu(text, opts = {}, &b)                            # {{{1
+    c = CfgMenu.new(&b); m = c._menu
+    o = opts.merge(subheight: opts[:menu_height]).freeze
+    a = m.map { |x| [x[:tag],x[:item]] } .flatten
+    t = Hash[m.map { |x| [x[:tag],x] }]
+    _whip(:menu, text, c, o, a) do |lines|
+      tag = lines.first; t[tag][:block][tag]
+    end
+  end                                                           # }}}1
+
+  # --
+
+  # choose checkboxes w/ OK/Cancel buttons
+  def self.check(text, opts = {}, &b)                           # {{{1
+    c = CfgCheck.new(&b); i = c._check
+    o = opts.merge(subheight: opts[:list_height]).freeze
+    a = i.map { |x| [x[:tag],x[:item],ON_OFF[x[:selected]]] } .flatten
+    _whip(:check, text, c, o, a) do |lines|
+      c.call :on_ok, lines
+    end
+  end                                                           # }}}1
+
+  # choose radiobutton w/ OK/Cancel buttons
+  def self.radio(text, opts = {}, &b)                           # {{{1
+    s = opts[:selected] ; f = ->(x) { ON_OFF[x == s] }
+    c = CfgRadio.new(&b); i = c._radio
+    o = opts.merge(subheight: opts[:list_height]).freeze
+    a = i.map { |x| [x[:tag],x[:item],f[x[:tag]]] } .flatten
+    _whip(:radio, text, c, o, a) do |lines|
+      c.call :on_ok, lines.first
+    end                                                         # }}}1
+  end
+
+  # --
+
+  # show gauge; use lambda passed to block to move it forward by
+  # passing it `percent[, message]`
+  def self.gauge(text, percent, opts = {}, &b)                  # {{{1
+    IO.pipe do |r, w|
+      mv  = ->(pct, msg = nil) {
+        msg ? w.puts('XXX', pct, msg, 'XXX', pct) : w.puts(pct) # WTF!
+      }
+      c   = CfgGauge.new
+      o   = _whip_opts :gauge, c, opts
+      c   = _whip_cmd text, opts, o, [percent]
+      pid = OU.spawn(*c, in: r)
+      r.close; b[mv]; w.close; Process.wait pid
+      raise Error, 'exitstatus != 0' if $?.exitstatus != 0
+    end                                                         # }}}1
+  end
+
+  # --
+
+  # process options, run whiptail, call `b[lines]` or
+  # `on_{cancel,no,esc}[]`
+  # @raise Error if unknown exitstatus
+  def self._whip(what, text, cfg, opts, args = [], &b)          # {{{1
+    o = _whip_opts what, cfg, opts; c = _whip_cmd text, opts, o, args
+    r = _run_whip c
+    case r[:exit]
+    when EXIT[:ok_yes]    ; b[r[:lines]] if b
+    when EXIT[:cancel_no] ; cfg.call :on_cancel; cfg.call :on_no
+    when EXIT[:esc]       ; cfg.call :on_esc
+    else                    raise Error, 'unknown exitstatus'
+    end
+    nil
+  end                                                           # }}}1
+
+  # process whiptail options
+  def self._whip_opts(what, cfg, opts)                          # {{{1
+     cfg._opts + [                  OPT[opts,:all],
+      cfg.respond_to?(:on_ok)     ? OPT[opts,:ok]     : [],
+      cfg.respond_to?(:on_cancel) ? OPT[opts,:cancel] : [],
+      cfg.respond_to?(:on_yes)    ? OPT[opts,:yes]    : [],
+      cfg.respond_to?(:on_no)     ? OPT[opts,:no]     : [],
+      what == :menu               ? OPT[opts,:menu]   : [],
+    ] .flatten + [WHAT[what]]
+  end                                                           # }}}1
+
+  # whiptail command
+  def self._whip_cmd(text, opts, opt_args, args)                # {{{1
+    h = opts[:height] || OU::Term.lines   - 4
+    w = opts[:width]  || OU::Term.columns - 4
+    s = opts.has_key?(:subheight) ? [opts[:subheight] || h - 8] : []
+    a = [WHIPTAIL] + opt_args + ['--', text, h, w] + s + args
+    a.map(&:to_s)
+  end                                                           # }}}1
+
+  # run whiptail
+  # @return [Hash] `{ exit: exitstatus, lines: chomped_lines }`
+  def self._run_whip(args)
+    IO.pipe do |r, w|
+      s = OU.spawn_w(*args, err: w); w.close
+      { exit: s.exitstatus, lines: r.readlines.map(&:chomp) }
+    end
+  end
+
+  # --
+
+  # call block w/ either `opts[:file]` or a tempfile w/ contents
+  # `opts[:text]`
+  def self._file_or_temp(opts, &b)                              # {{{1
+    file = opts[:file]; text = opts[:text]
+    raise Error, 'can\'t have file and text' if file && text
+    raise Error, 'must have file or text' if !file && !text
+    if file
+      b[file]
+    else
+      Tempfile.open('eft') { |f| f.write text; f.close; b[f.path] }
+    end
+  end                                                           # }}}1
+
+end
+
+# vim: set tw=70 sw=2 sts=2 et fdm=marker :

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: eft
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Felix C. Stegerman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: obfusk-util
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  ruby + whiptail
+
+  Eft is a ruby dsl that wraps whiptail to display dialog boxes.
+email:
+- flx@obfusk.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .yardopts
+- README.md
+- Rakefile
+- eft.gemspec
+- example.rb
+- lib/eft/version.rb
+- lib/eft.rb
+homepage: https://github.com/obfusk/eft
+licenses:
+- LGPLv3+
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: ruby + whiptail
+test_files: []