reterm 0.4.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b8eccbffc9e67c0b58c4ecce6689ed983192fdfc
+  data.tar.gz: fa932fa439231e95d1bb945c33a3e760da491f4a
+SHA512:
+  metadata.gz: 45677b6521f05935d939bac79b2ab237508ce109cf177868a69136f89cfb0993fa3404202b87d0c90cc2734439250db8a00401c4509b5eb7ddabcb0128ddc282
+  data.tar.gz: 5800ed5af8c81a8909a3ce6f50a4ee7fba3db37bfd932a14d927fba956accb60d1b603cf196a2e5e9105ab748072f1d5d53b460a707f1e9c914ecccf08376c1f

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2017 Mo Morsi (mo@morsi.org)
+
+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,131 @@
+# RETerm - Ruby Enhanced Terminal
+
+RETerm is a Text Based User Interface Framework built ontop of [ncurses](https://en.wikipedia.org/wiki/Ncurses)
+
+## Worth a thousand words...
+
+![Screenshot1](examples/sc1.gif)
+
+## Installation
+
+RETerm depends on the **ncursesw** rubygem, which in return depends on the '[ncursesw](https://www.gnu.org/software/ncurses/)' and terminfo libraries. These must be available for use locally via on means or another. Most Operating Systems and distributions have a binary / bundled version available, read the ncurses documentation for more information. The following packages should suffice to install on Linux:
+
+```
+  $ dnf install ruby-devel ncurses-devel (Fedora/RedHat)
+
+  $ apt-get install ruby-dev libncursesw5-dev libncurses5-dev libtinfo-dev (Ubuntu)
+```
+
+To install the core RETerm framework and components, simply run:
+
+```
+  $ gem install reterm
+```
+
+## Optional Components
+
+RETerm ships with components that depend on additional gem dependencies. These features are completely optional and will not be required unless the corresponding components are
+instantiated. To install all optional RETerm dependencies run:
+
+```
+  $ gem install artii drawille chunky_png tawny-cdk
+```
+
+## Usage
+
+See the **examples/** directory for demos of many common components.
+
+The following will instantiate a simple "Hello World" interface:
+
+```ruby
+require 'reterm'
+include RETerm
+
+init_reterm {
+  win = Window.new :rows => 10,
+                   :cols => 30
+  win.border!
+  update_reterm
+
+  label = Components::Label.new :text => "Hello world"
+  win.component = label
+  label.draw!
+
+  sleep(3)
+}
+```
+
+For something more interesting, create and activate layout and components. After
+we are done, reading the user input is a cinch!
+
+```ruby
+results = {}
+
+init_reterm {
+  win = Window.new
+  win.colors = :main
+  win.border!
+
+  layout1 = Layouts::Horizontal.new
+  win.component = layout1
+
+  child1 = layout1.add_child :rows => 3,
+                             :cols => 20
+
+  dial = Components::Dial.new
+  child1.component = dial
+
+  child2 = layout1.add_child :rows => 15,
+                             :cols => 40
+
+  entry = Components::Entry.new :title => "Enter: ", :label => "Text:"
+  child2.component = entry
+
+  ###
+
+  win.activate!
+
+  results[:dial]   = dial.value
+  results[:entry]  = entry.value
+}
+
+puts "Input results: "
+puts results
+```
+
+How about a generic JSON schema representing a terminal interface?
+
+```json
+{
+  "window" : {
+    "rows"      : 10,
+    "cols"      : 50,
+    "border"    : true,
+    "component" : {
+      "type" : "Entry",
+      "init" : {
+        "title" : "<C>Demo",
+        "label" : "Enter Text: "
+      }
+    }
+  }
+}
+```
+
+And here's how to load it:
+
+```ruby
+init_reterm {
+  load_reterm(File.read('path/to/schema.json')).activate!
+}
+```
+
+## Documentation
+
+Full reference documentation is available via [yard](http://www.rubydoc.info/gems/reterm)
+
+## Legaleese
+
+Copyright (C) 2017 Mo Morsi <mo@morsi.org>
+
+Distributed under the MIT licesnse

data/designer/main.rb

@@ -0,0 +1,10 @@
+#!/usr/bin/ruby
+
+require "vrlib"
+require_rel 'src/'
+
+designer = Designer.new
+designer.show_glade()
+
+require 'pp'
+pp designer.created_list.schema

data/designer/src/ComponentParams.rb

@@ -0,0 +1,120 @@
+# Popup window allowing us to set component parameters
+class ComponentParams
+  include GladeGUI
+
+  def initialize(component, window)
+    super()
+    @component = component
+    @window = window
+  end
+
+  def submit_button__clicked(*args)
+    @window.create_component(@component, component_params)
+    @builder["window1"].destroy
+  end
+
+  def cancel_button__clicked(*args)
+    @builder["window1"].destroy
+  end
+
+  def before_show
+    @builder[:component_edit_title].text = "Edit \"#{@component}\" params"
+
+    COMPONENTS[@component][:params].each { |label, type|
+      layout = Gtk::HBox.new
+
+      glabel = Gtk::Label.new label
+      glabel.margin = 5
+      layout.add glabel
+      glabel.show
+
+      if type.is_a?(Array)
+        placeholder = Gtk::Image.new(:file => "#{IMG_DIR}/blank_sm.png")
+        layout.pack_end placeholder
+        placeholder.margin = 14
+        placeholder.show
+
+        add_img = Gtk::Image.new(:file => "#{IMG_DIR}/add.png")
+        add_btn = Gtk::Button.new
+        add_btn.margin = 5
+        add_btn.add(add_img)
+
+        layout.pack_end add_btn
+        add_btn.signal_connect("clicked") {
+          add_row(label, type)
+        }
+
+        add_img.show
+        add_btn.show
+      end
+
+      gedit = Gtk::Entry.new
+      layout.pack_end gedit
+      gedit.show
+
+
+      @builder[:component_edit_layout].add layout
+      layout.show
+    }
+  end
+
+  private
+
+  def component_params
+    @builder[:component_edit_layout].children.collect { |c|
+      p = c.children.first # label
+           .text
+
+      t = COMPONENTS[@component][:params][p]
+      t = t.first if t.is_a?(Array)
+
+      txt = c.children[1].text
+      if t == :int
+        txt.to_i
+      else # if t == :string
+        txt
+      end
+    }
+  end
+
+  def add_row(label, type)
+    layout = Gtk::HBox.new
+    glabel = Gtk::Label.new
+    glabel.margin = 5
+    layout.add glabel
+    glabel.show
+
+    rm_img = Gtk::Image.new(:file => "#{IMG_DIR}/remove.png")
+    rm_btn = Gtk::Button.new
+    rm_btn.add(rm_img)
+    rm_btn.margin = 5
+    layout.pack_end rm_btn
+    rm_btn.signal_connect("clicked") {
+      rm_row(layout)
+    }
+    rm_img.show
+    rm_btn.show
+
+    add_img = Gtk::Image.new(:file => "#{IMG_DIR}/add.png")
+    add_btn = Gtk::Button.new
+    add_btn.margin = 5
+    add_btn.add(add_img)
+    layout.pack_end add_btn
+    add_btn.signal_connect("clicked") {
+      add_row(label, type)
+    }
+    add_img.show
+    add_btn.show
+
+    gedit = Gtk::Entry.new
+    layout.pack_end gedit
+    gedit.show
+
+    @builder[:component_edit_layout].add layout
+    layout.show
+  end
+
+  def rm_row(layout)
+    @builder[:component_edit_layout].remove layout
+  end
+end

data/designer/src/ComponentsList.rb

@@ -0,0 +1,90 @@
+# List of supported components
+class ComponentsList < VR::ListView
+  attr_accessor :designer
+
+  def initialize(designer)
+    @designer = designer
+
+    @cols = {}
+    @cols[:pix]   = GdkPixbuf::Pixbuf
+    @cols[:title] = String
+    @cols[:desc]  = String
+    super(@cols)
+
+    parse_signals # XXX needed for row activation callback
+
+    col_title(:pix   => "",
+              :title => "Component",
+              :desc  => "Description")
+
+    self.visible = true
+
+    first = true
+    selection.signal_connect("changed") {
+      unless selection.selected.nil?
+        changed unless first
+        selection.unselect_all
+        first = false
+      end
+    }
+  end
+
+  def add_component(c)
+    row = model.append
+    row[id(:pix)]   = icon_for(c)
+    row[id(:title)] = c
+    row[id(:desc)]  = desc_for(c)
+  end
+
+  def self__row_activated(*args)
+    changed
+  end
+
+  private
+
+  def changed
+    unless designer.has_toggled_area?
+      dialog = Gtk::MessageDialog.new(:parent  => designer.window,
+					                            :flags   => :destroy_with_parent,
+                                      :type    => :info,
+                                      :buttons => :close,
+                       :message => "Must select area to add component")
+
+      dialog.signal_connect("response") { |*args|
+        dialog.destroy
+      }
+      dialog.show
+      return
+    end
+
+
+    c = selection.selected[1]
+    e = COMPONENTS[c.intern]
+    if e.key?(:params)
+      w = ComponentParams.new(c.intern, designer)
+      w.show_glade(designer)
+    else
+      designer.create_component(c.intern, [])
+    end
+  end
+
+  DEFAULT_IMG = GdkPixbuf::Pixbuf.new(:file => "#{IMG_DIR}/blank.png")
+
+  def desc_for(c)
+    COMPONENTS[c][:desc]
+  end
+
+  def icon_for(c)
+    if File.exist?("#{IMG_DIR}/#{c.to_s.downcase}.png")
+      GdkPixbuf::Pixbuf.new(:file => "#{IMG_DIR}/#{c.to_s.downcase}.png")
+    else
+      DEFAULT_IMG
+    end
+  end
+
+  public
+
+  def image_for(c)
+    Gtk::Image.new(icon_for(c))
+  end
+end

data/designer/src/CreatedList.rb

@@ -0,0 +1,156 @@
+# List of components created
+class CreatedList < VR::TreeView
+  attr_accessor :designer, :schema
+
+  attr_accessor :rows_by_parent,
+                :rows_by_widget,
+                :rows_by_component,
+                :params_by_widget
+
+  def initialize(designer)
+    @designer = designer
+
+    @rows_by_parent   = {}
+    @rows_by_widget   = {}
+    @params_by_widget = {}
+    @rows_by_component = {}
+
+    @cols = {}
+    @cols[:title] = String
+    @cols[:rm]    = GdkPixbuf::Pixbuf
+    super(@cols)
+
+    col_title(:rm    => "Remove",
+              :title => "Component")
+
+    self.activate_on_single_click = true
+
+    self.signal_connect("row_activated") { |*args|
+      if args[2] == columns[1]
+        path = args[1]
+        iter = model.get_iter(path)
+        unregister(iter)
+      end
+
+      selection.unselect_all
+    }
+  end
+
+  def register(component, params, widget, parent)
+    img = GdkPixbuf::Pixbuf.new(:file => "#{IMG_DIR}/remove.png")
+
+    row             = model.append row_for(parent)
+    row[id(:title)] = component.to_s
+    row[id(:rm)]    = img
+
+    rows_by_parent[parent] ||= []
+    rows_by_parent[parent]  << row
+
+    rows_by_component[component] = row
+    rows_by_widget[widget]       = row
+    params_by_widget[widget]     = params
+
+    if visible?
+      designer.builder["created_window"].visible = true
+      show
+    end
+
+    @schema = _schema
+  end
+
+  def visible?
+    rows_by_parent.any? { |k,v| v.size > 0 }
+  end
+
+  def parent_for(row)
+    rows_by_parent.keys.find { |k|
+      rows_by_parent[k].include?(row)
+    }
+  end
+
+  def row_for(widget)
+    rows_by_widget[widget]
+  end
+
+  def widget_for(row)
+    rows_by_widget.keys.find { |k|
+      rows_by_widget[k] == row
+    }
+  end
+
+  def component_for(row)
+    rows_by_component.keys.find { |k|
+      rows_by_component[k] == row
+    }
+  end
+
+  def component_for_widget(widget)
+    component_for(row_for(widget))
+  end
+
+  def unregister(row)
+    0.upto(row.n_children-1) { |child|
+      unregister(row.nth_child(child))
+    }
+
+    parent = parent_for(row)
+    widget = widget_for(row)
+
+    rows_by_parent[parent].delete(row)
+    rows_by_widget.delete(widget)
+    model.remove(row)
+
+    designer.remove_component(widget)
+
+    unless visible?
+      designer.builder["created_window"].visible = false
+      hide
+    end
+
+    @schema = _schema
+  end
+
+  def _schema
+    win = {'window' => {}}
+
+    top = rows_by_parent[nil].first # there should be only one element here
+    tc  = component_for(top)
+    wg  = widget_for(top)
+
+    if wg.kind_of?(Gtk::Box)
+      win['window']["layout"] = layout_schema(wg)
+    else
+      win['window']["component"] = {"type" => tc,
+                                    "init" => params_for(wg)}
+    end
+
+    win
+  end
+
+  private
+
+  def params_for(w)
+    keys = COMPONENTS[component_for_widget(w)][:init_keys]
+    return [] unless keys
+    vals = params_by_widget[w]
+    Hash[keys.zip(vals)]
+  end
+
+  def layout_schema(l)
+    h = l.orientation == Gtk::Orientation::HORIZONTAL
+    s = {"type" => (h ? "Horizontal" : "Vertical"),
+         "children" => []}
+
+    l.children.each { |c|
+      next unless component_for_widget(c)
+      s["children"] << (c.kind_of?(Gtk::Box) ?
+                         layout_schema(c) :
+                         {"component" => {
+                           "type" => component_for(row_for(c)),
+                           "init" => params_for(c)
+                         }})
+    }
+
+    s
+  end
+end