mousetrap-rails 0.0.3 → 0.0.4

data/.gitignore

@@ -16,3 +16,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+*.log
+.sass-cache

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2

data/CHANGELOG.md

@@ -1,6 +1,12 @@
+## v0.0.5.wip
+
+## v0.0.4
+
+* add key binding hints (experimental)
+
 ## v0.0.3
 
-* add development dependecies
+* add development dependencies
 * add tests for generators
 
 ## v0.0.2

data/{LICENSE.txt → LICENSE.md}

@@ -1,3 +1,5 @@
+### Gem mousetrap-rails
+
 Copyright (c) 2012 Nick Kugaevsky
 
 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:
@@ -5,3 +7,20 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 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.
+
+
+### Original Moustrap javascript library
+
+Copyright 2012 Craig Campbell
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -1,4 +1,4 @@
-# Mousetrap::Rails [![endorse](http://api.coderwall.com/kugaevsky/endorsecount.png)](http://coderwall.com/kugaevsky)
+# Mousetrap::Rails [![endorse](http://api.coderwall.com/kugaevsky/endorsecount.png)](http://coderwall.com/kugaevsky) [![Build Status](https://secure.travis-ci.org/kugaevsky/mousetrap-rails.png)](http://travis-ci.org/kugaevsky/mousetrap-rails) [![Dependency Status](https://gemnasium.com/kugaevsky/mousetrap-rails.png)](https://gemnasium.com/kugaevsky/mousetrap-rails) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/kugaevsky/mousetrap-rails)
 
 [Mousetrap](https://github.com/ccampbell/mousetrap) is a javascript library for handling keyboard shortcuts in your web applications written by [Craig Campbell](http://craig.is/).
 
@@ -21,7 +21,10 @@ And then execute:
 
     $ rails generate mousetrap:install
 
-It will create sample `keybindings.js.coffee` file in `app/assets/javascripts` and add `//= require mousetrap` to `application.js` manifest.
+It will create sample `keybindings.js.coffee` file in `app/assets/javascripts` and insert mousetrap-rails files to manifests of assert pipeline
+
+    //= require mousetrap     # ---> application.js
+    *= require moustrap       # ---> application.css
 
 Voila!
 
@@ -82,6 +85,20 @@ Mousetrap.bind 'up up down down left right left right b a enter', -> console.log
 
 You can find full documentation on [Mousetrap library page](http://craig.is/killing/mice). Really, look there – there are plenty examples of using this awesome library.
 
+### Key binding hints (experimental)
+
+You can display key binding hints near links with `data-keybinding` attribute by pressing `Alt+Shift+h`. Now it's just experimental feature for debugging purposes only.
+
+
+## Changelog
+
+All changes could be found in [CHANGELOG.md](https://github.com/kugaevsky/mousetrap-rails/blob/master/CHANGELOG.md)
+
+
+## License
+
+Gosh! It's [here](https://github.com/kugaevsky/mousetrap-rails/blob/master/LICENSE.md).
+
 
 ## Authors
 

data/Rakefile

@@ -1 +1,5 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/app/assets/stylesheets/mousetrap.css

@@ -0,0 +1,37 @@
+.mt-hotkey-el {
+  position: relative; }
+
+a[data-keybinding] .mt-hotkey-hint {
+  display: block;
+  float: right;
+  position: absolute;
+  top: -4px;
+  right: -4px;
+  z-index: 999;
+  font: bold 13px/1em sans-serif;
+  text-decoration: none;
+  text-indent: 0;
+  text-align: center;
+  vertical-align: center;
+  margin: 0;
+  padding: 0.3ex 0.7ex;
+  background: beige;
+  color: black;
+  text-shadow: 1px 1px 0 white;
+  box-shadow: 1px 1px 0 #333333;
+  border-radius: 5px;
+  border: 1px solid #888888;
+  opacity: 0.75;
+  -webkit-transition: all 0.15s linear;
+  -moz-transition: all 0.15s linear;
+  -o-transition: all 0.15s linear;
+  -ms-transition: all 0.15s linear;
+  transition: all 0.15s linear; }
+  a[data-keybinding] .mt-hotkey-hint:hover {
+    background: white;
+    opacity: 1;
+    -webkit-transform: scale(1.25);
+    -moz-transform: scale(1.25);
+    -o-transform: scale(1.25);
+    -ms-transform: scale(1.25);
+    transform: scale(1.25); }

data/app/assets/stylesheets/mousetrap.css.sass

@@ -0,0 +1,50 @@
+$mtFont:        bold 13px/1em sans-serif
+$mtBackground:  beige
+$mtColor:       black
+$mtTextShadow:  1px 1px 0 white
+$mtBoxShadow:   1px 1px 0 #333
+$mtOpacity:     .75
+
+@mixin transition($styles)
+  -webkit-transition: $styles
+  -moz-transition: $styles
+  -o-transition: $styles
+  -ms-transition: $styles
+  transition: $styles
+
+@mixin transform($styles)
+  -webkit-transform: $styles
+  -moz-transform: $styles
+  -o-transform: $styles
+  -ms-transform: $styles
+  transform: $styles
+
+.mt-hotkey-el
+  position: relative
+a[data-keybinding]
+  .mt-hotkey-hint
+    display: block
+    float: right
+    position: absolute
+    top: -4px
+    right: -4px
+    z-index: 999
+    font: $mtFont
+    text-decoration: none
+    text-indent: 0
+    text-align: center
+    vertical-align: center
+    margin: 0
+    padding: 0.3ex 0.7ex
+    background: $mtBackground
+    color: $mtColor
+    text-shadow: $mtTextShadow
+    box-shadow: $mtBoxShadow
+    border-radius: 5px
+    border: 1px solid #888
+    opacity: $mtOpacity
+    @include transition(all .15s linear)
+    &:hover
+      background: white
+      opacity: $mtOpacity + 0.25
+      @include transform(scale(1.25))

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

@@ -8,13 +8,21 @@ module Mousetrap
         copy_file "keybindings.js.coffee", "app/assets/javascripts/keybindings.js.coffee"
       end
 
-      def add_assets
+      def add_javascript_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
+
+      def add_css_assets
+        if File.exist?('app/assets/stylesheets/application.css')
+          insert_into_file "app/assets/stylesheets/application.css", "*= require mousetrap\n ", :before => "*= require_tree ."
+        else
+          copy_file "application.css", "app/assets/stylesheets/application.css"
+        end
+      end
     end
   end
 end

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

@@ -0,0 +1,14 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require mousetrap
+ *= require_tree .
+ */

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

@@ -1,10 +1,10 @@
 $ ->
-  # Hotkey binding to links with 'data-keybindings' attribute
+  # Hotkey binding to links with 'data-keybinding' 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
+  # Hotkey binding to inputs with 'data-keybinding' attribute
   # Focus input when hotkey pressed
   $('input[data-keybinding]').each (i, el) ->
     Mousetrap.bind $(el).data('keybinding'), (e) ->
@@ -13,3 +13,25 @@ $ ->
         e.preventDefault()
       else
         e.returnValue = false
+
+  # Toggle show/hide hotkey hints
+  window.mouseTrapRails =
+    showOnLoad: false           # Show/hide hotkey hints by default (on page load). Mostly for debugging purposes.
+    toggleKeys: 'alt+shift+h'   # Key sequence to toggle hints visibility.
+    keysShown: false
+    toggleHints:  ->
+      $('a[data-keybinding]').each (i, el) ->
+        $el = $(el)
+        if mouseTrapRails.keysShown
+          $el.removeClass('mt-hotkey-el').find('.mt-hotkey-hint').remove()
+        else
+          mtKey = $el.data('keybinding')
+          $hint = "<i class='mt-hotkey-hint' title='Press \<#{mtKey}\> to open link'>#{mtKey}</i>"
+          $el.addClass('mt-hotkey-el') unless $el.css('position') is 'absolute'
+          $el.append $hint
+      @keysShown ^= true
+
+  Mousetrap.bind mouseTrapRails.toggleKeys, -> mouseTrapRails.toggleHints()
+
+  mouseTrapRails.toggleHints() if mouseTrapRails.showOnLoad
+

data/lib/mousetrap-rails/version.rb

@@ -1,5 +1,5 @@
 module Mousetrap
   module Rails
-    VERSION = "0.0.3"
+    VERSION = "0.0.4"
   end
 end

data/mousetrap-rails.gemspec

@@ -17,10 +17,11 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_development_dependency 'rails'
-  gem.add_development_dependency 'sqlite3'
-  gem.add_development_dependency 'rspec-rails'
-  gem.add_development_dependency 'genspec'
+  gem.add_development_dependency 'rails', '~> 3.2.1'
+  gem.add_development_dependency 'sqlite3', '~> 1.3.5'
+  gem.add_development_dependency 'rspec-rails', '~> 2.11.0'
+  gem.add_development_dependency 'genspec', '~> 0.2.7'
+  gem.add_development_dependency 'sass', '~> 3.2.1'
 
   gem.licenses      = ['MIT', 'Apache']
   gem.post_install_message =  <<MSG

data/spec/generators/install_generator_spec.rb

@@ -1,8 +1,6 @@
 require 'spec_helper'
 
 describe Mousetrap::Generators::InstallGenerator do
-  # subject { Mousetrap::Generators::InstallGenerator }
-
   context "with mousetrap:install" do
     it "should generate keybindings.js.coffee file" do
       subject.should generate("app/assets/javascripts/keybindings.js.coffee") { |content|
@@ -15,5 +13,11 @@ describe Mousetrap::Generators::InstallGenerator do
         content.should =~ /\/\/= require mousetrap\n/
       }
     end
+
+    it "should inject require mousetrap into application.css" do
+      subject.should generate("app/assets/stylesheets/application.css") { |content|
+        content.should =~ /\s\*= require mousetrap\n/
+      }
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mousetrap-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,72 +9,88 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-23 00:00:00.000000000 Z
+date: 2012-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.2.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.2.1
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.5
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.11.0
 - !ruby/object:Gem::Dependency
   name: genspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.7
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.1
 description: Mousetrap is a javascript library for handling keyboard shortcuts in
   your web applications. This gem integrates Mousetrap with Rails asset pipeline for
   easy of use.
@@ -85,13 +101,17 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - CHANGELOG.md
 - Gemfile
-- LICENSE.txt
+- LICENSE.md
 - README.md
 - Rakefile
+- app/assets/stylesheets/mousetrap.css
+- app/assets/stylesheets/mousetrap.css.sass
 - lib/generators/mousetrap/install/USAGE
 - lib/generators/mousetrap/install/install_generator.rb
+- lib/generators/mousetrap/install/templates/application.css
 - lib/generators/mousetrap/install/templates/application.js
 - lib/generators/mousetrap/install/templates/keybindings.js.coffee
 - lib/mousetrap-rails.rb
@@ -129,7 +149,6 @@ files:
 - spec/dummy/lib/assets/.gitkeep
 - spec/dummy/log/.gitkeep
 - spec/dummy/log/development.log
-- spec/dummy/log/test.log
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html
@@ -156,7 +175,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1311093102559047194
+      hash: 1496954347725522784
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -165,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1311093102559047194
+      hash: 1496954347725522784
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -203,7 +222,6 @@ test_files:
 - spec/dummy/lib/assets/.gitkeep
 - spec/dummy/log/.gitkeep
 - spec/dummy/log/development.log
-- spec/dummy/log/test.log
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
 - spec/dummy/public/500.html

data/spec/dummy/log/test.log

@@ -1,152 +0,0 @@
-Connecting to database specified by database.yml
-Connecting to database specified by database.yml
-   (0.2ms)  begin transaction
-   (0.0ms)  rollback transaction
-Connecting to database specified by database.yml
-Connecting to database specified by database.yml
-Connecting to database specified by database.yml
-Connecting to database specified by database.yml
-Connecting to database specified by database.yml
-Connecting to database specified by database.yml
-Connecting to database specified by database.yml
-Connecting to database specified by database.yml
-Connecting to database specified by database.yml
-   (0.2ms)  begin transaction
-   (0.1ms)  rollback transaction
-Connecting to database specified by database.yml
-   (0.2ms)  begin transaction
-   (0.0ms)  rollback transaction
-Connecting to database specified by database.yml
-   (0.3ms)  begin transaction
-   (0.1ms)  rollback transaction
-Connecting to database specified by database.yml
-   (0.2ms)  begin transaction
-   (0.1ms)  rollback transaction
-Connecting to database specified by database.yml
-   (0.2ms)  begin transaction
-   (0.1ms)  rollback transaction
-Connecting to database specified by database.yml
-   (0.2ms)  begin transaction
-   (0.1ms)  rollback transaction
-Connecting to database specified by database.yml
-   (0.2ms)  begin transaction
-   (0.1ms)  rollback transaction
-Connecting to database specified by database.yml
-Connecting to database specified by database.yml
-Connecting to database specified by database.yml
-Connecting to database specified by database.yml
-Connecting to database specified by database.yml
-Connecting to database specified by database.yml
-   (0.2ms)  begin transaction
-   (0.1ms)  rollback transaction
-Connecting to database specified by database.yml
-Connecting to database specified by database.yml
-Connecting to database specified by database.yml
-Connecting to database specified by database.yml
-Connecting to database specified by database.yml
-   (0.2ms)  begin transaction
-   (0.1ms)  rollback transaction
-Connecting to database specified by database.yml
-   (0.2ms)  begin transaction
-   (0.1ms)  rollback transaction
-Connecting to database specified by database.yml
-   (0.2ms)  begin transaction
-   (0.1ms)  rollback transaction
-Connecting to database specified by database.yml
-   (0.2ms)  begin transaction
-   (0.1ms)  rollback transaction
-Connecting to database specified by database.yml
-   (0.2ms)  begin transaction
-   (0.1ms)  rollback transaction
-Connecting to database specified by database.yml
-   (0.2ms)  begin transaction
-   (0.1ms)  rollback transaction
-Connecting to database specified by database.yml
-   (0.2ms)  begin transaction
-   (0.1ms)  rollback transaction
-Connecting to database specified by database.yml
-   (0.2ms)  begin transaction
-   (0.1ms)  rollback transaction
-Connecting to database specified by database.yml
-   (0.2ms)  begin transaction
-   (0.0ms)  rollback transaction
-Connecting to database specified by database.yml
-   (0.2ms)  begin transaction
-   (0.1ms)  rollback transaction
-   (0.1ms)  begin transaction
-   (0.1ms)  rollback transaction
-Connecting to database specified by database.yml
-   (0.2ms)  begin transaction
-   (0.1ms)  rollback transaction
-   (0.0ms)  begin transaction
-   (0.0ms)  rollback transaction
-Connecting to database specified by database.yml
-   (0.2ms)  begin transaction
-   (0.1ms)  rollback transaction
-   (0.0ms)  begin transaction
-   (0.0ms)  rollback transaction
-Connecting to database specified by database.yml
-   (0.2ms)  begin transaction
-   (0.1ms)  rollback transaction
-   (0.1ms)  begin transaction
-   (0.0ms)  rollback transaction
-Connecting to database specified by database.yml
-   (0.2ms)  begin transaction
-   (0.1ms)  rollback transaction
-   (0.0ms)  begin transaction
-   (0.0ms)  rollback transaction
-Connecting to database specified by database.yml
-   (0.2ms)  begin transaction
-   (0.1ms)  rollback transaction
-   (0.0ms)  begin transaction
-   (0.0ms)  rollback transaction
-Connecting to database specified by database.yml
-   (0.2ms)  begin transaction
-   (0.1ms)  rollback transaction
-   (0.0ms)  begin transaction
-   (0.0ms)  rollback transaction
-Connecting to database specified by database.yml
-   (0.2ms)  begin transaction
-   (0.0ms)  rollback transaction
-   (0.1ms)  begin transaction
-   (0.0ms)  rollback transaction
-Connecting to database specified by database.yml
-   (0.2ms)  begin transaction
-   (0.1ms)  rollback transaction
-   (0.0ms)  begin transaction
-   (0.1ms)  rollback transaction
-Connecting to database specified by database.yml
-   (0.2ms)  begin transaction
-   (0.1ms)  rollback transaction
-   (0.0ms)  begin transaction
-   (0.1ms)  rollback transaction
-Connecting to database specified by database.yml
-   (0.2ms)  begin transaction
-   (0.0ms)  rollback transaction
-   (0.0ms)  begin transaction
-   (0.0ms)  rollback transaction
-Connecting to database specified by database.yml
-   (0.2ms)  begin transaction
-   (0.1ms)  rollback transaction
-   (0.0ms)  begin transaction
-   (0.0ms)  rollback transaction
-Connecting to database specified by database.yml
-   (0.2ms)  begin transaction
-   (0.1ms)  rollback transaction
-   (0.0ms)  begin transaction
-   (0.0ms)  rollback transaction
-Connecting to database specified by database.yml
-   (0.2ms)  begin transaction
-   (0.1ms)  rollback transaction
-   (0.0ms)  begin transaction
-   (0.0ms)  rollback transaction
-Connecting to database specified by database.yml
-   (0.2ms)  begin transaction
-   (0.1ms)  rollback transaction
-   (0.1ms)  begin transaction
-   (0.0ms)  rollback transaction
-Connecting to database specified by database.yml
-   (0.2ms)  begin transaction
-   (0.1ms)  rollback transaction
-   (0.0ms)  begin transaction
-   (0.0ms)  rollback transaction