mittens_ui 0.0.7 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9fd554ceb6ba103cc474483896a9871db34a417a01e761b9c0befe7c43205cb1
-  data.tar.gz: 25ced2c5db0c26e27a9b29e85d635a2a8ef558da35cfe5ee690debd2a47eaa96
+  metadata.gz: 391008eacae8c2d65697cf656f208d4103fd4f92718c229d84b6a66da4daa2c6
+  data.tar.gz: 63d8e5a6721751bb98e18243aec0c456e4ba646451bf0817533df3eb63637779
 SHA512:
-  metadata.gz: 368761abc4d2b0a1170c52b6a2941a700913b263ef6c0be43ceca4c20e2b3d5714620e8eb805fb12eed09a78a0c742debe00ee288dfdbbee33d2b1baa1ada3a3
-  data.tar.gz: 0db136bdea5ca1a8126d828c93d2e5cc16e5c1daadd4e45edcd69f6208650eb776c91867cbeb5feac3c42eedef395f952a03743b484283a31fc8a8a6bb0612cf
+  metadata.gz: e56732b0ce5a8641eaac122aeaeaa55cf09d4e386681f7d3ca9704e1926472d5d7006d62354a0a32086d9d4a4caeae3a1b6f207944a5ad33f0c89ac0875ce58e
+  data.tar.gz: 11d93d50cc7132f6c768c8cb8b7bebf64f9c833fa8251d51c0084b668fff2289c1e78ac178eae0375ab2f294359836a32ccd996c67043bfbc692419ac4b8c8d5

data/.gitignore

@@ -15,3 +15,5 @@ mkmf.log
 
 # rspec failure tracking
 .rspec_status
+
+./releases

data/.ruby-version

@@ -0,0 +1 @@
+3.0.0

data/Gemfile

@@ -1,9 +1,11 @@
 source "https://rubygems.org"
 
+ruby "3.0.2"
+
 # Specify your gem's dependencies in mittens_ui.gemspec
 gemspec
 
 gem "rake", "~> 12.0"
 gem "rake-compiler"
 gem "rspec", "~> 3.0"
-gem "gtk3"
+gem "gtk3"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mittens_ui (0.0.6)
+    mittens_ui (0.0.10)
       gtk3
 
 GEM
@@ -67,5 +67,8 @@ DEPENDENCIES
   rake-compiler
   rspec (~> 3.0)
 
+RUBY VERSION
+   ruby 3.0.2p107
+
 BUNDLED WITH
-   2.2.3
+   2.2.22

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Zach Tuttle
+
+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

@@ -4,6 +4,8 @@ This is a small vertical stacking GUI toolkit inspired by Ruby Shoes and built o
 around GTK. The goal of this project is make creating GUIs in Ruby dead simple 
 without the UI framework/library getting your way.
 
+![alt_text](https://github.com/tuttza/mittens_ui/blob/51e84d7c50282e3f2c856aa9e65fe3ed28b117ff/lib/mittens_ui/assets/mittens_ui_preview.gif "MittensUi Preview")
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -23,45 +25,100 @@ Or install it yourself as:
 ## Usage
 
 ```ruby
-require '../lib/mittens_ui'
+require 'mittens_ui'
 
 app_options = {
-  name: "say_hello",
-  title: "Say Hello!",
-  height: 450,
-  width: 350,
+  name: "contacts",
+  title: "Contacts",
+  height: 615,
+  width: 570,
   can_resize: true
 }.freeze
 
+
 MittensUi::Application.Window(app_options) do
-  MittensUi::Label("Enter Name:", top: 30)
+  file_menus = { "File": { sub_menus: ["Exit"] } }.freeze
+  
+  fm = MittensUi::FileMenu.new(file_menus).render
 
-  text_box = MittensUi::Textbox(can_edit: true)
+  add_contact_button    = MittensUi::Button.new(title: "Add", icon: :add_green)
+  remove_contact_button = MittensUi::Button.new(title: "Remove", icon: :remove_red)
 
-  listbox_options = {
-    top: 10, 
-    items: ["item_1", "item_2", "item_3"]
-  }.freeze
+  buttons = [ add_contact_button, remove_contact_button ]
 
-  listbox = MittensUi::ListBox(listbox_options)
+  MittensUi::HeaderBar.new(buttons.map(&:render), title: "Contacts", position: :left).render
 
-  btn = MittensUi::Button(title: "Click Here")
-  btn.click {|_b| MittensUi::Alert("Hello #{text_box.text} AND! #{listbox.selected_value} was selected.") }
+  table_view_options = {
+    headers: ["Name", "Address", "Phone #"],
+    data: [ 
+      [ "John Appleseed", "123 abc st.", "111-555-3333"],
+      [ "Jane Doe", "122 abc st.", "111-555-4444" ],
+      [ "Bobby Jones", "434 bfef ave.", "442-333-1342"],
+      [ "Sara Akigawa", "777 tyo ave.", "932-333-1325"],
+     ],
+     top: 20
+  }
+  
+  contacts_table = MittensUi::TableView.new(table_view_options).render
 
-  s = MittensUi::Slider({ start_value: 1, stop_value: 100, initial_value: 30 })
-  s.slide { |s| puts s.value }
+  # FORM
+  MittensUi::Label.new("Add Contact", top: 30).render
+
+  name_tb = MittensUi::Textbox.new(can_edit: true, placeholder: "Name...")
+  addr_tb = MittensUi::Textbox.new(can_edit: true, placeholder: "Address...")
+  phne_tb = MittensUi::Textbox.new(can_edit: true, placeholder: "Phone #...")
+
+  tb_list = [name_tb, addr_tb, phne_tb].map(&:render).freeze
+
+  MittensUi::HBox.new(tb_list, spacing: 10).render
+
+  # ACTONS
+  add_contact_button.click do |_b| 
+    if tb_list.map { |tb| tb.text.length > 0 }.all?
+      contacts_table.add(tb_list.map {|tb| tb.text })
+      tb_list.map {|tb| tb.clear }
+    end
+  end
+
+  remove_contact_button.click do |btn| 
+    removed = contacts_table.remove_selected 
+
+    if removed.size > 0
+      MittensUi::Notify.new("#{removed[0]} was removed.", type: :info).render
+    end
+  end
+
+  contacts_table.row_clicked do |data|
+    msg = <<~MSG
+      Contact Info:
+
+      Name:        #{data[0]}
+      Address:     #{data[1]}
+      Phone #:     #{data[2]}
+    MSG
+
+    MittensUi::Alert.new(msg).render
+  end
+
+  fm.exit do |fm|
+    MittensUi::Application.exit { print "Exiting App!"}
+  end
 
-  switch = MittensUi::Switch(left: 120 )
-  switch.on { puts switch.status }
-end
 end
 ```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Simply fork and clone this repo to your machine, cd into it and run `bundle install`.
+
+This does require GTK ruby gem which requires `gtk` native dependencies to be complied and installed on your system.
+
+#### Fedora
+Using dnf:
+* `$ sudo dnf install ruby ruby-devel cairo cairo-devel gtk3-devel`
 
-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).
+#### Ubuntu
+* `sudo apt install build-essential git sqlite3 libsqlite3-dev lib-gtk-3 libcairo2-dev`
 
 ## Contributing
 

data/examples/app.rb

@@ -1,20 +1,26 @@
 require '../lib/mittens_ui'
 
 app_options = {
-  name: "say_hello",
-  title: "Say Hello!",
-  height: 450,
-  width: 350,
+  name: "hello_world",
+  title: "Hello World App!",
+  height: 650,
+  width: 550,
   can_resize: true
 }.freeze
 
 MittensUi::Application.Window(app_options) do
+
+  MittensUi::HeaderBar([
+    MittensUi::Button(title: "headerbar button"),
+    MittensUi::CheckBox(label: "Checkbox")
+  ], title: "Demo App", position: :left) {}
+
   MittensUi::Label("Enter Name:", top: 30)
 
   text_box = MittensUi::Textbox(can_edit: true)
 
   listbox_options = {
-    top: 10, 
+    top: 10,
     items: ["item_1", "item_2", "item_3"]
   }.freeze
 
@@ -26,6 +32,93 @@ MittensUi::Application.Window(app_options) do
   s = MittensUi::Slider({ start_value: 1, stop_value: 100, initial_value: 30 })
   s.slide { |s| puts s.value }
 
-  switch = MittensUi::Switch(left: 120 )
-  switch.on { puts switch.status }
-end
+  img_opts = {
+    tooltip_text: "The Gnome LOGO!",
+    width: 200,
+    height: 200,
+    left: 20
+  }.freeze
+
+  img = MittensUi::Image("./assets/gnome_logo.png", img_opts)
+
+  img2 = MittensUi::Image("./assets/mittens_ui_preview.gif", img_opts)
+
+  switch = MittensUi::Switch(left: 220 )
+
+  img.click do
+    unless switch.hidden?
+      switch.show
+    else
+      switch.hide
+    end
+  end
+
+  switch.on do
+    unless img.hidden?
+      img.show
+    else
+      img.hide
+    end 
+  end
+
+  cb = MittensUi::CheckBox(label: "Enable")
+  cb.value = "Some Value"
+  cb.toggle { puts "checkbox was toggled! associated value: #{cb.value}" }
+
+  link = MittensUi::WebLink("YouTube", "https://www.youtube.com", left: 200)
+
+  MittensUi::Label("Contact Info (use delimiter: ',')", top: 30)
+  contact_tb = MittensUi::Textbox(can_edit: true)
+
+  table_view_options = {
+    headers: ["Name", "Address", "Phone #"],
+    data: [ 
+      [ "John Appleseed", "123 abc st.", "111-555-3333"],
+      [ "Jane Doe", "122 abc st.", "111-555-4444" ],
+      [ "Bobby Jones", "434 bfef ave.", "442-333-1342"],
+     ],
+  }
+  
+  table = MittensUi::TableView(table_view_options)
+  table.add(["Sara Akigawa", "777 tyo ave.", "932-333-1325"], :prepend)
+
+  add_ct = MittensUi::Button(title: "Add Contact")
+  add_ct.click {|_b|  table.add(contact_tb.text.split(",")); contact_tb.clear; puts "Row Count: #{table.row_count}" }
+
+  table.row_clicked { |row| puts row.inspect }
+
+  remove_ct = MittensUi::Button(title: "Remove Contact")
+  remove_ct.click { |btn| table.remove_selected }
+
+  MittensUi::Shutdown() do 
+    puts "quitting...."
+  end
+
+  open_file_picker = MittensUi::Button(title: "Choose File")
+
+  open_file_picker.click do
+    picked_file_path = MittensUi::FilePicker()
+    puts picked_file_path.inspect
+    open_file_picker.remove
+  end
+
+  start_loader = MittensUi::Button(title: "Start Loader")
+
+  loader = MittensUi::Loader()
+
+  start_loader.click do
+    loader.start {
+      puts "Doing some work..."
+      num = 0
+      100.times do 
+        num += 1
+        puts num
+        sleep 0.2
+      end
+
+      start_loader.remove
+    }
+  end
+
+end
+

data/examples/contacts.rb

