yardstick 0.9.6 → 0.9.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9c2137c6b2747b94bf79c7d18f96f3046b88cad1
+  data.tar.gz: 3b701a6a2923c7925ff69040a03befa7a6a6ba85
+SHA512:
+  metadata.gz: 2cd3503aa97404404f678d781a4f144f73cf80662389cef07a2252af4236ffe51b10311e274847b457c1ce2cd4c4da44e7b4225f0a23c51704f0d50ee1258bf1
+  data.tar.gz: dc976e0b2f8477add7b52a5bdf2142bea4e5d22150601da3e0e8e493cfe1794c851eb83d14e8bef81ee6f0788865986d38a0f1ac301cd9bf124809c7d212ad48

data/.gitignore

@@ -28,6 +28,7 @@ doc
 log
 .yardoc
 measurements
+tags
 
 ## BUNDLER
 .bundle

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+yardstick

data/.travis.yml

@@ -3,29 +3,24 @@ before_install: gem install bundler
 bundler_args: --without yard guard benchmarks
 script: "bundle exec rake ci"
 rvm:
-  - ree
-  - 1.8.7
-  - 1.9.2
   - 1.9.3
   - 2.0.0
   - ruby-head
-  - rbx-18mode
   - rbx-19mode
-  - jruby-18mode
-notifications:
-  irc:
-    channels:
-      - irc.freenode.org#datamapper
-    on_success: never
-    on_failure: change
-  email:
-    recipients:
-      - dan.kubb@gmail.com
-    on_success: never
-    on_failure: change
 matrix:
   include:
     - rvm: jruby-19mode
       env: JRUBY_OPTS="$JRUBY_OPTS --debug"
     - rvm: jruby-head
       env: JRUBY_OPTS="$JRUBY_OPTS --debug"
+  allow_failures:
+    - rvm: 1.9.3       # mutant fails
+    - rvm: 2.0.0       # mutant fails
+    - rvm: ruby-head   # travis broken
+    - rvm: rbx-19mode  # mutant fails
+notifications:
+  irc:
+    channels:
+      - irc.freenode.org#rom-rb
+    on_success: never
+    on_failure: change

data/CONTRIBUTING.md

@@ -0,0 +1,11 @@
+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,64 +4,8 @@ source 'https://rubygems.org'
 
 gemspec
 
-group :development do
-  gem 'rake',  '~> 10.0.4'
-  gem 'rspec', '~> 1.3.2'
+group :development, :test do
+  gem 'devtools', git: 'https://github.com/rom-rb/devtools.git'
 end
 
-group :yard do
-  gem 'kramdown', '~> 1.0.1'
-end
-
-group :guard do
-  gem 'guard',         '~> 1.7.0'
-  gem 'guard-bundler', '~> 1.0.0'
-  gem 'guard-rspec',   '~> 1.2.1'
-
-  # file system change event handling
-  gem 'listen',     '~> 0.7.3'
-  gem 'rb-fchange', '~> 0.0.6', :require => false
-  gem 'rb-fsevent', '~> 0.9.3', :require => false
-  gem 'rb-inotify', '~> 0.9.0', :require => false
-
-  # notification handling
-  gem 'libnotify',               '~> 0.8.0', :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.6.5'
-  gem 'flay',            '~> 1.4.3'
-  gem 'flog',            '~> 2.5.3'
-  gem 'roodi',           '~> 2.2.0'
-  gem 'simplecov',       '~> 0.7.1'
-  gem 'yard-spellcheck', '~> 0.1.5'
-
-  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.7'  # for metric_fu rake task
-    gem 'map',                  '~> 6.3.0'  # for metric_fu
-    gem 'metric_fu',            '~> 2.1.1'
-    gem 'mspec',                '~> 1.5.17'
-    gem 'rails_best_practices', '= 1.13.3'  # for metric_fu
-    gem 'rcov',                 '~> 1.0.0'
-    gem 'ruby2ruby',            '= 1.2.2'   # for heckle
-  end
-
-  platforms :rbx do
-    gem 'pelusa', '~> 0.2.2'
-  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
+eval_gemfile 'Gemfile.devtools'

data/Gemfile.devtools

@@ -0,0 +1,54 @@
+# encoding: utf-8
+
+group :development do
+  gem 'rake',  '~> 10.1.0'
+  gem 'rspec', '~> 2.14.1'
+  gem 'yard',  '~> 0.8.7'
+end
+
+group :yard do
+  gem 'kramdown', '~> 1.2.0'
+end
+
+group :guard do
+  gem 'guard',         '~> 1.8.1'
+  gem 'guard-bundler', '~> 1.0.0'
+  gem 'guard-rspec',   '~> 3.0.2'
+  gem 'guard-rubocop', '~> 0.2.0'
+  gem 'guard-mutant',  '~> 0.0.1'
+
+  # file system change event handling
+  gem 'listen',     '~> 1.3.0'
+  gem 'rb-fchange', '~> 0.0.6', require: false
+  gem 'rb-fsevent', '~> 0.9.3', require: false
+  gem 'rb-inotify', '~> 0.9.0', require: false
+
+  # notification handling
+  gem 'libnotify',               '~> 0.8.0', 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.6.7'
+  gem 'flay',      '~> 2.4.0'
+  gem 'flog',      '~> 4.1.1'
+  gem 'reek',      '~> 1.3.2'
+  gem 'rubocop',   '~> 0.12.0'
+  gem 'simplecov', '~> 0.7.1'
+
+  platforms :ruby_19, :ruby_20 do
+    gem 'mutant', git: 'https://github.com/mbj/mutant.git'
+    gem 'yard-spellcheck', '~> 0.1.5'
+  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/Guardfile

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+guard :bundler do
+  watch('Gemfile')
+  watch('Gemfile.lock')
+  watch(%w{.+.gemspec\z})
+end
+
+guard :rspec, cli: File.read('.rspec').split.push('--fail-fast').join(' '), keep_failed: false do
+  # Run all specs if configuration is modified
+  watch('.rspec')              { 'spec' }
+  watch('Guardfile')           { 'spec' }
+  watch('Gemfile.lock')        { 'spec' }
+  watch('spec/spec_helper.rb') { 'spec' }
+
+  # Run all specs if supporting files files are modified
+  watch(%r{\Aspec/(?:fixtures|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(%r{\Alib/(.+)/support/(.+)\.rb\z})                            { |m| Dir["spec/unit/#{m[1]}/#{m[2]}*"] }
+  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
+
+guard :rubocop, cli: %w[--config config/rubocop.yml] do
+  watch(%r{.+\.(?:rb|rake)\z})
+  watch(%r{\Aconfig/rubocop\.yml\z})  { |m| File.dirname(m[0]) }
+  watch(%r{(?:.+/)?\.rubocop\.yml\z}) { |m| File.dirname(m[0]) }
+end

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Dan Kubb
+Copyright (c) 2009-2013 Dan Kubb
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,5 +1,4 @@
-# Yardstick
-===========
+# yardstick
 
 [![Gem Version](https://badge.fury.io/rb/yardstick.png)][gem]
 [![Build Status](https://secure.travis-ci.org/dkubb/yardstick.png?branch=master)][travis]
@@ -15,43 +14,8 @@
 
 Yardstick is a tool that verifies documentation coverage of Ruby code.  It will measure the source and provide feedback on what is missing from the documentation and what can be improved.
 
-* [Homepage](http://yardstick.rubyforge.org/)
-* [Git](http://github.com/dkubb/yardstick)
-* [Bug Tracker](http://github.com/dkubb/yardstick/issues)
-* [Mailing List](http://groups.google.com/group/yardstick)
-* [IRC](irc://irc.freenode.net/yardstick)
-
-Installation
-------------
-
-With Rubygems:
-
-```
-$ sudo gem install yardstick
-$ irb -rubygems
->> require 'yardstick'
-=> true
-```
-
-With the [Rip package manager](http://hellorip.com/):
-
-```
-$ rip install git://github.com/dkubb/yardstick.git 0.1.0
-$ irb -rrip
->> require 'yardstick'
-=> true
-```
-
-With git and local working copy:
-
-```
-$ git clone git://github.com/dkubb/yardstick.git
-$ cd yardstick
-$ rake build && sudo rake install
-$ irb -rubygems
->> require 'yardstick'
-=> true
-```
+* [Git](https://github.com/dkubb/yardstick)
+* [Bug Tracker](https://github.com/dkubb/yardstick/issues)
 
 ## Usage
 
@@ -121,19 +85,71 @@ measurements = Yardstick.measure_string <<-RUBY
 RUBY
 ```
 
-## TODO
-
-* Add more measurements, especially for @param, @yield and type
-  validation
-* Update yardstick_measure task to use the Yardstick::CLI library
-  underneath.
-* Output results as HTML from command line tool and Rake task
-* Specify method_missing to allow public, semipublic or private even
-  if its visibility is private
-* Allow initialize to be public, semipublic or private regardless of
-  its visibility.  A constructor may not necessarily be public, and may
-  not be used externally.
-* Allow @return type to be "self" to specify the return value is
-  the object itself.  Ask argv[0] if it can be made a YARD convention.
-
-Copyright (c) 2009 Dan Kubb. See LICENSE for details.
+### 4. Configuration
+
+Every rule in Yardstick can be turned off globally and locally. All rules are enabled and threshold is set to maximum by default.
+
+Default configuration:
+```yaml
+---
+threshold: 100
+rules:
+  ApiTag::Presence:
+    enabled: true
+    exclude: []
+  ApiTag::Inclusion:
+    enabled: true
+    exclude: []
+  ApiTag::ProtectedMethod:
+    enabled: true
+    exclude: []
+  ApiTag::PrivateMethod:
+    enabled: true
+    exclude: []
+  ExampleTag:
+    enabled: true
+    exclude: []
+  ReturnTag:
+    enabled: true
+    exclude: []
+  Summary::Presence:
+    enabled: true
+    exclude: []
+  Summary::Length:
+    enabled: true
+    exclude: []
+  Summary::Delimiter:
+    enabled: true
+    exclude: []
+  Summary::SingleLine:
+    enabled: true
+    exclude: []
+```
+
+To disable a rule for some part of the code use:
+
+```yaml
+rules:
+  ApiTag::Presence:
+    enabled: true
+    exclude:
+      - Foo::Bar  # class or module
+      - Foo#bar   # instance method
+      - Foo.bar   # class method
+```
+
+Rake tasks take these options as a second argument:
+
+```ruby
+options = YAML.load_file('config/yardstick.yml')
+
+Yardstick::Rake::Verify.new(:verify_measurements, options)
+```
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
+
+## Copyright
+
+Copyright (c) 2009-2013 Dan Kubb. See LICENSE for details.

data/Rakefile

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

data/TODO

@@ -0,0 +1,12 @@
+* TODO:
+
+* Add more measurements, especially for @param, @yield and type
+  validation
+* Update yardstick_measure task to use the Yardstick::CLI library
+  underneath.
+* Output results as HTML from command line tool and Rake task
+* Specify method_missing to allow public, semipublic or private even
+  if its visibility is private
+* Allow initialize to be public, semipublic or private regardless of
+  its visibility. A constructor may not necessarily be public, and may
+  not be used externally.

data/bin/yardstick

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby -KU
+# encoding: utf-8
 
 $LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
 

data/config/devtools.yml

@@ -0,0 +1,2 @@
+---
+unit_test_timeout: 0.3

data/config/flay.yml

@@ -1,3 +1,3 @@
 ---
-threshold: 16
-total_score: 257
+threshold: 12
+total_score: 160

data/config/flog.yml

@@ -1,2 +1,2 @@
 ---
-threshold: 15.0
+threshold: 11.4

data/config/mutant.yml

@@ -0,0 +1,3 @@
+---
+name: yardstick
+namespace: Yardstick

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

@@ -2,16 +2,16 @@
 Attribute:
   enabled: true
   exclude:
-  - Yardstick::Rake::Verify
-  - Yardstick::Rake::Measurement
-  - Yardstick::Measurement
+  - Yardstick::Config
+  - Yardstick::Rule
+  - Yardstick::Document
 BooleanParameter:
   enabled: true
   exclude: []
 ClassVariable:
   enabled: true
   exclude: []
-ControlCouple:
+ControlParameter:
   enabled: true
   exclude: []
 DataClump:
@@ -19,7 +19,7 @@ DataClump:
   exclude: []
   max_copies: 2
   min_clump_size: 2
-Duplication:
+DuplicateMethodCall:
   enabled: true
   exclude: []
   max_calls: 1
@@ -29,25 +29,7 @@ FeatureEnvy:
   exclude: []
 IrresponsibleModule:
   enabled: true
-  exclude:
-  - YARD::Docstring
-LargeClass:
-  enabled: true
-  exclude:
-  - Yardstick::Measurement
-  - Yardstick::Rake::Verify
-  max_instance_variables: 3
-  max_methods: 10
-LongMethod:
-  enabled: true
-  exclude:
-  - Yardstick::CLI#self.option_parser
-  - Yardstick::CLI#self.parse_options
-  - Yardstick::CLI#self.run
-  - Yardstick::OrderedSet#<<
-  - Yardstick::Processor#self.measurements
-  - Yardstick::Rake::Verify#verify_measurements
-  max_statements: 2
+  exclude: []
 LongParameterList:
   enabled: true
   exclude: []
@@ -64,10 +46,31 @@ NestedIterators:
   exclude: []
   max_allowed_nesting: 1
   ignore_iterators: []
-SimulatedPolymorphism:
+NilCheck:
+  enabled: true
+  exclude: []
+RepeatedConditional:
   enabled: true
   exclude: []
   max_ifs: 1
+TooManyInstanceVariables:
+  enabled: true
+  exclude:
+  - Yardstick::Config
+  max_instance_variables: 3
+TooManyMethods:
+  enabled: true
+  exclude:
+  - Yardstick::Document
+  max_methods: 10
+TooManyStatements:
+  enabled: true
+  exclude:
+  - Yardstick::CLI#self.option_parser
+  - Yardstick::CLI#self.parse_config
+  - Yardstick::Config#set_defaults
+  - Yardstick::Config#self.normalize_hash
+  max_statements: 3
 UncommunicativeMethodName:
   enabled: true
   exclude: []
@@ -99,6 +102,9 @@ UncommunicativeVariableName:
   - !ruby/regexp /[0-9]$/
   - !ruby/regexp /[A-Z]/
   accept: []
+UnusedParameters:
+  enabled: true
+  exclude: []
 UtilityFunction:
   enabled: true
   exclude: []