compo 0.1.5 → 0.2.0

data/spec/branch_shared_examples.rb

@@ -0,0 +1,33 @@
+require 'url_referenceable_shared_examples'
+require 'movable_shared_examples'
+
+shared_examples 'a branch' do
+  it_behaves_like 'a URL referenceable object'
+  it_behaves_like 'a movable object'
+
+  describe '#initialize' do
+    it 'initialises with a Parentless as parent' do
+      expect(subject.parent).to be_a(Compo::Parentless)
+    end
+
+    it 'initialises with an ID function returning nil' do
+      expect(subject.id).to be_nil
+    end
+  end
+
+  describe '#url' do
+    context 'when the Leaf has no parent' do
+      it 'returns the empty string' do
+        expect(subject.url).to eq('')
+      end
+    end
+    context 'when the Leaf is the child of a root' do
+      let(:parent) { Compo::HashBranch.new }
+      before(:each) { subject.move_to(parent, :id) }
+
+      it 'returns /ID, where ID is the ID of the Leaf' do
+        expect(subject.url).to eq('/id')
+      end
+    end
+  end
+end

data/spec/composite_shared_examples.rb

@@ -0,0 +1,283 @@
+require 'compo'
+
+shared_examples 'a removal of a child from its parent' do
+  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
+    op.call
+  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
+    op.call
+  end
+end
+
+shared_examples 'a composite' do
+  let(:id) { double(:id) }
+  let(:child) { double(:child) }
+
+  describe '#each' do
+    it 'delegates to the #each implementation of the hash from #children' do
+      children = double(:children)
+
+      allow(subject).to receive(:children).and_return(children)
+      expect(subject).to receive(:children).once.with(no_args)
+      expect(children).to receive(:each).once
+
+      subject.each
+    end
+  end
+
+  describe '#add' do
+    before(:each) { allow(subject).to receive(:add!) }
+
+    context 'when #add! returns nil' do
+      before(:each) { allow(subject).to receive(:add!).and_return(nil) }
+
+      specify { expect(subject.add(id, child)).to be_nil }
+
+      it 'calls #add! with the ID and child given' do
+        expect(subject).to receive(:add!).once.with(id, child)
+        subject.add(id, child)
+      end
+    end
+
+    context 'when #add! returns the child' do
+      before(:each) do
+        allow(subject).to receive(:add!).and_return(child)
+        allow(subject).to receive(:id_function)
+        allow(child).to receive(:update_parent)
+      end
+
+      it 'calls #add! with the ID and child given' do
+        expect(subject).to receive(:add!).once.with(id, child)
+        subject.add(id, child)
+      end
+
+      it 'calls #id_function with the child given' do
+        expect(subject).to receive(:id_function).once.with(child)
+        subject.add(id, child)
+      end
+
+      it 'calls #update_parent on the child with the parent and ID function' do
+        idf = double(:id_function)
+        allow(subject).to receive(:id_function).and_return(idf)
+        expect(child).to receive(:update_parent).once.with(subject, idf)
+        subject.add(id, child)
+      end
+
+      it 'returns the given child' do
+        expect(subject.add(id, child)).to eq(child)
+      end
+    end
+  end
+
+  describe '#get_child' do
+    let(:child) { double(:child) }
+
+    before(:each) do
+      allow(subject).to receive(:children).and_return(in_children: child)
+    end
+
+    context 'when the argument is in #children' do
+      it 'returns the child' do
+        expect(subject.get_child(:in_children)).to eq(child)
+      end
+    end
+
+    context 'when the argument is not in #children' do
+      specify { expect(subject.get_child(:not_in_children)).to be_nil }
+    end
+  end
+end
+
+shared_examples 'a composite with default #remove!' do
+  let(:child) { double(:child) }
+  let(:id) { double(:id) }
+
+  describe '#remove' do
+    context 'when #remove! is defined' do
+      before(:each) { allow(subject).to receive(:remove!) }
+
+      context 'when #remove! returns nil' do
+        before(:each) { allow(subject).to receive(:remove!).and_return(nil) }
+
+        specify { expect(subject.remove(child)).to be_nil }
+
+        it 'calls #remove! with the child given' do
+          expect(subject).to receive(:remove!).once.with(child)
+          subject.remove(child)
+        end
+      end
+
+      context 'when #remove! returns the child' do
+        before(:each) do
+          allow(subject).to receive(:remove!).and_return(child)
+          allow(child).to receive(:update_parent)
+        end
+
+        it 'calls #remove! with the child given' do
+          expect(subject).to receive(:remove!).once.with(child)
+          subject.remove(child)
+        end
+
+        it_behaves_like 'a removal of a child from its parent' do
+          let(:op) { -> { subject.remove(child) } }
+        end
+
+        it 'returns the given child' do
+          expect(subject.remove(child)).to eq(child)
+        end
+      end
+    end
+
+    context 'when #remove_id! is defined but #remove! is not' do
+      before(:each) do
+        allow(subject).to receive(:remove_id!)
+        allow(subject).to receive(:children).and_return(id => child)
+      end
+
+      context 'when #remove_id! returns nil' do
+        before(:each) do
+          allow(subject).to receive(:remove_id!).and_return(nil)
+        end
+
+        specify { expect(subject.remove(child)).to be_nil }
+
+        it 'calls #remove! with the child given' do
+          expect(subject).to receive(:remove!).once.with(child)
+          subject.remove(child)
+        end
+
+        it 'calls #remove_id! with the ID of the child' do
+          expect(subject).to receive(:remove_id!).once.with(id)
+          subject.remove(child)
+        end
+
+        it 'calls #children' do
+          expect(subject).to receive(:children).once
+          subject.remove(child)
+        end
+      end
+
+      context 'when #remove_id! returns the child' do
+        before(:each) do
+          allow(subject).to receive(:remove_id!).and_return(child)
+          allow(child).to receive(:update_parent)
+        end
+
+        it 'calls #remove_id! with the child given' do
+          expect(subject).to receive(:remove!).once.with(child)
+          subject.remove(child)
+        end
+
+        it_behaves_like 'a removal of a child from its parent' do
+          let(:op) { -> { subject.remove(child) } }
+        end
+
+        it 'returns the given child' do
+          expect(subject.remove(child)).to eq(child)
+        end
+      end
+    end
+  end
+end
+
+shared_examples 'a composite with default #remove_id!' do
+  let(:child) { double(:child) }
+  let(:id) { double(:id) }
+
+  describe '#remove_id' do
+    let(:id) { double(:id) }
+
+    context 'when #remove_id! is defined' do
+      before(:each) { allow(subject).to receive(:remove_id!) }
+
+      context 'and #remove_id! returns nil' do
+        before(:each) do
+          allow(subject).to receive(:remove_id!).and_return(nil)
+        end
+
+        specify { expect(subject.remove_id(id)).to be_nil }
+
+        it 'calls #remove_id! with the ID given' do
+          expect(subject).to receive(:remove_id!).once.with(id)
+          subject.remove_id(id)
+        end
+      end
+
+      context 'and #remove_id! returns the child' do
+        before(:each) do
+          allow(subject).to receive(:remove_id!).and_return(child)
+          allow(child).to receive(:update_parent)
+        end
+
+        it 'calls #remove_id! with the ID given' do
+          expect(subject).to receive(:remove_id!).once.with(id)
+          subject.remove_id(id)
+        end
+
+        it_behaves_like 'a removal of a child from its parent' do
+          let(:op) { -> { subject.remove_id(id) } }
+        end
+
+        it 'returns the child' do
+          expect(subject.remove_id(id)).to eq(child)
+        end
+      end
+    end
+
+    context 'when #remove! is defined but #remove_id! is not' do
+      before(:each) { allow(subject).to receive(:remove!) }
+
+      context 'and #remove! returns nil' do
+        before(:each) do
+          allow(subject).to receive(:remove!).and_return(nil)
+          allow(subject).to receive(:get_child).and_return(child)
+        end
+
+        specify { expect(subject.remove_id(id)).to be_nil }
+
+        it 'calls #remove_id! with the ID given' do
+          expect(subject).to receive(:remove_id!).once.with(id)
+          subject.remove_id(id)
+        end
+
+        it 'calls #get_child with the ID given' do
+          expect(subject).to receive(:get_child).once.with(id)
+          subject.remove_id(id)
+        end
+
+        it 'calls #remove! with the child given' do
+          expect(subject).to receive(:remove!).once.with(child)
+          subject.remove_id(id)
+        end
+      end
+
+      context 'and #remove! returns the child' do
+        before(:each) do
+          allow(subject).to receive(:remove!).and_return(child)
+          allow(subject).to receive(:get_child).and_return(child)
+          allow(child).to receive(:update_parent)
+        end
+
+        it 'calls #remove! with the child given' do
+          expect(subject).to receive(:remove!).once.with(child)
+          subject.remove_id(id)
+        end
+
+        it_behaves_like 'a removal of a child from its parent' do
+          let(:op) { -> { subject.remove_id(id) } }
+        end
+
+        it 'returns the given child' do
+          expect(subject.remove_id(id)).to eq(child)
+        end
+      end
+    end
+  end
+end

data/spec/composite_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'compo'
+require 'composite_shared_examples'
 
 # Mock implementation of a Composite
 class MockComposite
@@ -7,263 +8,21 @@ class MockComposite
 end
 
 describe MockComposite do
-  let(:id) { double(:id) }
+  before(:each) { allow(subject).to receive(:children).and_return(children) }
+  let(:children) { { in_children: child } }
   let(:child) { double(:child) }
 
-  describe '#add' do
-    before(:each) { allow(subject).to receive(:add!) }
-
-    context 'when #add! returns nil' do
-      before(:each) { allow(subject).to receive(:add!).and_return(nil) }
-
-      specify { expect(subject.add(id, child)).to be_nil }
-
-      it 'calls #add! with the ID and child given' do
-        expect(subject).to receive(:add!).once.with(id, child)
-        subject.add(id, child)
-      end
-    end
-
-    context 'when #add! returns the child' do
-      before(:each) do
-        allow(subject).to receive(:add!).and_return(child)
-        allow(subject).to receive(:id_function)
-        allow(child).to receive(:update_parent)
-      end
-
-      it 'calls #add! with the ID and child given' do
-        expect(subject).to receive(:add!).once.with(id, child)
-        subject.add(id, child)
-      end
-
-      it 'calls #id_function with the child given' do
-        expect(subject).to receive(:id_function).once.with(child)
-        subject.add(id, child)
-      end
-
-      it 'calls #update_parent on the child with the parent and ID function' do
-        idf = double(:id_function)
-        allow(subject).to receive(:id_function).and_return(idf)
-        expect(child).to receive(:update_parent).once.with(subject, idf)
-        subject.add(id, child)
-      end
-
-      it 'returns the given child' do
-        expect(subject.add(id, child)).to eq(child)
-      end
-    end
-  end
-
-  describe '#remove' do
-    context 'when #remove! is defined' do
-      before(:each) { allow(subject).to receive(:remove!) }
-
-      context 'when #remove! returns nil' do
-        before(:each) { allow(subject).to receive(:remove!).and_return(nil) }
-
-        specify { expect(subject.remove(child)).to be_nil }
-
-        it 'calls #remove! with the child given' do
-          expect(subject).to receive(:remove!).once.with(child)
-          subject.remove(child)
-        end
-      end
-
-      context 'when #remove! returns the child' do
-        before(:each) do
-          allow(subject).to receive(:remove!).and_return(child)
-          allow(child).to receive(:remove_parent)
-        end
-
-        it 'calls #remove! with the child given' do
-          expect(subject).to receive(:remove!).once.with(child)
-          subject.remove(child)
-        end
-
-        it 'calls #remove_parent on the child with no arguments' do
-          expect(child).to receive(:remove_parent).once.with(no_args)
-          subject.remove(child)
-        end
-
-        it 'returns the given child' do
-          expect(subject.remove(child)).to eq(child)
-        end
-      end
-    end
-
-    context 'when #remove_id! is defined but #remove! is not' do
-      before(:each) do
-        allow(subject).to receive(:remove_id!)
-        allow(subject).to receive(:children).and_return(id => child)
-      end
-
-      context 'when #remove_id! returns nil' do
-        before(:each) do
-          allow(subject).to receive(:remove_id!).and_return(nil)
-        end
-
-        specify { expect(subject.remove(child)).to be_nil }
-
-        it 'calls #remove! with the child given' do
-          expect(subject).to receive(:remove!).once.with(child)
-          subject.remove(child)
-        end
-
-        it 'calls #remove_id! with the ID of the child' do
-          expect(subject).to receive(:remove_id!).once.with(id)
-          subject.remove(child)
-        end
-
-        it 'calls #children' do
-          expect(subject).to receive(:children).once
-          subject.remove(child)
-        end
-      end
-
-      context 'when #remove_id! returns the child' do
-        before(:each) do
-          allow(subject).to receive(:remove_id!).and_return(child)
-          allow(child).to receive(:remove_parent)
-        end
-
-        it 'calls #remove_id! with the child given' do
-          expect(subject).to receive(:remove!).once.with(child)
-          subject.remove(child)
-        end
-
-        it 'calls #remove_parent on the child with no arguments' do
-          expect(child).to receive(:remove_parent).once.with(no_args)
-          subject.remove(child)
-        end
-
-        it 'returns the given child' do
-          expect(subject.remove(child)).to eq(child)
-        end
-      end
-    end
-  end
-
-  describe '#remove_id' do
-    let(:id) { double(:id) }
-
-    context 'when #remove_id! is defined' do
-      before(:each) { allow(subject).to receive(:remove_id!) }
-
-      context 'and #remove_id! returns nil' do
-        before(:each) do
-          allow(subject).to receive(:remove_id!).and_return(nil)
-        end
-
-        specify { expect(subject.remove_id(id)).to be_nil }
-
-        it 'calls #remove_id! with the ID given' do
-          expect(subject).to receive(:remove_id!).once.with(id)
-          subject.remove_id(id)
-        end
-      end
-
-      context 'and #remove_id! returns the child' do
-        before(:each) do
-          allow(subject).to receive(:remove_id!).and_return(child)
-          allow(child).to receive(:remove_parent)
-        end
-
-        it 'calls #remove_id! with the ID given' do
-          expect(subject).to receive(:remove_id!).once.with(id)
-          subject.remove_id(id)
-        end
-
-        it 'calls #remove_parent on the child with no arguments' do
-          expect(child).to receive(:remove_parent).once.with(no_args)
-          subject.remove_id(id)
-        end
-
-        it 'returns the child' do
-          expect(subject.remove_id(id)).to eq(child)
-        end
-      end
-    end
-
-    context 'when #remove! is defined but #remove_id! is not' do
-      before(:each) { allow(subject).to receive(:remove!) }
-
-      context 'and #remove! returns nil' do
-        before(:each) do
-          allow(subject).to receive(:remove!).and_return(nil)
-          allow(subject).to receive(:get_child).and_return(child)
-        end
-
-        specify { expect(subject.remove_id(id)).to be_nil }
-
-        it 'calls #remove_id! with the ID given' do
-          expect(subject).to receive(:remove_id!).once.with(id)
-          subject.remove_id(id)
-        end
-
-        it 'calls #get_child with the ID given' do
-          expect(subject).to receive(:get_child).once.with(id)
-          subject.remove_id(id)
-        end
-
-        it 'calls #remove! with the child given' do
-          expect(subject).to receive(:remove!).once.with(child)
-          subject.remove_id(id)
-        end
-      end
-
-      context 'and #remove! returns the child' do
-        before(:each) do
-          allow(subject).to receive(:remove!).and_return(child)
-          allow(subject).to receive(:get_child).and_return(child)
-          allow(child).to receive(:remove_parent)
-        end
-
-        it 'calls #remove! with the child given' do
-          expect(subject).to receive(:remove!).once.with(child)
-          subject.remove_id(id)
-        end
-
-        it 'calls #remove_parent on the child with no arguments' do
-          expect(child).to receive(:remove_parent).once.with(no_args)
-          subject.remove_id(id)
-        end
-
-        it 'returns the given child' do
-          expect(subject.remove_id(id)).to eq(child)
-        end
-      end
-    end
-  end
-
-  describe '#each' do
-    it 'delegates to the #each implementation of the hash from #children' do
-      children = double(:children)
-
-      allow(subject).to receive(:children).and_return(children)
-      expect(subject).to receive(:children).once.with(no_args)
-      expect(children).to receive(:each).once
-
-      subject.each
-    end
-  end
+  it_behaves_like 'a composite'
+  it_behaves_like 'a composite with default #remove!'
+  it_behaves_like 'a composite with default #remove_id!'
 
+  #
+  # Specifications for Composite's default behaviour.
+  #
   describe '#get_child' do
-    before(:each) { allow(subject).to receive(:children).and_return(children) }
-    let(:children) { { in_children: child } }
-
     it 'calls #children' do
       expect(subject).to receive(:children).once
       subject.get_child(:in_children)
     end
-
-    context 'when the argument is in #children' do
-      it 'returns the child' do
-        expect(subject.get_child(:in_children)).to eq(child)
-      end
-    end
-
-    context 'when the argument is in #children' do
-      specify { expect(subject.get_child(:not_in_children)).to be_nil }
-    end
   end
 end

data/spec/hash_branch_spec.rb

@@ -1,14 +1,9 @@
 require 'spec_helper'
 require 'compo'
+require 'branch_shared_examples'
+require 'hash_composite_shared_examples'
 
 describe Compo::HashBranch do
-  describe '#initialize' do
-    it 'initialises with no parent' do
-      expect(subject.parent).to be_nil
-    end
-
-    it 'initialises with an ID function returning nil' do
-      expect(subject.id).to be_nil
-    end
-  end
+  it_behaves_like 'a branch'
+  it_behaves_like 'a hash composite'
 end