descendants_tracker 0.0.1 → 0.0.4

data/lib/descendants_tracker.rb

@@ -1,13 +1,34 @@
+# encoding: utf-8
+
+require 'thread_safe'
+
 # Module that adds descendant tracking to a class
 module DescendantsTracker
 
   # Return the descendants of this class
   #
-  # @return [Array<Class>]
+  # @example
+  #   descendants = ParentClass.descendants
+  #
+  # @return [Array<Class<DescendantsTracker>>]
+  #
+  # @api public
+  attr_reader :descendants
+
+  # Setup the class for descendant tracking
+  #
+  # @param [Class<DescendantsTracker>] descendant
+  #
+  # @return [undefined]
   #
   # @api private
-  def descendants
-    @descendants ||= []
+  def self.setup(descendant)
+    descendant.instance_variable_set(:@descendants, ThreadSafe::Array.new)
+  end
+
+  class << self
+    alias_method :extended, :setup
+    private :extended
   end
 
   # Add the descendant to this class and the superclass
@@ -18,8 +39,10 @@ module DescendantsTracker
   #
   # @api private
   def add_descendant(descendant)
-    superclass = self.superclass
-    superclass.add_descendant(descendant) if superclass.respond_to?(:add_descendant)
+    ancestor = superclass
+    if ancestor.respond_to?(:add_descendant)
+      ancestor.add_descendant(descendant)
+    end
     descendants.unshift(descendant)
     self
   end
@@ -30,11 +53,12 @@ private
   #
   # @param [Class] descendant
   #
-  # @return [undefined]
+  # @return [self]
   #
   # @api private
   def inherited(descendant)
     super
+    DescendantsTracker.setup(descendant)
     add_descendant(descendant)
   end
 

data/spec/spec_helper.rb

@@ -1,11 +1,30 @@
 # encoding: utf-8
 
-require 'descendants_tracker'
-require 'spec'
-require 'spec/autorun'
+if ENV['COVERAGE'] == 'true'
+  require 'simplecov'
+  require 'coveralls'
+
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter
+  ]
+
+  SimpleCov.start do
+    command_name 'spec:unit'
+
+    add_filter 'config'
+    add_filter 'spec'
+    add_filter 'vendor'
 
-# require spec support files and shared behavior
-Dir[File.expand_path('../{support,shared}/**/*.rb', __FILE__)].each { |f| require f }
+    minimum_coverage 100
+  end
+end
+
+require 'devtools/spec_helper'
+require 'descendants_tracker'
 
-Spec::Runner.configure do |config|
+RSpec.configure do |config|
+  config.expect_with :rspec do |expect_with|
+    expect_with.syntax = :expect
+  end
 end

data/spec/support/config_alias.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'rbconfig'
 
 ::Config = RbConfig unless defined?(::Config)

data/spec/unit/descendants_tracker/add_descendant_spec.rb

@@ -1,24 +1,26 @@
+# encoding: utf-8
+
 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                                       }
+  let(:object)          { Class.new(described_class)              }
+  let(:descendant)      { Class.new                               }
 
-  it { should equal(object) }
+  it_should_behave_like 'a command method'
 
   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 ])
+    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 ])
+    expect { subject }.to change { object.superclass.descendants.dup }
+      .from([object])
+      .to([descendant, object])
   end
 end

data/spec/unit/descendants_tracker/descendants_spec.rb

@@ -1,10 +1,12 @@
+# encoding: utf-8
+
 require 'spec_helper'
 
 describe DescendantsTracker, '#descendants' do
   subject { object.descendants }
 
   let(:described_class) { Class.new { extend DescendantsTracker } }
-  let(:object)          { described_class                                 }
+  let(:object)          { described_class                         }
 
   context 'when there are no descendants' do
     it_should_behave_like 'an idempotent method'
@@ -17,6 +19,6 @@ describe DescendantsTracker, '#descendants' do
 
     it_should_behave_like 'an idempotent method'
 
-    it { should eql([ descendant ]) }
+    it { should eql([descendant]) }
   end
 end

data/spec/unit/descendants_tracker/inherited_spec.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe DescendantsTracker, '#inherited' do
+  subject { Class.new(object) }
+
+  let!(:object)    { Class.new(superklass).extend(self.class.described_class) }
+  let(:superklass) { Class.new                                                }
+
+  it 'delegates to the superclass #inherited method' do
+    superklass.should_receive(:inherited) do |descendant|
+      expect(descendant).to be_instance_of(Class)
+      expect(descendant.ancestors).to include(object)
+    end
+    subject
+  end
+
+  it 'adds the descendant' do
+    expect(object.descendants).to include(subject)
+  end
+
+  it 'sets up descendants in the child class' do
+    expect(subject.descendants).to eql([])
+  end
+end

metadata

@@ -1,141 +1,125 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: descendants_tracker
-version: !ruby/object:Gem::Version 
-  hash: 29
-  prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 1
-  version: 0.0.1
+version: !ruby/object:Gem::Version
+  version: 0.0.4
 platform: ruby
-authors: 
+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
+date: 2014-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thread_safe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+  type: :runtime
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 75
-        segments: 
-        - 10
-        - 0
-        - 2
-        version: 10.0.2
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.3
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 31
-        segments: 
-        - 1
-        - 3
-        - 2
-        version: 1.3.2
-  type: :development
-  version_requirements: *id002
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.3
 description: Module that adds descendant tracking to a class
-email: 
+email:
 - dan.kubb@gmail.com
 - piotr.solnica@gmail.com
-- mbj@seonic.net
+- mbj@schirp-dso.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE
 - README.md
+- CONTRIBUTING.md
 - TODO
-files: 
+files:
 - .gitignore
-- .rvmrc
+- .rspec
+- .ruby-gemset
 - .travis.yml
+- CONTRIBUTING.md
 - Gemfile
+- Gemfile.devtools
 - Guardfile
 - LICENSE
 - README.md
 - Rakefile
 - TODO
+- config/devtools.yml
 - config/flay.yml
 - config/flog.yml
-- config/roodi.yml
-- config/site.reek
+- config/mutant.yml
+- config/reek.yml
+- config/rubocop.yml
 - 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
+- spec/unit/descendants_tracker/inherited_spec.rb
 homepage: https://github.com/dkubb/descendants_tracker
-licenses: []
-
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+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"
+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: 1.8.24
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Module that adds descendant tracking to a class
-test_files: []
-
+test_files:
+- spec/unit/descendants_tracker/add_descendant_spec.rb
+- spec/unit/descendants_tracker/descendants_spec.rb
+- spec/unit/descendants_tracker/inherited_spec.rb
 has_rdoc: 

data/.rvmrc

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

data/config/roodi.yml

@@ -1,18 +0,0 @@
----
-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/spec/shared/command_method_behavior.rb

@@ -1,7 +0,0 @@
-# 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

@@ -1,15 +0,0 @@
-# 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

@@ -1,17 +0,0 @@
-# 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

@@ -1,7 +0,0 @@
-# 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

@@ -1,9 +0,0 @@
-# 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/tasks/metrics/ci.rake

@@ -1,9 +0,0 @@
-# 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

@@ -1,45 +0,0 @@
-# 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

@@ -1,49 +0,0 @@
-# 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