descendants_tracker 0.0.1 → 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c74464d200e35dda22a63eaf72795285f109b8fd
+  data.tar.gz: 755e09b06bf6717c22e434efd893ed692127211b
+SHA512:
+  metadata.gz: 1fe1cec3ee6cfcbc631fbc94b1a8a2097f530cccfb54d1ebea2197b9c879c1944d4daba19b84bba95fdd8e03f08a6d72ea83bf72c1f5aef962986ea541010487
+  data.tar.gz: d1d4fab6614f0e2c99cd29efb725faada0ff53aed1c2144ae26291bdfbb39ed966c3ee342575b76ea27780357cbe3d470118ad66e32c9f5049626af45f866b5e

data/.rspec

@@ -0,0 +1,5 @@
+--color
+--format progress
+--order random
+--profile
+--warnings

data/.ruby-gemset

@@ -0,0 +1 @@
+descendants_tracker

data/.travis.yml

@@ -1,19 +1,30 @@
 language: ruby
 before_install: gem install bundler
-bundler_args: --without yard guard
-script: "bundle exec rake spec"
+bundler_args: --without yard guard benchmarks
+script: "bundle exec rake ci:metrics"
 rvm:
-  - 1.8.7
-  - 1.9.2
   - 1.9.3
-  - jruby-18mode
-  - jruby-19mode
-  - rbx-18mode
-  - rbx-19mode
-  - ree
+  - 2.0.0
+  - 2.1.0
+  - 2.1.1
   - ruby-head
-  - jruby-head
+  - rbx-2
+matrix:
+  include:
+    - rvm: jruby-19mode
+      env: JRUBY_OPTS="$JRUBY_OPTS --debug"  # for simplecov
+    - rvm: jruby-20mode
+      env: JRUBY_OPTS="$JRUBY_OPTS --debug"  # for simplecov
+    - rvm: jruby-21mode
+      env: JRUBY_OPTS="$JRUBY_OPTS --debug"  # for simplecov
+    - rvm: jruby-head
+      env: JRUBY_OPTS="$JRUBY_OPTS --debug"  # for simplecov
+  allow_failures:
+    - rvm: 2.1.0  # buggy runtime
+  fast_finish: true
 notifications:
-  email:
-    - dan.kubb@gmail.com
-    - mbj@seonic.net
+  irc:
+    channels:
+      - irc.freenode.org#rom-rb
+    on_success: never
+    on_failure: change

data/CONTRIBUTING.md

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

data/Gemfile

@@ -4,56 +4,8 @@ source 'https://rubygems.org'
 
 gemspec
 
-group :yard do
-  gem 'yard',      '~> 0.8.3'
-  gem 'redcarpet', '~> 2.2.2', :platforms => [ :mri, :rbx ]
+group :development, :test do
+  gem 'devtools', git: 'https://github.com/rom-rb/devtools.git'
 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
+eval_gemfile 'Gemfile.devtools'

data/Gemfile.devtools

@@ -0,0 +1,71 @@
+# encoding: utf-8
+
+group :development do
+  gem 'rake',       '~> 10.2.1'
+  gem 'rspec',      '~> 2.14.1'
+  gem 'rspec-core', '~> 2.14.8'
+  gem 'yard',       '~> 0.8.7.4'
+
+  platform :rbx do
+    gem 'rubysl-singleton', '~> 2.0.0'
+  end
+end
+
+group :yard do
+  gem 'kramdown', '~> 1.3.3'
+end
+
+group :guard do
+  gem 'guard',         '~> 2.6.0'
+  gem 'guard-bundler', '~> 2.0.0'
+  gem 'guard-rspec',   '~> 4.2.8'
+  gem 'guard-rubocop', '~> 1.0.2'
+
+  # file system change event handling
+  gem 'listen',     '~> 2.7.1'
+  gem 'rb-fchange', '~> 0.0.6', require: false
+  gem 'rb-fsevent', '~> 0.9.4', require: false
+  gem 'rb-inotify', '~> 0.9.3', require: false
+
+  # notification handling
+  gem 'libnotify',               '~> 0.8.2', require: false
+  gem 'rb-notifu',               '~> 0.0.4', require: false
+  gem 'terminal-notifier-guard', '~> 1.5.3', require: false
+end
+
+group :metrics do
+  gem 'coveralls', '~> 0.7.0'
+  gem 'flay',      '~> 2.4.0'
+  gem 'flog',      '~> 4.2.0'
+  gem 'reek',      '~> 1.3.7'
+  gem 'rubocop',   '~> 0.19.1'
+  gem 'simplecov', '~> 0.8.2'
+  gem 'yardstick', '~> 0.9.9'
+
+  platforms :mri do
+    gem 'mutant',       '~> 0.5.8'
+    gem 'mutant-rspec', '~> 0.5.3'
+  end
+
+  platforms :ruby_19, :ruby_20 do
+    gem 'yard-spellcheck', '~> 0.1.5'
+  end
+
+  platform :rbx do
+    gem 'json',               '~> 1.8.1'
+    gem 'racc',               '~> 1.4.11'
+    gem 'rubysl-logger',      '~> 2.0.0'
+    gem 'rubysl-open-uri',    '~> 2.0.0'
+    gem 'rubysl-prettyprint', '~> 2.0.3'
+  end
+end
+
+group :benchmarks do
+  gem 'rbench', '~> 0.2.3'
+end
+
+platform :jruby do
+  group :jruby do
+    gem 'jruby-openssl', '~> 0.8.5'
+  end
+end

data/LICENSE

@@ -1,4 +1,5 @@
-Copyright (c) 2009-2012 Dan Kubb
+Copyright (c) 2012-2013 Dan Kubb (author)
+Copyright (c) 2011-2012 Piotr Solnica (source maintainer)
 Copyright (c) 2012 Markus Schirp (packaging)
 
 Permission is hereby granted, free of charge, to any person obtaining

data/README.md

@@ -1,41 +1,24 @@
-descendants_tracker
-===================
+# 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)
+[![Gem Version](https://badge.fury.io/rb/descendants_tracker.png)][gem]
+[![Build Status](https://secure.travis-ci.org/dkubb/descendants_tracker.png?branch=master)][travis]
+[![Dependency Status](https://gemnasium.com/dkubb/descendants_tracker.png)][gemnasium]
+[![Code Climate](https://codeclimate.com/github/dkubb/descendants_tracker.png)][codeclimate]
+[![Coverage Status](https://coveralls.io/repos/dkubb/descendants_tracker/badge.png?branch=master)][coveralls]
 
-Small module to track descendants in an unobtrusive way.
-
-Installation
-------------
-
-With Rubygems:
-
-```bash
-$ gem install descendants_tracker
-$ irb -rubygems
->> require 'descendants_tracker'
-=> true
-```
+[gem]: https://rubygems.org/gems/descendants_tracker
+[travis]: https://travis-ci.org/dkubb/descendants_tracker
+[gemnasium]: https://gemnasium.com/dkubb/descendants_tracker
+[codeclimate]: https://codeclimate.com/github/dkubb/descendants_tracker
+[coveralls]: https://coveralls.io/r/dkubb/descendants_tracker
 
-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
-```
+Small module to track descendants in an unobtrusive way.
 
-Examples
---------
+## Examples
 
 ``` ruby
 class Foo
-  extend Virtus::DescendantsTracker
+  extend DescendantsTracker
 end
 
 class Bar < Foo
@@ -44,45 +27,20 @@ end
 Foo.descendants # => [Bar]
 ```
 
-Credits
--------
+## 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
--------
+## Contributing
 
-Copyright (c) 2011-2012 Dan Kubb
+See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
 
-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:
+## Copyright
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+Copyright &copy; 2012-2013 Dan Kubb (author)
+Copyright &copy; 2011-2012 Piotr Solnica (source maintainer)
+Copyright &copy; 2012 Markus Schirp (packaging)
 
-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.
+See LICENSE for details.

data/Rakefile

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

data/config/devtools.yml

@@ -0,0 +1,4 @@
+---
+unit_test_timeout: 0.1
+fail_on_branch:
+- "master"

data/config/flay.yml

@@ -1,3 +1,3 @@
 ---
-threshold: 6
-total_score: 8
+threshold: 2
+total_score: 4

data/config/flog.yml

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

data/config/mutant.yml

@@ -0,0 +1,3 @@
+---
+name: descendants_tracker
+namespace: DescendantsTracker

data/config/{site.reek → reek.yml}

@@ -1,91 +1,106 @@
 ---
-UncommunicativeParameterName:
-  accept: []
-  exclude: []
+Attribute:
   enabled: true
-  reject:
-  - !ruby/regexp /^.$/
-  - !ruby/regexp /[0-9]$/
-  - !ruby/regexp /[A-Z]/
-LargeClass:
-  max_methods: 10
-  exclude: []
+  exclude:
+  - DescendantsTracker
+BooleanParameter:
   enabled: true
-  max_instance_variables: 2
-UncommunicativeMethodName:
-  accept: []
   exclude: []
+ClassVariable:
   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: []
+ControlParameter:
   enabled: true
-  overrides: {}
-FeatureEnvy:
   exclude: []
+DataClump:
   enabled: true
-ClassVariable:
   exclude: []
+  max_copies: 2
+  min_clump_size: 2
+DuplicateMethodCall:
   enabled: true
-BooleanParameter:
   exclude: []
+  max_calls: 1
+  allow_calls: []
+FeatureEnvy:
   enabled: true
+  exclude: []
 IrresponsibleModule:
+  enabled: true
   exclude: []
+LongParameterList:
   enabled: true
-UncommunicativeModuleName:
-  accept: []
   exclude: []
+  max_params: 2
+  overrides:
+    initialize:
+      max_params: 3
+LongYieldList:
   enabled: true
-  reject:
-  - !ruby/regexp /^.$/
-  - !ruby/regexp /[0-9]$/
+  exclude: []
+  max_params: 2
 NestedIterators:
+  enabled: true
+  exclude: []
+  max_allowed_nesting: 1
   ignore_iterators: []
+NilCheck:
+  enabled: true
   exclude: []
+RepeatedConditional:
   enabled: true
-  max_allowed_nesting: 1
-LongMethod:
-  max_statements: 7  # TODO: decrease max_statements to 5 or less
   exclude: []
+  max_ifs: 1
+TooManyInstanceVariables:
   enabled: true
-Duplication:
-  allow_calls: []
   exclude: []
+  max_instance_variables: 3
+TooManyMethods:
   enabled: true
-  max_calls: 1
-UtilityFunction:
-  max_helper_calls: 1
   exclude: []
+  max_methods: 10
+TooManyStatements:
+  enabled: true
+  exclude:
+  - DescendantsTracker#add_descendant
+  - DescendantsTracker#inherited
+  - each
+  max_statements: 2
+UncommunicativeMethodName:
   enabled: true
-Attribute:
   exclude: []
-  enabled: false
-UncommunicativeVariableName:
+  reject:
+  - !ruby/regexp /^[a-z]$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
   accept: []
+UncommunicativeModuleName:
+  enabled: true
   exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  accept: []
+UncommunicativeParameterName:
   enabled: true
+  exclude: []
   reject:
   - !ruby/regexp /^.$/
   - !ruby/regexp /[0-9]$/
   - !ruby/regexp /[A-Z]/
-SimulatedPolymorphism:
-  exclude: []
+  accept: []
+UncommunicativeVariableName:
   enabled: true
-  max_ifs: 1
-DataClump:
   exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UnusedParameters:
   enabled: true
-  max_copies: 1
-  min_clump_size: 3
-ControlCouple:
   exclude: []
+UtilityFunction:
   enabled: true
-LongYieldList:
-  max_params: 1
   exclude: []
-  enabled: true
+  max_helper_calls: 0

data/config/rubocop.yml

@@ -0,0 +1,62 @@
+AllCops:
+  Includes:
+    - '**/*.rake'
+    - 'Gemfile'
+    - 'Gemfile.devtools'
+  Excludes:
+    - '**/vendor/**'
+    - '**/benchmarks/**'
+
+# Avoid parameter lists longer than five parameters.
+ParameterLists:
+  Max: 3
+  CountKeywordArgs: true
+
+# Avoid more than `Max` levels of nesting.
+BlockNesting:
+  Max: 3
+
+# Align with the style guide.
+CollectionMethods:
+  PreferredMethods:
+    collect:  'map'
+    inject:   'reduce'
+    find:     'detect'
+    find_all: 'select'
+
+# Do not force public/protected/private keyword to be indented at the same
+# level as the def keyword. My personal preference is to outdent these keywords
+# because I think when scanning code it makes it easier to identify the
+# sections of code and visually separate them. When the keyword is at the same
+# level I think it sort of blends in with the def keywords and makes it harder
+# to scan the code and see where the sections are.
+AccessModifierIndentation:
+  Enabled: false
+
+# Limit line length
+LineLength:
+  Max: 79
+
+# Disable documentation checking until a class needs to be documented once
+Documentation:
+  Enabled: false
+
+# Do not favor modifier if/unless usage when you have a single-line body
+IfUnlessModifier:
+  Enabled: false
+
+# Allow case equality operator (in limited use within the specs)
+CaseEquality:
+  Enabled: false
+
+# Constants do not always have to use SCREAMING_SNAKE_CASE
+ConstantName:
+  Enabled: false
+
+# Not all trivial readers/writers can be defined with attr_* methods
+TrivialAccessors:
+  Enabled: false
+
+# Allow empty lines around body
+EmptyLinesAroundBody:
+  Enabled: false

data/descendants_tracker.gemspec

@@ -1,4 +1,4 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 
 require File.expand_path('../lib/descendants_tracker/version', __FILE__)
 
@@ -6,16 +6,18 @@ 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.email       = %w[ dan.kubb@gmail.com piotr.solnica@gmail.com mbj@schirp-dso.com ]
   gem.description = 'Module that adds descendant tracking to a class'
   gem.summary     = gem.description
   gem.homepage    = 'https://github.com/dkubb/descendants_tracker'
+  gem.license     = 'MIT'
 
   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.test_files       = `git ls-files -- spec/unit`.split($/)
+  gem.extra_rdoc_files = %w[LICENSE README.md CONTRIBUTING.md TODO]
 
-  gem.add_development_dependency('rake',  '~> 10.0.2')
-  gem.add_development_dependency('rspec', '~> 1.3.2')
+  gem.add_runtime_dependency('thread_safe', '~> 0.3', '>= 0.3.1')
+
+  gem.add_development_dependency('bundler', '~> 1.5', '>= 1.5.3')
 end

data/lib/descendants_tracker/version.rb

@@ -1,3 +1,8 @@
+# encoding: utf-8
+
 module DescendantsTracker
-  VERSION = '0.0.1'.freeze
-end
+
+  # Unreleased gem version
+  VERSION = '0.0.4'.freeze
+
+end # module DescendantsTracker