everyday-menu 0.4.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4519240679e0389183ed2e8dba773a4ed67c970a
-  data.tar.gz: 9ed56ec79c9022bc2bdeff2f6603363567b3f17b
+  metadata.gz: e245af3b08954f17c48965a894d13e01b8335649
+  data.tar.gz: 0ce77623e08bed86d0329e5e0d9a196e5261e7fe
 SHA512:
-  metadata.gz: 96ac26b404b7f1bcd0dc78fa3118041e77fdb995084961e0c1e877b8f72fe76c1f86e3419438ae83ee930b30445bdec8e74c919ca8d8fbd8f7c755749a9daf8e
-  data.tar.gz: 7a4ce75150edbe04fb1b8cb7ea985459265625a31e2d17ab5317cd81fdd159a79b42ed151a4cd52eaca07356f3affd5515109d7cbc17f606ce772d98f6a5b9c1
+  metadata.gz: 781454de5673aabd1a39be97feae58cb19dc1f2fd7fb21ac67e55ed0d12eadd3a8f7eb54a8f2145d34a0aac51a7c5d8c2b53a971124879f7a6a890e1fb837d59
+  data.tar.gz: 8ee6356acd25e9ecc634fd900dc133f7a01c98a59e328c631aa1e928d6a5fdecb9fae745d126a2ca9ddc8c6a364ceb268b8ee2c68816b86170e9b91861767c7b

data/README.md

@@ -1,7 +1,8 @@
 # EverydayMenu
 
 ## Updates
-Please see the "Introducing Presets!" section below for an awesome new feature!
+* Please see the "Introducing Presets!" section below for an awesome new feature!
+* Please see the "Introducing Statusbar Menus!" section below for another awesome new feature!
 
 ## Issue Tracking
 Please use <https://everydayprogramminggenius.atlassian.net/browse/EM> for issue tracking.
@@ -177,6 +178,35 @@ EverydayMenu::MenuItem.definePreset(:services) { |item|
 
 Any block you pass to `item.registerOnBuild(&block)` will be added to a list of blocks to be run when the menu setup is built.
 
+## Introducing Statusbar Menus!
+As of version 1.0.0, `everyday-menu` now supports creating statusbar menus.  With this addition, I believe I have finally matched all of the important features of `drink-menu`.
+
+Here's how you can make a menu be for the statusbar icon:
+
+```ruby
+class MainMenu
+  extend EverydayMenu::MenuBuilder
+  
+  menuItem :status_open, 'Open', key_equivalent: 'o'
+  menuItem :status_new, 'New'
+  menuItem :status_close, 'Close', key_equivalent: 'w'
+  menuItem :status_quit, 'Quit', preset: :quit
+
+  statusbarMenu(:statusbar, 'Statusbar Menu', status_item_icon: 'icon', status_item_view_class: ViewClass) {
+    status_new
+    status_open
+    ___
+    status_close
+    ___
+    status_quit
+  }
+end
+```
+
+This will create a statusbar menu with the specified title, icon, and view class.
+
+You can also create a statusbar menu by using the key `status_item_title:`, `status_item_icon:`, and/or `status_item_view_class:` in a regular (non-main) menu.  Other than the addition of these parameters, a statusbar menu has all of the same parameters as a regular menu.
+
 
 ## Known Issues
 

data/examples/basic_main_menu/app_delegate.rb

@@ -15,5 +15,17 @@ class AppDelegate
       @has_open = true
       puts 'open'
     }
+    MainMenu[:statusbar].subscribe(:status_new) { |_, _|
+      @has_open = true
+      puts 'status-new'
+    }
+    MainMenu[:statusbar].subscribe(:status_close) { |_, _|
+      @has_open = false
+      puts 'status-close'
+    }.canExecuteBlock { |_| @has_open }
+    MainMenu[:statusbar].subscribe(:status_open) { |_, _|
+      @has_open = true
+      puts 'status-open'
+    }
   end
 end

data/examples/basic_main_menu/main_menu.rb

@@ -11,6 +11,12 @@ class MainMenu
   menuItem :new, 'New'
   menuItem :close, 'Close', key_equivalent: 'w'
 
+  menuItem :status_open, 'Open', key_equivalent: 'o'
+  menuItem :status_new, 'New'
+  menuItem :status_close, 'Close', key_equivalent: 'w'
+  menuItem :status_quit, 'Quit', preset: :quit
+
+
   mainMenu(:app, 'Blah') {
     hide_others
     show_all
@@ -26,4 +32,13 @@ class MainMenu
     ___
     close
   }
+
+  statusbarMenu(:statusbar, 'Statusbar Menu') {
+    status_new
+    status_open
+    ___
+    status_close
+    ___
+    status_quit
+  }
 end

data/lib/everyday-menu/menu.rb

@@ -1,6 +1,16 @@
 module EverydayMenu
   class Menu
-    attr_reader :needsMenuItem
+    include MyAccessors
+
+    my_attr_writer :label
+
+    my_attr_accessor_bool :servicesMenu, :windowsMenu, :helpMenu, :mainMenu
+
+    my_attr_reader_bool :statusMenu
+
+    my_attr_reader :statusItemTitle, :statusItemIcon, :statusItemViewClass
+
+    attr_reader :menu, :builder
 
     def self.create(label, title, options = {}, &block)
       new(label, &block).tap { |menu|
@@ -11,14 +21,18 @@ module EverydayMenu
     end
 
     def initialize(label, &block)
-      @label         = label
-      @builder       = block
-      @menu          = NSMenu.alloc.init
-      @menuItems     = MenuItemList.new(@menu)
-      @needsMenuItem = false
-      @servicesMenu  = false
-      @windowMenu    = false
-      @helpMenu      = false
+      @label               = label
+      @builder             = block
+      @menu                = NSMenu.alloc.init
+      @menuItems           = MenuItemList.new(@menu)
+      @mainMenu            = false
+      @statusMenu          = false
+      @servicesMenu        = false
+      @windowsMenu         = false
+      @helpMenu            = false
+      @statusItemTitle     = nil
+      @statusItemIcon      = nil
+      @statusItemViewClass = nil
     end
 
     def menuItemFromMenu!
@@ -42,136 +56,79 @@ module EverydayMenu
       @menuItems << item
     end
 
-    def has(key)
-      name = key_to_name(key, 'has')
-      if self.respond_to?(name)
-        self.send(name)
-      else
-        @menu.send(name)
-      end
-    end
-
-    def is(key)
-      name = key_to_name(key, 'is')
-      if self.respond_to?(name)
-        self.send(name)
-      else
-        @menu.send(name)
-      end
-    end
-
-    def [](key)
-      name = key_to_name(key)
-      if self.respond_to?(name)
-        self.send(name)
-      else
-        @menu.send(name)
-      end
+    def containedObject
+      @menu
     end
 
-    def []=(key, value)
-      name = key_to_name(key, 'set')
-      if self.respond_to?(name)
-        self.send(name, value)
-      else
-        @menu.send(name, value)
-      end
+    def runOnBuild
+      @@buildBlocks ||= {}
+      @@buildBlocks.each { |block| block[1].call(self) if self.is(block[0]) }
+      @menuItems.each { |item| item.runOnBuild }
     end
 
-    def key_to_name(key, prefix = nil)
-      rval = key.to_s.gsub(/_(\w)/) { |_| $1.upcase }
-      prefix.nil? ? rval : "#{prefix}#{rval[0].upcase}#{rval[1..-1]}"
+    def self.registerBuildBlock(field, &block)
+      @@buildBlocks        ||= {}
+      @@buildBlocks[field] = block
     end
 
-    def runOnBuild
-      if self.is :services_menu
-        NSApp.servicesMenu = self.menu
-      end
-      if self.is :windows_menu
-        NSApp.windowsMenu = self.menu
-      end
-      if self.is :help_menu
-        NSApp.helpMenu = self.menu
-      end
-      @menuItems.each { |item| item.runOnBuild }
-    end
+    registerBuildBlock(:services_menu) { |menu| NSApp.servicesMenu = menu.menu }
+    registerBuildBlock(:windows_menu) { |menu| NSApp.windowsMenu = menu.menu }
+    registerBuildBlock(:help_menu) { |menu| NSApp.helpMenu = menu.menu }
+    registerBuildBlock(:status_menu) { |menu| menu.createStatusItem! }
 
     def label
       @label ||= nil
     end
 
-    def setLabel(label)
-      @label = label
-    end
-
-    alias :label= :setLabel
-
-    def isServicesMenu
-      @servicesMenu
+    def setStatusItemTitle(title)
+      @mainMenu        = false unless title.nil?
+      @statusItemTitle = title
+      @statusMenu      = true unless title.nil?
     end
 
-    alias :servicesMenu :isServicesMenu
-    alias :services_menu? :isServicesMenu
+    alias :statusItemTitle= :setStatusItemTitle
+    alias :status_item_title= :setStatusItemTitle
 
-    def setServicesMenu(value)
-      @servicesMenu = value
+    def setStatusItemIcon(icon)
+      @mainMenu       = false unless icon.nil?
+      @statusItemIcon = icon
+      @statusMenu     = true unless icon.nil?
     end
 
-    alias :servicesMenu= :setServicesMenu
-    alias :services_menu= :setServicesMenu
+    alias :statusItemIcon= :setStatusItemIcon
+    alias :status_item_icon= :setStatusItemIcon
 
-    def isWindowsMenu
-      @windowMenu
+    def setStatusItemViewClass(viewClass)
+      @mainMenu            = false unless viewClass.nil?
+      @statusItemViewClass = viewClass
+      @statusMenu          = true unless viewClass.nil?
     end
 
-    alias :windowsMenu :isWindowsMenu
-    alias :windows_menu? :isWindowsMenu
+    alias :statusItemViewClass= :setStatusItemViewClass
+    alias :status_item_view_class= :setStatusItemViewClass
 
-    def setWindowsMenu(value)
-      @windowMenu = value
-    end
+    def createStatusItem!
+      statusBar                 = NSStatusBar.systemStatusBar
+      @statusItem               = statusBar.statusItemWithLength(NSSquareStatusItemLength)
+      @statusItem.highlightMode = true
 
-    alias :windowsMenu= :setWindowsMenu
-    alias :windows_menu= :setWindowsMenu
+      @statusItem.menu = self.menu
 
-    def isHelpMenu
-      @helpMenu
-    end
+      unless @statusItemViewClass.nil?
+        statusItemView            = @statusItemViewClass.viewWithStatusItem(@statusItem)
+        @statusItem.menu.delegate = @statusItemView
+        @statusItem.view          = statusItemView
+      end
 
-    alias :helpMenu :isHelpMenu
-    alias :help_menu? :isHelpMenu
+      @statusItem.title = @statusItemTitle
+      @statusItem.image = @statusItemIcon
 
-    def setHelpMenu(value)
-      @helpMenu = value
+      @statusItem
     end
 
-    alias :helpMenu= :setHelpMenu
-    alias :help_menu= :setHelpMenu
-
     def items
       @menuItems
     end
-
-    def menu
-      @menu
-    end
-
-    def builder
-      @builder
-    end
-
-    def isMainMenu
-      @needsMenuItem
-    end
-
-    alias :mainMenu :isMainMenu
-    alias :main_menu? :isMainMenu
-
-    def setMainMenu(value)
-      @needsMenuItem = value
-    end
-
-    alias :main_menu= :setMainMenu
   end
 
   class MenuItemList

data/lib/everyday-menu/menu_builder.rb

@@ -45,6 +45,13 @@ module EverydayMenu
       @menus[label]       = Menu.create(label, title, options, &block)
     end
 
+    def statusbarMenu(label, title, options = {}, &block)
+      options[:main_menu]         = false
+      options[:status_item_title] = title unless options.has_key?(:status_item_title)
+      @menus                      ||= {}
+      @menus[label]               = Menu.create(label, title, options, &block)
+    end
+
     def [](label)
       @menus[label]
     end

data/lib/everyday-menu/menu_item.rb

@@ -1,5 +1,7 @@
 module EverydayMenu
   class MenuItem
+    include MyAccessors
+
     def self.create(label, title, options = {})
       new.tap { |item|
         item[:label] = label
@@ -25,67 +27,22 @@ module EverydayMenu
       @menuItem = menuItem || NSMenuItem.alloc.init
     end
 
-    def has(key)
-      name = key_to_name(key, 'has')
-      if self.respond_to?(name)
-        self.send(name)
-      else
-        @menuItem.send(name)
-      end
-    end
-
-    def is(key)
-      name = key_to_name(key, 'is')
-      if self.respond_to?(name)
-        self.send(name)
-      else
-        @menuItem.send(name)
-      end
-    end
-
-    def [](key)
-      name = key_to_name(key)
-      if self.respond_to?(name)
-        self.send(name)
-      else
-        @menuItem.send(name)
-      end
-    end
-
-    def []=(key, value)
-      name = key_to_name(key, 'set')
-      if self.respond_to?(name)
-        self.send(name, value)
-      else
-        @menuItem.send(name, value)
-      end
-    end
-
-    def key_to_name(key, prefix = nil)
-      rval = key.to_s.gsub(/_(\w)/) { |_| $1.upcase }
-      prefix.nil? ? rval : "#{prefix}#{rval[0].upcase}#{rval[1..-1]}"
+    def containedObject
+      @menuItem
     end
 
     def setSubmenu(menu)
       @menuItem.submenu = menu.menu
     end
 
-    def menuItem
-      @menuItem
-    end
-
-    alias :menu_item :menuItem
+    my_attr_reader :menuItem
     alias :item :menuItem
 
     def label
       @label ||= nil
     end
 
-    def setLabel(label)
-      @label = label
-    end
-
-    alias :label= :setLabel
+    my_attr_writer :label
 
     def tag
       @menuItem.tag

data/lib/everyday-menu/utils.rb

@@ -0,0 +1,160 @@
+module EverydayMenu
+  class EverydayCommand
+    attr_reader :label
+    attr_writer :canExecute
+
+    def initialize(label, canExecute = true, &block)
+      @label           = label
+      @block           = block
+      @canExecute      = canExecute
+      @canExecuteBlock = nil
+    end
+
+    def canExecuteBlock(&block)
+      @canExecuteBlock = block
+    end
+
+    def canExecute
+      @canExecuteBlock.nil? ? @canExecute : @canExecuteBlock.call(self)
+    end
+
+    def execute(sender)
+      @block.call(self, sender)
+    end
+  end
+
+  class CommandList
+    attr_accessor :label
+
+    def initialize(label)
+      @label = label
+      @items = []
+    end
+
+    def add(&block)
+      @items << EverydayCommand.new(@label, &block)
+    end
+
+    def last
+      @items.last
+    end
+
+    def execute(sender)
+      @items.each { |item| item.execute(sender) }
+    end
+
+    def canExecute
+      @items.any? { |item| item.canExecute }
+    end
+  end
+
+  module MyAccessors
+    def has(key)
+      name = self.class.key_to_name(key, 'has')
+      if self.respond_to?(name)
+        self.send(name)
+      else
+        self.containedObject.send(name)
+      end
+    end
+
+    def is(key)
+      name = self.class.key_to_name(key, 'is')
+      if self.respond_to?(name)
+        self.send(name)
+      else
+        self.containedObject.send(name)
+      end
+    end
+
+    def [](key)
+      name = self.class.key_to_name(key)
+      if self.respond_to?(name)
+        self.send(name)
+      else
+        self.containedObject.send(name)
+      end
+    end
+
+    def []=(key, value)
+      name = self.class.key_to_name(key, 'set')
+      if self.respond_to?(name)
+        self.send(name, value)
+      else
+        self.containedObject.send(name, value)
+      end
+    end
+
+    class << self
+      def self.key_to_name(key, prefix = nil)
+        rval = key.to_s.gsub(/_(\w)/) { |_| $1.upcase }
+        prefix.nil? ? rval : "#{prefix}#{rval[0].upcase}#{rval[1..-1]}"
+      end
+
+      def self.name_to_key(name)
+        name.to_s.gsub(/A-Z/) { |c| c.downcase }.to_sym
+      end
+
+      def self.my_attr_accessor(*names)
+        names.each { |name|
+          var_name = :"@#{name.to_s}"
+          define_method(name) { self.instance_variable_get(var_name) }
+          define_method(:"#{name.to_s}=") { |val| self.instance_variable_set(var_name, val) }
+          setName = :"set#{name.to_s[0].upcase}#{name.to_s[1..-1]}"
+          define_method(setName) { |val| self.instance_variable_set(var_name, val) }
+          name2 = name_to_key(name)
+          define_method(name2) { self.instance_variable_get(var_name) }
+          define_method(:"#{name2.to_s}=") { |val| self.instance_variable_set(var_name, val) }
+        }
+      end
+
+      def self.my_attr_accessor_bool(*names)
+        names.each { |name|
+          var_name = :"@#{name.to_s}"
+          define_method(name) { self.instance_variable_get(var_name) }
+          define_method(:"#{name.to_s}=") { |val| self.instance_variable_set(var_name, val) }
+          isName = :"#{key_to_name(name, 'is')}"
+          define_method(isName) { self.instance_variable_get(var_name) }
+          setName = :"#{key_to_name(name, 'set')}"
+          define_method(setName) { |val| self.instance_variable_set(var_name, val) }
+          name2 = name_to_key(name)
+          define_method(name2) { self.instance_variable_get(var_name) }
+          define_method(:"#{name2.to_s}?") { self.instance_variable_get(var_name) }
+          define_method(:"#{name2.to_s}=") { |val| self.instance_variable_set(var_name, val) }
+        }
+      end
+
+      def self.my_attr_reader(*names)
+        names.each { |name|
+          var_name = :"@#{name.to_s}"
+          define_method(name) { self.instance_variable_get(var_name) }
+          name2 = name_to_key(name)
+          define_method(name2) { self.instance_variable_get(var_name) }
+        }
+      end
+
+      def self.my_attr_reader_bool(*names)
+        names.each { |name|
+          var_name = :"@#{name.to_s}"
+          define_method(name) { self.instance_variable_get(var_name) }
+          isName = :"#{key_to_name(name, 'is')}"
+          define_method(isName) { self.instance_variable_get(var_name) }
+          name2 = name_to_key(name)
+          define_method(name2) { self.instance_variable_get(var_name) }
+          define_method(:"#{name2.to_s}?") { self.instance_variable_get(var_name) }
+        }
+      end
+
+      def self.my_attr_writer(*names)
+        names.each { |name|
+          var_name = :"@#{name.to_s}"
+          define_method(:"#{name.to_s}=") { |val| self.instance_variable_set(var_name, val) }
+          setName = :"#{key_to_name(name, 'set')}"
+          define_method(setName) { |val| self.instance_variable_set(var_name, val) }
+          name2 = name_to_key(name)
+          define_method(:"#{name2.to_s}=") { |val| self.instance_variable_set(var_name, val) }
+        }
+      end
+    end
+  end
+end

data/lib/everyday-menu/version.rb

@@ -1,3 +1,3 @@
 module EverydayMenu
-  VERSION = '0.4.0'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: everyday-menu
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Eric Henderson
@@ -55,10 +55,10 @@ files:
 - examples/basic_main_menu/app_delegate.rb
 - examples/basic_main_menu/main_menu.rb
 - lib/everyday-menu.rb
-- lib/everyday-menu/everyday_command.rb
 - lib/everyday-menu/menu.rb
 - lib/everyday-menu/menu_builder.rb
 - lib/everyday-menu/menu_item.rb
+- lib/everyday-menu/utils.rb
 - lib/everyday-menu/version.rb
 - spec/menu_builder_spec.rb
 - spec/menu_item_spec.rb

data/lib/everyday-menu/everyday_command.rb

@@ -1,50 +0,0 @@
-module EverydayMenu
-  class EverydayCommand
-    attr_reader :label
-    attr_writer :canExecute
-
-    def initialize(label, canExecute = true, &block)
-      @label           = label
-      @block           = block
-      @canExecute      = canExecute
-      @canExecuteBlock = nil
-    end
-
-    def canExecuteBlock(&block)
-      @canExecuteBlock = block
-    end
-
-    def canExecute
-      @canExecuteBlock.nil? ? @canExecute : @canExecuteBlock.call(self)
-    end
-
-    def execute(sender)
-      @block.call(self, sender)
-    end
-  end
-
-  class CommandList
-    attr_accessor :label
-
-    def initialize(label)
-      @label = label
-      @items = []
-    end
-
-    def add(&block)
-      @items << EverydayCommand.new(@label, &block)
-    end
-
-    def last
-      @items.last
-    end
-
-    def execute(sender)
-      @items.each { |item| item.execute(sender) }
-    end
-
-    def canExecute
-      @items.any? { |item| item.canExecute }
-    end
-  end
-end