mittens_ui 0.0.6 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4f5d25f3b7c96a792bc79fcaacc9fd9b564cd42bd25b0eb019ee890cf8e7645
-  data.tar.gz: 3d498df47afc937af7cb7995c7789703189e9a32b05548bd8617c6894fffd802
+  metadata.gz: bb39340bda7c9c473ade8a1cfa92300cd87f6fdd29e96431507b0fc21133a6a7
+  data.tar.gz: 3ed7082dfca8a2475e6d86bae2bb36e5740464044bc6d67ce140b3de00eb4d8c
 SHA512:
-  metadata.gz: b12928f2e7228a6d8c871ba3a8c3ba952db166695a05d71408f527ce59b7a84769015a6033c6b92ab04afc4a3f82316e9567fba0190a197c65c52202f8249266
-  data.tar.gz: 967a5b3b12549407e0afd26a31dafae1498b5a345e4b664f17162ef169c73847d9a449bcbe38e5ce577693f8d9f526504565fe42481887d4419f6b1a7fcae433
+  metadata.gz: 5a47bf32490fb765cb9084bdb6aea8ca5fba19b572d81cc321c1cd56e13c45cc317f39f99bf63834a867f513817a02000e5819379501f0a3a36334f02d458aeb
+  data.tar.gz: 54149cd2b1f4d2d3d45ea434e244a746de45226bea12597d6166f31ae2b127208ad848d630d859297ecf70a32fac568fbfd356d8d1eb8776609550c96547dc32

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.5)
+    mittens_ui (0.0.9)
       gtk3
 
 GEM
@@ -67,5 +67,8 @@ DEPENDENCIES
   rake-compiler
   rspec (~> 3.0)
 
+RUBY VERSION
+   ruby 3.0.2p107
+
 BUNDLED WITH
-   2.1.4
+   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:
@@ -26,38 +28,101 @@ Or install it yourself as:
 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
+
+
+require '../lib/mittens_ui'
+
+app_options = {
+  name: "contacts",
+  title: "Contacts",
+  height: 615,
+  width: 570,
   can_resize: true
 }.freeze
 
+
 MittensUi::Application.Window(app_options) do
-  MittensUi::Label("Enter Name:", top: 30)
+  add_contact_button    = MittensUi::Button.new(title: "Add")
+  remove_contact_button = MittensUi::Button.new(title: "Remove")
+
+  buttons = [ add_contact_button, remove_contact_button ]
+
+  MittensUi::HeaderBar.new(buttons.map(&:render), title: "Contacts", position: :left).render
 
-  text_box = 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"],
+      [ "Sara Akigawa", "777 tyo ave.", "932-333-1325"],
+     ],
+     top: 20
+  }
+  
+  contacts_table = MittensUi::TableView.new(table_view_options).render
 
-  listbox_options = {
-    top: 10, 
-    items: ["item_1", "item_2", "item_3"]
-  }.freeze
+  # FORM
+  MittensUi::Label.new("Add Contact", top: 30).render
 
-  listbox = MittensUi::ListBox(listbox_options)
+  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 #...")
 
-  btn = MittensUi::Button(title: "Click Here")
-  btn.click {|_b| MittensUi::Alert("Hello #{text_box.text} AND! #{listbox.selected_value} was selected.") }
+  tb_list = [name_tb, addr_tb, phne_tb].map(&:render).freeze
 
-  s = MittensUi::Slider({ start_value: 1, stop_value: 100, initial_value: 30 })
-  s.slide { |s| puts s.value }
+  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::Alert.new("#{removed[0]} was removed.").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
 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
 
@@ -25,4 +31,94 @@ MittensUi::Application.Window(app_options) do
 
   s = MittensUi::Slider({ start_value: 1, stop_value: 100, initial_value: 30 })
   s.slide { |s| puts s.value }
-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,75 @@
+require '../lib/mittens_ui'
+
+app_options = {
+  name: "contacts",
+  title: "Contacts",
+  height: 615,
+  width: 570,
+  can_resize: true
+}.freeze
+
+
+MittensUi::Application.Window(app_options) do
+  add_contact_button    = MittensUi::Button.new(title: "Add")
+  remove_contact_button = MittensUi::Button.new(title: "Remove")
+
+  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
+
+  fp = MittensUi::FilePicker.new
+
+  # 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 }
+        puts "#{fp.render.path}"
+    end
+  end
+
+  remove_contact_button.click do |btn| 
+    removed = contacts_table.remove_selected 
+
+    if removed.size > 0
+      MittensUi::Alert.new("#{removed[0]} was removed.").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
+end

