compo 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da63ba2221a1640af2ce8c4d72710edf04653e07
-  data.tar.gz: 3459f6450e9b5cf6059afe212a14817c0d8bb6b2
+  metadata.gz: 2c288d0dcd9919802b30e9a7474bbed1ec62ae69
+  data.tar.gz: 63ae3aee08834eec7facefebbccc5e4ba8c8983b
 SHA512:
-  metadata.gz: 4366f7d7e68bd32d1654efb4f64ce03f7df671e92e9201da820cbc5a169692fa855c9505e67ade09c10ad7af563c74bcd9d45fca061ee7b5a24a6f96c2b24a28
-  data.tar.gz: f09be088d6aba7563fe1d3a7a7c2a56d3c750d13ade1b5d95a1cbee479af09ceccc17e6c063bb021c7d6b58516ba470fec3700ab517af213c5bc7a94a6ca5bdb
+  metadata.gz: 38177f5e0602736715d5e682593dec1eaa28ea64e4f95ea2ed1ae62b82f9d2e98d298643c4b2f9270f2a20286ef6a2c1fd4b3df98e40fbd4ca9ff611b20970d2
+  data.tar.gz: 8c9b77ab21a06ba68029074426bd1c391bd02d147623823627fd4cc848118ac73da8d60204f3e119e6b1e1720ede82cdd1c7b4fa540ee17c29b68d524876c2ff

data/CHANGELOG

@@ -1,3 +1,10 @@
+0.1.4 (2013-12-28)
+  - Implement UrlReferenceable.  This adds two new functions, #url and
+    #parent_url, which retrieve a slash/delimited/string/of/IDs starting from
+    the first child in the parent chain from the caller and its parent
+    respectively.
+  - Include UrlReferenceable in ArrayBranch, HashBranch and Leaf.
+
 0.1.3 (2013-12-28)
   - Implement ArrayBranch and HashBranch.  These bundle ArrayComposite and
     HashComposite up with the Movable and ParentTracker mixins, for

data/lib/compo/array_branch.rb

@@ -11,6 +11,7 @@ module Compo
   class ArrayBranch < ArrayComposite
     include Movable
     include ParentTracker
+    include UrlReferenceable
 
     # Initialises the ArrayBranch
     #

data/lib/compo/hash_branch.rb

@@ -12,6 +12,7 @@ module Compo
   class HashBranch < HashComposite
     include Movable
     include ParentTracker
+    include UrlReferenceable
 
     # Initialises the HashBranch
     #

data/lib/compo/leaf.rb

@@ -11,6 +11,7 @@ module Compo
   class Leaf < NullComposite
     include Movable
     include ParentTracker
+    include UrlReferenceable
 
     # Initialises the Leaf
     #

data/lib/compo/url_referenceable.rb

@@ -0,0 +1,49 @@
+module Compo
+  # Adds ID-based 'URL's to Compo classes
+  #
+  # For the purposes of this module, a URL is a string of slash-delimited IDs
+  # representing the location of a Composite in the tree structure formed by
+  # its ancestors.  Depending on the types of IDs used in the structure, the
+  # URLs may not actually be literal Uniform Resource Locators.
+  #
+  # This module expects its includer to define #parent and #id.  These are
+  # defined, for example, by the Compo::ParentTracker mixin.
+  module UrlReferenceable
+    # Returns the URL of this object
+    #
+    # The #url of a Composite is defined inductively as '' for composites that
+    # have no parent, and the joining of the parent URL and the current ID
+    # otherwise.
+    #
+    # The result of #url can be used to give a URL hierarchy to Composites.
+    #
+    # @api  public
+    # @example  Gets the URL of an object with no parent.
+    #   orphan.url
+    #   #=> ''
+    # @example  Gets the URL of an object with a parent.
+    #   leaf.url
+    #   #=> 'grandparent_id/parent_id/id'
+    #
+    # @return [String]  The URL of this object.
+    def url
+      parent.nil? ? '' : [parent_url, id].join('/')
+    end
+
+    # Returns the URL of this object's parent
+    #
+    # @api  public
+    # @example  Gets the parent URL of an object with no parent.
+    #   orphan.parent_url
+    #   #=> nil
+    # @example  Gets the URL of an object with a parent.
+    #   leaf.parent_url
+    #   #=> 'grandparent_id/parent_id'
+    #
+    # @return [String]  The URL of this object's parent, or nil if there is no
+    #   parent.
+    def parent_url
+      parent.nil? ? nil : parent.url
+    end
+  end
+end

data/lib/compo/version.rb

@@ -1,4 +1,4 @@
 # The current gem version.  See CHANGELOG for information.
 module Compo
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
 end

data/lib/compo.rb

@@ -2,6 +2,7 @@
 require 'compo/composite'
 require 'compo/movable'
 require 'compo/parent_tracker'
+require 'compo/url_referenceable'
 
 # Composite implementations
 require 'compo/array_composite'

data/spec/leaf_spec.rb

@@ -11,4 +11,20 @@ describe Compo::Leaf 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/url_referenceable_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+require 'compo'
+
+# Mock implementation of UrlReferenceable.
+class MockUrlReferenceable
+  include Compo::UrlReferenceable
+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
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: compo
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Matt Windsor
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-28 00:00:00.000000000 Z
+date: 2013-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backports
@@ -149,6 +149,7 @@ files:
 - lib/compo/movable.rb
 - lib/compo/null_composite.rb
 - lib/compo/parent_tracker.rb
+- lib/compo/url_referenceable.rb
 - lib/compo/version.rb
 - spec/array_branch_spec.rb
 - spec/array_composite_spec.rb
@@ -160,6 +161,7 @@ files:
 - spec/null_composite_spec.rb
 - spec/parent_tracker_spec.rb
 - spec/spec_helper.rb
+- spec/url_referenceable_spec.rb
 homepage: http://github.com/CaptainHayashi/compo
 licenses:
 - MIT
@@ -195,4 +197,5 @@ test_files:
 - spec/null_composite_spec.rb
 - spec/parent_tracker_spec.rb
 - spec/spec_helper.rb
+- spec/url_referenceable_spec.rb
 has_rdoc: