compo 0.4.0 → 0.5.0

data/spec/array_composite_spec.rb

@@ -2,6 +2,6 @@ require 'spec_helper'
 require 'compo'
 require 'array_composite_shared_examples'
 
-describe Compo::Composites::Array do
+RSpec.describe Compo::Composites::Array do
   it_behaves_like 'an array composite'
 end

data/spec/branch_shared_examples.rb

@@ -2,7 +2,7 @@ require 'url_finder_shared_examples'
 require 'url_referenceable_shared_examples'
 require 'movable_shared_examples'
 
-shared_examples 'a branch' do
+RSpec.shared_examples 'a branch' do
   it_behaves_like 'a URL referenceable object'
   it_behaves_like 'a movable object'
 
@@ -16,6 +16,11 @@ shared_examples 'a branch' do
     end
   end
 
+  shared_context 'the branch has a parent' do
+    let(:parent) { Compo::Branches::Hash.new }
+    before(:each) { subject.move_to(parent, :id) }
+  end
+
   describe '#url' do
     context 'when the Branch has no parent' do
       it 'returns the empty string' do
@@ -23,8 +28,7 @@ shared_examples 'a branch' do
       end
     end
     context 'when the Branch is the child of a root' do
-      let(:parent) { Compo::Branches::Hash.new }
-      before(:each) { subject.move_to(parent, :id) }
+      include_context 'the branch has a parent'
 
       it 'returns /ID, where ID is the ID of the Branch' do
         expect(subject.url).to eq('/id')
@@ -35,8 +39,7 @@ shared_examples 'a branch' do
   describe '#move_to' do
     context 'when the Branch has a parent' do
       context 'when the new parent is nil' do
-        let(:parent) { Compo::Branches::Hash.new }
-        before(:each) { subject.move_to(parent, :id) }
+        include_context 'the branch has a parent'
 
         it 'loses its previous parent' do
           expect(subject.move_to(nil, :id).parent).to be_a(
@@ -53,7 +56,7 @@ shared_examples 'a branch' do
   end
 end
 
-shared_examples 'a branch with children' do
+RSpec.shared_examples 'a branch with children' do
   it_behaves_like 'a branch'
 
   describe '#find_url' do

data/spec/branch_spec.rb

@@ -7,6 +7,6 @@ class MockBranch
   include Compo::Branches::Branch
 end
 
-describe MockBranch do
+RSpec.describe MockBranch do
   it_behaves_like 'a branch'
 end

data/spec/composite_shared_examples.rb

@@ -1,6 +1,6 @@
 require 'compo'
 
-shared_examples 'a removal of a child from its parent' do
+RSpec.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::Composites::Parentless)
@@ -16,7 +16,7 @@ shared_examples 'a removal of a child from its parent' do
   end
 end
 
-shared_examples 'a composite' do
+RSpec.shared_examples 'a composite' do
   let(:id) { double(:id) }
   let(:child) { double(:child) }
 
@@ -32,7 +32,19 @@ shared_examples 'a composite' do
     end
   end
 
+  describe '#on_node' do
+    it 'calls the block given with the subject' do
+      expect { |block| subject.on_node(&block) }.to yield_with_args(subject)
+    end
+
+    it 'returns the result of the block' do
+      expect(subject.on_node { |subject| subject }).to eq(subject)
+      expect(subject.on_node { 3 }).to eq(3)
+    end
+  end
+
   describe '#add' do
+    let(:idf) { double(:id_function) }
     before(:each) { allow(subject).to receive(:add!) }
 
     context 'when #add! returns nil' do
@@ -48,26 +60,24 @@ shared_examples 'a composite' do
 
     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(subject).to receive_messages(add!: child, id_function: nil)
         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)
+        expect(subject).to have_received(:add!).once.with(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)
+        expect(subject).to have_received(:id_function).once.with(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)
+        expect(child).to have_received(:update_parent).once.with(subject, idf)
       end
 
       it 'returns the given child' do
@@ -95,16 +105,18 @@ shared_examples 'a composite' do
   end
 end
 
-shared_examples 'a composite with default #remove!' do
+RSpec.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!) }
+      before(:each) do
+        allow(subject).to receive(:remove!).and_return(remove_result)
+      end
 
       context 'when #remove! returns nil' do
-        before(:each) { allow(subject).to receive(:remove!).and_return(nil) }
+        let(:remove_result) { nil }
 
         specify { expect(subject.remove(child)).to be_nil }
 
@@ -115,10 +127,8 @@ shared_examples 'a composite with default #remove!' do
       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
+        let(:remove_result) { child }
+        before(:each)       { allow(child).to receive(:update_parent) }
 
         it 'calls #remove! with the child given' do
           expect(subject).to receive(:remove!).once.with(child)
@@ -137,40 +147,40 @@ shared_examples 'a composite with default #remove!' do
 
     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)
+        allow(subject).to receive_messages(remove_id!: remove_id_result,
+                                           children:   { id => child })
       end
 
       context 'when #remove_id! returns nil' do
-        before(:each) do
-          allow(subject).to receive(:remove_id!).and_return(nil)
-        end
+        let(:remove_id_result) { nil }
 
         specify { expect(subject.remove(child)).to be_nil }
 
         it 'calls #remove! with the child given' do
+          # Note: #remove! is not a stub, so we must use this form of
+          # expectation.
           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)
+          expect(subject).to have_received(:remove_id!).once.with(id)
         end
 
         it 'calls #children' do
-          expect(subject).to receive(:children).once
           subject.remove(child)
+          expect(subject).to have_received(:children).once
         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
+        let(:remove_id_result) { child }
+        before(:each)          { allow(child).to receive(:update_parent) }
 
-        it 'calls #remove_id! with the child given' do
+        it 'calls #remove! with the child given' do
+          # Note: #remove! is not a stub, so we must use this form of
+          # expectation.
           expect(subject).to receive(:remove!).once.with(child)
           subject.remove(child)
         end
@@ -187,38 +197,34 @@ shared_examples 'a composite with default #remove!' do
   end
 end
 
-shared_examples 'a composite with default #remove_id!' do
+RSpec.shared_examples 'a composite with default #remove_id!' do
   let(:child) { double(:child) }
-  let(:id) { double(:id) }
+  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!) }
+      before(:each) do
+        allow(subject).to receive(:remove_id!).and_return(remove_id_result)
+      end
 
       context 'and #remove_id! returns nil' do
-        before(:each) do
-          allow(subject).to receive(:remove_id!).and_return(nil)
-        end
+        let(:remove_id_result) { nil }
 
         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)
+          expect(subject).to have_received(:remove_id!).once.with(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
+        let(:remove_id_result) { child }
+        before(:each)          { allow(child).to receive(:update_parent) }
 
         it 'calls #remove_id! with the ID given' do
-          expect(subject).to receive(:remove_id!).once.with(id)
           subject.remove_id(id)
+          expect(subject).to have_received(:remove_id!).once.with(id)
         end
 
         it_behaves_like 'a removal of a child from its parent' do
@@ -232,42 +238,53 @@ shared_examples 'a composite with default #remove_id!' do
     end
 
     context 'when #remove! is defined but #remove_id! is not' do
-      before(:each) { allow(subject).to receive(:remove!) }
+      before(:each) do
+        allow(subject).to receive(:remove!).and_return(remove_result)
+      end
 
       context 'and #remove! returns nil' do
+        let(:remove_result) { nil }
         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
+          # Note: #remove_id! is not a stub, so we must use this form of
+          # expectation.
           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)
+          expect(subject).to have_received(:get_child).once.with(id)
         end
 
         it 'calls #remove! with the child given' do
-          expect(subject).to receive(:remove!).once.with(child)
           subject.remove_id(id)
+          expect(subject).to have_received(:remove!).once.with(child)
         end
       end
 
       context 'and #remove! returns the child' do
+        let(:remove_result) { child }
         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_id! with the ID given' do
+          # Note: #remove_id! is not a stub, so we must use this form of
+          # expectation.
+          expect(subject).to receive(:remove_id!).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)
+          expect(subject).to have_received(:remove!).once.with(child)
         end
 
         it_behaves_like 'a removal of a child from its parent' do

data/spec/composite_spec.rb

@@ -7,7 +7,7 @@ class MockComposite
   include Compo::Composites::Composite
 end
 
-describe MockComposite do
+RSpec.describe MockComposite do
   before(:each) { allow(subject).to receive(:children).and_return(children) }
   let(:children) { { in_children: child } }
   let(:child) { double(:child) }

data/spec/constant_branch_spec.rb

@@ -3,7 +3,7 @@ require 'compo'
 require 'branch_shared_examples'
 require 'leaf_composite_shared_examples'
 
-describe Compo::Branches::Constant do
+RSpec.describe Compo::Branches::Constant do
   let(:value) { 3.141592653 }
   subject { Compo::Branches::Constant.new(value) }
 

data/spec/hash_branch_spec.rb

@@ -3,7 +3,7 @@ require 'compo'
 require 'branch_shared_examples'
 require 'hash_composite_shared_examples'
 
-describe Compo::Branches::Hash do
+RSpec.describe Compo::Branches::Hash do
   it_behaves_like 'a branch with children' do
     let(:initial_ids) { %w(a b) }
   end

data/spec/hash_composite_shared_examples.rb

@@ -1,7 +1,7 @@
 require 'compo'
 require 'composite_shared_examples'
 
-shared_examples 'a hash composite' do
+RSpec.shared_examples 'a hash composite' do
   it_behaves_like 'a composite'
 
   let(:child1) { double(:child1) }
@@ -22,10 +22,9 @@ shared_examples 'a hash composite' do
       end
 
       it 'replaces the old child in the child hash' do
-        expect(subject.children).to eq(a: child1)
-
-        subject.add(:a, child2)
-        expect(subject.children).to eq(a: child2)
+        expect { subject.add(:a, child2) }.to change { subject.children }
+                                          .from(a: child1)
+                                          .to(a: child2)
       end
 
       it 'calls #update_parent on the new child with itself and an ID proc' do
@@ -61,14 +60,15 @@ shared_examples 'a hash composite' do
       it 'adds to the child hash' do
         expect(subject.children).to eq({})
 
-        subject.add(:a, child1)
-        expect(subject.children).to eq(a: child1)
-
-        subject.add(:b, child2)
-        expect(subject.children).to eq(a: child1, b: child2)
-
-        subject.add(:c, child3)
-        expect(subject.children).to eq(a: child1, b: child2, c: child3)
+        expect { subject.add(:a, child1) }.to change { subject.children }
+                                          .from({})
+                                          .to(a: child1)
+        expect { subject.add(:b, child2) }.to change { subject.children }
+                                          .from(a: child1)
+                                          .to(a: child1, b: child2)
+        expect { subject.add(:c, child3) }.to change { subject.children }
+                                          .from(a: child1, b: child2)
+                                          .to(a: child1, b: child2, c: child3)
       end
 
       it 'calls #update_parent on the child with itself and an ID proc' do
@@ -106,9 +106,10 @@ shared_examples 'a hash composite' do
       it 'removes the child, and only the child, from the children hash' do
         subject.add(:b, child2)
         subject.add(:c, child3)
-        expect(subject.children).to eq(a: child1, b: child2, c: child3)
-        subject.remove(child2)
-        expect(subject.children).to eq(a: child1, c: child3)
+
+        expect { subject.remove(child2) }.to change { subject.children }
+                                         .from(a: child1, b: child2, c: child3)
+                                         .to(a: child1, c: child3)
       end
     end
 
@@ -116,15 +117,13 @@ shared_examples 'a hash composite' do
       specify { expect(subject.remove(child1)).to be_nil }
 
       it 'does not change the children' do
-        expect(subject.children).to eq({})
-        subject.remove(child1)
-        expect(subject.children).to eq({})
+        expect { subject.remove(child1) }.to_not change { subject.children }
+                                         .from({})
 
         subject.add(:a, child1)
         subject.add(:b, child2)
-        expect(subject.children).to eq(a: child1, b: child2)
-        subject.remove(child3)
-        expect(subject.children).to eq(a: child1, b: child2)
+        expect { subject.remove(child3) }.to_not change { subject.children }
+                                         .from(a: child1, b: child2)
       end
     end
   end
@@ -154,9 +153,9 @@ shared_examples 'a hash composite' do
       it 'does not change the IDs of other children' do
         subject.add(:b, child2)
         subject.add(:c, child3)
-        expect(subject.children).to eq(a: child1, b: child2, c: child3)
-        subject.remove_id(:b)
-        expect(subject.children).to eq(a: child1, c: child3)
+        expect { subject.remove_id(:b) }.to change { subject.children }
+                                        .from(a: child1, b: child2, c: child3)
+                                        .to(a: child1, c: child3)
       end
     end
 
@@ -164,15 +163,13 @@ shared_examples 'a hash composite' do
       specify { expect(subject.remove_id(:a)).to be_nil }
 
       it 'does not change the children' do
-        expect(subject.children).to eq({})
-        subject.remove_id(:a)
-        expect(subject.children).to eq({})
+        expect { subject.remove_id(:a) }.to_not change { subject.children }
+                                        .from({})
 
         subject.add(:a, child1)
         subject.add(:b, child2)
-        expect(subject.children).to eq(a: child1, b: child2)
-        subject.remove_id(:c)
-        expect(subject.children).to eq(a: child1, b: child2)
+        expect { subject.remove_id(:c) }.to_not change { subject.children }
+                                        .from(a: child1, b: child2)
       end
     end
   end

data/spec/hash_composite_spec.rb

@@ -2,6 +2,6 @@ require 'spec_helper'
 require 'compo'
 require 'hash_composite_shared_examples'
 
-describe Compo::Composites::Hash do
+RSpec.describe Compo::Composites::Hash do
   it_behaves_like 'a hash composite'
 end

data/spec/leaf_branch_spec.rb

@@ -3,7 +3,7 @@ require 'compo'
 require 'branch_shared_examples'
 require 'leaf_composite_shared_examples'
 
-describe Compo::Branches::Leaf do
+RSpec.describe Compo::Branches::Leaf do
   it_behaves_like 'a branch'
   it_behaves_like 'a leaf composite'
 end

data/spec/leaf_composite_shared_examples.rb

@@ -1,47 +1,33 @@
 require 'composite_shared_examples'
 
-shared_examples 'a leaf composite' do
+RSpec.shared_examples 'a leaf composite' do
   it_behaves_like 'a composite'
 
-  let(:child1) { double(:child1) }
-  let(:child2) { double(:child2) }
-  let(:child3) { double(:child3) }
+  let(:c1) { double(:child1) }
+  let(:c2) { double(:child2) }
+  let(:c3) { 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
+      expect(subject.add(1, c1)).to be_nil
+      expect(subject.add(:a, c2)).to be_nil
+      expect(subject.add(nil, c3)).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({})
+      expect { subject.add(1, c1) }.to_not change { subject.children }.from({})
+      expect { subject.add(:a, c2) }.to_not change { subject.children }.from({})
+      expect { subject.add(:a, c3) }.to_not change { subject.children }.from({})
     end
   end
 
   describe '#remove' do
-    specify { expect(subject.remove(child1)).to eq(nil) }
+    specify { expect(subject.remove(c1)).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({})
+      expect { subject.remove(c1) }.to_not change { subject.children }.from({})
+      expect { subject.remove(c2) }.to_not change { subject.children }.from({})
+      expect { subject.remove(c3) }.to_not change { subject.children }.from({})
     end
   end
 

data/spec/leaf_composite_spec.rb

@@ -2,6 +2,6 @@ require 'spec_helper'
 require 'compo'
 require 'leaf_composite_shared_examples'
 
-describe Compo::Composites::Leaf do
+RSpec.describe Compo::Composites::Leaf do
   it_behaves_like 'a leaf composite'
 end

data/spec/movable_shared_examples.rb

@@ -1,6 +1,6 @@
 require 'compo'
 
-shared_examples 'a normal call to #move_to' do
+RSpec.shared_examples 'a normal call to #move_to' do
   it 'returns itself' do
     expect(subject.move_to(to, :test)).to eq(subject)
   end
@@ -11,14 +11,14 @@ shared_examples 'a normal call to #move_to' do
   end
 end
 
-shared_examples 'a removal from the old parent' do
+RSpec.shared_examples 'a removal from the old parent' do
   it 'calls #remove on the old parent with the Movable' do
     expect(from).to receive(:remove).once.with(subject)
     subject.move_to(to, :test)
   end
 end
 
-shared_examples 'an addition to the new parent' do
+RSpec.shared_examples 'an addition to the new parent' do
   it 'calls #add on the new parent with the ID and Movable' do
     expect(to).to_not be_nil
     expect(to).to receive(:add).once.with(:test, subject)
@@ -26,7 +26,7 @@ shared_examples 'an addition to the new parent' do
   end
 end
 
-shared_examples 'a movable object' do
+RSpec.shared_examples 'a movable object' do
   let(:old_parent)    { double(:old_parent) }
   let(:new_parent)    { double(:new_parent) }
   let(:remove_result) { subject }

data/spec/movable_spec.rb

@@ -7,6 +7,6 @@ class MockMovable
   include Compo::Mixins::Movable
 end
 
-describe MockMovable do
+RSpec.describe MockMovable do
   it_behaves_like 'a movable object'
 end

data/spec/parent_tracker_spec.rb

@@ -13,7 +13,7 @@ class MockParentTracker
   end
 end
 
-describe MockParentTracker do
+RSpec.describe MockParentTracker do
   subject { MockParentTracker.new(parent, id_function) }
   let(:parent) { double(:parent) }
   let(:id_function) { double(:id_function) }