compo 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27f469c00cf86d294398a92e891752c829380282
-  data.tar.gz: f3e4f7776ea089dcd80d77a0827f4c77cca6c728
+  metadata.gz: da63ba2221a1640af2ce8c4d72710edf04653e07
+  data.tar.gz: 3459f6450e9b5cf6059afe212a14817c0d8bb6b2
 SHA512:
-  metadata.gz: c0f0d6d791a42006eeb243311980e21c04338b68ccb4157c54303db2f77b6d08d962a6bdc709385188b52be2fed5b20125c003515294d5e9f1d06fd06f6bca67
-  data.tar.gz: 35962706d2103ccad4c75fa5c4ed6131daa0bc2a9eef3361a056b7edaa692620e6975bb03999744d539fbff272c72ac5a87307ab0e24f9509e4fc7bb4296d5e5
+  metadata.gz: 4366f7d7e68bd32d1654efb4f64ce03f7df671e92e9201da820cbc5a169692fa855c9505e67ade09c10ad7af563c74bcd9d45fca061ee7b5a24a6f96c2b24a28
+  data.tar.gz: f09be088d6aba7563fe1d3a7a7c2a56d3c750d13ade1b5d95a1cbee479af09ceccc17e6c063bb021c7d6b58516ba470fec3700ab517af213c5bc7a94a6ca5bdb

data/CHANGELOG

@@ -1,3 +1,8 @@
+0.1.3 (2013-12-28)
+  - Implement ArrayBranch and HashBranch.  These bundle ArrayComposite and
+    HashComposite up with the Movable and ParentTracker mixins, for
+    convenience.
+
 0.1.2 (2013-12-27)
   - Implement and specify #get_child.
 

data/README.md

@@ -26,7 +26,27 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Compo consists of several classes and mixins that implement various parts of the composite pattern.  In increasing order of general usefulness, they are:
+
+### Base mixins
+
+- **Composite**, which specifies the #add/#remove/#remove_id/#get_child API on top of an implementation;
+- **Movable**, which creates a #move_to method that simplifies the act of moving a child between Composites;
+- **ParentTracker**, which implements keeping track of a child's parent and the child end of #add/#remove;
+
+### Composite implementation classes
+
+These implement the methods needed for **Composite** to work, but don't implement moving, parent tracking, or anything else.
+
+- **ArrayComposite**, which is a class that implements **Composite** using an Array, with IDs being the array indices;
+- **HashComposite**, which is a class that implements **Composite** using a Hash, with IDs being the hash keys;
+- **NullComposite**, which allows no children but implements **Composite** in a way such that all operations fail;
+
+### Simple leaf and node classes
+
+These include **Composite**, **Movable** and **ParentTracker**, and thus can be moved around, added to and removed from composites, and track their current parents and IDs.
+
+- **Leaf**, which is based on NullComposite and is intended for objects that don't have children but can be placed in other Composites.
 
 ## Contributing
 

data/lib/compo/array_branch.rb

@@ -0,0 +1,27 @@
+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 Movable
+    include ParentTracker
+
+    # Initialises the ArrayBranch
+    #
+    # The ArrayBranch is created with no children, no parent, and no ID.
+    #
+    # @api  public
+    # @example  Creates a new ArrayBranch.
+    #   branch = ArrayBranch.new
+    def initialize
+      super()
+      remove_parent
+    end
+  end
+end

data/lib/compo/hash_branch.rb

@@ -0,0 +1,28 @@
+module Compo
+  # A simple implementation of a branch, whose children are stored in an Hash
+  #
+  # An HashBranch is a composite object that may be moved into other composite
+  # objects.  It stores its children as an Hash, and the ID of each child is
+  # its hash key.  Inserting and removing items into the HashBranch will not
+  # change the IDs of other items, but inserting with an existing key will
+  # remove the previous occupant.
+  #
+  # This is an extension of HashComposite to include the Movable and
+  # ParentTracker mixins.
+  class HashBranch < HashComposite
+    include Movable
+    include ParentTracker
+
+    # Initialises the HashBranch
+    #
+    # The HashBranch is created with no children, no parent, and no ID.
+    #
+    # @api  public
+    # @example  Creates a new HashBranch.
+    #   branch = HashBranch.new
+    def initialize
+      super()
+      remove_parent
+    end
+  end
+end

data/lib/compo/leaf.rb

@@ -3,18 +3,22 @@ require 'compo/null_composite'
 require 'compo/parent_tracker'
 
 module Compo
-  # A simple implementation of a leaf
+  # A simple implementation of a leaf node
   #
-  # Leaves have no children, but can be moved to one.
+  # Leaves have no children, but can be moved to one.  They implement the
+  # Composite API, but all additions and removals fail, and the Leaf always
+  # reports no children.
   class Leaf < NullComposite
     include Movable
     include ParentTracker
 
     # Initialises the Leaf
     #
+    # The Leaf is created with no children, no parent, and no ID.
+    #
     # @api  public
     # @example  Creates a new Leaf.
-    #   leaf.new
+    #   leaf = Leaf.new
     def initialize
       remove_parent
     end

data/lib/compo/parent_tracker.rb

@@ -58,7 +58,7 @@ module Compo
     #
     # @return [void]
     def remove_parent
-      update_parent(nil, ->{ nil })
+      update_parent(nil, -> { nil })
     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.2'
+  VERSION = '0.1.3'
 end

data/lib/compo.rb

@@ -1,12 +1,21 @@
-require 'compo/array_composite'
+# Base mixins
 require 'compo/composite'
-require 'compo/hash_composite'
-require 'compo/leaf'
 require 'compo/movable'
-require 'compo/null_composite'
 require 'compo/parent_tracker'
+
+# Composite implementations
+require 'compo/array_composite'
+require 'compo/hash_composite'
+require 'compo/null_composite'
+
+# Leaf and branch classes
+require 'compo/array_branch'
+require 'compo/hash_branch'
+require 'compo/leaf'
+
+# Misc
 require 'compo/version'
 
-# The main module for Compo.
+# The main module for Compo
 module Compo
 end

data/spec/array_branch_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+require 'compo'
+
+describe Compo::ArrayBranch 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
+end

data/spec/hash_branch_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+require 'compo'
+
+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
+end

metadata

@@ -1,125 +1,125 @@
 --- !ruby/object:Gem::Specification
 name: compo
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Matt Windsor
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-27 00:00:00.000000000 Z
+date: 2013-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backports
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: fuubar
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: yardstick
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: "\n    Compo provides mixins and classes that assist in implementing
@@ -131,8 +131,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
 - CHANGELOG
 - Gemfile
 - LICENSE.txt
@@ -140,16 +140,20 @@ files:
 - Rakefile
 - compo.gemspec
 - lib/compo.rb
+- lib/compo/array_branch.rb
 - lib/compo/array_composite.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/version.rb
+- spec/array_branch_spec.rb
 - spec/array_composite_spec.rb
 - spec/composite_spec.rb
+- spec/hash_branch_spec.rb
 - spec/hash_composite_spec.rb
 - spec/leaf_spec.rb
 - spec/movable_spec.rb
@@ -166,23 +170,25 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.0.rc.1
 signing_key: 
 specification_version: 4
 summary: Composite pattern style mixins with IDs
 test_files:
+- spec/array_branch_spec.rb
 - spec/array_composite_spec.rb
 - spec/composite_spec.rb
+- spec/hash_branch_spec.rb
 - spec/hash_composite_spec.rb
 - spec/leaf_spec.rb
 - spec/movable_spec.rb