@@ -0,0 +1,80 @@
+require '../lib/mittens_ui'
+
+app_options = {
+  name: "contacts",
+  title: "Contacts",
+  height: 615,
+  width: 570,
+  can_resize: true
+}.freeze
+
+
+MittensUi::Application.Window(app_options) do
+  file_menus = { "File": { sub_menus: ["Exit"] } }.freeze
+  
+  fm = MittensUi::FileMenu.new(file_menus).render
+
+  add_contact_button    = MittensUi::Button.new(title: "Add", icon: :add_green)
+  remove_contact_button = MittensUi::Button.new(title: "Remove", icon: :remove_red)
+
+  buttons = [ add_contact_button, remove_contact_button ]
+
+  MittensUi::HeaderBar.new(buttons.map(&:render), title: "Contacts", position: :left).render
+
+  table_view_options = {
+    headers: ["Name", "Address", "Phone #"],
+    data: [ 
+      [ "John Appleseed", "123 abc st.", "111-555-3333"],
+      [ "Jane Doe", "122 abc st.", "111-555-4444" ],
+      [ "Bobby Jones", "434 bfef ave.", "442-333-1342"],
+      [ "Sara Akigawa", "777 tyo ave.", "932-333-1325"],
+     ],
+     top: 20
+  }
+  
+  contacts_table = MittensUi::TableView.new(table_view_options).render
+
+  # FORM
+  MittensUi::Label.new("Add Contact", top: 30).render
+
+  name_tb = MittensUi::Textbox.new(can_edit: true, placeholder: "Name...")
+  addr_tb = MittensUi::Textbox.new(can_edit: true, placeholder: "Address...")
+  phne_tb = MittensUi::Textbox.new(can_edit: true, placeholder: "Phone #...")
+
+  tb_list = [name_tb, addr_tb, phne_tb].map(&:render).freeze
+
+  MittensUi::HBox.new(tb_list, spacing: 10).render
+
+  # ACTONS
+  add_contact_button.click do |_b| 
+    if tb_list.map { |tb| tb.text.length > 0 }.all?
+      contacts_table.add(tb_list.map {|tb| tb.text })
+      tb_list.map {|tb| tb.clear }
+    end
+  end
+
+  remove_contact_button.click do |btn| 
+    removed = contacts_table.remove_selected 
+
+    if removed.size > 0
+      MittensUi::Notify.new("#{removed[0]} was removed.", type: :info).render
+    end
+  end
+
+  contacts_table.row_clicked do |data|
+    msg = <<~MSG
+      Contact Info:
+
+      Name:        #{data[0]}
+      Address:     #{data[1]}
+      Phone #:     #{data[2]}
+    MSG
+
+    MittensUi::Alert.new(msg).render
+  end
+
+  fm.exit do |fm|
+    MittensUi::Application.exit { print "Exiting App!"}
+  end
+
+end

data/examples/file_menu_example.rb

@@ -0,0 +1,52 @@
+require '../lib/mittens_ui'
+
+app_options = {
+  name: "file_menu_example",
+  title: "File Menu",
+  height: 615,
+  width: 570,
+  can_resize: true
+}.freeze
+
+
+MittensUi::Application.Window(app_options) do
+  menu_items = {
+    "File": {
+      sub_menus: ["Hello", "One", "Quit"]
+    },
+
+    "Edit": {
+      sub_menus: ["World", "Two", "options with space"]
+    },
+
+ "Settings": {
+      sub_menus: [
+        { "App Update" => ["Upgrade", "Downgrade"] }
+      ]
+    }
+
+  }.freeze
+
+  file_menu = MittensUi::FileMenu.new(menu_items)
+  file_menu.render
+
+ puts file_menu.methods.sort.inspect
+
+  file_menu.hello do |_fm|
+    MittensUi::Alert.new("HELLO!").render
+  end
+
+  file_menu.one do |_fm|
+    puts "You clicked one!"
+  end
+
+  file_menu.world do |_fm|
+    MittensUi::Alert.new("WORLD!").render
+  end
+
+  file_menu.quit do |_fm|
+    MittensUi::Application.exit do 
+      puts "quitting!"
+    end
+  end
+end