wacky 0.1.4 → 0.1.5

data/README.md

@@ -8,6 +8,12 @@ Features:
 
 - versioning
 - realtime markdown preview
+- title extraction
+- keyboard shortcuts
+  - `e` to edit the current page
+  - `v` to see the versions
+  - `?` to see the help
+  - `ESC` to hide the help
 
 ### Installation
 

data/app/assets/javascripts/wacky/keyboard.js.coffee

@@ -0,0 +1,49 @@
+$ ->
+  helpContainer = ->
+    $('.wacky-keyboard-commands')
+
+  eKeyPressed = (e) ->
+    e.which == 69
+
+  vKeyPressed = (e) ->
+    e.which == 86
+
+  questionMarkPressed = (e) ->
+    e.shiftKey && e.which == 191
+
+  escPressed = (e) ->
+    e.which == 27
+
+  goToEditPage = ->
+    if editPageLink()
+      window.location = editPageLink().href
+
+  goToPageVersions = ->
+    if pageVersionsLink()
+      window.location = pageVersionsLink().href
+
+  editPageLink = ->
+    $('a[rel=edit-page]')[0]
+
+  pageVersionsLink = ->
+    $('a[rel=page-versions]')[0]
+
+  showHelp = ->
+    helpContainer().show()
+
+  hideHelp = ->
+    helpContainer().hide()
+
+  $(window).on 'keyup', (e) ->
+    if eKeyPressed(e)
+      goToEditPage()
+    if vKeyPressed(e)
+      goToPageVersions()
+    if escPressed(e)
+      hideHelp()
+
+  $(window).on 'keydown', (e) ->
+    if questionMarkPressed(e)
+      showHelp()
+
+  hideHelp()

data/app/assets/stylesheets/wacky/help.css.scss

@@ -0,0 +1,12 @@
+.wacky-keyboard-commands {
+  dl {
+    dt {
+      font-weight: bold;
+      width: 50px;
+      text-align: right;
+    }
+    dt, dd {
+      display: inline-block;
+    }
+  }
+}

data/app/views/wacky/pages/_help.html.slim

@@ -0,0 +1,17 @@
+.wacky-keyboard-commands
+  h4 Keyboard commands
+  dl
+    dt e
+    dd Edit Page
+
+  dl
+    dt v
+    dd Page Versions
+
+  dl
+    dt ?
+    dd Show Help
+
+  dl
+    dt ESC
+    dd Hide Help

data/app/views/wacky/pages/show.html.slim

@@ -1,5 +1,7 @@
+= render 'help'
+
 = @page.to_html.html_safe
 
 ul.actions
-  li= link_to "Edit", edit_page_path(@page)
-  li= link_to "Versions", versions_page_path(@page)
+  li= link_to "Edit", edit_page_path(@page), rel: 'edit-page'
+  li= link_to "Versions", versions_page_path(@page), rel: 'page-versions'

data/lib/wacky/version.rb

@@ -1,3 +1,3 @@
 module Wacky
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wacky
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
   prerelease: 
 platform: ruby
 authors:
@@ -356,6 +356,7 @@ extra_rdoc_files: []
 files:
 - app/views/layouts/wacky/application.html.slim
 - app/views/wacky/special_pages/recently_updated.html.slim
+- app/views/wacky/pages/_help.html.slim
 - app/views/wacky/pages/versions.html.slim
 - app/views/wacky/pages/new.html.slim
 - app/views/wacky/pages/version.html.slim
@@ -365,9 +366,11 @@ files:
 - app/models/wacky/extracts_title.rb
 - app/assets/javascripts/wacky/ace.js
 - app/assets/javascripts/wacky/showdown.js
+- app/assets/javascripts/wacky/keyboard.js.coffee
 - app/assets/javascripts/wacky/application.js
 - app/assets/stylesheets/wacky/ace.css.scss
 - app/assets/stylesheets/wacky/application.css
+- app/assets/stylesheets/wacky/help.css.scss
 - app/controllers/wacky/special_pages_controller.rb
 - app/controllers/wacky/application_controller.rb
 - app/controllers/wacky/pages_controller.rb