descendants_tracker 0.0.1

data/.gitignore

@@ -0,0 +1,37 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## Rubinius
+*.rbc
+.rbx
+
+## PROJECT::GENERAL
+*.gem
+coverage
+profiling
+turbulence
+rdoc
+pkg
+tmp
+doc
+log
+.yardoc
+measurements
+
+## BUNDLER
+.bundle
+Gemfile.lock
+
+## PROJECT::SPECIFIC

data/.rvmrc

@@ -0,0 +1 @@
+rvm use @$(basename `pwd`) --create

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+before_install: gem install bundler
+bundler_args: --without yard guard
+script: "bundle exec rake spec"
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode
+  - ree
+  - ruby-head
+  - jruby-head
+notifications:
+  email:
+    - dan.kubb@gmail.com
+    - mbj@seonic.net

data/Gemfile

@@ -0,0 +1,59 @@
+# encoding: utf-8
+
+source 'https://rubygems.org'
+
+gemspec
+
+group :yard do
+  gem 'yard',      '~> 0.8.3'
+  gem 'redcarpet', '~> 2.2.2', :platforms => [ :mri, :rbx ]
+end
+
+group :guard do
+  gem 'guard',         '~> 1.5.4'
+  gem 'guard-bundler', '~> 1.0.0'
+  gem 'guard-rspec',   '~> 1.2.1'
+end
+
+group :benchmarks do
+  gem 'rbench', '~> 0.2.3'
+end
+
+platform :jruby do
+  group :jruby do
+    gem 'jruby-openssl', '~> 0.7.4'
+  end
+end
+
+group :metrics do
+  gem 'flay',      '~> 1.4.3'
+  gem 'flog',      '~> 2.5.3'
+  gem 'reek',      '~> 1.2.8', :github => 'dkubb/reek'
+  gem 'roodi',     '~> 2.1.0'
+  gem 'yardstick', '~> 0.8.0'
+
+  platforms :ruby_18, :ruby_19 do
+    # this indirectly depends on ffi which does not build on ruby-head
+    gem 'yard-spellcheck', '~> 0.1.5'
+  end
+
+  platforms :mri_18 do
+    gem 'arrayfields', '~> 4.7.4'  # for metric_fu
+    gem 'fattr',       '~> 2.2.0'  # for metric_fu
+    gem 'heckle',      '~> 1.4.3'
+    gem 'json',        '~> 1.7.3'  # for metric_fu rake task
+    gem 'map',         '~> 6.2.0'  # for metric_fu
+    gem 'metric_fu',   '~> 2.1.1'
+    gem 'mspec',       '~> 1.5.17'
+    gem 'rcov',        '~> 1.0.0'
+    gem 'ruby2ruby',   '= 1.2.2'   # for heckle
+  end
+
+  platforms :ruby_19 do
+    gem 'simplecov', '~> 0.7.1'
+  end
+
+  platforms :rbx do
+    gem 'pelusa', '~> 0.2.1'
+  end
+end

data/Guardfile

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+guard :bundler do
+  watch('Gemfile')
+end
+
+guard :rspec do
+  # run all specs if the spec_helper or supporting files files are modified
+  watch('spec/spec_helper.rb')                      { 'spec' }
+  watch(%r{\Aspec/(?:lib|support|shared)/.+\.rb\z}) { 'spec' }
+
+  # run unit specs if associated lib code is modified
+  watch(%r{\Alib/(.+)\.rb\z})                                         { |m| Dir["spec/unit/#{m[1]}"] }
+  watch("lib/#{File.basename(File.expand_path('../', __FILE__))}.rb") { 'spec'                       }
+
+  # run a spec if it is modified
+  watch(%r{\Aspec/(?:unit|integration)/.+_spec\.rb\z})
+end

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2009-2012 Dan Kubb
+Copyright (c) 2012 Markus Schirp (packaging)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,88 @@
+descendants_tracker
+===================
+
+[![Build Status](https://secure.travis-ci.org/dkubb/descendants_tracker.png?branch=master)](http://travis-ci.org/dkubb/descendants_tracker)
+[![Dependency Status](https://gemnasium.com/dkubb/descendants_tracker.png)](https://gemnasium.com/dkubb/descendants_tracker)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/dkubb/descendants_tracker)
+
+Small module to track descendants in an unobtrusive way.
+
+Installation
+------------
+
+With Rubygems:
+
+```bash
+$ gem install descendants_tracker
+$ irb -rubygems
+>> require 'descendants_tracker'
+=> true
+```
+
+With git and local working copy:
+
+```bash
+$ git clone git://github.com/dkubb/descendants_tracker.git
+$ cd descendants_tracker
+$ rake install
+$ irb -rubygems
+>> require 'descendants_tracker'
+=> true
+```
+
+Examples
+--------
+
+``` ruby
+class Foo
+  extend Virtus::DescendantsTracker
+end
+
+class Bar < Foo
+end
+
+Foo.descendants # => [Bar]
+```
+
+Credits
+-------
+
+* Dan Kubb ([dkubb](https://github.com/dkubb))
+* Piotr Solnica ([solnic](https://github.com/solnic))
+* Markus Schirp ([mbj](https://github.com/mbj))
+
+Contributing
+-------------
+
+* If you want your code merged into the mainline, please discuss the proposed changes with me before doing any work on it. This library is still in early development, and the direction it is going may not always be clear. Some features may not be appropriate yet, may need to be deferred until later when the foundation for them is laid, or may be more applicable in a plugin.
+* Fork the project.
+* Make your feature addition or bug fix.
+* Follow this [style guide](https://github.com/dkubb/styleguide).
+* Add specs for it. This is important so I don't break it in a future version unintentionally. Tests must cover all branches within the code, and code must be fully covered.
+* Commit, do not mess with Rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Run "rake ci". This must pass and not show any regressions in the metrics for the code to be merged.
+* Send me a pull request. Bonus points for topic branc
+
+License
+-------
+
+Copyright (c) 2011-2012 Dan Kubb
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+require 'rake'
+
+require File.expand_path('../lib/descendants_tracker/version', __FILE__)
+
+FileList['tasks/**/*.rake'].each { |task| import task }
+
+task :default => :spec

data/config/flay.yml

@@ -0,0 +1,3 @@
+---
+threshold: 6
+total_score: 8

data/config/flog.yml

@@ -0,0 +1,2 @@
+---
+threshold: 6.5

data/config/roodi.yml

@@ -0,0 +1,18 @@
+---
+AbcMetricMethodCheck:            { score: 10.3 }
+AssignmentInConditionalCheck:    { }
+CaseMissingElseCheck:            { }
+ClassLineCountCheck:             { line_count: 293 }
+ClassNameCheck:                  { pattern: !ruby/regexp '/\A(?:[A-Z]+|[A-Z][a-z](?:[A-Z]?[a-z])+)\z/' }
+ClassVariableCheck:              { }
+CyclomaticComplexityBlockCheck:  { complexity: 2 }
+CyclomaticComplexityMethodCheck: { complexity: 4 }
+EmptyRescueBodyCheck:            { }
+ForLoopCheck:                    { }
+# TODO: decrease line_count to 5 to 10
+MethodLineCountCheck:            { line_count: 14 }
+MethodNameCheck:                 { pattern: !ruby/regexp '/\A(?:[a-z\d](?:_?[a-z\d])+[?!=]?|\[\]=?|==|<=>|[+*&|-])\z/' }
+ModuleLineCountCheck:            { line_count: 295 }
+ModuleNameCheck:                 { pattern: !ruby/regexp '/\A(?:[A-Z]+|[A-Z][a-z](?:[A-Z]?[a-z])+)\z/' }
+# TODO: decrease parameter_count to 2 or less
+ParameterNumberCheck:            { parameter_count: 3 }

data/config/site.reek

@@ -0,0 +1,91 @@
+---
+UncommunicativeParameterName:
+  accept: []
+  exclude: []
+  enabled: true
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+LargeClass:
+  max_methods: 10
+  exclude: []
+  enabled: true
+  max_instance_variables: 2
+UncommunicativeMethodName:
+  accept: []
+  exclude: []
+  enabled: true
+  reject:
+  - !ruby/regexp /^[a-z]$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+LongParameterList:
+  max_params: 2  # TODO: decrease max_params to 2
+  exclude: []
+  enabled: true
+  overrides: {}
+FeatureEnvy:
+  exclude: []
+  enabled: true
+ClassVariable:
+  exclude: []
+  enabled: true
+BooleanParameter:
+  exclude: []
+  enabled: true
+IrresponsibleModule:
+  exclude: []
+  enabled: true
+UncommunicativeModuleName:
+  accept: []
+  exclude: []
+  enabled: true
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+NestedIterators:
+  ignore_iterators: []
+  exclude: []
+  enabled: true
+  max_allowed_nesting: 1
+LongMethod:
+  max_statements: 7  # TODO: decrease max_statements to 5 or less
+  exclude: []
+  enabled: true
+Duplication:
+  allow_calls: []
+  exclude: []
+  enabled: true
+  max_calls: 1
+UtilityFunction:
+  max_helper_calls: 1
+  exclude: []
+  enabled: true
+Attribute:
+  exclude: []
+  enabled: false
+UncommunicativeVariableName:
+  accept: []
+  exclude: []
+  enabled: true
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+SimulatedPolymorphism:
+  exclude: []
+  enabled: true
+  max_ifs: 1
+DataClump:
+  exclude: []
+  enabled: true
+  max_copies: 1
+  min_clump_size: 3
+ControlCouple:
+  exclude: []
+  enabled: true
+LongYieldList:
+  max_params: 1
+  exclude: []
+  enabled: true

data/config/yardstick.yml

@@ -0,0 +1,2 @@
+---
+threshold: 100

data/descendants_tracker.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path('../lib/descendants_tracker/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = 'descendants_tracker'
+  gem.version     = DescendantsTracker::VERSION.dup
+  gem.authors     = [ 'Dan Kubb', 'Piotr Solnica', 'Markus Schirp' ]
+  gem.email       = %w[ dan.kubb@gmail.com piotr.solnica@gmail.com mbj@seonic.net ]
+  gem.description = 'Module that adds descendant tracking to a class'
+  gem.summary     = gem.description
+  gem.homepage    = 'https://github.com/dkubb/descendants_tracker'
+
+  gem.require_paths    = %w[lib]
+  gem.files            = `git ls-files`.split($/)
+  gem.test_files       = `git ls-files -- {spec}/*`.split($/)
+  gem.extra_rdoc_files = %w[LICENSE README.md TODO]
+
+  gem.add_development_dependency('rake',  '~> 10.0.2')
+  gem.add_development_dependency('rspec', '~> 1.3.2')
+end

data/lib/descendants_tracker.rb

@@ -0,0 +1,41 @@
+# Module that adds descendant tracking to a class
+module DescendantsTracker
+
+  # Return the descendants of this class
+  #
+  # @return [Array<Class>]
+  #
+  # @api private
+  def descendants
+    @descendants ||= []
+  end
+
+  # Add the descendant to this class and the superclass
+  #
+  # @param [Class] descendant
+  #
+  # @return [self]
+  #
+  # @api private
+  def add_descendant(descendant)
+    superclass = self.superclass
+    superclass.add_descendant(descendant) if superclass.respond_to?(:add_descendant)
+    descendants.unshift(descendant)
+    self
+  end
+
+private
+
+  # Hook called when class is inherited
+  #
+  # @param [Class] descendant
+  #
+  # @return [undefined]
+  #
+  # @api private
+  def inherited(descendant)
+    super
+    add_descendant(descendant)
+  end
+
+end # module DescendantsTracker

data/lib/descendants_tracker/version.rb

@@ -0,0 +1,3 @@
+module DescendantsTracker
+  VERSION = '0.0.1'.freeze
+end

data/spec/rcov.opts

@@ -0,0 +1,7 @@
+--exclude-only "spec/,^/"
+--sort coverage
+--callsites
+--xrefs
+--profile
+--text-summary
+--failure-threshold 100

data/spec/shared/command_method_behavior.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+shared_examples_for 'a command method' do
+  it 'returns self' do
+    should equal(object)
+  end
+end

data/spec/shared/each_method_behaviour.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+shared_examples_for 'an #each method' do
+  it_should_behave_like 'a command method'
+
+  context 'with no block' do
+    subject { object.each }
+
+    it { should be_instance_of(to_enum.class) }
+
+    it 'yields the expected values' do
+      subject.to_a.should eql(object.to_a)
+    end
+  end
+end

data/spec/shared/hash_method_behavior.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+shared_examples_for 'a hash method' do
+  it_should_behave_like 'an idempotent method'
+
+  specification = proc do
+    should be_instance_of(Fixnum)
+  end
+
+  it 'is a fixnum' do
+    instance_eval(&specification)
+  end
+
+  it 'memoizes the hash code' do
+    subject.should eql(object.memoized(:hash))
+  end
+end

data/spec/shared/idempotent_method_behavior.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+shared_examples_for 'an idempotent method' do
+  it 'is idempotent' do
+    should equal(instance_eval(&self.class.subject))
+  end
+end

data/spec/shared/invertible_method_behaviour.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+shared_examples_for 'an invertible method' do
+  it_should_behave_like 'an idempotent method'
+
+  it 'is invertible' do
+    subject.inverse.should equal(object)
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,3 @@
+--color
+--loadby random
+--format profile

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+require 'descendants_tracker'
+require 'spec'
+require 'spec/autorun'
+
+# require spec support files and shared behavior
+Dir[File.expand_path('../{support,shared}/**/*.rb', __FILE__)].each { |f| require f }
+
+Spec::Runner.configure do |config|
+end

data/spec/support/config_alias.rb

@@ -0,0 +1,3 @@
+require 'rbconfig'
+
+::Config = RbConfig unless defined?(::Config)

data/spec/unit/descendants_tracker/add_descendant_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe DescendantsTracker, '#add_descendant' do
+  subject { object.add_descendant(descendant) }
+
+  let(:described_class) { Class.new { extend DescendantsTracker } }
+  let(:object)          { Class.new(described_class)                      }
+  let(:descendant)      { Class.new                                       }
+
+  it { should equal(object) }
+
+  it 'prepends the class to the descendants' do
+    object.descendants << original = Class.new
+    expect { subject }.to change { object.descendants.dup }.
+      from([ original ]).
+      to([ descendant, original ])
+  end
+
+  it 'prepends the class to the superclass descendants' do
+    expect { subject }.to change { object.superclass.descendants.dup }.
+      from([ object ]).
+      to([ descendant, object ])
+  end
+end

data/spec/unit/descendants_tracker/descendants_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe DescendantsTracker, '#descendants' do
+  subject { object.descendants }
+
+  let(:described_class) { Class.new { extend DescendantsTracker } }
+  let(:object)          { described_class                                 }
+
+  context 'when there are no descendants' do
+    it_should_behave_like 'an idempotent method'
+
+    it { should be_empty }
+  end
+
+  context 'when there are descendants' do
+    let!(:descendant) { Class.new(object) }  # trigger the class inhertance
+
+    it_should_behave_like 'an idempotent method'
+
+    it { should eql([ descendant ]) }
+  end
+end

data/tasks/metrics/ci.rake

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+desc 'Run metrics with Heckle'
+task :ci => %w[ ci:metrics metrics:heckle ]
+
+namespace :ci do
+  desc 'Run metrics (except heckle) and spec'
+  task :metrics => %w[ spec metrics:verify_measurements metrics:flog metrics:flay metrics:reek metrics:roodi metrics:all ]
+end

data/tasks/metrics/flay.rake

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+begin
+  require 'flay'
+  require 'yaml'
+
+  config      = YAML.load_file(File.expand_path('../../../config/flay.yml', __FILE__)).freeze
+  threshold   = config.fetch('threshold').to_i
+  total_score = config.fetch('total_score').to_f
+  files       = Flay.expand_dirs_to_files(config.fetch('path', 'lib')).sort
+
+  namespace :metrics do
+    # original code by Marty Andrews:
+    # http://blog.martyandrews.net/2009/05/enforcing-ruby-code-quality.html
+    desc 'Analyze for code duplication'
+    task :flay do
+      # run flay once without a threshold to ensure the max mass matches the threshold
+      flay = Flay.new(:fuzzy => false, :verbose => false, :mass => 0)
+      flay.process(*files)
+
+      max = (flay.masses.map { |hash, mass| mass.to_f / flay.hashes[hash].size }.max) || 0
+      unless max >= threshold
+        raise "Adjust flay threshold down to #{max}"
+      end
+
+      total = flay.masses.reduce(0.0) { |total, (hash, mass)| total + (mass.to_f / flay.hashes[hash].size) }
+      unless total == total_score
+        raise "Flay total is now #{total}, but expected #{total_score}"
+      end
+
+      # run flay a second time with the threshold set
+      flay = Flay.new(:fuzzy => false, :verbose => false, :mass => threshold.succ)
+      flay.process(*files)
+
+      if flay.masses.any?
+        flay.report
+        raise "#{flay.masses.size} chunks of code have a duplicate mass > #{threshold}"
+      end
+    end
+  end
+rescue LoadError
+  task :flay do
+    $stderr.puts 'Flay is not available. In order to run flay, you must: gem install flay'
+  end
+end

data/tasks/metrics/flog.rake

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+begin
+  require 'flog'
+  require 'yaml'
+
+  class Float
+    def round_to(n)
+      (self * 10**n).round.to_f * 10**-n
+    end
+  end
+
+  config    = YAML.load_file(File.expand_path('../../../config/flog.yml', __FILE__)).freeze
+  threshold = config.fetch('threshold').to_f.round_to(1)
+
+  namespace :metrics do
+    # original code by Marty Andrews:
+    # http://blog.martyandrews.net/2009/05/enforcing-ruby-code-quality.html
+    desc 'Analyze for code complexity'
+    task :flog do
+      flog = Flog.new
+      flog.flog Array(config.fetch('path', 'lib'))
+
+      totals = flog.totals.select  { |name, score| name[-5, 5] != '#none' }.
+                           map     { |name, score| [ name, score.round_to(1) ] }.
+                           sort_by { |name, score| score }
+
+      if totals.any?
+        max = totals.last[1]
+        unless max >= threshold
+          raise "Adjust flog score down to #{max}"
+        end
+      end
+
+      bad_methods = totals.select { |name, score| score > threshold }
+      if bad_methods.any?
+        bad_methods.reverse_each do |name, score|
+          puts '%8.1f: %s' % [ score, name ]
+        end
+
+        raise "#{bad_methods.size} methods have a flog complexity > #{threshold}"
+      end
+    end
+  end
+rescue LoadError
+  task :flog do
+    $stderr.puts 'Flog is not available. In order to run flog, you must: gem install flog'
+  end
+end

data/tasks/metrics/heckle.rake

@@ -0,0 +1,208 @@
+# encoding: utf-8
+
+$LOAD_PATH.unshift(File.expand_path('../../../lib', __FILE__))
+
+# original code by Ashley Moran:
+# http://aviewfromafar.net/2007/11/1/rake-task-for-heckling-your-specs
+
+begin
+  require 'pathname'
+  require 'heckle'
+  require 'mspec'
+  require 'mspec/utils/name_map'
+
+  SKIP_METHODS = %w[ blank_slate_method_added ].freeze
+
+  class NameMap
+    def file_name(method, constant)
+      map  = MAP[method]
+      name = if map
+        map[constant] || map[:default]
+      else
+        method.gsub(/[?!=]\z/, '')
+      end
+      "#{name}_spec.rb"
+    end
+  end
+
+  namespace :metrics do
+    desc 'Heckle each module and class'
+    task :heckle => :coverage do
+      unless Ruby2Ruby::VERSION == '1.2.2'
+        raise "ruby2ruby version #{Ruby2Ruby::VERSION} may not work properly, 1.2.2 *only* is recommended for use with heckle"
+      end
+
+      require 'descendants_tracker'
+
+      root_module_regexp = Regexp.union('DescendantsTracker')
+
+      spec_dir = Pathname('spec/unit')
+
+      NameMap::MAP.each do |op, method|
+        next if method.kind_of?(Hash)
+        NameMap::MAP[op] = { :default => method }
+      end
+
+      aliases = Hash.new { |h,mod| h[mod] = Hash.new { |h,method| h[method] = method } }
+      map     = NameMap.new
+
+      heckle_caught_modules = Hash.new { |hash, key| hash[key] = [] }
+      uncovered_methods = 0
+
+      ObjectSpace.each_object(Module) do |mod|
+        next unless mod.name =~ /\A#{root_module_regexp}(?::|\z)/
+
+        spec_prefix = spec_dir.join(mod.name.underscore)
+
+        specs = []
+
+        # get the public class methods
+        metaclass  = class << mod; self end
+        ancestors  = metaclass.ancestors
+
+        spec_class_methods = mod.singleton_methods(false)
+
+        spec_class_methods.reject! do |method|
+          %w[ yaml_new yaml_tag_subclasses? included nesting constants ].include?(method.to_s)
+        end
+
+        if mod.ancestors.include?(Singleton)
+          spec_class_methods.reject! { |method| method.to_s == 'instance' }
+        end
+
+        # get the protected and private class methods
+        other_class_methods = metaclass.protected_instance_methods(false) |
+                              metaclass.private_instance_methods(false)
+
+        ancestors.each do |ancestor|
+          other_class_methods -= ancestor.protected_instance_methods(false) |
+                                 ancestor.private_instance_methods(false)
+        end
+
+        other_class_methods.reject! do |method|
+          method.to_s == 'allocate' || SKIP_METHODS.include?(method.to_s)
+        end
+
+        other_class_methods.reject! do |method|
+          next unless spec_class_methods.any? { |specced| specced.to_s == $1 }
+
+          spec_class_methods << method
+        end
+
+        spec_class_methods -= other_class_methods
+
+        # get the instances methods
+        spec_methods = mod.public_instance_methods(false)
+
+        other_methods = mod.protected_instance_methods(false) |
+                        mod.private_instance_methods(false)
+
+        other_methods.reject! do |method|
+          next unless spec_methods.any? { |specced| specced.to_s == $1 }
+
+          spec_methods << method
+        end
+
+        # map the class methods to spec files
+        spec_class_methods.each do |method|
+          method = aliases[mod.name][method]
+          next if SKIP_METHODS.include?(method.to_s)
+
+          spec_file = spec_prefix.join('class_methods').join(map.file_name(method, mod.name))
+
+          unless spec_file.file?
+            raise "No spec file #{spec_file} for #{mod}.#{method}"
+          end
+
+          specs << [ ".#{method}", [ spec_file ] ]
+        end
+
+        # map the instance methods to spec files
+        spec_methods.each do |method|
+          method = aliases[mod.name][method]
+          next if SKIP_METHODS.include?(method.to_s)
+
+          spec_file = spec_prefix.join(map.file_name(method, mod.name))
+
+          unless spec_file.file?
+            raise "No spec file #{spec_file} for #{mod}##{method}"
+          end
+
+          specs << [ "##{method}", [ spec_file ] ]
+        end
+
+        # non-public methods are considered covered if they can be mutated
+        # and any spec fails for the current or descendant modules
+        other_methods.each do |method|
+          descedant_specs = []
+
+          ObjectSpace.each_object(Module) do |descedant|
+            next unless descedant.name =~ /\A#{root_module_regexp}(?::|\z)/ && mod >= descedant
+            descedant_spec_prefix = spec_dir.join(descedant.name.underscore)
+            descedant_specs << descedant_spec_prefix
+
+            if method.to_s == 'initialize'
+              descedant_specs.concat(Pathname.glob(descedant_spec_prefix.join('class_methods/new_spec.rb')))
+            end
+          end
+
+          specs << [ "##{method}", descedant_specs ]
+        end
+
+        other_class_methods.each do |method|
+          descedant_specs = []
+
+          ObjectSpace.each_object(Module) do |descedant|
+            next unless descedant.name =~ /\A#{root_module_regexp}(?::|\z)/ && mod >= descedant
+            descedant_specs << spec_dir.join(descedant.name.underscore).join('class_methods')
+          end
+
+          specs << [ ".#{method}", descedant_specs ]
+        end
+
+        specs.sort.each do |(method, spec_files)|
+          puts "Heckling #{mod}#{method}"
+          IO.popen("spec #{spec_files.join(' ')} --heckle '#{mod}#{method}'") do |pipe|
+            while line = pipe.gets
+              case line = line.chomp
+                when "The following mutations didn't cause test failures:"
+                  heckle_caught_modules[mod.name] << method
+                  uncovered_methods += 1
+              end
+            end
+          end
+        end
+      end
+
+      if uncovered_methods > 0
+        error_message_lines = [ "*************\n" ]
+
+        error_message_lines << "Heckle found #{uncovered_methods} " \
+          "method#{"s" unless uncovered_methods == 1} " \
+          "where mutations didn't cause spec violations\n"
+
+        heckle_caught_modules.each do |mod, methods|
+          error_message_lines << "#{mod} contains the following " \
+            'poorly-specified methods:'
+          methods.each do |method|
+            error_message_lines << " - #{method}"
+          end
+          error_message_lines << ''
+        end
+
+        error_message_lines << 'Get your act together and come back ' \
+          'when your specs are doing their job!'
+
+        raise error_message_lines.join("\n")
+      else
+        puts 'Well done! Your code withstood a heckling.'
+      end
+    end
+  end
+rescue LoadError
+  namespace :metrics do
+    task :heckle => :coverage do
+      $stderr.puts 'Heckle or mspec is not available. In order to run heckle, you must: gem install heckle mspec'
+    end
+  end
+end

data/tasks/metrics/metric_fu.rake

@@ -0,0 +1,31 @@
+# encoding: utf-8
+
+begin
+  require 'metric_fu'
+  require 'json'
+
+  # XXX: temporary hack until metric_fu is fixed
+  MetricFu::Saikuro.class_eval { include FileUtils }
+
+  MetricFu::Configuration.run do |config|
+    config.rcov = {
+      :environment => 'test',
+      :test_files  => %w[ spec/**/*_spec.rb ],
+      :rcov_opts   => %w[
+        --sort coverage
+        --no-html
+        --text-coverage
+        --no-color
+        --profile
+        --exclude spec/,^/
+        --include lib:spec
+      ],
+    }
+  end
+rescue LoadError
+  namespace :metrics do
+    task :all do
+      $stderr.puts 'metric_fu is not available. In order to run metrics:all, you must: gem install metric_fu'
+    end
+  end
+end

data/tasks/metrics/reek.rake

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+begin
+  require 'reek/rake/task'
+
+  RBX_18_MODE = RUBY_VERSION < '1.9' && defined?(RUBY_ENGINE) && RUBY_ENGINE == 'rbx'
+
+  namespace :metrics do
+    Reek::Rake::Task.new do |t|
+      # reek has some problems under rbx in 1.8 mode that cause the underlying
+      # script to raise an exception. Rather than halt the "rake ci" process due
+      # to one bug, we choose to ignore it in this specific case until reek can be
+      # fixed.
+      t.fail_on_error = ! RBX_18_MODE  # always true, except under rbx 18 mode
+    end
+  end
+rescue LoadError
+  task :reek do
+    $stderr.puts 'Reek is not available. In order to run reek, you must: gem install reek'
+  end
+end

data/tasks/metrics/roodi.rake

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+begin
+  require 'roodi'
+  require 'rake/tasklib'
+  require 'roodi_task'
+
+  namespace :metrics do
+    RoodiTask.new do |t|
+      t.verbose  = false
+      t.config   = File.expand_path('../../../config/roodi.yml', __FILE__)
+      t.patterns = %w[ lib/**/*.rb ]
+    end
+  end
+rescue LoadError
+  task :roodi do
+    $stderr.puts 'Roodi is not available. In order to run roodi, you must: gem install roodi'
+  end
+end

data/tasks/metrics/yardstick.rake

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+begin
+  require 'yardstick/rake/measurement'
+  require 'yardstick/rake/verify'
+  require 'yaml'
+
+  config = YAML.load_file(File.expand_path('../../../config/yardstick.yml', __FILE__))
+
+  namespace :metrics do
+    # yardstick_measure task
+    Yardstick::Rake::Measurement.new
+
+    # verify_measurements task
+    Yardstick::Rake::Verify.new do |verify|
+      verify.threshold = config.fetch('threshold')
+    end
+  end
+rescue LoadError
+  %w[ yardstick_measure verify_measurements ].each do |name|
+    task name.to_s do
+      $stderr.puts "Yardstick is not available. In order to run #{name}, you must: gem install yardstick"
+    end
+  end
+end

data/tasks/spec.rake

@@ -0,0 +1,60 @@
+# encoding: utf-8
+
+spec_defaults = lambda do |spec|
+  spec.ruby_opts = %w[ -r./spec/support/config_alias ]
+  spec.spec_opts << '--options' << 'spec/spec.opts'
+end
+
+begin
+  require 'spec/rake/spectask'
+
+  desc 'Run all specs'
+  task :spec => %w[ spec:unit spec:integration ]
+
+  namespace :spec do
+    desc 'Run unit specs'
+    Spec::Rake::SpecTask.new(:unit) do |unit|
+      spec_defaults.call(unit)
+      unit.pattern = 'spec/unit/**/*_spec.rb'
+    end
+
+    desc 'Run integration specs'
+    Spec::Rake::SpecTask.new(:integration) do |integration|
+      spec_defaults.call(integration)
+      integration.pattern = 'spec/integration/**/*_spec.rb'
+    end
+  end
+rescue LoadError
+  %w[ spec spec:unit spec:integration ].each do |name|
+    task name do
+      $stderr.puts "rspec is not available. In order to run #{name}, you must: gem install rspec"
+    end
+  end
+end
+
+namespace :metrics do
+  begin
+    if RUBY_VERSION < '1.9'
+      desc 'Generate code coverage'
+      Spec::Rake::SpecTask.new(:coverage) do |rcov|
+        spec_defaults.call(rcov)
+        rcov.rcov      = true
+        rcov.pattern   = 'spec/unit/**/*_spec.rb'
+        rcov.rcov_opts = File.read('spec/rcov.opts').split(/\s+/)
+      end
+    else
+      desc 'Generate code coverage'
+      task :coverage do
+        ENV['COVERAGE'] = 'true'
+        Rake::Task['spec:unit'].execute
+      end
+    end
+  rescue LoadError
+    task :coverage do
+      lib = RUBY_VERSION < '1.9' ? 'rcov' : 'simplecov'
+      $stderr.puts "coverage is not available. In order to run #{lib}, you must: gem install #{lib}"
+    end
+  end
+end
+
+task :test => :spec

data/tasks/yard.rake

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+begin
+  require 'yard'
+
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yard do
+    $stderr.puts 'YARD is not available. In order to run yard, you must: gem install yard'
+  end
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification 
+name: descendants_tracker
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Dan Kubb
+- Piotr Solnica
+- Markus Schirp
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-11-24 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 75
+        segments: 
+        - 10
+        - 0
+        - 2
+        version: 10.0.2
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 1
+        - 3
+        - 2
+        version: 1.3.2
+  type: :development
+  version_requirements: *id002
+description: Module that adds descendant tracking to a class
+email: 
+- dan.kubb@gmail.com
+- piotr.solnica@gmail.com
+- mbj@seonic.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+- TODO
+files: 
+- .gitignore
+- .rvmrc
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- TODO
+- config/flay.yml
+- config/flog.yml
+- config/roodi.yml
+- config/site.reek
+- config/yardstick.yml
+- descendants_tracker.gemspec
+- lib/descendants_tracker.rb
+- lib/descendants_tracker/version.rb
+- spec/rcov.opts
+- spec/shared/command_method_behavior.rb
+- spec/shared/each_method_behaviour.rb
+- spec/shared/hash_method_behavior.rb
+- spec/shared/idempotent_method_behavior.rb
+- spec/shared/invertible_method_behaviour.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/support/config_alias.rb
+- spec/unit/descendants_tracker/add_descendant_spec.rb
+- spec/unit/descendants_tracker/descendants_spec.rb
+- tasks/metrics/ci.rake
+- tasks/metrics/flay.rake
+- tasks/metrics/flog.rake
+- tasks/metrics/heckle.rake
+- tasks/metrics/metric_fu.rake
+- tasks/metrics/reek.rake
+- tasks/metrics/roodi.rake
+- tasks/metrics/yardstick.rake
+- tasks/spec.rake
+- tasks/yard.rake
+homepage: https://github.com/dkubb/descendants_tracker
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Module that adds descendant tracking to a class
+test_files: []
+
+has_rdoc: