hetch 0.1.0

data/README.md

@@ -0,0 +1,55 @@
+Hetch is Graphical User interface to fetch a Regex pattern from a text file and display the result in a text window in the same GUI.
+
+The Gui is called by a simpified call to the Tcl/Tk Syntax built in a gui class in a separate "gui.rb"file.
+
+The "gui.rb"demonstrates the way to call various widgets including a Help menu on the Menubar which includes the instruction on use of "gui.rb". The Help text is included in a separate "guide.rb" file.
+
+Classes:
+class Gui
+class H # Hetch file to fetch string matching a pattern
+class Guide # to "view" the help instructions
+
+Files:
+gui.rb
+hetch.rb
+guide.rb
+hetch_tk # file containing the main script to call GUI
+
+USAGE:
+simply run 'hetch_tk' file from the command prompt
+
+Using the 'gui.rb' file:
+the Gui class may be used for building other Gui's by calling the class name followed by the method with its parameters.
+x, y are the row number (x) and column number (y) in grid geometry
+
+1. Gui.root: no parameters
+2. Gui.entry($var1, x, y) : $var1 is the variable that contains entry text.
+    Gui.entry($var2, x, y) : $var2 is the variable that contains entry
+3. Gui.textfield(h, w, c1, c2, x, y) : The parameters are 
+        h=height, w=width, c1=background color, c2=foreground color
+4. Gui.button(tx1, m, x, y) : tx1= text on button, m= method triggered by button.
+The method should be written in the active script before the end Gui.show command. e.g.
+  This simple method just add the two variables and get result into the text window.
+    def m 
+      z = $var1+ $var2 
+      $textfield.delete(1.0, 'end') 
+      $textfield.insert(1.0, '#{z}')
+    end
+5. Gui.label(tx2, x, y): tx2 = text on label
+6. Gui.show :Tk.mainloop
+#______________SAMPLE SCRIPT___________________
+require_relative 'gui'
+Gui.root
+Gui.menu
+Gui.label("Enter Number", 0, 0)
+Gui.entry($var1, 0, 1)
+Gui.label("Enter Number", 1, 0)
+Gui.entry($var2, 1, 1)
+Gui.textfield(15, 1, "black", "white", 2, 1)
+Gui.button("OK", "m" , 2, 0) 
+def m
+$z = $var1 + $var2
+$textfield.insert('end', "#$z")
+end 
+Gui.show
+#________________________________________________

