commandz 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 702744b575b0c129c8031ffb874531ccabc57686
-  data.tar.gz: fcd2c78539f793ce8ca8d2724bcd00a03e234d95
+  metadata.gz: 331dea85970246369b095cc99b8660c3f9a93c04
+  data.tar.gz: f00a9e210a47a18b3458a6f88ea0d96ba58a331c
 SHA512:
-  metadata.gz: 49f382728b5c447021de95d10e8b7ed1a6a6386592dfd1945fda902933962fd7c99149008a4332331235ff9ab03bb499c726952cd0a9dcc06c0b872b8ba0a596
-  data.tar.gz: c349a981e728cb17c0b8fb885e4bec53d545367c9e1def72e37f833d30a112d4a949d40995df85542731a9f55d6887cbf44d8d992d932e35b3087c9a23adfbb8
+  metadata.gz: f30b30d62d585f39e024587ca28bf156493862829757104e3e23700f5ee02e55d3a2719db6449a5c5cc638f547e8654f8578da4ef3fa8962a050688a14e4d3ef
+  data.tar.gz: 410ba025d6b17e60f62f9db2a31bda7071e43401a710efa0880ace7f738b16be296bc093b7fa8cf6a9c3beb9c63e1b5a3b5d81e47a8b1f07b8c44473549fce31

data/README.md

@@ -13,6 +13,21 @@
   <a href="http://badge.fury.io/rb/commandz"><img src="https://badge.fury.io/rb/commandz@2x.png" alt="Gem Version" height="18"></a>
 </p>
 
+## Table of contents
+- [API](#api)
+  - [CommandZ.execute](#execute)
+  - [CommandZ.undo](#undo)
+  - [CommandZ.redo](#redo)
+  - [CommandZ.status](#status)
+  - [CommandZ.onChange](#onchange)
+  - [CommandZ.clear](#clear)
+  - [CommandZ.keyboardShortcuts](#keyboardshortcuts)
+- [DOM Example](#dom-example)
+- [Setup](#setup)
+  - [Rails](#rails)
+  - [Other](#other)
+- [Tests](#tests)
+
 ## API
 #### Glossary
 ```js
@@ -110,7 +125,7 @@ console.log(CommandZ.index)           // => 0
 ```
 
 ### status
-Return the current `COMMAND`.
+Return the current status.
 
 ```js
 CommandZ.execute({
@@ -123,11 +138,33 @@ CommandZ.execute({
   down: function() { console.log('down 2') }
 }) // => up 2
 
-console.log(CommandZ.status())        // => { up: function() { console.log('up 2') }, down: function() { console.log('down 2') } }
+console.log(CommandZ.status())        // => { canUndo: true, canRedo: false }
 console.log(CommandZ.commands.length) // => 2
 console.log(CommandZ.index)           // => 1
 ```
 
+### onChange
+Register a callback that will be called with the `status` every time there’s a change to the history.
+
+```js
+CommandZ.onChange(function(status) {
+  console.log(status)
+})
+
+CommandZ.execute({
+  up:   function() { 'up 1' },
+  down: function() { 'down 1' }
+}) // => { canUndo: true, canRedo: false }
+
+CommandZ.execute({
+  up:   function() { 'up 2' },
+  down: function() { 'down 2' }
+}) // => { canUndo: true, canRedo: false }
+
+CommandZ.undo() // => { canUndo: true, canRedo: true }
+CommandZ.undo() // => { canUndo: false, canRedo: true }
+```
+
 ### clear
 Clear history.
 
@@ -149,6 +186,15 @@ console.log(CommandZ.commands.length) // => 0
 console.log(CommandZ.index)           // => -1
 ```
 
+### keyboardShortcuts
+Enable or disable `CMD+Z` & `CMD+SHIFT+Z` keyboard shortcuts. These shortcuts are enabled by default.<br>
+Will only `undo()` & `redo()` if the current selected element is not an input so that it doesn’t prevent your OS default behavior.
+
+```js
+CommandZ.keyboardShortcuts(true) // default
+CommandZ.keyboardShortcuts(false)
+```
+
 ## DOM Example
 ```js
 // This example requires jQuery or Zepto

data/commandz.min.js

@@ -1,10 +1,10 @@
 /*
-* CommandZ v0.0.1
+* CommandZ v0.0.2
 * https://github.com/EtienneLem/commandz
 *
 * Copyright 2013, Etienne Lemay http://heliom.ca
 * Released under the MIT license
 *
-* Date: 2013-08-28 23:28:40 -0400
+* Date: 2013-08-29 03:07:13 -0400
 */
-(function(){var t;t=function(){function t(){this.VERSION="0.0.1",this.clear()}return t.prototype.clear=function(){return this.commands=[],this.index=-1},t.prototype.execute=function(t){var n;return this.up(t),this.index<this.commands.length-1&&(n=this.commands.length-this.index-1,this.commands.splice(-n)),this.commands.push(t),this.index=this.commands.length-1},t.prototype.undo=function(t){var n,i;if(null==t&&(t=1),!(this.index<0))for(n=i=1;t>=1?t>=i:i>=t;n=t>=1?++i:--i){if(!this.commands[this.index])return;this.down(this.commands[this.index]),this.index--}},t.prototype.redo=function(t){var n,i;if(null==t&&(t=1),!(this.index>=this.commands.length-1))for(n=i=1;t>=1?t>=i:i>=t;n=t>=1?++i:--i){if(!this.commands[this.index+1])return;this.index++,this.up(this.commands[this.index])}},t.prototype.exec=function(t,n){var i,s,e,o;if(!(n instanceof Array))return n[t]();for(o=[],s=0,e=n.length;e>s;s++)i=n[s],o.push(i[t]());return o},t.prototype.up=function(t){return this.exec("up",t)},t.prototype.down=function(t){return this.exec("down",t)},t.prototype.status=function(){return this.commands[this.index]},t}(),this.CommandZ=new t}).call(this);
+(function(){var t,n=function(t,n){return function(){return t.apply(n,arguments)}};t=function(){function t(){this.handleKeyboard=n(this.handleKeyboard,this),this.VERSION="0.0.2",this.changeCallback=null,this.clear(),this.keyboardShortcuts(!0)}return t.prototype.clear=function(){return this.commands=[],this.index=-1},t.prototype.keyboardShortcuts=function(t){var n;return null==t&&(t=!0),n=t?"addEventListener":"removeEventListener",document[n]("keypress",this.handleKeyboard)},t.prototype.handleKeyboard=function(t){return"INPUT"!==document.activeElement.nodeName&&122===t.keyCode&&t.metaKey===!0?(t.preventDefault(),t.shiftKey?this.redo():this.undo()):void 0},t.prototype.execute=function(t){var n;return this.up(t),this.index<this.commands.length-1&&(n=this.commands.length-this.index-1,this.commands.splice(-n)),this.commands.push(t),this.index=this.commands.length-1},t.prototype.undo=function(t){var n,e;if(null==t&&(t=1),this.status().canUndo)for(n=e=1;t>=1?t>=e:e>=t;n=t>=1?++e:--e){if(!this.commands[this.index])return;this.down(this.commands[this.index]),this.index--,this.handleChange()}},t.prototype.redo=function(t){var n,e;if(null==t&&(t=1),this.status().canRedo)for(n=e=1;t>=1?t>=e:e>=t;n=t>=1?++e:--e){if(!this.commands[this.index+1])return;this.index++,this.up(this.commands[this.index]),this.handleChange()}},t.prototype.exec=function(t,n){var e,i,o,s;if(!(n instanceof Array))return n[t]();for(s=[],i=0,o=n.length;o>i;i++)e=n[i],s.push(e[t]());return s},t.prototype.up=function(t){return this.exec("up",t)},t.prototype.down=function(t){return this.exec("down",t)},t.prototype.onChange=function(t){return this.changeCallback=t,this.handleChange()},t.prototype.handleChange=function(){return this.changeCallback?this.changeCallback(this.status()):void 0},t.prototype.status=function(){return{canUndo:this.index>-1,canRedo:this.index<this.commands.length-1}},t}(),this.CommandZ=new t}).call(this);

data/lib/assets/javascripts/commandz.coffee

@@ -1,13 +1,27 @@
 class CommandZ
 
   constructor: ->
-    @VERSION = '0.0.1'
+    @VERSION = '0.0.2'
+    @changeCallback = null
+
     this.clear()
- 
+    this.keyboardShortcuts(true)
+
   clear: ->
     @commands = []
     @index = -1
 
+  keyboardShortcuts: (enable=true) ->
+    addOrRemove = if enable then 'addEventListener' else 'removeEventListener'
+    document[addOrRemove]('keypress', this.handleKeyboard)
+
+  handleKeyboard: (e) =>
+    return if document.activeElement.nodeName is 'INPUT'
+    return unless e.keyCode is 122 and e.metaKey is true
+
+    e.preventDefault()
+    if e.shiftKey then this.redo() else this.undo()
+
   execute: (command) ->
     this.up(command)
 
@@ -21,19 +35,27 @@ class CommandZ
     @index = @commands.length - 1
 
   undo: (times=1) ->
-    return if @index < 0
+    return unless this.status().canUndo
+
     for i in [1..times]
       return unless @commands[@index]
+
       this.down(@commands[@index])
       @index--
 
+      this.handleChange()
+
   redo: (times=1) ->
-    return if @index >= @commands.length - 1
+    return unless this.status().canRedo
+
     for i in [1..times]
       return unless @commands[@index + 1]
+
       @index++
       this.up(@commands[@index])
 
+      this.handleChange()
+
   # Execute up/down on a command
   # command can be a group of commands or a single command
   exec: (action, command) ->
@@ -43,8 +65,19 @@ class CommandZ
   up:   (command) -> this.exec('up',   command)
   down: (command) -> this.exec('down', command)
 
-  # Return current command
-  status: -> @commands[@index]
+  # Register onChange callback
+  onChange: (callback) ->
+    @changeCallback = callback
+    this.handleChange()
+
+  handleChange: ->
+    return unless @changeCallback
+    @changeCallback(this.status())
+
+  # Return current status
+  status: ->
+    canUndo: @index > -1
+    canRedo: @index < @commands.length - 1
 
 # Singleton
 @CommandZ = new CommandZ

data/lib/commandz/version.rb

@@ -1,3 +1,3 @@
 module CommandZ
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/spec/commandz_spec.coffee

@@ -36,9 +36,11 @@ describe 'CommandZ', ->
       expect(CommandZ.commands.length).toBe(10)
       expect(CommandZ.index).toBe(9)
 
-    it 'returns current command', ->
-      currentCommand = CommandZ.status()
-      expect(currentCommand.up()).toBe(9)
+    it 'returns current status', ->
+      status = CommandZ.status()
+
+      expect(status.canUndo).toBe(true)
+      expect(status.canRedo).toBe(false)
 
     it 'overwrites upcoming commands', ->
       CommandZ.undo(3)
@@ -63,6 +65,19 @@ describe 'CommandZ', ->
 
       expect(CommandZ.index).toBe(0)
 
+    it 'registers onChange callback', ->
+      CommandZ.clear()
+      [0..2].forEach (i) -> CommandZ.execute({up: (-> i), down: (-> i)})
+
+      onChangeCallback = jasmine.createSpy('onChangeCallback')
+      CommandZ.onChange (status) -> onChangeCallback('test')
+
+      CommandZ.undo(3)
+      CommandZ.redo(2)
+
+      expect(onChangeCallback.calls.length).toBe(6)
+      CommandZ.onChange(null)
+
   describe 'integration', ->
     $container = null
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: commandz
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Etienne Lemay