compo 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6db898fd60a7a46a30a7d851bd634c2be59a1d4
-  data.tar.gz: 78d2ccf08de768e42ca7df43a29f6491b0adbcfb
+  metadata.gz: de0ae1a9f06c21a0818cb86865d5bd26d79aa7e0
+  data.tar.gz: 7cce675b54964af406c7391913fde1b8f6741c34
 SHA512:
-  metadata.gz: 1694942f4173cd3c464a66d904ff36044ea714c79c8e2c8fc708d7c2d296dd28da42d760ebae89442c3734bf692fbf7ee3feceeebeecab5d00ce0d47ffa75f20
-  data.tar.gz: 1c7db6618f24c57980ad14b6200cd212d516d4c800e5718fe46964576eb9ec6175c06d3a1337997507fe972ba70da7b3bcd92d396026e527a99301217b1e3d17
+  metadata.gz: 075f6b9688444e1ee13333c97fddf7fce91d897ac4088df6e56fa9c1a5cce5e75b2a279ed2ecbc89999d72da57e95d380f830490a847c7a288586ef06b32abce
+  data.tar.gz: 6900ffec47c87b03f12de21196b2a603b54569882a5e20ee682e5eca555740d2e33ee887f102142f447406ccd6a32dea89e3fe253a9057178ac4bcac91d3a0b9

data/CHANGELOG

@@ -1,3 +1,11 @@
+0.3.0 (2014-05-21)
+  - Require bundler 1.6.
+  - Remove some unnecessary checks for nil: Parentless should be used instead.
+    (This could be construed as a backwards incompatibility, hence the version
+    bump.)
+  - Factor out branch mixins into a new Branch mixin.
+  - Some Rubocop fixes.
+
 0.2.0 (2013-12-29)
   - (BACKWARDS INCOMPATIBILITY) Implement Parentless as a null object for the
     result of calling #parent on a parentless child.  This case now returns

data/Rakefile

@@ -1,7 +1,7 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new
 
-task :default => :spec
-task :test => :spec
+task default: :spec
+task test: :spec

data/compo.gemspec

@@ -2,28 +2,29 @@
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'compo/version'
+require 'English'
 
 Gem::Specification.new do |spec|
   spec.name          = 'compo'
   spec.version       = Compo::VERSION
   spec.authors       = ['Matt Windsor']
   spec.email         = ['matt.windsor@ury.org.uk']
-  spec.description   = %q{
+  spec.description   = %q(
     Compo provides mixins and classes that assist in implementing a variant of
     the Composite design pattern, in which each child has an ID that uniquely
     identifies it inside the parent's child set.
-  }
+  )
   spec.summary       = 'Composite pattern style mixins with IDs'
   spec.homepage      = 'http://github.com/CaptainHayashi/compo'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'backports'
-  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'fuubar'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'

data/lib/compo/array_branch.rb

@@ -1,3 +1,5 @@
+require 'compo/branch'
+
 module Compo
   # A simple implementation of a branch, whose children are stored in an Array
   #
@@ -9,20 +11,6 @@ module Compo
   # This is an extension of ArrayComposite to include the Movable and
   # ParentTracker mixins.
   class ArrayBranch < ArrayComposite
-    include Movable
-    include ParentTracker
-    include UrlReferenceable
-
-    # 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
+    include Branch
   end
 end

data/lib/compo/branch.rb

@@ -0,0 +1,18 @@
+require 'compo/movable'
+require 'compo/parent_tracker'
+require 'compo/url_referenceable'
+
+module Compo
+  # A movable, URL referenceable parent tracker
+  #
+  # A Branch represents a fully-featured part of a composite object.  This
+  # abstract pattern is implemented concretely by Leaf (a Branch with no
+  # children), ArrayBranch (a Branch with a list of numerically identified
+  # children), and HashBranch (a Branch with a hash of key-identified children).
+  # reports no children.
+  module Branch
+    include Movable
+    include ParentTracker
+    include UrlReferenceable
+  end
+end

data/lib/compo/composite.rb

@@ -116,7 +116,7 @@ module Compo
     #
     # @return [void]
     def remove_parent_of(child)
-      Parentless.new.add(nil, child) unless child.nil?
+      Parentless.for(child)
     end
 
     # Default implementation of #remove! in terms of #remove_id!

data/lib/compo/hash_branch.rb

@@ -1,3 +1,5 @@
+require 'compo/branch'
+
 module Compo
   # A simple implementation of a branch, whose children are stored in an Hash
   #
@@ -10,20 +12,6 @@ module Compo
   # This is an extension of HashComposite to include the Movable and
   # ParentTracker mixins.
   class HashBranch < HashComposite
-    include Movable
-    include ParentTracker
-    include UrlReferenceable
-
-    # 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
+    include Branch
   end
 end

data/lib/compo/leaf.rb

@@ -1,4 +1,4 @@
-require 'compo/movable'
+require 'compo/branch'
 require 'compo/null_composite'
 require 'compo/parent_tracker'
 
@@ -9,19 +9,6 @@ module Compo
   # Composite API, but all additions and removals fail, and the Leaf always
   # reports no children.
   class Leaf < NullComposite
-    include Movable
-    include ParentTracker
-    include UrlReferenceable
-
-    # Initialises the Leaf
-    #
-    # The Leaf is created with no children, no parent, and no ID.
-    #
-    # @api  public
-    # @example  Creates a new Leaf.
-    #   leaf = Leaf.new
-    def initialize
-      remove_parent
-    end
+    include Branch
   end
 end

data/lib/compo/movable.rb

@@ -35,7 +35,7 @@ module Compo
     #
     # @return [void]
     def move_from_old_parent
-      parent.remove(self) unless parent.nil?
+      parent.remove(self)
     end
 
     # Performs the move to a new parent, if necessary

data/lib/compo/parent_tracker.rb

@@ -7,12 +7,14 @@ module Compo
   # This implements #parent, #update_parent and #remove_parent to track the
   # current parent and ID function as instance variables.  It also implements
   # #parent, and #id in terms of the ID function.
-  #
-  # Subclasses should call #remove_parent in their #initialize methods, to
-  # set the parent and ID function to their default, empty values.
   module ParentTracker
     extend Forwardable
 
+    def initialize
+      super()
+      remove_parent
+    end
+
     # Gets this object's current ID
     #
     # @api  public
@@ -47,6 +49,9 @@ module Compo
     #
     # @return [void]
     def update_parent(new_parent, new_id_function)
+      fail 'Parent cannot be nil: use #remove_parent.' if new_parent.nil?
+      fail 'ID function cannot be nil: use -> { nil }.' if new_id_function.nil?
+
       @parent = new_parent
       @id_function = new_id_function
     end

data/lib/compo/parentless.rb

@@ -10,6 +10,25 @@ module Compo
   class Parentless
     include Composite
 
+    # Creates a new instance of Parentless and adds an item to it
+    #
+    # This effectively removes the item's parent.
+    #
+    # If this method is passed nil, then nothing happens.
+    #
+    # @api  public
+    # @example  Makes a new Parentless for an item.
+    #   Parentless.for(item)
+    # @example  Does nothing.
+    #   Parentless.for(nil)
+    #
+    # @param item [Object] The item to be reparented to a Parentless.
+    #
+    # @return [void]
+    def self.for(item)
+      new.add(nil, item) unless item.nil?
+    end
+
     # 'Removes' a child from this Parentless
     #
     # This always succeeds, and never triggers any other action.

data/lib/compo/url_referenceable.rb

@@ -9,6 +9,8 @@ module Compo
   # This module expects its includer to define #parent and #id.  These are
   # defined, for example, by the Compo::ParentTracker mixin.
   module UrlReferenceable
+    extend Forwardable
+
     # Returns the URL of this object
     #
     # The #url of a Composite is defined inductively as '' for composites that
@@ -61,8 +63,6 @@ module Compo
     #
     # @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
+    def_delegator :parent, :url, :parent_url
   end
 end

data/lib/compo/version.rb

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

data/spec/url_referenceable_shared_examples.rb

@@ -40,15 +40,12 @@ shared_examples 'a URL referenceable object' do
   end
 
   describe '#parent_url' do
-    context 'when the UrlReferenceable has no parent' do
+    context 'when the UrlReferenceable has a nil 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
+      # Note that having a nil parent is considered an error in itself.
+      # Parentless objects should use Parentless as a null object.
+      specify { expect { subject.parent_url }.to raise_error }
     end
 
     context 'when the UrlReferenceable has a parent' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: compo
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Matt Windsor
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-29 00:00:00.000000000 Z
+date: 2014-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backports
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: fuubar
   requirement: !ruby/object:Gem::Requirement
@@ -142,6 +142,7 @@ files:
 - 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
@@ -191,7 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0.rc.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Composite pattern style mixins with IDs