ncumbra 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e2e982667f4938fcec8de0033c42123cef862f3a4ccdf605abfd509852949b2b
+  data.tar.gz: 259e0d105fbbae4bfa07d3470be80d726cee091de29447a7ae70a994b376c262
+SHA512:
+  metadata.gz: e7ce64a554e6644cb8303da6bd76d2a837c8009231adf5c680acf4af3324ae3351a763fa96a66e9e554ca3dde008fe9b696ccce21a1831a0128bf7f30e4dceeb
+  data.tar.gz: 32acff4e2f0c371a512fd8258ad5f1d565b97f22b0af067ebbbcff5f8009bbb37c0f3e499f371680ae3a964eb43cad834903b300f750a53905e5eab14cb52081

data/.gitignore

@@ -0,0 +1,25 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+bak
+zbak
+*.log
+notes
+bugs
+t.t
+*.tgz
+*.zip
+*.gz
+*.t
+*.1
+todo
+bug
+*.gem
+*.rbc
+tmp.*
+*.bak

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in umbra.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 kepler
+
+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 without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,48 @@
+# Umbra
+
+stripped version of canis (ncurses ruby)
+
+ - Minimal functionality
+ - Very close to ncurses, should not try to wrap everything
+ - load only what you need
+ - not necessarily object oriented, that is not a goal
+ - should be able to use a file or widget from here without having to copy too much
+ - should be able to understand one file without having to understand entire library
+ - should be easy for others to change as per their needs, or copy parts.
+ - 
+
+
+Currently, not looking at ALT keys, this may change in the future. Only single and control keys and function keys trapped 
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'umbra'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install umbra
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mare-imbrium/umbra.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/README.md.bak

@@ -0,0 +1,15 @@
+# umbra
+
+stripped version of canis (ncurses ruby)
+
+ - Minimal functionality
+ - Very close to ncurses, should not try to wrap everything
+ - load only what you need
+ - not necessarily object oriented, that is not a goal
+ - should be able to use a file or widget from here without having to copy too much
+ - should be able to understand one file without having to understand entire library
+ - should be easy for others to change as per their needs, or copy parts.
+ - 
+
+
+Currently, not looking at ALT keys, this may change in the future. Only single and control keys and function keys trapped 

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "umbra"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/ex1.rb

@@ -0,0 +1,85 @@
+#!/usr/bin/env ruby
+# example showing only labels on a window
+# 2018-03-10 
+require 'umbra'
+require 'umbra/label'
+
+def startup
+  require 'logger'
+  require 'date'
+
+    path = File.join(ENV["LOGDIR"] || "./" ,"v.log")
+    file   = File.open(path, File::WRONLY|File::TRUNC|File::CREAT) 
+    $log = Logger.new(path)
+    $log.level = Logger::DEBUG
+    today = Date.today
+    $log.info "Started up on #{today}"
+    FFI::NCurses.init_pair(10,  FFI::NCurses::BLACK,   FFI::NCurses::GREEN) # statusline
+end
+def statusline win, str, col = 0
+  win.printstring( FFI::NCurses.LINES-1, col, str, 10)
+end
+begin
+  include Umbra
+  init_curses
+  startup
+  win = Window.new
+  statusline(win, " "*(win.width-0), 0)
+  statusline(win, "Press q to quit #{win.height}:#{win.width}", 20)
+  title = Label.new( :text => "Demo of Labels", :row => 0, :col => 0 , :width => FFI::NCurses.COLS-1, 
+                    :justify => :center, :color_pair => 0)
+
+  form = Form.new win
+  form.add_widget title
+  labels = ["Name: ", "Address: ","Mobile No.", "Email Id:","Hobbies: "]
+  labs = []
+  row = 3
+  col = 5
+  labels.each_with_index {|lab, ix| 
+    w = Label.new( :text => lab, :row => row, :col => col )
+    labs << w
+    row += 2
+    w.color_pair = 1
+    w.attr = FFI::NCurses::A_BOLD
+    form.add_widget w
+  }
+  labels = ["Roger Federer", "20 Slam Drive","9810012345", "ihumble@tennis.com","golf, programming"]
+  row = 3
+  col = 30
+  labels.each_with_index {|lab, ix| 
+    w = Label.new( :text => lab, :row => row, :col => col , :width => 50)
+    labs << w
+    row += 2
+    w.color_pair = 1
+    w.attr = FFI::NCurses::A_REVERSE
+    form.add_widget w
+  }
+  form.pack
+  win.wrefresh
+
+  y = x = 1
+  while (ch = win.getkey) != 113
+    #y, x = win.getbegyx(win.pointer)
+    old_y, old_x = y, x
+    case ch
+    when FFI::NCurses::KEY_RIGHT
+    when FFI::NCurses::KEY_LEFT
+      # go back higher level
+    when FFI::NCurses::KEY_UP
+    when FFI::NCurses::KEY_DOWN
+    end
+    #FIXME after scrolling, pointer is showing wrong file here
+    statusline(win, "Pressed #{ch} on     ", 70)
+    win.wrefresh
+  end
+
+rescue Object => e
+  @window.destroy if @window
+  FFI::NCurses.endwin
+  puts e
+  puts e.backtrace.join("\n")
+ensure
+  @window.destroy if @window
+  FFI::NCurses.endwin
+  puts 
+end

data/examples/ex2.rb

@@ -0,0 +1,128 @@
+#!/usr/bin/env ruby
+# example showing only labels and fields a window
+# 2018-03-10 
+require 'umbra'
+require 'umbra/label'
+require 'umbra/field'
+
+def create_footer_window h = 2 , w = FFI::NCurses.COLS, t = FFI::NCurses.LINES-2, l = 0
+  ewin = Window.new(h, w , t, l)
+end
+def _alert str 
+  win = create_footer_window
+  #FFI::NCurses.init_pair(12,  COLOR_WHITE, FFI::NCurses::RED)
+  cp = create_color_pair(COLOR_RED, COLOR_WHITE)
+  win.wbkgd(FFI::NCurses.COLOR_PAIR(cp)) # white on red, defined here
+  win.printstring(0,1, str)
+  win.wrefresh
+  win.getkey
+  win.destroy
+end
+def startup
+  require 'logger'
+  require 'date'
+
+    path = File.join(ENV["LOGDIR"] || "./" ,"v.log")
+    file   = File.open(path, File::WRONLY|File::TRUNC|File::CREAT) 
+    $log = Logger.new(path)
+    $log.level = Logger::DEBUG
+    today = Date.today
+    $log.info "Field demo #{$0} started on #{today}"
+    FFI::NCurses.init_pair(10,  FFI::NCurses::BLACK,   FFI::NCurses::GREEN) # statusline
+end
+def statusline win, str, col = 0
+  win.printstring( FFI::NCurses.LINES-1, col, str, 10)
+end
+begin
+  include Umbra
+  init_curses
+  startup
+  #FFI::NCurses.init_pair(12,  COLOR_WHITE, FFI::NCurses::RED)
+  win = Window.new
+  statusline(win, " "*(win.width-0), 0)
+  statusline(win, "Press C-q to quit #{win.height}:#{win.width}", 20)
+  title = Label.new( :text => "Demo of Fields", :row => 0, :col => 0 , :width => FFI::NCurses.COLS-1, 
+                    :justify => :center, :color_pair => CP_BLACK)
+
+  form = Form.new win
+  form.add_widget title
+  labels = ["Name:", "Age:", "Address:","Mobile No.:", "Email Id:","Hobbies:"]
+  labs = []
+  row = 3
+  col = 5
+  labels.each_with_index {|lab, ix| 
+    w = Label.new( :text => lab, :row => row, :col => col , :width => 20)
+    labs << w
+    row += 2
+    w.color_pair = CP_WHITE
+    w.justify = :right
+    w.attr = FFI::NCurses::A_BOLD
+    form.add_widget w
+  }
+  labels = ["Roger Federer", "20 Slam Drive","9810012345", "ihumble@tennis.com","golf, programming"]
+  labels = ["name", "age", "address","mobile", "email","hobbies"]
+ 
+  row = 3
+  col = 30
+  fhash = {}
+  labels.each_with_index {|lab, ix| 
+    w = Field.new( :name => lab, :row => row, :col => col , :width => 50)
+    fhash[lab] = w
+    row += 2
+    w.color_pair = CP_CYAN
+    w.attr = FFI::NCurses::A_REVERSE
+    w.highlight_color_pair = CP_YELLOW
+    w.highlight_attr = REVERSE
+    w.null_allowed = true
+    form.add_widget w
+  }
+  message_label = Label.new({text: "Message comes here C-q to quit",
+                             :name=>"message_label",:row => win.height-2, :col => 2, :width => 60,
+                             :height => 2, :color_pair => CP_MAGENTA})
+  form.add_widget message_label
+  #fhash["mobile"].type = :integer
+  fhash["mobile"].chars_allowed = /[\d\-]/
+  fhash["mobile"].maxlen = 10
+  fhash["mobile"].bind_event(:CHANGE) do |f|
+    message_label.text = "#{f.getvalue.size()} chars entered"
+    statusline(win, "#{f.getvalue.size()} chars entered")
+    message_label.repaint_required
+  end
+  fhash["email"].chars_allowed = /[\w\+\.\@]/
+  fhash["email"].valid_regex = /\w+\@\w+\.\w+/
+  fhash["age"].valid_range = (18..100)
+  fhash["age"].type = :integer
+  fhash["hobbies"].maxlen = 100
+  form.pack
+  form.select_first_field
+  win.wrefresh
+
+  y = x = 1
+  while (ch = win.getkey) != FFI::NCurses::KEY_CTRL_Q
+    begin
+      form.handle_key ch
+    rescue => e
+      _alert(e.to_s)
+      $log.error e
+      $log.error e.backtrace.join("\n")
+      e = nil
+    end
+    win.wrefresh
+  end
+
+rescue => e
+  win.destroy if win
+  FFI::NCurses.endwin
+  puts "printing inside rescue"
+  puts e
+  puts e.backtrace.join("\n")
+  e = nil
+ensure
+  win.destroy if win
+  FFI::NCurses.endwin
+  if e
+    puts "printing inside ensure"
+    puts e 
+    puts e.backtrace.join("\n")
+  end
+end

data/examples/ex21.rb

@@ -0,0 +1,136 @@
+#!/usr/bin/env ruby
+# example showing labeledfield
+# 2018-03-10 
+require 'umbra'
+require 'umbra/label'
+require 'umbra/labeledfield'
+
+def create_footer_window h = 2 , w = FFI::NCurses.COLS, t = FFI::NCurses.LINES-2, l = 0
+  ewin = Window.new(h, w , t, l)
+end
+def _alert str 
+  win = create_footer_window
+  #FFI::NCurses.init_pair(12,  COLOR_WHITE, FFI::NCurses::RED)
+  cp = create_color_pair(COLOR_RED, COLOR_WHITE)
+  win.wbkgd(FFI::NCurses.COLOR_PAIR(cp)) # white on red, defined here
+  win.printstring(0,1, str)
+  win.wrefresh
+  win.getkey
+  win.destroy
+end
+def startup
+  require 'logger'
+  require 'date'
+
+    path = File.join(ENV["LOGDIR"] || "./" ,"v.log")
+    file   = File.open(path, File::WRONLY|File::TRUNC|File::CREAT) 
+    $log = Logger.new(path)
+    $log.level = Logger::DEBUG
+    today = Date.today
+    $log.info "Field demo #{$0} started on #{today}"
+    FFI::NCurses.init_pair(10,  FFI::NCurses::BLACK,   FFI::NCurses::GREEN) # statusline
+end
+def statusline win, str, col = 0
+  win.printstring( FFI::NCurses.LINES-1, col, str, 10)
+end
+begin
+  include Umbra
+  init_curses
+  startup
+  #FFI::NCurses.init_pair(12,  COLOR_WHITE, FFI::NCurses::RED)
+  win = Window.new
+  statusline(win, " "*(win.width-0), 0)
+  statusline(win, "Press C-q to quit #{win.height}:#{win.width}", 20)
+  title = Label.new( :text => "Demo of LabeledFields", :row => 0, :col => 0 , :width => FFI::NCurses.COLS-1, 
+                    :justify => :center, :color_pair => CP_BLACK)
+
+  form = Form.new win
+  form.add_widget title
+  labels = ["Name:", "Age:", "Address:","Mobile No.:", "Email Id:","Hobbies:"]
+  labs = []
+  row = 3
+  col = 5
+=begin
+  labels.each_with_index {|lab, ix| 
+    w = Label.new( :text => lab, :row => row, :col => col , :width => 20)
+    labs << w
+    row += 2
+    w.color_pair = CP_WHITE
+    w.justify = :right
+    w.attr = FFI::NCurses::A_BOLD
+    form.add_widget w
+  }
+=end
+  labels = ["Name:", "Age:", "Address:","Mobile No.:", "Email Id:","Hobbies:"]
+  names = ["name", "age", "address","mobile", "email","hobbies"]
+ 
+  row = 3
+  col = 30
+  fhash = {}
+  names.each_with_index {|lab, ix| 
+    w = LabeledField.new( :name => lab, :row => row, :col => col , :width => 50, label: labels[ix],
+                         :label_highlight_attr => BOLD
+                        )
+    fhash[lab] = w
+    row += 2
+    w.color_pair = CP_CYAN
+    w.attr = FFI::NCurses::A_REVERSE
+    w.highlight_color_pair = CP_YELLOW
+    w.highlight_attr = REVERSE
+    w.null_allowed = true
+    form.add_widget w
+  }
+  message_label = Label.new({text: "Message comes here C-q to quit",
+                             :name=>"message_label",:row => win.height-2, :col => 2, :width => 60,
+                             :height => 2, :color_pair => CP_MAGENTA})
+  form.add_widget message_label
+  #fhash["mobile"].type = :integer
+  fhash["mobile"].chars_allowed = /[\d\-]/
+  fhash["mobile"].maxlen = 10
+  fhash["mobile"].mnemonic = "m"
+  fhash["name"].mnemonic = "n"
+  fhash["age"].mnemonic = "a"
+  fhash["address"].mnemonic = "d"
+  fhash["mobile"].bind_event(:CHANGE) do |f|
+    message_label.text = "#{f.getvalue.size()} chars entered"
+    statusline(win, "#{f.getvalue.size()} chars entered")
+    message_label.repaint_required
+  end
+  fhash["email"].chars_allowed = /[\w\+\.\@]/
+  fhash["email"].valid_regex = /\w+\@\w+\.\w+/
+  fhash["age"].valid_range = (18..100)
+  fhash["age"].type = :integer
+  fhash["hobbies"].maxlen = 100
+  form.pack
+  form.select_first_field
+  win.wrefresh
+
+  y = x = 1
+  while (ch = win.getkey) != FFI::NCurses::KEY_CTRL_Q
+    begin
+      form.handle_key ch
+    rescue => e
+      _alert(e.to_s)
+      $log.error e
+      $log.error e.backtrace.join("\n")
+      e = nil
+    end
+    win.wrefresh
+  end
+
+rescue => e
+  win.destroy if win
+  FFI::NCurses.endwin
+  puts "printing inside rescue"
+  puts e
+  puts e.backtrace.join("\n")
+  e = nil
+ensure
+  win.destroy if win
+  FFI::NCurses.endwin
+  if e
+    puts "printing inside ensure"
+    puts e 
+    puts e.backtrace.join("\n")
+  end
+end