data/hetch.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "hetch"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Sabry A F"]
+  s.date = "2015-02-11"
+  s.description = "hetch is a GUI application to search a comma-separated text file and fetch data based on Regex search pattern. The Gui is based on simplified Tcl/Tk command statements"
+  s.email = "sabryabdelfattah@gmail.com"
+  s.extra_rdoc_files = ["README.md"]
+  s.files = ["hetch.gemspec", "hetch_tk.rb", "README.md", "test.txt", "lib/gui.rb", "lib/guide.rb", "lib/hetch.rb"]
+  s.homepage = "http://sabryfattah.com"
+  s.rdoc_options = ["--main", "README.md"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.29"
+  s.summary = "tk-based Gui App. to search for Regex match in text file"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/hetch_tk.rb

@@ -0,0 +1,23 @@
+require  'lib/gui'
+require  'lib/hetch'
+#_________________________________________________________________
+#Main Script to build a GUI for "hetch.rb"
+# user enter the name of the file without extension and Regex matching pattern to fetch
+# The statements here are based on "gui.rb" which simplify "tcl/tk" commands
+#The script require both "gui.rb" and "hetch.rb"
+# For instruction on usage of "gui.rb" click on help on the menubar
+Gui.root
+Gui.menu
+Gui.label("File Name", 0, 0)
+Gui.entry($var1, 0, 1)
+Gui.label("Regex pattern", 1, 0)
+Gui.entry($var2, 1, 1)
+#Gui.label("Result", 3, 0)
+Gui.textfield(35, 8, "black", "white", 2, 2)
+Gui.button("Search", "m" , 6, 0) 
+def m
+z =  H.fetch("#{$var1}.txt", $var2)
+$textfield.delete('1.0','end')
+$textfield.insert('end', "#{z}")
+end
+Gui.show

data/lib/gui.rb

@@ -0,0 +1,107 @@
+require 'tk'
+require_relative 'guide'
+#A class which uses tcl/tk to build a GUI for user interaction
+#_______________________________________________
+class Gui
+#we start by building a Toplevel Help window which is used by a menu as a Help guide
+def self.help_win
+$win = TkToplevel.new{title "Help Window"}
+$scrollbar = TkScrollbar.new($win){command proc{|*args| $textwin.yview(*args)}
+}.pack('side' => 'right', 'fill' => 'y')
+$textwin =TkText.new($win){
+  borderwidth 5
+  wrap 'word'
+  font TkFont.new('times 16 bold')
+  background  "yellow"
+  pack('side' => 'right')
+}
+$guide = Guide.view
+$textwin.insert(1.0, "#{$guide}")
+$textwin.yscrollcommand(proc{|first, last| $scrollbar.set(first, last)})
+end
+#_______________________________________________________
+#method to build the root main window
+def self.root
+TkRoot.new{
+title "GUI"
+}
+end
+#_______________________________________________________
+#method to draw a label with text (tx1) and coordinates x,y in a grid
+def self.label(tx1, x, y)
+  TkLabel.new(root){
+    text tx1
+    grid('row' => x, 'column' => y, 'padx' => 10, 'pady' => 15)}
+end
+#________________________________________________________
+#method to draw a button with text (tx2), triggering method (m) and coordinates x,y
+def self.button(tx2, m,  x, y)
+   TkButton.new(root){
+   text tx2
+   command(m)
+   grid('row' => x, 'column' => y, 'padx' => 10, 'pady' => 15)}
+end
+#__________________________________________________________
+#global variables declared for use in the class method
+$var1 = TkVariable.new
+$var2 = TkVariable.new
+$var3 = TkVariable.new
+#________________________________________________________
+#method to draw an entry field sending value to variable (var)[ use $var1 to $var3]
+def self.entry(var, x, y)
+  TkEntry.new(root){
+    textvariable var
+   grid('row' => x, 'column' => y, 'padx' => 10, 'pady' => 15)}
+end
+#_____________________________________________________________
+#method to draw a textfield with specific width (w), height (h), background color (bg)
+#and foreground color (fg), and coordinates x, y, with vertical scrollbar
+def self.textfield(w, h, bg, fg, x, y)
+  $textfield = TkText.new(root){
+    width w
+    height h
+    background bg
+    foreground  fg
+    font TkFont.new('times 16 bold')
+    grid('rowspan' => x, 'columnspan' => y, 'padx' => 10, 'pady' => 15)
+	}
+end
+#___________________________________________________________
+#method to insert result of the method into the textfield widget
+def self.insert_text(content)
+$textfield.delete(1.0, 'end')
+$textfield.insert('end', content)
+end
+	
+#____________________________________________________________	
+#The Scrollbar to use with textfield widget
+def scroll
+$scroll = TkScrollbar.new{command proc{|*args|
+    $textfield.yview(*args)
+	$textfield.yscrollcommand(proc {|first, last| $scroll.set(first, last)})
+    pack('side' => 'right', 'fill' => 'y')}
+	}
+end
+#______________________________________________________________
+# menu to display at the root window menubar
+def self.menu
+TkOption.add '*tearOff', 0
+menu = TkMenu.new(root)
+menu.add('command',
+              'label'   => "Help",
+              'command' => proc{help_win},
+              'underline' => 3)
+menu_bar = TkMenu.new
+menu_bar.add('cascade',
+             'menu' => menu,
+             'label' => "Help")
+root.menu(menu_bar)
+end
+#____________________________________________________________
+#The final and essential step, to run the mainloop for GUI to display
+def self.show
+Tk.mainloop
+end
+
+end
+#__________________________________________________________

data/lib/guide.rb

@@ -0,0 +1,41 @@
+#here document to use in Help Window accessed through the menu
+class Guide
+#__________________________________________________________
+def self.view
+return $guide
+end
+#__________________________________________________________
+$guide = %q{
+USAGE:
+x, y are the row number (x) and column number (y) in grid geometry
+1. Gui.root: no options 
+2. Gui.entry($var1, x, y) : variable that contains entry
+    Gui.entry($var1, x, y) : variable that contains entry
+3. Gui.textfield(h, w, c1, c2, x, y) : h=height, w=width, c1=background, c2=foreground
+4. Gui.button(tx1, m, x, y) : tx1= text on button, m= method triggered by button.
+Method should be written in the active script. e.g.
+    def m 
+      z = $var1+ $var2 
+      $textfield.delete(1.0, 'end') 
+      $textfield.insert(1.0, '#{z}')
+    end
+5. Gui.label(tx2, x, y): tx2 = text on label
+6. Gui.show :Tk.mainloop
+#______________EXAMPLE___________________
+require_relative 'gui'
+Gui.root
+Gui.menu
+Gui.label("Enter Number", 0, 0)
+Gui.entry($var1, 0, 1)
+Gui.label("Enter Number", 1, 0)
+Gui.entry($var2, 1, 1)
+Gui.textfield(15, 1, "black", "white", 2, 1)
+Gui.button("OK", "m" , 2, 0) 
+def m
+$z = $var1 + $var2
+$textfield.insert('end', "#$z")
+end 
+Gui.show
+}
+#________________________________________________________
+end

data/lib/hetch.rb

@@ -0,0 +1,14 @@
+#A class to search a text file and fetch a string matching a Regex pattern
+# user provides the name of the file without extension and the Regex matching pattern
+class H
+
+def self.fetch(file, match)
+h = Hash[File.read("#{file}").split("\n").map{|i| i.split(', ')}]
+m = h.keys
+key = m.grep(/#{match}/)
+arr = []
+key.each{|a|   arr.push(a," \n ", h.fetch(a), " \n")}
+return arr.join("")
+end
+
+end

data/test.txt

@@ -0,0 +1,17 @@
+James Benton,70116/504-621-8927/504-845 1427
+Josephine Jeffrey, 48116/810-292-9388/810-374-9840
+Art James, 8014/856-636-8749/856-264
+Lenna Johnston, 907-385-4412/907-921-2010
+Donette Foller, 513-570-1893/513-549-4561
+Simona Morasca, 44805/419-503-2484/419-800-6759
+Mitsue Tollner, 60632/773-573-6914/773-924-8565
+Leota Dilliard, 408-752-3500/408-813-
+Sage Wieser, 57105/605-414-2147/605-794-
+Kris Marrier, 21224/410-655-8723/410-804-4694
+Minna Amigon, 19443/215-874-1229/215-422-8694
+Abel Maclead, 11953/631-335-3414/631-677-3675
+Kiley Caldarera, 310-498-5651/310-254-3084
+Graciela Ruta, 44023/440-780-8425/440-579-
+Cammy Albares, 78045/956-537-6195/956-841-7216
+Mattie Poquette, 85013/602-277-4385/602-953-6360
+Meaghan Garufi, 37110/931-313-9635/931-235-7959

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: hetch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Sabry A F
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-11 00:00:00.000000000 Z
+dependencies: []
+description: hetch is a GUI application to search a comma-separated text file and
+  fetch data based on Regex search pattern. The Gui is based on simplified Tcl/Tk
+  command statements
+email: sabryabdelfattah@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- hetch.gemspec
+- hetch_tk.rb
+- README.md
+- test.txt
+- lib/gui.rb
+- lib/guide.rb
+- lib/hetch.rb
+homepage: http://sabryfattah.com
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.29
+signing_key: 
+specification_version: 3
+summary: tk-based Gui App. to search for Regex match in text file
+test_files: []