compo 0.1.5 → 0.2.0

data/spec/movable_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'compo'
+require 'movable_shared_examples'
 
 # Mock implementation of a Movable
 class MockMovable
@@ -7,195 +8,5 @@ class MockMovable
 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
+  it_behaves_like 'a movable object'
 end

data/spec/null_composite_shared_examples.rb

@@ -0,0 +1,68 @@
+require 'composite_shared_examples'
+
+shared_examples 'a null composite' do
+  it_behaves_like 'a composite'
+
+  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/null_composite_spec.rb

@@ -1,67 +1,7 @@
 require 'spec_helper'
 require 'compo'
+require 'null_composite_shared_examples'
 
 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
+  it_behaves_like 'a null composite'
 end

data/spec/parent_tracker_spec.rb

@@ -50,9 +50,9 @@ describe MockParentTracker do
   end
 
   describe '#remove_parent' do
-    it 'sets the parent to nil' do
+    it 'sets the parent to an instance of Parentless' do
       subject.remove_parent
-      expect(subject.parent).to be_nil
+      expect(subject.parent).to be_a(Compo::Parentless)
     end
 
     it 'sets the ID function to one returning nil' do

data/spec/parentless_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+require 'compo'
+
+describe Compo::Parentless do
+  let(:child) { double(:child) }
+
+  describe '#add' do
+    before(:each) { allow(child).to receive(:update_parent) }
+
+    it 'returns the given child exactly' do
+      expect(subject.add(:id, child)).to be(child)
+    end
+
+    it 'calls #update_parent on the child with a Parentless' do
+      expect(child).to receive(:update_parent).once do |parent, _|
+        expect(parent).to be_a(Compo::Parentless)
+      end
+      subject.add(:id, child)
+    end
+
+    it 'calls #update_parent on the child with a nil-returning ID proc' do
+      expect(child).to receive(:update_parent).once do |_, idp|
+        expect(idp.call).to be_nil
+      end
+      subject.add(:id, child)
+    end
+  end
+
+  describe '#remove' do
+    it 'returns the given child exactly' do
+      expect(subject.remove(child)).to be(child)
+    end
+  end
+
+  describe '#children' do
+    specify { expect(subject.children).to eq({}) }
+  end
+
+  describe '#url' do
+    specify { expect(subject.url).to eq('') }
+  end
+
+  describe '#child_url' do
+    specify { expect(subject.child_url(:id)).to eq('') }
+  end
+
+  describe '#parent' do
+    it 'returns the exact same Parentless object' do
+      expect(subject.parent).to be(subject)
+    end
+  end
+end

data/spec/url_referenceable_shared_examples.rb

@@ -0,0 +1,78 @@
+shared_examples 'a URL referenceable object' do
+  let(:parent) { nil }
+  let(:id) { double(:id) }
+
+  before(:each) do
+    allow(subject).to receive(:id).and_return(id)
+    allow(subject).to receive(:parent).and_return(parent)
+  end
+
+  describe '#url' do
+    context 'when the UrlReferenceable has no parent' do
+      specify { expect { subject.url }.to raise_error }
+    end
+
+    context 'when the UrlReferenceable has a parent' do
+      let(:parent) { double(:parent) }
+      before(:each) do
+        allow(parent).to receive(:child_url).and_return(:child_url)
+      end
+
+      it 'calls #id' do
+        expect(subject).to receive(:id)
+        subject.url
+      end
+
+      it 'calls #parent' do
+        expect(subject).to receive(:parent)
+        subject.url
+      end
+
+      it 'calls #child_url on the parent with the ID' do
+        expect(parent).to receive(:child_url).with(id)
+        subject.url
+      end
+
+      it 'returns the result of calling #child_url' do
+        expect(subject.url).to eq(:child_url)
+      end
+    end
+  end
+
+  describe '#parent_url' do
+    context 'when the UrlReferenceable has no parent' do
+      let(:parent) { nil }
+
+      specify { expect(subject.parent_url).to be_nil }
+
+      it 'calls #parent' do
+        expect(subject).to receive(:parent)
+        subject.parent_url
+      end
+    end
+
+    context 'when the UrlReferenceable has a parent' do
+      let(:parent) { double(:parent) }
+      let(:url) { double(:url) }
+
+      before(:each) do
+        allow(parent).to receive(:url).and_return(url)
+      end
+
+      it 'calls #parent' do
+        expect(subject).to receive(:parent).with(no_args)
+        subject.parent_url
+      end
+
+      it 'calls #url on the parent' do
+        expect(parent).to receive(:url).once.with(no_args)
+        subject.parent_url
+      end
+
+      it 'returns the result of #url on the parent' do
+        expect(subject.parent_url).to eq(url)
+        subject.parent_url
+      end
+    end
+  end
+end

data/spec/url_referenceable_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'compo'
+require 'url_referenceable_shared_examples'
 
 # Mock implementation of UrlReferenceable.
 class MockUrlReferenceable
@@ -7,69 +8,5 @@ class MockUrlReferenceable
 end
 
 describe MockUrlReferenceable do
-  before(:each) { allow(subject).to receive(:parent).and_return(parent) }
-
-  describe '#url' do
-    context 'when the UrlReferenceable has no parent' do
-      let(:parent) { nil }
-
-      it 'returns the empty string' do
-        expect(subject.url).to eq('')
-      end
-    end
-
-    context 'when the UrlReferenceable has a parent' do
-      let(:parent) { double(:parent) }
-      before(:each) do
-        allow(subject).to receive(:id).and_return('id')
-        allow(subject).to receive(:parent_url).and_return('dog/goes')
-      end
-
-      it 'calls #id' do
-        expect(subject).to receive(:id)
-        subject.url
-      end
-
-      it 'returns the joining of the parent URL and ID with a slash' do
-        expect(subject.url).to eq('dog/goes/id')
-      end
-    end
-  end
-
-  describe '#parent_url' do
-    context 'when the UrlReferenceable has no parent' do
-      let(:parent) { nil }
-
-      specify { expect(subject.parent_url).to be_nil }
-
-      it 'calls #parent' do
-        expect(subject).to receive(:parent)
-        subject.parent_url
-      end
-    end
-
-    context 'when the UrlReferenceable has a parent' do
-      let(:parent) { double(:parent) }
-      let(:url) { double(:url) }
-
-      before(:each) do
-        allow(parent).to receive(:url).and_return(url)
-      end
-
-      it 'calls #parent' do
-        expect(subject).to receive(:parent).with(no_args)
-        subject.parent_url
-      end
-
-      it 'calls #url on the parent' do
-        expect(parent).to receive(:url).once.with(no_args)
-        subject.parent_url
-      end
-
-      it 'returns the result of #url on the parent' do
-        expect(subject.parent_url).to eq(url)
-        subject.parent_url
-      end
-    end
-  end
+  it_behaves_like 'a URL referenceable object'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: compo
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - Matt Windsor
@@ -149,18 +149,27 @@ files:
 - lib/compo/movable.rb
 - lib/compo/null_composite.rb
 - lib/compo/parent_tracker.rb
+- lib/compo/parentless.rb
 - lib/compo/url_referenceable.rb
 - lib/compo/version.rb
 - spec/array_branch_spec.rb
+- spec/array_composite_shared_examples.rb
 - spec/array_composite_spec.rb
+- spec/branch_shared_examples.rb
+- spec/composite_shared_examples.rb
 - spec/composite_spec.rb
 - spec/hash_branch_spec.rb
+- spec/hash_composite_shared_examples.rb
 - spec/hash_composite_spec.rb
 - spec/leaf_spec.rb
+- spec/movable_shared_examples.rb
 - spec/movable_spec.rb
+- spec/null_composite_shared_examples.rb
 - spec/null_composite_spec.rb
 - spec/parent_tracker_spec.rb
+- spec/parentless_spec.rb
 - spec/spec_helper.rb
+- spec/url_referenceable_shared_examples.rb
 - spec/url_referenceable_spec.rb
 homepage: http://github.com/CaptainHayashi/compo
 licenses:
@@ -188,14 +197,22 @@ specification_version: 4
 summary: Composite pattern style mixins with IDs
 test_files:
 - spec/array_branch_spec.rb
+- spec/array_composite_shared_examples.rb
 - spec/array_composite_spec.rb
+- spec/branch_shared_examples.rb
+- spec/composite_shared_examples.rb
 - spec/composite_spec.rb
 - spec/hash_branch_spec.rb
+- spec/hash_composite_shared_examples.rb
 - spec/hash_composite_spec.rb
 - spec/leaf_spec.rb
+- spec/movable_shared_examples.rb
 - spec/movable_spec.rb
+- spec/null_composite_shared_examples.rb
 - spec/null_composite_spec.rb
 - spec/parent_tracker_spec.rb
+- spec/parentless_spec.rb
 - spec/spec_helper.rb
+- spec/url_referenceable_shared_examples.rb
 - spec/url_referenceable_spec.rb
 has_rdoc: