compo 0.1.0

data/spec/movable_spec.rb

@@ -0,0 +1,201 @@
+require 'spec_helper'
+require 'compo'
+
+# Mock implementation of a Movable
+class MockMovable
+  include Compo::Movable
+end
+
+describe MockMovable do
+  let(:old_parent) { double(:old_parent) }
+  let(:new_parent) { double(:new_parent) }
+
+  describe '#move_to' do
+    context 'when the receiving parent is nil' do
+      context 'and the Movable has no parent' do
+        before(:each) do
+          allow(subject).to receive(:parent).and_return(nil)
+        end
+
+        it 'returns itself' do
+          expect(subject.move_to(nil, :test)).to eq(subject)
+        end
+
+        it 'calls #parent' do
+          expect(subject).to receive(:parent).once
+          subject.move_to(nil, :test)
+        end
+      end
+
+      context 'and the Movable has a parent' do
+        before(:each) do
+          allow(subject).to receive(:parent).and_return(old_parent)
+          allow(old_parent).to receive(:remove)
+        end
+
+        it 'returns itself' do
+          expect(subject.move_to(nil, :test)).to eq(subject)
+        end
+
+        it 'calls #parent' do
+          expect(subject).to receive(:parent)
+          subject.move_to(nil, :test)
+        end
+
+        it 'calls #remove on the old parent with the Movable' do
+          expect(old_parent).to receive(:remove).once.with(subject)
+          subject.move_to(nil, :test)
+        end
+      end
+    end
+
+    context 'when the receiving parent refuses to add the Movable' do
+      before(:each) do
+        allow(new_parent).to receive(:add).and_return(nil)
+      end
+
+      context 'and the Movable has no parent' do
+        before(:each) do
+          allow(subject).to receive(:parent).and_return(nil)
+        end
+
+        it 'returns itself' do
+          expect(subject.move_to(new_parent, :test)).to eq(subject)
+        end
+
+        it 'calls #parent' do
+          expect(subject).to receive(:parent)
+          subject.move_to(new_parent, :test)
+        end
+
+        it 'calls #add on the new parent with the ID and Movable' do
+          expect(new_parent).to receive(:add).once.with(:test, subject)
+          subject.move_to(new_parent, :test)
+        end
+      end
+
+      context 'and the Movable has a parent that refuses to remove it' do
+        before(:each) do
+          allow(subject).to receive(:parent).and_return(old_parent)
+          allow(old_parent).to receive(:remove).and_return(nil)
+        end
+
+        it 'returns itself' do
+          expect(subject.move_to(new_parent, :test)).to eq(subject)
+        end
+
+        it 'calls #parent' do
+          expect(subject).to receive(:parent)
+          subject.move_to(new_parent, :test)
+        end
+
+        it 'calls #remove on the old parent with the Movable' do
+          expect(old_parent).to receive(:remove).once.with(subject)
+          subject.move_to(new_parent, :test)
+        end
+      end
+
+      context 'and the Movable has a parent that allows it to be removed' do
+        before(:each) do
+          allow(subject).to receive(:parent).and_return(old_parent)
+          allow(old_parent).to receive(:remove).and_return(subject)
+          allow(new_parent).to receive(:add)
+        end
+
+        it 'returns itself' do
+          expect(subject.move_to(new_parent, :test)).to eq(subject)
+        end
+
+        it 'calls #parent' do
+          expect(subject).to receive(:parent)
+          subject.move_to(new_parent, :test)
+        end
+
+        it 'calls #remove on the old parent with the Movable' do
+          expect(old_parent).to receive(:remove).once.with(subject)
+          subject.move_to(new_parent, :test)
+        end
+
+        it 'calls #add on the new parent with the ID and Movable' do
+          expect(new_parent).to receive(:add).once.with(:test, subject)
+          subject.move_to(new_parent, :test)
+        end
+      end
+    end
+
+    context 'when the receiving parent allows the Movable to be added' do
+      before(:each) do
+        allow(new_parent).to receive(:add).and_return(subject)
+      end
+
+      context 'and the Movable has no parent' do
+        before(:each) do
+          allow(subject).to receive(:parent).and_return(nil)
+        end
+
+        it 'returns itself' do
+          expect(subject.move_to(new_parent, :test)).to eq(subject)
+        end
+
+        it 'calls #parent' do
+          expect(subject).to receive(:parent)
+          subject.move_to(new_parent, :test)
+        end
+
+        it 'calls #add on the new parent with the ID and Movable' do
+          expect(new_parent).to receive(:add).with(:test_id, subject)
+
+          subject.move_to(new_parent, :test_id)
+        end
+      end
+
+      context 'and the Movable has a parent that refuses to remove it' do
+        before(:each) do
+          allow(subject).to receive(:parent).and_return(old_parent)
+          allow(old_parent).to receive(:remove).and_return(nil)
+        end
+
+        it 'returns itself' do
+          expect(subject.move_to(new_parent, :test)).to eq(subject)
+        end
+
+        it 'calls #parent' do
+          expect(subject).to receive(:parent)
+          subject.move_to(new_parent, :test)
+        end
+
+        it 'calls #remove on the old parent with the Movable' do
+          expect(old_parent).to receive(:remove).once.with(subject)
+          subject.move_to(new_parent, :test)
+        end
+      end
+
+      context 'and the Movable has a parent that allows it to be removed' do
+        before(:each) do
+          allow(subject).to receive(:parent).and_return(old_parent)
+          allow(old_parent).to receive(:remove).and_return(subject)
+          allow(new_parent).to receive(:add)
+        end
+
+        it 'returns itself' do
+          expect(subject.move_to(new_parent, :test)).to eq(subject)
+        end
+
+        it 'calls #parent' do
+          expect(subject).to receive(:parent)
+          subject.move_to(new_parent, :test)
+        end
+
+        it 'calls #remove on the old parent with the Movable' do
+          expect(old_parent).to receive(:remove).once.with(subject)
+          subject.move_to(new_parent, :test)
+        end
+
+        it 'calls #add on the new parent with the ID and Movable' do
+          expect(new_parent).to receive(:add).once.with(:test, subject)
+          subject.move_to(new_parent, :test)
+        end
+      end
+    end
+  end
+end

data/spec/null_composite_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+require 'compo'
+
+describe Compo::NullComposite do
+  let(:child1) { double(:child1) }
+  let(:child2) { double(:child2) }
+  let(:child3) { double(:child3) }
+
+  describe '#add' do
+    it 'always returns nil' do
+      expect(subject.add(1, child1)).to be_nil
+      expect(subject.add(:a, child2)).to be_nil
+      expect(subject.add(nil, child3)).to be_nil
+    end
+
+    it 'does not change the result of #children' do
+      expect(subject.children).to eq({})
+
+      subject.add(1, child1)
+      expect(subject.children).to eq({})
+
+      subject.add(:a, child2)
+      expect(subject.children).to eq({})
+
+      subject.add(:a, child3)
+      expect(subject.children).to eq({})
+    end
+  end
+
+  describe '#remove' do
+    specify { expect(subject.remove(child1)).to eq(nil) }
+
+    it 'does not change the result of #children' do
+      expect(subject.children).to eq({})
+
+      subject.remove(child1)
+      expect(subject.children).to eq({})
+
+      subject.remove(child2)
+      expect(subject.children).to eq({})
+
+      subject.remove(child3)
+      expect(subject.children).to eq({})
+    end
+  end
+
+  describe '#remove_id' do
+    specify { expect(subject.remove_id(:a)).to eq(nil) }
+
+    it 'does not change the result of #children' do
+      expect(subject.children).to eq({})
+
+      subject.remove_id(0)
+      expect(subject.children).to eq({})
+
+      subject.remove_id(:a)
+      expect(subject.children).to eq({})
+
+      subject.remove_id(nil)
+      expect(subject.children).to eq({})
+    end
+  end
+
+  describe '#children' do
+    specify { expect(subject.children).to eq({}) }
+  end
+end

data/spec/parent_tracker_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+require 'compo'
+
+# Mock implementation of a ParentTracker
+class MockParentTracker
+  include Compo::ParentTracker
+
+  def initialize(parent, id_function)
+    @parent = parent
+    @id_function = id_function
+  end
+end
+
+describe MockParentTracker do
+  subject { MockParentTracker.new(parent, id_function) }
+  let(:parent) { double(:parent) }
+  let(:id_function) { double(:id_function) }
+
+  describe '#parent' do
+    it 'returns the current parent' do
+      expect(subject.parent).to eq(parent)
+    end
+  end
+
+  describe '#id' do
+    it 'calls the current ID function and returns its result' do
+      allow(id_function).to receive(:call).and_return(:id)
+      expect(id_function).to receive(:call).once.with(no_args)
+
+      expect(subject.id).to eq(:id)
+    end
+  end
+
+  describe '#update_parent' do
+    let(:new_parent) { double(:new_parent) }
+    let(:new_id_function) { double(:new_id_function) }
+
+    it 'sets the parent to the new value' do
+      subject.update_parent(new_parent, new_id_function)
+      expect(subject.parent).to eq(new_parent)
+    end
+
+    it 'sets the ID function to the new ID function' do
+      allow(new_id_function).to receive(:call).and_return(:new_id)
+      expect(new_id_function).to receive(:call).once
+
+      subject.update_parent(new_parent, new_id_function)
+      expect(subject.id).to eq(:new_id)
+    end
+  end
+
+  describe '#remove_parent' do
+    it 'sets the parent to nil' do
+      subject.remove_parent
+      expect(subject.parent).to be_nil
+    end
+
+    it 'sets the ID function to one returning nil' do
+      subject.remove_parent
+      expect(subject.id).to be_nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'simplecov'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end
+
+SimpleCov.start do
+  add_filter 'spec'
+end

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification
+name: compo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matt Windsor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: backports
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: simplecov
+  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: yard
+  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: yardstick
+  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: "\n    Compo provides mixins and classes that assist in implementing
+  a variant of\n    the Composite design pattern, in which each child has an ID that
+  uniquely\n    identifies it inside the parent's child set.\n  "
+email:
+- matt.windsor@ury.org.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- CHANGELOG
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- compo.gemspec
+- lib/compo.rb
+- lib/compo/array_composite.rb
+- lib/compo/composite.rb
+- lib/compo/hash_composite.rb
+- lib/compo/leaf.rb
+- lib/compo/movable.rb
+- lib/compo/null_composite.rb
+- lib/compo/parent_tracker.rb
+- lib/compo/version.rb
+- spec/array_composite_spec.rb
+- spec/composite_spec.rb
+- spec/hash_composite_spec.rb
+- spec/leaf_spec.rb
+- spec/movable_spec.rb
+- spec/null_composite_spec.rb
+- spec/parent_tracker_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/CaptainHayashi/compo
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Composite pattern style mixins with IDs
+test_files:
+- spec/array_composite_spec.rb
+- spec/composite_spec.rb
+- spec/hash_composite_spec.rb
+- spec/leaf_spec.rb
+- spec/movable_spec.rb
+- spec/null_composite_spec.rb
+- spec/parent_tracker_spec.rb
+- spec/spec_helper.rb
+has_rdoc: