undo-manager 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d689b917106bd7744e60bbc2c299545d257f3ee5
+  data.tar.gz: 9f07646e5571bc48a5534ea02594ab5e18a42b08
+SHA512:
+  metadata.gz: 59b19e312c039de63218569ac570f22f1b9788e87ba3df5b66969a2e0cbf577f6630fc6908cae45923aeea8065a6a4897550293c6b334c3b22764378c54b6374
+  data.tar.gz: d4edc564a2d11c0ef31489872a21b95ebdb99b3c0350ed0592f167294b3b07882a6f35109add706a1c9a70c8b8a594f7b85cabbf29665467c72d251aadf1a02b

data/.gitignore

@@ -0,0 +1,11 @@
+*.gem
+.bundle
+.DS_Store
+.ruby-version
+.ruby-gemset
+pkg/*
+tmp
+
+Gemfile.lock
+gemfiles/*.lock
+doc/scratchpad.md

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### 0.0.1
+
+* Initial release

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+gemspec
+
+group :development, :test do
+  gem 'gem-release'
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Jo Hund
+
+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,38 @@
+# undo-manager
+
+undo-manager makes it easy to add undo/redo functionality to a Ruby (on Rails) app. It uses the command pattern to do so. undo-manager provides the handling of undo and redo. It’s up to you to implement the `#do` and `#undo` methods for each of your commands.
+
+
+## Installation
+
+`gem install undo-manager`
+
+or with bundler in your Gemfile:
+
+`gem 'undo-manager'`
+
+
+## Dependencies
+
+* Ruby >= 1.9.3
+
+
+## Resources
+
+* [API documentation](http://www.rubydoc.info/gems/undo-manager/)
+* [Changelog](https://github.com/jhund/undo-manager/blob/master/CHANGELOG.md)
+* [Source code (github)](https://github.com/jhund/undo-manager)
+* [Issues](https://github.com/jhund/undo-manager/issues)
+* [Rubygems.org](http://rubygems.org/gems/undo-manager)
+
+[![Build Status](https://travis-ci.org/jhund/undo-manager.svg?branch=master)](https://travis-ci.org/jhund/undo-manager)
+
+[![Code Climate](https://codeclimate.com/github/jhund/undo-manager.png)](https://codeclimate.com/github/jhund/undo-manager)
+
+### License
+
+[MIT licensed](https://github.com/jhund/undo-manager/blob/master/MIT-LICENSE).
+
+### Copyright
+
+Copyright (c) 2015 Jo Hund. See [(MIT) LICENSE](https://github.com/jhund/undo-manager/blob/master/MIT-LICENSE) for details.

data/Rakefile

@@ -0,0 +1,18 @@
+# encoding: utf-8
+begin
+  require 'bundler'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.libs.push "spec"
+  t.pattern = "spec/**/*_spec.rb"
+  t.verbose = true
+end
+
+task :default => ['test']

data/doc/how_to/release.md

@@ -0,0 +1,19 @@
+# Workflow to Maintain This Gem
+
+I use the gem-release gem
+
+For more info see: https://github.com/svenfuchs/gem-release#usage
+
+## Steps for an update
+
+1. Update code and commit it.
+2. Add entry to CHANGELOG
+   * h1 for major release (1.0.0)
+   * h2 for minor release (0.1.0)
+   * h3 for patch release (0.0.1)
+3. Update version in .gemspec
+4. Commit CHANGELOG and .gemspec
+5. Release it.
+   * `gem release`
+6. Create a git tag and push to origin.
+   `gem tag`

data/lib/undo-manager.rb

@@ -0,0 +1,2 @@
+require 'undo_manager'
+require 'undo_manager/command'

data/lib/undo_manager.rb

@@ -0,0 +1,59 @@
+# Responsibilities
+# * Manage undo stack
+# * Manage redo stack
+# * clear redo stack when new undo command is added
+# Collaborators
+# * Command
+class UndoManager
+
+  attr_reader :redo_stack, :undo_stack
+
+  # Initializes a new UndoManager.
+  # @param undo_stack [Array, optional]
+  def initialize(undo_stack = [])
+    @undo_stack = undo_stack
+    @redo_stack = []
+    @total_ops_counter = 0
+  end
+
+  # Returns true if there is at least one command to be redone.
+  def can_redo?
+    @redo_stack.any?
+  end
+
+  # Returns true if there is at least one command to be undone.
+  def can_undo?
+    @undo_stack.any?
+  end
+
+  # Pushes a new command onto the undo_stack.
+  # @param command [#do, #undo] a command object that responds to #do and #undo
+  # @return [Integer] number of total commands
+  def record_new_command(command)
+    @redo_stack = [] # clear redo stack
+    @undo_stack.push(command)
+  end
+
+  # Redoes command at top of redo_stack.
+  # @return [Command, nil] the redone command or nil if nothing was redone
+  def redo_command
+    o = @redo_stack.pop
+    if o
+      o.do # redo the command
+      @undo_stack.push(o)
+    end
+    o
+  end
+
+  # Undoes command at top of undo_stack.
+  # @return [Command, nil] the undone command or nil if nothing was undone
+  def undo_command
+    o = @undo_stack.pop
+    if o
+      o.undo # undo the command
+      @redo_stack.push(o)
+    end
+    o
+  end
+
+end

data/lib/undo_manager/command.rb

@@ -0,0 +1,13 @@
+class UndoManager
+  class Command
+
+    def do
+      raise "Implement me in subclass"
+    end
+
+    def undo
+      raise "Implement me in subclass"
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+# dependencies
+require 'rubygems'
+require 'minitest'
+require 'minitest/autorun'
+
+# Gem under test
+require 'undo-manager'

data/spec/undo_manager/command_spec.rb

@@ -0,0 +1,15 @@
+require_relative '../spec_helper'
+
+class UndoManager
+  describe Command do
+
+    it 'responds to #do' do
+      Command.new.must_respond_to(:do)
+    end
+
+    it 'responds to #undo' do
+      Command.new.must_respond_to(:undo)
+    end
+
+  end
+end

data/spec/undo_manager_spec.rb

@@ -0,0 +1,173 @@
+require_relative 'spec_helper'
+
+describe UndoManager do
+
+  class TestCommand < UndoManager::Command
+
+    attr_reader :do_count, :undo_count
+
+    def initialize
+      @do_count = 0
+      @undo_count = 0
+    end
+
+    def do
+      @do_count += 1
+    end
+
+    def undo
+      @undo_count += 1
+    end
+
+  end
+
+  describe 'A new UndoManager' do
+
+    let(:undo_manager){ UndoManager.new([]) }
+
+    it 'has an empty undo_stack' do
+      undo_manager.undo_stack.must_be_empty
+    end
+
+    it 'cannot undo' do
+      undo_manager.can_undo?.must_equal false
+    end
+
+    it 'has an empty redo_stack' do
+      undo_manager.redo_stack.must_be_empty
+    end
+
+    it 'cannot redo' do
+      undo_manager.can_redo?.must_equal false
+    end
+
+    it 'uses the undo_stack passed as argument' do
+      us = [1,2,3]
+      UndoManager.new(us).undo_stack.must_equal [1,2,3]
+    end
+
+  end
+
+  describe 'UndoManager with commands in the undo_stack' do
+
+    let(:undo_manager){ UndoManager.new([1,2,3]) }
+
+    it 'has commands in the undo_stack' do
+      undo_manager.undo_stack.wont_be_empty
+    end
+
+    it 'has an empty redo_stack' do
+      undo_manager.redo_stack.must_be_empty
+    end
+
+    it 'can_undo' do
+      undo_manager.can_undo?.must_equal true
+    end
+
+  end
+
+  describe '#can_redo?' do
+
+    it 'returns false for empty redo_stack' do
+      UndoManager.new.can_redo?.must_equal false
+    end
+
+    it 'returns true for non-empty redo_stack' do
+      undo_manager = UndoManager.new([TestCommand.new])
+      undo_manager.undo_command
+      undo_manager.can_redo?.must_equal true
+    end
+
+  end
+
+  describe '#can_undo?' do
+
+    it 'returns false for empty undo_stack' do
+      UndoManager.new.can_undo?.must_equal false
+    end
+
+    it 'returns true for non-empty undo_stack' do
+      undo_manager = UndoManager.new([TestCommand.new])
+      undo_manager.can_undo?.must_equal true
+    end
+
+  end
+
+
+  describe '#record_new_command' do
+
+    let(:undo_manager){ UndoManager.new([]) }
+
+    it 'starts with an empty undo_stack' do
+      undo_manager.undo_stack.must_be_empty
+    end
+
+    it 'records a new command' do
+      undo_manager.must_respond_to(:record_new_command)
+    end
+
+    it 'adds new command to undo_stack' do
+      undo_manager.record_new_command(1)
+      undo_manager.undo_stack.must_equal [1]
+    end
+
+    it 'clears the redo_stack' do
+      o = TestCommand.new
+      undo_manager.record_new_command(o)
+      undo_manager.undo_command
+      undo_manager.redo_stack.must_equal [o]
+      undo_manager.record_new_command(1)
+      undo_manager.redo_stack.must_be_empty
+    end
+
+  end
+
+  describe 'redo_command' do
+
+    let(:command1){ TestCommand.new }
+    let(:command2){ TestCommand.new }
+    let(:undo_manager){
+      um = UndoManager.new([command1, command2])
+      um.undo_command
+      um
+    }
+
+    it 'redoes and returns the most recently undone command' do
+      undo_manager.redo_command.must_equal command2
+    end
+
+    it 'calls #do on the redone command' do
+      undo_manager.redo_command
+      command2.do_count.must_equal 1
+    end
+
+    it 'pushes the redone command onto the undo_stack' do
+      undo_manager.redo_command
+      undo_manager.undo_stack.last.must_equal command2
+    end
+
+  end
+
+  describe 'undo_command' do
+
+    let(:command1){ TestCommand.new }
+    let(:command2){ TestCommand.new }
+    let(:undo_manager){ UndoManager.new([command1, command2]) }
+
+    it 'undoes and returns the most recent command' do
+      undo_manager.undo_command.must_equal command2
+    end
+
+    it 'calls #undo on the undone command' do
+      undo_manager.undo_command
+      command2.undo_count.must_equal 1
+    end
+
+    it 'pushes the undone command onto the undo_stack' do
+      undo_manager.undo_command
+      undo_manager.redo_stack.last.must_equal command2
+    end
+
+  end
+
+end

data/undo-manager.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name = 'undo-manager'
+  gem.version = '0.0.1'
+  gem.platform = Gem::Platform::RUBY
+
+  gem.authors = ['Jo Hund']
+  gem.email = 'jhund@clearcove.ca'
+  gem.homepage = 'https://github.com/jhund/undo-manager'
+  gem.licenses = ['MIT']
+  gem.summary = 'undo-manager makes it easy to add undo/redo functionality to a Ruby (on Rails) app.'
+  gem.description = %(undo-manager makes it easy to add undo/redo functionality to a Ruby (on Rails) app.)
+
+  gem.files = `git ls-files`.split("\n")
+  gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  gem.add_development_dependency 'bundler', ['>= 1.0.0']
+  gem.add_development_dependency 'minitest'
+  gem.add_development_dependency 'minitest-spec-expect'
+  gem.add_development_dependency 'rake', ['>= 0']
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: undo-manager
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jo Hund
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-spec-expect
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: undo-manager makes it easy to add undo/redo functionality to a Ruby (on
+  Rails) app.
+email: jhund@clearcove.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- doc/how_to/release.md
+- lib/undo-manager.rb
+- lib/undo_manager.rb
+- lib/undo_manager/command.rb
+- spec/spec_helper.rb
+- spec/undo_manager/command_spec.rb
+- spec/undo_manager_spec.rb
+- undo-manager.gemspec
+homepage: https://github.com/jhund/undo-manager
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: undo-manager makes it easy to add undo/redo functionality to a Ruby (on Rails)
+  app.
+test_files:
+- spec/spec_helper.rb
+- spec/undo_manager/command_spec.rb
+- spec/undo_manager_spec.rb