compo 0.3.1 → 0.4.0

data/spec/branch_spec.rb

@@ -4,7 +4,7 @@ require 'branch_shared_examples'
 
 # Mock implementation of a Branch
 class MockBranch
-  include Compo::Branch
+  include Compo::Branches::Branch
 end
 
 describe MockBranch do

data/spec/composite_shared_examples.rb

@@ -3,7 +3,7 @@ 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)
+      expect(parent).to be_a(Compo::Composites::Parentless)
     end
     op.call
   end

data/spec/composite_spec.rb

@@ -4,7 +4,7 @@ require 'composite_shared_examples'
 
 # Mock implementation of a Composite
 class MockComposite
-  include Compo::Composite
+  include Compo::Composites::Composite
 end
 
 describe MockComposite do

data/spec/constant_branch_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+require 'compo'
+require 'branch_shared_examples'
+require 'leaf_composite_shared_examples'
+
+describe Compo::Branches::Constant do
+  let(:value) { 3.141592653 }
+  subject { Compo::Branches::Constant.new(value) }
+
+  it_behaves_like 'a branch'
+  it_behaves_like 'a leaf composite'
+
+  describe '#value' do
+    it 'returns the constant value' do
+      expect(subject.value).to eq(value)
+    end
+  end
+end

data/spec/hash_branch_spec.rb

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

data/spec/hash_composite_shared_examples.rb

@@ -38,7 +38,7 @@ shared_examples 'a hash composite' do
 
       it 'calls #update_parent on the old child with a Parentless' do
         expect(child1).to receive(:update_parent).once do |parent, _|
-          expect(parent).to be_a(Compo::Parentless)
+          expect(parent).to be_a(Compo::Composites::Parentless)
         end
         subject.add(:a, child2)
       end
@@ -91,7 +91,7 @@ shared_examples 'a hash composite' do
 
       it 'calls #update_parent on the child with a Parentless' do
         expect(child1).to receive(:update_parent).once do |parent, _|
-          expect(parent).to be_a(Compo::Parentless)
+          expect(parent).to be_a(Compo::Composites::Parentless)
         end
         subject.remove(child1)
       end
@@ -139,7 +139,7 @@ shared_examples 'a hash composite' do
 
       it 'calls #update_parent on the child with a Parentless' do
         expect(child1).to receive(:update_parent).once do |parent, _|
-          expect(parent).to be_a(Compo::Parentless)
+          expect(parent).to be_a(Compo::Composites::Parentless)
         end
         subject.remove_id(:a)
       end

data/spec/hash_composite_spec.rb

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

data/spec/leaf_branch_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'compo'
+require 'branch_shared_examples'
+require 'leaf_composite_shared_examples'
+
+describe Compo::Branches::Leaf do
+  it_behaves_like 'a branch'
+  it_behaves_like 'a leaf composite'
+end

data/spec/{null_composite_shared_examples.rb → leaf_composite_shared_examples.rb}

@@ -1,6 +1,6 @@
 require 'composite_shared_examples'
 
-shared_examples 'a null composite' do
+shared_examples 'a leaf composite' do
   it_behaves_like 'a composite'
 
   let(:child1) { double(:child1) }

data/spec/leaf_composite_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+require 'compo'
+require 'leaf_composite_shared_examples'
+
+describe Compo::Composites::Leaf do
+  it_behaves_like 'a leaf composite'
+end

data/spec/movable_shared_examples.rb

@@ -46,7 +46,7 @@ shared_examples 'a movable object' do
       let(:new_parent) { nil }
 
       context 'and the Movable has no parent' do
-        let(:old_parent) { Compo::Parentless.new }
+        let(:old_parent) { Compo::Composites::Parentless.new }
 
         it_behaves_like 'a normal call to #move_to' do
           let(:to) { new_parent }
@@ -69,7 +69,7 @@ shared_examples 'a movable object' do
       let(:add_result) { nil }
 
       context 'and the Movable has no parent' do
-        let(:old_parent) { Compo::Parentless.new }
+        let(:old_parent) { Compo::Composites::Parentless.new }
 
         it_behaves_like 'a normal call to #move_to' do
           let(:to) { new_parent }
@@ -111,7 +111,7 @@ shared_examples 'a movable object' do
 
     context 'when the receiving parent allows the Movable to be added' do
       context 'and the Movable has no parent' do
-        let(:old_parent) { Compo::Parentless.new }
+        let(:old_parent) { Compo::Composites::Parentless.new }
 
         it_behaves_like 'a normal call to #move_to' do
           let(:to) { new_parent }

data/spec/movable_spec.rb

@@ -4,7 +4,7 @@ require 'movable_shared_examples'
 
 # Mock implementation of a Movable
 class MockMovable
-  include Compo::Movable
+  include Compo::Mixins::Movable
 end
 
 describe MockMovable do

data/spec/parent_tracker_spec.rb

@@ -3,14 +3,13 @@ require 'compo'
 
 # Mock implementation of a ParentTracker
 class MockParentTracker
-  include Compo::ParentTracker
+  include Compo::Mixins::ParentTracker
 
   # Initialises a MockParentTracker
   #
   # @api  private
   def initialize(parent, id_function)
-    @parent = parent
-    @id_function = id_function
+    update_parent(parent, id_function)
   end
 end
 
@@ -51,16 +50,4 @@ describe MockParentTracker do
       expect(subject.id).to eq(:new_id)
     end
   end
-
-  describe '#remove_parent' do
-    it 'sets the parent to an instance of Parentless' do
-      subject.remove_parent
-      expect(subject.parent).to be_a(Compo::Parentless)
-    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/parentless_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'compo'
 
-describe Compo::Parentless do
+describe Compo::Composites::Parentless do
   let(:child) { double(:child) }
 
   describe '#add' do
@@ -13,7 +13,7 @@ describe Compo::Parentless 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)
+        expect(parent).to be_a(Compo::Composites::Parentless)
       end
       subject.add(:id, child)
     end

data/spec/url_finder_shared_examples.rb

@@ -0,0 +1,104 @@
+require 'compo'
+
+shared_examples 'a URL finding' do
+  let(:target) { Compo::Branches::Leaf.new }
+
+  context 'when given a nil URL' do
+    specify { expect { |b| proc.call(nil, &b) }.to raise_error }
+  end
+
+  shared_examples 'a successful finding' do
+    it 'returns the correct resource' do
+      expect { |b| proc.call(url, &b) }.to yield_with_args(target)
+    end
+  end
+
+  shared_examples 'an unsuccessful finding' do
+    specify do
+      expect { |b| proc.call(url, &b) }.to raise_error(
+        "Could not find resource: #{url}"
+      )
+    end
+  end
+
+  shared_examples 'an unsuccessful finding with custom error' do
+    specify do
+      mp = ->(_) { :a }
+      expect { |b| proc.call(url, missing_proc: mp,  &b) }
+        .to yield_with_args(:a)
+    end
+  end
+
+  context 'when given a correct root but incorrect URL' do
+    context 'using the default missing resource handler' do
+      context 'when the URL has a leading slash' do
+        it_behaves_like 'an unsuccessful finding' do
+          let(:url) { "/#{incorrect_url}" }
+        end
+      end
+      context 'when the URL has a trailing slash' do
+        it_behaves_like 'an unsuccessful finding' do
+          let(:url) { "#{incorrect_url}/" }
+        end
+      end
+      context 'when the URL has a leading and trailing slash' do
+        it_behaves_like 'an unsuccessful finding' do
+          let(:url) { "/#{incorrect_url}/" }
+        end
+      end
+      context 'when the URL has neither leading nor trailing slash' do
+        it_behaves_like 'an unsuccessful finding' do
+          let(:url) { "#{incorrect_url}" }
+        end
+      end
+    end
+
+    context 'using a custom error handler' do
+      context 'when the URL has a leading slash' do
+        it_behaves_like 'an unsuccessful finding with custom error' do
+          let(:url) { "/#{incorrect_url}" }
+        end
+      end
+      context 'when the URL has a trailing slash' do
+        it_behaves_like 'an unsuccessful finding with custom error' do
+          let(:url) { "#{incorrect_url}/" }
+        end
+      end
+      context 'when the URL has a leading and trailing slash' do
+        it_behaves_like 'an unsuccessful finding with custom error' do
+          let(:url) { "/#{incorrect_url}/" }
+        end
+      end
+      context 'when the URL has neither leading nor trailing slash' do
+        it_behaves_like 'an unsuccessful finding with custom error' do
+          let(:url) { "#{incorrect_url}" }
+        end
+      end
+    end
+  end
+
+  context 'when given a correct root and URL' do
+    context 'when the URL leads to a resource' do
+      context 'when the URL has a leading slash' do
+        it_behaves_like 'a successful finding' do
+          let(:url) { "/#{correct_url}" }
+        end
+      end
+      context 'when the URL has a trailing slash' do
+        it_behaves_like 'a successful finding' do
+          let(:url) { "#{correct_url}/" }
+        end
+      end
+      context 'when the URL has a leading and trailing slash' do
+        it_behaves_like 'a successful finding' do
+          let(:url) { "/#{correct_url}/" }
+        end
+      end
+      context 'when the URL has neither leading nor trailing slash' do
+        it_behaves_like 'a successful finding' do
+          let(:url) { "#{correct_url}" }
+        end
+      end
+    end
+  end
+end

data/spec/url_finder_spec.rb

@@ -1,128 +1,39 @@
 require 'spec_helper'
 require 'compo'
+require 'url_finder_shared_examples'
 
-describe Compo::UrlFinder do
-  subject { Compo::UrlFinder }
+describe Compo::Finders::Url do
+  subject { Compo::Finders::Url }
   describe '.find' do
-    let(:target) { Compo::Leaf.new }
-
-    let(:root) do
-      s    = Compo::HashBranch.new
-      a    = Compo::HashBranch.new
-      b    = Compo::ArrayBranch.new
-      d    = Compo::Leaf.new
-      e    = Compo::Leaf.new
-      zero = Compo::Leaf.new
-
-      s.add('a', a)
-      a.add('b', b)
-      b.add(0, zero)
-      b.add(1, target)
-      s.add('d', d)
-      a.add('e', e)
-      s
-    end
-
     context 'when given a nil root' do
       specify { expect { |b| subject.find(nil, 'a/b/1', &b) }.to raise_error }
     end
 
-    context 'when given a nil URL' do
-      specify { expect { |b| subject.find(root, nil, &b) }.to raise_error }
-    end
-
-    shared_examples 'a successful finding' do
-      it 'returns the correct resource' do
-        expect { |b| subject.find(root, url, &b) }.to yield_with_args(target)
+    it_behaves_like 'a URL finding' do
+      let(:target) { Compo::Branches::Leaf.new }
+
+      let(:root) do
+        s    = Compo::Branches::Hash.new
+        a    = Compo::Branches::Hash.new
+        b    = Compo::Branches::Array.new
+        d    = Compo::Branches::Leaf.new
+        e    = Compo::Branches::Leaf.new
+        zero = Compo::Branches::Leaf.new
+
+        s.add('a', a)
+        a.add('b', b)
+        b.add(0, zero)
+        b.add(1, target)
+        s.add('d', d)
+        a.add('e', e)
+        s
       end
-    end
 
-    shared_examples 'an unsuccessful finding' do
-      specify do
-        expect { |b| subject.find(root, url, &b) }.to raise_error(
-          "Could not find resource: #{url}"
-        )
-      end
-    end
-
-    shared_examples 'an unsuccessful finding with custom error' do
-      specify do
-        mp = ->(_) { :a }
-        expect { |b| subject.find(root, url, missing_proc: mp,  &b) }
-          .to yield_with_args(:a)
-      end
-    end
-
-    context 'when given a correct root but incorrect URL' do
-      context 'using the default missing resource handler' do
-        context 'when the URL has a leading slash' do
-          it_behaves_like 'an unsuccessful finding' do
-            let(:url) { '/a/z' }
-          end
-        end
-        context 'when the URL has a trailing slash' do
-          it_behaves_like 'an unsuccessful finding' do
-            let(:url) { 'a/z/' }
-          end
-        end
-        context 'when the URL has a leading and trailing slash' do
-          it_behaves_like 'an unsuccessful finding' do
-            let(:url) { '/a/z/' }
-          end
-        end
-        context 'when the URL has neither leading nor trailing slash' do
-          it_behaves_like 'an unsuccessful finding' do
-            let(:url) { 'a/z' }
-          end
-        end
-      end
-
-      context 'using a custom error handler' do
-        context 'when the URL has a leading slash' do
-          it_behaves_like 'an unsuccessful finding with custom error' do
-            let(:url) { '/d/e/d' }
-          end
-        end
-        context 'when the URL has a trailing slash' do
-          it_behaves_like 'an unsuccessful finding with custom error' do
-            let(:url) { 'd/e/d/' }
-          end
-        end
-        context 'when the URL has a leading and trailing slash' do
-          it_behaves_like 'an unsuccessful finding with custom error' do
-            let(:url) { '/d/e/d/' }
-          end
-        end
-        context 'when the URL has neither leading nor trailing slash' do
-          it_behaves_like 'an unsuccessful finding with custom error' do
-            let(:url) { 'd/e/d' }
-          end
-        end
-      end
-    end
+      let(:correct_url)   { 'a/b/1' }
+      let(:incorrect_url) { 'a/z/1' }
 
-    context 'when given a correct root and URL' do
-      context 'when the URL leads to a resource' do
-        context 'when the URL has a leading slash' do
-          it_behaves_like 'a successful finding' do
-            let(:url) { '/a/b/1' }
-          end
-        end
-        context 'when the URL has a trailing slash' do
-          it_behaves_like 'a successful finding' do
-            let(:url) { 'a/b/1/' }
-          end
-        end
-        context 'when the URL has a leading and trailing slash' do
-          it_behaves_like 'a successful finding' do
-            let(:url) { '/a/b/1/' }
-          end
-        end
-        context 'when the URL has neither leading nor trailing slash' do
-          it_behaves_like 'a successful finding' do
-            let(:url) { 'a/b/1' }
-          end
-        end
+      let(:proc) do
+        ->(*args, &b) { Compo::Finders::Url.find(root, *args, &b) }
       end
     end
   end

data/spec/url_referenceable_spec.rb

@@ -4,7 +4,7 @@ require 'url_referenceable_shared_examples'
 
 # Mock implementation of UrlReferenceable.
 class MockUrlReferenceable
-  include Compo::UrlReferenceable
+  include Compo::Mixins::UrlReferenceable
 end
 
 describe MockUrlReferenceable do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: compo
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Matt Windsor
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-21 00:00:00.000000000 Z
+date: 2014-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backports
@@ -140,19 +140,24 @@ files:
 - Rakefile
 - compo.gemspec
 - lib/compo.rb
-- lib/compo/array_branch.rb
-- lib/compo/array_composite.rb
-- lib/compo/branch.rb
-- lib/compo/composite.rb
-- lib/compo/hash_branch.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/parentless.rb
-- lib/compo/url_finder.rb
-- lib/compo/url_referenceable.rb
+- lib/compo/branches.rb
+- lib/compo/branches/array.rb
+- lib/compo/branches/branch.rb
+- lib/compo/branches/constant.rb
+- lib/compo/branches/hash.rb
+- lib/compo/branches/leaf.rb
+- lib/compo/composites.rb
+- lib/compo/composites/array.rb
+- lib/compo/composites/composite.rb
+- lib/compo/composites/hash.rb
+- lib/compo/composites/leaf.rb
+- lib/compo/composites/parentless.rb
+- lib/compo/finders.rb
+- lib/compo/finders/url.rb
+- lib/compo/mixins.rb
+- lib/compo/mixins/movable.rb
+- lib/compo/mixins/parent_tracker.rb
+- lib/compo/mixins/url_referenceable.rb
 - lib/compo/version.rb
 - spec/array_branch_spec.rb
 - spec/array_composite_shared_examples.rb
@@ -161,17 +166,19 @@ files:
 - spec/branch_spec.rb
 - spec/composite_shared_examples.rb
 - spec/composite_spec.rb
+- spec/constant_branch_spec.rb
 - spec/hash_branch_spec.rb
 - spec/hash_composite_shared_examples.rb
 - spec/hash_composite_spec.rb
-- spec/leaf_spec.rb
+- spec/leaf_branch_spec.rb
+- spec/leaf_composite_shared_examples.rb
+- spec/leaf_composite_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_finder_shared_examples.rb
 - spec/url_finder_spec.rb
 - spec/url_referenceable_shared_examples.rb
 - spec/url_referenceable_spec.rb
@@ -207,17 +214,19 @@ test_files:
 - spec/branch_spec.rb
 - spec/composite_shared_examples.rb
 - spec/composite_spec.rb
+- spec/constant_branch_spec.rb
 - spec/hash_branch_spec.rb
 - spec/hash_composite_shared_examples.rb
 - spec/hash_composite_spec.rb
-- spec/leaf_spec.rb
+- spec/leaf_branch_spec.rb
+- spec/leaf_composite_shared_examples.rb
+- spec/leaf_composite_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_finder_shared_examples.rb
 - spec/url_finder_spec.rb
 - spec/url_referenceable_shared_examples.rb
 - spec/url_referenceable_spec.rb

data/lib/compo/array_branch.rb

@@ -1,16 +0,0 @@
-require 'compo/branch'
-
-module Compo
-  # A simple implementation of a branch, whose children are stored in an Array
-  #
-  # An ArrayBranch is a composite object that may be moved into other composite
-  # objects.  It stores its children as an Array, and the ID of each child is
-  # its current index in the array.  Inserting and removing items into the
-  # ArrayBranch may change the IDs of items with higher indices in the array.
-  #
-  # This is an extension of ArrayComposite to include the Movable and
-  # ParentTracker mixins.
-  class ArrayBranch < ArrayComposite
-    include Branch
-  end
-end