yardstick 0.9.3 → 0.9.4

data/README.md

@@ -0,0 +1,131 @@
+# Yardstick
+===========
+
+[![Build Status](https://secure.travis-ci.org/dkubb/yardstick.png?branch=master)](http://travis-ci.org/dkubb/yardstick)
+[![Dependency Status](https://gemnasium.com/dkubb/yardstick.png)](https://gemnasium.com/dkubb/yardstick)
+[![Code Climate](https://codeclimate.com/github/dkubb/yardstick.png)](https://codeclimate.com/github/dkubb/yardstick)
+
+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
+```
+
+## Usage
+
+Yardstick may be used three ways:
+
+### 1. Command-line Tool
+
+This is the simplest way to run yardstick.  Provide it a list of files
+and it will measure all of them and output suggestions for improvement,
+eg:
+
+```
+$ yardstick 'lib/**/*.rb' 'app/**/*.rb' ...etc...
+```
+
+### 2. Rake task
+
+Yardstick may be integrated with existing Rakefile and build processes,
+and is especially useful when used with a continuous integration system.
+You can set thresholds, as well as check that the threshold matches the
+actual coverage, forcing you to bump it up if the actual coverage has
+increased.  It uses a simple DSL to configure the task eg:
+
+```
+# measure coverage
+
+require 'yardstick/rake/measurement'
+
+Yardstick::Rake::Measurement.new(:yardstick_measure) do |measurement|
+  measurement.output = 'measurement/report.txt'
+end
+
+
+# verify coverage
+
+require 'yardstick/rake/verify'
+
+Yardstick::Rake::Verify.new do |verify|
+  verify.threshold = 100
+end
+```
+
+### 3. Libraries
+
+Yardstick comes with several libraries that will allow you to process
+lists of files, or String code fragments, eg:
+
+```
+require 'yardstick'
+
+# measure a list of file paths
+measurements = Yardstick.measure(paths)
+
+# measure a code fragment
+measurements = Yardstick.measure_string <<-RUBY
+  # Displays the message provided to stdout
+  #
+  # @param [#to_str] message
+  #   the message to display
+  #
+  # @return [undefined]
+  #
+  # @api public
+  def display(message)
+    puts message.to_str
+  end
+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.

data/config/flog.yml

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

data/lib/yardstick/processor.rb

@@ -15,7 +15,7 @@ module Yardstick
     #
     # @api private
     def self.process_path(path)
-      YARD.parse(Array(path).map { |file| file.to_s })
+      YARD.parse(Array(path).map(&:to_s), [], YARD::Logger::ERROR)
       measurements
     end
 

data/lib/yardstick/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module Yardstick
-  VERSION = '0.9.3'
+  VERSION = '0.9.4'
 end # module Yardstick

data/yardstick.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |gem|
   gem.require_paths    = %w[lib]
   gem.files            = `git ls-files`.split($/)
   gem.test_files       = `git ls-files -- spec/{public,semipublic}`.split($/)
-  gem.extra_rdoc_files = %w[LICENSE README.rdoc]
+  gem.extra_rdoc_files = %w[LICENSE README.md]
   gem.executables      = %w[yardstick]
 
   gem.add_dependency 'backports', ['~> 3.0', '>= 3.0.3']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yardstick
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 0.9.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-01 00:00:00.000000000 Z
+date: 2013-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backports
@@ -73,7 +73,7 @@ executables:
 extensions: []
 extra_rdoc_files:
 - LICENSE
-- README.rdoc
+- README.md
 files:
 - .document
 - .gitignore
@@ -81,7 +81,7 @@ files:
 - .travis.yml
 - Gemfile
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - bin/yardstick
 - config/flay.yml

data/README.rdoc

@@ -1,114 +0,0 @@
-= Yardstick 0.1.0
-
-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
-
-== Usage
-
-Yardstick may be used three ways:
-
-=== 1. Command-line Tool
-
-This is the simplest way to run yardstick.  Provide it a list of files
-and it will measure all of them and output suggestions for improvement,
-eg:
-
-    $ yardstick 'lib/**/*.rb' 'app/**/*.rb' ...etc...
-
-=== 2. Rake task
-
-Yardstick may be integrated with existing Rakefile and build processes,
-and is especially useful when used with a continuous integration system.
-You can set thresholds, as well as check that the threshold matches the
-actual coverage, forcing you to bump it up if the actual coverage has
-increased.  It uses a simple DSL to configure the task eg:
-
-    # measure coverage
-
-    require 'yardstick/rake/measurement'
-
-    Yardstick::Rake::Measurement.new(:yardstick_measure) do |measurement|
-      measurement.output = 'measurement/report.txt'
-    end
-
-
-    # verify coverage
-
-    require 'yardstick/rake/verify'
-
-    Yardstick::Rake::Verify.new do |verify|
-      verify.threshold = 100
-    end
-
-
-=== 3. Libraries
-
-Yardstick comes with several libraries that will allow you to process
-lists of files, or String code fragments, eg:
-
-    require 'yardstick'
-
-    # measure a list of file paths
-    measurements = Yardstick.measure(paths)
-
-    # measure a code fragment
-    measurements = Yardstick.measure_string <<-RUBY
-      # Displays the message provided to stdout
-      #
-      # @param [#to_str] message
-      #   the message to display
-      #
-      # @return [undefined]
-      #
-      # @api public
-      def display(message)
-        puts message.to_str
-      end
-    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.