means 0.1.1 → 0.1.2

data/Gemfile

@@ -7,6 +7,7 @@ source "http://rubygems.org"
 # Include everything needed to run rake, tests, features, etc.
 group :development do
   gem "rspec", "~> 2.3.0"
+  gem "yard", "~> 0.6.0"
   gem "bundler", "~> 1.0.0"
   gem "jeweler", "~> 1.6.4"
   gem "rcov", ">= 0"

data/Gemfile.lock

@@ -17,6 +17,7 @@ GEM
     rspec-expectations (2.3.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.3.0)
+    yard (0.6.8)
 
 PLATFORMS
   ruby
@@ -26,3 +27,4 @@ DEPENDENCIES
   jeweler (~> 1.6.4)
   rcov
   rspec (~> 2.3.0)
+  yard (~> 0.6.0)

data/Rakefile

@@ -38,12 +38,5 @@ end
 
 task :default => :spec
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "means #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/lib/Mean.rb

@@ -3,20 +3,26 @@ require 'mathn'
 # Allows calculation of arithmetic, geometric and harmonic means.
 # Class methods allow the passing in of a data set. 
 # Alternatively an object can be created and elements can
-# be added with Mean#push
+# be added with #push
 class Mean
 
-  # Calculate the arithmetic mean of _data_
+  # Calculate the arithmetic mean
+  # @param [Array<Float>] data the data values
+  # @return [Float] the arithmetic mean
   def Mean.arithmetic(data)
     data.reduce(:+) / data.size unless data.empty?
   end
 
-  # Calculate the geometric mean of _data_
+  # Calculate the geometric mean
+  # @param (see Mean.arithmetic)
+  # @return [Float] the geometric mean
   def Mean.geometric(data)
     data.reduce(:*) ** (1 / data.size) unless data.empty?
   end
 
-  # Calculate the harmonic mean of _data_
+  # Calculate the harmonic mean
+  # @param (see Mean.arithmetic)
+  # @return [Float] the harmonic mean
   def Mean.harmonic(data)
     data.size / data.reduce(0) {|sum, element| sum += (1 / element)} unless data.empty?
   end
@@ -24,9 +30,10 @@ class Mean
   # Remember the initial state. 
   #
   # If you are passing in an initial state:
-  # [arithmetic mean] needs :sum and :count
-  # [geometric mean] needs :product and :count.
-  # [harmonic mean] needs :sum_of_reciprocals and :count
+  # [arithmetic mean] needs `:sum` and `:count`
+  # [geometric mean] needs `:product` and `:count`
+  # [harmonic mean] needs `:sum_of_reciprocals` and `:count`
+  # @param [Hash{Symbol => Fixnum}]
   def initialize(params={})
     @sum                ||= params[:sum]                ||= 0
     @sum_of_reciprocals ||= params[:sum_of_reciprocals] ||= 0
@@ -34,7 +41,8 @@ class Mean
     @count              ||= params[:count]              ||= 0
   end
 
-  # Add _element_ to the data set
+  # Add element to the data set
+  # @param [Float] element the element to add
   def push(element)
     @sum += element
     @sum_of_reciprocals += (1 / element)
@@ -42,17 +50,20 @@ class Mean
     @count += 1
   end
 
-  # Calculate the arithmetic mean of the data set
+  # Calculate the arithmetic mean
+  # @return [Float] the arithmetic mean
   def arithmetic_mean
     @sum / @count unless @count == 0
   end
 
-  # Calculate the geometric mean of the data set
+  # Calculate the geometric mean
+  # @return [Float] the geometric mean
   def geometric_mean
     @product ** (1 / @count) unless @count == 0
   end
 
-  # Calculate the harmonic mean of the data set
+  # Calculate the harmonic mean
+  # @return [Float] the harmonic mean
   def harmonic_mean
     @count / @sum_of_reciprocals unless @count == 0
   end

data/means.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "means"
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nigel Lowry"]
@@ -41,17 +41,20 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<yard>, ["~> 0.6.0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
     else
       s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<yard>, ["~> 0.6.0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
       s.add_dependency(%q<rcov>, [">= 0"])
     end
   else
     s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<yard>, ["~> 0.6.0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
     s.add_dependency(%q<rcov>, [">= 0"])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: means
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-11-06 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70363465138320 !ruby/object:Gem::Requirement
+  requirement: &70214563112520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,21 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *70363465138320
+  version_requirements: *70214563112520
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &70214563112040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *70214563112040
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70363465137840 !ruby/object:Gem::Requirement
+  requirement: &70214563111560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +43,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70363465137840
+  version_requirements: *70214563111560
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70363465137360 !ruby/object:Gem::Requirement
+  requirement: &70214563111080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +54,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70363465137360
+  version_requirements: *70214563111080
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70363465136880 !ruby/object:Gem::Requirement
+  requirement: &70214563110600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70363465136880
+  version_requirements: *70214563110600
 description: Calculates the diferent means for a data set (arithmetic, geometric and
   harmonic).
 email: nigel-lowry@ultra.eclipse.co.uk
@@ -91,7 +102,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2129749344075212161
+      hash: 4342977988734455412
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: