mac_shortcuts 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d91535e242a57348510861a2beae0b0ee659badb
+  data.tar.gz: 5a6b26615c07adf981ef46fff9a80c9e4508a9ea
+SHA512:
+  metadata.gz: 7ea230f0e82d03ae579845c839dcbadab6e4d19b214916dd8ceb6a10fda8a85783573ec4611e51e5eed71b14e62b2b5c97b4b6d0eb9dd2a32d614ab963887300
+  data.tar.gz: 1161e4498897d8da47ddb7de30cf61f4efc38887b065caf51cf3c3efc7cb642e90aac675142592fa75f821f1926637c38719dbe2619a0f4badb0c8938f7aba06

data/bin/mac_shortcuts

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+lib = File.expand_path('../lib', File.dirname(__FILE__))
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'mac_shortcuts'
+
+MacShortcuts::Command.run(ARGV)

data/lib/mac_shortcuts.rb

@@ -0,0 +1,10 @@
+
+module MacShortcuts
+  require_relative 'mac_shortcuts/version'
+
+  require 'bundler/setup'
+
+  autoload :Shortcut, 'mac_shortcuts/shortcut'
+  autoload :Command, 'mac_shortcuts/command'
+  autoload :ApplicationPreferencesFinder, 'mac_shortcuts/application_preferences_finder'
+end

data/lib/mac_shortcuts/application_preferences_finder.rb

@@ -0,0 +1,76 @@
+
+require 'rake'
+
+
+module MacShortcuts
+  class ApplicationPreferencesFinder
+    # @param [String] query
+    #
+    # @return [Array<String>] paths to preferences file
+    #
+    def self.find_with_query(query)
+      founded = Dir[File.join(preferences_path, "*.#{query}.plist")]
+      return founded unless founded.empty?
+
+      apps_dirs_paths = [
+          '/Applications',
+          File.join(Dir.home, 'Applications'),
+      ]
+
+      apps_dirs_paths.each do |apps_path|
+        founded = process_apps_paths(Dir[File.join(apps_path, "#{query}.app")])
+        return founded unless founded.empty?
+      end
+
+      return founded unless founded.empty?
+
+      # use Spotlight to find applications
+      apps_paths = `mdfind "#{query}.app"`.split("\n")
+
+      # filter out not application results
+      apps_paths.select! do |path|
+        path.end_with?('.app')
+      end
+
+      founded = process_apps_paths(apps_paths)
+
+      founded
+    end
+
+    private
+
+
+    # @return [String] base path for user application preferences
+    #
+    def self.preferences_path
+      @preferences_path ||= File.join(Dir.home, 'Library', 'Preferences')
+    end
+
+    # @param [Array<String>] apps_paths paths to applications folder
+    #
+    # @return [Array<String>] preference paths of input applications
+    #
+    def self.process_apps_paths(apps_paths)
+      apps_paths.map do |app_path|
+        preferences_path_of(app_path)
+      end
+    end
+
+    # @param [String] app_path path to application folder
+    #
+    # @return [String] preference path of input application
+    #
+    def self.preferences_path_of(app_path)
+      File.join(preferences_path, "#{self.bundle_identifier_of(app_path)}.plist")
+    end
+
+    # @param [String] app_path path to application folder, example: '/Applications/Messages.app'
+    #
+    # @return [String, nil] bundle identifier of that application
+    #
+    def self.bundle_identifier_of(app_path)
+      plist_path = "#{app_path}/Contents/Info.plist"
+      `/usr/libexec/PlistBuddy -c "Print :CFBundleIdentifier" "#{plist_path}"`.chomp
+    end
+  end
+end

data/lib/mac_shortcuts/command.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+require 'claide'
+
+module MacShortcuts
+  class PlainInformative < StandardError
+    include CLAide::InformativeError
+
+    def message
+      "[!] #{super}".red
+    end
+  end
+
+  class Command < CLAide::Command
+    require_relative 'command/set'
+
+    self.abstract_command = true
+    self.command = 'mac_shortcuts'
+    self.version = VERSION
+    self.description = 'Command line tool to modify custom shortcuts in Mac applications.'
+    self.plugin_prefixes += %w(mac_shortcuts)
+  end
+end

data/lib/mac_shortcuts/command/set.rb

@@ -0,0 +1,56 @@
+# encoding: utf-8
+
+require_relative '../command'
+
+module MacShortcuts
+  class Set < Command
+    self.summary = 'Set shortcut for application.'
+    self.arguments = [
+        CLAide::Argument.new(%w(APPLICATION PLIST_FILE), true, false),
+        CLAide::Argument.new(%w(MENU_TITLE), true, false),
+        CLAide::Argument.new(%w(SHORTCUT), true, false),
+    ]
+
+    def initialize(argv)
+      @application = argv.shift_argument
+      @menu_title = argv.shift_argument
+      @shortcut_str = argv.shift_argument
+
+      super
+    end
+
+    def validate!
+      super
+
+      help! 'You must specify APPLICATION or PLIST_FILE' if @application.nil?
+      help! 'You must specify MENU_TITLE' if @menu_title.nil?
+      help! 'You must specify SHORTCUT' if @shortcut_str.nil?
+
+      begin
+        @shortcut = Shortcut.from_pretty(@shortcut_str)
+      rescue Exception => e
+        help! e.message
+      end
+
+      @plist_path = if File.exists?(@application) && File.extname(@application) == '.plist'
+                      @application
+                    else
+                      founded = ApplicationPreferencesFinder.find_with_query(@application)
+
+                      help! "Not found location for preferences for query #{@application}" if founded.length == 0
+                      help! "Founded too many applications for query #{@application}, results are: #{founded.inspect}" if founded.length != 1
+
+                      founded.first
+                    end
+    end
+
+    def run
+      ret = system(%{defaults write "#{@plist_path}" NSUserKeyEquivalents -dict-add "#{@menu_title}" -string "#{@shortcut.to_code}"})
+      unless ret
+        exit 1
+      end
+
+      puts 'Shortcut was set, now restart application to take effect.'
+    end
+  end
+end

data/lib/mac_shortcuts/shortcut.rb

@@ -0,0 +1,118 @@
+
+module MacShortcuts
+  class Shortcut
+    attr_accessor :command
+    attr_accessor :shift
+    attr_accessor :control
+    attr_accessor :alt
+    attr_accessor :key
+
+    PRETTY_MAP = {
+        command: %w(⌘ @ cmd command),
+        alt:     %w(⌥ ~ alt option),
+        shift:   %w(⇧ $ shift),
+        control: %w(^ ^ ctrl control),
+    }.freeze
+
+    CODE_MAP = PRETTY_MAP.map { |key, values|
+      [key, values[1]]
+    }.freeze
+
+    KEYS_MAP = {
+        '→' => 'right',
+        '←' => 'left',
+    }
+
+
+    def initialize
+      @command = @shift = @control = @alt = false
+      @key = nil
+    end
+
+
+    # @param [String] shortcut_str
+    #
+    def self.from_code(shortcut_str)
+      inst = self.new
+      CODE_MAP.each do |key, value|
+        inst.send("#{key}=", shortcut_str.include?(value))
+      end
+      inst.key = shortcut_str[-1]
+      inst
+    end
+
+    # @param [String] shortcut_str
+    #
+    def self.from_pretty(shortcut_str)
+      inst = self.new
+      components = components_from_pretty(shortcut_str)
+      components.each do |cmp|
+        case cmp
+        when String
+          inst.key = cmp
+        when Symbol
+          inst.send("#{cmp}=", true)
+        end
+      end
+      inst
+    end
+
+
+    def to_s
+      components = []
+      PRETTY_MAP.each do |key, value|
+        components << value.first if self.send(key)
+      end
+      components << @key if @key
+      components.join(' + ')
+    end
+
+    def to_code
+      components = []
+      CODE_MAP.each do |key, value|
+        components << value if self.send(key)
+      end
+      components << @key if @key
+      components.join
+    end
+
+    private
+
+    # @param cmp [String]
+    #
+    # @return [Symbol, nil]
+    #
+    def self.key_for_pretty(cmp)
+      key = nil
+      PRETTY_MAP.each do |curr_key, values|
+        if values.include?(cmp)
+          key = curr_key
+          break
+        end
+      end
+      key
+    end
+
+    # @param str [String]
+    #
+    # @return [Array<Symbol, String>]
+    #
+    def self.components_from_pretty(str)
+      components = str.split(/( |\+)/)
+      components.reject! { |cmp| cmp.strip.empty? }
+      components.reject! { |cmp| cmp == '+' }
+      last = components.pop
+
+      correct_last = KEYS_MAP[last] || last
+
+      components.map! do |cmp|
+        key = key_for_pretty(cmp)
+        if key.nil?
+          raise "Unknown text for #{cmp}"
+        end
+        key
+      end
+      components + [correct_last]
+    end
+  end
+end

data/lib/mac_shortcuts/version.rb

@@ -0,0 +1,4 @@
+
+module MacShortcuts
+  VERSION = '0.1'
+end

data/mac_shortcuts.gemspec

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'mac_shortcuts/version'
+
+
+Gem::Specification.new do |s|
+  s.name        = 'mac_shortcuts'
+  s.version     = MacShortcuts::VERSION
+  s.date        = Date.today
+  s.summary     = 'Command line tool to modify custom shortcuts in Mac applications.'
+  s.description = "Command line tool to modify custom shortcuts in Mac applications.\n"
+                  'For now just adding.'
+  s.authors     = ['Roman Kříž']
+  s.email       = 'roman@kriz.io'
+
+  s.homepage    = 'https://github.com/samnung/rb-mac_shortcuts'
+  s.license     = 'MIT'
+
+  s.files       = Dir['bin/**/*'] + Dir['lib/**/*'] + ["#{s.name}.gemspec"]
+  s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files  = s.files.grep(%r{^(test|spec|features)/})
+
+  s.add_runtime_dependency 'claide', '~> 0.8'
+
+  s.add_development_dependency 'bundler', '~> 1.3'
+  s.add_development_dependency 'rspec', '~> 3.2'
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: mac_shortcuts
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Roman Kříž
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: claide
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: 'Command line tool to modify custom shortcuts in Mac applications.
+
+'
+email: roman@kriz.io
+executables:
+- mac_shortcuts
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/mac_shortcuts
+- lib/mac_shortcuts.rb
+- lib/mac_shortcuts/application_preferences_finder.rb
+- lib/mac_shortcuts/command.rb
+- lib/mac_shortcuts/command/set.rb
+- lib/mac_shortcuts/shortcut.rb
+- lib/mac_shortcuts/version.rb
+- mac_shortcuts.gemspec
+homepage: https://github.com/samnung/rb-mac_shortcuts
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Command line tool to modify custom shortcuts in Mac applications.
+test_files: []