compo 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13ca1304045a3fb0ac403495a4c838b53aeecb65
-  data.tar.gz: 06039743fc1c5f084a2906d548ecf322b8a12aaf
+  metadata.gz: 914e22d4c5fb780ddfb95a6b71ecabf0046200b1
+  data.tar.gz: 91fa7096c61860f8aa06b7d773a3c8a490ac1cb6
 SHA512:
-  metadata.gz: 6de424684aa210f5f48c2d422dee5e44310ccacf6f2623d180c0f2934fa55ee7191b7a479b56badd9220ef1c0ee2dcb907d3df69e3f5063ea4079e2e8448a823
-  data.tar.gz: 6fd54c3de144b876874596fcc446e9b6a4f922f0c89fbaf4d2f6f423bc98d7f3fc10c58bc4d01fcc6d2a2d9d3a7c4beb1d7936684780965fe0ae6b9b389ea167
+  metadata.gz: b6477ff141c788b2889b06c7674bb0ffcb157880f739e7ab0532a866e917fe4df56c19dffb8794b69caaffb1f011ff463326435460334a95c58813cdea3d2c4c
+  data.tar.gz: 42527748f975f4e21bfbf8ca7b3b8cc46cda5304eaf586bd5ea37961c0ff9d998cec64641c8f3e82611248626796fdb1b7a352afb95e2037b459b04e7599e263

data/CHANGELOG

@@ -1,2 +1,7 @@
+0.1.1 (2013-12-27)
+  - Avoid a function name clash between #remove_parent on a child and
+    #remove_parent on a parent.  The latter is now #remove_parent_of.
+    #assign_parent is now #assign_parent_to, to match.
+
 0.1.0 (2013-12-26)
   - Initial version.

data/README.md

@@ -1,6 +1,14 @@
 # Compo
 
-TODO: Write a gem description
+**Compo** is a library providing mixins and base classes for setting up
+composite objects.
+
+It implements something similar to the Gang of Four Composite pattern, but with
+the difference that children are identified in their parents by an *ID*,
+such as the index or hash key, that the child is aware of at all times.
+
+Compo was designed for the purpose of creating models whose natural composite
+structure can be expressed as URLs made from their recursive ID trails.
 
 ## Installation
 

data/lib/compo/composite.rb

@@ -34,7 +34,7 @@ module Compo
     #
     # @return [Object]  The added child if successful; nil otherwise.
     def add(id, child)
-      add!(id, child).tap(&method(:assign_parent))
+      add!(id, child).tap(&method(:assign_parent_to))
     end
 
     # Removes a child from this Composite directly
@@ -50,7 +50,7 @@ module Compo
     #
     # @return [Object]  The removed child if successful; nil otherwise.
     def remove(child)
-      remove!(child).tap(&method(:remove_parent))
+      remove!(child).tap(&method(:remove_parent_of))
     end
 
     # Removes a child from this Composite, given its ID
@@ -66,7 +66,7 @@ module Compo
     #
     # @return [Object]  The removed child if successful; nil otherwise.
     def remove_id(id)
-      remove_id!(id).tap(&method(:remove_parent))
+      remove_id!(id).tap(&method(:remove_parent_of))
     end
 
     def_delegator :children, :each
@@ -83,7 +83,7 @@ module Compo
     # @param child [Object]  The child whose parent assignment is being set.
     #
     # @return [void]
-    def assign_parent(child)
+    def assign_parent_to(child)
       child.update_parent(self, id_function(child)) unless child.nil?
     end
 
@@ -96,7 +96,7 @@ module Compo
     # @param child [Object]  The child whose parent assignment is being set.
     #
     # @return [void]
-    def remove_parent(child)
+    def remove_parent_of(child)
       child.remove_parent unless child.nil?
     end
 

data/lib/compo/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: compo
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Matt Windsor
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-26 00:00:00.000000000 Z
+date: 2013-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backports