mousetrap-rails 0.0.1 → 0.0.2

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v0.0.2
+
+* add rails generator for mousetrap
+
 ## v0.0.1
 
 * initial release

data/README.md

@@ -1,12 +1,13 @@
-# Mousetrap::Rails
+# Mousetrap::Rails [![endorse](http://api.coderwall.com/kugaevsky/endorsecount.png)](http://coderwall.com/kugaevsky)
 
 [Moustrap](https://github.com/ccampbell/mousetrap) is a javascript library for handling keyboard shortcuts in your web applications written by [Craig Campbell](http://craig.is/).
 
 The `mousetrap-rails` gem integrates Moustrap javascript library with Rails Asset Pipeline.
 
+
 ## Installation
 
-### Install mousetrap-rails gem
+### Add mousetrap-rails gem to app
 
 Add this line to your application's Gemfile:
 
@@ -16,26 +17,77 @@ And then execute:
 
     $ bundle install
 
-### Include moustrap to asset pipeline
+### Run generator
 
-Add to your `app/assets/javascripts/application.js` file
+    $ rails generate mousetrap:install
 
-    //= require mousetrap
+It will create sample `keybindings.js.coffee` file in `app/assets/javascripts` and add `//= require mousetrap` to `application.js` manifest.
 
 Voila!
 
+### Latest (may be unstable) version
+
+Instead of `gem 'mousetrap-rails'` add to your Gemfile
+
+    gem 'mousetrap-rails', git: 'git://github.com/kugaevsky/mousetrap-rails.git'
+
+
 ## Usage
 
-Now you can use Moustrap library features in your rails application. To test it out create coffeescript file in your `app/assets/javascripts` directory and add to it this code
+### Via data-attributes
+
+You can add keyboard navigation to your links by using `data-keybinding` attribute.
+
+    = link_to 'Homepage', root_path, data: { keybinding: 'h' }      # Press 'h' to navigate to homepage
+
+You can jump to input
+
+    = text_field_tag 'Username', nil, data: { keybinding: 'u' }      # Press 'u' to focus username input field
+
+### Via javascript
 
-    # app/assets/javascripts/test_hotkeys.js.coffee
-    Mousetrap.bind 's', -> console.log 's pressed!'
+Any javascript function can be called with mousetrap
 
-Run application and press `s` on your keyboard. You should see `s pressed!` message in your javascript console.
+```coffeescript
+Mousetrap.bind 'f', (e) -> alert 'My perfect function called'
+```
+
+### More examples (from official guide)
+
+```coffeescript
+# single keys
+Mousetrap.bind '4', -> alert '4 pressed!'
+Mousetrap.bind 'x', (-> alert 'x pressed!'), 'keyup'
+
+# combinations
+Mousetrap.bind 'command+shift+k', ->
+  alert 'command+shift+k pressed!'
+  false
+
+Mousetrap.bind ['command+k', 'ctrl+k'], ->
+  alert 'command+k or ctrl+k pressed!'
+  false
+
+# gmail style sequences
+Mousetrap.bind 'g i', -> console.log 'g i sequence pressed!'
+Mousetrap.bind '* a', -> console.log '* a sequence pressed!'
+
+# konami code!
+Mousetrap.bind 'up up down down left right left right b a enter', -> console.log 'You WIN!'
+```
 
 You can find full documentation on [Moustrap library page](http://craig.is/killing/mice). Really, look there – there are plenty examples of using this awesome library.
 
+
+## TODO
+
+* Generators
+* Helpers
+    * Keyboard navigation for links
+    * Keyboard navigation for inputs
+
+
 ## Authors
 
 * mousetrap-rails gem by [Nick Kugaevsky](http://kugaevsky.ru)
-* original moustrap library by [Craig Campbell](http://craig.is/).
+* original moustrap library by [Craig Campbell](http://craig.is/)

data/lib/generators/mousetrap/install/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Mousetrap generator installs mousetrap javascript library in your Rails application
+
+Example:
+    rails generate mousetrap:install
+
+    This will:
+        Create `keybindings.js.coffee' file in your `app/assets/javascripts' directory
+        And add `//= require mousetrap' line to `application.js' file to include library to Rails Asset Pipeline

data/lib/generators/mousetrap/install/install_generator.rb

@@ -0,0 +1,20 @@
+module Mousetrap
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      desc "Copy Mousetrap default files"
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_mousetrap
+        copy_file "keybindings.js.coffee", "app/assets/javascripts/keybindings.js.coffee"
+      end
+
+      def add_assets
+        if File.exist?('app/assets/javascripts/application.js')
+          insert_into_file "app/assets/javascripts/application.js", "//= require mousetrap\n", :after => "jquery_ujs\n"
+        else
+          copy_file "application.js", "app/assets/javascripts/application.js"
+        end
+      end
+    end
+  end
+end

data/lib/generators/mousetrap/install/templates/application.js

@@ -0,0 +1,10 @@
+// This is a manifest file that'll be compiled into including all the files listed below.
+// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
+// be included in the compiled file accessible from http://example.com/assets/application.js
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+//= require jquery
+//= require jquery_ujs
+//= require mousetrap
+//= require_tree .

data/lib/generators/mousetrap/install/templates/keybindings.js.coffee

@@ -0,0 +1,15 @@
+$ ->
+  # Hotkey binding to links with 'data-keybindings' attribute
+  # Navigate link when hotkey pressed
+  $('a[data-keybinding]').each (i, el) ->
+    Mousetrap.bind $(el).data('keybinding'), (e) -> el.click()
+
+  # Hotkey binding to inputs with 'data-keybindings' attribute
+  # Focus input when hotkey pressed
+  $('input[data-keybinding]').each (i, el) ->
+    Mousetrap.bind $(el).data('keybinding'), (e) ->
+      el.focus()
+      if e.preventDefault
+        e.preventDefault()
+      else
+        e.returnValue = false

data/lib/mousetrap-rails/version.rb

@@ -1,5 +1,5 @@
 module Mousetrap
   module Rails
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mousetrap-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-22 00:00:00.000000000 Z
+date: 2012-09-23 00:00:00.000000000 Z
 dependencies: []
 description: Mousetrap is a javascript library for handling keyboard shortcuts in
   your web applications. This gem integrates Mousetrap with Rails asset pipeline for
@@ -26,6 +26,10 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/generators/mousetrap/install/USAGE
+- lib/generators/mousetrap/install/install_generator.rb
+- lib/generators/mousetrap/install/templates/application.js
+- lib/generators/mousetrap/install/templates/keybindings.js.coffee
 - lib/mousetrap-rails.rb
 - lib/mousetrap-rails/engine.rb
 - lib/mousetrap-rails/railtie.rb