remi-simpletray 0.0.6

data/README.rdoc

@@ -0,0 +1,60 @@
+= simpletray
+
+simpletray is a gem for making it really easy to make wxruby-based system tray applications
+
+== installation
+
+simpletray uses wxWidgets, so you need to install wx: http://www.wxwidgets.org/
+
+a binary should be available for Windows users.  Mac/Linux should be able to use your packaging systems.
+
+now, install the required rubygems ...
+
+  $ sudo gem install wxruby activesupport
+
+and ... simpletray!  (NOTE: at the time of writing, github still hasn't generated by gem, so you need to manually download from github)
+
+  $ sudo gem install remi-simpletray -s http://gems.github.com
+
+== usage
+
+  #! /usr/bin/env ruby
+  require 'simpletray'
+
+  # icon my_cool_app.png will be used for the tray icon
+  SimpleTray.app 'My Cool App' do
+
+    # this makes a single item 'About' (about.png will be used if found)
+    # which pops up a message box when clicked
+    about { msgbox "Hello!  This is my app!" }
+
+    # this makes a submenu 'Dogs' with rover/spot/rex subitems.
+    # dogs.png, rover.png, spot.png, rex.png will all be looked for
+    _dogs_  {
+      rover { puts "..." }
+      spot  { puts "..." }
+      rex   { msgbox "w00f, my name is rex!" } 
+    }
+
+    # adds an item (the same as saying my_custom_item) with a custom icon
+    item 'My Custom Item', 'custom-icon.png' do
+      # ...
+    end
+
+    # adds an menu (the same as saying _my_custom_menu_) with a custom icon
+    menu 'My Custom Menu', 'custom-menu-icon.png' do
+      item1 { }
+      item2 { }
+    end
+
+    # this adds a seperator and then a special 'exit' item to quit the application
+    ____
+    exit
+
+  end
+
+Also, see examples/first.rb (the first file I used for testing), which shows how to add 
+your own helper methods
+
+Note, currently I'm only supporting PNGs.  I'll fix this to support ICO/PNG/BMP/JPG/etc.
+My TODO list is long  :P

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rake/rdoctask'
+
+Rake::RDocTask.new do |rdoc|
+      files = ['README.rdoc','lib/**/*.rb', 'doc/**/*.rdoc', 'test/*.rb']
+      rdoc.rdoc_files.add(files)
+      rdoc.main = 'README.rdoc'
+      rdoc.title = 'SimpleTray'
+      rdoc.rdoc_dir = 'doc'
+      rdoc.options << '--line-numbers' << '--inline-source'
+end

data/examples/first.rb

@@ -0,0 +1,46 @@
+#! /usr/bin/env ruby
+$:.unshift File.join( File.dirname(__FILE__), '..', 'lib' )
+require 'rubygems'
+require 'simpletray'
+
+module SimpleTray::Builder
+  def popup name, message
+    item( name ){ msgbox message }
+  end
+end
+
+SimpleTray.app 'My Cool App' do
+
+  popup 'testing 1,2,3', 'this is my message'
+  
+  about { puts "this is my tray app!" }
+
+  msgbox_hi { msgbox "hello!" }
+  _____
+
+  item 'My Name' do 
+  end
+
+  item 'blah', lambda { puts 'hello from blah' }
+
+  _menu_ 'xxx' do 
+    menu_item_1 { msgbox "you clicked menu item 1!" }
+    ___
+    menu_item_2 { puts "clicked number 2 !!!!!" }
+  end
+
+  options { puts "on click" }
+
+  _options_ do
+    profile { puts "your profile" }
+    neato   { puts "blah!"        }
+    _nested_ do
+      _more_ do
+        clicky { msgbox "yay!" }
+      end
+    end
+  end
+
+  exit
+
+end

data/lib/simpletray.rb

@@ -0,0 +1,176 @@
+$:.unshift File.dirname(__FILE__)
+%w( rubygems wx activesupport ).each {|lib| require lib }
+
+class SimpleTray
+  cattr_accessor :icon_directory
+
+  # Use this to run your SimpleTray application
+  #
+  #  SimpleTray.app 'My Cool App' do
+  #    about { msgbox "My App!" }
+  #    exit
+  #  end
+  #
+  def self.app title, &block
+    Wx::App.run { Icon.new title, &block }
+  end
+
+  # This is where the magic happens.
+  #
+  # Any methods you add to this module will be available in the DSL
+  #
+  #  module SimpleTray::Builder
+  #    def popup name, message
+  #      item( name ){ msgbox message }
+  #    end
+  #  end
+  #
+  #  SimpleTray.app 'My Cool App' do
+  #   popup 'Click Me', 'Hello!  This is my message!'
+  #  end
+  #
+  # Whatever you do, do NOT override the methods used 
+  # in this module, *especially* not #method_missing.
+  #
+  # If you want to override the behavior of one of these 
+  # methods, ***PLEASE*** use #alias_method_chain.
+  #
+  module Builder
+
+    def item name, icon = nil, &block
+      if block.nil? and icon.respond_to?:call
+        block = icon 
+        icon  = nil
+      end
+      item = Wx::MenuItem.new @menu, -1, name
+
+      icon ||= name.titleize.gsub(' ','').underscore + '.png' # 'My Cool App' => 'my_cool_app.png'
+      icon = File.join SimpleTray.icon_directory, icon unless File.file?icon
+      if File.file?icon
+        icon = Wx::Bitmap.new icon, Wx::BITMAP_TYPE_PNG
+        item.set_bitmap icon
+      end
+      
+      @menu.append_item item
+      @menu.evt_menu(item){ block.call }
+      item
+    end
+
+    def menu name, icon = nil, &block
+      if block.nil? and icon.respond_to?:call
+        block = icon 
+        icon  = nil
+      end
+      item = SimpleTray::MenuItem.new @menu, name, icon, &block
+      @menu.append_item item
+    end
+
+    def seperator
+      @menu.append_separator
+    end
+
+    def exit name = 'Quit'
+      @menu.append Wx::ID_EXIT, name
+      @menu.evt_menu(Wx::ID_EXIT){ Kernel::exit }
+    end
+
+    alias quit exit
+
+    def msgbox msg
+      Wx::MessageDialog.new(@frame, msg, 'Ashacache', Wx::OK, Wx::DEFAULT_POSITION ).show_modal
+    end
+
+    def method_missing method, *args, &block
+      method = method.to_s
+      if method[/^_*$/]
+        seperator
+      elsif method[/^_.*_$/]
+        menu method.titleize.strip, *args, &block
+      else
+        item method.titleize, *args, &block
+      end
+    end
+  end
+
+  # Used *internally* by SimpleTray
+  #
+  # Represents a menu item that has a web menu.
+  #
+  # This dynamically creates the menu when your mouse 
+  # highlights / hovers over the menu.  See #on_highlight
+  #
+  class MenuItem < Wx::MenuItem
+    include Builder
+  
+    def initialize menu, name, icon = nil, &block
+      super menu, -1, name
+      @menu = menu
+      @name = name
+      @icon = icon || @name.titleize.gsub(' ','').underscore + '.png' # 'My Cool App' => 'my_cool_app.png'
+      @icon = File.join SimpleTray.icon_directory, @icon unless File.file?@icon
+      init_icon
+      @item_block = block
+      self.get_menu.evt_menu_highlight(self){ |evt| on_highlight(evt) }
+      @menu = Wx::Menu.new
+      self.set_sub_menu @menu
+    end
+
+    def init_icon
+      if File.file?@icon
+        icon = Wx::Bitmap.new @icon, Wx::BITMAP_TYPE_PNG
+        set_bitmap icon
+      end
+    end
+  
+    def on_highlight(evt)
+      instance_eval &@item_block if @menu.get_menu_item_count == 0
+    end
+  end
+  
+  # Used *internally* by SimpleTray
+  #
+  # Represents the top-level system tray icon
+  #
+  # Menu items are dynamically created each time you click on 
+  # the system tray icon.  See #create_popup_menu
+  #
+  class Icon < Wx::TaskBarIcon
+    include Builder
+  
+    def initialize title, icon = nil, &block
+      super()
+      @title = title
+      @icon  = icon || @title.titleize.gsub(' ','').underscore + '.png' # 'My Cool App' => 'my_cool_app.png'
+      @icon  = File.join SimpleTray.icon_directory, @icon unless File.file?@icon
+      init_icon
+      @item_block = block
+    end
+  
+    def icon= path
+      @icon = path
+    end
+  
+    def init_icon
+      unless File.file?@icon
+        raise "SimpleTray icon not found!  #{ @icon }.  Try: SimpleTray.app 'title', 'path to icon'.  " + 
+              "Or set SimpleTray.icon_directory to the directory where your icons reside."
+      else
+        refresh_icon
+      end
+    end
+
+    def refresh_icon
+      set_icon Wx::Icon.new( @icon, Wx::BITMAP_TYPE_PNG ), @title if File.file?@icon
+    end
+  
+    def create_popup_menu
+      @menu = Wx::Menu.new
+      instance_eval &@item_block
+      @menu
+    end
+  end
+
+end
+
+# default the icon directory to what we *think* is the path of the script being run
+SimpleTray.icon_directory = File.expand_path(File.dirname($0))

data/simpletray.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+
+  s.name = "simpletray"
+  s.version = "0.0.6"
+  s.date = "2008-09-26"
+  s.summary = "Ruby gem that provides a DSL for creating system tray icon applications *really* easily."
+  s.email = "remi@remitaylor.com"
+  s.homepage = "http://github.com/remi/simpletray"
+  s.description = "Ruby gem that provides a DSL for creating system tray icon applications *really* easily."
+  s.has_rdoc = true
+  s.rdoc_options = ["--quiet", "--title", "SimpleTray - creating system tray icons", "--opname", "index.html", "--line-numbers", "--main", "SimpleTray", "--inline-source"]
+  s.authors = ["remi Taylor"]
+
+  # generate using: $ ruby -e "puts Dir['**/**'].select{|x| File.file?x}.inspect"
+  s.files = ["examples/first.rb", "lib/simpletray.rb", "README.rdoc", "simpletray.gemspec", "Rakefile"]
+
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: remi-simpletray
+version: !ruby/object:Gem::Version 
+  version: 0.0.6
+platform: ruby
+authors: 
+- remi Taylor
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-09-26 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Ruby gem that provides a DSL for creating system tray icon applications *really* easily.
+email: remi@remitaylor.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- examples/first.rb
+- lib/simpletray.rb
+- README.rdoc
+- simpletray.gemspec
+- Rakefile
+has_rdoc: true
+homepage: http://github.com/remi/simpletray
+post_install_message: 
+rdoc_options: 
+- --quiet
+- --title
+- SimpleTray - creating system tray icons
+- --opname
+- index.html
+- --line-numbers
+- --main
+- SimpleTray
+- --inline-source
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Ruby gem that provides a DSL for creating system tray icon applications *really* easily.
+test_files: []
+