data/examples/ex3.rb

@@ -0,0 +1,163 @@
+#!/usr/bin/env ruby
+# example showing labels and fields and buttons
+# 2018-03-11 
+require 'umbra'
+require 'umbra/label'
+require 'umbra/field'
+require 'umbra/button'
+require 'umbra/togglebutton'
+require 'umbra/checkbox'
+require 'umbra/buttongroup'
+require 'umbra/radiobutton'
+
+def startup
+  require 'logger'
+  require 'date'
+
+    path = File.join(ENV["LOGDIR"] || "./" ,"v.log")
+    file   = File.open(path, File::WRONLY|File::TRUNC|File::CREAT) 
+    $log = Logger.new(path)
+    $log.level = Logger::DEBUG
+    today = Time.now.to_s
+    $log.info "Button demo #{$0} started on #{today}"
+    FFI::NCurses.init_pair(10,  FFI::NCurses::BLACK,   FFI::NCurses::GREEN) # statusline
+end
+def statusline win, str, col = 1
+  # LINES-2 prints on second last line so that box can be seen
+  win.printstring( FFI::NCurses.LINES-2, col, str, 6, REVERSE)
+end
+begin
+  include Umbra
+  init_curses
+  startup
+  #win = Window.new
+  win = Window.new 21,100, 0, 20
+  statusline(win, " "*(win.width-0), 0)
+  win.box
+  statusline(win, "Press C-q to quit #{win.height}:#{win.width}", 20)
+  str = " Demo of Buttons "
+  win.title str
+
+  catch(:close) do
+  form = Form.new win
+  labels = ["Name: ", "Address: ","Mobile No.", "Email Id:","Hobbies: "]
+  labs = []
+  row = 3
+  col = 5
+  labels.each_with_index {|lab, ix| 
+    w = Label.new( :text => lab, :row => row, :col => col )
+    labs << w
+    row += 2
+    w.color_pair = 1
+    w.attr = BOLD
+    form.add_widget w
+  }
+  labels = ["Roger Federer", "20 Slam Drive","9810012345", "ihumble@tennis.com","golf, programming"]
+  labels = ["name", "address","mobile", "email","hobbies"]
+ 
+  row = 3
+  col = 30
+  labels.each_with_index {|lab, ix| 
+    w = Field.new( :name => lab, :row => row, :col => col , :width => 50)
+    labs << w
+    row += 2
+    w.color_pair = 1
+    w.attr = REVERSE
+    form.add_widget w
+  }
+
+  message_label = Label.new({text: "Message comes here C-q to quit",
+                             :name=>"message_label",:row => win.height-2, :col => 2, :width => 60,
+                             :height => 2, :color_pair => 5})
+
+  row += 0
+  togglebutton = ToggleButton.new()
+  togglebutton.value = true
+  togglebutton.onvalue = " Toggle Down "
+  togglebutton.offvalue ="  Untoggle   "
+  togglebutton.row = row
+  togglebutton.col = col
+  togglebutton.command do
+    if togglebutton.value
+      message_label.text = "Toggle button was pressed"
+    else
+      message_label.text = "UNToggle button was pressed"
+    end
+    # we need this since we have done away with dsl_property
+    message_label.repaint_required = true
+  end
+  form.add_widget togglebutton 
+
+  check = Checkbox.new text: "No Frames", value: true, row: row+1, col: col, mnemonic: "N"
+  check1 = Checkbox.new text: "Use https", value: false, row: row+2, col: col, mnemonic: "U"
+  row += 2
+  form.add_widget check, check1
+  [ check, check1 ].each do |cb|
+    cb.command do 
+      message_label.text = "#{cb.text} is now #{cb.value}"
+      message_label.repaint_required = true
+    end
+  end
+
+  radio1 = RadioButton.new text: "Red", value: "Red", row: check.row, col: col+20
+  radio2 = RadioButton.new text: "Blue", value: "Blue", row: check1.row, col: col+20
+  group = ButtonGroup.new "Color"
+  group.add(radio1).add(radio2)
+  form.add_widget radio1, radio2
+  group.command do
+    message_label.text = "#{group.name} #{group.value} has been selected"
+    message_label.repaint_required = true
+  end
+
+  ok_butt = Button.new( :name => 'ok', :text => 'Ok', :row => row+2, :col => col, :width => 10 , :color_pair => 0, :mnemonic => 'O')
+  cancel_butt = Button.new( :name => 'cancel', :text => 'Cancel', :row => row+2, :col => col + 20, :width => 10 , :color_pair => 0, mnemonic: 'C')
+  form.add_widget ok_butt
+  form.add_widget cancel_butt
+  FFI::NCurses.mvwhline(win.pointer, ok_butt.row+1, 1, FFI::NCurses::ACS_HLINE, win.width-2)
+  cancel_butt.command do
+    throw :close
+  end
+  ok_butt.command do
+    form.focusables.each_with_index {|f, ix| 
+      if f.class.to_s == "Field"
+        $log.debug "FIELD #{f.name} = #{f.text}"
+      else
+        $log.debug "WIDGET #{f.class.to_s}, #{f.name} = #{f.text}"
+      end
+    }
+    throw :close
+  end
+
+
+  form.add_widget message_label
+
+  form.pack
+  form.select_first_field
+  win.wrefresh
+
+  y = x = 1
+  while (ch = win.getch) != FFI::NCurses::KEY_CTRL_Q
+    begin
+      form.handle_key ch
+    rescue => e
+      puts e
+      puts e.backtrace.join("\n")
+    end
+    win.wrefresh
+  end
+  end # close
+
+rescue => e
+  win.destroy if win
+  win = nil
+  FFI::NCurses.endwin
+  puts e
+  puts e.backtrace.join("\n")
+ensure
+  win.destroy if win
+  FFI::NCurses.endwin
+  if e
+    puts e 
+    puts e.backtrace.join("\n")
+  end
+end