menu-motion 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 934a02195b3c68b51b5bcfdf5f0907d7d3717995
-  data.tar.gz: 5f6f318336f94e483f9cc58d2d7c17f1e42583f6
+  metadata.gz: 728776dec6261eb85e60dbb1d452dd1605257f62
+  data.tar.gz: 233be399ec008b1eb71af6146684568fc335f521
 SHA512:
-  metadata.gz: 833c111856c289a0c5b3d977640e3d65cb92b9d02daeb6385164349b79d03582b3925b3ad1ca19888579d38039db043bd2715b6bdeefc21d46449555e5630555
-  data.tar.gz: 815b050b4d22bbbda7601e30417897d897e75a268dd1235b03f6cde46ad4e1a773f0bfe47b5cc0088851d926fb9ee9c1d036f964c45e0fcd93b6293f2dc58adf
+  metadata.gz: 7f27f0192f9ef7bb1f1c2592873fa5bda6e949410b40bcc2f3d093b79bbeae54b34ce42e69c8a5a0cfe6d29e01bf7893b787e506d5d616cf00bb50d02be529ba
+  data.tar.gz: e57a001a46dc0fc2271f7f1b44fa541e0a247a0de2db09caf75d5891c192c2ba7ac9d37299fcd0108611a8738224dc00554b1ba444fcfd60d1ba0275f3b0b5be

data/README.md

@@ -1,6 +1,9 @@
 # MenuMotion
 
-MenuMotion is a RubyMotion wrapper inspired by Formotion for creating OS X status bar menus with a syntax that should feel familiar if you've used Formotion.
+[![Build Status](https://travis-ci.org/codelation/menu-motion.svg)](https://travis-ci.org/codelation/menu-motion)
+[![Code Climate](https://codeclimate.com/github/codelation/menu-motion.png)](https://codeclimate.com/github/codelation/menu-motion)
+
+MenuMotion is a [RubyMotion](http://www.rubymotion.com) wrapper inspired by [Formotion](https://github.com/clayallsopp/formotion) for creating OS X status bar menus with a syntax that should feel familiar if you've used Formotion.
 
 ## Installation
 
@@ -67,12 +70,10 @@ menu = MenuMotion::Menu.new({
   }, {
     rows: [{
       title: "About MenuMotion",
-      target: self,
-      action: "about"
+      action: "orderFrontStandardAboutPanel:"
     }, {
       title: "Quit",
-      target: self,
-      action: "quit"
+      action: "terminate:"
     }]
   }]
 })
@@ -137,23 +138,69 @@ def action_with_sender(sender)
 end
 ```
 
+### Keyboard Shortcuts
+
+Keyboard shortcuts can be assigned to menu items with a simple string.
+The string can include multiple modifier keys, followed by the final key to be assigned (`{modifier+}{modifier+}{key}`):
+
+```ruby
+menu = MenuMotion::Menu.new({
+  rows: [{
+    title: "Item 1",
+    shortcut: "command+1"
+  }, {
+    title: "Item 2",
+    shortcut: "control+shift+2"
+  }]
+})
+```
+
+#### Modifier Key Options
+
+- **`shift`**
+- **`control`**, `ctl`, `ctrl`
+- **`option`**, `opt`, `alt`, `alternate`
+- **`command`**, `cmd`
+
+### Validation
+
+MenuMotion implements the [NSMenuValidation](https://developer.apple.com/library/mac/documentation/cocoa/reference/applicationkit/Protocols/NSMenuValidation_Protocol/Reference/Reference.html) protocol. Pass a proc to a menu item on `validate`:
+
+```ruby
+menu = MenuMotion::Menu.new({
+  rows: [{
+    title: "Menu item",
+    tag: :main_item
+    rows: [{
+      title: "Submenu item 1",
+      tag: :submenu_item1,
+      target: self,
+      action: "do_something:",
+      validate: ->(menu_item) {
+        true # or false
+      }
+    }]
+  }]
+})
+```
+
 ### Updating Menu Items
 
-Assign keys to menu items that will need to be updated.
+Assign tags to menu items that will need to be updated.
 
 ```ruby
 menu = MenuMotion::Menu.new({
   rows: [{
     title: "Menu item",
-    key: :main_item
+    tag: :main_item
     rows: [{
       title: "Submenu item 1",
-      key: :submenu_item1,
+      tag: :submenu_item1,
       target: self,
       action: "do_something:"
     }, {
       title: "Submenu item 2",
-      key: :submenu_item2,
+      tag: :submenu_item2,
       target: self,
       action: "do_something:"
     }]
@@ -161,13 +208,13 @@ menu = MenuMotion::Menu.new({
 })
 
 # Let's update the first item's title:
-menu.update(:main_item, {
+menu.update_item_with_tag(:main_item, {
   title: "Hello World"
 })
 
 # And give the first submenu item a submenu.
 # The target and action will not be used if a submenu is defined.
-menu.update(:submenu_item1, {
+menu.update_item_with_tag(:submenu_item1, {
   rows: [{
     title: "Click me",
     target: self,
@@ -176,6 +223,11 @@ menu.update(:submenu_item1, {
 })
 ```
 
+## TODO
+
+- Menu Item Icons
+- Keyboard Shortcuts
+
 ## Contributing
 
 1. Fork it

data/lib/menu_motion/menu.rb

@@ -2,34 +2,25 @@ module MenuMotion
 
   class Menu < NSMenu
 
-    attr_accessor :menu_items
-    attr_accessor :root_menu
+    attr_accessor :menu_items, :root_menu
 
     def add_rows_to_menu(menu, rows)
       rows.each do |row|
-        menu_item = NSMenuItem.alloc.initWithTitle(row[:title], action: row[:action], keyEquivalent:"")
-        menu_item.target = row[:target]
-
-        # Add sections and/or rows to a submenu
-        if row[:sections]
-          submenu = MenuMotion::Menu.new({
-            sections: row[:sections]
-          }, self.root_menu || self)
-          menu_item.setSubmenu(submenu)
-        elsif row[:rows]
-          submenu = MenuMotion::Menu.new({
-            rows: row[:rows]
-          }, self.root_menu || self)
-          menu_item.setSubmenu(submenu)
-        end
+        row[:root_menu] = WeakRef.new(self.root_menu || self)
+        menu_item = MenuMotion::MenuItem.new(row)
+        menu_item.target = self
+        menu_item.action = "perform_action:"
+
+        if tag = row[:tag]
+          tag = tag.to_sym
+          menu_item.tag = tag
 
-        if row[:key]
           if self.root_menu
             self.root_menu.menu_items ||= {}
-            self.root_menu.menu_items[row[:key].to_sym] = WeakRef.new(menu_item)
+            self.root_menu.menu_items[tag] = WeakRef.new(menu_item)
           else
             self.menu_items ||= {}
-            self.menu_items[row[:key].to_sym] = WeakRef.new(menu_item)
+            self.menu_items[tag] = WeakRef.new(menu_item)
           end
         end
 
@@ -59,7 +50,11 @@ module MenuMotion
     end
 
     def initialize(params = {}, root_menu = nil)
-      super()
+      if params[:title]
+        initWithTitle(params[:title])
+      else
+        super()
+      end
 
       self.root_menu = root_menu
       self.build_menu_from_params(self, params)
@@ -67,22 +62,24 @@ module MenuMotion
       self
     end
 
-    def item_with_key(key)
+    def item_with_tag(tag)
       @menu_items ||= {}
-      @menu_items[key.to_sym]
+      @menu_items[tag.to_sym]
     end
 
-    def update(key, params)
-      menu_item = self.item_with_key(key)
+    def perform_action(menu_item)
+      menu_item.perform_action
+    end
 
-      menu_item.title  = params[:title]  if params[:title]
-      menu_item.target = params[:target] if params[:target]
-      menu_item.action = params[:action] if params[:action]
+    def update_item_with_tag(tag, params)
+      menu_item = self.item_with_tag(tag)
+      menu_item.update(params)
+    end
 
-      self
+    def validateMenuItem(menu_item)
+      menu_item.valid?
     end
 
   end
 
 end
-

data/lib/menu_motion/menu_item.rb

@@ -0,0 +1,106 @@
+module MenuMotion
+
+  class MenuItem < NSMenuItem
+
+    attr_accessor :item_action, :item_target,
+                  :root_menu, :tag, :validate
+
+    def initialize(params = {})
+      super()
+      update(params)
+      self
+    end
+
+    def perform_action
+      if self.valid? && self.valid_target_and_action?
+        if self.item_action.to_s.end_with?(":")
+          self.item_target.performSelector(self.item_action, withObject: self)
+        else
+          self.item_target.performSelector(self.item_action)
+        end
+      end
+    end
+
+    def update(params)
+      self.item_action = params[:action]    if params.has_key?(:action)
+      self.item_target = params[:target]    if params.has_key?(:target)
+      self.root_menu   = params[:root_menu] if params.has_key?(:root_menu)
+      self.title       = params[:title]     if params.has_key?(:title)
+      self.validate    = params[:validate]  if params.has_key?(:validate)
+
+      # Set NSApp as the default target if no other target is given
+      if self.item_action && self.item_target.nil?
+        self.item_target = NSApp
+      end
+
+      # Setup submenu and keyboard shortcut
+      set_submenu_from_params(params)
+      set_keyboard_shortcut(params[:shortcut]) if params.has_key?(:shortcut)
+
+      self
+    end
+
+    def valid?
+      if self.submenu || self.valid_target_and_action?
+        if self.validate.nil?
+          true
+        else
+          self.validate.call(self)
+        end
+      else
+        false
+      end
+    end
+
+    def valid_target_and_action?
+      self.item_target && self.item_action && self.item_target.respond_to?(self.item_action.gsub(":", ""))
+    end
+
+  private
+
+    def set_keyboard_shortcut(shortcut)
+      if shortcut
+        keys = shortcut.gsub("-", "+").split("+")
+        key = keys.pop
+        modifier_mask = 0
+        modifier_keys = keys
+
+        modifier_keys.each do |modifier_key|
+          case modifier_key
+          when "alt", "alternate", "opt", "option"
+            modifier_mask |= NSAlternateKeyMask
+          when "cmd", "command"
+            modifier_mask |= NSCommandKeyMask
+          when "ctl", "ctrl", "control"
+            modifier_mask |= NSControlKeyMask
+          when "shift"
+            modifier_mask |= NSShiftKeyMask
+          end
+        end
+
+        self.setKeyEquivalent(key)
+        self.setKeyEquivalentModifierMask(modifier_mask)
+      else
+        self.setKeyEquivalent(nil)
+        self.setKeyEquivalentModifierMask(nil)
+      end
+    end
+
+    def set_submenu_from_params(params)
+      if params[:sections]
+        submenu = MenuMotion::Menu.new({
+          sections: params[:sections]
+        }, self.root_menu)
+        self.setSubmenu(submenu)
+      elsif params[:rows]
+        submenu = MenuMotion::Menu.new({
+          rows: params[:rows]
+        }, self.root_menu)
+        self.setSubmenu(submenu)
+      end
+    end
+
+  end
+
+end
+

data/lib/menu_motion/version.rb

@@ -1,3 +1,3 @@
 module MenuMotion
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: menu-motion
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Brian Pattison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-18 00:00:00.000000000 Z
+date: 2014-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -35,6 +35,7 @@ files:
 - README.md
 - lib/menu_motion.rb
 - lib/menu_motion/menu.rb
+- lib/menu_motion/menu_item.rb
 - lib/menu_motion/version.rb
 homepage: https://github.com/codelation/menu-motion
 licenses: