commandz 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 702744b575b0c129c8031ffb874531ccabc57686
+  data.tar.gz: fcd2c78539f793ce8ca8d2724bcd00a03e234d95
+SHA512:
+  metadata.gz: 49f382728b5c447021de95d10e8b7ed1a6a6386592dfd1945fda902933962fd7c99149008a4332331235ff9ab03bb499c726952cd0a9dcc06c0b872b8ba0a596
+  data.tar.gz: c349a981e728cb17c0b8fb885e4bec53d545367c9e1def72e37f833d30a112d4a949d40995df85542731a9f55d6887cbf44d8d992d932e35b3087c9a23adfbb8

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+.jhw-cache

data/.jasmine-headless-webkit

@@ -0,0 +1,2 @@
+--colors
+--jasmine-config config/jasmine.yml

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Guardfile

@@ -0,0 +1,7 @@
+spec_location = "spec/%s_spec"
+
+guard 'jasmine-headless-webkit' do
+  watch(%r{^lib/assets/javascripts/(.*)\.coffee$}) { |m| newest_js_file(spec_location % m[1]) }
+  watch(%r{^spec/(.*)_spec\..*}) { |m| newest_js_file(spec_location % m[1]) }
+  watch(%r{spec/fixtures/.+$})
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Etienne Lemay
+
+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,200 @@
+<p align="center">
+  <a href="https://github.com/EtienneLem/commandz">
+    <img src="https://f.cloud.github.com/assets/436043/1047139/032acfc8-1059-11e3-8baa-d22caee7e517.png">
+  </a>
+</p>
+
+<p align="center">
+  <strong>CommandZ</strong> undo and redo commands.<br>
+  Add commands history support to your web app.
+</p>
+
+<p align="center">
+  <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>
+
+## API
+#### Glossary
+```js
+COMMANDS: An Array of COMMAND
+COMMAND: {
+  up:   function() {},
+  down: function() {}
+}
+```
+
+### execute
+Receive `COMMAND` or `COMMANDS` and execute `COMMAND.up()`.
+
+**Single command per history item**<br>
+Store one history item per `COMMAND`.
+
+```js
+CommandZ.execute({
+  up:   function() { console.log('up 1') },
+  down: function() { console.log('down 1') }
+}) // => up 1
+
+CommandZ.execute({
+  up:   function() { console.log('up 2') },
+  down: function() { console.log('down 2') }
+}) // => up 2
+
+console.log(CommandZ.commands.length) // => 2
+console.log(CommandZ.index)           // => 1
+```
+
+**Multiple commands per history item**<br>
+Store one history item per `COMMAND` group (`COMMANDS`).<br>
+A *single* undo would go back through *all* of the `COMMAND` inside `COMMANDS`.
+
+```js
+commands = []
+for (var i=1; i <= 5; i++) {
+  commands.push({
+    up:   function() { 'up 1.' + i },
+    down: function() { 'down 1.' + i }
+  })
+}
+
+CommandZ.execute(commands) // => up 1.1, up 1.2, up 1.3, up 1.4, up 1.5
+
+console.log(CommandZ.commands.length) // => 1
+console.log(CommandZ.index)           // => 0
+```
+
+### undo
+Call `COMMAND.down()` and set the index to the previous command.
+
+```js
+CommandZ.execute({
+  up:   function() { console.log('up 1') },
+  down: function() { console.log('down 1') }
+}) // => up 1
+
+CommandZ.execute({
+  up:   function() { console.log('up 2') },
+  down: function() { console.log('down 2') }
+}) // => up 2
+
+CommandZ.undo() // => down 2
+
+console.log(CommandZ.commands.length) // => 2
+console.log(CommandZ.index)           // => 0
+
+CommandZ.undo() // => down 1
+
+console.log(CommandZ.commands.length) // => 2
+console.log(CommandZ.index)           // => -1
+```
+
+### redo
+Set the index to the next command and call `COMMAND.up()`.
+
+```js
+CommandZ.execute({
+  up:   function() { console.log('up 1') },
+  down: function() { console.log('down 1') }
+}) // => up 1
+
+CommandZ.execute({
+  up:   function() { console.log('up 2') },
+  down: function() { console.log('down 2') }
+}) // => up 2
+
+CommandZ.undo(2) // => down 2, down 1
+CommandZ.redo()  // => up 1
+
+console.log(CommandZ.commands.length) // => 2
+console.log(CommandZ.index)           // => 0
+```
+
+### status
+Return the current `COMMAND`.
+
+```js
+CommandZ.execute({
+  up:   function() { console.log('up 1') },
+  down: function() { console.log('down 1') }
+}) // => up 1
+
+CommandZ.execute({
+  up:   function() { console.log('up 2') },
+  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.commands.length) // => 2
+console.log(CommandZ.index)           // => 1
+```
+
+### clear
+Clear history.
+
+```js
+CommandZ.execute({
+  up:   function() { console.log('up 1') },
+  down: function() { console.log('down 1') }
+}) // => up 1
+
+CommandZ.execute({
+  up:   function() { console.log('up 2') },
+  down: function() { console.log('down 2') }
+}) // => up 2
+
+CommandZ.clear()
+
+console.log(CommandZ.status())        // => undefined
+console.log(CommandZ.commands.length) // => 0
+console.log(CommandZ.index)           // => -1
+```
+
+## DOM Example
+```js
+// This example requires jQuery or Zepto
+$container = $('<div></div>')
+
+// Lets do 5 commands
+[1, 2, 3, 4, 5].forEach(function(i) {
+  var $i = $('<i>' + i + '</i>')
+  CommandZ.execute({
+    up:   function() { $container.append($i) },
+    down: function() { $i.detach() } // When removing DOM elements, I highly recommend .detach()
+  })
+})
+
+console.log($container.html()) // => <i>1</i><i>2</i><i>3</i><i>4</i><i>5</i>
+
+// Undo
+CommandZ.undo()
+console.log($container.html()) // => <i>1</i><i>2</i><i>3</i><i>4</i>
+
+// Redo
+CommandZ.redo()
+console.log($container.html()) // => <i>1</i><i>2</i><i>3</i><i>4</i><i>5</i>
+
+// When undoing, a new command will overwrite all upcoming commands
+CommandZ.undo(3)
+
+$i = $('<i>1337</i>')
+CommandZ.execute({
+  up:   function() { $container.append($i) },
+  down: function() { $i.detach() }
+})
+
+console.log($container.html())        // => <i>1</i><i>2</i><i>1337</i>
+console.log(CommandZ.commands.length) // => 3
+console.log(CommandZ.index)           // => 2
+```
+
+## Setup
+### Rails
+1. Add `gem 'commandz'` to your Gemfile.
+2. Add `//= require commandz` to your JavaScript manifest file.
+3. Restart your server and `CMD+Z` - `CMD+SHIFT+Z` away!
+
+### Other
+Download and include [commandz.min.js](https://raw.github.com/EtienneLem/commandz/master/commandz.min.js) in your HTML pages.
+
+## Tests
+Run the `rake spec` task or `bundle exec guard` for continuous testing.

data/Rakefile

@@ -0,0 +1,49 @@
+$:.unshift File.join(File.dirname(__FILE__), *%w[lib])
+require 'tasks/task_helpers'
+
+# Rubygems
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+# Dependencies
+require 'uglifier'
+require 'commandz'
+require 'sprockets'
+
+# Tasks
+desc 'Merge, compiles and minify CoffeeScript files'
+task :compile do
+  @environment = Sprockets::Environment.new
+  @environment.append_path 'lib/assets/javascripts'
+  @environment.js_compressor = Uglifier.new(mangle: true)
+
+  compile('commandz.js')
+end
+
+desc 'run Jasmine specs'
+task :spec do
+  system('bundle exec jasmine-headless-webkit')
+end
+
+# Helpers
+def compile(file)
+  minjs = @environment[file].to_s
+  out = "#{file.sub('.js', '.min.js')}"
+
+  File.open(out, 'w') { |f| f.write(copyright + minjs + "\n") }
+  success "Compiled #{out}"
+end
+
+def copyright
+  @copyright ||= <<-EOS
+/*
+* CommandZ v#{CommandZ::VERSION}
+* https://github.com/EtienneLem/commandz
+*
+* Copyright 2013, Etienne Lemay http://heliom.ca
+* Released under the MIT license
+*
+* Date: #{Time.now}
+*/
+EOS
+end

data/commandz.gemspec

@@ -0,0 +1,21 @@
+require './lib/commandz/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'commandz'
+  s.version     = CommandZ::VERSION
+  s.authors     = ['Etienne Lemay']
+  s.email       = ['etienne@heliom.ca']
+  s.homepage    = 'https://github.com/EtienneLem/commandz'
+  s.summary     = 'CommandZ undo and redo commands'
+  s.license     = 'MIT'
+
+  s.files      = `git ls-files`.split($/)
+  s.test_files = s.files.grep(%r{^(spec)/})
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'jasmine'
+  s.add_development_dependency 'uglifier'
+  s.add_development_dependency 'sprockets'
+  s.add_development_dependency 'jasmine-headless-webkit'
+  s.add_development_dependency 'guard-jasmine-headless-webkit'
+end

data/commandz.min.js

@@ -0,0 +1,10 @@
+/*
+* CommandZ v0.0.1
+* 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
+*/
+(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);

data/config/jasmine.yml

@@ -0,0 +1,10 @@
+src_files:
+  - "**/*"
+helpers:
+  - helpers/**/*
+spec_files:
+  - "**/*_spec.*"
+src_dir: 
+  - lib
+  - vendor
+spec_dir: spec

data/lib/assets/javascripts/commandz.coffee

@@ -0,0 +1,50 @@
+class CommandZ
+
+  constructor: ->
+    @VERSION = '0.0.1'
+    this.clear()
+ 
+  clear: ->
+    @commands = []
+    @index = -1
+
+  execute: (command) ->
+    this.up(command)
+
+    # Overwrites following commands (if @index < @commands.length)
+    if (@index < @commands.length - 1)
+      difference = (@commands.length - @index) - 1
+      @commands.splice(-difference)
+
+    # Push new command
+    @commands.push(command)
+    @index = @commands.length - 1
+
+  undo: (times=1) ->
+    return if @index < 0
+    for i in [1..times]
+      return unless @commands[@index]
+      this.down(@commands[@index])
+      @index--
+
+  redo: (times=1) ->
+    return if @index >= @commands.length - 1
+    for i in [1..times]
+      return unless @commands[@index + 1]
+      @index++
+      this.up(@commands[@index])
+
+  # Execute up/down on a command
+  # command can be a group of commands or a single command
+  exec: (action, command) ->
+    return command[action]() unless command instanceof Array
+    c[action]() for c in command
+
+  up:   (command) -> this.exec('up',   command)
+  down: (command) -> this.exec('down', command)
+
+  # Return current command
+  status: -> @commands[@index]
+
+# Singleton
+@CommandZ = new CommandZ

data/lib/commandz.rb

@@ -0,0 +1,2 @@
+require 'commandz/version'
+require 'commandz/engine' if defined?(Rails) && Rails::VERSION::MAJOR >= 3

data/lib/commandz/engine.rb

@@ -0,0 +1,3 @@
+module CommandZ
+  class Engine < ::Rails::Engine; end
+end

data/lib/commandz/version.rb

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

data/lib/tasks/task_helpers.rb

@@ -0,0 +1,18 @@
+def colorize(text, color_code)
+  "\e[#{color_code}m#{text}\e[0m"
+end
+
+{ # See: http://kpumuk.info/ruby-on-rails/colorizing-console-ruby-script-output/
+  31 => 'red',
+  32 => 'green',
+  33 => 'yellow',
+  34 => 'blue',
+  35 => 'magenta',
+  36 => 'cyan',
+}.each do |code, color|
+  Kernel.send(:define_method, color) { |text| colorize(text, code) }
+end
+
+def error(text);   puts red('ERROR: ') + text; end
+def success(text); puts green('SUCCESS: ') + text; end
+def warn(text);    puts yellow('WARNING: ') + text; end

data/spec/commandz_spec.coffee

@@ -0,0 +1,118 @@
+describe 'CommandZ', ->
+  describe 'unit', ->
+    it 'stores commands', ->
+      [0..9].forEach (i) -> CommandZ.execute({up: (-> i), down: (-> i)})
+
+      expect(CommandZ.commands.length).toBe(10)
+      expect(CommandZ.index).toBe(9)
+
+    it 'undo', ->
+      [0..3].forEach -> CommandZ.undo()
+
+      expect(CommandZ.commands.length).toBe(10)
+      expect(CommandZ.index).toBe(5)
+
+    it 'redo', ->
+      CommandZ.redo()
+
+      expect(CommandZ.commands.length).toBe(10)
+      expect(CommandZ.index).toBe(6)
+
+    it 'undo many times', ->
+      CommandZ.undo(3)
+      expect(CommandZ.commands.length).toBe(10)
+      expect(CommandZ.index).toBe(3)
+
+      CommandZ.undo(100)
+      expect(CommandZ.commands.length).toBe(10)
+      expect(CommandZ.index).toBe(-1)
+
+    it 'redo many times', ->
+      CommandZ.redo(3)
+      expect(CommandZ.commands.length).toBe(10)
+      expect(CommandZ.index).toBe(2)
+
+      CommandZ.redo(100)
+      expect(CommandZ.commands.length).toBe(10)
+      expect(CommandZ.index).toBe(9)
+
+    it 'returns current command', ->
+      currentCommand = CommandZ.status()
+      expect(currentCommand.up()).toBe(9)
+
+    it 'overwrites upcoming commands', ->
+      CommandZ.undo(3)
+      CommandZ.execute({up: (->), down: (->)})
+
+      expect(CommandZ.commands.length).toBe(8)
+      expect(CommandZ.index).toBe(7)
+
+    it 'clears commands', ->
+      CommandZ.clear()
+
+      expect(CommandZ.commands.length).toBe(0)
+      expect(CommandZ.index).toBe(-1)
+
+    it 'stores grouped commands', ->
+      CommandZ.execute([{up: (->), down: (->)}, {up: (->), down: (->)}])
+      CommandZ.undo()
+      CommandZ.redo()
+
+      expect(CommandZ.commands.length).toBe(1)
+      expect(CommandZ.commands[0].length).toBe(2)
+
+      expect(CommandZ.index).toBe(0)
+
+  describe 'integration', ->
+    $container = null
+
+    beforeEach ->
+      CommandZ.clear()
+      loadFixtures('spec_container.html')
+
+      $container = $('#spec-container')
+      [0..4].forEach ->
+        $test = $('<div class="foo"></div>')
+        CommandZ.execute
+          up:   -> $container.append($test)
+          down: -> $test.remove()
+
+    it 'executes commands', ->
+      expect($container.children().length).toBe(5)
+
+    it 'undo', ->
+      CommandZ.undo(3)
+      expect($container.children().length).toBe(2)
+
+    it 'redo', ->
+      CommandZ.undo(3)
+      CommandZ.redo()
+
+      expect($container.children().length).toBe(3)
+
+    it 'overwrites upcoming commands', ->
+      CommandZ.undo(10)
+      CommandZ.redo()
+
+      $bar = $('<div class="bar"></div>')
+      CommandZ.execute
+        up:   -> $container.append($bar)
+        down: -> $bar.remove()
+
+      expect($container.html()).toBe('<div class="foo"></div><div class="bar"></div>')
+
+    it 'executes grouped commands', ->
+      $container.html('')
+      commands = []
+
+      [1..3].forEach (i) ->
+       $i = $("<i>#{i}</i>")
+       commands.push
+         up:   -> $container.append($i)
+         down: -> $i.remove()
+
+      CommandZ.execute(commands)
+      expect($container.html()).toBe('<i>1</i><i>2</i><i>3</i>')
+
+      CommandZ.undo()
+      expect($container.html()).toBe('')