data/lib/mittens_ui.rb

@@ -1,69 +1,60 @@
 require "mittens_ui/version"
-require "mittens_ui/widgets/alert"
-require "mittens_ui/widgets/label"
-require "mittens_ui/widgets/button"
-require "mittens_ui/widgets/textbox"
-require "mittens_ui/widgets/listbox"
-require "mittens_ui/widgets/slider"
+require "mittens_ui/alert"
+require "mittens_ui/label"
+require "mittens_ui/button"
+require "mittens_ui/textbox"
+require "mittens_ui/listbox"
+require "mittens_ui/slider"
+require "mittens_ui/switch"
+require "mittens_ui/image"
+require "mittens_ui/checkbox"
+require "mittens_ui/web_link"
+require "mittens_ui/table_view"
+require "mittens_ui/loader"
+require "mittens_ui/header_bar"
+require "mittens_ui/file_picker"
+require "mittens_ui/hbox"
 
 require "gtk3"
 
 module MittensUi
-
   class Error < StandardError; end
 
-  def self.Slider(options = {})
-    MittensUi::Widgets::Slider.new(options)
-  end
-
-  def self.ListBox(options = {})
-    MittensUi::Widgets::ListBox.new(options)
-  end
-
-  def self.Alert(message, options = {})
-    MittensUi::Widgets::Alert.new(message, options)
-  end
-
-  def self.Label(text, options = {})
-    MittensUi::Widgets::Label.new(text, options)
-  end
-
-  def self.Textbox(options = {})
-    MittensUi::Widgets::Textbox.new(options)
-  end
-
-  def self.Button(options = {})
-    MittensUi::Widgets::Button.new(options)
-  end
-
-  def self.RemoveWidget(widget)
-    widget.remove
+  def self.Shutdown
+    $app_window.signal_connect("delete-event") do |_widget| 
+      yield
+    end
   end
 
   class Application
     class << self
-      def Window(options = {}, &block)  
-        init_gtk_application(options, block)
+      def Window(options = {}, &block)
+        init_gtk_application(options, &block)
       end
-  
-      private 
+
+      private
 
       def set_process_name(name)
-        # Doesn't work in MacOS Activity Monitor or Windows Task Manager. It shows up as "Ruby".
         Process.setproctitle(name)
         $PROGRAM_NAME = name
+        $0 = name
       end
 
-      def init_gtk_application(options, block)
+      def init_gtk_application(options, &block)
         app_name    = options[:name].nil?       ? "mittens_ui_app" : options[:name]
         height      = options[:height].nil?     ? 600 : options[:height]
         width       = options[:width].nil?      ? 400 : options[:width]
         title       = options[:title].nil?      ? "Mittens App" : options[:title]
         can_resize  = options[:can_resize].nil? ? true : options[:can_resize]
 
+        app_assets_path = File.join(File.expand_path(File.dirname(__FILE__)), "mittens_ui", "assets") + "/"
+        default_icon = app_assets_path + "icon.png"
+        
+        app_icon = options[:icon].nil? ? default_icon : options[:icon]
+
         set_process_name(app_name)
 
-        gtk_app_name = "org.gtk.mittens_ui.#{app_name}"
+        gtk_app_name = "org.mittens_ui.#{app_name}"
 
         app = Gtk::Application.new(gtk_app_name, :flags_none)
 
@@ -73,10 +64,11 @@ module MittensUi
           $vertical_box = Gtk::Box.new(:vertical, 10)
           scrolled_window.add($vertical_box)
           $app_window.add(scrolled_window)
-          block.call($app_window, $vertical_box)
+          yield($app_window, $vertical_box)
           $app_window.set_size_request(width, height)
           $app_window.set_title(title)
           $app_window.set_resizable(can_resize)
+          $app_window.set_icon_from_file(app_icon)
           $app_window.show_all
         end
 
@@ -84,23 +76,4 @@ module MittensUi
       end
     end
   end
-
-  class Job
-    attr_reader :name, :status
-
-    def initialize(name)
-      @name = name
-      @status = nil
-    end
-
-    def run(&block)
-      job_t = Thread.new { |_t| yield }
-      set_status(job_t)
-    end
-
-    private 
-    def set_status(thread)
-      @status = thread.status
-    end
-  end
 end