mac-key_code 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d82745a5c02d07bc21ecabdab71f9a27fa846446
+  data.tar.gz: 3969b36bf047625a4fdaa36add24f99d15d63863
+SHA512:
+  metadata.gz: 6cd0fe6108e686e102aee0e06d6875f551c455f9d57a284b360e099440980cca1da07c8d12b9746bfdd5cc40311599dbda37ec542980c48c1e58149c3232b4d9
+  data.tar.gz: cd45bfabb68387bc1b33ab627f687393f18e40783436f4fd3a52e8a1818f9d61ad72f29ea109976dd10de72416a340da7c805101e3b7a2f8d8caf6bb66f71dea

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.log
+*.o
+Makefile

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mac-key_code.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 youpy
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+# mac-key_code
+
+A key code library for mac.
+It supports any keyboard layouts such as QWERTY, Dvorak etc.
+
+It is based on http://stackoverflow.com/a/1971027
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mac-key_code'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mac-key_code
+
+## Usage
+
+```ruby
+require 'mac-key_code'
+
+key_code = Mac::KeyCode.new(38)
+key_code.to_s # => 'j'
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/youpy/mac-key_code/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,29 @@
+require 'rake'
+require 'rake/clean'
+require "bundler/gem_tasks"
+
+ext_names = %w/key_code_native/
+ext_names.each do |ext_name|
+  CLEAN.include Dir.glob("ext/#{ext_name}/*{.o,.log}")
+  CLEAN.include "ext/#{ext_name}/Makefile"
+  CLOBBER.include "ext/#{ext_name}/#{ext_name}.bundle"
+  CLOBBER.include "lib/#{ext_name}.bundle"
+
+  file "lib/#{ext_name}.bundle" =>
+    Dir.glob("ext/#{ext_name}/*{.rb,.c}") do
+    Dir.chdir("ext/#{ext_name}") do
+      ruby "extconf.rb"
+      sh "make"
+    end
+    cp "ext/#{ext_name}/#{ext_name}.bundle", "lib/"
+  end
+
+  task :spec => "lib/#{ext_name}.bundle"
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec

data/ext/key_code_native/extconf.rb

@@ -0,0 +1,14 @@
+require "mkmf"
+
+extension_name = 'key_code_native'
+dir_config(extension_name)
+
+$LDFLAGS += ' -framework AppKit'
+
+begin
+  MACRUBY_VERSION # Only MacRuby has this constant.
+  $CFLAGS += ' -fobjc-gc' # Enable MacOSX's GC for MacRuby
+rescue
+end
+
+create_makefile(extension_name)

data/ext/key_code_native/key_code_native.c

@@ -0,0 +1,115 @@
+#include <CoreFoundation/CoreFoundation.h>
+#include <Carbon/Carbon.h> /* For kVK_ constants, and TIS functions. */
+#include <ruby.h>
+
+/* based on http://stackoverflow.com/a/1971027 */
+
+VALUE CFString2RString(CFStringRef str) {
+  int stringSize;
+  char *tmpptr;
+  VALUE result;
+
+  stringSize = CFStringGetMaximumSizeForEncoding(CFStringGetLength(str), kCFStringEncodingUTF8) + 1;
+  tmpptr = (char *)malloc(sizeof(char) * stringSize);
+  CFStringGetCString(str, tmpptr, stringSize, kCFStringEncodingUTF8);
+  result = rb_str_new2(tmpptr);
+  free(tmpptr);
+
+  return result;
+}
+
+/* Returns string representation of key, if it is printable.
+ * Ownership follows the Create Rule; that is, it is the caller's
+ * responsibility to release the returned object. */
+CFStringRef createStringForKey(CGKeyCode keyCode)
+{
+  TISInputSourceRef currentKeyboard = TISCopyCurrentKeyboardInputSource();
+  CFDataRef layoutData =
+    TISGetInputSourceProperty(currentKeyboard,
+                              kTISPropertyUnicodeKeyLayoutData);
+  const UCKeyboardLayout *keyboardLayout =
+    (const UCKeyboardLayout *)CFDataGetBytePtr(layoutData);
+
+  UInt32 keysDown = 0;
+  UniChar chars[4];
+  UniCharCount realLength;
+
+  UCKeyTranslate(keyboardLayout,
+                 keyCode,
+                 kUCKeyActionDisplay,
+                 0,
+                 LMGetKbdType(),
+                 kUCKeyTranslateNoDeadKeysBit,
+                 &keysDown,
+                 sizeof(chars) / sizeof(chars[0]),
+                 &realLength,
+                 chars);
+  CFRelease(currentKeyboard);
+
+  return CFStringCreateWithCharacters(kCFAllocatorDefault, chars, 1);
+}
+
+/* Returns key code for given character via the above function, or UINT16_MAX
+ * on error. */
+CGKeyCode keyCodeForChar(const char c)
+{
+  static CFMutableDictionaryRef charToCodeDict = NULL;
+  CGKeyCode code;
+  UniChar character = c;
+  CFStringRef charStr = NULL;
+
+  /* Generate table of keycodes and characters. */
+  if (charToCodeDict == NULL) {
+    size_t i;
+    charToCodeDict = CFDictionaryCreateMutable(kCFAllocatorDefault,
+                                               128,
+                                               &kCFCopyStringDictionaryKeyCallBacks,
+                                               NULL);
+    if (charToCodeDict == NULL) return UINT16_MAX;
+
+    /* Loop through every keycode (0 - 127) to find its current mapping. */
+    for (i = 0; i < 128; ++i) {
+      CFStringRef string = createStringForKey((CGKeyCode)i);
+      if (string != NULL) {
+        CFDictionaryAddValue(charToCodeDict, string, (const void *)i);
+        CFRelease(string);
+      }
+    }
+  }
+
+  charStr = CFStringCreateWithCharacters(kCFAllocatorDefault, &character, 1);
+
+  /* Our values may be NULL (0), so we need to use this function. */
+  if (!CFDictionaryGetValueIfPresent(charToCodeDict, charStr,
+                                     (const void **)&code)) {
+    code = UINT16_MAX;
+  }
+
+  CFRelease(charStr);
+  return code;
+}
+
+static VALUE mKeyCodeNative_key_code_to_char(int argc, VALUE *argv, VALUE self)
+{
+  VALUE key_code;
+
+  int intKey_code;
+  CFStringRef c;
+
+  rb_scan_args(argc, argv, "1", &key_code);
+
+
+  intKey_code = NUM2INT(key_code);
+
+  c = createStringForKey((CGKeyCode)intKey_code);
+
+  return CFString2RString(c);
+}
+
+void Init_key_code_native(void){
+  VALUE rb_mMac, rb_mKeyCodeNative;
+
+  rb_mMac = rb_define_module("Mac");
+  rb_mKeyCodeNative = rb_define_module_under(rb_mMac, "KeyCodeNative");
+  rb_define_singleton_method(rb_mKeyCodeNative, "key_code_to_char", mKeyCodeNative_key_code_to_char, -1);
+}

data/lib/mac/key_code/version.rb

@@ -0,0 +1,5 @@
+module Mac
+  class KeyCode
+    VERSION = "0.0.1"
+  end
+end

data/lib/mac/key_code.rb

@@ -0,0 +1,19 @@
+require "mac/key_code/version"
+require "key_code_native"
+
+module Mac
+  class KeyCode
+    def initialize(key_code)
+      @key_code = key_code
+      @char = KeyCodeNative.key_code_to_char(@key_code)
+    end
+
+    def printable?
+      @char =~ /^[[:print:]\s]+/
+    end
+
+    def to_s
+      @char
+    end
+  end
+end

data/lib/mac-key_code.rb

@@ -0,0 +1 @@
+require 'mac/key_code'

data/mac-key_code.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mac/key_code/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mac-key_code"
+  spec.version       = Mac::KeyCode::VERSION
+  spec.authors       = ["youpy"]
+  spec.email         = ["youpy@buycheapviagraonlinenow.com"]
+  spec.summary       = %q{A key code library for mac}
+  spec.description   = %q{A key code library for mac. It supports any keyboard layouts such as QWERTY, Dvorak etc.}
+  spec.homepage      = "https://github.com/youpy/mac-key_code"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14"
+end

data/spec/mac/key_code_spec.rb

@@ -0,0 +1,79 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+include Mac
+
+# TODO: support key lauouts other than QWERTY
+
+describe KeyCode do
+  describe '.new' do
+    subject do
+      KeyCode.new(key_code)
+    end
+
+    context 'key code for space key' do
+      let(:key_code) do
+        49
+      end
+
+      it do
+        should be_printable
+      end
+
+      it do
+        subject.to_s.should eql(' ')
+      end
+    end
+
+    context 'key code for tab key' do
+      let(:key_code) do
+        48
+      end
+
+      it do
+        should be_printable
+      end
+
+      it do
+        subject.to_s.should eql("\t")
+      end
+    end
+
+    context 'key code for "j"' do
+      let(:key_code) do
+        38
+      end
+
+      it do
+        should be_printable
+      end
+
+      it do
+        subject.to_s.should eql('j')
+      end
+    end
+
+    context 'key code for return key' do
+      let(:key_code) do
+        36
+      end
+
+      it do
+        should be_printable
+      end
+
+      it do
+        subject.to_s.should eql("\r")
+      end
+    end
+
+    context 'key code for non-printable key' do
+      let(:key_code) do
+        96
+      end
+
+      it do
+        should_not be_printable
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'mac-key_code'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: mac-key_code
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- youpy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: A key code library for mac. It supports any keyboard layouts such as
+  QWERTY, Dvorak etc.
+email:
+- youpy@buycheapviagraonlinenow.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ext/key_code_native/extconf.rb
+- ext/key_code_native/key_code_native.c
+- lib/mac-key_code.rb
+- lib/mac/key_code.rb
+- lib/mac/key_code/version.rb
+- mac-key_code.gemspec
+- spec/mac/key_code_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/youpy/mac-key_code
+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.2.1
+signing_key: 
+specification_version: 4
+summary: A key code library for mac
+test_files:
+- spec/mac/key_code_spec.rb
+- spec/spec_helper.rb