everyday-menu 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c86edc8a146c2c3b4de839336fa419abef9a406
-  data.tar.gz: c2c7ed2317237e3d80915daa45ceee890e5f17b8
+  metadata.gz: 4519240679e0389183ed2e8dba773a4ed67c970a
+  data.tar.gz: 9ed56ec79c9022bc2bdeff2f6603363567b3f17b
 SHA512:
-  metadata.gz: fe680c8e891ee03cab8aa1a5e2a931426da4f587d46e2e6bc7e4c5741d8e16f69ce46d6e51789966ac4bc2eadfd4086d7b517eea8afc5c78aeac065c8dbaad74
-  data.tar.gz: 5ce81bad9ca66feb8c8626a7e02955e4800ef58d851d7cf82fe1d68d67b18b973085400bdb023d64dbbd5a47eda079bf3fa753a8916bc7e2ebc9a962dfc762d2
+  metadata.gz: 96ac26b404b7f1bcd0dc78fa3118041e77fdb995084961e0c1e877b8f72fe76c1f86e3419438ae83ee930b30445bdec8e74c919ca8d8fbd8f7c755749a9daf8e
+  data.tar.gz: 7a4ce75150edbe04fb1b8cb7ea985459265625a31e2d17ab5317cd81fdd159a79b42ed151a4cd52eaca07356f3affd5515109d7cbc17f606ce772d98f6a5b9c1

data/README.md

@@ -1,5 +1,8 @@
 # EverydayMenu
 
+## Updates
+Please see the "Introducing Presets!" section below for an awesome new feature!
+
 ## Issue Tracking
 Please use <https://everydayprogramminggenius.atlassian.net/browse/EM> for issue tracking.
 
@@ -94,6 +97,87 @@ class AppDelegate
   end
 end
 ```
+
+You can even put multiple actions on a single item by calling subscribe multiple times.
+
+## Introducing Presets!
+With version 0.4.0, I have added the capability to use some presets.  Here is the above example with presets:
+
+```ruby
+class MainMenu
+  extend EverydayMenu::MenuBuilder
+
+  menuItem :hide_others, 'Hide Others', preset: :hide_others
+  menuItem :show_all, 'Show All', preset: :show_all
+  menuItem :quit, 'Quit', preset: :quit
+
+  menuItem :services_item, 'Services', preset: :services
+
+  menuItem :open, 'Open', key_equivalent: 'o'
+  menuItem :new, 'New'
+  menuItem :close, 'Close', key_equivalent: 'w'
+end
+```
+
+with actions defined as:
+
+```ruby
+class AppDelegate
+  def applicationDidFinishLaunching(notification)
+    @has_open = false
+    MainMenu.build!
+
+    MainMenu[:file].subscribe(:new) { |_, _|
+      @has_open = true
+      puts 'new'
+    }
+    MainMenu[:file].subscribe(:close) { |_, _|
+      @has_open = false
+      puts 'close'
+    }.canExecuteBlock { |_| @has_open }
+    MainMenu[:file].subscribe(:open) { |_, _|
+      @has_open = true
+      puts 'open'
+    }
+  end
+end
+```
+
+I didn't use a preset for close because there was special handling.  Here are the presets and what they do:
+
+Preset | Settings | Action
+--------|-----------------------|------------------------------
+`:hide` | `key_equivalent: 'h'` | <code>{ &#124;_, _&#124; NSApp.hide(self) }</code>
+`:hide_others` | `key_equivalent: 'H'` <br> and <br> <code>:key\_equivalent\_modifier_mask: NSCommandKeyMask&#124;NSAlternateKeyMask</code> | <code>{ &#124;_, _&#124; NSApp.hideOtherApplications(self) }</code>
+`:show_all` | none | <code>{ &#124;_, _&#124; NSApp.unhideAllApplications(self) }</code>
+`:quit` | `key_equivalent: 'q'` | <code>{ &#124;_, _&#124; NSApp.terminate(self) }</code>
+`:close` | `key_equivalent: 'w'` | <code>{ &#124;_, _&#124; NSApp.keyWindow.performClose(self) }</code>
+`:services` | `submenu: (menu :services, <item-title>, services_menu: true)` | none
+
+Let me know if you have any others you think I should add.  If you want to add one of your own, I have included the ability to define presets.  You will want to do this at the top of the file where you setup your menu items.  Here is an example:
+
+```ruby
+EverydayMenu::MenuItem.definePreset(:hide_others) { |item|
+  item[:key_equivalent]               = 'H'
+  item[:key_equivalent_modifier_mask] = NSCommandKeyMask|NSAlternateKeyMask
+  item.subscribe { |_, _| NSApp.hideOtherApplications(item) }
+}
+```
+
+Since the block is being run after the item instance is created, you have to use the other syntax, `item[<key>]=` in order to set the values.  If you want to create a submenu in this, you can use `EverydayMenu::Menu.create(label, title, options = {})`, which accepts the same parameters as the `menu` method when building the menu normally.
+
+If you set some application property (like `NSApp.servicesMenu`) in your method, you should probably have that delayed until the whole menu setup is built.  You can do that like this:
+
+```ruby
+EverydayMenu::MenuItem.definePreset(:services) { |item|
+  item[:submenu] = Menu.create(:services_menu, item[:title], services_menu: true)
+  item.registerOnBuild { NSApp.servicesMenu = item[:submenu] }
+}
+```
+
+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.
+
+
 ## Known Issues
 
 Here are known issues.  If you encounter one, please log a bug ticket in the issue tracker (link above)

data/examples/basic_main_menu/app_delegate.rb

@@ -3,19 +3,14 @@ class AppDelegate
     @has_open = false
     MainMenu.build!
 
-    MainMenu[:app].subscribe(:hide_others) { |_, _| NSApp.hideOtherApplications(self) }
-    MainMenu[:app].subscribe(:quit) { |_, _| NSApp.terminate(self) }
-
     MainMenu[:file].subscribe(:new) { |_, _|
       @has_open = true
       puts 'new'
     }
-
     MainMenu[:file].subscribe(:close) { |_, _|
       @has_open = false
       puts 'close'
     }.canExecuteBlock { |_| @has_open }
-
     MainMenu[:file].subscribe(:open) { |_, _|
       @has_open = true
       puts 'open'

data/examples/basic_main_menu/main_menu.rb

@@ -1,11 +1,11 @@
 class MainMenu
   extend EverydayMenu::MenuBuilder
 
-  menuItem :hide_others, 'Hide Others', key_equivalent: 'H', key_equivalent_modifier_mask: NSCommandKeyMask|NSAlternateKeyMask
-  menuItem :quit, 'Quit', key_equivalent: 'q'
+  menuItem :hide_others, 'Hide Others', preset: :hide_others
+  menuItem :show_all, 'Show All', preset: :show_all
+  menuItem :quit, 'Quit', preset: :quit
 
-  menu :services, 'Services', services_menu: true
-  menuItem :services_item, 'Services', submenu: :services
+  menuItem :services_item, 'Services', preset: :services
 
   menuItem :open, 'Open', key_equivalent: 'o'
   menuItem :new, 'New'
@@ -13,6 +13,7 @@ class MainMenu
 
   mainMenu(:app, 'Blah') {
     hide_others
+    show_all
     ___
     services_item
     ___

data/lib/everyday-menu/menu.rb

@@ -83,6 +83,19 @@ module EverydayMenu
       prefix.nil? ? rval : "#{prefix}#{rval[0].upcase}#{rval[1..-1]}"
     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
+
     def label
       @label ||= nil
     end
@@ -193,5 +206,9 @@ module EverydayMenu
     end
 
     alias :select_item_by_member :selectItemByMember
+
+    def each(&block)
+      @menuItems.values.each(&block)
+    end
   end
 end

data/lib/everyday-menu/menu_builder.rb

@@ -57,15 +57,7 @@ module EverydayMenu
           @mainMenu ||= NSMenu.new
           @mainMenu.addItem menu.menuItemFromMenu!.menuItem
         end
-        if menu.is :services_menu
-          NSApp.servicesMenu = menu.menu
-        end
-        if menu.is :windows_menu
-          NSApp.windowsMenu = menu.menu
-        end
-        if menu.is :help_menu
-          NSApp.helpMenu = menu.menu
-        end
+        menu.runOnBuild
       end
       setupMainMenu if @mainMenu
     end

data/lib/everyday-menu/menu_item.rb

@@ -108,6 +108,61 @@ module EverydayMenu
     alias :keyEquivalentModifierMask= :setKeyEquivalentModifierMask
     alias :key_equivalent_modifier_mask= :setKeyEquivalentModifierMask
 
+    def setPreset(action)
+      @@presets ||= {}
+      if @@presets.has_key?(action)
+        @@presets[action].call(self)
+      end
+    end
+
+    def self.definePreset(label, &block)
+      @@presets        ||= {}
+      @@presets[label] = block
+    end
+
+    definePreset(:hide) { |item|
+      item[:key_equivalent] = 'h'
+      item.subscribe { |_, _| NSApp.hide(item) }
+    }
+
+    definePreset(:hide_others) { |item|
+      item[:key_equivalent]               = 'H'
+      item[:key_equivalent_modifier_mask] = NSCommandKeyMask|NSAlternateKeyMask
+      item.subscribe { |_, _| NSApp.hideOtherApplications(item) }
+    }
+
+    definePreset(:show_all) { |item|
+      item.subscribe { |_, _| NSApp.unhideAllApplications(item) }
+    }
+
+    definePreset(:quit) { |item|
+      item[:key_equivalent] = 'q'
+      item.subscribe { |_, _| NSApp.terminate(item) }
+    }
+
+    definePreset(:close) { |item|
+      item[:key_equivalent] = 'w'
+      item.subscribe { |_, _| NSApp.keyWindow.performClose(item) }
+    }
+
+    definePreset(:services) { |item|
+      item[:submenu] = Menu.create(:services_menu, item[:title], services_menu: true)
+      item.registerOnBuild { NSApp.servicesMenu = item[:submenu] }
+    }
+
+    def runOnBuild
+      onBuild.each { |block| block.call }
+    end
+
+    def onBuild
+      @onBuild ||= []
+    end
+
+    def registerOnBuild(&block)
+      @onBuild ||= []
+      @onBuild << block
+    end
+
     def subscribe(&block)
       @menuItem.subscribe(self.label, &block)
     end

data/lib/everyday-menu/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: everyday-menu
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Eric Henderson