mittens_ui 0.0.4 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 324fbc94f63593ea41d2eb4eec17ff975f2eae84f9e0187eca390f4c8804d157
-  data.tar.gz: 2f0817770780a0f15846fde876e81467f287721dc90eb1916a276cbe4989d972
+  metadata.gz: 9976f7810db4c1f9ed61a4a1f1f639617ee9c84bf117d37e174b14fd54b21dbc
+  data.tar.gz: 0224ed85d93f9366f7f594e19ed74827c72b33c949ea7ce9efc78a230dc44121
 SHA512:
-  metadata.gz: 28e5e9926830ae66529664e40003b681b8fa15db65b4d5a10171b588837fdb0643fce74b7aec786a9a1d73e94ca84ba37cec97250deeffa8e736c0f68d1d58ba
-  data.tar.gz: 728fe8237aa4f4140af931edb405fc1c35ff60419fddda91075358fff8ff8f26788d0b6d6eeacc4e3c5cf13af73a5d5761a79a400f420b5839bb1a64c2b6e865
+  metadata.gz: 68fbe929734690f1a21377b914fc200c54307e5393a98da9324e017b6bc59b3270577e4e09843aad88f49d61f6fd732c25f5e635d0ad2b0536d518898750e40b
+  data.tar.gz: edaecba0f03a65f2c79cab04345434cd8f8539c4a7930480eb6e792e89c90ee969416b7bcd36efba77be11f28210cf08e4a9c1c2d7cb3990cf5ca5940be3db67

data/.ruby-version

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

data/Gemfile

@@ -1,9 +1,11 @@
 source "https://rubygems.org"
 
+ruby "3.0.1"
+
 # 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.2)
+    mittens_ui (0.0.9)
       gtk3
 
 GEM
@@ -67,5 +67,8 @@ DEPENDENCIES
   rake-compiler
   rspec (~> 3.0)
 
+RUBY VERSION
+   ruby 3.0.1p64
+
 BUNDLED WITH
-   2.1.4
+   2.2.15

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

@@ -26,43 +26,99 @@ Or install it yourself as:
 require "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 |window, layout|
-  label_opts = { top: 30 }
-  MittensUi::Label("Enter Name:", layout, label_opts)
+MittensUi::Application.Window(app_options) do
+  MittensUi::Label("Enter Name:", top: 30)
 
-  textbox_options = { can_edit: true }
-  text_box = MittensUi::Textbox(layout, textbox_options)
+  text_box = MittensUi::Textbox(can_edit: true)
 
   listbox_options = {
     top: 10,
     items: ["item_1", "item_2", "item_3"]
   }.freeze
-  listbox = MittensUi::ListBox(layout, listbox_options)
 
-  btn1_options = { title: "Click Here" }
-  MittensUi::Button(layout, btn1_options) do
-    MittensUi::Alert(window, "Hello #{text_box.text}!")
+  listbox = MittensUi::ListBox(listbox_options)
+
+  btn = MittensUi::Button(title: "Click Here")
+  btn.click {|_b| MittensUi::Alert("Hello #{text_box.text} AND! #{listbox.selected_value} was selected.") }
+
+  s = MittensUi::Slider({ start_value: 1, stop_value: 100, initial_value: 30 })
+  s.slide { |s| puts s.value }
+
+  img_opts = {
+    tooltip_text: "The Gnome LOGO!",
+    width: 200,
+    height: 200,
+    left: 50
+  }.freeze
+
+  img = MittensUi::Image("./assets/gnome_logo.png", img_opts)
+
+  switch = MittensUi::Switch(left: 120 )
+
+  img.click do
+    unless switch.hidden?
+      switch.show
+    else
+      switch.hide
+    end
   end
 
-  slider_opts = { start_value: 1, stop_value: 100 }
-  MittensUi::Slider(layout, slider_opts) do |s|
-    puts "value changed: #{s.value}"
+  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)
+  
+  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)
+  
+  remove_ct = MittensUi::Button(title: "Remove Contact")
+  remove_ct.click { |btn| table.remove_selected }
+  
 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`
+
+#### MacOS
 
-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).
+Using Brew:
+* `$ brew install gtk+3`
+* `$ brew install cairo`
 
 ## Contributing
 

data/examples/app.rb

@@ -1,33 +1,116 @@
 require '../lib/mittens_ui'
 
 app_options = {
-  name: "say_hello",
-  title: "Say Hello!",
-  height: 450,
-  width: 350,
-  can_resize: true
+  name: "hello_world",
+  title: "Hello World App!",
+  height: 650,
+  width: 550,
+  can_resize: false
 }.freeze
 
-MittensUi::Application.Window(app_options) do |window, layout|
-  label_opts = { top: 30 }
-  MittensUi::Label("Enter Name:", layout, label_opts)
+MittensUi::Application.Window(app_options) do
+  MittensUi::Label("Enter Name:", top: 30)
 
-  textbox_options = { can_edit: true }
-  text_box = MittensUi::Textbox(layout, textbox_options)
+  text_box = MittensUi::Textbox(can_edit: true)
 
   listbox_options = {
     top: 10,
     items: ["item_1", "item_2", "item_3"]
   }.freeze
-  listbox = MittensUi::ListBox(layout, listbox_options)
 
-  btn1_options = { title: "Click Here" }
-  MittensUi::Button(layout, btn1_options) do
-    MittensUi::Alert(window, "Hello #{text_box.text}!")
+  listbox = MittensUi::ListBox(listbox_options)
+
+  btn = MittensUi::Button(title: "Click Here")
+  btn.click {|_b| MittensUi::Alert("Hello #{text_box.text} AND! #{listbox.selected_value} was selected.") }
+
+  s = MittensUi::Slider({ start_value: 1, stop_value: 100, initial_value: 30 })
+  s.slide { |s| puts s.value }
+
+  img_opts = {
+    tooltip_text: "The Gnome LOGO!",
+    width: 200,
+    height: 200,
+    left: 20
+  }.freeze
+
+  img = MittensUi::Image("./assets/gnome_logo.png", 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
 
-  slider_opts = { start_value: 1, stop_value: 100, initial_value: 30 }
-  MittensUi::Slider(layout, slider_opts) do |s|
-    puts "value changed: #{s.value}"
+  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
-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/brightness_controller.rb

@@ -0,0 +1,64 @@
+#! /usr/bin/ruby
+
+require 'mittens_ui'
+
+app_options = {
+  name: "brightness_controller",
+  title: "Brightness Controller",
+  height: 350,
+  width: 350,
+  can_resize: true
+}.freeze
+
+class Brightness
+  attr_accessor :max_value, :current_value
+
+  def initialize
+    # Only works for on-board Intel based graphics.
+    @current_path = "/sys/class/backlight/intel_backlight/brightness"
+    @current_value = get_current
+    @max_path = "/sys/class/backlight/intel_backlight/max_brightness"
+    @max_value = get_max
+  end
+
+  def set(value)
+    File.write(@current_path, value)
+  end
+
+  def is_root?
+    case Process.uid
+    when 0 then true
+    else false
+    end
+  end
+
+  private
+
+  def get_max
+    File.open(@max_path, "r") { |f| f.read }.strip
+  end
+
+  def get_current
+    File.open(@current_path, "r") { |f| f.read }.strip
+  end
+end
+
+MittensUi::Application.Window(app_options) do
+  brightness = Brightness.new
+  
+  unless brightness.is_root?
+    MittensUi::Alert(window, "To change your screen brightness level you must run this App as root.")
+    window
+  end
+
+  MittensUi::Label("Current Brightness Level:", top: 25)
+
+  slider_opts = { 
+    start_value: 1, 
+    stop_value: brightness.max_value, 
+    initial_value: brightness.current_value
+  }.freeze
+
+  brightness_slider = MittensUi::Slider(layout, slider_opts)
+  brightness.set(brightness_slider.value.to_i.to_s)
+end

data/lib/mittens_ui.rb

@@ -5,83 +5,94 @@ require "mittens_ui/widgets/button"
 require "mittens_ui/widgets/textbox"
 require "mittens_ui/widgets/listbox"
 require "mittens_ui/widgets/slider"
+require "mittens_ui/widgets/switch"
+require "mittens_ui/widgets/image"
+require "mittens_ui/widgets/checkbox"
+require "mittens_ui/widgets/web_link"
+require "mittens_ui/widgets/table_view"
+require "mittens_ui/widgets/loader"
+
+require "mittens_ui/dialogs/file_dialog"
 
 require "gtk3"
 
 module MittensUi
   class Error < StandardError; end
 
-  def self.Slider(layout, options = {}, &block)
-    raise Error.new("Slider must be passed a block.") unless block_given?
-    slider = MittensUi::Widgets::Slider.new(layout, options, &block)
-    Application.set_visible_elements(slider)
-    return slider
+  def self.Loader(options={})
+    MittensUi::Widgets::Loader.new(options)
   end
 
-  def self.ListBox(layout, options = {})
-    list_box = MittensUi::Widgets::ListBox.new(layout, options)
-    Application.set_visible_elements(list_box)
-    return list_box
+  def self.FilePicker
+    fp = MittensUi::Dialogs::File.new
+    return fp.path
+  end
+  
+  def self.TableView(options={})
+    MittensUi::Widgets::TableView.new(options)
   end
 
-  def self.Alert(window, message, options = {})
-    alert = MittensUi::Widgets::Alert.new(window, message, options)
-    Application.set_visible_elements(alert)
-    return alert
+  def self.WebLink(url, name, options={})
+    MittensUi::Widgets::WebLink.new(url, name, options)
   end
 
-  def self.Label(text, layout, options = {})
-    label = MittensUi::Widgets::Label.new(text, layout, options)
-    Application.set_visible_elements(label)
-    return label
+  def self.CheckBox(options={})
+    MittensUi::Widgets::Checkbox.new(options)
   end
 
-  def self.Textbox(layout, options = {})
-    textbox = MittensUi::Widgets::Textbox.new(layout, options)
-    Application.set_visible_elements(textbox)
-    return textbox
+  def self.Image(path, options={})
+    MittensUi::Widgets::Image.new(path, options)
   end
 
-  def self.Button(layout, options = {}, &block)
-    raise Error.new("Button must be passed a block.") unless block_given?
-    button = MittensUi::Widgets::Button.new(layout, options, &block)
-    Application.set_visible_elements(button)
-    return button
+  def self.Switch(options = {})
+    MittensUi::Widgets::Switch.new(options)
   end
 
-  def self.HideVisible
-    Application.visible_elements.each(&:remove)
-    Application.reset_visible_elements
+  def self.Slider(options = {})
+    MittensUi::Widgets::Slider.new(options)
   end
 
-  class Application
-    class << self
-      def Window(options = {}, &block)  
-        @@visible_elements = []
-        init_gtk_application(options, block)
-      end
+  def self.ListBox(options = {})
+    MittensUi::Widgets::ListBox.new(options)
+  end
 
-      def set_visible_elements(element)
-        @@visible_elements << element
-      end
+  def self.Alert(message, options = {})
+    MittensUi::Widgets::Alert.new(message, options)
+  end
 
-      def visible_elements
-        @@visible_elements
-      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 reset_visible_elements
-        @@visible_elements = []
+  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)
       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]
@@ -90,44 +101,25 @@ module MittensUi
 
         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)
 
         app.signal_connect("activate") do |application|
-          app_window = Gtk::ApplicationWindow.new(application)
+          $app_window = Gtk::ApplicationWindow.new(application)
           scrolled_window = Gtk::ScrolledWindow.new
-          vertical_box = Gtk::Box.new(:vertical, 10)
-          scrolled_window.add(vertical_box)
-          app_window.add(scrolled_window)
-          block.call(app_window, vertical_box)
-          app_window.set_size_request(width, height)
-          app_window.set_title(title)
-          app_window.set_resizable(can_resize)
-          app_window.show_all
+          $vertical_box = Gtk::Box.new(:vertical, 10)
+          scrolled_window.add($vertical_box)
+          $app_window.add(scrolled_window)
+          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.show_all
         end
 
         app.run
       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