yardstick 0.7.0 → 0.8.0

data/.travis.yml

@@ -1,16 +1,16 @@
 language: ruby
-bundler_args: --without guard metrics
+bundler_args: --without yard guard metrics
 script: "bundle exec rake spec"
 rvm:
-  - ree
   - 1.8.7
   - 1.9.2
   - 1.9.3
-  - ruby-head
-  - rbx-18mode
-  - rbx-19mode
   - jruby-18mode
   - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode
+  - ree
+  - ruby-head
   - jruby-head
 notifications:
   email:

data/VERSION

@@ -1 +1 @@
-0.7.0
+0.8.0

data/lib/yardstick.rb

@@ -4,8 +4,6 @@ require 'rational'
 require 'backports'
 require 'yard'
 
-require 'yardstick/yard_ext'
-
 require 'yardstick/ordered_set'
 require 'yardstick/rule_set'
 require 'yardstick/measurement'
@@ -17,6 +15,8 @@ require 'yardstick/rule'
 require 'yardstick/measurable'
 require 'yardstick/method'
 
+require 'yardstick/yard_ext'
+
 require 'yardstick/version'
 
 module Yardstick

data/lib/yardstick/cli.rb

@@ -1,6 +1,8 @@
 require 'optparse'
 
 module Yardstick
+
+  # Handle the yardstick command line interface
   class CLI
 
     # Parse the command line options, and run the command

data/lib/yardstick/measurable.rb

@@ -4,6 +4,18 @@ module Yardstick
 
     module ClassMethods
 
+      # Include the class or module with measurable class methods
+      #
+      # @param [Module] mod
+      #   the module to include within
+      #
+      # @return [undefined]
+      #
+      # @api private
+      def included(mod)
+        mod.extend(ClassMethods).rules.merge(rules)
+      end
+
       # List of rules for this class
       #
       # @return [Yardstick::RuleSet<Rule>]
@@ -32,32 +44,6 @@ module Yardstick
         rules << Rule.new(description, &block)
       end
 
-    private
-
-      # Include the class or module with measurable class methods
-      #
-      # @param [Module] mod
-      #   the module to include within
-      #
-      # @return [undefined]
-      #
-      # @api private
-      def included(mod)
-        mod.extend(ClassMethods).rules.merge(rules)
-      end
-
-      # Extend the docstring meta class with measurable class methods
-      #
-      # @param [YARD::Docstring] docstring
-      #   the docstring to extend
-      #
-      # @return [undefined]
-      #
-      # @api private
-      def extended(docstring)
-        included(docstring.singleton_class)
-      end
-
     end # module ClassMethods
 
     extend ClassMethods
@@ -72,7 +58,7 @@ module Yardstick
     #
     # @api public
     def measure
-      singleton_class.rules.measure(self)
+      self.class.rules.measure(self)
     end
 
   end # module Measurable

data/lib/yardstick/measurement.rb

@@ -1,4 +1,6 @@
 module Yardstick
+
+  # A measurement given a constraint on the docs
   class Measurement
 
     # Return the Measurement description

data/lib/yardstick/measurement_set.rb

@@ -1,4 +1,6 @@
 module Yardstick
+
+  # A set of yardstick measurements
   class MeasurementSet < OrderedSet
 
     # The total number of measurements

data/lib/yardstick/ordered_set.rb

@@ -1,4 +1,6 @@
 module Yardstick
+
+  # A base class for an ordered set
   class OrderedSet
     include Enumerable
 

data/lib/yardstick/processor.rb

@@ -1,4 +1,6 @@
 module Yardstick
+
+  # Handle procesing a docstring or path of files
   class Processor
 
     # Measure files provided

data/lib/yardstick/rake/measurement.rb

@@ -6,6 +6,8 @@ require 'yardstick'
 
 module Yardstick
   module Rake
+
+    # A rake task for measuring docs in a set of files
     class Measurement < ::Rake::TaskLib
 
       # List of paths to measure

data/lib/yardstick/rake/verify.rb

@@ -5,6 +5,8 @@ require 'yardstick'
 
 module Yardstick
   module Rake
+
+    # A rake task for verifying the doc thresholds
     class Verify < ::Rake::TaskLib
 
       # Set the threshold

data/lib/yardstick/rule.rb

@@ -1,4 +1,6 @@
 module Yardstick
+
+  # A constraint on the docs
   class Rule
 
     # Return a Rule instance

data/lib/yardstick/rule_set.rb

@@ -1,4 +1,6 @@
 module Yardstick
+
+  # A set of rules to apply to docs
   class RuleSet < OrderedSet
 
     # Measure a docstring with all Rules

data/lib/yardstick/version.rb

@@ -1,3 +1,3 @@
 module Yardstick
-  VERSION = '0.7.0'
+  VERSION = '0.8.0'
 end # module Yardstick

data/lib/yardstick/yard_ext.rb

@@ -1,20 +1,7 @@
 module YARD  #:nodoc: all
-  module CodeObjects
-    class MethodObject
 
-      # Return the docstring associated with the method
-      #
-      # @example
-      #   method_object.docstring  # => YARD::Docstring instance
-      #
-      # @return [YARD::Docstring]
-      #   the docstring for this method
-      #
-      # @api public
-      def docstring
-        super.extend(Yardstick::Method)
-      end
-
-    end # class MethodObject
-  end # module CodeObjects
+  # Extend docstring with yardstick methods
+  class Docstring
+    include Yardstick::Method
+  end # class Docstring
 end # module YARD

data/spec/semipublic/yardstick/rule_spec.rb

@@ -1,27 +1,34 @@
 require 'spec_helper'
 
 describe Yardstick::Rule do
+  let(:object)      { described_class.new(description) { true } }
+  let(:description) { 'test rule'                               }
+
   describe '#eql?' do
+    subject { object.eql?(other) }
+
     describe 'when rules are equal' do
-      before do
-        @rule  = Yardstick::Rule.new('test rule') { true }
-        @other = Yardstick::Rule.new('test rule') { true }
-      end
+      let(:other) { described_class.new(description) { true } }
 
-      it 'should return true' do
-        @rule.eql?(@other).should be_true
+      it 'is true' do
+        should be(true)
       end
     end
 
     describe 'when rules are not equal' do
-      before do
-        @rule  = Yardstick::Rule.new('test rule')  { true }
-        @other = Yardstick::Rule.new('other rule') { true }
-      end
+      let(:other) { described_class.new('other rule') { true } }
 
-      it 'should return false' do
-        @rule.eql?(@other).should be_false
+      it 'is false' do
+        should be(false)
       end
     end
   end
+
+  describe '#hash' do
+    subject { object.hash }
+
+    it 'is the expected hash' do
+      should == description.hash
+    end
+  end
 end

data/yardstick.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "yardstick"
-  s.version = "0.7.0"
+  s.version = "0.8.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Dan Kubb"]
-  s.date = "2012-10-26"
+  s.date = "2012-11-12"
   s.description = "Measure YARD documentation coverage"
   s.email = "dan.kubb@gmail.com"
   s.executables = ["yardstick"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yardstick
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-26 00:00:00.000000000 Z
+date: 2012-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backports
@@ -155,6 +155,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3755619333426981008
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: