gtk3app 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6f11845611abaa142433e9f894dbc26467421a2d
+  data.tar.gz: 62b121e1f8cd664d6ae8ac22f3bf4f254d80aaf9
+SHA512:
+  metadata.gz: 9f54f47674f0fe13725f37c4aa7ea2c04b5a8a6bb048815f4676bdf7e5ea43b2515763bd8ba10b715630ebccab431192092cc45f03a0ab08709f942d24d0da0d
+  data.tar.gz: 8be430fe3b0aa8d87786253c3fada252767a084904d3a5a318c77202dc5809cccfd13510a901fdbd572cf7edfeed605e716532de5bfc909e1f4678e52103a275

data/README.rdoc

@@ -0,0 +1,81 @@
+= gt3applib
+
+== DESCRIPTION:
+
+_Gtk3App_ provides a _Gtk3_ application stub.
+
+It autmatically provides for command line options parsing, user configuration, and minime windows.
+
+== SYNOPSIS:
+
+Given a module file such as ./my_app.rb, the module is expected to at leat provide MyApp.run(window):
+
+   module MyApp
+     def self.run(window)
+       # develop as you would on a Gtk3::Window object...
+       # ...probably a good idea to show all your work.
+       window.show_all
+     end
+   end
+
+That's enough to get you going.
+The three examples in the ./examples[https://github.com/carlosjhr64/gtk3app/tree/master/examples]
+directory fully explains the rest of what _Gtk3App_ can do for you.
+
+== HELP:
+
+   This is the gtk3app stub.
+   Usage:
+      gtk3app [options] appname ...
+   Options:
+      -h --help      Show this help and exit.
+      -v --version   Show the version and exit.
+      -q --quiet     Set $VERBOSE to nil.
+      -V --verbose   Set $VERBOSE to true.
+      -d --debug     Set $DEBUG to true.
+      appname        The name of the application to be run.
+
+== FEATURES:
+
+* _Such_[https://github.com/carlosjhr64/Such] wrappers.
+* _Rafini_[https://github.com/carlosjhr64/rafini] refinements.
+* _HelpParser_[https://github.com/carlosjhr64/help_parser] command line options parsing.
+* _UserSpace_[https://github.com/carlosjhr64/user_space] XDG support.
+* MiniMe, an alternative to the deprecated Gtk::StatusIcon.
+* Popup Application Menu from window button 3 press event (standard left click on application).
+
+== INSTALL:
+
+  $ sudo gem install gtk3applib
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2014 
+
+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.
+
+== CREDITS
+
+Stuff here I may have taken from:
+
+   http://www.softicons.com/application-icons/ruby-programming-icons-by-ahmad-galal/ruby-gtk-icon
+   http://zetcode.com/gui/rubygtk/

data/bin/gtk3app

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'gtk3app'
+Gtk3App.main

data/data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/gtk3app/config.rb

@@ -0,0 +1,127 @@
+module Gtk3App
+
+  # The gem's root directory
+  APPDIR = File.dirname File.dirname __dir__
+
+  a0 = Rafini::Empty::ARRAY
+  h0 = Rafini::Empty::HASH
+  s0 = Rafini::Empty::STRING
+
+  # CONFIG follows the following conventions:
+  # * Strings and numbers are mixed case.
+  # * Arrays are all upper case (may except for arrays of length 1, see Such).
+  # * Hashes are all lower case.
+  # * Lower case bang! keys have special meaning in Such.
+  # * Note that method keys may have mixed case as the method itself.
+  CONFIG = {
+    # The command line help in standard form.
+    Help: <<HELP,
+
+This is the gtk3app stub.
+
+Usage:
+
+   gtk3app [options] appname ...
+
+Options:
+
+   -h --help      Show this help and exit.
+   -v --version   Show the version and exit.
+   -q --quiet     Set $VERBOSE to nil.
+   -V --verbose   Set $VERBOSE to true.
+   -d --debug     Set $DEBUG to true.
+
+   appname        The name of the application to be run.
+
+HELP
+
+    # The command to open with default application
+    Open: 'gnome-open',
+
+    Slots: 13, # The number of minime slots
+    SlotsDBM: "#{XDG['CACHE']}/gtk3app/slots.sdbm", # slot management database
+    SLOTS_OFFSET: [0,0], # The offset from the bottom right corner
+    SlotsScale: 25, # The size of the slots
+
+    thing: { # The application MAY overwrite some these
+
+      # Main window configuration
+      WINDOW: a0, # Window.new's parameters
+      window: h0, # window settings
+      window!: [:WINDOW,:window],
+
+      # Minime's configuration
+      # Application SHOULD NOT modify these.
+      MINI: a0,
+      mini: {
+        set_decorated: false,
+        minime: a0,
+      },
+      mini!: [:MINI,:mini],
+
+      # Fullscreen app-menu item
+      # Application MAY modify :FS for language
+      FS: ['Full Screen'],
+      fs: h0,
+      fs!: [:FS, :fs, 'activate'],
+
+      # About app-menu item
+      # Application MAY modify :ABOUT for language
+      # Application SHOULD modify :about_dialog
+      ABOUT: ['About'],
+      about: h0,
+      about!: [:ABOUT, :about, 'activate'],
+      about_dialog: {
+        set_program_name: 'Gtk3App',
+        set_version: VERSION,
+        set_copyright: '(c) 2014 CarlosJHR64',
+        set_comments: 'A Gtk3 Application Stub',
+        set_website: 'https://github.com/carlosjhr64/gtk3app',
+        set_website_label: 'See it at GitHub!',
+      },
+      # Application SHOULD modify LOGO to use it's own logo image.
+      Logo: "#{XDG['DATA']}/gtk3app/logo.png",
+      # Application SHOULD modify :HelpFile to their own help page.
+      HelpFile: 'https://github.com/carlosjhr64/gtk3app',
+      # By convention, I'm using mix case for simple String configurations in here thing.
+
+      # Help app-menu item
+      # Application MAY modify :HELP for language
+      HELP: ['Help'],
+      help: h0,
+      help!: [:HELP, :help, 'activate'],
+
+      # Minime's app-menu item.
+      # Application MAY modify :MINIME for language.
+      MINIME: ['Mini-me'],
+      minime: h0,
+      minime!: [:MINIME, :minime, 'activate'],
+
+      # Quit app-menu item.
+      # Application MAY modify :QUIT for language.
+      QUIT: ['Quit'],
+      quit: h0,
+      quit!: [:QUIT, :quit, 'activate'],
+
+      # The app menu configuration.
+      # The application MAY ONLY modify app_menu.append_menu_item
+      # by removing un-wanted app menu items.
+      APP_MENU: a0,
+      app_menu: {
+        append_menu_item: [:fs!, :about!, :help!, :minime!, :quit!],
+      },
+      app_menu!: [:APP_MENU, :app_menu, s0],
+
+      # Minime's app-menu configuration.
+      # The application SHOULD NOT modify
+      # (the application will have the opportunity later to modify
+      # minime's app-menu directly).
+      MINI_MENU: a0,
+      mini_menu: {
+        append_menu_item: [:quit!],
+      },
+      mini_menu!: [:MINI_MENU, :mini_menu, s0],
+
+    },
+  }
+end

data/lib/gtk3app/gtk3app.rb

@@ -0,0 +1,87 @@
+module Gtk3App
+  using Rafini::String
+  using Rafini::Hash
+  using Rafini::Exception
+
+  UserSpace::OPTIONS[:parser] = YAML
+  UserSpace::OPTIONS[:ext]    = 'yml'
+
+  def self.config(mod)
+    # Let's get NameErrors out of the way first
+    appdir  = mod::APPDIR
+    config  = mod::CONFIG
+    version = mod::VERSION
+    # Create the directory name for UserSpace.
+    appname = mod.name.downcase
+    appname.prepend('gtk3app/') unless mod==Gtk3App
+    # UserSpace does its thing...
+    user_space = UserSpace.new(appname: appname, appdir: appdir)
+    user_space.install unless user_space.version == version
+    user_space.configures(config)
+  rescue NameError
+    $!.puts 'Application is not using APPDIR, VERSION, or CONFIG.'
+  end
+
+  def self.options=(h)
+    @@options=h
+  end
+
+  def self.options(mod=nil)
+    if mod
+      version, help = mod::VERSION, mod::CONFIG[:Help]
+      if help
+        # HelpParser enforces -h and -v for help and version respectively.
+        # To that we add -V, -q, and -d for verbose, quiet, and debug respectively.
+        options = HELP_PARSER::HelpParser.new(version, help, {verbose: :V, quiet: :q, debug: :d})
+        $VERBOSE = (options[:q])? nil : (options[:V])? true : false
+        $DEBUG = true if options[:d] # Don't get to turn off debug
+        mod.options = options
+      end
+    else
+      @@options
+    end
+  rescue NoMethodError
+    $!.puts 'Application is not providing options setter.'
+  rescue NameError
+    $!.puts 'Application is not using VERSION or CONFIG.'
+  end
+
+  def self.init(mod=Gtk3App)
+    Gtk3App.config mod
+    Gtk3App.options mod
+    if thing = mod::CONFIG[:thing]
+      Such::Thing.configure thing
+    end
+  rescue NameError
+    $!.puts 'Application is not using CONFIG.'
+  end
+
+  def self.run(appname)
+    require appname
+    app = Object.const_get File.basename(appname, '.rb').camelize
+    Gtk3App.init app
+    Program.new app
+    Gtk.main
+  end
+
+  def self.main
+    begin
+      Gtk3App.init
+      appname = ARGV.shift
+      if appname
+        Gtk3App.run appname
+      else
+        puts CONFIG[:Help]
+      end
+    rescue HELP_PARSER::UsageException
+      puts $!.message
+      exit 0
+    rescue HELP_PARSER::UsageError
+      $stderr.puts $!.message
+      exit 64
+    rescue StandardError
+      $!.puts
+      exit 1
+    end
+  end
+end

data/lib/gtk3app/program.rb

@@ -0,0 +1,73 @@
+module Gtk3App
+  class Program
+    using Rafini::Array
+
+    def initialize(app)
+      Widget::MainWindow.set_icon Such::Thing::PARAMETERS[:Logo]
+
+      @window = Widget::MainWindow.new(:window!, 'delete-event'){quit!}
+
+      @app_menu = Widget::AppMenu.new(@window, :app_menu!) do |w,*_,s|
+        self.method(w.key).call if s=='activate'
+      end
+
+      @fs = false
+
+      @mini_menu = nil
+      if @app_menu.children.which{|item| item.key==:minime!}
+        @mini = Widget::MainWindow.new(:mini, 'delete-event'){quit!}
+        @mini_menu = Widget::AppMenu.new(@mini, :mini_menu!) do |w,*_,s|
+          self.method(w.key).call if s=='activate'
+          minime! if s=='button_press_event'
+        end
+      end
+
+      case app.method(:run).arity
+      when 1 then app.run(@window)
+      when 2 then app.run(@window, @mini_menu)
+      else raise "Application run method should have 2 parameters."
+      end
+    end
+
+    def fs!
+      @fs ? @window.unfullscreen : @window.fullscreen
+      @fs = !@fs
+    end
+
+    def about!
+      about = Such::AboutDialog.new :about_dialog
+      about.set_logo Widget::MainWindow.icon
+      about.run
+      about.destroy
+    end
+
+    def help!
+      system "#{CONFIG[:Open]} '#{Such::Thing::PARAMETERS[:HelpFile]}'"
+    end
+
+    def minime!
+      if @window.visible?
+        @slot = Slot.get
+        if @slot
+          s = CONFIG[:SlotsScale]
+          x, y = CONFIG[:SLOTS_OFFSET]
+          w, h = Gdk.screen_width, Gdk.screen_height
+          @mini.move(w-@slot*s+x, h-s+y)
+          @mini.keep_above=true
+          @window.hide
+          @mini.show
+        end
+      else
+        Slot.release(@slot) if @slot
+        @mini.hide
+        @window.show
+      end
+    end
+
+    def quit!
+      Slot.release(@slot) if @slot
+      Gtk.main_quit
+    end
+
+  end
+end

data/lib/gtk3app/slot.rb

@@ -0,0 +1,31 @@
+module Gtk3App
+module Slot
+  using Rafini::Array
+
+  def self.dbm
+    SDBM.open(CONFIG[:SlotsDBM]){|db|yield(db)}
+  end
+
+  def self.numbers
+    1.upto(CONFIG[:Slots]){|n|yield(n.to_s)}
+  end
+
+  def self.get
+    alive = Sys::ProcTable.ps.select{|p|p.cmdline=~/\bruby\b.*\bgtk3app\b/}.map{|p|p.pid.to_s}.is(true)
+    Slot.dbm do |db|
+      Slot.numbers do |slot|
+        unless alive[db[slot]]
+          db[slot]=$$.to_s
+          return slot.to_i
+        end
+      end
+    end
+    return nil
+  end
+
+  def self.release(slot)
+    Slot.dbm{|db|db.delete(slot.to_s)}
+  end
+
+end
+end

data/lib/gtk3app/version.rb

@@ -0,0 +1,3 @@
+module Gtk3App
+  VERSION = '0.0.0'
+end

data/lib/gtk3app/widget/widgets.rb

@@ -0,0 +1,55 @@
+module Gtk3App
+module Widget
+
+  class MenuItem < Such::MenuItem
+    attr_accessor :key
+  end
+
+  class Menu < Such::Menu
+    def append_menu_item(key, &block)
+      item = MenuItem.new(self, key, &block)
+      item.key = key
+      item.show
+    end
+  end
+
+  class AppMenu < Menu
+    def initialize(window, *par, &block)
+      @block = block
+      window.add_events(Gdk::Event::BUTTON_PRESS_MASK)
+      window.signal_connect('button_press_event') do |w,e|
+        if e.button == 3
+          self.popup(nil, nil, 3, e.time)
+        else
+          block.call(w,e,'button_press_event')
+        end
+      end
+      super(*par)
+    end
+
+    def append_menu_item(key)
+      block_given? ? super : super(key, &@block)
+    end
+  end
+
+  class MainWindow < Such::Window
+    def self.set_icon(file)
+      @@icon = Gdk::Pixbuf.new(file: file)
+    end
+
+    def self.icon
+      @@icon
+    end
+
+    def initialize(*par, &block)
+      super(*par, &block)
+      self.set_icon MainWindow.icon
+    end
+
+    def minime(x=CONFIG[:SlotsScale])
+      self.set_default_size(x,x)
+      self.add Gtk::Image.new(pixbuf: MainWindow.icon.scale(x,x)).show
+    end
+  end
+end
+end

data/lib/gtk3app.rb

@@ -0,0 +1,28 @@
+# Standard Libraries
+require 'yaml'
+require 'sdbm'
+
+# Supporting Gems
+require 'help_parser'
+require 'user_space'
+require 'rafini'
+require 'sys/proctable'
+
+# Workhorse Gems
+require 'gtk3'
+require 'such'
+Such::Things.gtk_widget
+
+### Gtk3App ###
+# Configuration
+require 'gtk3app/version.rb'
+require 'gtk3app/config.rb'
+# Custom Widgets
+require 'gtk3app/widget/widgets.rb'
+# Program Flow
+require 'gtk3app/slot.rb'
+require 'gtk3app/program.rb'
+require 'gtk3app/gtk3app.rb'
+
+# Requires:
+#`ruby`

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: gtk3app
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- carlosjhr64
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: help_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: user_space
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: rafini
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: sys-proctable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.4
+- !ruby/object:Gem::Dependency
+  name: gtk3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: such
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+description: |
+  _Gtk3App_ provides a _Gtk3_ application stub.
+
+  It autmatically provides for command line options parsing, user configuration, and minime windows.
+email: carlosjhr64@gmail.com
+executables:
+- gtk3app
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- README.rdoc
+- bin/gtk3app
+- data/VERSION
+- data/logo.png
+- data/ruby.png
+- lib/gtk3app.rb
+- lib/gtk3app/config.rb
+- lib/gtk3app/gtk3app.rb
+- lib/gtk3app/program.rb
+- lib/gtk3app/slot.rb
+- lib/gtk3app/version.rb
+- lib/gtk3app/widget/widgets.rb
+homepage: https://github.com/carlosjhr64/gtk3app
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--main"
+- README.rdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- 'ruby: ruby 2.1.3p242 (2014-09-19 revision 47630) [x86_64-linux]'
+- 'system: linux/bash'
+rubyforge_project: 
+rubygems_version: 2.4.1
+signing_key: 
+specification_version: 4
+summary: _Gtk3App_ provides a _Gtk3_ application stub.
+test_files: []
+has_rdoc: